HP.HPTRIM.SDK.Enum Class Reference

A helper class that allows you to iterate through enum item values and access captions for them. More...

Inheritance diagram for HP.HPTRIM.SDK.Enum:

Public Member Functions
	Enum (AllEnumerations enumType)
	Constructs an Enum base on the specified enum type. More...
	Enum (AllEnumerations enumType, Database forDatabase)
EnumItemList	GetItemArray ()
	Returns an array of EnumItem objects that belong to this enum. More...
EnumItemList	GetItemArray (IntList excludingTheseValues, bool excludeUneditedCustomValues)
	Returns an array of EnumItem objects that is a subset of those that belong to this enum. More...
EnumItem	FindItemByCaption (string itemCaption)
	Constructs an EnumItem by searching for an item within this enumeration that has the caption supplied. More...
EnumItem	FindItemByName (string itemName)
	Constructs an EnumItem by searching for an item within this enumeration that has item name supplied. More...
Public Member Functions inherited from HP.HPTRIM.SDK.TrimSDKObject
	TrimSDKObject ()

Properties
AllEnumerations	EnumType [get]
	Gets an AllEnumerations enum value indicating which TRIM Enumeration this EnumItemHelper applies to. 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 the descriptive caption for this enumeration. 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...
string	CaptionPlural [get, set]
	Gets or sets the plural version of caption for this enumeration. 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 enumeration. 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...

Detailed Description

A helper class that allows you to iterate through enum item values and access captions for them.

Constructor & Destructor Documentation

HP.HPTRIM.SDK.Enum.Enum

(

AllEnumerations

enumType

)

Constructs an Enum base on the specified enum type.

HP.HPTRIM.SDK.Enum.Enum	(	AllEnumerations	enumType,
		Database	forDatabase
	)

Member Function Documentation

EnumItem HP.HPTRIM.SDK.Enum.FindItemByCaption

(

string

itemCaption

)

Constructs an EnumItem by searching for an item within this enumeration that has the caption supplied.

EnumItem HP.HPTRIM.SDK.Enum.FindItemByName

(

string

itemName

)

Constructs an EnumItem by searching for an item within this enumeration that has item name supplied.

EnumItemList HP.HPTRIM.SDK.Enum.GetItemArray

(

)

Returns an array of EnumItem objects that belong to this enum.

EnumItemList HP.HPTRIM.SDK.Enum.GetItemArray	(	IntList	excludingTheseValues,
		bool	excludeUneditedCustomValues
	)

Returns an array of EnumItem objects that is a subset of those that belong to this enum.

Property Documentation

string HP.HPTRIM.SDK.Enum.Caption

getset

Gets or sets the descriptive caption for this enumeration. 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

string HP.HPTRIM.SDK.Enum.CaptionPlural

getset

Gets or sets the plural version of caption for this enumeration. 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

AllEnumerations HP.HPTRIM.SDK.Enum.EnumType

get

Gets an AllEnumerations enum value indicating which TRIM Enumeration this EnumItemHelper applies to.

Icons HP.HPTRIM.SDK.Enum.Icon

get

Gets the identifier of the TRIM icon associated with this enumeration.

bool HP.HPTRIM.SDK.Enum.IsValid

get

Gets an boolean value indicating whether this EnumItem is actually valid.

string HP.HPTRIM.SDK.Enum.Name

get

Returns a string containing the internal (uncaptioned) name for this e enumeration at the specified index of the collection.