This class defines a page contained within an ApiFormDefinition More...

Inheritance diagram for TRIM.SDK.PageDefinition:

Public Member Functions
PageItemDefinition	GetItem (uint idx)
	Gets the item at the specified index on this page More...

PageItemDefinition	AddTabItem ()
	adds a new tab positioning item into the items array. More...

PageItemDefinition	AddLineItem ()
	Adds a new horizontal line item into the items array. More...

PageItemDefinition	AddPropertyItem (PropertyIds prop)
	Adds a new item based on a standard Content Manager property into the items array. More...

PageItemDefinition	AddFieldDefinitionItem (FieldDefinition field)
	adds a new item based on a custom FieldDefinition into the items array. More...

PageItemDefinition	AddTextItem (string text, bool italics, bool bold)
	adds a new ExplanatoryText item into the items array. More...

void	DeleteItem (uint idx)
	Removes the page item at the specified index. More...

void	DeleteAllItems ()
	Removes all the items on this page More...

PageItemDefinition	FindItem (PropertyIds prop)
	Looks for an item in this form corresponding the nominated property id. More...

PageItemDefinition	FindItem (FieldDefinition field)
	Looks for an item in this form corresponding the nominated field definition More...

Public Member Functions inherited from TRIM.SDK.TrimSDKObject
	TrimSDKObject ()

Properties
uint	ItemCount `[get]`
	Gets the number of items currently on this page More...

DataEntryPageType	PageType `[get]`
	Gets the type of this data entry page More...

BaseObjectTypes	ChildTypeOfPage `[get]`
	Gets the child object type of this page - only applicable for pages of type 'ChildList' More...

PropertyValue?	ChildPageFilter `[get]`
	Gets the filter used to restrict which items appear in the child list page - only applicable for pages of type 'ChildList' More...

EditNotesStyle	NotesStyle `[get]`
	Gets the notes editing style to use if this page is the standard notes editing page More...

string	Caption `[get, set]`
	Gets or sets the caption to be used as the title of this page More...

string	DefaultCaption `[get]`
	Gets or internal default caption for this page More...

bool	ItemCaptionsAboveControl `[get, set]`
	Gets or sets a boolean value indicating if captions for items should be displayed above the item control More...

bool	HighlightMandatoryItems `[get, set]`
	Gets or sets a boolean value indicating if items that are mandatory (i.e. cannot be blank or zero), an indicator should appear next to the item to alert the user to this state. More...

bool	IsMandatory `[get, set]`
	Gets or sets a boolean value indicating if it is mandatory to enter some data into this page. May used to indicate that an entry must be added for a child list page, but can also apply to some of the standard pages. 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 a page contained within an ApiFormDefinition

Member Function Documentation

◆ AddFieldDefinitionItem()

PageItemDefinition TRIM.SDK.PageDefinition.AddFieldDefinitionItem ( FieldDefinition field )

adds a new item based on a custom FieldDefinition into the items array.

◆ AddLineItem()

PageItemDefinition TRIM.SDK.PageDefinition.AddLineItem ( )

Adds a new horizontal line item into the items array.

◆ AddPropertyItem()

PageItemDefinition TRIM.SDK.PageDefinition.AddPropertyItem ( PropertyIds prop )

Adds a new item based on a standard Content Manager property into the items array.

◆ AddTabItem()

PageItemDefinition TRIM.SDK.PageDefinition.AddTabItem ( )

adds a new tab positioning item into the items array.

◆ AddTextItem()

PageItemDefinition TRIM.SDK.PageDefinition.AddTextItem	(	string	text,
		bool	italics,
		bool	bold
	)

adds a new ExplanatoryText item into the items array.

◆ DeleteAllItems()

void TRIM.SDK.PageDefinition.DeleteAllItems ( )

Removes all the items on this page

◆ DeleteItem()

void TRIM.SDK.PageDefinition.DeleteItem ( uint idx )

Removes the page item at the specified index.

◆ FindItem() [1/2]

PageItemDefinition TRIM.SDK.PageDefinition.FindItem ( FieldDefinition field )

Looks for an item in this form corresponding the nominated field definition

◆ FindItem() [2/2]

PageItemDefinition TRIM.SDK.PageDefinition.FindItem ( PropertyIds prop )

Looks for an item in this form corresponding the nominated property id.

◆ GetItem()

PageItemDefinition TRIM.SDK.PageDefinition.GetItem ( uint idx )

Gets the item at the specified index on this page

Property Documentation

◆ Caption

string TRIM.SDK.PageDefinition.Caption

getset

Gets or sets the caption to be used as the title of this page

◆ ChildPageFilter

PropertyValue? TRIM.SDK.PageDefinition.ChildPageFilter

get

Gets the filter used to restrict which items appear in the child list page - only applicable for pages of type 'ChildList'

◆ ChildTypeOfPage

BaseObjectTypes TRIM.SDK.PageDefinition.ChildTypeOfPage

get

Gets the child object type of this page - only applicable for pages of type 'ChildList'

◆ DefaultCaption

string TRIM.SDK.PageDefinition.DefaultCaption

get

Gets or internal default caption for this page

◆ HighlightMandatoryItems

bool TRIM.SDK.PageDefinition.HighlightMandatoryItems

getset

Gets or sets a boolean value indicating if items that are mandatory (i.e. cannot be blank or zero), an indicator should appear next to the item to alert the user to this state.

◆ IsMandatory

bool TRIM.SDK.PageDefinition.IsMandatory

getset

Gets or sets a boolean value indicating if it is mandatory to enter some data into this page. May used to indicate that an entry must be added for a child list page, but can also apply to some of the standard pages.

◆ ItemCaptionsAboveControl

bool TRIM.SDK.PageDefinition.ItemCaptionsAboveControl

getset

Gets or sets a boolean value indicating if captions for items should be displayed above the item control

◆ ItemCount

uint TRIM.SDK.PageDefinition.ItemCount

get

Gets the number of items currently on this page

◆ NotesStyle

EditNotesStyle TRIM.SDK.PageDefinition.NotesStyle

get

Gets the notes editing style to use if this page is the standard notes editing page

◆ PageType

DataEntryPageType TRIM.SDK.PageDefinition.PageType

get

Gets the type of this data entry page

Public Member Functions

Properties

Detailed Description

Member Function Documentation

◆ AddFieldDefinitionItem()

◆ AddLineItem()

◆ AddPropertyItem()

◆ AddTabItem()

◆ AddTextItem()

◆ DeleteAllItems()

◆ DeleteItem()

◆ FindItem() [1/2]

◆ FindItem() [2/2]

◆ GetItem()

Property Documentation

◆ Caption

◆ ChildPageFilter

◆ ChildTypeOfPage

◆ DefaultCaption

◆ HighlightMandatoryItems

◆ IsMandatory

◆ ItemCaptionsAboveControl

◆ ItemCount

◆ NotesStyle

◆ PageType