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

Inheritance diagram for HP.HPTRIM.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 into the items array More...

PageItemDefinition	AddPropertyItem (PropertyIds prop)
	adds a new child list editing page in the the array of pages on this form. More...

PageItemDefinition	AddFieldDefinitionItem (FieldDefinition field)
	adds a new child list editing page in the the array of pages on this form. More...

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

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

Public Member Functions inherited from HP.HPTRIM.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 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 a page contained within an ApiFormDefinition

Member Function Documentation

PageItemDefinition HP.HPTRIM.SDK.PageDefinition.AddFieldDefinitionItem ( FieldDefinition field )

adds a new child list editing page in the the array of pages on this form.

PageItemDefinition HP.HPTRIM.SDK.PageDefinition.AddLineItem ( )

adds a new horizontal line into the items array

PageItemDefinition HP.HPTRIM.SDK.PageDefinition.AddPropertyItem ( PropertyIds prop )

adds a new child list editing page in the the array of pages on this form.

PageItemDefinition HP.HPTRIM.SDK.PageDefinition.AddTabItem ( )

adds a new tab positioning item into the items array

void HP.HPTRIM.SDK.PageDefinition.DeleteAllItems ( )

Removes all the items on this page

void HP.HPTRIM.SDK.PageDefinition.DeleteItem ( uint idx )

Removes the page item at the specified index.

PageItemDefinition HP.HPTRIM.SDK.PageDefinition.GetItem ( uint idx )

Gets the item at the specified index on this page

Property Documentation

string HP.HPTRIM.SDK.PageDefinition.Caption

getset

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

PropertyValue HP.HPTRIM.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'

BaseObjectTypes HP.HPTRIM.SDK.PageDefinition.ChildTypeOfPage

get

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

string HP.HPTRIM.SDK.PageDefinition.DefaultCaption

get

Gets or internal default caption for this page

bool HP.HPTRIM.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.

bool HP.HPTRIM.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.

bool HP.HPTRIM.SDK.PageDefinition.ItemCaptionsAboveControl

getset

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

uint HP.HPTRIM.SDK.PageDefinition.ItemCount

get

Gets the number of items currently on this page

EditNotesStyle HP.HPTRIM.SDK.PageDefinition.NotesStyle

get

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

DataEntryPageType HP.HPTRIM.SDK.PageDefinition.PageType

get

Gets the type of this data entry page

Public Member Functions

Properties

Detailed Description

Member Function Documentation

Property Documentation