GetEditorOption()

Summary

Gets the value of an option from an editor window.

 

Changes

Added Row Background option to version 5.0.

 

Syntax

value = GetEditorOption(string editor_name, string option)

 

Argument	Contents
editor_name	The name of the editor, or null for the current editor
option	The name of the option, from the table below

 

Returns

A string indicating the value of the specified option.

 

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)
Menu	String	The menu that is associated with the window
Range Menu	String	The context menu associated with a selected range of cells (but not a column or a row)
Read Only	Boolean	Whether the data are read-only
Row Background	Boolean	Whether every other row in an editor window is shaded a different color ("True") or not ("False")
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
Show Sets	Boolean	Whether the editor includes columns that indicate which records belong to selection sets
Title	String	The title of 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")

 

Examples

// Before running the examples, open any dataview.

if GetEditorOption(, "Grid") = "True" then

     ShowMessage("The grid is on.") else ShowMessage("The grid is off.")

 

// Toggle how an editor is displayed

v = GetEditorOption(, "Transposed")

v = if v then "False" else "True"

SetEditorOption(, "Transposed", v)

RedrawEditor()

 

Error Codes

Error Type	Meaning
NotFound	The specified editor does not exist or the specified option is not valid

 

See Also

Function	Summary
CreateEditor()	Creates a new editor window
OpenEditor()	Creates an editor from a file
SetEditorOption()	Sets an option for an editor window