TCnXDocument Class

Represents an XML document.

Namespace: CNClrLib.Component.XDocument
TComponent
  CNClrLib.Control.Base.TClrBaseComponent
    CNClrLib.Component.XDocument.TCnXDocument
type
 TCnXDocument = class(TClrBaseComponent)
 end;

The TCnXDocument type exposes the following members.

Show:
 NameDescription
Create(TComponent)

Creates and initializes a TCnXDocument instance. (Overrides TClrBaseComponent.Create(TComponent).)

Destroy

Frees the resources allocated with a TCnXDocument instance. (Overrides TClrBaseComponent.Destroy.)

Top
Show:
 NameDescription
BaseUri

Gets the base URI for this document.

Declaration

Gets the _XDocument for this document.

DefaultClrObject

Get the common language runtime object interface for this component. (Inherited from TClrBaseComponent.)

Document

Gets or sets the XML declaration for this document.

DocumentType

Gets the Document Type Definition (DTD) for this document.

FileName

A string that references the file name to load into this document.

FirstNode

Get the first child node for this document.

LastNode

Get the last child node for this document.

NextNode

Gets the next sibling node for this document.

NodeType

Gets the node type for this document.

Parent

Gets the element of the XML Tree for this document.

PreviousNode

Gets the previous sibling node for this document.

Root

Gets the root element of the XML Tree for this document.

Uri

A URI string that references the file to load into a this document.

XmlText

A string that contains XML.

Top
Show:
 NameDescription
Add(Olevariant)

Overloaded. Adds the specified content as children of this document.

Add(_ObjectArray)

Overloaded. Adds the specified content as children of this document.

AddAfterSelf(Olevariant)

Overloaded. Adds the specified content immediately after this node.

AddAfterSelf(_ObjectArray)

Overloaded. Adds the specified content immediately after this node.

AddAnnotation(Olevariant)

Adds an object to the annotation list of this document.

AddBeforeSelf(Olevariant)

Overloaded. Adds the specified content immediately before this node.

AddBeforeSelf(_ObjectArray)

Overloaded. Adds the specified content immediately before this node.

AddFirst(Olevariant)

Overloaded. Adds the specified content as the first children of this document.

AddFirst(_ObjectArray)

Overloaded. Adds the specified content as the first children of this document.

Ancestors

Overloaded. Returns a collection of the ancestor elements of this document.

Ancestors(_XName)

Overloaded. Returns a filtered collection of the ancestor elements of this document. Only elements that have a matching XName are included in the collection.

Annotation(_Type)

Overloaded. Gets the first annotation object of the specified type from this document.

Annotations(_Type)

Overloaded. Gets a collection of annotations of the specified type for this document.

CreateReader

Overloaded. Creates an XmlReader for this document.

CreateReader(TReaderOptions_Set)

Overloaded. Creates an XmlReader for this document with the options specified by the readerOptions parameter.

CreateWriter

Creates an XmlWriter that can be used to add nodes to the document.

DescendantNodes

Returns a collection of the descendant nodes for this document, in document order.

Descendants

Overloaded. Returns a collection of the descendant elements for this document, in document order.

Descendants(_XName)

Overloaded. Returns a filtered collection of the descendant elements for this document, in document order. Only elements that have a matching XName are included in the collection.

Dispose

Releases the resources used by the Component. (Inherited from TClrBaseComponent.)

DoGetDefaultClrObject

Represents method DoGetDefaultClrObject. (Overrides TClrBaseComponent.DoGetDefaultClrObject.)

DoGetDotNetBaseComponent

Represents method DoGetDotNetBaseComponent. (Overrides TClrBaseComponent.DoGetDotNetBaseComponent.)

Element(_XName)

Gets the first (in document order) child element with the specified XName.

Elements

Overloaded. Returns a collection of the child elements of this document, in document order.

Elements(_XName)

Overloaded. Returns a filtered collection of the child elements of this document, in document order. Only elements that have a matching XName are included in the collection.

ElementsAfterSelf

Overloaded. Returns a collection of the sibling elements after this node, in document order.

ElementsAfterSelf(_XName)

Overloaded. Returns a filtered collection of the sibling elements after this node, in document order. Only elements that have a matching XName are included in the collection.

ElementsBeforeSelf

Overloaded. Returns a collection of the sibling elements before this node, in document order.

ElementsBeforeSelf(_XName)

Overloaded. Returns a filtered collection of the sibling elements before this node, in document order. Only elements that have a matching XName are included in the collection.

GetClrObject

Represents method GetClrObject. (Inherited from TClrBaseComponent.)

IsAfter(_XNode)

Determines if the current node appears after a specified node in terms of document order.

IsBefore(_XNode)

Determines if the current node appears before a specified node in terms of document order.

Load(String)

Overloaded. Load an XML document from a URI string that references the file to load.

Load(String,TLoadOptions_Set)

Overloaded. Load an XML document from a URI string that references the file to load, optionally preserving white space, setting the base URI, and retaining line information.

Load(_Stream)

Overloaded. Load an XML document from the specified stream.

Load(_Stream,TLoadOptions_Set)

Overloaded. Load an XML document from the specified stream, optionally preserving white space, setting the base URI, and retaining line information.

Load(_TextReader)

Overloaded. Load an XML document from the specified TextReader.

Load(_TextReader,TLoadOptions_Set)

Overloaded. Load an XML document from the specified TextReader, optionally preserving white space, setting the base URI, and retaining line information.

Load(_XmlReader)

Overloaded. Load an XML document from the specified XmlReader.

Load(_XmlReader,TLoadOptions_Set)

Overloaded. Load an XML document from the specified XmlReader, optionally preserving white space, setting the base URI, and retaining line information.

Nodes

Returns a collection of the child nodes of this document, in document order.

NodesAfterSelf

Adds the specified content immediately after this node.

NodesBeforeSelf

Adds the specified content immediately before this node.

Parse(String)

Overloaded. Creates a new Xml document from a string.

Parse(String,TLoadOptions_Set)

Overloaded. Creates a new Xml document from a string, optionally preserving white space, setting the base URI, and retaining line information.

RegisterEventCallBack(ClrWString,Pointer)

Add an event to the instance using the specified event name and function pointer which is the event handler. The RegisterEventCallBack method does not directly add the event handler to the event. A hooking mechanism is used such that if the event is fired, the hook event is also fired which in turn calls the function pointer. (Inherited from TClrBaseComponent.)

RegisterEventSource

Register the Delphi object which will raise the .Net event handler. (Inherited from TClrBaseComponent.)

Remove

Removes this node from its parent.

RemoveAnnotations(_Type)

Overloaded. Removes the annotations of the specified type from this document.

RemoveNodes

Removes the child nodes from this document.

ReplaceNodes(Olevariant)

Overloaded. Replaces the children nodes of this document or element with the specified content.

ReplaceNodes(_ObjectArray)

Overloaded. Replaces the children nodes of this document or element with the specified content.

ReplaceWith(Olevariant)

Overloaded. Replaces this node with the specified content.

ReplaceWith(_ObjectArray)

Overloaded. Replaces this node with the specified content.

Save(String)

Overloaded. Serialize this document to a file, overwriting an existing file, if it exists.

Save(String,TSaveOptions_Set)

Overloaded. Serialize this document to a file, optionally disabling formatting.

Save(_Stream)

Overloaded. Outputs this document to the specified Stream.

Save(_Stream,TSaveOptions_Set)

Overloaded. Outputs this document to the specified Stream, optionally specifying formatting behavior.

Save(_TextWriter)

Overloaded. Serialize this document to a TextWriter.

Save(_TextWriter,TSaveOptions_Set)

Overloaded. Serialize this document to a TextWriter, optionally disabling formatting.

Save(_XmlWriter)

Overloaded. Serialize this document to an XmlWriter.

ToString(TSaveOptions_Set)

Returns the XML for this node, optionally disabling formatting.

UnRegisterEventCallBack(ClrWString,Pointer)

Remove an event from the instance using the specified event name and function pointer which is the event handler. (Inherited from TClrBaseComponent.)

UnRegisterEventSource

Unregister the Delphi object which raised the .Net event handler. (Inherited from TClrBaseComponent.)

WriteTo(_XmlWriter)

Write this document to an _XmlWriter .

Top
Show:
 NameDescription
OnChanged

Raised when this document or any of its descendants have changed.

OnChanging

Raised when this document or any of its descendants are about to change.

Top

See C:\Users\Public\Documents\CrystalNet Technologies\.Net VCL for Delphi Demo Folder after installation for examples of how to use this component.