DataObject Methods |
The DataObject type exposes the following members.
Methods| Name | Description | |
|---|---|---|
 | AddVersion(Boolean, DataObjectType) |
Adds a new DataObjevtVersion object the Versions collection.
If copyValues is true, all property values on the current version are copied to the new version.
|
| AddVersion(Boolean, Boolean, DataObjectType) |
If a data object must be modified then a new version must be added first.
This method adds a new version to the data object.
|
| AssignPropertyValue |
Tip: use the indexer property to access property values instead of using this method.
Assigns a property value to the LastVersion of the object.
The value can be of type:
string, int, datetime, double, bool, timespan, AppStringContainer, SetPropertyValue, ReferencePropertyValue or null.
The value type is dependant on the DataType of the property
|
| AssignReferencePropertyValue |
Assigns a reference property on LastVersion.
|
| AssignReferencePropertyValues |
Assigns a reference property on LastVersion.
Tip: use the indexer property to access property values instead of using this method.
|
| BreakSecurityInheritance |
Breaks the enheritance of security.
If InheritsSecurity=true no adjustments must be made to the security.
This method is used to set InheritsSecurity=false.
|
| CheckAndAddVersion(Boolean) |
Adds a version only of the LastVersion object is already stored in the database.
|
| CheckAndAddVersion(Boolean, DataObjectType) |
Adds a version only if the LastVersion object is already stored in the database.
|
| Clone | |
 | DataObjectHasExtendedProtection |
Builtin data objects of certain types has "extended protection" meaning that they can neither be updated nor deleted
(for all other builtin data objects we only prevent deletion)
|
| FormatTemplateText |
Formats the object to a string using a template string where attributes a replaced.
|
| GetDefaultParentId |
Returns the default parentid for a new dataobject of the provided type.
|
| GetMultiLanguagePropertyValue |
Returns multi language property value in provided language.
|
| GetObjectKey |
Returns the key value of the data object.
the key property comes from the typen, but it must be provided for performance reasons.
If key property is 0 the display name is returned.
Returns null if the object does not have a value for the provided key (value) property.
|
| GetPropertyValue(Int32) |
Returns the value of a particular property on the newest data object version.
The value can be of the following type::
string, int, datetime, double, bool, SetPropertyValue object or ReferencePropertyValue object.
It can also be null, if:
* The object does not have a current versionhar ingen current version
* The property was not found (its not on the type)'en blev ikke fundet (den er ikke på typen)
* The value has not been loaded (ValueAvailable=false)
* There are no value for theproperty
(can be caused by yhe property being added to the type after the object was created.)
* The identity user does not have access to the property
|
| GetPropertyValue(Int32, IEnumerableInt32) | Obsolete.
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.
|
| GetPropertyValue(Int32, Int32) | Obsolete.
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.
|
| GetPropertyValue(String, Boolean) | Obsolete.
Returns the value of a Value property with data type 'Boolean'.
|
| GetPropertyValue(String, IEnumerableInt32) | Obsolete.
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.
|
| GetPropertyValue(String, DateTime) | Obsolete.
Returns the value of a Value property with data type 'DateTime'.
|
| GetPropertyValue(String, Double) | Obsolete.
Returns the value of a Value property with data type 'Decimal'.
|
| GetPropertyValue(String, Guid) | Obsolete.
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 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, 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) | Obsolete.
Returns the value of a Value property with data type 'TimeSpan'.
|
| GetPropertyValueByOdwMapping(String, DateTime) |
Returns the datetime value of a property by odw mapping.
If the property is a Value property it must be of data type DateTime.
|
| GetPropertyValueByOdwMapping(String, String) |
Returns the string value of a property by odw mapping.
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
|
| GetPropertyValuesT(Int32) |
Returns the value(s) for a property.
|
| GetPropertyValuesT(String) |
Returns the value(s) for a property or a fixed field.
Not all fixed fields are supported - please refer to the PropertyValuesContainer class for details.
|
| GetReferencePropertyValues(Int32) |
Returns a collection of ReferencePropertyValue objects from the current DataObjectVersion.
|
| GetReferencePropertyValues(String) |
Returns a collection of ReferencePropertyValue objects from the current DataObjectVersion.
|
| GetSinglePropertyValueT(Int32, T) |
Returns a single value for a property (fixed fields are not supported by this method).
|
| GetSinglePropertyValueT(String, T) |
Returns a single value for a property or a fixed field.
Not all fixed fields are supported - please refer to the PropertyValuesContainer class for details.
|
| GetSinglePropertyValueByOdwMappingT |
Returns a single value for a property or a fixed field based on ODW mapping.
Not all fixed fields are supported - please refer to the PropertyValuesContainer class for details.
|
| HasProperty |
Returns true if the data object has the specified property.
|
| IsInfoAvailable |
Returns true if the fields provided in infoFlags is available on the DataObject.
|
| PropertyChanged |
Returns true if the provided property has changed between
CurrentVersion and LastVersion.
If no currentversion is available, true is returned.
|
| SetId |
Sets the internal ID of the object
|
| SetPropertyValue |
Tip: use the indexer property to access property values instead of using this method.
Assigns a property value to the LastVersion of the object.
The value can be of type:
string, int, datetime, double, bool, timespan, AppStringContainer, SetPropertyValue, ReferencePropertyValue or null.
The value type is dependant on the DataType of the property
|
| ToObjectArray |
Utility for helping assigning values to the property value dictionary.
|
| ToString |
Formats the object to a displayable string.
(Overrides ObjectToString.) |
| ToString(AppFormatInfo) |
Returns the string representation of the object.
|
| UpdateDisplayName |
Updates data object display name.
|
Extension Methods| Name | Description | |
|---|---|---|
 | ToBool |
Converts object to boolean.
(Defined by ObjectExtensions.) |
| ToDateTime |
Converts object to DateTime.
(Defined by ObjectExtensions.) |
| ToInt |
Converts object to integer.
(Defined by ObjectExtensions.) |
Explicit Interface Implementations| Name | Description | |
|---|---|---|
  | IObjectWithDataVersion.GetDataVersion | |
| IObjectWithGuid.GetGuid | |
| IObjectWithId.GetId | |
| IDataObjectGetPropertyValue |
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
|
| IDataObjectGetPropertyValues |
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
|
| IObjectContainingDataObjectGetDataObject |
Returns the DataObject
|
| IObjectWithAttributesAddAttribute |
Adds an attribute - if it exists already the value is overwritten.
|
| IObjectWithAttributesGetKeys |
Returns all the keys in the collection
|
| IObjectWithAttributesGetValue |
Returns the value of an attribute.
If the attribute doesn't exist null is returned.
|
| IObjectWithAttributesHasAttribute |
Returns whether an attribute exists.
|
See Also