SAP Business One UI API 10.0 - Objects Reference (10.00.270)

• Matrix Object Members

  • UI API

  • • Public Methods

      AddRow	Adds a row to the matrix.
      AutoResizeColumns	Stretches columns to the full size of the matrix by resizing them.
      Clear	Clears all data from the matrix.
      ClearRowData	Clears the data in the specified matrix row.
      ClearSelections	Clears the selected rows or columns of the matrix.
      DeleteRow	Deletes a row from the matrix.
      FlushToDataSource	Flushes current data from the user interface to the bounded data source, as follows: Cleans the data source. Copies each row from the matrix to the corresponding data source record.
      GetCellFocus	Returns the position of the cell currently in focus.
      GetCellSpecific	Returns an instance of a specific (unique) item type, such as EditText or CheckBox, for a specific cell.
      GetLineData	Retrieves 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.
      GetNextSelectedRow	Returns the index of the first selected row within a specified range in the matrix.
      GetSchema	Returns the schema for the XML that is returned by the SerializeAsXML method.
      IsRowSelected	Indicates whether a specified row is selected.
      LoadFromDataSource	Loads the user interface with current data from the matrix objects data source.
      LoadFromDataSourceEx	method LoadFromDataSourceEx
      SelectRow	Selects rows in the matrix.
      SerializeAsXML	Returns information about the matrix (the data and metadata) in XML format. The schema of the XML is available using the GetSchema method.
      SetCellFocus	Sets a cell to the one currently in focus.
      SetCellWithoutValidation	Sets a matrix cell to skip the validation.
      SetLineData	Updates 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

      Columns	The collection of columns in the matrix.
      CommonSetting	The common settings for cells or rows in a grid or matrix.
      Item	The item properties of the matrix. You can get the item that specifics the matrix, and set the item properties if necessary.
      Layout	The matrix layout.
      RowCount	The number of rows in the matrix.
      SelectionMode	Indicates how rows can be selected.
      TabOrder	The 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.
      VisualRowCount	The 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

      ChooseFromListAfter	The event occurs after the user makes a selection in the ChooseFromList form or chooses Cancel.
      ChooseFromListBefore	The event occurs before the ChooseFromList form is displayed.
      ClickAfter	ClickAfter
      ClickBefore	ClickBefore
      CollapsePressedAfter	The event occurs after the collapse button is pressed.
      CollapsePressedBefore	The event occurs before the collapse button is pressed.
      ComboSelectAfter	The event occurs after a value was selected in a combo box.
      ComboSelectBefore	The event occurs before a value was selected in a combo box.
      DatasourceLoadAfter	The event occurs after data was loaded from the GUI into a matrix data source.
      DatasourceLoadBefore	The event occurs before data was loaded from the GUI into a matrix data source.
      DoubleClickAfter	The event occurs after the main mouse button was double clicked.
      DoubleClickBefore	The event occurs before the main mouse button was double clicked.
      GotFocusAfter	GotFocusAfter
      GridSortAfter	The event occurs after a grid column was sorted.
      GridSortBefore	The event occurs before a grid column was sorted.
      KeyDownAfter	The event occurs after the key was pressed.
      KeyDownBefore	The event occurs before the key was pressed.
      LinkPressedAfter	The event occurs after a link arrow was pressed.
      LinkPressedBefore	The event occurs before a link arrow was pressed.
      LostFocusAfter	LostFocusAfter
      MatrixLoadAfter	The event occurs after data was loaded from the database into a matrix data source.
      MatrixLoadBefore	The event occurs before data was loaded from the database into a matrix data source.
      PickerClickedBefore	The event occurs before the Picker form is displayed.
      PressedAfter	The event occurs after the item was pressed, that is, a mouse is released within an item.
      PressedBefore	The event occurs before the item was pressed.
      ValidateAfter	An item lost focus and validation is required. The event occurs after the validation.
      ValidateBefore	An item lost focus and validation is required. The event occurs after the validation.

  • • See Also

      Matrix Overview