AVEVA Database .NET Public Interface

DbElement Methods

The methods of the DbElement class are listed below. For a complete list of DbElement class members, see the DbElement Members topic.

Public Static Methods

GetElementOverloaded. Get a null Element instance.

Public Instance Methods

AtDefault Query whether the named Attribute of this Element has default value. If attribute is invalid, method returns false.
ChangeType Change the type of this Element. Method throws an exception if not allowed.
Claim Claim this Element. Throws an exception if element cannot be claimed
ClaimHierarchy Claim this Element and all its descendants. Throws an exception if all elements cannot be claimed. Even if some elements cannot be claimed, the method will claim what it can.
Clone Return a new instance representing this Element.
CompareTo Compare this Element with general object.
Copy Copy attributes from another Element. This method throws an exception if operation fails.
CopyHierarchy Copy attributes from another Element, and create a copy of Element's descendants. This method throws an exception if operation fails.
CopyLike Copy only a subset of attributes from another Element, as determined by attribute definitions. Examples of attributes NOT copied are POS/ORI. The list is documented in the 'COPY LIKE' section of the database reference manual. This method throws an exception if operation fails.
Create Create a new Element at given position in this Element's child list. This method throws an exception if operation fails.
CreateAfter Create a new Element after this Element in owner's child list. This method throws an exception if operation fails.
CreateBefore Create a new Element before this Element in owner's child list. This method throws an exception if operation fails.
CreateCopyHierarchyAfter Create copy of an Element hierarchy after this Element in owner's child list. This method throws an exception if operation fails.
CreateCopyHierarchyAfterLast Create copy of an Element hierarchy at the end of this Element's owner's child list. This method throws an exception if operation fails.
CreateCopyHierarchyBefore Create copy of an Element hierarchy before this Element in owner's child list. This method throws an exception if operation fails.
CreateCopyHierarchyBeforeFirst Create copy Element hierarchy at the beginning of this Element's owner's child list. This method throws an exception if operation fails.
CreateFirst Create new Element at the beginning of this Element's child list. This method throws an exception if operation fails.
CreateLast Create new Element at the end of this Element's child list. This method throws an exception if operation fails.
DbNo Database number for the Database containing this Element
Delete Delete this Element. This method throws an exception if operation fails.
DeleteRule Delete the Rule, attached to the given Attribute, from this Element. This method throws an exception if operation fails.
Equals Compare this Element with general object.
EvaluateBool Evaluate boolean valued PML1 Expression against this Element. Example of such an expression is (HBORE GT 100). This method throws an exception if expression can not be evaluated.
EvaluateDouble Evaluate numerical valued PML1 Expression against this Element. Example of such an expression is (DIAM * 2). This method throws an exception if expression can not be evaluated.
EvaluateElement Evaluate reference valued PML1 Expression against this Element. Example of such an expression is (BOX 2 OF /MyEquip ). This method throws an exception if expression can not be evaluated.
EvaluateString Evaluate text valued PML1 Expression against this Element. Example of such an expression is (DESC + 'Sometext') This method throws an exception if expression can not be evaluated.
ExecuteAllRules Execute all Rules on this Element. This method throws an exception if rules cannot be executed.
ExecuteRule Execute the Rule, attached to the given Attribute, on this Element. This method throws an exception if rules cannot be executed.
ExistRule Queries whether a Rule is attached to the given Attribute on this Element.
FirstMemberOverloaded. Navigate to first child Element that has given type.
GetActualType Get the actual type of this Element. Where this is a User-Defined Element Type, that is returned.
GetAsStringOverloaded. As for standard GetAsString() but allowing for an string qulaifier.
GetAsStringArrayOverloaded. Deprecated- do not use. Use method with DbQualifier instead.
GetAttributeOverloaded. Deprecated- do not use. Use method with DbQualifier instead.
GetAttributeArrayOverloaded. Deprecated- do not use. Use method with DbQualifier instead.
GetAttributes Get all the Attributes on this Element.
GetAttributesWithRules Get all Attributes on this Element that have Rules.
GetBoolOverloaded. Deprecated- do not use. Use method with DbQualifier instead.
GetBoolArrayOverloaded. Deprecated- do not use. Use method with DbQualifier instead.
GetDate Get Date-Time Attribute value on Element. This method throws an exception if attribute is invalid.
GetDateTime Get Date-Time Attribute value on Element. This method throws an exception if attribute is invalid.
GetDirectionOverloaded. Deprecated- do not use. Use method with DbQualifier instead.
GetDoubleOverloaded. Deprecated- do not use. Use method with DbQualifier instead.
GetDoubleArrayOverloaded. Deprecated- do not use. Use method with DbQualifier instead.
GetElementOverloaded. Deprecated- do not use. Use method with DbQualifier instead.
GetElementArrayOverloaded. Deprecated- do not use. Use method with DbQualifier instead.
GetElementTypeOverloaded. Deprecated- do not use. Use method with DbQualifier instead.
GetElementTypeArrayOverloaded. Deprecated- do not use. Use method with DbQualifier instead.
GetExpression Get Expression instance given by Attribute on Element. This method throws an exception if attribute is invalid.
GetHashCode Get the hash code for this Element, overriding Object.GetHashCode.
GetIntegerOverloaded. Deprecated- do not use. Use method with DbQualifier instead.
GetIntegerArrayOverloaded. Deprecated- do not use. Use method with DbQualifier instead.
GetOrientationOverloaded. Deprecated- do not use. Use method with DbQualifier instead.
GetParameterList Get ParameterList Attribute value on Element. This method throws an exception if attribute is invalid.
GetPositionOverloaded. Deprecated- do not use. Use method with DbQualifier instead.
GetRule Get Rule instance for Attribute on Element. This method throws an exception if no rule exists.
GetStringOverloaded. Deprecated- do not use. Use method with DbQualifier instead.
GetType (inherited from Object) Gets the Type of the current instance.
GetValidAsString Get Attribute value on Element as text. This method works for all attributes that are valid ion this element The string returned will be correctly formated for output taking into account the current units. e.g. if in imperial units a position might be output as 'W 39'4.7/16 N 59'0.85/128 U 4'0.31/128'.
GetValidBool Get Boolean Attribute value on Element, if available.
GetValidDouble Get floating-point Attribute value on Element, if available.
GetValidInteger Get integer Attribute value on Element, if available.
GetValidString Get text value Attribute on Element, if available.
InsertAfter Insert Element after the given reference Element. This method throws an exception if insertion fails.
InsertAfterLast Insert Element after the last child of the given parent Element. This method throws an exception if insertion fails.
InsertBefore Insert Element before the given reference Element. This method throws an exception if insertion fails.
InsertBeforeFirst Insert Element before the first child of the given parent Element. This method throws an exception if insertion fails.
InsertIntoSecondaryListAfter Insert Element into secondary list, after the given reference Element. This method throws an exception if insertion fails.
InsertIntoSecondaryListAfterLast Insert Element into secondary list, after the last child of the given parent Element. This method throws an exception if insertion fails.
InsertIntoSecondaryListBefore Insert Element into secondary list, before the given reference Element. This method throws an exception if insertion fails.
InsertIntoSecondaryListBeforeFirst Insert Element into secondary list, before the first child of the given parent Element. This method throws an exception if insertion fails.
IsAttributeSetable Queries whether the named Attribute on this Element can be set.
IsAttributeValid Queries whether the named Attribute value on this Element is valid.
IsCopyable Queries whether the Attributes of another Element can be copied into this Element.
IsCreatable Queries whether a child Element of a given type can be created
IsDescendant Queries whether this Element is a descendant of the given Element.
IsInsertable Queries whether this Element can be inserted as child to the given Element.
LastMember Returns the last child Element of this Element. If none, returns a null DbElement.
Member Returns the numbered child Element of this Element. If none, returns a null DbElement.
MembersOverloaded. Returns all child Elements of this Element that have Element Type.
NextOverloaded. Returns the next Element in order that has the given Element Type, from this Element. If none, returns a null DbElement.
PassObjectToCPP Pass object through to unmanaged C++.
PropagateRules Re-evaluate all rule-dependent attributes, following change to Attribute on this Element
RefNo Reference number pair for this Element
Release Release claim on this Element. Method throws an exception if not allowed.
ReleaseHierarchy Release claim on this Element and all its descendants. Method throws an exception if not allowed. The method will always release what it can.
RemoveFromSecondaryList Remove this Element from the secondary list of another Element Method throws an exception if not allowed.
SetAttributeOverloaded. Set Attribute on Element as a ParameterList. Method throws an exception if not allowed.
SetAttributeDefault Reset Attribute on Element to its default value. Method throws an exception if not allowed.
SetRule Attach the Rule to the given Attribute of this Element. Method throws an exception if not allowed.
ToString Get textual representation of this Element.
VerifyRule Verify that the value and the Rule attached to an Attribute of this Element, are consistent.

See Also

DbElement Class | Aveva.Pdms.Database Namespace