Class SelectNode

Class for parsing and storing AML select attributes

Inheritance
System.Object
SelectNode
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
Namespace: Innovator.Client
Assembly: Innovator.Client.dll
Syntax
public class SelectNode : ICollection<SelectNode>, IEnumerable<SelectNode>, IEnumerable
Remarks

Use FromString(String) to parse an AML select attribute.

Constructors

| Improve this Doc View Source

SelectNode()

Initializes a new SelectNode instance for storing an AML select path

Declaration
public SelectNode()
| Improve this Doc View Source

SelectNode(String)

Initializes a new SelectNode instance with a property name.

Declaration
public SelectNode(string name)
Parameters
Type Name Description
System.String name

The name of the property to store in the node

Properties

| Improve this Doc View Source

Count

Number of child columns

Declaration
public int Count { get; }
Property Value
Type Description
System.Int32
Implements
System.Collections.Generic.ICollection<T>.Count
| Improve this Doc View Source

Item[Int32]

Access a child sub-select by index

Declaration
public SelectNode this[int index] { get; }
Parameters
Type Name Description
System.Int32 index
Property Value
Type Description
SelectNode
| Improve this Doc View Source

Name

Name of the current column

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

Methods

| Improve this Doc View Source

Add(SelectNode)

Add a child SelectNode to this instance

Declaration
public void Add(SelectNode item)
Parameters
Type Name Description
SelectNode item
Implements
System.Collections.Generic.ICollection<T>.Add(T)
| Improve this Doc View Source

Clear()

Removes all child items from the SelectNode

Declaration
public void Clear()
Implements
System.Collections.Generic.ICollection<T>.Clear()
| Improve this Doc View Source

Contains(SelectNode)

Determines whether the SelectNode contains a specific value.

Declaration
public bool Contains(SelectNode item)
Parameters
Type Name Description
SelectNode item

The child SelectNode to locate in the SelectNode.
Returns
Type Description
System.Boolean

true if item is found in the SelectNode; otherwise, false.
Implements
System.Collections.Generic.ICollection<T>.Contains(T)
| Improve this Doc View Source

CopyTo(SelectNode[], Int32)

Copies the elements of the SelectNode to an System.Array, starting at a particular System.Array index.

Declaration
public void CopyTo(SelectNode[] array, int arrayIndex)
Parameters
Type Name Description
SelectNode[] array

The one-dimensional System.Array that is the destination of the elements copied from SelectNode. The System.Array must have zero-based indexing.
System.Int32 arrayIndex

The zero-based index in array at which copying begins.
Implements
System.Collections.Generic.ICollection<T>.CopyTo(T[], System.Int32)
| Improve this Doc View Source

EnsurePath(IEnumerable<String>)

Ensure that the path of properties exists in the select statement

Declaration
public void EnsurePath(IEnumerable<string> path)
Parameters
Type Name Description
System.Collections.Generic.IEnumerable<System.String> path
Examples

Sending in new string[] {"created_by_id, first_name"} will result in the select statement created_by_id(first_name)

| Improve this Doc View Source

EnsurePath(String[])

Ensure that the path of properties exists in the select statement

Declaration
public void EnsurePath(params string[] path)
Parameters
Type Name Description
System.String[] path
Examples

Sending in "created_by_id, first_name" will result in the select statement created_by_id(first_name)

| Improve this Doc View Source

FromString(String)

Parse an AML select statement into a SelectNode structure

Declaration
public static SelectNode FromString(string select)
Parameters
Type Name Description
System.String select
Returns
Type Description
SelectNode
| Improve this Doc View Source

GetEnumerator()

Returns an enumerator that iterates through the child nodes.

Declaration
public IEnumerator<SelectNode> GetEnumerator()
Returns
Type Description
System.Collections.Generic.IEnumerator<SelectNode>

An enumerator that can be used to iterate through the child nodes.
Implements
System.Collections.Generic.IEnumerable<T>.GetEnumerator()
| Improve this Doc View Source

Remove(SelectNode)

Removes the first occurrence of the child SelectNode from the SelectNode.

Declaration
public bool Remove(SelectNode item)
Parameters
Type Name Description
SelectNode item

The object to remove from the SelectNode.
Returns
Type Description
System.Boolean

true if item was successfully removed from the SelectNode; otherwise, false. This method also returns false if item is not found in the original SelectNode.
Implements
System.Collections.Generic.ICollection<T>.Remove(T)
| Improve this Doc View Source

Sort()

Sort the properties by name

Declaration
public void Sort()
| Improve this Doc View Source

ToString()

Returns a System.String in the format of an AML select attribute

Declaration
public override string ToString()
Returns
Type Description
System.String
Overrides
System.Object.ToString()
| Improve this Doc View Source

ToString(IEnumerable<SelectNode>)

Returns a System.String in the format of an AML select attribute

Declaration
public static string ToString(IEnumerable<SelectNode> items)
Parameters
Type Name Description
System.Collections.Generic.IEnumerable<SelectNode> items
Returns
Type Description
System.String
| Improve this Doc View Source

UnionWith(SelectNode)

Union the children of two select nodes

Declaration
public void UnionWith(SelectNode item)
Parameters
Type Name Description
SelectNode item

Operators

| Improve this Doc View Source

Implicit(String to SelectNode)

Performs an implicit conversion from System.String to SelectNode.

Declaration
public static implicit operator SelectNode(string select)
Parameters
Type Name Description
System.String select
Returns
Type Description
SelectNode

Explicit Interface Implementations

| Improve this Doc View Source

ICollection<SelectNode>.IsReadOnly

Declaration
bool ICollection<SelectNode>.IsReadOnly { get; }
Returns
Type Description
System.Boolean
Implements
System.Collections.Generic.ICollection<T>.IsReadOnly
| Improve this Doc View Source

IEnumerable.GetEnumerator()

Declaration
IEnumerator IEnumerable.GetEnumerator()
Returns
Type Description
System.Collections.IEnumerator
Implements
System.Collections.IEnumerable.GetEnumerator()

Extension Methods