 | CAEXWrapper Class |
This class is the base CAEXWrapper class, defined for all CAEX objects. The CAEXWrapper class supports
notifications of changes.
Inheritance HierarchyNamespace: Aml.Engine.CAEX
Assembly: Aml.Engine (in Aml.Engine.dll) Version: 3.2
SyntaxThe CAEXWrapper type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | CAEXWrapper | A new CAEXWrapper instance is constructed to wrap the provided XML element. |
Properties| Name | Description | |
|---|---|---|
 | CAEXDocument | 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. |
| CAEXParent | Gets the CAEXParent of this instance if it exists. |
| CAEXSequenceOfCAEXObject | Gets the CAEXSequence containing this CAEX object |
| Document | Gets the XDocument of the wrapped XML-Element |
| Exists | Determines if this is a wrapper around an existing XML-Element |
| IsDeleted | Determines, if this object is not contained in any document |
| Node | Gets the wrapped XML-Element |
| Owner | Gets the wrapped Xml-Element's parent |
| TagName | Gets the name of the CAEX tag for this CAEX object. |
Methods| Name | Description | |
|---|---|---|
| CAEXChild | Gets the first child of this CAEX object with the defined CAEX tag name. |
| CAEXChildren | Gets all children of this CAEX object with the defined CAEX tag name. |
| Copy | Creates a deep copy of this CAEX object |
| Equals |
Equality of CAEX wrapper instances is defined on the equality of the wrapped XML elements.
(Overrides ObjectEquals(Object)) |
| GetHashCode |
Gets the Hash code for this instance, using the wrapped XML element.
(Overrides ObjectGetHashCode) |
| GetXAttributeValue | Gets the value of the Xml-Attribute with the specified attribute name of the wrapped Xml-Element. |
| InsertNew | 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. |
| Remove | Removes this element. After that it is no longer assigned to a document and has no owner anymore. |
| SetXAttributeValue | Sets the value of an attribute, adds an attribute, or removes an attribute (if the value is null). |
Events| Name | Description | |
|---|---|---|
 | PropertyChanged | The Change event raised when any property is modified. |
Operators| Name | Description | |
|---|---|---|
  | Equality(CAEXWrapper, CAEXWrapper) | operator overload (compares the wrapped nodes) |
| Inequality(CAEXWrapper, CAEXWrapper) | operator overload (compares the wrapped nodes) |
Extension Methods| Name | Description | |
|---|---|---|
 | AMLSchemaManager |
Gets the associated CAEX schema manager of the CAEX object.
(Defined by CAEXBasicObjectExtensions) |
| Ancestors |
Finds all ancestors of the provided CAEX object.
(Defined by CAEXBasicObjectExtensions) |
| AncestorsT |
Finds the ancestors of the provided CAEX object which have the given type.
(Defined by CAEXBasicObjectExtensions) |
| CAEXDocument |
Gets the CAEX document which contains this CAEX object.
(Defined by CAEXBasicObjectExtensions) |
| CAEXFile |
Gets the CAEX file which contains this CAEX object.
(Defined by CAEXBasicObjectExtensions) |
| CAEXSchema |
Gets the associated CAEX schema of the CAEX object.
(Defined by CAEXBasicObjectExtensions) |
| Descendants |
Finds all descendants of the provided CAEX object.
(Defined by CAEXBasicObjectExtensions) |
| Descendants |
Finds the descendants of the provided CAEX object which are of the given type.
(Defined by CAEXBasicObjectExtensions) |
| DescendantsT |
Finds the descendants of the provided CAEX object which are of the given type.
(Defined by CAEXBasicObjectExtensions) |
| DescendantsT |
Finds the descendants of the provided CAEX object which are of the given type.
(Defined by CAEXBasicObjectExtensions) |
| FindCaexObjectFromIdT |
Finds the CAEX object with the specified id and the specified Type.
(Defined by CAEXBasicObjectExtensions) |
| FindReferencedClassT |
Finds the CAEX object with the specified CAEX path and the specified Type.
(Defined by CAEXBasicObjectExtensions) |
| FirstAncestor |
Finds the first ancestor of the specified CAEX object which fulfils the specified predicate
(Defined by CAEXBasicObjectExtensions) |
| FirstAncestor |
Finds the first ancestor of the specified CAEX object with the given Tag name
(Defined by CAEXBasicObjectExtensions) |
| FirstAncestorT |
Finds the first ancestor of the specified CAEX object in the given Type.
(Defined by CAEXBasicObjectExtensions) |
| GetParentT |
Tries to get a CAEX parent with the specified Type of the provided caexObject. If the parent is
not assignable to the provided type, the result is null.
(Defined by CAEXBasicObjectExtensions) |
| IsAMLObject |
Determines whether the CAEX object is an AutomationML object. If the CAEX object is a SystemUnitClass or
InternalElement,
it is checked, if there exists a role reference to the AutomationMLBaseRole. If the CAEX object is an
ExternalInterface,
it is checked, if there exists an InterfaceClass reference to an AutomationMLBase Interface.
(Defined by AmlObjectsExtensions) |
| Library |
Gets the Library which contains this CAEX object.
(Defined by CAEXBasicObjectExtensions) |
| Name |
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) |
See AlsoInheritance Hierarchy