XmlDocument

Overview

XML document is the root node for xml documents.

Location

  • Reference:
    • Elements.dll  .NET, .NET Standard 2.0
    • elements.jar  Cooper
    • Elements.fx  Island, ToffeeV2
    • libElements.fx  Toffee
  • Namespace: RemObjects.Elements.RTL
  • Platforms: .NET, .NET Standard 2.0, Cooper, Island, Toffee, ToffeeV2

 

AddNode

Add a node to this document. Note that xml documents only have 1 element node.

 

method AddNode(aNode: not nullable XmlNode)

 

void AddNode(XmlNode! aNode)

 

func AddNode(_ aNode: XmlNode)

 

void AddNode(XmlNode aNode)

 

Sub AddNode(aNode As XmlNode)

Parameters:

  • aNode:

Encoding

Encoding in the xml tag.

 

property Encoding: String read write;

 

String Encoding { get; set; }

 

var Encoding: String { get{} set{} }

 

String Encoding { __get; __set; }

 

Property Encoding() As String

ErrorInfo

Error info during parsing.

 

property ErrorInfo: XmlErrorInfo read write;

 

XmlErrorInfo ErrorInfo { get; set; }

 

var ErrorInfo: XmlErrorInfo { get{} set{} }

 

XmlErrorInfo ErrorInfo { __get; __set; }

 

Property ErrorInfo() As XmlErrorInfo

FromBinary

Parse an xml file.

 

class method FromBinary(aBinary: not nullable ImmutableBinary): not nullable XmlDocument

 

static XmlDocument! FromBinary(ImmutableBinary! aBinary)

 

static func FromBinary(_ aBinary: ImmutableBinary) -> XmlDocument

 

static XmlDocument FromBinary(ImmutableBinary aBinary)

 

Shared Function FromBinary(aBinary As ImmutableBinary) As XmlDocument

Parameters:

  • aBinary:

FromFile .NET, .NET Standard 2.0, Cooper, Island-Android, Island-iOS, Island-iOS Simulator, Island-Mac Catalyst, Island-macOS, Island-tvOS, Island-tvOS Simulator, Island-Ubuntu, Island-watchOS, Island-watchOS Simulator, Island-Windows, Toffee, ToffeeV2

Parse an xml file.

 

class method FromFile(aFileName: not nullable File): not nullable XmlDocument

 

static XmlDocument! FromFile(File! aFileName)

 

static func FromFile(_ aFileName: File) -> XmlDocument

 

static XmlDocument FromFile(File aFileName)

 

Shared Function FromFile(aFileName As File) As XmlDocument

Parameters:

  • aFileName:

FromString

Parse an xml file from a string.

 

class method FromString(aString: not nullable String): not nullable XmlDocument

 

static XmlDocument! FromString(String! aString)

 

static func FromString(_ aString: String) -> XmlDocument

 

static XmlDocument FromString(String aString)

 

Shared Function FromString(aString As String) As XmlDocument

Parameters:

  • aString:

FromUrl

Parse an xml file.

 

class method FromUrl(aUrl: not nullable Url): not nullable XmlDocument

 

static XmlDocument! FromUrl(Url! aUrl)

 

static func FromUrl(_ aUrl: Url) -> XmlDocument

 

static XmlDocument FromUrl(Url aUrl)

 

Shared Function FromUrl(aUrl As Url) As XmlDocument

Parameters:

  • aUrl:

GetCurrentCursorPosition

Given a row, col, returns info on the state at this point.

 

method GetCurrentCursorPosition(aRow: Int32; aColumn: Int32): XmlDocCurrentPosition

 

XmlDocCurrentPosition GetCurrentCursorPosition(Int32 aRow, Int32 aColumn)

 

func GetCurrentCursorPosition(_ aRow: Int32, _ aColumn: Int32) -> XmlDocCurrentPosition

 

XmlDocCurrentPosition GetCurrentCursorPosition(Integer aRow, Integer aColumn)

 

Function GetCurrentCursorPosition(aRow As Int32, aColumn As Int32) As XmlDocCurrentPosition

Parameters:

  • aRow:
  • aColumn:

NearestOpenTag

Finds the nearest open tag, given a row/col.

 

method NearestOpenTag(aRow: Int32; aColumn: Int32; out aCursorPosition: XmlPositionKind): XmlElement

 

XmlElement NearestOpenTag(Int32 aRow, Int32 aColumn, out XmlPositionKind aCursorPosition)

 

func NearestOpenTag(_ aRow: Int32, _ aColumn: Int32, _ aCursorPosition: XmlPositionKind) -> XmlElement

 

XmlElement NearestOpenTag(Integer aRow, Integer aColumn, __out XmlPositionKind aCursorPosition)

 

Function NearestOpenTag(aRow As Int32, aColumn As Int32, <OutAttribute> ByRef aCursorPosition As XmlPositionKind) As XmlElement

Parameters:

  • aRow:
  • aColumn:
  • aCursorPosition:

Nodes

Returns all nodes in this file (at the root; generally a root node and xml declarion + comments)

 

property Nodes: ImmutableList<XmlNode> read;

 

ImmutableList<XmlNode> Nodes { get; }

 

var Nodes: ImmutableList<XmlNode> { get{} }

 

ImmutableList<XmlNode> Nodes { __get; }

 

ReadOnly Property Nodes() As ImmutableList<XmlNode>

Root

Returns the root element.

 

property Root: not nullable XmlElement read write;

 

XmlElement! Root { get; set; }

 

var Root: XmlElement { get{} set{} }

 

XmlElement Root { __get; __set; }

 

Property Root() As XmlElement

SaveToFile (not nullable File) .NET, .NET Standard 2.0, Cooper, Island-Android, Island-iOS, Island-iOS Simulator, Island-Mac Catalyst, Island-macOS, Island-tvOS, Island-tvOS Simulator, Island-Ubuntu, Island-watchOS, Island-watchOS Simulator, Island-Windows, Toffee, ToffeeV2

Save this node to a file.

 

method SaveToFile(aFileName: not nullable File)

 

void SaveToFile(File! aFileName)

 

func SaveToFile(_ aFileName: File)

 

void SaveToFile(File aFileName)

 

Sub SaveToFile(aFileName As File)

Parameters:

  • aFileName:

SaveToFile (not nullable File, XmlFormattingOptions) .NET, .NET Standard 2.0, Cooper, Island-Android, Island-iOS, Island-iOS Simulator, Island-Mac Catalyst, Island-macOS, Island-tvOS, Island-tvOS Simulator, Island-Ubuntu, Island-watchOS, Island-watchOS Simulator, Island-Windows, Toffee, ToffeeV2

Save this node to a file.

 

method SaveToFile(aFileName: not nullable File; aFormatOptions: XmlFormattingOptions)

 

void SaveToFile(File! aFileName, XmlFormattingOptions aFormatOptions)

 

func SaveToFile(_ aFileName: File, _ aFormatOptions: XmlFormattingOptions)

 

void SaveToFile(File aFileName, XmlFormattingOptions aFormatOptions)

 

Sub SaveToFile(aFileName As File, aFormatOptions As XmlFormattingOptions)

Parameters:

  • aFileName:
  • aFormatOptions:

Standalone

True if this xml file has a header with standalone=true.

 

property Standalone: String read write;

 

String Standalone { get; set; }

 

var Standalone: String { get{} set{} }

 

String Standalone { __get; __set; }

 

Property Standalone() As String

toString Cooper

 

method toString: PlatformString

 

PlatformString toString()

 

func toString() -> PlatformString

 

PlatformString toString()

 

Function toString() As PlatformString

ToString  virtual Toffee, ToffeeV2

 

func ToString() -> String

Convert this xml node to string

 

method ToString(aFormatOptions: XmlFormattingOptions): String

 

String ToString(XmlFormattingOptions aFormatOptions)

 

func ToString(_ aFormatOptions: XmlFormattingOptions) -> String

 

String ToString(XmlFormattingOptions aFormatOptions)

 

Function ToString(aFormatOptions As XmlFormattingOptions) As String

Parameters:

  • aFormatOptions:

Convert this xml node to string

 

method ToString(aSaveFormatted: Boolean; aFormatOptions: XmlFormattingOptions): String

 

String ToString(Boolean aSaveFormatted, XmlFormattingOptions aFormatOptions)

 

func ToString(_ aSaveFormatted: Boolean, _ aFormatOptions: XmlFormattingOptions) -> String

 

String ToString(Boolean aSaveFormatted, XmlFormattingOptions aFormatOptions)

 

Function ToString(aSaveFormatted As Boolean, aFormatOptions As XmlFormattingOptions) As String

Parameters:

  • aSaveFormatted:
  • aFormatOptions:

TryFromBinary (not nullable ImmutableBinary): nullable XmlDocument

Try parse this xml node; if aAllowBrokenDocument is true, it always returns an xml document, but with error info set on failure.

 

class method TryFromBinary(aBinary: not nullable ImmutableBinary): nullable XmlDocument

 

static XmlDocument? TryFromBinary(ImmutableBinary! aBinary)

 

// Toffee
static func TryFromBinary(_ aBinary: ImmutableBinary) -> XmlDocument
// ToffeeV2
static func TryFromBinary(_ aBinary: ImmutableBinary) -> XmlDocument?

 

static XmlDocument TryFromBinary(ImmutableBinary aBinary)

 

Shared Function TryFromBinary(aBinary As ImmutableBinary) As XmlDocument?

Parameters:

  • aBinary:

TryFromBinary (not nullable ImmutableBinary, Boolean): nullable XmlDocument

Try parse this xml node; if aAllowBrokenDocument is true, it always returns an xml document, but with error info set on failure.

 

class method TryFromBinary(aBinary: not nullable ImmutableBinary; aAllowBrokenDocument: Boolean): nullable XmlDocument

 

static XmlDocument? TryFromBinary(ImmutableBinary! aBinary, Boolean aAllowBrokenDocument)

 

// Toffee
static func TryFromBinary(_ aBinary: ImmutableBinary, _ aAllowBrokenDocument: Boolean) -> XmlDocument
// ToffeeV2
static func TryFromBinary(_ aBinary: ImmutableBinary, _ aAllowBrokenDocument: Boolean) -> XmlDocument?

 

static XmlDocument TryFromBinary(ImmutableBinary aBinary, Boolean aAllowBrokenDocument)

 

Shared Function TryFromBinary(aBinary As ImmutableBinary, aAllowBrokenDocument As Boolean) As XmlDocument?

Parameters:

  • aBinary:
  • aAllowBrokenDocument:

TryFromFile (not nullable File): nullable XmlDocument .NET, .NET Standard 2.0, Cooper, Island-Android, Island-iOS, Island-iOS Simulator, Island-Mac Catalyst, Island-macOS, Island-tvOS, Island-tvOS Simulator, Island-Ubuntu, Island-watchOS, Island-watchOS Simulator, Island-Windows, Toffee, ToffeeV2

Try parse this xml node; if aAllowBrokenDocument is true, it always returns an xml document, but with error info set on failure.

 

class method TryFromFile(aFileName: not nullable File): nullable XmlDocument

 

static XmlDocument? TryFromFile(File! aFileName)

 

// Toffee
static func TryFromFile(_ aFileName: File) -> XmlDocument
// ToffeeV2
static func TryFromFile(_ aFileName: File) -> XmlDocument?

 

static XmlDocument TryFromFile(File aFileName)

 

Shared Function TryFromFile(aFileName As File) As XmlDocument?

Parameters:

  • aFileName:

TryFromFile (not nullable File, Boolean): nullable XmlDocument .NET, .NET Standard 2.0, Cooper, Island-Android, Island-iOS, Island-iOS Simulator, Island-Mac Catalyst, Island-macOS, Island-tvOS, Island-tvOS Simulator, Island-Ubuntu, Island-watchOS, Island-watchOS Simulator, Island-Windows, Toffee, ToffeeV2

Try parse this xml node; if aAllowBrokenDocument is true, it always returns an xml document, but with error info set on failure.

 

class method TryFromFile(aFileName: not nullable File; aAllowBrokenDocument: Boolean): nullable XmlDocument

 

static XmlDocument? TryFromFile(File! aFileName, Boolean aAllowBrokenDocument)

 

// Toffee
static func TryFromFile(_ aFileName: File, _ aAllowBrokenDocument: Boolean) -> XmlDocument
// ToffeeV2
static func TryFromFile(_ aFileName: File, _ aAllowBrokenDocument: Boolean) -> XmlDocument?

 

static XmlDocument TryFromFile(File aFileName, Boolean aAllowBrokenDocument)

 

Shared Function TryFromFile(aFileName As File, aAllowBrokenDocument As Boolean) As XmlDocument?

Parameters:

  • aFileName:
  • aAllowBrokenDocument:

TryFromString (not nullable String): nullable XmlDocument

Try parse this xml node; if aAllowBrokenDocument is true, it always returns an xml document, but with error info set on failure.

 

class method TryFromString(aString: not nullable String): nullable XmlDocument

 

static XmlDocument? TryFromString(String! aString)

 

// Toffee
static func TryFromString(_ aString: String) -> XmlDocument
// ToffeeV2
static func TryFromString(_ aString: String) -> XmlDocument?

 

static XmlDocument TryFromString(String aString)

 

Shared Function TryFromString(aString As String) As XmlDocument?

Parameters:

  • aString:

TryFromString (not nullable String, Boolean): nullable XmlDocument

Try parse this xml node; if aAllowBrokenDocument is true, it always returns an xml document, but with error info set on failure.

 

class method TryFromString(aString: not nullable String; aAllowBrokenDocument: Boolean): nullable XmlDocument

 

static XmlDocument? TryFromString(String! aString, Boolean aAllowBrokenDocument)

 

// Toffee
static func TryFromString(_ aString: String, _ aAllowBrokenDocument: Boolean) -> XmlDocument
// ToffeeV2
static func TryFromString(_ aString: String, _ aAllowBrokenDocument: Boolean) -> XmlDocument?

 

static XmlDocument TryFromString(String aString, Boolean aAllowBrokenDocument)

 

Shared Function TryFromString(aString As String, aAllowBrokenDocument As Boolean) As XmlDocument?

Parameters:

  • aString:
  • aAllowBrokenDocument:

TryFromUrl (not nullable Url): nullable XmlDocument

Try parse this xml node; if aAllowBrokenDocument is true, it always returns an xml document, but with error info set on failure.

 

class method TryFromUrl(aUrl: not nullable Url): nullable XmlDocument

 

static XmlDocument? TryFromUrl(Url! aUrl)

 

// Toffee
static func TryFromUrl(_ aUrl: Url) -> XmlDocument
// ToffeeV2
static func TryFromUrl(_ aUrl: Url) -> XmlDocument?

 

static XmlDocument TryFromUrl(Url aUrl)

 

Shared Function TryFromUrl(aUrl As Url) As XmlDocument?

Parameters:

  • aUrl:

TryFromUrl (not nullable Url, Boolean): nullable XmlDocument

Try parse this xml node; if aAllowBrokenDocument is true, it always returns an xml document, but with error info set on failure.

 

class method TryFromUrl(aUrl: not nullable Url; aAllowBrokenDocument: Boolean): nullable XmlDocument

 

static XmlDocument? TryFromUrl(Url! aUrl, Boolean aAllowBrokenDocument)

 

// Toffee
static func TryFromUrl(_ aUrl: Url, _ aAllowBrokenDocument: Boolean) -> XmlDocument
// ToffeeV2
static func TryFromUrl(_ aUrl: Url, _ aAllowBrokenDocument: Boolean) -> XmlDocument?

 

static XmlDocument TryFromUrl(Url aUrl, Boolean aAllowBrokenDocument)

 

Shared Function TryFromUrl(aUrl As Url, aAllowBrokenDocument As Boolean) As XmlDocument?

Parameters:

  • aUrl:
  • aAllowBrokenDocument:

Version

Returns the xml version.

 

property Version: String read write;

 

String Version { get; set; }

 

var Version: String { get{} set{} }

 

String Version { __get; __set; }

 

Property Version() As String

WithRootElement (not nullable XmlElement): not nullable XmlDocument

Create a new xml document with a root node.

 

class method WithRootElement(aElement: not nullable XmlElement): not nullable XmlDocument

 

static XmlDocument! WithRootElement(XmlElement! aElement)

 

static func WithRootElement(_ aElement: XmlElement) -> XmlDocument

 

static XmlDocument WithRootElement(XmlElement aElement)

 

Shared Function WithRootElement(aElement As XmlElement) As XmlDocument

Parameters:

  • aElement:

WithRootElement (not nullable String): not nullable XmlDocument

Create a new xml document with a root node.

 

class method WithRootElement(aName: not nullable String): not nullable XmlDocument

 

static XmlDocument! WithRootElement(String! aName)

 

static func WithRootElement(_ aName: String) -> XmlDocument

 

static XmlDocument WithRootElement(String aName)

 

Shared Function WithRootElement(aName As String) As XmlDocument

Parameters:

  • aName:

 

Encoding

Encoding in the xml tag.

 

property Encoding: String read write;

 

String Encoding { get; set; }

 

var Encoding: String { get{} set{} }

 

String Encoding { __get; __set; }

 

Property Encoding() As String

ErrorInfo

Error info during parsing.

 

property ErrorInfo: XmlErrorInfo read write;

 

XmlErrorInfo ErrorInfo { get; set; }

 

var ErrorInfo: XmlErrorInfo { get{} set{} }

 

XmlErrorInfo ErrorInfo { __get; __set; }

 

Property ErrorInfo() As XmlErrorInfo

Nodes

Returns all nodes in this file (at the root; generally a root node and xml declarion + comments)

 

property Nodes: ImmutableList<XmlNode> read;

 

ImmutableList<XmlNode> Nodes { get; }

 

var Nodes: ImmutableList<XmlNode> { get{} }

 

ImmutableList<XmlNode> Nodes { __get; }

 

ReadOnly Property Nodes() As ImmutableList<XmlNode>

Root

Returns the root element.

 

property Root: not nullable XmlElement read write;

 

XmlElement! Root { get; set; }

 

var Root: XmlElement { get{} set{} }

 

XmlElement Root { __get; __set; }

 

Property Root() As XmlElement

Standalone

True if this xml file has a header with standalone=true.

 

property Standalone: String read write;

 

String Standalone { get; set; }

 

var Standalone: String { get{} set{} }

 

String Standalone { __get; __set; }

 

Property Standalone() As String

Version

Returns the xml version.

 

property Version: String read write;

 

String Version { get; set; }

 

var Version: String { get{} set{} }

 

String Version { __get; __set; }

 

Property Version() As String

 

FromBinary

Parse an xml file.

 

class method FromBinary(aBinary: not nullable ImmutableBinary): not nullable XmlDocument

 

static XmlDocument! FromBinary(ImmutableBinary! aBinary)

 

static func FromBinary(_ aBinary: ImmutableBinary) -> XmlDocument

 

static XmlDocument FromBinary(ImmutableBinary aBinary)

 

Shared Function FromBinary(aBinary As ImmutableBinary) As XmlDocument

Parameters:

  • aBinary:

FromFile .NET, .NET Standard 2.0, Cooper, Island-Android, Island-iOS, Island-iOS Simulator, Island-Mac Catalyst, Island-macOS, Island-tvOS, Island-tvOS Simulator, Island-Ubuntu, Island-watchOS, Island-watchOS Simulator, Island-Windows, Toffee, ToffeeV2

Parse an xml file.

 

class method FromFile(aFileName: not nullable File): not nullable XmlDocument

 

static XmlDocument! FromFile(File! aFileName)

 

static func FromFile(_ aFileName: File) -> XmlDocument

 

static XmlDocument FromFile(File aFileName)

 

Shared Function FromFile(aFileName As File) As XmlDocument

Parameters:

  • aFileName:

FromString

Parse an xml file from a string.

 

class method FromString(aString: not nullable String): not nullable XmlDocument

 

static XmlDocument! FromString(String! aString)

 

static func FromString(_ aString: String) -> XmlDocument

 

static XmlDocument FromString(String aString)

 

Shared Function FromString(aString As String) As XmlDocument

Parameters:

  • aString:

FromUrl

Parse an xml file.

 

class method FromUrl(aUrl: not nullable Url): not nullable XmlDocument

 

static XmlDocument! FromUrl(Url! aUrl)

 

static func FromUrl(_ aUrl: Url) -> XmlDocument

 

static XmlDocument FromUrl(Url aUrl)

 

Shared Function FromUrl(aUrl As Url) As XmlDocument

Parameters:

  • aUrl:

TryFromBinary (not nullable ImmutableBinary): nullable XmlDocument

Try parse this xml node; if aAllowBrokenDocument is true, it always returns an xml document, but with error info set on failure.

 

class method TryFromBinary(aBinary: not nullable ImmutableBinary): nullable XmlDocument

 

static XmlDocument? TryFromBinary(ImmutableBinary! aBinary)

 

// Toffee
static func TryFromBinary(_ aBinary: ImmutableBinary) -> XmlDocument
// ToffeeV2
static func TryFromBinary(_ aBinary: ImmutableBinary) -> XmlDocument?

 

static XmlDocument TryFromBinary(ImmutableBinary aBinary)

 

Shared Function TryFromBinary(aBinary As ImmutableBinary) As XmlDocument?

Parameters:

  • aBinary:

TryFromBinary (not nullable ImmutableBinary, Boolean): nullable XmlDocument

Try parse this xml node; if aAllowBrokenDocument is true, it always returns an xml document, but with error info set on failure.

 

class method TryFromBinary(aBinary: not nullable ImmutableBinary; aAllowBrokenDocument: Boolean): nullable XmlDocument

 

static XmlDocument? TryFromBinary(ImmutableBinary! aBinary, Boolean aAllowBrokenDocument)

 

// Toffee
static func TryFromBinary(_ aBinary: ImmutableBinary, _ aAllowBrokenDocument: Boolean) -> XmlDocument
// ToffeeV2
static func TryFromBinary(_ aBinary: ImmutableBinary, _ aAllowBrokenDocument: Boolean) -> XmlDocument?

 

static XmlDocument TryFromBinary(ImmutableBinary aBinary, Boolean aAllowBrokenDocument)

 

Shared Function TryFromBinary(aBinary As ImmutableBinary, aAllowBrokenDocument As Boolean) As XmlDocument?

Parameters:

  • aBinary:
  • aAllowBrokenDocument:

TryFromFile (not nullable File): nullable XmlDocument .NET, .NET Standard 2.0, Cooper, Island-Android, Island-iOS, Island-iOS Simulator, Island-Mac Catalyst, Island-macOS, Island-tvOS, Island-tvOS Simulator, Island-Ubuntu, Island-watchOS, Island-watchOS Simulator, Island-Windows, Toffee, ToffeeV2

Try parse this xml node; if aAllowBrokenDocument is true, it always returns an xml document, but with error info set on failure.

 

class method TryFromFile(aFileName: not nullable File): nullable XmlDocument

 

static XmlDocument? TryFromFile(File! aFileName)

 

// Toffee
static func TryFromFile(_ aFileName: File) -> XmlDocument
// ToffeeV2
static func TryFromFile(_ aFileName: File) -> XmlDocument?

 

static XmlDocument TryFromFile(File aFileName)

 

Shared Function TryFromFile(aFileName As File) As XmlDocument?

Parameters:

  • aFileName:

TryFromFile (not nullable File, Boolean): nullable XmlDocument .NET, .NET Standard 2.0, Cooper, Island-Android, Island-iOS, Island-iOS Simulator, Island-Mac Catalyst, Island-macOS, Island-tvOS, Island-tvOS Simulator, Island-Ubuntu, Island-watchOS, Island-watchOS Simulator, Island-Windows, Toffee, ToffeeV2

Try parse this xml node; if aAllowBrokenDocument is true, it always returns an xml document, but with error info set on failure.

 

class method TryFromFile(aFileName: not nullable File; aAllowBrokenDocument: Boolean): nullable XmlDocument

 

static XmlDocument? TryFromFile(File! aFileName, Boolean aAllowBrokenDocument)

 

// Toffee
static func TryFromFile(_ aFileName: File, _ aAllowBrokenDocument: Boolean) -> XmlDocument
// ToffeeV2
static func TryFromFile(_ aFileName: File, _ aAllowBrokenDocument: Boolean) -> XmlDocument?

 

static XmlDocument TryFromFile(File aFileName, Boolean aAllowBrokenDocument)

 

Shared Function TryFromFile(aFileName As File, aAllowBrokenDocument As Boolean) As XmlDocument?

Parameters:

  • aFileName:
  • aAllowBrokenDocument:

TryFromString (not nullable String): nullable XmlDocument

Try parse this xml node; if aAllowBrokenDocument is true, it always returns an xml document, but with error info set on failure.

 

class method TryFromString(aString: not nullable String): nullable XmlDocument

 

static XmlDocument? TryFromString(String! aString)

 

// Toffee
static func TryFromString(_ aString: String) -> XmlDocument
// ToffeeV2
static func TryFromString(_ aString: String) -> XmlDocument?

 

static XmlDocument TryFromString(String aString)

 

Shared Function TryFromString(aString As String) As XmlDocument?

Parameters:

  • aString:

TryFromString (not nullable String, Boolean): nullable XmlDocument

Try parse this xml node; if aAllowBrokenDocument is true, it always returns an xml document, but with error info set on failure.

 

class method TryFromString(aString: not nullable String; aAllowBrokenDocument: Boolean): nullable XmlDocument

 

static XmlDocument? TryFromString(String! aString, Boolean aAllowBrokenDocument)

 

// Toffee
static func TryFromString(_ aString: String, _ aAllowBrokenDocument: Boolean) -> XmlDocument
// ToffeeV2
static func TryFromString(_ aString: String, _ aAllowBrokenDocument: Boolean) -> XmlDocument?

 

static XmlDocument TryFromString(String aString, Boolean aAllowBrokenDocument)

 

Shared Function TryFromString(aString As String, aAllowBrokenDocument As Boolean) As XmlDocument?

Parameters:

  • aString:
  • aAllowBrokenDocument:

TryFromUrl (not nullable Url): nullable XmlDocument

Try parse this xml node; if aAllowBrokenDocument is true, it always returns an xml document, but with error info set on failure.

 

class method TryFromUrl(aUrl: not nullable Url): nullable XmlDocument

 

static XmlDocument? TryFromUrl(Url! aUrl)

 

// Toffee
static func TryFromUrl(_ aUrl: Url) -> XmlDocument
// ToffeeV2
static func TryFromUrl(_ aUrl: Url) -> XmlDocument?

 

static XmlDocument TryFromUrl(Url aUrl)

 

Shared Function TryFromUrl(aUrl As Url) As XmlDocument?

Parameters:

  • aUrl:

TryFromUrl (not nullable Url, Boolean): nullable XmlDocument

Try parse this xml node; if aAllowBrokenDocument is true, it always returns an xml document, but with error info set on failure.

 

class method TryFromUrl(aUrl: not nullable Url; aAllowBrokenDocument: Boolean): nullable XmlDocument

 

static XmlDocument? TryFromUrl(Url! aUrl, Boolean aAllowBrokenDocument)

 

// Toffee
static func TryFromUrl(_ aUrl: Url, _ aAllowBrokenDocument: Boolean) -> XmlDocument
// ToffeeV2
static func TryFromUrl(_ aUrl: Url, _ aAllowBrokenDocument: Boolean) -> XmlDocument?

 

static XmlDocument TryFromUrl(Url aUrl, Boolean aAllowBrokenDocument)

 

Shared Function TryFromUrl(aUrl As Url, aAllowBrokenDocument As Boolean) As XmlDocument?

Parameters:

  • aUrl:
  • aAllowBrokenDocument:

WithRootElement (not nullable XmlElement): not nullable XmlDocument

Create a new xml document with a root node.

 

class method WithRootElement(aElement: not nullable XmlElement): not nullable XmlDocument

 

static XmlDocument! WithRootElement(XmlElement! aElement)

 

static func WithRootElement(_ aElement: XmlElement) -> XmlDocument

 

static XmlDocument WithRootElement(XmlElement aElement)

 

Shared Function WithRootElement(aElement As XmlElement) As XmlDocument

Parameters:

  • aElement:

WithRootElement (not nullable String): not nullable XmlDocument

Create a new xml document with a root node.

 

class method WithRootElement(aName: not nullable String): not nullable XmlDocument

 

static XmlDocument! WithRootElement(String! aName)

 

static func WithRootElement(_ aName: String) -> XmlDocument

 

static XmlDocument WithRootElement(String aName)

 

Shared Function WithRootElement(aName As String) As XmlDocument

Parameters:

  • aName:

 

AddNode

Add a node to this document. Note that xml documents only have 1 element node.

 

method AddNode(aNode: not nullable XmlNode)

 

void AddNode(XmlNode! aNode)

 

func AddNode(_ aNode: XmlNode)

 

void AddNode(XmlNode aNode)

 

Sub AddNode(aNode As XmlNode)

Parameters:

  • aNode:

GetCurrentCursorPosition

Given a row, col, returns info on the state at this point.

 

method GetCurrentCursorPosition(aRow: Int32; aColumn: Int32): XmlDocCurrentPosition

 

XmlDocCurrentPosition GetCurrentCursorPosition(Int32 aRow, Int32 aColumn)

 

func GetCurrentCursorPosition(_ aRow: Int32, _ aColumn: Int32) -> XmlDocCurrentPosition

 

XmlDocCurrentPosition GetCurrentCursorPosition(Integer aRow, Integer aColumn)

 

Function GetCurrentCursorPosition(aRow As Int32, aColumn As Int32) As XmlDocCurrentPosition

Parameters:

  • aRow:
  • aColumn:

NearestOpenTag

Finds the nearest open tag, given a row/col.

 

method NearestOpenTag(aRow: Int32; aColumn: Int32; out aCursorPosition: XmlPositionKind): XmlElement

 

XmlElement NearestOpenTag(Int32 aRow, Int32 aColumn, out XmlPositionKind aCursorPosition)

 

func NearestOpenTag(_ aRow: Int32, _ aColumn: Int32, _ aCursorPosition: XmlPositionKind) -> XmlElement

 

XmlElement NearestOpenTag(Integer aRow, Integer aColumn, __out XmlPositionKind aCursorPosition)

 

Function NearestOpenTag(aRow As Int32, aColumn As Int32, <OutAttribute> ByRef aCursorPosition As XmlPositionKind) As XmlElement

Parameters:

  • aRow:
  • aColumn:
  • aCursorPosition:

SaveToFile (not nullable File) .NET, .NET Standard 2.0, Cooper, Island-Android, Island-iOS, Island-iOS Simulator, Island-Mac Catalyst, Island-macOS, Island-tvOS, Island-tvOS Simulator, Island-Ubuntu, Island-watchOS, Island-watchOS Simulator, Island-Windows, Toffee, ToffeeV2

Save this node to a file.

 

method SaveToFile(aFileName: not nullable File)

 

void SaveToFile(File! aFileName)

 

func SaveToFile(_ aFileName: File)

 

void SaveToFile(File aFileName)

 

Sub SaveToFile(aFileName As File)

Parameters:

  • aFileName:

SaveToFile (not nullable File, XmlFormattingOptions) .NET, .NET Standard 2.0, Cooper, Island-Android, Island-iOS, Island-iOS Simulator, Island-Mac Catalyst, Island-macOS, Island-tvOS, Island-tvOS Simulator, Island-Ubuntu, Island-watchOS, Island-watchOS Simulator, Island-Windows, Toffee, ToffeeV2

Save this node to a file.

 

method SaveToFile(aFileName: not nullable File; aFormatOptions: XmlFormattingOptions)

 

void SaveToFile(File! aFileName, XmlFormattingOptions aFormatOptions)

 

func SaveToFile(_ aFileName: File, _ aFormatOptions: XmlFormattingOptions)

 

void SaveToFile(File aFileName, XmlFormattingOptions aFormatOptions)

 

Sub SaveToFile(aFileName As File, aFormatOptions As XmlFormattingOptions)

Parameters:

  • aFileName:
  • aFormatOptions:

toString Cooper

 

method toString: PlatformString

 

PlatformString toString()

 

func toString() -> PlatformString

 

PlatformString toString()

 

Function toString() As PlatformString

ToString  virtual Toffee, ToffeeV2

 

func ToString() -> String

Convert this xml node to string

 

method ToString(aFormatOptions: XmlFormattingOptions): String

 

String ToString(XmlFormattingOptions aFormatOptions)

 

func ToString(_ aFormatOptions: XmlFormattingOptions) -> String

 

String ToString(XmlFormattingOptions aFormatOptions)

 

Function ToString(aFormatOptions As XmlFormattingOptions) As String

Parameters:

  • aFormatOptions:

Convert this xml node to string

 

method ToString(aSaveFormatted: Boolean; aFormatOptions: XmlFormattingOptions): String

 

String ToString(Boolean aSaveFormatted, XmlFormattingOptions aFormatOptions)

 

func ToString(_ aSaveFormatted: Boolean, _ aFormatOptions: XmlFormattingOptions) -> String

 

String ToString(Boolean aSaveFormatted, XmlFormattingOptions aFormatOptions)

 

Function ToString(aSaveFormatted As Boolean, aFormatOptions As XmlFormattingOptions) As String

Parameters:

  • aSaveFormatted:
  • aFormatOptions: