Grid
The Origin C Grid class provides properties and methods to set the format for datasheet window – Origin worksheet and matrix sheet.
This class provides the extra function on data selection, setting column/row lable show, setting cell text color, merge cells and so on.
origin.h
| Name | Brief | Example |
|---|---|---|
| Attach | Attach a Grid to a worksheet or matrixsheet | Examples |
| CanDelete | Based on the current selection, it determines whether it is possible to delete if entire rows or columns are selected. | Examples |
| CanInsert | Based on the current selection, it determines whether it is possible to insert rows or columns if entire rows or columns are selected. | Examples |
| CellBkColor | Get and set the background color of a datasheet cell. | Examples |
| CellTextColor | Get and set the text color of a datasheet cell. | Examples |
| Delete | Based on the current selection, it deletes rows or columns if entire rows or columns are selected. | Examples |
| Expand | Expand or collapse tables | Examples |
| GetCurrentCell | It retrieve the location of the cursor on the active sheet. | Examples |
| GetNumChildGrids | Get the number of child grids. | Examples |
| GetOwner | Get the origin object that this grid attached to | Examples |
| GetSelectedRange | It retrieves the current selection in the notation in which the (first, if there are multiple, which is not supported yet) header row or column has index 0, followed by label rows and columns, followed by data rows and columns. | Examples |
| GetSelection | Retrieves current multiple selection ranges from the Grid. | Examples |
| GetShowLabels | to get all show column or row labels | Examples |
| GetUserDefinedLabelNames | to get the name of user defined parameter labels | Examples |
| Grid | Default constructor which constructs an unattached Grid object. | |
| Insert | Based on the current selection, it inserts rows or columns if entire rows or columns are selected. | Examples |
| IsGridLinesShown | to return grid lines are show or hidden | Examples |
| IsheadersShown | check column or row is show or hidden. | Examples |
| IsLabelsShown | to check the specified type label is show or hidden | Examples |
| IsTransposed | to check table is transpose or not | Examples |
| MergeCells | to merge cells. | Examples |
| PutLabelsByType | Put labels of the specified type into all columns. | Examples |
| SetCurrentCell | It highlight the specified cell on the active sheet. | Examples |
| SetSelection | do multiple selection on a given Grid | Examples |
| SetShowLabels | set multiple type labels show once. | Examples |
| SetTranspose | to transpose table. | Examples |
| SetTransposedView | to transpose to column list view. | Examples |
| SetUserDefinedLabelNames | to add user defined labels and named by argument arr. | Examples |
| ShowGridLines | set show/hide grid lines | Examples |
| Showheaders | show/hide column or row header | Examples |
| ShowLabels | show labels | Examples |
| Styles | Get or set the Name styles in the grid selection | Examples |
| Name | Brief | Example |
|---|---|---|
| Cols | The total number of columns. | Examples |
| FixedCols | The number of fixed columns. Fixed columns remain visible when the user scrolls the contents of the grid. They should correspond to our header columns in worksheet. | Examples |
| FixedRows | The number of fixed rows. Fixed rows remain visible when the user scrolls the contents of the grid. They should correspond to our header rows in worksheet. | Examples |
| FrozenCols | The number of frozen columns. Cells in frozen columns can be selected and edited, but they remain visible when the user scrolls the contents horizontally. Frozen columns should correspond to our label columns (i.e. row labels). | Examples |
| FrozenRows | The number of frozen rows. Cells in frozen rows can be selected and edited, but they remain visible when the user scrolls the contents vertically. Frozen rows should correspond to our label rows (i.e. column labels). | Examples |
| Rows | The total number of rows. | Examples |