Micro Focus Content Manager SDK 9.3
|
A helper class that allows you to iterate through enum item values and access captions for them. More...
Public Member Functions | |
EnumItem (Enum within, int enumValue) | |
Constructs an EnumItem corresponding to the specified enumValue within the specified enumeration. More... | |
EnumItem (AllEnumerations within, int enumValue) | |
Constructs an EnumItem corresponding to the specified enumValue within the specified enumeration. More... | |
EnumItem (AllEnumerations within, int enumValue, Database forDatabase) | |
Constructs an EnumItem corresponding to the specified enumValue within the specified enumeration. This form of constructor allows you to specify a database which is used to retrieve customised captions. More... | |
Public Member Functions inherited from HP.HPTRIM.SDK.TrimSDKObject | |
TrimSDKObject () | |
Properties | |
Enum | Within [get] |
Gets an AllEnumerations enum value indicating which TRIM Enumeration this EnumItem applies to. More... | |
int | Value [get] |
Gets an integer value indicating the value of this particular enumeration item. More... | |
string | Name [get] |
Returns a string containing the internal (uncaptioned) name for this e enumeration at the specified index of the collection. More... | |
bool | IsValid [get] |
Gets an boolean value indicating whether this EnumItem is actually valid. More... | |
string | Caption [get, set] |
Gets or sets a string containing the caption for this item. Note that to set a caption, this object must have been constructed with a valid Database parameter. To make caption changes permanent, call the SaveCaptionChanges method of the database More... | |
Icons | Icon [get] |
Gets the identifier of the TRIM icon associated with this enumerated item value. More... | |
bool | HasBeenCustomised [get] |
Gets a boolean value indicating whether the caption of this EnumItem has been customized by the user. More... | |
bool | IsACustomValue [get] |
Gets a boolean value indicating whether this item is a value that requires customisation. 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... | |
A helper class that allows you to iterate through enum item values and access captions for them.
HP.HPTRIM.SDK.EnumItem.EnumItem | ( | Enum | within, |
int | enumValue | ||
) |
Constructs an EnumItem corresponding to the specified enumValue within the specified enumeration.
HP.HPTRIM.SDK.EnumItem.EnumItem | ( | AllEnumerations | within, |
int | enumValue | ||
) |
Constructs an EnumItem corresponding to the specified enumValue within the specified enumeration.
HP.HPTRIM.SDK.EnumItem.EnumItem | ( | AllEnumerations | within, |
int | enumValue, | ||
Database | forDatabase | ||
) |
Constructs an EnumItem corresponding to the specified enumValue within the specified enumeration. This form of constructor allows you to specify a database which is used to retrieve customised captions.
|
getset |
Gets or sets a string containing the caption for this item. Note that to set a caption, this object must have been constructed with a valid Database parameter. To make caption changes permanent, call the SaveCaptionChanges method of the database
|
get |
Gets a boolean value indicating whether the caption of this EnumItem has been customized by the user.
|
get |
Gets the identifier of the TRIM icon associated with this enumerated item value.
|
get |
Gets a boolean value indicating whether this item is a value that requires customisation.
|
get |
Gets an boolean value indicating whether this EnumItem is actually valid.
|
get |
Returns a string containing the internal (uncaptioned) name for this e enumeration at the specified index of the collection.
|
get |
Gets an integer value indicating the value of this particular enumeration item.