|
static PropertyValueList | GetPropertyValues (TrimObject forTrimObject, PropertyDefList propertySet) |
| Constructs an array of the values of a specified set of properties of a particular object. The string display type parameter is used to indicate what type of string value to retrieve. More...
|
|
static PropertyValueList | GetPropertyValues (TrimObject forTrimObject, PropertyDefList propertySet, StringDisplayType propertyValueStringType) |
| Constructs an array of the values of a specified set of properties of a particular object. The string display type parameter is used to indicate what type of string value to retrieve. More...
|
|
static int | Compare (PropertyValue propertyValue1, PropertyValue propertyValue2) |
| Compares two property values to see which should appear first in a sort sequence. Generally assumed that both property values would be based on the same propertyDef. Returns -1 to indicate that propertyValue1 is less than propertyValue2, 0 to indicate that the property values are equal +1 to indicate that propertyValue1 is greater than propertyValue2, More...
|
|
static PropertyDef | FindUsingInternalName (string internalPropertyName) |
| Find a property definition based on the supplied internal name. More...
|
|
static PropertyDef | FindUsingInternalName (string internalPropertyName, Database forDatabase) |
| Find a property definition based on the supplied internal name. Providing the database object ensures that the returned property definition has access to any customized captions within that database. More...
|
|
static PropertyDefList | GetAllProperties (BaseObjectTypes forObjectType) |
| Constructs an array of all property definitions for the nominated object type. More...
|
|
static PropertyDefList | GetAllProperties (BaseObjectTypes forObjectType, Database forDatabase) |
| Constructs an array of all property definitions for the nominated object type. Providing the database object ensures that the returned property definition has access to any customized captions within that database. More...
|
|
static PropertyDefList | GetAllProperties (UserOptionSetIds forOptionSet) |
| Constructs an array of all property definitions for the nominated user option set. More...
|
|
static PropertyDefList | GetAllProperties (UserOptionSetIds forOptionSet, Database forDatabase) |
| Constructs an array of all property definitions for the nominated nominated user option set. Providing the database object ensures that the returned property definition has access to any customized captions within that database. More...
|
|
static PropertyDefList | GetViewPaneProperties (BaseObjectTypes forObjectType) |
| Constructs an array of all view pane property definitions of the nominated object type. More...
|
|
static PropertyDefList | GetViewPaneProperties (BaseObjectTypes forObjectType, Database forDatabase) |
| Constructs an array of all view pane property definitions of the nominated object type. Providing the database object ensures that the returned property definitions have access to any customized captions within that database. More...
|
|
static PropertyDefList | GetDataGridProperties (BaseObjectTypes forObjectType) |
| Constructs an array of all property definitions that are suitable data grid columns of the nominated object type. More...
|
|
static PropertyDefList | GetDataGridProperties (BaseObjectTypes forObjectType, Database forDatabase) |
| Constructs an array of all property definitions that are suitable data grid columns of the nominated object type. Providing the database object ensures that the returned property definitions have access to any customized captions within that database. More...
|
|
static PropertyDefList | GetWriteableProperties (BaseObjectTypes forObjectType) |
| Constructs an array of all writable property definitions of the nominated object type. More...
|
|
static PropertyDefList | GetWriteableProperties (BaseObjectTypes forObjectType, Database forDatabase) |
| Constructs an array of all writable property definitions of the nominated object type. Providing the database object ensures that the returned property definitions have access to any customized captions within that database. More...
|
|
static PropertyDefList | GetSearchOptionProperties (BaseObjectTypes whenSearchingForObject, Database forDatabase) |
| Constructs an array of all property definitions that belong to the UserSearchOptions option set and that are also relevant for use when searching for the specified type of object More...
|
|
|
bool | IsModified [get] |
| The modified state tracks any changes made to this property value by the various set functions. More...
|
|
PropertyIds | Id [get] |
| Gets an integer containing the unique property identifier for this property definition. More...
|
|
string | Caption [get, set] |
| Gets or sets a string containing the descriptive caption for this property. Note that to set a caption, this property must have been constructed with a valid Database parameter. To make caption changes permanent, call the SaveCaptionChanges method of the database More...
|
|
string | CaptionShort [get, set] |
| Gets or sets a string containing the abbreviated caption for this property Note that to set a caption, this property must have been constructed with a valid Database parameter. To make caption changes permanent, call the SaveCaptionChanges method of the database More...
|
|
PropertySortMode | SortMode [get] |
| Gets the sorting mode most suited to the values of this property. More...
|
|
StringDisplayAlignment | StringAlignment [get] |
| Gets the preferred method for aligning a string when displaying values of this property. More...
|
|
IconDisplayMode | IconDefaultMode [get] |
| Gets the preferred style for displaying an icon when displaying a value for this property More...
|
|
bool | IsReadOnly [get] |
| Gets a Boolean value indicating whether this Property Definition is read only or not. More...
|
|
bool | IsOkForViewPane [get] |
| Gets a Boolean value indicating whether this Property can be displayed in the ViewPane More...
|
|
bool | IsDefaultForViewPane [get] |
| Gets a Boolean value indicating whether this Property is displayed in the ViewPane by default. More...
|
|
bool | IsOkForDataEntry [get] |
| Gets a Boolean value indicating whether this Property can be displayed on the Data Entry Form for this object. More...
|
|
PropertyFormats | Format [get] |
| Gets a pfPropertyFormats enum value indicating the data type (format) of this Property. If the property is an object data type ('pfObject'), the TRIM Object type is held in the 'ObjectType' property. If it is an enumerated type ('pfEnum'), the TRIM Enumeration type is held in the 'EnumType' property. More...
|
|
BaseObjectTypes | ObjectType [get] |
| Gets a BaseObjectTypes enum value indicating the object type of this property, if it is of PropertyDef.Format 'pfObject'. More...
|
|
AllEnumerations | EnumType [get] |
| Gets an enmAllEnumerations enum value indicating the enumerator type of this property, if it is of PropertyDef.Format 'pfEnum'. More...
|
|
bool | IsNameProperty [get] |
| Gets a Boolean value indicating whether this property is the default 'unique naming' property for the object, by which it may be instantiated instead of by uri. More...
|
|
string | InternalName [get] |
| Gets a string containing the internal name for this property. More...
|
|
bool | IsExposedInSDK [get] |
| Gets a Boolean value indicating whether this property is directly exposed for use in the SDK. More...
|
|
PropertyOrFieldFormat | PFFormat [get] |
| Gets a poPropertyOrFieldFormat enum value indicating the generic format of this property in the context of formats available to TRIM Properties or Fields. More...
|
|
int | Length [get] |
| Gets the length of this property if it is a string More...
|
|
string | TrueString [get] |
| Gets the string representing true for a property of type boolean. Most likely this will be 'True', but for some boolean properties, it may contain something more descriptive. For example, the property 'IsActive' may have a true string of 'Active' and a false string of 'InActive' More...
|
|
string | FalseString [get] |
| Gets the string representing false for a property of type boolean. Most likely this will be 'False', but for some boolean properties, it may contain something more descriptive. For example, the property 'IsActive' may have a true string of 'Active' and a false string of 'Inactive'. More...
|
|
bool | IsDataGridColumn [get] |
| Gets a Boolean value indicating whether this Property would be useful displayed in a data grid. More...
|
|
bool | IsDefaultDataGridColumn [get] |
| Gets a Boolean value indicating whether this Property should be displayed as a default column in a data grid. More...
|
|
SearchClauseIds | SearchClauseId [get] |
| Gets a SearchClauseIds value indicating whether this property can be used for searches. Returns Unknown if it is not suitable. More...
|
|
bool | CanView [get] |
| Gets a Boolean value indicating whether the current user has the permission to view this property. Some system settings such as classified security, DoD 5015.3 compliance, require properties to be hidden. More...
|
|
string | ErrorMessage [get] |
| All TRIM SDK objects have an ErrorMessage property which can be used to examine any error that may have occurred in the most recent method call. More...
|
|
TrimException | Error [get] |
| All TRIM SDK objects have an Error property which can be used to examine any error that may have occurred in the most recent method call. More...
|
|