Interface IReadOnlyElement
A read-only AML element. This element could be an Item, property, result tag, or something else
Inherited Members
Namespace: Innovator.Client
Assembly: Innovator.Client.dll
Syntax
public interface IReadOnlyElement : IAmlNode
Properties
| Improve this Doc View SourceAmlContext
Retrieve the context used for rendering primitive values
Declaration
ElementFactory AmlContext { get; }
Property Value
Type | Description |
---|---|
ElementFactory |
Exists
Returns true
if this element actually exists in the underlying AML,
otherwise, returns false
to indicate that the element is just a null placeholder
put in place to reduce unnecessary null reference checks
Declaration
bool Exists { get; }
Property Value
Type | Description |
---|---|
System.Boolean |
Name
Local XML name of the element (e.g. Item
, Relationships
,
config_id
, etc.). To access the property <name>
, there will be a
method such as NameProp()
Declaration
string Name { get; }
Property Value
Type | Description |
---|---|
System.String | The XML name of the element |
Parent
Retrieve the parent element
Declaration
IReadOnlyElement Parent { get; }
Property Value
Type | Description |
---|---|
IReadOnlyElement |
Value
String value of the element
Declaration
string Value { get; }
Property Value
Type | Description |
---|---|
System.String |
Methods
| Improve this Doc View SourceAttribute(String)
Retrieve the attribute with the specified name
Declaration
IReadOnlyAttribute Attribute(string name)
Parameters
Type | Name | Description |
---|---|---|
System.String | name | Name of the XML attribute |
Returns
Type | Description |
---|---|
IReadOnlyAttribute |
|
Attributes()
Retrieve all attributes specified for the element
Declaration
IEnumerable<IReadOnlyAttribute> Attributes()
Returns
Type | Description |
---|---|
System.Collections.Generic.IEnumerable<IReadOnlyAttribute> | An System.Collections.Generic.IEnumerable<T> containing all of the defined attributes |
Elements()
Retrieve all child elements
Declaration
IEnumerable<IReadOnlyElement> Elements()
Returns
Type | Description |
---|---|
System.Collections.Generic.IEnumerable<IReadOnlyElement> |