GetEditorHighlight()
Summary
Gets the highlighted range of cells from an editor window.
Syntax
highlight = GetEditorHighlight(string editor_name)
| Argument | Contents |
|---|---|
| editor_name | The editor whose highlight is returned |
Returns
An array of two elements, the highlighted columns and the highlighted rows. Each of these is an array of strings.
| Element | Type | Contents |
|---|---|---|
| 1 | Array | An array of the field names of the highlighted columns |
| 2 | Array | An array of record handles of the highlighted rows |
Notes
-
If editor_name is null, GetEditorHighlight() returns the range of highlighted cells in the current editor.
-
If entire columns are highlighted, GetEditorHighlight() returns null for the array of row descriptors.
-
If entire rows are highlighted, GetEditorHighlight() returns null for the array of field names.
Error Codes
| Error Type | Meaning |
|---|---|
| NotFound | The specified editor does not exist |
| Error | GetEditorHighlight() was unable to identify the range of highlighted cells |
See Also
| Function | Summary |
|---|---|
| SetEditorHighlight() | Sets the highlighted cell in an editor window |