Syntax

Provides methods for creating XML text.

Remarks

The XMLBuilder class is designed for creating XML text. It is similar in principle to the StringBuilder class which is designed for creating strings.

The XMLBuilder class - like the StringBuilder class - stores the text internally. The text is retrieved with the ToString() method.

Add Text Methods
The "Add" methods are similar to StringBuilder methods:
AddLine() - StringBuilder.AppendLine()
AddText() - StringBuilder.Append()
"Add" methods add text to the builder unmodified except for AddLine() which appends a newline.

Append Text Methods
Line(), Text()
"Append" methods add the potentially indented and wrapped text to the builder.
The Text() method creates the added text without an ending newline This behavior is done for consistency and it allows the developer to append to the existing text.
"Append" methods start the text with a newline if the builder already has text, param allowNewLine = true and builder text does not end with a newline.
The Line() and Text() methods should have the addIndent property set to false if it applies text retrieved with a "Get" method as the "Get" method has already applied the indent.

The AddIndent() method manually controls the current indent count. The indent string length is calculated with the properties (IndentCount * IndentCharCount) and can be retrieved with the IndentLength property.

Get Text Methods
GetLine(), GetText()
All "Get" methods create and return the potentialy indented and wrapped text but do not add it to the builder.

Append Element Methods
Begin(), Create(), End()
These methods append element tags and content. Begin() automatically increments the IndentCount by 1. Create() also increments the IndentCount by 1 if the isEmpty parameter is false and the close parameter is false. End() automatically decrements the IndentCount by 1 if the IndentCount is currently greater than zero.
The "Append" element methods create the added text without an ending newline. This behavior is done for consistency and it allows the developer to append to the existing text.
"Append" methods start the text with a newline if the builder already has text, param allowNewLine = true and builder text does not end with a newline.

Get Element Methods
GetBegin(), GetCreate(), GetEnd()
All "Get" methods create and return the potentialy indented and wrapped text but do not add it to the builder.

18 Methods

5 Methods