Show / Hide Table of Contents

Interface IReadOnlyElement

A read-only AML element. This element could be an Item, property, result tag, or something else

Inherited Members
IAmlNode.ToAml(XmlWriter, AmlWriterSettings)
Namespace: Innovator.Client
Assembly: Innovator.Client.dll
Syntax
public interface IReadOnlyElement : IAmlNode

Properties

| Improve this Doc View Source

AmlContext

Retrieve the context used for rendering primitive values

Declaration
ElementFactory AmlContext { get; }
Property Value
Type Description
ElementFactory
| Improve this Doc View Source

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
| Improve this Doc View Source

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

| Improve this Doc View Source

Parent

Retrieve the parent element

Declaration
IReadOnlyElement Parent { get; }
Property Value
Type Description
IReadOnlyElement
| Improve this Doc View Source

Value

String value of the element

Declaration
string Value { get; }
Property Value
Type Description
System.String

Methods

| Improve this Doc View Source

Attribute(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
  • If the property exists, a valid IReadOnlyAttribute will be returned
  • If the property does not exists, a "null" IReadOnlyAttribute will be returned where Exists = false
| Improve this Doc View Source

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

| Improve this Doc View Source

Elements()

Retrieve all child elements

Declaration
IEnumerable<IReadOnlyElement> Elements()
Returns
Type Description
System.Collections.Generic.IEnumerable<IReadOnlyElement>

Extension Methods

ItemExtensions.ToAml(IAmlNode, AmlWriterSettings)
ItemExtensions.ToAml(IAmlNode, XmlWriter)
ItemExtensions.Element(IReadOnlyElement, String)
ItemExtensions.ToXml(IAmlNode)
ItemExtensions.CreateReader(IReadOnlyElement)
ItemExtensions.Parents(IReadOnlyElement)
ItemExtensions.ParentsAndSelf(IReadOnlyElement)
ItemExtensions.InnerText(IReadOnlyElement)
  • Improve this Doc
  • View Source
Back to top Copyright © 2015-2017 Microsoft
Generated by DocFX