Kofax DM API - Manual (Page 158)

138 C HAPTER 4
AddReturnMetaProperty
AddReturnMetaProperty
The AddReturnMetaProperty method allows you to retrieve
information about the data requested in a search. For example, your
custom application can use AddReturnMetaProperty to determine if an
object returned in your search result set is supposed to be visible to the
user or not.
The available metadata properties are %PropertyName , %Title ,
%Visible , and %Data . Each row in the metadata property list offers
the following information:
• %PropertyName is the name of the property as it is identified on
the base form. It can have the value “ _UNKNOWN_ ” if there is no
corresponding property on the base form.
• %Title is the title of this column. The %Title property often
contains the prompt that describes the data when it is presented to
the user. It can be blank.
• %Visible is a flag indicating whether or not this column should
be displayed to the user.
• %Data is the value of this column in the current row of the data (as
opposed to the metadata). For example, %PropertyName could
return “ AUTHOR_ID ”, and %Data could return “ J_SMITH ”.
Note: For compatibility purposes, AddReturnMetaProperty also supports these
property names as an alternative to the preferred terms shown above:
PROPNAME
, TITLE, VISIBLE, and DATA.
Syntax
PCDRecentDoc.AddReturnMetaProperty( strPropName
)
PCDSearch.AddReturnMetaProperty( strPropName )