Set Designer Frame statement - 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

Purpose

Converts a normal layout frame into an empty frame, or converts an empty frame into a map frame or browser frame, by cloning an existing Map or Browser window. Refer to Create Empty Frames for details on creating empty frames.

Syntax

Set Designer Frame
	[ Window layout_window_id ] 
	Id { empty_frame_id } 
	[ From Window map_or_browser_window_id [ Legends On | Off ]]
	[ Clear ]

layout_window_id is an integer window identifier for a Layout window.

empty_frame_id is a number that specifies which empty frame within the Layout window you want to fill.

map_or_browser_window_id is an integer identifier for the Map or Browser window, which you want to insert in the empty frame.

Description

If Id is an empty frame, then when followed by the From Window clause, the empty frame would be filled by a clone of the Map or Browser window with map_or_browser_window_id. For maps, the content is adjusted to fit the frame size by resizing the cloned window to fit the frame. For browsers, the content is clipped to the frame if necessary.

The From Window clause can also include the optional Legends clause. Specify Legends On if the map you are are cloning has legends, and you want to clone those legends into the Layout window.

Clear clears a layout frame, turning it into an empty frame. This leaves behind an empty frame of the same size and position as the content it just contained, and retains the name currently assigned to it. All frame content (browsers, maps, legends, shapes, images, and text) can be removed using this command, and it can be used on an already empty frame. After clearing an active map or browser frame (the front window), the parent Layout window becomes the front window. Frame properties such as, the border pen, fill brush, and z-order, remain unchanged with the exception of frames containing shapes. The pen and brush for shape content is applied to the shape style itself, so it is not applied to the frame containing the shape. Therefore, once the shape content is removed, the pen and brush settings for the shape are lost. The error code when frames do not clear is: 1699 "Unable to clear Layout frame ^0."