This is a child object of either the BatchControlDialog (see BatchControlDialog Object) or PromptingControlDialog (see PromptingControlDialog Object) object. Access this object is via the Line method of either those two objects. This object is used to manipulate one of the prompts when displaying a prompting control window.
The order in which the prompt's lines occur depends on the order of the prompting document controls. They are generally in order of batch header, image and document set document controls. Within each record, only the prompting control is added to the array of PromptingControlLine objects. Document controls based on system variables are not shown. This object is only valid during the OnBatchControl or OnPromptingControl events (see VBScript Events).
|
Property |
Type |
Read Only/Write |
Description |
|---|---|---|---|
|
Prompt |
String |
Read Write |
The prompting window's prompt text |
|
Value |
String |
Read Write |
The prompting window's value text |
|
Mask |
String |
Read Write |
This is an edit mask that is applied to the value. See MatchesEditMask for the appropriate string. |
|
MaskErrorMessage |
String |
Read Write |
Displays the specified error message if the edit mask/regular expression fails. |
|
PromptShowMask |
Boolean |
Read Write |
If set to vbTrue, the edit mask/regular expression is displayed in the prompting window. |
|
ReadOnly |
Boolean |
Read Write |
Setting this property makes the prompting control item to be read only. |
|
Required |
Boolean |
Read Write |
If set to vbTrue, the control item will require a non-blank value when the prompting window is displayed. |
|
Regular Expression |
String |
Read Write |
Applies a regular expression edit to the value. |
|
SortList |
Boolean |
Read Write |
If set to vbTrue, the list is sorted alphabetically rather than the order in which items were added. |
|
Hidden |
Boolean |
Read Write |
If set to vbTrue, the prompting control item is not displayed when the prompting window is displayed. |
|
Method |
Parameter |
Description |
|---|---|---|
|
AddValue(strValue) |
String |
Adds a value to the drop down list. |
|
ClearList |
Clears all the drop down list values. |