Difference between revisions of "XElement class"

From Catglobe Wiki
Jump to: navigation, search
Line 1: Line 1:
 +
{{HelpFiles}}
 
{{CGscriptClass_Template
 
{{CGscriptClass_Template
 
|Name=<nowiki>XElement</nowiki>
 
|Name=<nowiki>XElement</nowiki>

Revision as of 07:48, 12 December 2011


XElement



An element in an xml document

Constructors

  • (params AnyType) - Create a new element with a number of child elements
  • (string xml "A xml string") - Create a new element from a string
  • (string name "Name of the element", AnyType value "Value of the element") - Create a new element with a name and value

Methods

  • Empty Add(AnyType content "Content to add") - Adds the specified content as children of this element.
  • Empty Add(params AnyType) - Adds the specified content as children of this element.
  • Empty AddAfterSelf(AnyType content "Content to add") - Adds the specified content immediately after this node.
  • Empty AddBeforeSelf(AnyType content "Content to add") - Adds the specified content immediately before this node.
  • Empty AddFirst(AnyType content "Content to add") - Adds the specified content as the first children of this document or element.
  • Empty AddFirst(params AnyType) - Adds the specified content as the first children of this document or element.
  • array Ancestors() - Returns a collection of the ancestor elements of this node.
  • array Ancestors(string name "Name of ancestor to look for") - Returns a filtered collection of the ancestor elements of this node. Only elements that have a matching name are included in the collection.
  • array AncestorsAndSelf() - Returns a collection of elements that contain this element, and the ancestors of this element.
  • array AncestorsAndSelf(string name "Name of ancestor to look for") - Returns a collection of elements that contain this element, and the ancestors of this element. Only elements that have a matching name are included in the collection.
  • array Descendants() - Returns a collection of the descendant elements for this document or element, in document order.
  • array Descendants(string name "Name of ancestor to look for") - Returns a collection of the descendant elements for this document or element, in document order. Only elements that have a matching name are included in the collection.
  • array DescendantsAndSelf() - Returns a collection of elements that contain this element, and all descendant elements of this element, in document order.
  • array DescendantsAndSelf(string name "Name of ancestor to look for") - Returns a filtered collection of elements that contain this element, and all descendant elements of this element, in document order. Only elements that have a matching name are included in the collection.
  • XElement Element(string name "Name of ancestor to look for") - Gets the first (in document order) child element with the specified name.
  • array Elements() - Returns a collection of the child elements of this element or document, in document order.
  • array Elements(string name "Name of ancestor to look for") - Returns a collection of the child elements of this element or document, in document order. Only elements that have a matching name are included in the collection.
  • array ElementsAfterSelf() - Returns a collection of the sibling elements after this node, in document order.
  • array ElementsAfterSelf(string name "Name of ancestor to look for") - Returns a filtered collection of the sibling elements after this node, in document order. Only elements that have a matching name are included in the collection.
  • array ElementsBeforeSelf() - Returns a collection of the sibling elements before this node, in document order.
  • array ElementsBeforeSelf(string name "Name of ancestor to look for") - Returns a filtered collection of the sibling elements before this node, in document order. Only elements that have a matching name are included in the collection.
  • string this[] { get; }(string attributename "The attribute name.") - Gets an attribute value.
  • Empty Remove() - Removes this node from its parent.
  • Empty RemoveAll() - Removes nodes and attributes from this element.
  • Empty RemoveAttributes() - Removes attributes from this element.
  • Empty RemoveNodes() - Removes the child nodes from this document or element.
  • Empty ReplaceWith(AnyType content "Content to replace with") - Replaces this node with the specified content.
  • Empty ReplaceWith(params AnyType) - Replaces this node with the specified content.
  • Empty ReplaceWith(AnyType content "Content to replace with") - Replaces the children nodes of this document or element with the specified content.
  • Empty ReplaceWith(params AnyType) - Replaces the children nodes of this document or element with the specified content.
  • Empty this[] { set; }(string attributename "The attribute name.", string value "Value to set.") - Sets an attribute value.
  • string ToString() - The string representation of the object.

Properties

  • Dictionary Attributes { get; set; } - Get/sets the collection of attributes of this element. The get returns a copy, use the indexer instead.
  • bool HasAttributes { get; } - Gets a value indicating whether this element as at least one attribute.
  • bool HasElements { get; } - Gets a value indicating whether this element has at least one child element.
  • bool IsEmpty { get; } - Gets a value indicating whether this element contains no content.
  • string Name { get; set; } - Gets/sets the name of this element.
  • string ObjectTypeName { get; } - The name of the type of object.
  • XElement Parent { get; } - Gets the parent XElement
  • TypeInformation TypeInformation { get; } - Get information about this class.
  • string Value { get; set; } - Gets/sets the concatenated text contents of this element.


Examples