Class: cCJGridColumn

Specifies whether the column can have focus. See ReportRecordItem.Focusable

Tracks whether peIconAlignment has been explicitly set.

if set false, it will use the codejock edit control

Used to store combo list items before the COM object has been instanciated.

Create a constraints object for the column. The pvComObject for this child object is assigned during OnCreate of the parent grid object.... ReportRecordItemConstraints for the column

Create an edit options object for the column. The pvComObject for this child object is assigned during OnCreate of the parent grid object.... ReportRecordItemEditOptions for the column

control needed to handle masking

these can be set via entry_item command

will be assigned when the grid is registered belowd

Grid Column Properties (private with Get/Set methods).... specifies the column's background color (clNone = use Grid's Color)

Allows\Disallows dragging of the column, see ReportColumn.AllowDrag

Specifies whether the column can be removed from the grid at runtime, see ReportColumn.AllowRemove

Specifies whether the column contains a CheckBox. See ReportRecordItem.HasCheckbox

Specifies whether the Items in the column display a combo button when selected. See ReportRecordItemEditOptions.AddComboButton

Similar to VDF Grid.Column_Combo_Entry_State. See ReportRecordItemEditOptions.ConstraintEdit

Specifies whether a divider is drawn between column footers, see ReportColumn.DrawFooterDivider

Specifies whether the divider is drawn Between column headers. See ReportColumn.DrawHeaderDivider

Specifies whether the Items in the column can be edited. See ReportColumn.Editable and ReportRecordItemEditOptions.AllowEdit

Indicates whether the column supports multi-line rows. See ReportColumn.Alignment

Indicates whether the column is resizable. See ReportColumn.Resizable

Indicates If a column will appear in the FieldChooser when the column is hidden. See See ReportColumn.ShowInFieldChooser.

Specifies whether the column is visible in the ReportControl. See ReportColumn.Visible

Specifies the column footer text alignment. See ReportColumn.FooterAlignment

Specifies the column header text alignment. See ReportColumn.HeaderAlignment

column icon alignment. See ReportColumn.Alignment

column text alignment. See ReportColumn.Alignment

specifies the disabled column's background color (clNone = use Column Color)

specifies the disabed column's text color (clNone = use Column Color)

(internal) Icon ID of the image to display in column header, psImage (above)

Maximum column width (If Set as positive). This only applies when AutoSize is False. See ReportColumn.MaximumWidth

the maximum number of characters that can be entered when editing an item. See ReportControlItemEditOptions.MaxLength

Specifies the minimum width that a column can be sized to If resizable. See ReportColumn.MinimumWidth

Specifies the minimal default column width. See ReportColumn.Width

Text caption for the column header, see ReportColumn.Caption

The text that is displayed in the column's footer. see ReportColumn.FooterText

Image to display in column header, see ReportColumn.Icon

Specifies the mask token characters. See VDF Grid, Form_Mask

Tool tip that is displayed when the mouse cursor is positioned over the column header. See ReportColumn.Tooltip

specifies the column's text color (clNone = use Grid's Color)

returns true if keyboard navigation is allowed for this column. pass whether the navigation is forward or backwards, return True if allowed We don't test Entering here, which can refuse the focus. Even though you can navigate into the column, Entering or Exiting might not allow it when the change is attempted.

returns a string representing the passed checked state

This is the column displayed order of this object

returns a tGridSortRules type which defines the rules for sorting this column. by default the rule is sort ascending the current column based on its datatype

======================================================================================== Methods................................................................................. ======================================================================================== ComboAddItem Adds a member to the combo list for this column. See ReportColumn.EditOptions.Constraints.Add sCaption - Is the value displayed in the combo list. iData - Is the numeric data value representing the combo item.

ComboData Returns the set of combo items in the combo list for this column. See ReportColumn.EditOptions.Constraints.Constraint.Data I decided to return the entire set of combo items in an array of struct. We could change this to provide an indexed access.

ComboDeleteData Clears the combo list for this column. See ReportColumn.EditOptions.Constraints.DeleteAll

Returns a match for the passed caption starting at position iStartAt

ComboInitialize: Rebuilds the column combo list (ReportRecordItemConstraints) from the internal array of constraint data.

Inherited from cCJReportColumn

allows you to assign a different row context menu for this column. The current default grid menu is passed in. If you return 0, no menu is used

Creates the COM column object. Called as part of grid activation

Can be used to set up a currency/mask for this column by passing digits to the left and right

Can be used to set up a numric/mask for this column by passing digits to the left and right

returns an initialized custom VDF edit object

test if two values are valid and eq based on the passed datatype

Can be used to determine if the column object understands the DEO interface

called in OnComBeforeDrawRow to paint for this column

Use this object to trap the error and do nothing

takes value from datasource and formats it for display.

takes value from edit control and "unformats" it

allows you to assign a different header context menu for this column. The current default grid menu is passed in. If you return 0, no menu is used

Called when an initial value is needed. With simple grids this is called when a row is inserted or appended. With dbgrids it is called for each record found

returns true of column can take the focus (focusable and editable)

Find the next column that can be navigated into. Returns byref the new column and if this is a wrap. If return value is True if column could be found

sent when the grid exits edit mode and the value needs to be updated. ret true if changed

notification that a checked value has been pressed.

OnCreateColumn event called at end of creation of com column object

OnEndEdit

OnEntering

OnEntry

OnExit

OnExiting

OnGetTooltip Fired whenever the mouse is positioned over a grid cell belonging to this column. iRow - Is the row number of the cell that the mouse is positioned over. sValue - Is the current cell value of the cell that the mouse is positioned over. sText - Is the default tooltip to be displayed returns - The tooltip to display for the current mouse co-ordinate. Return empty string to cancel tooltip display over this cell.

OnSetDisplayMetrics Fired when each cell in the column is about to get painted. Use this method to customize the cell's display attributes (color etc). hoGridItemMetrics - This is a handle to a cCJReportRecordItemMetrics object. Manipulate the properties of this objecty to modify the display attributes of the cell being painted. iRow - Is the row number of the row whose cell is being painted. sValue - Is the cell text that is to be painted.

OnValidating

Find the previous column that can be navigated into. Returns byref the new column and if this is a wrap. If return value is True if success

Release/destroy the COM column object. Called as part of grid deactivation

Return the value for this column for the passed row. If this happens to be a column being edited it has the edited value (i.e., the value in the edit object)

Return the value for this column for the selected row. If this happens to be a column being edited it has the edited value (i.e., the value in the edit object)

This is the before value of this column for the selected row where before means the value before the edit is commited.

Inherited from cCJIReportColumn

======================================================================================== Property Get/Set Methods................................................................ ======================================================================================== Color: specifies the column's background color (clNone = use Grid's Color)

Inherited from cCJIReportColumn

piDisabledColor: specifies the column's disabled background color (clNone = use Grid's Color)

Inherited from cCJIReportColumn

piDisabledTextColor: specifies the column's disabled text color (clNone = use Grid's Color)

Inherited from cCJIReportColumn

pbAllowDrag Allows\Disallows dragging of the column, see ReportColumn.AllowDrag

Inherited from cCJIReportColumn

pbAllowRemove Allows\Disallows removing of the column, see ReportColumn.AllowRemove

Inherited from cCJIReportColumn

pbCapslock Set True to force data entry in this column to uppercase characters.

Inherited from cCJIReportColumn

pbCheckbox Specifies whether the column contains a CheckBox. See ReportRecordItem.HasCheckbox

Inherited from cCJIReportColumn

pbComboButton Specifies whether a combo control is used to edit this column.

Inherited from cCJIReportColumn

pbComboEntryState Similar to VDF Grid.Column_Combo_Entry_State. See ReportRecordItemEditOptions.ConstraintEdit

Inherited from cCJIReportColumn

pbDrawFooterDivider Specifies whether a divider is drawn between column footers, see ReportColumn.DrawFooterDivider.

Inherited from cCJIReportColumn

pbDrawHeaderDivider Specifies whether the divider is drawn Between column headers. See ReportColumn.DrawHeaderDivider

Inherited from cCJIReportColumn

pbEditable: Specifies whether the Items in the column can be edited. See ReportColumn.Editable and ReportRecordItemEditOptions.AllowEdit

Inherited from cCJIReportColumn

pbMultiLine Indicates whether the column supports multi-line rows. See ReportColumn.Alignment

Inherited from cCJIReportColumn

pbResizable: Indicates whether the column is resizable. See ReportColumn.Resizable

Inherited from cCJIReportColumn

pbShowInFieldChooser Indicates If a column will appear in the FieldChooser when the column is hidden. See See ReportColumn.ShowInFieldChooser.

Inherited from cCJIReportColumn

pbVisible Specifies whether the column is visible in the ReportControl. See ReportColumn.Visible

Inherited from cCJIReportColumn

peDataType

Inherited from cCJIReportColumn

peIconAlignment: Column alignment. See ReportColumn.Alignment

Inherited from cCJIReportColumn

peFooterAlignment Specifies the column footer text alignment. See ReportColumn.FooterAlignment

Inherited from cCJIReportColumn

peHeaderAlignment Specifies the column header text alignment. See ReportColumn.HeaderAlignment

Inherited from cCJIReportColumn

peTextAlignment: Column alignment. See ReportColumn.Alignment

Inherited from cCJIReportColumn

piMaximumWidth Maximum column width (If Set as positive). This only applies when AutoSize is False. See ReportColumn.MaximumWidth .

Inherited from cCJIReportColumn

piMaxLength the maximum number of characters that can be entered when editing an item. See ReportControlItemEditOptions.MaxLength

Inherited from cCJIReportColumn

piMinimumWidth: Specifies the minimum width that a column can be sized to If resizable. See ReportColumn.MinimumWidth

Inherited from cCJIReportColumn

piWidth: Specifies the minimal default column width. See ReportColumn.Width

Inherited from cCJIReportColumn

psCaption Text caption for the column header, see ReportColumn.psCaption

Inherited from cCJIReportColumn

psFooterText The text that is displayed in the column's footer. see ReportColumn.FooterText

Inherited from cCJIReportColumn

psImage: Sets the image/icon name of an icon that is displayed in the column header. See ReportColumn.Icon.

Inherited from cCJIReportColumn

psMask Edit mask string.

Inherited from cCJIReportColumn

psTooltip Tool tip that is displayed when the mouse cursor is positioned over the column header. See ReportColumn.Tooltip

Inherited from cCJIReportColumn

TextColor: specifies the column's background text color (clNone = use Grid's Color)

Inherited from cCJIReportColumn

Inherited from cCJIReportColumn

Inherited from cCJIReportColumn

update value in data-source

commit the value in the edit control without losing its focus

returns boolean checked state of the passed value