MarkupElement Class

This handles the markup element, a parent element that does not itself have any rendered representation. It just clones the child nodes, removes any XML namespaces, and passes them through as-is.

Definition

Namespace: Sandcastle.Core.PresentationStyle.Transformation.Elements
Assembly: Sandcastle.Core (in Sandcastle.Core.dll) Version: 2024.2.18.0
public class MarkupElement : Element
Inheritance
Object    Element    MarkupElement

Remarks

This will allow build components and topic authors to add HTML or other elements such as include elements for localized shared content to a pre-transformed document. This prevents it from being removed as unrecognized content by the transformations.

An optional contentType attribute is supported that defines the type of content (Html, OpenXml, or Markdown). This allows rendering of content based on the content type supported by the presentation style.

When specified, presentation styles that only support Open XML will only render markup element content with a content type of "OpenXml". Presentation styles that only support Markdown will only render markup element content with a content type of "Html" or "Markdown". All others will only render the content if the type is "Html". If the attribute is omitted, the content will be rendered regardless of the presentation style's formats whether or not they actually support it.

Constructors

MarkupElementInitializes a new instance of the Object class.

Properties

Name This read-only property returns the element name
(Inherited from Element)

Methods

EqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
FinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object)
GetHashCodeServes as the default hash function.
(Inherited from Object)
GetTypeGets the Type of the current instance.
(Inherited from Object)
MemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
Render Render the element to the topic
(Overrides ElementRender(TopicTransformationCore, XElement))
ToStringReturns a string that represents the current object.
(Inherited from Object)

See Also