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

Inheritance diagram for TRIM.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 TRIM.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 another page item used to determine if this item should be enabled 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...

PropertyValue?	EnablingPageItemValue `[get]`
	Gets the value that the parent item should have if this item is to be enabled. Commonly, for check boxes, it will be simply "true", however when a control is enabled based on a parent combo box control, then this could return the value that needs to be selected inside that parent combobox. More...

bool	IsExplanatoryText `[get]`
	Gets a boolean property indicating if this page item is an ExplanatoryText item type More...

bool	IsItalic `[get]`
	Gets a boolean indicating if the explanatory text should be displayed in Italics. More...

bool	IsBold `[get]`
	Gets a boolean indicating if the explanatory text should be displayed in Bold type. More...

string	ExplanatoryText `[get, set]`
	Gets or sets a string containing the explanatory text for a item that is a static text caption on the page. (i.e. an item which returns true for 'IsExplanatoryText'). More...

bool	CanHavePlaceHolderText `[get]`
	Gets a boolean indicating if this form item has some instructions which could be displayed as 'banner text' in a data entry form control. This is only supported for certain property or field types. More...

string	PlaceHolderText `[get, set]`
	Gets or sets a string containing some text to be displayed as 'place holder text' in a data entry form control. It should appear dimmed within the control and disappear once the user starts typing. More...

string	HoverText `[get, set]`
	Gets or sets a string containing some text to be displayed as 'hover text' in a data entry form control. It should appear as a tool tip. More...

Properties inherited from TRIM.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

◆ MoveDown()

void TRIM.SDK.PageItemDefinition.MoveDown ( )

Move this item down one position in its page

◆ MoveUp()

void TRIM.SDK.PageItemDefinition.MoveUp ( )

Move this item up one position in its page

Property Documentation

◆ AcceptNewLine

bool TRIM.SDK.PageItemDefinition.AcceptNewLine

get

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

◆ CanHavePlaceHolderText

bool TRIM.SDK.PageItemDefinition.CanHavePlaceHolderText

get

Gets a boolean indicating if this form item has some instructions which could be displayed as 'banner text' in a data entry form control. This is only supported for certain property or field types.

◆ Caption

string TRIM.SDK.PageItemDefinition.Caption

getset

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

◆ CharacterLimit

uint TRIM.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.

◆ DefaultCaption

string TRIM.SDK.PageItemDefinition.DefaultCaption

get

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

◆ DefaultCharacterLimit

uint TRIM.SDK.PageItemDefinition.DefaultCharacterLimit

get

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

◆ EditPurpose

int TRIM.SDK.PageItemDefinition.EditPurpose

get

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

◆ EditPurposeExtra

long TRIM.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)

◆ EditValue

PropertyOrFieldValue? TRIM.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.

◆ EnablingPageItem

PageItemDefinition? TRIM.SDK.PageItemDefinition.EnablingPageItem

get

Gets a possible parent item that represents another page item used to determine if this item should be enabled 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.

◆ EnablingPageItemValue

PropertyValue? TRIM.SDK.PageItemDefinition.EnablingPageItemValue

get

Gets the value that the parent item should have if this item is to be enabled. Commonly, for check boxes, it will be simply "true", however when a control is enabled based on a parent combo box control, then this could return the value that needs to be selected inside that parent combobox.

◆ ExplanatoryText

string TRIM.SDK.PageItemDefinition.ExplanatoryText

getset

Gets or sets a string containing the explanatory text for a item that is a static text caption on the page. (i.e. an item which returns true for 'IsExplanatoryText').

◆ Field

FieldDefinition? TRIM.SDK.PageItemDefinition.Field

get

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

◆ HoverText

string TRIM.SDK.PageItemDefinition.HoverText

getset

Gets or sets a string containing some text to be displayed as 'hover text' in a data entry form control. It should appear as a tool tip.

◆ IsBold

bool TRIM.SDK.PageItemDefinition.IsBold

get

Gets a boolean indicating if the explanatory text should be displayed in Bold type.

◆ IsExplanatoryText

bool TRIM.SDK.PageItemDefinition.IsExplanatoryText

get

Gets a boolean property indicating if this page item is an ExplanatoryText item type

◆ IsFullWidth

bool TRIM.SDK.PageItemDefinition.IsFullWidth

getset

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

◆ IsItalic

bool TRIM.SDK.PageItemDefinition.IsItalic

get

Gets a boolean indicating if the explanatory text should be displayed in Italics.

◆ IsItemAFieldDefinition

bool TRIM.SDK.PageItemDefinition.IsItemAFieldDefinition

get

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

◆ IsItemALine

bool TRIM.SDK.PageItemDefinition.IsItemALine

get

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

◆ IsItemAProperty

bool TRIM.SDK.PageItemDefinition.IsItemAProperty

get

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

◆ IsItemATab

bool TRIM.SDK.PageItemDefinition.IsItemATab

get

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

◆ IsMandatory

bool TRIM.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

◆ IsMandatoryAlways

bool TRIM.SDK.PageItemDefinition.IsMandatoryAlways

get

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

◆ IsMandatoryForNewItems

bool TRIM.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

◆ IsMultiLine

bool TRIM.SDK.PageItemDefinition.IsMultiLine

get

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

◆ IsReadOnly

bool TRIM.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

◆ IsTimeMandatory

bool TRIM.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.

◆ IsTimeMandatoryAlways

bool TRIM.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

◆ IsTrimIcon

bool TRIM.SDK.PageItemDefinition.IsTrimIcon

get

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

◆ IsVisible

bool TRIM.SDK.PageItemDefinition.IsVisible

get

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

◆ PlaceHolderText

string TRIM.SDK.PageItemDefinition.PlaceHolderText

getset

Gets or sets a string containing some text to be displayed as 'place holder text' in a data entry form control. It should appear dimmed within the control and disappear once the user starts typing.

◆ PropertyId

PropertyIds TRIM.SDK.PageItemDefinition.PropertyId

get

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

◆ SearchStartingPoint

int TRIM.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

◆ WarnWhenBlank

bool TRIM.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

◆ MoveDown()

◆ MoveUp()

Property Documentation

◆ AcceptNewLine

◆ CanHavePlaceHolderText

◆ Caption

◆ CharacterLimit

◆ DefaultCaption

◆ DefaultCharacterLimit

◆ EditPurpose

◆ EditPurposeExtra

◆ EditValue

◆ EnablingPageItem

◆ EnablingPageItemValue

◆ ExplanatoryText

◆ Field

◆ HoverText

◆ IsBold

◆ IsExplanatoryText

◆ IsFullWidth

◆ IsItalic

◆ IsItemAFieldDefinition

◆ IsItemALine

◆ IsItemAProperty

◆ IsItemATab

◆ IsMandatory

◆ IsMandatoryAlways

◆ IsMandatoryForNewItems

◆ IsMultiLine

◆ IsReadOnly

◆ IsTimeMandatory

◆ IsTimeMandatoryAlways

◆ IsTrimIcon

◆ IsVisible

◆ PlaceHolderText

◆ PropertyId

◆ SearchStartingPoint

◆ WarnWhenBlank