IDataObject Methods |
The IDataObject type exposes the following members.
Methods| Name | Description | |
|---|---|---|
 | GetPropertyValue(Int32, IEnumerableInt32) |
Returns the value(s) of a Set property or a Reference property.
If the property is a Set property the Ids of the selected Set Property Values are returned.
If the property is a Reference property the Ids of the selected Data Objects are returned.
Throws an exception if:
- The property doesn't exist
- The property is not present in the data object type
- The property is not of the right type and data type
- The value of the property is not available (because it has not been loaded)
- The value of the property is not accessible due to security
|
| GetPropertyValue(Int32, Int32) |
Returns the value of a Value property with data type 'Integer' or a Set property or a Reference property.
If the property is a Set property the Id of the selected Set Property Value is returned.
If the Set property has more than one selected values then a random one of those is returned.
If the property is a Reference property the Id of the selected Data Object is returned.
If the Reference property has more than one selected values then a random one of those is returned.
Throws an exception if:
- The property is not found
- The property is not of the right type and data type
- The value of the property is not available (because it has not been loaded)
- The value of the property is not accessible due to security
|
| GetPropertyValue(Int32, String) |
Returns the string value of a property.
If the property is a Value property it must be of data type 'Text' or 'MultiLangText'.
If the property is a Set property the Name of the (first) selected value is returned.
If the property is a Reference property the DisplayName of the (first) selected value is returned.
Throws an exception if:
- The property doesn't exist
- The property is not present in the data object type
- The property is not of the right type and data type
- The value of the property is not available (because it has not been loaded)
- The value of the property is not accessible due to security
|
| GetPropertyValue(String, Boolean) |
Returns the value of a Value property with data type 'Boolean'.
Throws an exception if:
- The property is not found
- The property is not of the right type and data type
- The value of the property is not available (because it has not been loaded)
- The value of the property is not accessible due to security
|
| GetPropertyValue(String, IEnumerableInt32) |
Returns the value(s) of a Set property or a Reference property.
If the property is a Set property the Ids of the selected Set Property Values are returned.
If the property is a Reference property the Ids of the selected Data Objects are returned.
Throws an exception if:
- The property doesn't exist
- The property is not present in the data object type
- The property is not of the right type and data type
- The value of the property is not available (because it has not been loaded)
- The value of the property is not accessible due to security
|
| GetPropertyValue(String, DateTime) |
Returns the value of a Value property with data type 'DateTime'.
Throws an exception if:
- The property is not found
- The property is not of the right type and data type
- The value of the property is not available (because it has not been loaded)
- The value of the property is not accessible due to security
|
| GetPropertyValue(String, Double) |
Returns the value of a Value property with data type 'Decimal'.
Throws an exception if:
- The property is not found
- The property is not of the right type and data type
- The value of the property is not available (because it has not been loaded)
- The value of the property is not accessible due to security
|
| GetPropertyValue(String, Guid) |
Returns the value of Set property.
The UId of the selected Set Property Value is returned.
If the Set property has more than one selected values then a random one of those is returned.
Throws an exception if:
- The property doesn't exist
- The property is not present in the data object type
- The property is not of the right type and data type
- The value of the property is not available (because it has not been loaded)
- The value of the property is not accessible due to security
|
| GetPropertyValue(String, Int32) |
Returns the value of a Value property with data type 'Integer' or a Set property or a Reference property.
If the property is a Set property the Id of the selected Set Property Value is returned.
If the Set property has more than one selected values then a random one of those is returned.
If the property is a Reference property the Id of the selected Data Object is returned.
If the Reference property has more than one selected values then a random one of those is returned.
Throws an exception if:
- The property is not found
- The property is not of the right type and data type
- The value of the property is not available (because it has not been loaded)
- The value of the property is not accessible due to security
|
| GetPropertyValue(String, String) |
Returns the string value of a property.
If the property is a Value property it must be of data type 'Text' or 'MultiLangText'.
If the property is a Set property the Name of the (first) selected value is returned.
If the property is a Reference property the DisplayName of the (first) selected value is returned.
Throws an exception if:
- The property doesn't exist
- The property is not present in the data object type
- The property is not of the right type and data type
- The value of the property is not available (because it has not been loaded)
- The value of the property is not accessible due to security
|
| GetPropertyValue(String, TimeSpan) |
Returns the value of a Value property with data type 'TimeSpan'.
Throws an exception if:
- The property is not found
- The property is not of the right type and data type
- The value of the property is not available (because it has not been loaded)
- The value of the property is not accessible due to security
|
| GetPropertyValues |
Returns a dictionary with the property values of the data object.
The keys in the dictionary are the system names of the properties.
Not all properties are present in the dictionary. The following are excluded:
- Text properties with log
- Hyperlink properties
- Properties w. denied access
- Properties w. an inavailable value
The data type of the property value depends on the type and data type of the property:
- Set property: IEnumerable int of SetPropertyValue ids
- Reference property: IEnumerable<IReferencePropertyValue>
- Value property - Text: string - can be null
- Value property - Integer: int - can be null
- Value property - DateTime: DateTime - can be null
- Value property - Decimal : double - can be null
- Value property - Boolean : bool - can be null
- Value property - TimeSpan : TimeSpan - can be null
- Value property - Multilang. text : string with value in active user's language - can be null
|
See Also