XJEaseArrayParameter Class
An XJEase array parameter which can be passed to XJEase functions.
Namespace: XJTAG.Integration.XJRunner
Syntax
public sealed class XJEaseArrayParameter : XJEaseParameter, IEnumerable<XJEaseParameter>
Remarks
All items in the array must have the same type. Available types are IntParameter, StringParameter and XJEaseArrayParameter. If items are of type XJEaseArrayParameter, the maximum depth is 3.
Example
This is an example of how to initialise an array of integers with a depth of 3:
var innerArray = new XJEaseArrayParameter(XJEaseParameterType.Int, 1) { new IntParameter(2) }; var middleArray = new XJEaseArrayParameter(XJEaseParameterType.Int, 2) { innerArray }; var topLevelArray = new XJEaseArrayParameter(XJEaseParameterType.Int, 3) { middleArray };
Inheritance Hierarchy
- XJEaseParameter
- object
- IEnumerable<XJEaseParameter>
- IEnumerable
Members
Constructors
| Name | Description |
|---|---|
| XJEaseArrayParameter | Creates a new instance of the XJEaseArrayParameter class. |
Indexers
| Name | Description |
|---|---|
| XJEaseParameter this[int] | Gets the item in the array located at the given index. |
Properties
| Name | Description |
|---|---|
| Depth | The depth of the array. |
| IsArray | Indicates whether this parameter represents an XJEase array (i.e. returns true when this is an XJEaseArrayParameter instance). |
| Length | The number of items currently contained in the array. |
| Type | Returns the type of this parameter as an XJEaseParameterType value. |
Methods
| Name | Description |
|---|---|
| Add | Appends an XJEaseParameter to the end of the array. |
| AddInt(int) | Appends a new IntParameter (based on an Int32) to the end of the array. |
| AddInt(uint) | Appends a new IntParameter (based on a UInt32) to the end of the array. |
| AddInt(long) | Appends a new IntParameter (based on an Int64) to the end of the array. |
| AddInt(ulong) | Appends a new IntParameter (based on a UInt64) to the end of the array. |
| AddString | Appends a new StringParameter to the end of the array. |
| AsArray (from XJEaseParameter) | Converts this XJEaseParameter to an XJEaseArrayParameter. |
| AsInt (from XJEaseParameter) | Converts this XJEaseParameter to an IntParameter. |
| AsString (from XJEaseParameter) | Converts this XJEaseParameter to an StringParameter. |
| Equals(object) (from object) | |
| Finalize (from object) | |
| GetEnumerator | Returns an enumerator that iterates through the XJEaseParameters in the collection. |
| GetHashCode (from object) | |
| GetType (from object) | |
| GetValueAt | Gets the item in the array located at the given index. |
| MemberwiseClone (from object) | |
| ToString (from object) | |
| With | Appends an XJEaseParameter to the end of the array. |
| WithInt(int) | Appends a new IntParameter (based on an Int32) to the end of the array. |
| WithInt(uint) | Appends a new IntParameter (based on a UInt32) to the end of the array. |
| WithInt(long) | Appends a new IntParameter (based on an Int64) to the end of the array. |
| WithInt(ulong) | Appends a new IntParameter (based on a UInt64) to the end of the array. |
| WithString | Appends a new StringParameter to the end of the array. |
XJTAG v4.1.100