GetEditorValues()

Summary

Reads a two-dimensional array of values from an editor window.

 

Syntax

Values = GetEditorValues(string editor_name, array region, string order, array options)

 

Argument	Contents
editor_name	The name of the editor from which values are read, or null for the current editor
region	An array of two elements: {array columns, array rows}
order	"Column" for column-major order, "Row" for row-major order

 

No options are currently supported.

 

Returns

An array. For column-major order, the array has one element per column and each element is an array with one element per row. For row-major order, the array has one element per row and each element is an array with one element per column.

 

Notes

• The region variable is identical in format to that returned by GetEditorHighlight().

Example

hl = GetEditorHighlight()

 

// Get the values for the highlighted range in column-major order

values = GetEditorValues(null, hl, "Column", null)

 

Error Codes

Error Type	Meaning
Error	The region or order is invalid
NotFound	There is no editor of the given name

 

See Also

Function	Summary
SetEditorValues()	Writes a value or sequence of numbers into a range of cells in an editor window
GetRecordValues()	Reads the values of one or more fields for a record in a view