DspGetMetadataFromName

Name used to retrieve the metadata of an object on the page. Use the following relative path syntax:

[RelativePath].[Group].[Group].Control

This will browse the group hierarchy to a specific starting point, and then drill down to other groups to find the named control or object and metadata. See Referencing an Object using a Name at Runtime for more information.

Syntax

DspGetMetadataFromName(sName, sMetaName)

sName

The Name used as a reference for the object.

sMetaName

The name of the metadata to be returned.

The name belonging to the metadata name/value pair defined in the object's properties metadata tab. See the topic Metadata in the main help for more information.

Return Value

The value of the metadata or blank.

Related Functions

DspSetMetadataFromName

Example

// example of relative pathing syntax
// Relative pathing varies according to the starting point of the search
DspGetMetadataFromName("Object1", "Pump")
DspGetMetadataFromName(".\Object1", "Pump")
DspGetMetadataFromName("..\..\..\Object1", "Pump")

See Also

Display Functions