Home > Class Reference > ENSLIB namespace > %ZEN.Component.dynaGrid

%ZEN.Component.dynaGrid

class %ZEN.Component.dynaGrid extends %ZEN.Component.control, %ZEN.Component.dataView

An editable grid control.
The data and size of the grid is provided by the %ZEN.Auxiliary.dataSet associated with the grid.
The first dimension of the dataSet supplies rows, the second supplies columns. The third dimension, if present, supplies "pages" for the grid. (One page is visible at a time).

Property Inventory (Including Private)

Method Inventory (Including Private)

Parameters

parameter DEFAULTCOLUMNWIDTH = 100;
Default value for the columnWidth property in pixels.
parameter DEFAULTGRIDCLASS = dynaGrid;
Subclasses can set this to change default css class used for grids.
parameter DEFAULTGRIDLABEL;
Default value for the gridLabel property.
parameter DEFAULTROWLABELWIDTH = 100;
Default value for the rowLabelWidth property in pixels.
parameter DEFAULTSHOWARROWS = 0;
Default value for the showArrows property.
parameter SYSMODULE;
Do not include in "form" module.

Properties (Including Private)

property OnCreateDataSet as %ZEN.Datatype.delegator (FORMALSPEC = "pGrid:%ZEN.Component.dynaGrid,pDataSet:%ZEN.Auxiliary.dataSet", RETURNTYPE = "%Status");
Name of Server-side callback method to call to information for each node of this tree.
This must be the name of a server-only method in the page class that contains this component.
Property methods: OnCreateDataSetDisplayToLogical(), OnCreateDataSetGet(), OnCreateDataSetIsValid(), OnCreateDataSetLogicalToDisplay(), OnCreateDataSetLogicalToOdbc(), OnCreateDataSetNormalize(), OnCreateDataSetSet()
property borders as %ZEN.Datatype.string (VALUELIST = ",all,none") [ InitialExpression = "all" ];
Specify whether cell borders should be "all" (the default) or "none".
Property methods: bordersDisplayToLogical(), bordersGet(), bordersIsValid(), bordersLogicalToDisplay(), bordersLogicalToOdbc(), bordersNormalize(), bordersSet()
property cells as list of %ZEN.Auxiliary.gridCell (XMLPROJECTION = "ELEMENT", XMLREF = 1, XMLTYPECONSTRAINT = "CHOICE", ZENSETTING = 0);
Additional specification for cells within the grid. This allows cell-by-cell overrides of formats and styles.
Property methods: cellsBuildValueArray(), cellsCollectionToDisplay(), cellsCollectionToOdbc(), cellsDisplayToCollection(), cellsGet(), cellsGetObject(), cellsGetObjectId(), cellsGetSwizzled(), cellsIsValid(), cellsOdbcToCollection(), cellsSet(), cellsSetObject(), cellsSetObjectId()
property columnHeaderStyle as %ZEN.Datatype.style;
Additional style to apply to column headers in this grid.
Property methods: columnHeaderStyleDisplayToLogical(), columnHeaderStyleGet(), columnHeaderStyleIsValid(), columnHeaderStyleLogicalToDisplay(), columnHeaderStyleLogicalToOdbc(), columnHeaderStyleNormalize(), columnHeaderStyleSet()
property columnWidth as %ZEN.Datatype.length [ InitialExpression = ..#DEFAULTCOLUMNWIDTH ];
This is the default width (in pixels) used for columns that do not supply a width.
Property methods: columnWidthDisplayToLogical(), columnWidthGet(), columnWidthIsValid(), columnWidthLogicalToDisplay(), columnWidthLogicalToOdbc(), columnWidthNormalize(), columnWidthSet()
property columns as list of %ZEN.Auxiliary.gridColumn (XMLPROJECTION = "ELEMENT", XMLREF = 1, XMLTYPECONSTRAINT = "CHOICE", ZENSETTING = 0);
Additional specification for columns within the grid.
Property methods: columnsBuildValueArray(), columnsCollectionToDisplay(), columnsCollectionToOdbc(), columnsDisplayToCollection(), columnsGet(), columnsGetObject(), columnsGetObjectId(), columnsGetSwizzled(), columnsIsValid(), columnsOdbcToCollection(), columnsSet(), columnsSetObject(), columnsSetObjectId()
property currColumn as %ZEN.Datatype.integer [ InitialExpression = 1 ];
This is the column number (1-based) of the current selected cell.
Property methods: currColumnDisplayToLogical(), currColumnGet(), currColumnIsValid(), currColumnLogicalToDisplay(), currColumnLogicalToOdbc(), currColumnNormalize(), currColumnSet()
property currPage as %ZEN.Datatype.integer [ InitialExpression = 1