Window Settings - MapBasic - 2023

MapInfo MapBasic Reference

Product type
Software
Portfolio
Locate
Product family
MapInfo
Product
MapInfo > MapBasic
Version
2023
Language
English
Product name
MapBasic
Title
MapInfo MapBasic Reference
First publish date
1985
Last updated
2023-09-12
Published on
2023-09-12T16:32:32.686312

The WINDOW_CLAUSES are optional clauses that set Legend window properties.

Syntax

Create Designer Legend 
	[ From Window map_window_id ]
	[ WINDOW_CLAUSES ]
	[ DEFAULT_FRAME_CLAUSES ]
	[ LEGEND_TEXT_FRAME_CLAUSE ]
	[ FRAME_FROM_LAYER_CLAUSE ]

Where WINDOW_CLAUSES is:

Create Designer Legend 
	[ From Window map_window_id ]
	[ Position ( x, y ) [ Units paper_units ] ] 
	[ Width win_width [ Units paper_units ] ] 
	[ Height win_height [ Units paper_units ] ] 
	[ Min | Max | Restore | Floating | Docked | Tabbed | AutoHidden ]
	[ Window Title { legend_window_title } 
	[ Portrait | Landscape | Custom ]

map_window_id is an integer window identifier which you can obtain by calling the FrontWindow() function and WindowID() function. If this identifier is for a map within a Layout window, then the legends are created in the window.

x states the desired distance from the left of the workspace to the left edge of the window.

y states the desired distance from the top of the workspace to the top edge of the window.

paper_units is a string representing a paper unit name: cm (centimeters), mm (millimeters), in (inches), pt (points), and pica. For a list of paper unit names, see Set Paper Units statement.

win_width is the desired width of the window.

win_height is the desired height of the window.

legend_window_title is a string expression representing a title for the window, defaults to "Legend of My Map Window" where My Map Window is the Map window title.

Description

The Position clause controls the window's position on MapInfo Pro's workspace. The upper left corner of MapInfo Pro's workspace has the position 0, 0.

The Width and Height clauses control the window's size. Window position and size values use paper unit settings, such as "in" (inches) or "cm" (centimeters). MapBasic has a current paper units setting, which defaults to inches; a MapBasic program can change this setting through the Set Paper Units statement. A Create Designer Legend statement can override the current paper units by including the optional Units sub-clause within the Position, Width, and/or Height clauses.

The Floating clause is a docking state that floats the window. (This only applies to 64-bit MapInfo Pro.)

The Docked clause is a docking state that docks the window to the default position. (This only applies to 64-bit MapInfo Pro.)

The Tabbed clause is a docking state that tabs the window. In this state, a window is called a document. (This only applies to 64-bit MapInfo Pro.)

The AutoHidden clause is a docking state that automatically hides the window. (This only applies to 64-bit MapInfo Pro.)

Portrait or Landscape describes the orientation or automatic arrangement of the legend frames in the window. Portrait results in an orientation that is top to bottom. Landscape results in an orientation that is left to right.

If Custom is specified, you can specify a custom Position clause for each frame.