SimpleDocument Class |
14c (14.1.1.0)
F23534-02
A simple implementation of the IXmlDocument interface.
Inheritance HierarchySystemObject
Tangosol.Run.XmlSimpleValue
Tangosol.Run.XmlSimpleElement
Tangosol.Run.XmlSimpleDocument
Tangosol.Run.XmlSimpleValue
Tangosol.Run.XmlSimpleElement
Tangosol.Run.XmlSimpleDocument
Namespace: Tangosol.Run.Xml
Assembly: Coherence (in Coherence.dll) Version: 14.1.1.14 (14.1.1.14)
SyntaxC#
public class SimpleDocument : SimpleElement, IXmlDocument, IXmlElement, IXmlValue, ICloneable
The SimpleDocument type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | SimpleDocument |
Construct an empty SimpleDocument.
|
| SimpleDocument(String) |
Construct a SimpleDocument.
|
| SimpleDocument(String, String, String) |
Construct a SimpleDocument.
|
Properties| Name | Description | |
|---|---|---|
 | AbsolutePath |
Get the '/'-delimited path of the element starting from the root
element.
(Inherited from SimpleElement.) |
| Attributes |
Get the dictionary of all attributes.
(Inherited from SimpleElement.) |
| Comment |
Get or set the text of any comments that are in the XML element.
(Inherited from SimpleElement.) |
| DocumentComment |
Get or set the XML comment that appears outside of the root
element.
|
 | DtdName |
Get or set the public identifier of the DTD (DOCTYPE) for the
document.
|
| DtdUri |
Get or set the URI of the DTD (DOCTYPE) for the document.
|
| ElementList |
Get the list of all child elements.
(Inherited from SimpleElement.) |
| Encoding |
Get or set the encoding string for the XML document.
|
 | InternalValue |
Get or set the internal value of this IXmlValue.
(Inherited from SimpleValue.) |
| IsAttribute |
Determine if this value is an element attribute.
(Inherited from SimpleValue.) |
| IsContent |
Determine if this value is an element's content.
(Inherited from SimpleValue.) |
| IsEmpty |
Determine if the value is empty.
(Inherited from SimpleValue.) |
| IsMutable |
Determine if this value can be modified.
(Inherited from SimpleValue.) |
| IsNameMutable |
Determine if the name can be changed.
(Inherited from SimpleElement.) |
| Name |
Get or set the name of the element.
(Inherited from SimpleElement.) |
| Parent |
Get or set the parent element of this value.
(Inherited from SimpleValue.) |
| Root |
Get the root element.
(Inherited from SimpleElement.) |
| Value |
Get the value as an object.
(Inherited from SimpleValue.) |
Methods| Name | Description | |
|---|---|---|
| AddAttribute |
Provides a means to add a new attribute value.
(Inherited from SimpleElement.) |
| AddElement |
Create a new element and add it as a child element to this
element.
(Inherited from SimpleElement.) |
 | CheckMutable |
Validates that the element is mutable, otherwise throws an
InvalidOperationException.
(Overrides SimpleElementCheckMutable.) |
| Clone |
Creates and returns a copy of this SimpleElement.
(Inherited from SimpleElement.) |
| Convert |
Convert the passed object to the specified type.
(Inherited from SimpleValue.) |
| EnsureElement |
Ensure that a child element exists.
(Inherited from SimpleElement.) |
| EnsureType |
Change the type of the internal representation of the IXmlValue.
(Inherited from SimpleValue.) |
| Equals |
Compare this XML document and all of its contained information
with another XML document for equality.
(Overrides SimpleElementEquals(Object).) |
| Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| FindElement |
Find a child element with the specified '/'-delimited path.
(Inherited from SimpleElement.) |
| GetAttribute |
Get an attribute value.
(Inherited from SimpleElement.) |
| GetBinary |
Get the value as Binary.
(Inherited from SimpleValue.) |
| GetBinary(Binary) |
Get the value as Binary.
(Inherited from SimpleValue.) |
| GetBoolean |
Get the value as a boolean.
(Inherited from SimpleValue.) |
| GetBoolean(Boolean) |
Get the value as a boolean.
(Inherited from SimpleValue.) |
| GetDateTime |
Get the value as a DateTime.
(Inherited from SimpleValue.) |
| GetDateTime(DateTime) |
Get the value as a DateTime.
(Inherited from SimpleValue.) |
| GetDecimal |
Get the value as a decimal.
(Inherited from SimpleValue.) |
| GetDecimal(Decimal) |
Get the value as a Decimal.
(Inherited from SimpleValue.) |
| GetDouble |
Get the value as a double.
(Inherited from SimpleValue.) |
| GetDouble(Double) |
Get the value as a double.
(Inherited from SimpleValue.) |
| GetElement |
Get a child element.
(Inherited from SimpleElement.) |
| GetElements |
Get an enumerator of child elements that have a specific name.
(Inherited from SimpleElement.) |
| GetHashCode |
Provide a hash value for this XML document and all of its
contained information.
(Overrides SimpleElementGetHashCode.) |
| GetInt |
Get the value as an int.
(Inherited from SimpleValue.) |
| GetInt(Int32) |
Get the value as an int.
(Inherited from SimpleValue.) |
| GetLong |
Get the value as a long.
(Inherited from SimpleValue.) |
| GetLong(Int64) |
Get the value as a long.
(Inherited from SimpleValue.) |
| GetSafeAttribute |
Get an attribute value, and return a temporary value if the
attribute does not exist.
(Inherited from SimpleElement.) |
| GetSafeElement |
Return the specified child element using the same path notation
as supported by FindElement(String), but return a
read-only element if the specified element does not exist.
(Inherited from SimpleElement.) |
| GetString |
Get the value as a string.
(Inherited from SimpleValue.) |
| GetString(String) |
Get the value as a string.
(Inherited from SimpleValue.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| InstantiateAttribute |
Instantiate an IXmlValue implementation for an
attribute value.
(Inherited from SimpleElement.) |
| InstantiateAttributes |
Instantiate an IDictionary implementation that will
support the name to value dictionary used to hold attributes.
(Inherited from SimpleElement.) |
| InstantiateElement |
Instantiate an IXmlElement implementation for an element.
(Inherited from SimpleElement.) |
| InstantiateElementList |
Instantiate an IList implementation that will hold child
elements.
(Inherited from SimpleElement.) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| ReadExternal |
Restore the contents of a user type instance by reading its state
using the specified IPofReader object.
(Overrides SimpleElementReadExternal(IPofReader).) |
| SetAttribute |
Set an attribute value.
(Inherited from SimpleElement.) |
| SetBinary |
Set the Binary value.
(Inherited from SimpleValue.) |
| SetBoolean |
Set the boolean value.
(Inherited from SimpleValue.) |
| SetDateTime |
Set the value as a DateTime.
(Inherited from SimpleValue.) |
| SetDecimal |
Set the decimal value.
(Inherited from SimpleValue.) |
| SetDouble |
Set the double value.
(Inherited from SimpleValue.) |
| SetInt |
Set the int value.
(Inherited from SimpleValue.) |
| SetLong |
Set the long value.
(Inherited from SimpleValue.) |
| SetString |
Set the string value.
(Inherited from SimpleValue.) |
| ToString |
Format the XML element and all its contained information into a
string in a display format.
(Inherited from SimpleElement.) |
| ToString(Boolean) |
Format the XML element and all its contained information into a
string in a display format.
(Inherited from SimpleElement.) |
| WriteAttributes |
Write the attributes as part of a start tag.
(Inherited from SimpleElement.) |
| WriteChildren |
Write the element's children.
(Inherited from SimpleElement.) |
| WriteComment |
Write the comment as it will appear in XML.
(Inherited from SimpleElement.) |
| WriteEmptyTag |
Write the element as a combined start/end tag.
(Inherited from SimpleElement.) |
| WriteEndTag |
Write the element's end tag.
(Inherited from SimpleElement.) |
| WriteExternal |
Save the contents of a POF user type instance by writing its
state using the specified IPofWriter object.
(Overrides SimpleElementWriteExternal(IPofWriter).) |
| WriteStartTag |
Write the element's start tag.
(Inherited from SimpleElement.) |
| WriteValue |
Write the value as it will appear in XML.
(Inherited from SimpleElement.) |
| WriteXml |
Write the XML document, including an XML header and DOCTYPE if
one exists.
(Overrides SimpleElementWriteXml(TextWriter, Boolean).) |
Extension Methods| Name | Description | |
|---|---|---|
 | IterateThroughAllNodes |
Takes an IXmlDocument and iterate through all nodes to perform action
on each node.
(Defined by IXmlDocumentExtension.) |
Remarks
Protected methods are provided to support inheriting classes.
See Also