HPE Content Manager SDK 8.3
|
This class defines an item contained within an ApiPageDefinition More...
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... | |
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... | |
Properties inherited from HP.HPTRIM.SDK.TrimSDKObject | |
string | ErrorMessage [get] |
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... | |
This class defines an item contained within an ApiPageDefinition
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
|
get |
Gets a boolean property indicating if this page item should accept a new line character in the text.
|
getset |
Gets or sets a string property indicating the caption that should be used for this page item
|
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.
|
get |
Gets a string property indicating the default caption that should be used for this page item
|
get |
Gets the character limit that normally applies for this page item (ignoring any custom-specified character limit).
|
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.
|
get |
Gets the field definition object for this item - only available for items that are a field definition
|
getset |
Gets or sets a boolean property indicating if this item should be redered at the full width of the form
|
get |
Gets a boolean property indicating if this page item is a user-defined Field Definition
|
get |
Gets a boolean property indicating if this page item is a horizontal line
|
get |
Gets a boolean property indicating if this page item is a standard property
|
get |
Gets a boolean property indicating if this page item is a special "tab" item
|
getset |
Gets or sets a boolean property indicating if this page item should be marked as mandatory on the data entry form
|
get |
Gets a boolean property indicating if this page item is always mandatory and the setting cannot be changed
|
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
|
get |
Gets a boolean property indicating if this page item should normally be displayed across multiple lines.
|
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
|
getset |
Gets or sets a boolean property indicating that if this page item is a dateTime item, the time component must be supplied.
|
get |
Gets a boolean property indicating if this page item must always have a time specified and the setting cannot be changed
|
get |
Gets a boolean property indicating if this page item should be made visible to the currently logged-in user
|
get |
Gets the property identifier for this item - only available for items that are a property