Getmetapropertyvalue – Kofax DM API User Manual
Page 216

196 C
HAPTER
4
GetMetaPropertyValue
GetMetaPropertyValue
Use this method to get the value of a property from metadata that is
returned when a search or lookup is executed.
Syntax
PCDLookup.GetMetaPropertyValue( strPropName )
PCDRecentDoc.GetMetaPropertyValue( strPropName )
PCDSearch.GetMetaPropertyValue( strPropName )
Parameter
Returns
GetMetaPropertyValue returns a
VARIANT
value that contains the value
of the requested property.
Usage
You specify the metadata property for which you want data returned.
The available metadata properties are
%PropertyName
,
%Title
,
%Visible
, and
%Data
. However, their meaning varies based on
whether the GetMetaPropertyValue method is being used by the
PCDLookup object or a different object.
For
, each row in the metadata property list offers the
following information:
•
%PropertyName
is the name of the property as it is shown on the
base form. It can have the value “
_UNKNOWN_
” if there is no
corresponding property on the base form.
•
%Title
is the title in the Lookup list box for this column. The
%Title
property often contains the prompt that describes the
data when it is presented to the user. It can be blank.
strPropName
The name of the property to be returned in the
results. It should be one of those described
below.