LabKit MATLAB Workbench

reference

FrameworkApp SDK API

labkit.app.event.TableCellEdit

Describe one validated table-cell edit signal.

Syntax

edit = labkit.app.event.TableCellEdit(Name=Value)

Description

TableEdit replaces raw MATLAB CellEditData and event metadata with stable row/column identity, the previous and proposed values, and the complete proposed table data when the callback must interpret pasted or related rows atomically.

Required Name-Value Arguments

RowIndex
Positive integer row index.
ColumnIndex
Positive integer column index.
PreviousValue
App-owned value before the edit.
NewValue
App-owned proposed value.

Optional Name-Value Arguments

RowId
Empty or nonempty scalar text stable across sorting. Default: empty.
ColumnId
Empty or nonempty scalar text stable across display-name changes. Default: empty.
Data
Complete proposed table data after the edit. Default: empty.

Outputs

edit
Immutable labkit.app.event.TableCellEdit value.

Errors

labkit:app:contract:UnknownArgument
An option is missing, unknown, duplicated, or unpaired.
labkit:app:contract:InvalidValue
An index or ID is malformed.

Example

edit = labkit.app.event.TableCellEdit(RowIndex=2, ColumnIndex=3, ...
ColumnId="group", PreviousValue="A", NewValue="B");
assert(edit.ColumnId == "group")

Source

This page is generated from the MATLAB help text in +labkit/+app/+event/TableCellEdit.m.