Maptitude GISDK Help

OpenEditorFromAnnotation()

Summary

Creates a new editor window from an editor that appears in a layout.

 

Syntax

ed_name = OpenEditorFromAnnotation(string layout_name, integer id, array options)

 

Argument

Contents

layout_name

The name of the layout containing the editor

id

The ID of the editor annotation in the layout

 

Option

Type

Contents

Activate Macro

String

The name of a macro that is called whenever the window is activated

Close Macro

String

The name of a macro that is called when the user closes the window from the system menu

Done Macro

String

The name of a macro that is called after the window is closed

Font

String

The font in which data are displayed

Grid

Boolean

Whether the editor displays a grid between cells

Highlight Macro

String

The name of a macro called whenever the user changes cells that are highlighted in the editor (by clicking on a cell or dragging over a range of cells)

Locked

Boolean

If "True" the Close option does not appear in the system menu; if "False" the Close option does appear

Menu

String

The menu associated with the window

Position

2 integers

The screen location of the window (x, y)

Read Only

Boolean

Whether the data are read-only

Row Labels

String

Number of columns (fields) that should be locked in place at the left edge of the editor window. This option must be specified as a string (e.g., "2")

Show Sets

Boolean

Whether the editor includes columns that indicate which records belong to selection sets

Size

2 integers

The screen size of the window (x, y)

Title

String

The title of the window

Toolbar

String

The toolbar associated with the window

 

Notes

Returns

A string containing the actual name of the new editor.

 

Error Codes

Error Type

Meaning

Error

The editor window could not be created

NotFound

The specified layout or editor annotation does not exist

 

See Also

Function

Summary

CloseEditor()

Closes an editor window

OpenEditor()

Creates an editor from a file

CreateEditor()

Creates a new editor window

SaveEditor()

Saves an editor to a file

SetDefaults()

Sets default menus, toolbars, and macros

 

 

©2025 Caliper Corporation www.caliper.com