| IProperty Interface |
A modifiable property of an item
Namespace: Innovator.Client
Assembly: Innovator.Client (in Innovator.Client.dll) Version: 2016.1.15.1759 (2016.01.15.1759)
SyntaxThe IProperty type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | Context | Retrieve the context used for rendering primitive values (Inherited from IReadOnlyElement.) |
| 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 (Inherited from IReadOnlyElement.) |
| Name | Local XML name of the element (Inherited from IReadOnlyElement.) |
| Parent | Retrieve the parent element (Inherited from IReadOnlyElement.) |
| Value | String value of the element (Inherited from IReadOnlyElement.) |
Methods| Name | Description | |
|---|---|---|
 | Add(Object) | Add new content to the element (Inherited from IElement.) |
| Add(Object) | Add new content to the element (Inherited from IElement.) |
| AsBoolean | Value converted to a nullable boolean.
If the value cannot be converted, an exception is thrown (Inherited from IReadOnlyProperty.) |
| AsBoolean(Boolean) | Value converted to a boolean using the default value if null.
If the value cannot be converted, an exception is thrown (Inherited from IReadOnlyProperty.) |
| AsDateTime | Value converted to a nullable DateTime in the local timezone.
If the value cannot be converted, an exception is thrown (Inherited from IReadOnlyProperty.) |
 | AsDateTime(DateTime) | Value converted to a DateTime in the local timezone using the default value if null.
If the value cannot be converted, an exception is thrown (Inherited from IReadOnlyProperty.) |
| AsDateTimeUtc | Value converted to a nullable DateTime in the UTC timezone.
If the value cannot be converted, an exception is thrown (Inherited from IReadOnlyProperty.) |
| AsDateTimeUtc(DateTime) | Value converted to a DateTime in the UTC timezone using the default value if null.
If the value cannot be converted, an exception is thrown (Inherited from IReadOnlyProperty.) |
| AsDouble | Value converted to a nullable double.
If the value cannot be converted, an exception is thrown (Inherited from IReadOnlyProperty.) |
| AsDouble(Double) | Value converted to a double using the default value if null.
If the value cannot be converted, an exception is thrown (Inherited from IReadOnlyProperty.) |
| AsGuid | Value converted to a nullable Guid.
If the value cannot be converted, an exception is thrown (Inherited from IReadOnlyProperty.) |
| AsGuid(Guid) | Value converted to a Guid using the default value if null.
If the value cannot be converted, an exception is thrown (Inherited from IReadOnlyProperty.) |
| AsInt | Value converted to a nullable int.
If the value cannot be converted, an exception is thrown (Inherited from IReadOnlyProperty.) |
| AsInt(Int32) | Value converted to a int using the default value if null.
If the value cannot be converted, an exception is thrown (Inherited from IReadOnlyProperty.) |
| AsItem | Value converted to a read-only item.
If the value cannot be converted, a 'null' item (where the
Exists property returns false) is returned |
| AsLong | Value converted to a nullable long.
If the value cannot be converted, an exception is thrown (Inherited from IReadOnlyProperty.) |
| AsLong(Int64) | Value converted to a long using the default value if null.
If the value cannot be converted, an exception is thrown (Inherited from IReadOnlyProperty.) |
| AsString | Value converted to a string using the default value if null. (Inherited from IReadOnlyProperty.) |
| Attribute | Retrieve the attribute with the specified name (Inherited from IReadOnlyElement.) |
| Attributes | Retrieve all attributes specified for the element (Inherited from IReadOnlyElement.) |
| Clone | Creates a new object that is a copy of the current instance. (Inherited from ICloneable.) |
| Elements | Retrieve all child elements (Inherited from IReadOnlyElement.) |
| Remove | Remove the element from its parent (Inherited from IElement.) |
| RemoveAttributes | Remove attributes from the element (Inherited from IElement.) |
| RemoveNodes | Remove child nodes from the element (Inherited from IElement.) |
| Set |
Set the value of the property
|
| ToAml |
Render the node to a string
(Inherited from IAmlNode.) |
| ToAml(XmlWriter) |
Write the node to the specified XmlWriter (Inherited from IAmlNode.) |
Extension Methods| Name | Description | |
|---|---|---|
 | AsFile(IConnection) | Overloaded. Download the file represented by the property (Defined by ItemExtensions.) |
| AsFile(IConnection, Boolean) | Overloaded. Asynchronously download the file represented by the property (Defined by ItemExtensions.) |
| Condition | Overloaded. Retrieve the condition attribute of the property (Defined by Core.) |
| Condition | Overloaded. Retrieve the condition attribute of the property (Defined by Core.) |
| HasValue |
Indicates that the property is neither null nor empty
(Defined by ItemExtensions.) |
| IsNull | Overloaded. Retrieve the is_null attribute of the property (Defined by Core.) |
| IsNull | Overloaded. Retrieve the is_null attribute of the property (Defined by Core.) |
| KeyedName | Overloaded. Retrieve the keyed_name attribute of the property (Defined by Core.) |
| KeyedName | Overloaded. Retrieve the keyed_name attribute of the property (Defined by Core.) |
| ToXml |
Renders an AML node to XML
(Defined by ItemExtensions.) |
| Type | Overloaded. Retrieve the type attribute of the property (Defined by Core.) |
| Type | Overloaded. Retrieve the type attribute of the property (Defined by Core.) |
See Also