Micro Focus Content Manager SDK 9.4
HP.HPTRIM.SDK.FormDefinition Class Reference

This class defines a generic layout of a data entry form that can be used to drive a web-based data entry application More...

Inheritance diagram for HP.HPTRIM.SDK.FormDefinition:
HP.HPTRIM.SDK.TrimSDKObject

Public Member Functions

 FormDefinition (Database db, BaseObjectTypes objectType)
 Constructs the form definition for the specified object type. Do not use this form for records or locations More...
 
 FormDefinition (Database db, BaseObjectTypes objectType, int formType)
 Constructs the form definition for the specified object type. Do not use this form for records or locations. Allows you to use a formType specifier that may result in a simpler form in some circumstances (for example, a formType of 1 for CheckinStyle provides the simpler email link style form) More...
 
 FormDefinition (Database db, LocationType forLocationsOfType)
 Constructs the form that is used for records of the specified type More...
 
 FormDefinition (TrimObject forEditingObject)
 Constructs the form that is used for editing the supplied object More...
 
 FormDefinition (TrimObject forEditingObject, int formType)
 Constructs the form that is used for editing the supplied object. Allows you to use a formType specifier that may result in a simpler form in some circumstances (for example, a formType of 1 for CheckinStyle provides the simpler email link style form) More...
 
PageDefinition GetPage (uint idx)
 Gets the page at the specified index on this form More...
 
PageDefinition AddGenericPage ()
 adds a new generic page in the the array of pages on this form. More...
 
PageDefinition AddChildPage (BaseObjectTypes childListType)
 adds a new child list editing page in the the array of pages on this form. More...
 
PageDefinition AddStandardPage (DataEntryPageType standardPageType)
 adds a new standard page in the the array of pages on this form. More...
 
void DeletePage (uint idx)
 Removes the page at the specified index. More...
 
void DeleteAllPages ()
 Removes all the pages on this form. More...
 
void Save ()
 Saves this form definition back to the database to be used as the default form definition whenever requiring to edit the object type specified in the form constructor. Do not use this call when working with the form property of a record type, for record type set the RecordPropertiesFormDefinition property More...
 
- Public Member Functions inherited from HP.HPTRIM.SDK.TrimSDKObject
 TrimSDKObject ()
 

Properties

uint PageCount [get]
 destructor Gets the number of pages currently on this form 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 generic layout of a data entry form that can be used to drive a web-based data entry application

Constructor & Destructor Documentation

HP.HPTRIM.SDK.FormDefinition.FormDefinition ( Database  db,
BaseObjectTypes  objectType 
)

Constructs the form definition for the specified object type. Do not use this form for records or locations

HP.HPTRIM.SDK.FormDefinition.FormDefinition ( Database  db,
BaseObjectTypes  objectType,
int  formType 
)

Constructs the form definition for the specified object type. Do not use this form for records or locations. Allows you to use a formType specifier that may result in a simpler form in some circumstances (for example, a formType of 1 for CheckinStyle provides the simpler email link style form)

HP.HPTRIM.SDK.FormDefinition.FormDefinition ( Database  db,
LocationType  forLocationsOfType 
)

Constructs the form that is used for records of the specified type

HP.HPTRIM.SDK.FormDefinition.FormDefinition ( TrimObject  forEditingObject)

Constructs the form that is used for editing the supplied object

HP.HPTRIM.SDK.FormDefinition.FormDefinition ( TrimObject  forEditingObject,
int  formType 
)

Constructs the form that is used for editing the supplied object. Allows you to use a formType specifier that may result in a simpler form in some circumstances (for example, a formType of 1 for CheckinStyle provides the simpler email link style form)

Member Function Documentation

PageDefinition HP.HPTRIM.SDK.FormDefinition.AddChildPage ( BaseObjectTypes  childListType)

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

PageDefinition HP.HPTRIM.SDK.FormDefinition.AddGenericPage ( )

adds a new generic page in the the array of pages on this form.

PageDefinition HP.HPTRIM.SDK.FormDefinition.AddStandardPage ( DataEntryPageType  standardPageType)

adds a new standard page in the the array of pages on this form.

void HP.HPTRIM.SDK.FormDefinition.DeleteAllPages ( )

Removes all the pages on this form.

void HP.HPTRIM.SDK.FormDefinition.DeletePage ( uint  idx)

Removes the page at the specified index.

PageDefinition HP.HPTRIM.SDK.FormDefinition.GetPage ( uint  idx)

Gets the page at the specified index on this form

void HP.HPTRIM.SDK.FormDefinition.Save ( )

Saves this form definition back to the database to be used as the default form definition whenever requiring to edit the object type specified in the form constructor. Do not use this call when working with the form property of a record type, for record type set the RecordPropertiesFormDefinition property

Property Documentation

uint HP.HPTRIM.SDK.FormDefinition.PageCount
get

destructor Gets the number of pages currently on this form