You will receive one UserField object for every user field in your job when personalizing document Scripts.
Properties:
|
Type
|
Property
|
Description
|
|
String
|
Value
|
Allows you to set the user field value
|
|
bool
|
ValidateStatus
|
Set it to 1 or 0:
-
1 means that the value of this field is correct
-
0 means that the value of this field is incorrect
Keep in mind that script validation overrides normal app validation rules.
|
|
void
|
ValidateMessage
|
Message to show to the user when the value of the field is incorrect.
|
Methods:
|
Returns
|
Method
|
Description
|
|
short
|
Validate
|
Force the document to "revalidate", for example for calculated fields.
|
|
void
|
SetDefaultValue
|
Parameters:
String value - New default value for the field.
|
|
void
|
SetFocus
|
Set focus
|
|
void
|
SetSel
|
Select a range of characters in a field
Parameters:
Short start char
Short end char
|
|
short
|
HelpList_AddValue
|
Parameters:
String - Value to add to the list
Return value index
|
|
short
|
HelpList_AddValueDescription
|
Parameters:
String - Value to add to the list
String - Description to show on the help list
Return value index
|
|
void
|
Enable
|
Parameters:
short, 1 Enable, 0 Disable.
|
|
void
|
ExecuteOnValueChanged
|
Execute OnValueChanged script configured for this field
|
|
void
|
ExecuteOnListValueSelect
|
Execute OnListValueSelect script configured for this field
|
|
void
|
Hide
|
Hides the field
|
|
void
|
Show
|
Shows the field
|
|
void
|
HideOnGridView
|
Hides the field on grid view
|
|
void
|
ShowOnGridView
|
Shows the field on grid view
|
|
void
|
Expand
|
Expand a group field
Parameters:
short, 1 Expand, 0 Contract.
|
