Purpose
This function returns a value corresponding to the key stored in the metadata that is associated with a frame within a Layout window. The function does not apply to the classic Layout window. You can call this function from the MapBasic window in MapInfo Pro.
Syntax
LayoutItemMetadataValue( window_id, frame_id, key)window_id is an integer window identifier.
frame_id is a number that specifies which frame within a Layout window you want to query. Frames are numbered 1 to n where n is the number of frames in the layout.
key is a string representing the key of a layout frame’s metadata value to search for.
Return Value
String
This function returns a metadata value by passing a key for a frame within a Layout window. If the key is not found, then returns "". The returned value is the value corresponding to the key stored in the metadata for a particular frame.
Description
The window_id parameter specifies which window to query. In a multi-page layout, this function only searches the current page selection.