[This is preliminary documentation and is subject to change.]
Declaration Syntax| C# | Visual Basic | Visual C++ |
[SerializableAttribute] public abstract class Element : ISerializable, ICloneable
<SerializableAttribute> _ Public MustInherit Class Element _ Implements ISerializable, ICloneable
[SerializableAttribute] public ref class Element abstract : ISerializable, ICloneable
Members| All Members | Methods | Properties | |||
| Icon | Member | Description |
|---|---|---|
 | Clone()() | |
| CompareTo(Element) | Compare the text value of this Element to another Element |
 | DoNotEncode |
Determines if automatic XML Encoding of character entities should be
performed on this element when rendered by the ADK.
|
| ElementDef | Gets the metadata for this Element |
| IsChanged()() | Determines if this object is in the changed state. |
| IsEmpty()() | Determines if this object is in the empty state |
| Parent |
Gets or sets the parent of this Element.
|
| Root | Enumerating the ancestry of this object to return the root Element |
| SetChanged()() | Sets this DataObject and each of its children to the dirty state. An
object in the dirty state will not be written to an XML stream when a
SIF message is rendered.
|
| SetChanged(Boolean) | Sets this DataObject and each of its children to the specified dirty
state. An object in the dirty state will not be written to an XML stream
when a SIF message is rendered.
|
| SetEmpty()() | Sets this DataObject and each of its children to the empty state. An
object in the empty state will be written to an XML stream as an empty
element with no attributes and no child elements.
|
| SetEmpty(Boolean) | Sets this DataObject and each of its children to the specified empty
state. An object in the empty state will be written to an XML stream as
an empty element with no attributes and no child elements.
|
| SifValue | Gets or sets the SIF strongly-typed value of this element if applicable |
| TextValue | Gets or sets the text value of this element if applicable |
| ToString()() | Returns the value of getTextValue (Overrides Object.ToString()().) |
RemarksAgent developers do not generally work with this class directly.
Each Element instance is associated with an IElementDef that both identifies and describes the element or attribute encapsulated by this class. IElementDef constants are defined by the SifDtd class for each element and attribute defined in the SIF Specification. These objects provide information about how to render elements in a version-dependent way, including the tag name and sequence number (which may vary from one version of SIF to the next), the Sdo implementation class name, the earliest version of SIF the element or attribute appeared in, and the latest version of SIF that supports the element or attribute.
An IElementDef must be provided to the constructor. Inheritance Hierarchy| Object | ||
 | Element | |
 | SifElement | |
| SimpleField | |