HPE Content Manager SDK 9.0
|
Public Member Functions | |
PropertyDef () | |
PropertyDef (PropertyIds pid) | |
PropertyDef (PropertyIds pid, Database withinDB) | |
Icons | GetIcon (IconUsage forUseAs) |
Gets the identifier of the TRIM icon associated with this property. More... | |
bool | BelongsTo (BaseObjectTypes type) |
Gets a BaseObjectTypes enum value indicating what type of TRIM object this property belongs to. More... | |
SearchClauseIds | GetSortClauseId (BaseObjectTypes forListsOfObjectType, bool strict) |
This returns the same as the SearchClauseId property, provided the search clause is sortable. The strict parameter will also exclude and search clause that does not perform a strictly alphabetic sort, such as properties that are enums or objects) More... | |
bool | IsMandatory (TrimObject forObject) |
Gets a boolean value indicating if the property is mandatory (cannot have an empty/null value) for the supplied TRIM object. More... | |
Public Member Functions inherited from HP.HPTRIM.SDK.TrimSDKObject | |
TrimSDKObject () | |
Static Public Member Functions | |
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... | |
Properties | |
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... | |
Properties inherited from HP.HPTRIM.SDK.TrimSDKObject | |
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... | |
HP.HPTRIM.SDK.PropertyDef.PropertyDef | ( | ) |
HP.HPTRIM.SDK.PropertyDef.PropertyDef | ( | PropertyIds | pid | ) |
HP.HPTRIM.SDK.PropertyDef.PropertyDef | ( | PropertyIds | pid, |
Database | withinDB | ||
) |
bool HP.HPTRIM.SDK.PropertyDef.BelongsTo | ( | BaseObjectTypes | type | ) |
Gets a BaseObjectTypes enum value indicating what type of TRIM object this property belongs to.
|
static |
Find a property definition based on the supplied internal name.
|
static |
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.
|
static |
Constructs an array of all property definitions for the nominated object type.
|
static |
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.
|
static |
Constructs an array of all property definitions for the nominated user option set.
|
static |
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.
|
static |
Constructs an array of all property definitions that are suitable data grid columns of the nominated object type.
|
static |
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.
Gets the identifier of the TRIM icon associated with this property.
SearchClauseIds HP.HPTRIM.SDK.PropertyDef.GetSortClauseId | ( | BaseObjectTypes | forListsOfObjectType, |
bool | strict | ||
) |
This returns the same as the SearchClauseId property, provided the search clause is sortable. The strict parameter will also exclude and search clause that does not perform a strictly alphabetic sort, such as properties that are enums or objects)
|
static |
Constructs an array of all view pane property definitions of the nominated object type.
|
static |
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.
|
static |
Constructs an array of all writable property definitions of the nominated object type.
|
static |
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.
bool HP.HPTRIM.SDK.PropertyDef.IsMandatory | ( | TrimObject | forObject | ) |
Gets a boolean value indicating if the property is mandatory (cannot have an empty/null value) for the supplied TRIM object.
|
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.
|
getset |
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
|
getset |
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
|
get |
Gets an enmAllEnumerations enum value indicating the enumerator type of this property, if it is of PropertyDef.Format 'pfEnum'.
|
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'.
|
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.
|
get |
Gets the preferred style for displaying an icon when displaying a value for this property
|
get |
Gets an integer containing the unique property identifier for this property definition.
|
get |
Gets a string containing the internal name for this property.
|
get |
Gets a Boolean value indicating whether this Property would be useful displayed in a data grid.
|
get |
Gets a Boolean value indicating whether this Property should be displayed as a default column in a data grid.
|
get |
Gets a Boolean value indicating whether this Property is displayed in the ViewPane by default.
|
get |
Gets a Boolean value indicating whether this property is directly exposed for use in the SDK.
|
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.
|
get |
Gets a Boolean value indicating whether this Property can be displayed on the Data Entry Form for this object.
|
get |
Gets a Boolean value indicating whether this Property can be displayed in the ViewPane
|
get |
Gets a Boolean value indicating whether this Property Definition is read only or not.
|
get |
Gets the length of this property if it is a string
|
get |
Gets a BaseObjectTypes enum value indicating the object type of this property, if it is of PropertyDef.Format 'pfObject'.
|
get |
Gets a poPropertyOrFieldFormat enum value indicating the generic format of this property in the context of formats available to TRIM Properties or Fields.
|
get |
Gets a SearchClauseIds value indicating whether this property can be used for searches. Returns Unknown if it is not suitable.
|
get |
Gets the sorting mode most suited to the values of this property.
|
get |
Gets the preferred method for aligning a string when displaying values of this property.
|
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'