ContextData Class Methods
In this section, the ContextData class methods are presented in alphabetical order.
Syntax
ContextData(rec_name, field_name, label, value, isKey, isVisible)Description
Use this constructor method to initialize one row of contextual data for an activity guide.
Parameters
Parameter |
Description |
|---|---|
rec_name |
Specifies the record name that is the source for the contextual field as a string value. |
field_name |
Specifies the name of the source contextual field as a string value. |
label |
Specifies an optional label for the contextual field as a string value. This label can be displayed along with the data value in the activity guide pagelet on the WorkCenter page. |
value |
Specifies the contextual data value as a string. |
isKey |
Specifies a Boolean value indicating whether the contextual field is a key field. |
isVisible |
Specifies a Boolean value indicating whether to display the contextual data and labels in the activity guide pagelet on the WorkCenter page. |
Returns
None.
Syntax
IsEqual(&object)Description
Use this method to evaluate the equivalency of an object with the current ContextData object. Equivalency is established based on the value of five properties: recname, fieldname, keyLabel, keyValue, and ctxKey.
Parameters
Parameter |
Description |
|---|---|
&object |
Specifies the object to be compared as a PTAI_COLLECTION:Collectable object. |
Returns
A Boolean value: True if the objects are equivalent, False otherwise.