Click or drag to resize

DescriptionType Class

This class is a wrapper for the CAEX element 'Description'.
Inheritance Hierarchy

Namespace: Aml.Engine.CAEX
Assembly: Aml.Engine (in Aml.Engine.dll) Version: 3.2
Syntax
public class DescriptionType : BaseElementType<string>

The DescriptionType type exposes the following members.

Constructors
 NameDescription
Public methodDescriptionType Initializes a new instance of the DescriptionType class.
Top
Properties
 NameDescription
Public propertyCAEXDocument Gets the CAEX document of this CAEX object. If the CAEX object has not been inserted into a document or has been removed from the document, the value is null.
(Inherited from CAEXWrapper)
Public propertyCAEXParent Gets the CAEXParent of this instance if it exists.
(Inherited from CAEXWrapper)
Public propertyCAEXSequenceOfCAEXObject Gets the CAEXSequence containing this CAEX object
(Inherited from CAEXWrapper)
Public propertyChangeMode Optionally describes the change state of a CAEX object. If used, the ChangeMode shall have the following value range: state, create, delete and change. This information should be used for further change management applications.
(Inherited from BaseElementTypeTDataType)
Public propertyDocument Gets the XDocument of the wrapped XML-Element
(Inherited from CAEXWrapper)
Public propertyExists Determines if this is a wrapper around an existing XML-Element
(Inherited from CAEXWrapper)
Public propertyIsDeleted Determines, if this object is not contained in any document
(Inherited from CAEXWrapper)
Public propertyNode Gets the wrapped XML node.
(Inherited from CAEXWrapperTDataType)
Public propertyOwner Gets the wrapped Xml-Element's parent
(Inherited from CAEXWrapper)
Public propertyTagName Gets the name of the CAEX tag for this CAEX object.
(Inherited from CAEXWrapper)
Public propertyValue Gets and sets the value of the wrapped XML node, according to the defined DataType. If the element doesn't exists, it is created and inserted into the document as a child of the defined owner.
(Inherited from CAEXWrapperTDataType)
Top
Methods
 NameDescription
Public methodCAEXChild Gets the first child of this CAEX object with the defined CAEX tag name.
(Inherited from CAEXWrapper)
Public methodCAEXChildren Gets all children of this CAEX object with the defined CAEX tag name.
(Inherited from CAEXWrapper)
Public methodCopy Creates a deep copy of this CAEX object
(Inherited from CAEXWrapper)
Public methodEquals Equality of CAEX wrapper instances is defined on the equality of the wrapped XML elements.
(Inherited from CAEXWrapper)
Public methodGetHashCode Gets the Hash code for this instance, using the wrapped XML element.
(Inherited from CAEXWrapper)
Public methodGetXAttributeValue Gets the value of the Xml-Attribute with the specified attribute name of the wrapped Xml-Element.
(Inherited from CAEXWrapper)
Public methodInsertNew This method can be used to create an XML node, if this CAEX wrapper was instantiated without an XML node. This method can only be applied, if an Owner is defined. The new created CAEX object is inserted as a new child of the owner.
(Inherited from CAEXWrapper)
Public methodRemove Removes this element. After that it is no longer assigned to a document and has no owner anymore.
(Inherited from CAEXWrapper)
Public methodSetXAttributeValue Sets the value of an attribute, adds an attribute, or removes an attribute (if the value is null).
(Inherited from CAEXWrapper)
Top
Events
 NameDescription
Public eventPropertyChanged The Change event raised when any property is modified.
(Inherited from CAEXWrapper)
Top
Extension Methods
 NameDescription
Public Extension MethodDescendants Finds all descendants of the provided CAEX object.
(Defined by CAEXBasicObjectExtensions)
Public Extension MethodDescendants Finds the descendants of the provided CAEX object which are of the given type.
(Defined by CAEXBasicObjectExtensions)
Public Extension MethodDescendantsT Finds the descendants of the provided CAEX object which are of the given type.
(Defined by CAEXBasicObjectExtensions)
Public Extension MethodName Gets a names for the specified CAEX wrapper object. If the specified object is a CAEXObject, the Name is returned; otherwise the TagName of the CAEX item.
(Defined by CAEXBasicObjectExtensions)
Top
See Also