XmlElement

Description

sealed class Tinman.Core.Xml.XmlElement

Derived from

XmlNodeWithParent abstract

Represents an element in an XML document:

<element attribute="value">...</element>
<element attribute="value"/>

Source code formatting in XML elements may be applied by inserting XmlSpace content nodes, preferably by using the following helpers:

Public / Constructors

For

[Pure]
public static method For → (1)

name in : string

[not-empty]
The element name.

returns → XmlElement

The created XmlElement value.

Creates a new instance of XmlElement.

ValidatingException

If name in is malformed.

From​Source

public static method FromSource → (1)

xml in : string

[not-empty]
The XML element to parse.

returns → XmlElement

The parsed XmlElement.

Parses the given XML element and returns an XmlElement object for it.

ValidatingException

If xml in is malformed.

Xml​Element

2 overloads

public constructor XmlElement1 → (3)

name in : XmlName

See Name.

capacityAttributes opt : int32 = 0

The initial capacity of Attributes.

capacityContent opt : int32 = 0

The initial capacity of Content.

Creates a new instance of XmlElement.

public constructor XmlElement2 → (3)

name in : XmlName

See Name.

attributes in : IBagConst<XmlAttribute>

The attribute list or null for an empty list. See Attributes.

content opt : IBagConst<XmlNode> = null

The content node list or null for an empty list. See Content. All non-content nodes will be ignored (see XmlNode.IsDocumentContent).

Creates a new instance of XmlElement.

Public / Methods

Add

2 overloads

public method Add1 → (1)

node in : XmlAttribute

[not-null]
The attribute to add.

returns → XmlElement

this

Adds an attribute to this element.

public method Add2 → (2)

node in : XmlNode

[not-null]
The content node to add. May be one of the following (will be ignored otherwise): XmlComment, XmlElement, XmlInstruction, XmlText.

count opt : int32 = 1

[>=0]
The number of times to add node in.

returns → XmlElement

this

Adds a content node to this element.

See also

XmlNode.IsElementContent

Find

2 overloads

[Pure]
public method Find1 → (1)

name in : string

[not-null]
The attribute name.

returns → XmlAttribute

The found attribute or null.

Returns the attribute that has the given name in.

[Pure]
public method Find2 → (1)

name in : XmlName

The attribute name.

returns → XmlAttribute

The found attribute or null.

Returns the attribute that has the given name in.

First

2 overloads

[Pure]
public method First1 → (1)

name opt : string = null

The element name or null for any.

returns → XmlElement

The child element or null.

Returns the first child element of the given name opt.

[Pure]
public method First2 → (1)

name in : XmlName

The element name or XmlName.Invalid for any.

returns → XmlElement

The child element or null.

Returns the first child element of the given name in.

Format​Break

public method FormatBreak → ()

returns → XmlElement

this

Adds a XmlSpace.LineFeed content node.

Use this method to apply formatting while generating XML.

See also

XmlElement.FormatIndent

Format​Indent

public method FormatIndent → (2)

level opt : int32 = 0

[>=0]
The indentation level.

width opt : int32 = 2

[>=-1]
The indentation width. If negative, a single XmlSpace.Tabulator node will be added per indentation level. Otherwise, zero or more XmlSpace.Whitespace8, XmlSpace.Whitespace4, XmlSpace.Whitespace2 and XmlSpace.Whitespace nodes will be added, summing up to a whitespace character count of level opt * width opt.

returns → XmlElement

this

Adds XmlSpace content nodes for indentation.

Use this method to apply formatting while generating XML.

See also

XmlElement.Add2
XmlElement.FormatBreak

Get

4 overloads

[Pure]
public method Get1 → (2)

name in : string

[not-null]
The attribute name.

defaultValue in : string

The default value to return if there is no attribute of that name.

returns → string

The attribute name or defaultValue in.

Returns the value of the attribute that has the given name in.

[Pure]
public method Get2 → (2)

name in : XmlName

The attribute name.

defaultValue in : string

The default value to return if there is no attribute of that name.

returns → string

The attribute name or defaultValue in.

Returns the value of the attribute that has the given name in.

[Pure]
public method Get3 → (1)

name opt : string = null

The element name or null to return all elements.

returns → XmlElement [ ]

The child elements.

Returns all child elements of the given name opt.

[Pure]
public method Get4 → (1)

name in : XmlName

The element name.

returns → XmlElement [ ]

The child elements.

Returns all child elements of the given name in.

Has​Content

[Pure]
public method HasContent → (1)

mask in : int32

A bitmask of the XML node types to look for:
1 : XmlElement
2 : XmlText
4 : XmlSpace
8 : XmlInstruction
16 : XmlComment

returns → bool

true if there is at least one content node that matches the type mask in,
false if there are no matching nodes.

Checks if Content contains any of the given XML nodes.

Public / Attributes

Attributes

[Constant]
public attribute Attributes → (get)

value : IVectorConst<XmlAttribute>

[not-null]
The attributes.

Returns the attributes of this element.

Content

[Constant]
public attribute Content → (get)

value : IVectorConst<XmlNode>

[not-null]
The content nodes.

Returns the content nodes of this element, see XmlNode.IsElementContent.

See also

XmlChar
XmlComment
XmlElement
XmlEntity
XmlInstruction
XmlSpace
XmlText

Content​Xml

public attribute ContentXml → (get)

value : string

[not-null]
The inner XML markup.

Returns the XML markup for Content.

Name

[Constant]
public attribute Name → (get)

value : XmlName

The element name.

Returns the element name.