deprecatedclass %ZEN.Auxiliary.gridColumnDescriptor
extends %ZEN.Component.object
Defines a column descriptor within a %ZEN.Component.dataGrid component.
• parameter XMLNAME = "columnDescriptor";
This parameter provides the default XMLNAME for the class. If it is
empty then the class name will be used to construct a default XML name.
The default XMLNAME is used as the top level tag
when exporting objects and the export context
did not provide an XML container name.
• property align
as %ZEN.Datatype.string(VALUELIST=",left,right,center",XMLPROJECTION="attribute");
Optional horizontal alignment to apply to this column.
Use this rather than the style property.
• property caption
as %ZEN.Datatype.caption(XMLPROJECTION="attribute");
Optional caption to apply to this element.
• property columns
as list of %ZEN.Auxiliary.gridColumnDescriptor(XMLPROJECTION="ELEMENT",XMLREF=1,XMLTYPECONSTRAINT="CHOICE",ZENSETTING=0);
Optional child descriptors for this column.
• property format
as %ZEN.Datatype.string(XMLPROJECTION="attribute");
Optional format to apply to this element.
• property headerAlign
as %ZEN.Datatype.string(VALUELIST=",left,right,center",XMLPROJECTION="attribute");
Optional horizontal alignment to apply to the header for this column.
If not defined, then the align is used.
Use this rather than the style property.
• property headerStyle
as %ZEN.Datatype.string(XMLPROJECTION="attribute");
Style string to apply to the header for this column.
• property height
as %ZEN.Datatype.length(XMLPROJECTION="attribute");
Optional height to apply to this element.
• property hidden
as %ZEN.Datatype.boolean(XMLPROJECTION="attribute") [ InitialExpression = 0 ];
Do not show this column.
• property image
as %ZEN.Datatype.uri(XMLPROJECTION="attribute");
For image columns, this is the name of the image to display.
• property ongetlookupspec
as %ZEN.Datatype.eventHandler(XMLPROJECTION="attribute");
This event is used to compute the lookup (popup) information for this column.!!!
• property priority
as %ZEN.Datatype.integer(MAXVAL=2,MINVAL=0,XMLPROJECTION="attribute");
Optional priority to apply to this element.
• property readOnly
as %ZEN.Datatype.boolean(XMLPROJECTION="attribute");
Optional readOnly attribute to apply to this element.
• property style
as %ZEN.Datatype.string(XMLPROJECTION="attribute");
Style string for this column.
• property type
as %ZEN.Datatype.string(VALUELIST=",string,image,button,checkbox,link,lookup,user",XMLPROJECTION="attribute") [ InitialExpression = "string" ];
Type of this column. This is used to determine what kind of editing can occur within this cell
when the dataGrid is in "cells" mode.
"string" -- display a string value and edit as a string.
"image" -- display an image (using the url in the image property).
"button" -- display a button. You must implement an onaction handler for this to take effect.
"checkbox" -- display a checkbox.
"link" -- display an HTML link. You must implement an onaction handler for this to take effect.
"lookup" -- display a lookup control. You must implement an ongetlookupdata handler for this to take effect.
"user" -- display arbitary HTML as defined by the ondrawcell callback.
• property value
as %ZEN.Datatype.string(XMLPROJECTION="attribute");
Optional default value for this column.
This can be a literal value or an expression: "=[@Name]"
• property width
as %ZEN.Datatype.length(XMLPROJECTION="attribute");
Optional default minimum width to apply to this column (in pixels - no units need be supplied)
upon initial rendering. The actual width may be adjusted higher as needed depending on the
actual widths of data in the cells themselves. This setting does not preclude the end user from
manually resizing the column width to a smaller value.
