Kofax DM API - Manual (Page 306)

286 C HAPTER 4
SetTargetProperty
SetTargetProperty
Use this method to set the target property of a lookup.
Syntax
PCDLookup.SetTargetProperty( strTargetProp )
Parameter
Returns
Returns an HRESULT to receive the result of the call. S_OK indicates
success. Languages such as JavaScript, Visual Basic, and VBScript
return this as a function value.
Usage
The target property can be any data object that appears on a lookup
form. If your form has a data item called
SUPERVISOR , it will usually be
mapped to the lookup form as “ SUPERVISOR” , and you select it as the
target property by passing that identifier as the SetTargetProperty
parameter.
Note: While the DM API allows you to change the name of fields on forms you
create (or modify), you should only do this when absolutely necessary. You
should never rename original fields on the standard forms that DM creates
when you initially install it.
You can use the AddUserFilterCriteria method to further limit the
search. If you want to retrieve documents written by Mary Smith, the
AddUserFilterCriteria method allows you, for example, to restrict the
search to author names that match “SMITH_M”.
Related Items
See the PCDLookup object.
See the AddUserFilterCriteria method.
See the following properties:
strTargetProp A string variable that identifies the target
property that is to be used for the lookup.