SetEditorHighlight()
Summary
Sets the highlighted cell in an editor window.
Syntax
SetEditorHighlight(string editor_name, array highlight)
| Argument | Contents |
|---|---|
| editor_name | The editor whose highlight is changed |
| highlight | An array of two elements, the column and the row to highlight, as follows: |
| Element | Type | Contents |
|---|---|---|
| 1 | Array | An array of the field names of the highlighted columns |
| 2 | Array | An array of the record handles of the highlighted rows |
Notes
-
SetEditorHighlight() currently supports only setting an editor's highlight to a single cell. The array of columns to highlight must have zero or one elements. The array of rows to highlight must have zero or one elements.
-
In addition to setting the highlight of the specified editor, SetEditorHighlight() also ensures that the highlighted cell is visible in the editor window.
-
If the array of columns to highlight is null, SetEditorHighlight() retains the currently highlighted column. If the array of rows to highlight is null, SetEditorHighlight() retains the currently highlighted row. If the highlight array is null, SetEditorHighlight() returns an error.
-
If editor_name is null, SetEditorHighlight() changes the range of highlighted cells in the current editor.
-
The highlight array has the same format as the array returned by GetEditorHighlight().Note, however, that GetEditorHighlight() returns multiple rows and columns when a range of cells is highlighted, but SetEditorHighlight() supports only a single row and column.
Example
SetEditorHighlight("States Editor", {{"State Name"}, {"123"}})Error Codes
| Error Type | Meaning |
|---|---|
| Error | The format of the highlight argument is incorrect, more than one row or column is specified, or the array of rows is null and there is no current record |
| NotFound | The specified editor, column, or row does not exist |
See Also
| Function | Summary |
|---|---|
| GetEditorHighlight() | Gets the highlighted range of cells from an editor window |