📚 SAP Business One SDK Help

Matrix Object Members
See Also  Overview 

Public Methods

Public Method AddRowAdds a row to the matrix.
Public Method AutoResizeColumnsStretches columns to the full size of the matrix by resizing them.
Public Method ClearClears all data from the matrix.
Public Method ClearRowDataClears the data in the specified matrix row.
Public Method ClearSelectionsClears the selected rows or columns of the matrix.
Public Method DeleteRowDeletes a row from the matrix.
Public Method FlushToDataSourceFlushes current data from the user interface to the bounded data source, as follows:
  1. Cleans the data source.
  2. Copies each row from the matrix to the corresponding data source record.
Public Method GetCellFocusReturns the position of the cell currently in focus.
Public Method GetCellSpecificReturns an instance of a specific (unique) item type, such as EditText or CheckBox, for a specific cell.
Public Method GetLineDataRetrieves the data from a specified row and puts it into the bounded data source of the row.

Use this method to retrieve row data into the bounded data sources of the column. This allows you to work non-editable columns using data sources.

Public Method GetNextSelectedRowReturns the index of the first selected row within a specified range in the matrix.
Public Method GetSchemaReturns the schema for the XML that is returned by the SerializeAsXML method.
Public Method IsRowSelectedIndicates whether a specified row is selected.
Public Method LoadFromDataSourceLoads the user interface with current data from the matrix objects data source.
Public Method LoadFromDataSourceExmethod LoadFromDataSourceEx
Public Method SelectRowSelects rows in the matrix.
Public Method SerializeAsXMLReturns information about the matrix (the data and metadata) in XML format.

The schema of the XML is available using the GetSchema method.

Public Method SetCellFocusSets a cell to the one currently in focus.
Public Method SetCellWithoutValidationSets a matrix cell to skip the validation.
Public Method SetLineDataUpdates a matrix row with the current values from its bounded data source, each column from its corresponding data source.

Use this method to update row data from the bounded data sources of the columns. This allows you to work non-editable columns using data sources.

Public Properties

Public Property ColumnsThe collection of columns in the matrix.
Public Property CommonSettingThe common settings for cells or rows in a grid or matrix.
Public Property ItemThe item properties of the matrix. You can get the item that specifics the matrix, and set the item properties if necessary.
Public Property LayoutThe matrix layout.
Public Property RowCountThe number of rows in the matrix.
Public Property SelectionModeIndicates how rows can be selected.
Public Property TabOrderThe item's tab order, which can be any long integer equal to or greater than 0.

Tab order is the order in which form items get focus when the user presses the TAB key. Only items that can get focus can get a tab order value, for example, you cannot set a tab order for cells or columns.

Two items can have the same tab order, in which case the order is not guaranteed.

Public Property VisualRowCountThe number of rows in the matrix, excluding deleted and collapsed rows.

The number reflects only rows that can be viewed in the user interface.

Events

Public Event ChooseFromListAfterThe event occurs after the user makes a selection in the ChooseFromList form or chooses Cancel.
Public Event ChooseFromListBeforeThe event occurs before the ChooseFromList form is displayed.
Public Event ClickAfterClickAfter
Public Event ClickBeforeClickBefore
Public Event CollapsePressedAfterThe event occurs after the collapse button is pressed.
Public Event CollapsePressedBeforeThe event occurs before the collapse button is pressed.
Public Event ComboSelectAfterThe event occurs after a value was selected in a combo box.
Public Event ComboSelectBeforeThe event occurs before a value was selected in a combo box.
Public Event DatasourceLoadAfterThe event occurs after data was loaded from the GUI into a matrix data source.
Public Event DatasourceLoadBeforeThe event occurs before data was loaded from the GUI into a matrix data source.
Public Event DoubleClickAfterThe event occurs after the main mouse button was double clicked.
Public Event DoubleClickBeforeThe event occurs before the main mouse button was double clicked.
Public Event GotFocusAfterGotFocusAfter
Public Event GridSortAfterThe event occurs after a grid column was sorted.
Public Event GridSortBeforeThe event occurs before a grid column was sorted.
Public Event KeyDownAfterThe event occurs after the key was pressed.
Public Event KeyDownBeforeThe event occurs before the key was pressed.
Public Event LinkPressedAfterThe event occurs after a link arrow was pressed.
Public Event LinkPressedBeforeThe event occurs before a link arrow was pressed.
Public Event LostFocusAfterLostFocusAfter
Public Event MatrixLoadAfterThe event occurs after data was loaded from the database into a matrix data source.
Public Event MatrixLoadBeforeThe event occurs before data was loaded from the database into a matrix data source.
Public Event PickerClickedBeforeThe event occurs before the Picker form is displayed.
Public Event PressedAfterThe event occurs after the item was pressed, that is, a mouse is released within an item.
Public Event PressedBeforeThe event occurs before the item was pressed.
Public Event ValidateAfterAn item lost focus and validation is required. The event occurs after the validation.
Public Event ValidateBeforeAn item lost focus and validation is required. The event occurs after the validation.

See Also