CreateEditor()

Summary

Creates a new editor window.

Changes

Removed Code Field Callback option and added Row Background Color option in Version 6.0/2012.

Syntax

actual_name = CreateEditor(string editor_name, string view_set_name, array columns, array options)

Argument	Contents
editor_name	The requested name for the editor
view_set_name	The name of the view and set to display, separated by a vertical bar
columns	An array of field names to display, or null to display all fields

Option	Type	Contents
Activate Macro	String	The name of a macro that is called whenever the window is activated
Background Menu	String	The context menu associated with a selected window outside the data range
Cell Menu	String	The context menu when a cell is selected
Close Macro	String	The name of a macro that is called when the user closes the window from the system menu
Column Menu	String	The context menu associated with a selected column
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 that is 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 that is associated with the window
Position	2 integers	The screen location of the window (x, y)
Range Menu	String	The context menu associated with a selected range of cells (but not a column or row)
Read Only	Boolean	Whether the data are read-only
Row Background Color	Color	The background color to be used to shade every other row in an editor window (the default is window background color, so no shading)
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")
Row Menu	String	The context menu associated with a selected row
Selection Macro	String	The name of a macro that is called whenever the user clicks in a selection set column
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) as percentages of the frame window
Title	String	The title of the window
Toolbar	String	The toolbar that is associated with the window
Trans Head Width	String	The width of the head column in a transposed editor, in number of characters
Trans Data Width	String	The width of each data column in a transposed editor, in number of characters
Transposed	Boolean	Whether the editor is regular ("False") or transposed ("True")

Returns

A string indicating the actual name of the editor window.

Notes

The position and size of the window are expressed as percentages of Maptitude's frame.
The attached menu and toolbar are automatically displayed whenever the editor is activated.
If the menu, toolbar, activate macro, close macro, or highlight macro is not specified, CreateEditor() uses the default specified with SetDefaults(). If an editor-specific default was not specified with SetDefaults(), then CreateEditor() uses the generic default.
The default color for the Row Background option is a moderate gray; use SetEditorOptionEx() to change the color.

Example

folder = RunMacro("G30 Tutorial Folder")

view = OpenTable("Customers", "DBASE", {folder + "customer.dbf"})

CreateEditor("Customers", view + "|",

{"ID", "COMPANY", "SALES"},

{{"Position", 0, 0},

{"Size", 50, 100},

{"Read Only", "True"},

{"Grid", "True"},

{"Row Labels","1"}})

Function	Summary
CloseEditor()	Closes an editor window
OpenEditor()	Creates an editor from a file
OpenTable()	Opens a table from a file
SaveEditor()	Saves an editor to a file
SetDefaults()	Sets default menus, toolbars, and macros
SetEditorOption()	Sets an option for an editor window
SetRowOrder()	Sets the order in which rows appear in an editor