This class defines an item contained within an ApiPageDefinition More...

Inheritance diagram for HP.HPTRIM.SDK.PageItemDefinition:

Public Member Functions
void	MoveUp ()
	Move this item up one position in its page More...

void	MoveDown ()
	Move this item down one position in its page More...

Public Member Functions inherited from HP.HPTRIM.SDK.TrimSDKObject
	TrimSDKObject ()

Properties
bool	IsItemAProperty `[get]`
	Gets a boolean property indicating if this page item is a standard property More...

PropertyIds	PropertyId `[get]`
	Gets the property identifier for this item - only available for items that are a property More...

bool	IsItemAFieldDefinition `[get]`
	Gets a boolean property indicating if this page item is a user-defined Field Definition More...

FieldDefinition	Field `[get]`
	Gets the field definition object for this item - only available for items that are a field definition More...

bool	IsItemATab `[get]`
	Gets a boolean property indicating if this page item is a special "tab" item More...

bool	IsItemALine `[get]`
	Gets a boolean property indicating if this page item is a horizontal line More...

uint	CharacterLimit `[get, set]`
	Gets or sets a user-defined character limit on this data entry item (must be smaller than the default limit). Basically limits how many characters the user can type into this field. Set it to 0 to revert the limit back to the maximum allowable for this field. More...

uint	DefaultCharacterLimit `[get]`
	Gets the character limit that normally applies for this page item (ignoring any custom-specified character limit). More...

bool	IsReadOnly `[get, set]`
	Gets or sets a boolean property indicating if this page item is a read-only item and should not be modifiable on the data entry form. If an editing object has been supplied to the form constructor, the test will be specific to the object being edited More...

bool	IsFullWidth `[get, set]`
	Gets or sets a boolean property indicating if this item should be redered at the full width of the form More...

bool	IsVisible `[get]`
	Gets a boolean property indicating if this page item should be made visible to the currently logged-in user More...

string	Caption `[get, set]`
	Gets or sets a string property indicating the caption that should be used for this page item More...

string	DefaultCaption `[get]`
	Gets a string property indicating the default caption that should be used for this page item More...

bool	IsMultiLine `[get]`
	Gets a boolean property indicating if this page item should normally be displayed across multiple lines. More...

bool	AcceptNewLine `[get]`
	Gets a boolean property indicating if this page item should accept a new line character in the text. More...

bool	IsMandatory `[get, set]`
	Gets or sets a boolean property indicating if this page item should be marked as mandatory on the data entry form More...

bool	IsMandatoryAlways `[get]`
	Gets a boolean property indicating if this page item is always mandatory and the setting cannot be changed More...

bool	IsMandatoryForNewItems `[get]`
	Gets a boolean property indicating if this page item should be marked as mandatory on the data entry form when editing a new object More...

bool	IsTimeMandatory `[get, set]`
	Gets or sets a boolean property indicating that if this page item is a dateTime item, the time component must be supplied. More...

bool	IsTimeMandatoryAlways `[get]`
	Gets a boolean property indicating if this page item must always have a time specified and the setting cannot be changed More...

bool	WarnWhenBlank `[get, set]`
	Gets or sets a boolean value indicating if it a warning should be issued (if a user interface is available) if this field has been left blank. An alternative to the available mandatory settings. More...

PropertyOrFieldValue	EditValue `[get]`
	Gets the value for the property or field definition that is being edited by this form item. Only applies when an editing object has been supplied in the form constructor. More...

int	EditPurpose `[get]`
	Gets a purposeEnum value relevant to the type of object being edited (when this item represents a TrimMainObject) More...

long	EditPurposeExtra `[get]`
	Gets a purposeExtra value (as a supplement for the EditPurpose) relevant to the type of object being edited (when this item represent a TrimMainObject) More...

int	SearchStartingPoint `[get]`
	Gets a starting point for object selection (when this item represents a TrimMainObject). For records, returns a suitable DesktopStartStates enum value, for other objects, returns a SearchStartPoint enum value More...

bool	IsTrimIcon `[get]`
	Gets a boolean value indicating if this item represents a standard Trim Icon More...

PageItemDefinition	EnablingPageItem `[get]`
	Gets a possible parent item that represents a boolean property used to determine if this item should be enable or not. For example, if the "LookupSet.ItemsHaveHierarchy" form item is checked, then the form item for "LookupSet.OnlySelectLowestLevel" should be enabled, otherwise it should be unavailable. 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

This class defines an item contained within an ApiPageDefinition

Member Function Documentation

void HP.HPTRIM.SDK.PageItemDefinition.MoveDown ( )

Move this item down one position in its page

void HP.HPTRIM.SDK.PageItemDefinition.MoveUp ( )

Move this item up one position in its page

Property Documentation

bool HP.HPTRIM.SDK.PageItemDefinition.AcceptNewLine

get

Gets a boolean property indicating if this page item should accept a new line character in the text.

string HP.HPTRIM.SDK.PageItemDefinition.Caption

getset

Gets or sets a string property indicating the caption that should be used for this page item

uint HP.HPTRIM.SDK.PageItemDefinition.CharacterLimit

getset

Gets or sets a user-defined character limit on this data entry item (must be smaller than the default limit). Basically limits how many characters the user can type into this field. Set it to 0 to revert the limit back to the maximum allowable for this field.

string HP.HPTRIM.SDK.PageItemDefinition.DefaultCaption

get

Gets a string property indicating the default caption that should be used for this page item

uint HP.HPTRIM.SDK.PageItemDefinition.DefaultCharacterLimit

get

Gets the character limit that normally applies for this page item (ignoring any custom-specified character limit).

int HP.HPTRIM.SDK.PageItemDefinition.EditPurpose

get

Gets a purposeEnum value relevant to the type of object being edited (when this item represents a TrimMainObject)

long HP.HPTRIM.SDK.PageItemDefinition.EditPurposeExtra

get

Gets a purposeExtra value (as a supplement for the EditPurpose) relevant to the type of object being edited (when this item represent a TrimMainObject)

PropertyOrFieldValue HP.HPTRIM.SDK.PageItemDefinition.EditValue

get

Gets the value for the property or field definition that is being edited by this form item. Only applies when an editing object has been supplied in the form constructor.

PageItemDefinition HP.HPTRIM.SDK.PageItemDefinition.EnablingPageItem

get

Gets a possible parent item that represents a boolean property used to determine if this item should be enable or not. For example, if the "LookupSet.ItemsHaveHierarchy" form item is checked, then the form item for "LookupSet.OnlySelectLowestLevel" should be enabled, otherwise it should be unavailable.

FieldDefinition HP.HPTRIM.SDK.PageItemDefinition.Field

get

Gets the field definition object for this item - only available for items that are a field definition

bool HP.HPTRIM.SDK.PageItemDefinition.IsFullWidth

getset

Gets or sets a boolean property indicating if this item should be redered at the full width of the form

bool HP.HPTRIM.SDK.PageItemDefinition.IsItemAFieldDefinition

get

Gets a boolean property indicating if this page item is a user-defined Field Definition

bool HP.HPTRIM.SDK.PageItemDefinition.IsItemALine

get

Gets a boolean property indicating if this page item is a horizontal line

bool HP.HPTRIM.SDK.PageItemDefinition.IsItemAProperty

get

Gets a boolean property indicating if this page item is a standard property

bool HP.HPTRIM.SDK.PageItemDefinition.IsItemATab

get

Gets a boolean property indicating if this page item is a special "tab" item

bool HP.HPTRIM.SDK.PageItemDefinition.IsMandatory

getset

Gets or sets a boolean property indicating if this page item should be marked as mandatory on the data entry form

bool HP.HPTRIM.SDK.PageItemDefinition.IsMandatoryAlways

get

Gets a boolean property indicating if this page item is always mandatory and the setting cannot be changed

bool HP.HPTRIM.SDK.PageItemDefinition.IsMandatoryForNewItems

get

Gets a boolean property indicating if this page item should be marked as mandatory on the data entry form when editing a new object

bool HP.HPTRIM.SDK.PageItemDefinition.IsMultiLine

get

Gets a boolean property indicating if this page item should normally be displayed across multiple lines.

bool HP.HPTRIM.SDK.PageItemDefinition.IsReadOnly

getset

Gets or sets a boolean property indicating if this page item is a read-only item and should not be modifiable on the data entry form. If an editing object has been supplied to the form constructor, the test will be specific to the object being edited

bool HP.HPTRIM.SDK.PageItemDefinition.IsTimeMandatory

getset

Gets or sets a boolean property indicating that if this page item is a dateTime item, the time component must be supplied.

bool HP.HPTRIM.SDK.PageItemDefinition.IsTimeMandatoryAlways

get

Gets a boolean property indicating if this page item must always have a time specified and the setting cannot be changed

bool HP.HPTRIM.SDK.PageItemDefinition.IsTrimIcon

get

Gets a boolean value indicating if this item represents a standard Trim Icon

bool HP.HPTRIM.SDK.PageItemDefinition.IsVisible

get

Gets a boolean property indicating if this page item should be made visible to the currently logged-in user

PropertyIds HP.HPTRIM.SDK.PageItemDefinition.PropertyId

get

Gets the property identifier for this item - only available for items that are a property

int HP.HPTRIM.SDK.PageItemDefinition.SearchStartingPoint

get

Gets a starting point for object selection (when this item represents a TrimMainObject). For records, returns a suitable DesktopStartStates enum value, for other objects, returns a SearchStartPoint enum value

bool HP.HPTRIM.SDK.PageItemDefinition.WarnWhenBlank

getset

Gets or sets a boolean value indicating if it a warning should be issued (if a user interface is available) if this field has been left blank. An alternative to the available mandatory settings.

Public Member Functions

Properties

Detailed Description

Member Function Documentation

Property Documentation