Purpose
Returns information about a text frame within a a Legend window. You can call this function from the MapBasic window in MapInfo Pro.
Syntax
LegendTextFrameInfo( window_id, frame_id, attribute )window_id is a number that specifies which legend window you want to query.
frame_id is a number that specifies which frame within the legend window you want to query. Frames are numbered 1 to n where n is the number of frames in the legend.
attribute is an integer code indicating which type of information to return.
Return Value
Depends on the attribute parameter.
| Attribute Parameter | ID | LegendTextFrameInfo() Return Value |
|---|---|---|
| FRAME_INFO_POS_X | 1 | Returns the distance of the frame's upper left corner from the left edge of the legend canvas (in paper units). |
| FRAME_INFO_POS_Y | 2 | Returns the distance of the frame's upper left corner from the top edge of the legend canvas (in paper units). |
| FRAME_INFO_WIDTH | 3 | Returns the width of the frame (in paper units). For details about paper units, see Set Paper Units statement. |
| FRAME_INFO_HEIGHT | 4 | Returns the height of the frame (in paper units). For details about paper units, see Set Paper Units statement. |
| FRAME_INFO_TEXT | 5 | Returns the text of a text frame. |
| FRAME_INFO_TEXT_FONT | 6 | Returns the font of the Text Frame text. |
See Also:
LegendInfo() function, LegendFrameInfo() function, LegendStyleInfo() function