SetEditorValues()
Summary
Writes a value or sequence of numbers into a range of cells in an editor window.
Syntax
SetEditorValues(string editor_name, array region, string method, array params, 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} |
| method | "Value" to write an array of values into the cells of the editor, "Sequence" to write a series of numbers into the cells of the editor, or "Formula" to copy the values from another column (including a formula field) into the cells of the editor |
| params | For "Value" method, an array containing the value to be written.For "Sequence" method, an array containing the start_value and step_value.For "Formula" method, an array containing the name of the other column. |
No options are currently supported.
Notes
-
The region variable is identical in format to that returned by GetEditorHighlight().
-
If columns or rows are null, all columns or rows are filled, respectively.
Example
hl = GetEditorHighlight()
// Fill the highlighted range with the number 77.7
SetEditorValues(null, hl, "Value", {77.7}, null)
// Fill the entire editor with missing values
SetEditorValues(null, hl, "Value", {null}, null)
// Fill the Sort Order column with 1, 2, 3, etc.
SetEditorValues(null, {{"[Sort Order]"}, null}, "Sequence", {1, 1}, )Error Codes
| Error Type | Meaning |
|---|---|
| Error | The region or method is invalid |
| NotFound | There is no editor of the given name |
See Also
| Function | Summary |
|---|---|
| GetEditorValues() | Reads a two-dimensional array of values from an editor window |
| GetRecordValues() | Reads the values of one or more fields for a record in a view |
| SetRecordsValues() | Writes a value or sequence of numbers into a range of cells in a view on a table |