cCJGrid
-------
Wraps the main grid control.
Construct_Object()
- IntegerhoFieldChooserPanel
- IntegerhoDataSource
- IntegerhoContextMenu
- HandlephoDataSource
Object handle properties....................
cCJGridDataSource object
- HandlephoFieldChooserPanel
Field Chooser tool panel object
- HandlephoHeaderContextMenu
- HandlephoContextMenu
- HandlephoContextMenuColumn
column use for context menu
- HandlephoReportToolTipInfo
makes it easier to bind com objects
- HandlephoToolTipContext
- HandlephoReportColumn
- HandlephoReportColumns
- HandlephoReportRecords
- HandlephoReportRecord
- HandlephoReportRecordItem
- HandlephoReportRecordItemMetrics
- HandlephoReportRow
- HandlephoReportRows
- HandlephoReportNavigator
- HandlephoReportPaintManager
- HandlephoImageManagerIcons
- Handle[]phoColumnObjects
collection of report column objects
- BooleanpbSelectTextOnEdit
Determines if text is selected when cell goes into edit mode, see ReportRecordItemEditOptions.SelectTextOnEdit, we apply this setting to every column by default.
- Variantprivate_pvSelectedFont
COM object pointer of the selected cell's Font. This is maintained in OnComBeforeDrawRow.
- Integerprivate_piSelectedTextColor
color of the selected cell's text. This is maintained in OnComBeforeDrawRow.
- Integerprivate_Color
see cReportPaintManager.BackColor
- Booleanprivate_Enabled_State
Gets or sets a value indicating whether the ReportControl can respond to user interaction., see ReportControl.Enabled
- Booleanprivate_pbAllowColumnRemove
Specifies whether ReportColumns can be removed from the ReportControl, see ReportControl.AllowColumnRemove
- Booleanprivate_pbAllowColumnReorder
Specifies whether ReportColumns can be reordered in the ReportControl, see ReportControl.AllowColumnReorder
- Booleanprivate_pbAllowColumnResize
Specifies whether ReportColumns can be resized, see ReportControl.AllowColumnResize
- Booleanprivate_pbAllowEdit
Allows the text in all ReportRecordItems to be edited, see cReportControl.AllowEdit.
- Booleanprivate_pbAutoColumnSizing
Specifies If AutoColumnSizing should be used. see ReportControl.AutoColumnSizing
- Booleanprivate_pbEditOnClick
Determine whether a ReportRecorditem can be edited by single-clicking on the item., see ReportControl.EditOnClick
- Integerprivate_pbFixedInplaceButtonHeight
Specifies whether the paint manager supports fixed height of in-place buttons, see ReportControl.FixedInplaceButtonHeight
- Booleanprivate_pbFullColumnScrolling
Specifies whether full column scrolling will be used., see ReportControl.FullColumnScrolling
- Booleanprivate_pbDrawGridForEmptySpace
Gets or sets wether grid lines will be drawn after the body of rows to fill the empty space. See ReportPaintManager.DrawGridForEmptySpace.
- Booleanprivate_pbGrayIfDisable
Specifies whether to draw the report using "normal" colors or standard Windows disabled colors when the report control disabled. See ReportPaintManager.GrayIfDisable.
- Booleanprivate_pbHideSelection
Determines whether the currently selected rows will remain shaded when the ReportControl loses focus. See ReportPaintManager.HideSelection.
- Booleanprivate_pbHotTracking
Gets\Set whether hot tracking is used While moving the mouse over the column header when using the "Explorer" or "Office 2003" column styles. See ReportPaintManager.HotTracking.
- Booleanprivate_pbInitialSelectionEnable
Specifies whether the first row in the report will become selected when initially populated., see ReportControl.InitialSelectionEnable
- Booleanprivate_pbMultipleSelection
Specifies whether multiple ReportRows can be selected at the same Time in the grid, see cReportControl.MultipleSelection
- Booleanprivate_pbMultiSelectionMode
Enables/disables the multiple selection mode for the control., see ReportControl.MultiSelectionMode
- Booleanprivate_pbSelectionEnable
Gets or sets whether rows will become selected when clicked or navigated with the arrow keys., see ReportControl.SelectionEnable
- Booleanprivate_pbShowFooter
Shows\Hides the report column footer., see ReportControl.ShowFooter
- Booleanprivate_pbShowHeader
The ShowHeader Property is used to hide or display the Column Headers in the Report Control., see ReportControl.ShowHeader
- Booleanprivate_pbShowNonActiveInPlaceButton
Specifies whether to Show NonActive InPlace Buttons (Combo, Expand, Spin) all the Time. See ReportPaintManager.ShowNonActiveInPlaceButton.
- Booleanprivate_pbShowRowFocus
Specifies whether to draw a focus rectangle around the focused row, see cReportControl.ShowRowFocus
- Booleanprivate_pbUseAlternateRowBackgroundColor
Specifies whether to use the piAlternateRowBackgroundColor to color the background of every second row. See ReportPaintManager.UseAlternativeBackground.
- Booleanprivate_pbUseColumnTextAlignment
The UseColumnTextAlignment Property specifies whether the text in the column header will Use the ReportColumn.Alignment setting to align the header caption. See ReportPaintManager.UseColumnTextAlignment.
- Booleanprivate_pbUseEditTextAlignment
Specifies whether the ReportColumn.Alignment setting is automatically applied to items when in edit mode. See ReportPaintManager.UseEditTextAlignment.
- XTPReportBorderStyleprivate_peBorderStyle
The type of border style that is placed around the ReportControl, see ReportControl.BorderStyle
- XTPReportColumnStyleprivate_peColumnStyle
Stores the style used to display ReportColumn headers. See ReportPaintManager.ColumnStyle.
- XTPReportFreezeColsDividerStyleprivate_peFreezeColsDividerStyle
Style of the freeze column divider. See ReportPaintManager.FreezeColsDividerStyle.
- XTPReportGridStyleprivate_peHorizontalGridStyle
Style used to draw horizontal grid lines. See ReportPaintManager.HorizontalGridStyle.
- XTPToolTipStyleprivate_peTooltipStyle
The Style Property gets\sets the style of the tool tip window. See TooltipContext.Style
- XTPReportGridStyleprivate_peVerticalGridStyle
see cReportPaintManager.VerticalGridStyle
- XTPReportWatermarkAlignmentprivate_peWatermarkAlignment
Gets or sets the alignment of the watermark., see ReportControl.WatermarkAlignment
- Integerprivate_piAlternateRowBackgroundColor
The background color of every second grid row. See ReportPaintManager.AlternativeBackgroundColor
- IntegerpiDefaultAlternateRowBackColor
Used to store the COM Object's default. This is a workaround as setting this COM property to -1 does not work.
- Integerprivate_piHScrollStep
Gets\sets the amount of pixels the report is scrolled when the horizontal scroll bar buttons are clicked., see ReportControl.HScrollStep
- Integerprivate_piCaptionBackColor
The background color of the column headers. See ReportPaintManager.CaptionBackColor.
- Integerprivate_piCaptionBackGradientColorDark
The "Dark" color in the color gradient used for the background color of "normal" column headers. See ReportPaintManager.CaptionBackGradientColorDark.
- Integerprivate_piCaptionBackGradientColorLight
The "Light" color in the color gradient used for the background color of "normal" column headers. See ReportPaintManager.CaptionBackGradientColorLight.
- Integerprivate_piCaptionForeColor
The forecolor\caption color of the column headers. See ReportPaintManager.CaptionForeColor.
- Integerprivate_piColumnHotGradientColorDark
The "Dark" color in the color gradient used for the background color of "hot" column headers. See ReportPaintManager.ColumnHotGradientColorDark.
- Integerprivate_piColumnHotGradientColorLight
The "Light" color in the color gradient used for the background color of "hot" column headers. See ReportPaintManager.ColumnHotGradientColorLight.
- Integerprivate_piColumnPushedGradientColorDark
The "Dark" color in the color gradient used for the background color of "pushed" column headers. See ReportPaintManager.ColumnPushedGradientColorDark.
- Integerprivate_piColumnPushedGradientColorLight
The "Light" color in the color gradient used for the background color of "pushed" column headers. See ReportPaintManager.ColumnPushedGradientColorLight.
- Integerprivate_piHeaderHeightMultiplier
number of fixed header rows (overrides cCJGridColumn.pbMultiLine), -1 or 0 = ignore.
- Integerprivate_piFreezeColsDividerColor
Color of the freeze column divider. See ReportPaintManager.FreezeColsDividerColor.
- Integerprivate_piFreezeColumnsCount
Gets\Sets the Number of columns that are frozen when the report is scrolled horizontally., see ReportControl.FreezeColumnsCount
- Integerprivate_piGridLineColor
The color used to draw grid lines. See ReportPaintManager.GridLineColor.
- Integerprivate_piHighlightBackColor
The background color of selected rows. See ReportPaintManager.HighlightBackColor.
- Integerprivate_piHighlightForeColor
The text color of selected rows. See ReportPaintManager.HighlightForeColor.
- Integerprivate_piSelectedRowBackColor
The background color of selected rows when grid doees not have the focus. See ReportPaintManager.SelectedRowBackColor.
- Integerprivate_piSelectedRowForeColor
The text color of selected rows when grid does not have the focus. See ReportPaintManager.SelectedRowForeColor.
- Integerprivate_piHotDividerColor
Gets\sets the color of the arrows used to Show where a column can be dropped when dragging a column header. See ReportPaintManager.HotDividerColor.
- Integerprivate_piTooltipBkColor
Gets\sets the background color of the tool tip window. See TooltipContext.TipBkColor
- Integerprivate_piTooltipMaxWidth
The MaxTipWidth Property gets\sets the maximum tool tip width in pixels. See TooltipContext.MaxTipWidth
- Integerprivate_piTooltipTextColor
Gets\sets the color of the text that is displayed in the tool tip window. See TooltipContext.TipTextColor
- Stringprivate_psNoFieldsAvailableText
The "No Fields Available" text message displayed in the Field Chooser when no Column Headers are present. See ReportPaintManager.NoFieldsAvailableText.
- Stringprivate_psNoItemsText
The "No Items" text message displayed in the ReportControl when there are no visible rows. See ReportPaintManager.NoItemsText.
- Integerprivate_TextColor
Default grid text color. see cReportPaintManager.ForeColor
- Integerprivate_piShadeSortColor
Default sorted column background. see cReportPaintManager.ShadeSortColor
- Booleanprivate_pbShadeSortColumn
- XTPReportDrawSortTriangleStyleprivate_peDrawSortTriangleStyle
- BooleanpbNavigateOutOfEditMode
pbNavigateOutOfEditMode: Internal - Used to determine if the Tab, Shift Tab or Enter keys
were used to navigate out of a cell that was being edited. This property is used to stop
the navigated to cell from going into edit mode. See OnComRequestEdit.
- IntegerpiLastImageId
Used to assign sequential image IDs in the ImageManagerIcons object
- IntegerpiTooltipMarginTop
- IntegerpiTooltipMarginLeft
- IntegerpiTooltipMarginBottom
- IntegerpiTooltipMarginRight
- IntegerpiBeginEditLockCount
- StringpsWatermark
Internal: Used to set up the grid's watermark during OnCreate.
- IntegerpiWatermarkTransparency
Internal: Used to set up the grid's watermark during OnCreate.
- BooleanpbValidateOnNext
- BooleanpbVirtualMode
- HandlephoCustomEdit
- HandlephoIdleHandler
- IntegerpiLastTopRowIndex
last topindex. Used to determine if scrolling in paint
- IntegerpiLastVisibleRowCount
last visible row count. Used to determine if scrolling in paint
- IntegerpiSelectedColumn
- IntegerpiLastKey
- IntegerpiLastKey2
- Integerprivate_pbFocusSubItems
- Integerprivate_pbEditOnKeyNavigation
- BooleanpbInRowFocusChanging
- HandlephoDeferredFocusColumn
- IntegerpiDeferredRemoveRow
- BooleanpbNoFocusChangeCheck
- BooleanpbNeedsRedraw
- IntegerpiFocusCellBackColor
(RGB(217,222,243)) // Background color of the focused cell. clNone means that if pbSelectionEnable is true then piSelectedRowBackColor is used.
- IntegerpiFocusCellForeColor
clBlack // text color of the focused cell. clNone means that if pbSelectionEnable is true then piSelectedRowForeColor is used.
- IntegerpiFocusCellRectangleColor
pen color of the focused cell rectangle. See pbUseFocusCellRectangle
- BooleanpbUseFocusCellRectangle
draw focus rectangle of selected cell. See piFocusCellRectangleColor.
- BooleanpbUseFocusCellColors
draw focus cell background using piFocusCellBackColor & piFocusCellForeColor
- BooleanpbReadOnly
can change rows: in-place edit, save, delete, insert or append
- BooleanpbAllowDeleteRow
can delete rows
- BooleanpbAutoSave
attempt save on row change
- BooleanpbAutoAppend
append new rows when in add mode
- BooleanpbAllowAppendRow
can append a row to the end
- BooleanpbAllowInsertRow
can insert rows
- StringpsLayoutSection
the developer must provide a unique string id for this.
- BooleanpbRestoreLayout
- IntegerpiLayoutBuild
- StringpsOriginalLayout
- StringpsInstanceLayout
- BooleanpbHeaderReorders
click on header reorders
- BooleanpbHeaderTogglesDirection
click on header changes order direction
- BooleanpbHeaderSelectsColumn
click on header sets this as the selected column
- BooleanpbHeaderPrompts
click on header executes prompt if one exists
- Booleanprivate_pbReverseOrdering
current direction of ordering
- IntegerpeGridMouseStatus
determines mouse down, up, moved status
- Integerprivate_piSortColumn
tracks current sort column
- IntegerpiCurrentEditColumn
tracks last column edited (including current edit)
- HandlephoPriorScopeFocus
- HandlepbNeedPostEntering
- BooleanpbEditOnTyping
- BooleanpbBeginEditOnIdle
when set true, OnIdle will start edit-mode if appropriate
- Set(Integer iValue)
------------------------------------------------------------------------
Property Get/Set Methods................................................
------------------------------------------------------------------------
Color
The background color of the grid, see ReportPaintManager.BackColor
- IntegerhoPaintManager
- IntegerColor()
- IntegeriValue
- IntegerhoPaintManager
- Set(Integer bValue)
Enabled_State
Augmented to set/return ReportControl.Enabled
- IntegerEnabled_State()
- BooleanbValue
- Set(Boolean bValue)
pbAllowColumnRemove
Specifies whether ReportColumns can be removed from the ReportControl, see ReportControl.AllowColumnRemove
- BooleanpbAllowColumnRemove()
- BooleanbValue
- Set(Boolean bValue)
pbAllowColumnReorder
Specifies whether ReportColumns can be reordered in the ReportControl, see ReportControl.AllowColumnReorder
- BooleanpbAllowColumnReorder()
- BooleanbValue
- Set(Boolean bValue)
pbAllowColumnResize
Specifies whether ReportColumns can be resized, see ReportControl.AllowColumnResize
- BooleanpbAllowColumnResize()
- BooleanbValue
- Set(Boolean bValue)
pbAllowEdit:
Allows the text in all cells to be edited by default. see cReportControl.AllowEdit
- BooleanpbAllowEdit()
- BooleanbValue
- Set(Boolean bValue)
pbAutoColumnSizing
Specifies If AutoColumnSizing should be used, see ReportControl.AutoColumnSizing
- BooleanpbAutoColumnSizing()
- BooleanbValue
- Set(Boolean bValue)
pbDrawGridForEmptySpace
Gets or sets wether grid lines will be drawn after the body of rows to fill the empty space. See ReportPaintManager.DrawGridForEmptySpace.
- IntegerhoPaintManager
- BooleanpbDrawGridForEmptySpace()
- BooleanbValue
- IntegerhoPaintManager
- Set(Boolean bValue)
pbEditOnClick
Determine whether a ReportRecorditem can be edited by single-clicking on the item., see ReportControl.EditOnClick
- BooleanpbEditOnClick()
- BooleanbValue
- Set(Boolean bValue)
pbFixedInplaceButtonHeight
Specifies whether the paint manager supports fixed height of in-place buttons, see ReportControl.FixedInplaceButtonHeight
- IntegerhoPaintManager
- BooleanpbFixedInplaceButtonHeight()
- BooleanbValue
- IntegerhoPaintManager
- Set(Boolean bValue)
pbFocusSubItems:
If True, when a cell is clicked, the entire row will become highlighted except the individual cell that was clicked.
If False, the entire row will become highlighted when an item is clicked, including the item that was clicked.
Also controls the ability of the grid control to address individual cells.
See cReportControl.FocusSubItems
- BooleanpbFocusSubItems()
- BooleanbValue
- Set(Boolean bValue)
pbFullColumnScrolling
Specifies whether full column scrolling will be used., see ReportControl.FullColumnScrolling
- BooleanpbFullColumnScrolling()
- BooleanbValue
- Set(Boolean bValue)
pbGrayIfDisable
Specifies whether to draw the report using "normal" colors or standard Windows disabled colors when the report control disabled. See ReportPaintManager.GrayIfDisable.
- IntegerhoPaintManager
- BooleanpbGrayIfDisable()
- BooleanbValue
- IntegerhoPaintManager
- Set(Boolean bValue)
pbHideSelection
Determines whether the currently selected rows will remain shaded when the ReportControl loses focus. See ReportPaintManager.HideSelection.
- IntegerhoPaintManager
- BooleanpbHideSelection()
- BooleanbValue
- IntegerhoPaintManager
- Set(Boolean bValue)
pbHotTracking
Gets\Set whether hot tracking is used While moving the mouse over the column header when using the "Explorer" or "Office 2003" column styles. See ReportPaintManager.HotTracking.
- IntegerhoPaintManager
- BooleanpbHotTracking()
- BooleanbValue
- IntegerhoPaintManager
- Set(Boolean bValue)
pbInitialSelectionEnable
Specifies whether the first row in the report will become selected when initially populated., see ReportControl.InitialSelectionEnable
- BooleanpbInitialSelectionEnable()
- BooleanbValue
- Set(Boolean bValue)
pbMultipleSelection:
Specifies whether multiple rows can be selected at the same time, see cReportControl.MultipleSelection
- BooleanpbMultipleSelection()
- BooleanbValue
- Set(Boolean bValue)
pbMultiSelectionMode
Enables/disables the multiple selection mode for the control., see ReportControl.MultiSelectionMode
- BooleanpbMultiSelectionMode()
- BooleanbValue
- Set(Boolean bValue)
pbSelectionEnable
Gets or sets whether rows will become selected when clicked or navigated with the arrow keys., see ReportControl.SelectionEnable
- BooleanpbSelectionEnable()
- BooleanbValue
- Set(Boolean bValue)
pbShowNonActiveInPlaceButton
Specifies whether to Show NonActive InPlace Buttons (Combo, Expand, Spin) all the Time. See ReportPaintManager.ShowNonActiveInPlaceButton.
- IntegerhoPaintManager
- BooleanpbShowNonActiveInPlaceButton()
- BooleanbValue
- IntegerhoPaintManager
- Set(Boolean bValue)
pbShowRowFocus:
Specifies whether to draw a focus rectangle around the focused row, see cReportControl.ShowRowFocus
- BooleanpbShowRowFocus()
- BooleanbValue
- Set(Boolean bValue)
pbShowFooter
Shows\Hides the report column footer., see ReportControl.ShowFooter
- BooleanpbShowFooter()
- BooleanbValue
- Set(Boolean bValue)
pbShowHeader
The ShowHeader Property is used to hide or display the Column Headers in the Report Control., see ReportControl.ShowHeader
- BooleanpbShowHeader()
- BooleanbValue
- Set(Boolean bValue)
pbEditOnKeyNavigation
Determines the behavior of Tab Key Navigation. When False, the default Grid control behavior is applied. When True,
the appication can trap the Tab key to alter its behavior.
See cReportControl.TrapTabKey
- BooleanpbEditOnKeyNavigation()
- BooleanbValue
- Set(Boolean bValue)
pbUseAlternateRowBackgroundColor
Specifies whether to use the piAlternateRowBackgroundColor to color the background of every second row. See ReportPaintManager.UseAlternativeBackground.
- IntegerhoPaintManager
- BooleanpbUseAlternateRowBackgroundColor()
- BooleanbValue
- IntegerhoPaintManager
- Set(Boolean bValue)
pbUseColumnTextAlignment
The UseColumnTextAlignment Property specifies whether the text in the column header will Use the ReportColumn.Alignment setting to align the header caption. See ReportPaintManager.UseColumnTextAlignment.
- IntegerhoPaintManager
- BooleanpbUseColumnTextAlignment()
- BooleanbValue
- IntegerhoPaintManager
- Set(Boolean bValue)
pbUseEditTextAlignment
Specifies whether the ReportColumn.Alignment setting is automatically applied to items when in edit mode. See ReportPaintManager.UseEditTextAlignment.
- IntegerhoPaintManager
- BooleanpbUseEditTextAlignment()
- BooleanbValue
- IntegerhoPaintManager
- Set(XTPReportBorderStyle eValue)
peBorderStyle
The type of border style that is placed around the ReportControl, see ReportControl.BorderStyle
- XTPReportBorderStylepeBorderStyle()
- IntegereValue
- Set(XTPReportColumnStyle iValue)
peColumnStyle
Stores the style used to display ReportColumn headers. See ReportPaintManager.ColumnStyle.
- IntegerhoPaintManager
- XTPReportColumnStylepeColumnStyle()
- IntegeriValue
- IntegerhoPaintManager
- Set(XTPReportFreezeColsDividerStyle iValue)
peFreezeColsDividerStyle
Style of the freeze column divider. See ReportPaintManager.FreezeColsDividerStyle.
- IntegerhoPaintManager
- XTPReportFreezeColsDividerStylepeFreezeColsDividerStyle()
- IntegeriValue
- IntegerhoPaintManager
- Set(XTPReportGridStyle iValue)
peHorizontalGridStyle:
Style used to draw horizontal grid lines. See ReportPaintManager.HorizontalGridStyle.
- IntegerhoPaintManager
- XTPReportGridStylepeHorizontalGridStyle()
- IntegeriValue
- IntegerhoPaintManager
- Set(XTPToolTipStyle iValue)
peTooltipStyle
The Style Property gets\sets the style of the tool tip window. See TooltipContext.Style.
- IntegerhoTooltipContext
- XTPToolTipStylepeTooltipStyle()
- IntegeriValue
- IntegerhoToolTipContext
- Set(XTPReportGridStyle iValue)
peVerticalGridStyle:
Style used to draw vertical grid lines, see cReportPaintManager.VerticalGridStyle
- IntegerhoPaintManager
- XTPReportGridStylepeVerticalGridStyle()
- IntegeriValue
- IntegerhoPaintManager
- Set(XTPReportWatermarkAlignment eValue)
peWatermarkAlignment
Gets or sets the alignment of the watermark., see ReportControl.WatermarkAlignment
- XTPReportWatermarkAlignmentpeWatermarkAlignment()
- IntegereValue
- Set(Integer iValue)
piAlternateRowBackgroundColor
The background color of every second grid row. See ReportPaintManager.AlternativeBackgroundColor
- IntegerhoPaintManager
- IntegerpiAlternateRowBackgroundColor()
- IntegeriValue
- IntegerhoPaintManager
- Set(Integer iValue)
piCaptionBackColor
The background color of the column headers. See ReportPaintManager.CaptionBackColor.
- IntegerhoPaintManager
- IntegerpiCaptionBackColor()
- IntegeriValue
- IntegerhoPaintManager
- Set(Integer iValue)
piCaptionBackGradientColorDark
The "Dark" color in the color gradient used for the background color of "normal" column headers. See ReportPaintManager.CaptionBackGradientColorDark.
- IntegerhoPaintManager
- IntegerpiCaptionBackGradientColorDark()
- IntegeriValue
- IntegerhoPaintManager
- Set(Integer iValue)
piCaptionBackGradientColorLight
The "Light" color in the color gradient used for the background color of "normal" column headers. See ReportPaintManager.CaptionBackGradientColorLight.
- IntegerhoPaintManager
- IntegerpiCaptionBackGradientColorLight()
- IntegeriValue
- IntegerhoPaintManager
- Set(Integer iValue)
piCaptionForeColor
The forecolor\caption color of the column headers. See ReportPaintManager.CaptionForeColor.
- IntegerhoPaintManager
- IntegerpiCaptionForeColor()
- IntegeriValue
- IntegerhoPaintManager
- Set(Integer iValue)
piColumnHotGradientColorDark
The "Dark" color in the color gradient used for the background color of "hot" column headers. See ReportPaintManager.ColumnHotGradientColorDark.
- IntegerhoPaintManager
- IntegerpiColumnHotGradientColorDark()
- IntegeriValue
- IntegerhoPaintManager
- Set(Integer iValue)
piColumnHotGradientColorLight
The "Light" color in the color gradient used for the background color of "hot" column headers. See ReportPaintManager.ColumnHotGradientColorLight.
- IntegerhoPaintManager
- IntegerpiColumnHotGradientColorLight()
- IntegeriValue
- IntegerhoPaintManager
- Set(Integer iValue)
piColumnPushedGradientColorDark
The "Dark" color in the color gradient used for the background color of "pushed" column headers. See ReportPaintManager.ColumnPushedGradientColorDark.
- IntegerhoPaintManager
- IntegerpiColumnPushedGradientColorDark()
- IntegeriValue
- IntegerhoPaintManager
- Set(Integer iValue)
piColumnPushedGradientColorLight
The "Light" color in the color gradient used for the background color of "pushed" column headers. See ReportPaintManager.ColumnPushedGradientColorLight.
- IntegerhoPaintManager
- IntegerpiColumnPushedGradientColorLight()
- IntegeriValue
- IntegerhoPaintManager
- Set(Integer iValue)
piHeaderHeightMultiplier
Determines the height of the report header section in lines of text. See ReportFormulaMulDivC.Multiplier.
If this value = -1 or 0 then it is ignored and the header height is one text line by default,
unless one of the grid columns has pbMultiLine set to True in which case the header height
is determined by the tallest column header.
- IntegerhoPaintManager
- IntegerhoFormula
- VariantvFormula
- BooleanbMultiLineHeader
- IntegerpiHeaderHeightMultiplier()
- IntegeriValue
- Set(Integer iValue)
piFreezeColsDividerColor
Color of the freeze column divider. See ReportPaintManager.FreezeColsDividerColor.
- IntegerhoPaintManager
- IntegerpiFreezeColsDividerColor()
- IntegeriValue
- IntegerhoPaintManager
- Set(Integer iValue)
piFreezeColumnsCount
Gets\Sets the Number of columns that are frozen when the report is scrolled horizontally., see ReportControl.FreezeColumnsCount
- IntegerpiFreezeColumnsCount()
- IntegeriValue
- Set(Integer iValue)
piGridLineColor
The color used to draw grid lines. See ReportPaintManager.GridLineColor.
- IntegerhoPaintManager
- IntegerpiGridLineColor()
- IntegeriValue
- IntegerhoPaintManager
- Set(Integer iValue)
piHighlightBackColor
The background color of selected rows. See ReportPaintManager.HighlightBackColor.
- IntegerhoPaintManager
- IntegeriSelectedRowColor
- IntegerpiHighlightBackColor()
- IntegeriValue
- IntegerhoPaintManager
- Set(Integer iValue)
piHighlightForeColor
The text color of selected rows. See ReportPaintManager.HighlightForeColor.
- IntegerhoPaintManager
- IntegeriSelectedRowColor
- IntegerpiHighlightForeColor()
- IntegeriValue
- IntegerhoPaintManager
- Set(Integer iValue)
piSelectedRowBackColor
The background color of selected rows when grid doees not have the focus. See ReportPaintManager.SelectedRowBackColor.
- IntegerhoPaintManager
- IntegerpiSelectedRowBackColor()
- IntegeriValue
- IntegerhoPaintManager
- Set(Integer iValue)
piSelectedRowForeColor
The text color of selected rows when grid does not have the focus. See ReportPaintManager.SelectedRowForeColor.
- IntegerhoPaintManager
- IntegerpiSelectedRowForeColor()
- IntegeriValue
- IntegerhoPaintManager
- Set(Integer iValue)
piHotDividerColor
Gets\sets the color of the arrows used to Show where a column can be dropped when dragging a column header. See ReportPaintManager.HotDividerColor.
- IntegerhoPaintManager
- IntegerpiHotDividerColor()
- IntegeriValue
- IntegerhoPaintManager
- Set(Integer iValue)
piHScrollStep
Gets\sets the amount of pixels the report is scrolled when the horizontal scroll bar buttons are clicked., see ReportControl.HScrollStep
- IntegerpiHScrollStep()
- IntegeriValue
- Set(Integer iValue)
piTooltipBkColor
Gets\sets the background color of the tool tip window. See TooltipContext.TipBkColor
- IntegerhoTooltipContext
- IntegerpiTooltipBkColor()
- IntegeriValue
- IntegerhoTooltipContext
- Set(Integer iValue)
piTooltipMaxWidth
The MaxTipWidth Property gets\sets the maximum tool tip width in pixels. See TooltipContext.MaxTipWidth.
- IntegerhoTooltipContext
- IntegerpiTooltipMaxWidth()
- IntegeriValue
- IntegerhoTooltipContext
- Set(Integer iValue)
piTooltipTextColor
Gets\sets the color of the text that is displayed in the tool tip window. See TooltipContext.TipTextColor.
- IntegerhoTooltipContext
- IntegerpiTooltipTextColor()
- IntegeriValue
- IntegerhoTooltipContext
- Set(String sValue)
psNoFieldsAvailableText
The "No Fields Available" text message displayed in the Field Chooser when no Column Headers are present. See ReportPaintManager.NoFieldsAvailableText.
- IntegerhoPaintManager
- StringpsNoFieldsAvailableText()
- StringsValue
- IntegerhoPaintManager
- Set(String sValue)
psNoItemsText
The "No Items" text message displayed in the ReportControl when there are no visible rows. See ReportPaintManager.NoItemsText.
- IntegerhoPaintManager
- StringpsNoItemsText()
- StringsValue
- IntegerhoPaintManager
- Set(Integer iValue)
TextColor:
The foreground\text color of the grid, see ReportPaintManager.ForeColor
- IntegerhoPaintManager
- IntegerTextColor()
- IntegeriValue
- IntegerhoPaintManager
- Set(Integer iValue)
piShadeSortColor:
- IntegerhoPaintManager
- IntegerpiShadeSortColor()
- IntegeriValue
- IntegerhoPaintManager
- Set(Boolean bValue)
pbShadeSortColumn:
- IntegerhoPaintManager
- BooleanpbShadeSortColumn()
- BooleanbValue
- IntegerhoPaintManager
- Set(XTPReportDrawSortTriangleStyle eStyle)
peDrawSortTriangleStyle:
- IntegerhoPaintManager
- XTPReportDrawSortTriangleStylepeDrawSortTriangleStyle()
- IntegereStyle
- IntegerhoPaintManager
- IntegerConvertSystemColor(Integer iColor)
------------------------------------------------------------------------
Methods.................................................................
------------------------------------------------------------------------
- IntegeriSysColor
- ActivateFieldChooser()
ActivateFieldChooser:
Send this message to popup a field chooser object.
- IntegerhoFieldChooserPanel
- IntegerAddImageType(Boolean bIsIcon String sImage Integer iId)
AddImageType:
Adds an image to imagelist. Pass if bmp or icon, the image name and the Id and image type (normal, disabled, etc.)
With Bitmaps this will first look for the resource then search for the file in the file path.
With Icons it checks for the file first (explained below)
return Image Id if success
- IntegerhBitmap
- VariantvIcons
- IntegerhoIcons
- IntegeriVoid
- BooleanbOk
- StringsFileImage
- IntegerAddImage(String sImage Integer iId)
AddImage
Adds an image to imagelist.
We assume that this is an icon unless the .bmp extension is passed.
return True if success
- BooleanbIsIcon
- AllowMultiLineCells()
AllowMultiLineCells
Send this message to enable multi line cells in the grid. (usually this message is sent by a column object
when it's pbMultiLine property is set to true.
- IntegerhoPaintManager
- BooleanCreateDataSource()
CreateDataSource
Called by constructor to create a datasource
- IntegerhoDataSource
- HandleCreateHeaderContextMenu()
CreateHeaderContextMenu
Called by constructor to create a header context menu. Can be augmented
create a different object or none at all
- IntegerhoMenu
- IntegerhoMenu1
- HandleCreateContextMenu()
CreateContextMenu
Called by constructor to create a regular context grid menu. Can be augmented
create a different object or none at all. By default this creates nothing
- HandleCreateFieldChooserPanel()
CreateFieldChooserPanel
Called by constructor to create a field chooser panel. Can be augmented
create a different object or none at all
- IntegerhoFieldChooserPanel
- AttachFieldChooser(Handle hoFieldChooser Boolean bAttach)
AttachFieldChooser
Send this message to attach a field chooser object to the Grid. See ReportControl.FieldChooser
hoFieldChooser - is the object handle of the cCJGridFieldChooser control. The field chooser's COM object
should be already created before sending this message.
- VariantvFieldChooser
- BooleanCanCopy()
CanCopy
Indicates whether a Copy operation can be performed., see ReportControl.CanCopy
- BooleanbValue
- BooleanCanCut()
CanCut
Indicates whether a Cut operation can be performed., see ReportControl.CanCut
- BooleanbValue
- BooleanCanPaste()
CanPaste
Indicates whether a Paste operation can be performed., see ReportControl.CanPaste
- BooleanbValue
- Set(Integer i1 Integer i2)
Dynamic_Colors
We need to kill this procedure, else the procedures
Set Color and Set TextColor wont work. (Internal VDF behaviour).
- OnComBeforeDrawRow(Variant llRow Variant llItem Variant llMetrics)
OnComBeforeDrawRow
- IntegerhoItem
- IntegerhoRow
- IntegerhoMetrics
- IntegeriSize
- IntegeriTop
- IntegeriLastTop
- IntegeriRowOffset
- IntegeriLastRowOffset
- IntegeriLastVisibleRowCount
- IntegeriVisRows
- IntegeriRow
- IntegeriCol
- IntegeriSelectedRow
- IntegeriSelectedCol
- IntegeriBackColor
- IntegeriForeColor
- IntegeriFocusedColumnIndex
- StringsValue
- IntegerhoDataSource
- IntegerhoColumn
- IntegerhoFocus
- BooleanbCheckbox
- BooleanbChecked
- BooleanbFocusable
- BooleanbUseFocusCell
- BooleanbSelectionEnable
- BooleanbGridIsFocus
- BooleanbHideSelection
- BooleanbSelected
- BooleanbFauxSelection
- BooleanbCustomEdit
- VariantvFont
- IntegerhoEdit
- IntegeriSizeX
- IntegeriSizeY
- IntegeriLocX
- IntegeriLocY
- IntegeriGuiLoc
- IntegeriGuiLocX
- IntegeriGuiSize
- IntegeriGuiSizeX
- OnComRowRClick(Variant llRow Variant llItem)
OnComRowRClick
Augmented to handle popping up a context menu....
- IntegerhoReportRow
- IntegerhoReportItem
- IntegeriRow
- IntegeriCol
- BooleanbPostEntering
- OnComRowDblClick(Variant llRow Variant llItem)
Augmented to send OnRowDoubleClick
- IntegerhoReportRow
- IntegerhoReportItem
- IntegeriRow
- IntegeriCol
- OnComDrawItem(Variant llRow Variant llColumn Variant llItem OLE_HANDLE hDC Integer iLeft Integer iTop Integer iRight Integer iBottom Boolean ByRef llDoDefault)
OnComDrawItem
Augmented to draw a rectangle around the "focused cell".
- VariantvFocusedColumn
- VariantvFocusedRow
- VariantvRow
- BooleanbVoid
- BooleanbUseFocusCell
- BooleanbContainsFocus
- IntegereHorizontalGrid
- IntegereVerticalGrid
- IntegeriVoid
- IntegeriRow
- IntegeriFocusedRow
- IntegeriFocusedCol
- IntegeriCol
- IntegeriPenColor
- IntegerhPen
- IntegerhPenOld
- IntegerhoRow
- IntegerhoRowCollection
- IntegerhoItem
- IntegerhoDataSource
- IntegerlpOrigin
- tWinPointOrigin
- tWinRectARect
- OnComFocusChanging(Variant llNewRow Variant llNewColumn Variant llNewItem Boolean ByRef llCancel)
OnComFocusChanging
use this to synch the focus row with the datasource's selectrow
Thi gets called first to move to column (if needed) and then it is called to move the row (if needed). If col
is canceled, it is called to mvoe the row with the current column.
- IntegeriIndex
- IntegeriOldRow
- IntegeriOldCol
- IntegeriCol
- IntegerhoReportRow
- IntegerhoItem
- BooleanbSelect
- BooleanbInFocusChanging
- BooleanbNoFocusChangeCheck
- BooleanbPostEntering
- BooleanbEdit
- IntegerhoDataSource
- IntegerhoRows
- VariantvRows
- OnComGetToolTipInfo(Variant lltoolTipInfo)
OnComGetToolTipInfo
Send tooltip event to the appropriate column object.
- VariantvRow
- VariantvItem
- VariantvColumn
- IntegerhoTooltipInfo
- IntegerhoColumnObject
- IntegerhoRow
- IntegerhoItem
- StringsText
- StringsValue
- IntegeriRow
- IntegeriItemIndex
- OnComItemCheck(Variant llRow Variant llItem)
OnComItemCheck
- IntegerhoRow
- IntegerhoItem
- IntegeriRow
- IntegeriColumn
- BooleanbAllowEdit
- OnComKeyDown(Short ByRef llKeyCode Short llShift)
OnComKeyDown
- BooleanbInEdit
- OnComPreviewKeyDown(Short ByRef iKeyCode Short iShift Boolean ByRef bCancel)
OnComPreviewKeyDown
Handle keyboard navigation duties. Triggered after a key is pressed down but before it is processed.
- IntegerhoNavigator
- BooleanbEditMode
- BooleanbFocusSub
- GetCustomEditSizeAndLocation(Handle hoRow Variant llItem Integer ByRef iSizeY Integer ByRef iSizeX Integer ByRef iLocY Integer ByRef iLocX)
this returns by reference the GUI size and location for the edit control.
- IntegeriL
- IntegeriT
- IntegeriR
- IntegeriB
- IntegeriEL
- IntegeriET
- IntegeriER
- IntegeriEB
- IntegeriGuiLoc
- IntegeriGuiLocX
- IntegeriGuiLocY
- OnComRequestEdit(Variant llRow Variant llColumn Variant llItem Boolean ByRef llCancel)
- IntegerhoRow
- IntegerhoItem
- IntegerhoCol
- IntegerhoForm
- IntegeriLocX
- IntegeriLocY
- IntegeriSizeX
- IntegeriSizeY
- IntegeriRow
- IntegeriCol
- IntegeriKey
- IntegeriVoid
- IntegeriKey2
- IntegeriChar
- IntegerhoReportColumn
- IntegerhoReportRow
- IntegerhoReportItem
- IntegerhWnd
- IntegerhoFont
- VariantvFont
- StringsTypeFace
- IntegeriFontSize
- IntegeriWeight
- IntegeriColor
- IntegeriTextColor
- BooleanbItalic
- BooleanbUnderline
- BooleanbSubFocus
- BooleanbCancel
- BooleanbOk
- BooleanbIsCutCopyPaste
- IntegerGetVKeyToAnsi(Integer iVKey Integer iShiftBits)
convert current key press from keydown to ANSI character. Returns 0 in a char
- IntegeriCapsLock
- IntegeriAnsi
- OnComValueChanged(Variant llRow Variant llColumn Variant llItem)
OnComValueChanged
- IntegerhoRow
- IntegerhoItem
- IntegeriRow
- IntegeriColumn
- StringsValue
- OnComMouseDown(Short llButton Short llShift Integer llx Integer lly)
OnComMouseDown
augmented to set internal property to false, which may get reset in OnComColumnOrderChangedEx
- IntegerhoFocus
- OnComMouseUp(Short llButton Short llShift Integer llx Integer lly)
OnComMouseUp
augment to handle mouse header click
- IntegerhoHitTest
- IntegerhoReportColumn
- VariantvHit
- VariantvCol
- IntegeriCol
- IntegereHt
- BooleanbPostEntering
- IntegereMouse
- OnComColumnOrderChangedEx(Variant llColumn XTPReportColumnOrderChangedReason llReason)
OnComColumnOrderChangedEx
augmented so we know that a header click did resulted in some kind of column move. When this happens
we don't want to treat a mouse up as a simple mouse click
- OnCreate()
OnCreate
Called when the COM object is created.
make this private. Use OnCreateGridControl for custom event
- OnCreateGridControl()
OnCreateGridControl
- OnIdle()
OnIdle
- BooleanbDirty
- BooleanbCancel
- BooleanbNeedsRedraw
- BooleanbNeedsPostEntry
- IntegerhoDataSource
- IntegerhoCol
- IntegeriRow
- BeginEditOnIdle()
OnIdle is done and needs to check if the edit control should take the focus.
We set the focus if pbBeginEditOnIdle is true (set by activate) and the grid has
the focus. ResetEditMode may not activate the edit control. This only does something if
pbEditOnNavigate/pbEditOnClick is true (i.e., aggressive edit mode)
- BooleanbBeginEdit
- IntegerhoFoc
- ComRedraw()
- BooleanOnRowChanging(Integer iCurrentSelectedRow Integer iNewRow)
called before row change. iCurrentSelectedRow is the SelectedRow. Return True to cancel
- OnRowChanged(Integer iOldRow Integer iNewSelectedRow)
called after the row change has succeeded. iNewSelectedRow is now the SelectedRow
- OnEnterKey()
- BooleanbEditOnKeyNavigate
- OnEscKey()
- BooleanbIsEdit
- Request_Cancel()
- OnRelease()
OnRelease
- OnHeaderClick(Integer iCol)
- BooleanbSelectCol
- BooleanbFocusSub
- BooleanbPrompt
- BooleanbCancel
- IntegerhoCol
- IntegerhoPrompt
- IntegeriSel
- OnUnknownAreaClick(Integer iX Integer iY)
Handle popping up a click in an unknown area. If autoappend is allowed we will attempt to append
a row to the end of the table. This can be easily cancelled.
- BooleanbEnterOnClick
- IntegeriEL
- IntegeriET
- IntegeriER
- IntegeriEB
- IntegereHt
- IntegeriRow
- IntegeriBottomRow
- IntegerhoHitTest
- IntegerhoDatasource
- IntegerhoReportRow
- VariantvHit
- VariantvRow
- OnHeaderRightClick(Integer iCol)
OnHeaderRightClick
Handle poping up a header context menu
- IntegerhoHeaderContextMenu
- IntegerhoReportColumn
- IntegerhoColumn
- IntegeriIndex
- OnRowDoubleClick(Integer iRow Integer iCol)
- OnRowRightClick(Integer iRow Integer iCol)
Handle popping up a context menu over a row
- IntegerhoContextMenu
- IntegerhoColumn
- IntegerhoDataSource
- IntegeriSelRow
- IntegeriSelCol
- BooleanbFocusSub
- BooleanbCancel
- BooleanOnExiting(Handle hoDestination)
- OnEntering()
- BooleanOnPostEntering()
- OnWrappingRow(Boolean bForwardWrap Handle hoToColumn Boolean ByRef bWrapRow Boolean ByRef bCancel)
When next or previous results in a wrap you can choose to cancel (set bCancel True)
stay within the row (set bWrapRow to False) or activate some other object, row, or column
(just do it and set bCancel True)
- RegisterColumn(Handle hoColumn)
RegisterColumn:
Registers a column object in the columns collection.
- IntegeriSize
- Integer[]hoColumnObjects
- DeferredRedraw()
tells grid to redraw when idle
- BooleanRowChange(Integer iNew)
RowChange
handles possible row change. returns false to cancel
- IntegerhoDataSource
- IntegeriOld
- IntegeriOldCol
- BooleanbCancel
- BooleanbOldCancel
- IntegerSelectedColumn()
SelectedColumn
Call this to get the index of the currently focused column.
- IntegeriIndex
- IntegeriRow
- IntegerhoDataSource
- SetTooltipMargin(Integer iLeft Integer iTop Integer iRight Integer iBottom)
SetTooltipMargin
sets the top, left, bottom, and right margins of the tool tip window. This is the "padding" that is placed around
the tool tip text in the tool tip window.
- IntegerhoTooltipContext
- SetWatermark(String sImage Integer iTransparency)
SetWatermark
Sets a watermark bitmap to be shown in the report control background using a bitmap from file or resource.
sImage - Is the resource image name or the image filename.
iTransparency - Level of transparency. Values can be 0-255 with 0 being totally transparent and 255 being totally visible.
- IntegerhBitmap
- IntegeriVoid
- BooleanbOk
- StringsFileImage
- Handle[]ColumnObjectsInDisplayOrder()
ColumnObjectsInDisplayOrder
return array of column objects in display order.
This will include non visible objects so you may have to test if the object is visible
- Integer[]ItemsArrays
- Integer[]ColumnObjects
- IntegeriDisplayIndex
- IntegeriCols
- IntegeriColIndex
- IntegerhoReportColumns
- IntegerhoReportColumn
- VariantvCol
- IntegerEstimateVisibleRowCount(Handle hoRow Variant llItem)
Must be called from BeforeDrawRow passing the row object and recorditem com pointer.
If variable length row, we change to guess.
- IntegeriTop
- IntegeriLeft
- IntegeriBottom
- IntegeriRight
- IntegeriRowTop
- IntegeriRowBottom
- IntegeriRowLeft
- IntegeriRowRight
- IntegeriTopRow
- IntegeriRowHeight
- IntegeriRowCount
- IntegeriGridHeight
- IntegeriVisibleCount
- NumbernVisibleCount
- IntegerhoPaintManager
- BooleanbFixedHeight
- NewColumn(Integer iColumn)
Selects column without entering exiting messages.
Note that this sets SelectedColumn but it does not synch this with
the grid's focus column. If you misuse this, things will not work
- IntegerhoDataSource
- IntegeriRow
- IntegeriCount
- BooleanForceColumnExit()
Does a column exit without changing the current column.
Is used to force the column exiting events without changing
the column (used during object exiting)
- IntegeriOld
- BooleanbCancel
- BooleanColumnChange(Integer iNew)
changes the column
- BooleanbCancel
- BooleanbIsFocus
- IntegeriOld
- IntegerhoFocus
- BooleanColumnChanging(Integer iOld Integer iNew)
this provides room for us to work within
- BooleanbCancel
- IntegerhoCol
- ColumnChanged(Integer iOld Integer iNew)
this provides room for us to work within
- IntegerhoCol
- CreateGridControl()
- VariantvComObject
- VariantvItem
- VariantvEditOptions
- VariantvConstraints
- VariantvFormula
- IntegerhoObject
- IntegerhoReportColumns
- IntegerhoDataSource
- IntegerhoPaintManager
- IntegerhoColumn
- IntegerhoToolTipContext
- IntegerhoFormula
- IntegerhoReportRecord
- IntegerhoReportRecords
- IntegerhoReportRows
- IntegerhoEditOptions
- IntegerhoConstraints
- IntegerhoIdle
- IntegeriColumn
- IntegericColumn
- IntegeriWidth
- IntegeriRowCount
- IntegeriValue
- IntegeriLeft
- IntegeriTop
- IntegeriRight
- IntegeriBottom
- StringsCaption
- StringsValue
- StringsSettings
- BooleanbResizable
- BooleanbValue
- SaveEnvironment()
Standard SaveEnvironment Behavior. This is called when the grid is deactivated.
This is good for augmentation if you wish to change the standard save
- StringsKey
- StringsSection
- StringsSettings
- BooleanbPreserveEnvironment
- BooleanbRestore
- LoadEnvironment()
Standard LoadEnvironment Behavior.
This is good for augmentation if you wish to change the standard load.
- StringsKey
- StringsSection
- StringsSettings
- BooleanbOk
- BooleanbPreserveEnvironment
- BooleanbRestore
- RestoreLayout()
restores the gird layout with the original object created layout.
It is an error to call this when the grid is not activated.
- StringsSettings
- IntegeriSort
- IntegeriTop
- StoreOriginalLayout()
Stores the current state as the original layout
- StringsSettings
- StringCurrentLayoutAsXML()
return the current layout as an xml document. We use this instead of ComLoadSettings & ComSaveSettings
because those interfaces don't work as well. When two columns have the same name, it messes things up.
- IntegerhoExchange
- IntegerhoExchangePref
- BooleanbOk
- StringsSection
- StringsName
- StringsXmlLayout
- VariantvSection
- RestoreLayoutFromXMLString(String sXmlLayout)
restore the grid based on the passed xml layout string.
- IntegerhoExchange
- IntegerhoExchangePref
- BooleanbOk
- StringsSection
- StringsName
- VariantvSection
- ReleaseComObject()
- IntegerhoDataSource
- IntegerhoObject
- IntegerhoIdle
- Integer[]hoColumnObjects
- IntegericColumn
- IntegeriColumn
- ResetGrid()
does a reset. Clears data. Add columns to datasource
- IntegerhoDataSource
- IntegerhoColumn
- IntegerhoColumnDataSource
- IntegerhoPaint
- IntegeriColumn
- IntegericColumn
- IntegeriCustomDraw
- BooleanbIsVirtual
- BooleanbUseFocusCell
- BooleanbFixed
- BindDataSource()
use this to set any special properties in the datasource that might be
needed for this particular grid and data source
- InitializeData(Variant[] DataSource)
initializes the data
- IntegeriCount
- IntegerhoDataSource
- CreateTemplateRow()
create a template row
- IntegerhoReportRecord
- IntegerhoReportRecords
- VariantvComobject
- VariantvItem
- IntegeriColumn
- IntegericColumn
- IntegeriRows
- CreateColumns()
- IntegerhoColumn
- Integer[]hoColumnObjects
- IntegericColumn
- IntegeriColumn
- HandleColumnObject(Integer iColumn)
returns object for column
- Integer[]hoColumnObjects
- HandleSelectedColumnObject()
returns selected column object, 0 if none
- IntegerhoCol
- IntegeriCol
- IntegerColumnCount()
returns number of columns
- Integer[]hoColumnObjects
- Notify_Focus_Change(Integer Fg)
- IntegerEntering()
- IntegerhoEdit
- IntegerhoScope
- BooleanbOldVal
- BooleanbNeeds
- Set(Integer iPosition)
- BooleanbFocusSub
- PostEntering()
This is called after a focus change is complete during the first idle event
It sends OnEntering which can be cancelled. If cancelled the prior focus object
will be activated. However, if OnEntering changed the focus, it won't do anything
- IntegerhodataSource
- IntegerhoColumn
- IntegerhoEdit
- IntegerhoOld
- BooleanbCancel
- EnteringGrid()
- IntegerhodataSource
- IntegerhoColumn
- IntegerhoEdit
- IntegerhoOld
- VariantvVal
- IntegeriCol
- IntegeriRow
- IntegeriRows
- IntegeriERow
- IntegeriECol
- BooleanbCancel
- BooleanbEdit
- BooleanbSubFocus
- BooleanbAutoAppend
- BooleanbAllowAppend
- BooleanbAllowInsert
- BooleanbReadOnly
- BooleanShouldCommitOnObjectExit(Handle hoDestination)
called when you are exiting object. Return true if the selected row should be
committed - either saved or cleared depending on the autosave state. We pass the
destination object so you can use this to determine where you are exiting to. Sometimes
this will influence the decision.
- IntegerExiting(Handle hoDestination)
it is important that the exiting logic is executed properly, particularly the
custom edit cancellation. For that reason developers are discouraged from augmenting
this method and OnExiting is provided instead
- BooleanbCancel
- BooleanbCommit
- BooleanbSubFocus
- IntegerhoEdit
- IntegeriSelRow
- IntegerhoDatasource
- NotifyEndEdit(Integer iRow Integer iColumn String sValue)
- IntegerhoColumn
- BooleanbChanged
- NotifyCustomEndEdit(Integer iCol String sValue)
- IntegerhoDataSource
- IntegeriRow
- NotifyItemChecked(Integer iRow Integer iColumn)
- IntegerhoColumn
- BooleanbCancel
- BooleanLoadFirstOrLastRow(Boolean bLast)
- IntegerhoDataSource
- IntegeriCount
- BooleanbDirty
- BooleanbCancel
- ResetVirtualMode(Integer iCount)
this does the mechanics of resetting info for virtual mode. Note that after
a reset, everything is cleared, Although focusRow is 0, we are setting select row as not defined
- BooleanbVirtualMode
- PageData(Integer iStartRow)
normally sent within BeforeDraw Paint event. The startrow is the top row and last row must be the
approximate last row (so we have number of rows by subtracting the two). Any special caching (and there is some)
will be handled by PageInRows in the datasource
- IntegeriRowsToRead
- IntegeriLastRow
- IntegerhoDataSource
- ReSynchToDataSource()
called to reset datasource rowcount/offset as needed and then
update the report control
- IntegeriNewRowCount
- IntegeriTop
- IntegeriNewTop
- IntegeriRowCount
- IntegeriOffsetChange
- IntegeriIndex
- Integer[]SelectedRowIndexes
- IntegeriSel
- IntegeriFoc
- IntegeriNewSel
- IntegeriNewFoc
- IntegeriSels
- IntegerhoDataSource
- IntegerhoPaint
- IntegerhoNav
- BooleanbNoFocusChangeCheck
- BooleanbFixedHeight
- BooleanbIsEdit
- RemoveRowAndSelect(Integer iRow)
Removes the row, the row below becomes the selected row unless there are no
rows below and then the row above is selected.
If other rows were selected they are deselected
- IntegeriIndex
- IntegeriSelect
- IntegeriNewRow
- IntegerhoDataSource
- IntegeriRowCount
- BooleanbInEdit
- BooleanbInRowChange
- BooleanbRemoveSelected
- BooleanbNoFocusChangeCheck
- MoveToRow(Integer iIndex)
Move to a row.
- IntegerhoNav
- IntegerhoDataSource
- VariantvNav
- IntegeriCurrent
- IntegeriSel
- IntegeriSelCol
- BooleanbInEdit
- BooleanbEdit
- BooleanbNoFocusChangeCheck
- BooleanbCancel
- MovetoLastRow()
Move to last row and select. This is the last row of data, which may not
be the last row of the current datasource. Can be used to refresh the grid
around the last record
- IntegeriRowCount
- IntegerhoDataSource
- BooleanbCancel
- BooleanbInEdit
- MovetoFirstRow()
Move to first row and select. This is the last row of data, which may not
be the first row of the current datasource. Can be used to refresh the grid
around the first record
- BooleanbCancel
- BooleanbInEdit
- BooleanMoveToColumnObject(Handle hoCol)
MoveToColumnObject
Move to the column and set SelectedColumn.
- IntegerhoNav
- IntegerhoDataSource
- IntegerhoOldCol
- VariantvNav
- IntegeriItemCol
- IntegeriDispayCol
- IntegeriFocusedItemIndex
- IntegeriRows
- BooleanbCancel
- BooleanbInfocusChange
- BooleanbFocusable
- BooleanbSubFocus
- BooleanbInEdit
- HandleFirstEnterableColumn()
returns the first enterable column object, 0 if none
- Integer[]hoCols
- IntegerhoCol
- IntegeriCol
- IntegeriCols
- BooleanbOk
- BooleanbWrap
- HandleLastEnterableColumn()
returns the last enterable column object, 0 if none
- Integer[]hoCols
- IntegerhoCol
- IntegeriCol
- IntegeriCols
- BooleanbOk
- BooleanbWrap
- MoveToFirstEnterableColumn()
move to first enterable column
- IntegerhoCol
- BooleanbOk
- MoveToLastEnterableColumn()
move to last enterable column
- IntegerhoCol
- BooleanbOk
- StringEditValue()
returns the current value from the active edit control
- BooleanbEditMode
- IntegeriLen
- StringsValue
- IntegerhWnd
- IntegerhoEdit
- IntegerhoColumn
- BooleanIsCustomEditMode()
returns true if VDF edit control is active
- IntegerhoEdit
- IntegerhwHnd
- BooleanbEdit
- BooleanIsEditMode()
returns true if built-in or VDF edit control is active
- BooleanbEdit
- EndEdit()
ends edit mode. If not in edit mode, does nothing
- IntegerhwHnd
- IntegerhoEdit
- IntegerhoFocus
- BooleanbInEdit
- IntegeriVal
- LockBeginEdit()
- UnlockBeginEdit()
- BooleanIsBeginEditLocked()
- IntegeriLocked
- BeginEdit()
starts edit mode if not already in edit mode
- BooleanbInEdit
- BooleanbLock
- IntegerhoDataSource
- IntegerhoNavigator
- IntegerhoCol
- IntegeriRow
- IntegeriCol
- CommitFocusField()
Sent to commit the value in an edit control without
needing to close the edit
- IntegerhoCol
- BooleanbEdit
- IntegeriCurrentEdit
- SetSelectedRow(Integer iIndex Boolean bSet)
sets the selected row in report control. note this is all COM
and the selected rows do not interact with the datasource
- IntegerhoRows
- IntegerhoRow
- VariantvRow
- VariantvRows
- SetSelectedRowsAll(Boolean bSet)
clear or set all rows selection
- IntegeriCount
- IntegeriSels
- IntegeriSel
- IntegerhoDataSource
- SetIndexesForSelectedRows(Integer[] SelectedRowIndexes)
Get array of selected rows. This is not to be confused with
with the Grid's SelectedRow. These are rows that are selected
- IntegeriCount
- IntegeriSels
- IntegeriSel
- IntegerhoDataSource
- Integer[]GetIndexesForSelectedRows()
Get array of selected rows. This is not to be confused with
with the Grid's SelectedRow. These are rows that are selected
- IntegeriCount
- Integeri
- Integer[]iIndexes
- IntegerhoRows
- IntegerhoRow
- VariantvRow
- VariantvRows
- IntegerGetSelectedRowsCount()
Get number of selected rows. Normally not needed as GetIndexesForSelectedRows
has the same info.
- IntegeriCount
- IntegerhoRows
- VariantvRows
- IntegerGetFocusedRowIndex()
// Sets focused row but does not adjust datasource. Use with care!
Procedure SetFocusedRow Integer iIndex
Variant vRow vrows
Handle horows
Get phoReportRows to horows
Get ComRows to vrows
Set pvComObject of horows to vRows
Get ComRow of horows iIndex to vRow
// setting focused row changes the displayed row and sets selection
Set ComFocusedRow to vRow // set focused row
End_Procedure
get index of focused row. Use carefully. You should use SelectedRow
- IntegeriIndex
- IntegerhoRow
- VariantvRow
- IntegerGetFocusedColumnIndex()
get index of focused column. Use carefully. You should use SelectedColumn.
This returns the object item order not display order
- IntegeriIndex
- IntegerhoCol
- VariantvCol
- ToggleEdit()
ToggleEdit
If we are editing a cell then Enter acts just like pressing Tab. If we are not editing then
Enter will put the cell into Edit mode.
- IntegerhoDataSource
- IntegeriRow
- IntegeriCol
- BooleanbEditMode
- Next()
Next
- IntegeriSelRow
- IntegeriRowCount
- IntegeriNewSelRow
- IntegerhoCol
- IntegerhoNewCol
- IntegerhoNextCol
- IntegerhoDataSource
- BooleanbWrap
- BooleanbCancel
- BooleanbEdit
- BooleanbValidate
- BooleanbInFocusChanging
- BooleanbOk
- BooleanbInEdit
- BooleanbChanged
- BooleanbReadOnly
- BooleanbAutoSaveOnRowChange
- BooleanbAllowInsert
- BooleanbAllowAppend
- BooleanbAutoAppend
- BooleanbNew
- BooleanbAttemptSaveAndAppend
- Previous()
- IntegeriRow
- IntegeriSelRow
- IntegeriNewSelRow
- IntegerhoCol
- IntegerhoNewCol
- IntegerhoNextCol
- IntegerhoDataSource
- IntegerhoExitTo
- BooleanbWrap
- BooleanbCancel
- BooleanbEdit
- BooleanbInFocusChanging
- BooleanbOk
- BooleanbInEdit
- MoveDownRow()
used by down arrow key. Does a row down with the option of
creating a new row at the bottom.
- IntegerhoDataSource
- IntegeriSel
- IntegeriRows
- IntegeriCol
- BooleanbNew
- BooleanbAllowAppend
- BooleanbCancel
- BooleanbReadOnly
- BooleanbCancelCol
- BooleanbEdit
- BooleanbInEdit
- BooleanbDirty
- MoveUpRow()
used by up arrow key. Does a row up
- IntegerhoDataSource
- IntegeriSel
- IntegeriRows
- IntegeriCol
- BooleanbNew
- BooleanbAllowAppend
- BooleanbCancel
- BooleanbReadOnly
- BooleanbCancelCol
- BooleanbEdit
- BooleanbInEdit
- MovePageDown()
- IntegerhoNav
- BooleanbInEdit
- MovePageUp()
- IntegerhoNav
- BooleanbInEdit
- HandleValidateRow(Boolean bTakeFocus)
Validates the selected row (which is done by the datasource). Returns column object
of the object that failed validation. If 0, no errors. If bTakeFocus is true it will
give focus to the offending column.
- IntegerhoCol
- IntegerhoDataSource
- BooleanbCancel
- IntegerOffSetFromTop()
returns number of rows the selectedRow is from the TopRow. If SelRow is
above, the top, it returns 0.
- IntegeriSel
- IntegeriOffset
- IntegeriTop
- IntegerhoDataSource
- SynchronizeGridtoSelectedRow(Integer iRowOffsetPreference)
synchronize the grid to the selected row passing a rowOffset preference
no rowchanging events are triggered by this. The offset preference can
be a row offset or ropTop, ropCenter, ropBotton
- IntegeriRow
- IntegeriIndex
- IntegeriRows
- IntegerhoDataSource
- BooleanbCancel
- BooleanbNoFocusChangeCheck
- SynchronizeGridtoSelectedColumn()
synchronize the grid to the selected column
no row/column changing events are triggered by this
currently this is private because I cannot think of any reason this
would be used.
- IntegerhoCol
- BooleanbCancel
- BooleanbNoFocusChangeCheck
- BooleanCanDeleteRow()
returns true if you are allowed to delete the row
- IntegerhoDataSource
- BooleanbCanDelete
- BooleanbAllowDelete
- BooleanbReadOnly
- IntegeriSel
- BooleanCanAddRow()
returns true if you are allowed to insert a row
- IntegerhoDataSource
- BooleanbReadOnly
- BooleanbCanInsert
- BooleanCanEditColumn(Integer iCol)
This is called by OnComRequestEdit which means that this is already
editable. This is used as one last chance to stop the edit. Most often
this will be applied to the entire row. We will disable edits if pbReadOnly is True.
When pbReadOnly is true and pbAllowEdit is true (default) edit requests will come
here and we want to disable them. If for some odd reason you wanted to be able to
edit you could augment this message
- BooleanbReadOnly
- BooleanCanSaveRow()
returns true if you are allowed to save the row
- IntegerhoDataSource
- BooleanbReadOnly
- BooleanbCanSave
- IntegeriSel
- BooleanRemoveNewSelectedRow()
removes a new selected row and selects the next row
performs a dataloss verify if needed.
Returns True If canceled
- BooleanbChanged
- BooleanbNewRow
- BooleanbCancel
- IntegeriSel
- IntegerhoDataSource
- BooleanRestoreSelectedRow()
restores the selected row back to its pre-edited state
performs a dataloss verify if needed
returns True if canceled
- IntegeriSel
- IntegerhoDataSource
- BooleanbChanged
- BooleanbCancel
- BooleanAddRow(Integer iNewRow)
inserts or appends a new empty row at iNewRow
Pass row number to insert before. If at end, it will append
Existing row is restored or saved as needed with verifications
Returns True if this was cancelled (eitehr not allowed or a verification cancel)
- IntegerhoDataSource
- BooleanbCancel
- BooleanbAllowed
- BooleanbAutoSave
- BooleanbShouldSave
- BooleanbNew
- IntegeriSel
- BooleanDeleteSelectedRow()
deletes the selected row from datasource with verify
returns true if cancelled (either not allowed or cancelled)
- IntegerhoDataSource
- BooleanbCanDelete
- BooleanbCancel
- BooleanbErr
- IntegeriSel
- BooleanSaveSelectedRow()
Save the selected row with verify
returns True if cancelled (either not allowed or cancelled)
- IntegeriSel
- BooleanbChanged
- BooleanbCancel
- BooleanbSave
- IntegerhoDataSource
- IntegerhoCol
- BooleanCommitSelectedRow()
this does a commit of the selected row without changing the
actual row. Can be used to save or clear a row without changing the row. If the
row is new and not changed we will remove it. This is normally used in exiting.
- IntegerhoDataSource
- IntegeriRow
- BooleanbCancel
- BooleanbChanged
- BooleanbNew
- BooleanRowChanging(Integer iOld Integer iNew)
- BooleanbCancel
- BooleanbValidate
- BooleanbChanged
- BooleanbAutoSaveOnrowChange
- BooleanbNew
- BooleanbReadOnly
- IntegerhoCol
- IntegerhoDataSource
- IntegerVerify_Save()
called to verify a save. Return non zero to cancel
- IntegerVerify_Data_Loss()
called to verify a dataloss from a clear or restore. Return non zero to cancel
- IntegerVerify_Delete()
called to verify a delete. Return non zero to cancel
- Request_ClearRow()
Request a "clear row"
This is the table row clearing handler. If:
A. New row / Unchanged: Delete empty row
B. old row / unchanged: ignore
C. New row / changed: verify_loss and clear changes, goto 1st enterable column
D. old row / changed: verify_loss and clear changes, goto 1st enterable column
- BooleanbChanged
- BooleanbNewRow
- BooleanbCancel
- IntegeriSel
- IntegeriCount
- IntegerhoDataSource
- BooleanbInFocusChanging
- Request_InsertRow()
requests an insert row
- BooleanbChanged
- BooleanbNewRow
- BooleanbCancel
- BooleanbAppend
- IntegeriSel
- IntegeriCol
- IntegerhoDataSource
- BooleanbInFocusChanging
- BooleanbAllowInsert
- BooleanbInEdit
- Request_AppendRow()
requests an append row
- BooleanbChanged
- BooleanbCancel
- BooleanbAllowAppend
- BooleanbInFocusChanging
- BooleanbInEdit
- IntegeriSel
- IntegeriCol
- IntegeriRowCount
- IntegerhoDataSource
- Request_Clear()
standard request_clear (which is sent to all DEOs).
Does a Request_ClearRow
- Request_Delete()
request a delete row
delete row and back end record.
If the record is new, treat this as a remove row request
- BooleanbCancel
- BooleanbInFocusChanging
- BooleanbIsNew
- BooleanbInEdit
- IntegerhoDataSource
- Request_Save()
request a save
- BooleanbCancel
- BooleanbInFocusChanging
- BooleanbInEdit
- Prompt()
Does a prompt for selected column. Needed by the rest of the system
- IntegerhoCol
- HandlePrompt_Object()
returns prompt object for selected column. Needed by the rest of the system
- IntegerhoCol
- IntegerhoPrompt
- Prompt_Callback(Handle hoPrompt)
- IntegerhoCol
- Zoom()
Does a Zoom for selected column. Needed by the rest of the system
- IntegerhoCol
- HandleZoom_Object()
returns Zoom object for selected column. Needed by the rest of the system
- IntegerhoCol
- IntegerhoZoom
- Set(Integer iHeight Integer iWidth)
augmented to remove the custom edit before a resize.
- Set(Integer iRowPos Integer iColPos)
augmented to remove the custom edit before a relocate.
- HandleCreatePropExchangeObject()
create and return a PropExchange COM object
- IntegerhoPropExchange
- IntegerhoGlobal
- VariantvPropExchange
- VariantvGlobal
- ExchangeLayout(Handle hoExchange String sSection)
does a property exchange. Pass COM exchange objetc and section name
- VariantvSection
- IntegerhoExchangePref
- IntegeriBuild
- IntegeriIDBuild
- IntegeriColumns
- IntegeriLastColumns
- BooleanbLoad
- BooleanLoadGridLayoutFromRegistry(String sKey)
loads grid info from the registry.
It provides a good model for how to do this kind of thing.
- IntegerhoExchange
- BooleanbOk
- StringsSection
- StringsFullKey
- IntegeriSort
- SaveGridLayoutToRegistry(String sKey)
save grid info to the registry.
It provides a good model for how to do this kind of thing.
- IntegerhoExchange
- IntegerhoRegistry
- BooleanbOk
- BooleanbExists
- BooleanbVoid
- StringsSection
- StringsFullKey
- StringsShortKey
- DestroyColumnObjects()
Destroys all column objects. You'd only use this if you are dynamically creating columns. There is no need to send
this during a normal grid destroy. There is no option to destroy individual columns - just destroy them all and start over.
This also resets the datasource. The datasource is not valid when the column objects are destroyed.
- Integer[]hoColumnObjects
- IntegerhoDataSource
- IntegerhoReportColumns
- IntegeriCols
- Integeri
- HeaderReorder(Integer iCol)
request a grid reorder based on bestorder for this header column.
- IntegerhoCol
- IntegeriOldCol
- BooleanbHeaderTogglesDirection
- BooleanbHeaderReorders
- BooleanbReverse
- SortGridByColumn(Handle hoCol Boolean bDescending)
request a grid datasource for passed column object and ascending/descending flag.
Should mainly be used with a datasource that is fully loaded and static.
If your datasource is cached and not fully loaded it will sort what is there which is
almost never what you.
- IntegerhoDataSource
- IntegerhoSelCol
- IntegeriCol
- IntegeriSelRow
- IntegeriOffset
- tGridSortRulesSortRules
- BooleanbCancel
- Set(Integer iValue)
- IntegerhoSortOrer
- IntegerhoCol
- IntegeriCount
- IntegeriCol
- VariantvCol
- BooleanbAsc
- IntegerpiSortColumn()
- IntegeriCol
- Set(Boolean bAsc)
- IntegerhoCol
- IntegeriCol
- BooleanpbReverseOrdering()
- BooleanbReverse
- RequestFindColumnValue(Integer iColumn String sValue Boolean bFindGE Integer iStartRow)
Search the value for this column in the datasource and move to that row.
This is meant to be used when all data is loaded. bFindGE determines if this is a EQ (false)
or GE (True) find. iStartRow determines the row to start the search at.
If a GE search and no match move to end of datasource (it makes the most sense)
- IntegeriRow
- IntegeriRows
- IntegerhoDataSource
- BooleanbReverse
- HandleItemToColumnObject(Integer iItem)
required DD/DEO interface
- IntegerhoCol
- IntegerCurrent_Item()
required Item interface
These are special item/value things that get sent to the focus
object to get or set the current focused control).
required Item interface
- IntegeriItem
- Integeritem_count()
required Item interface
- IntegeriItems
- Set(Integer iItem String sVal)
required Item interface
- IntegerhoCol
- StringValue(Integer iItem)
required Item interface
- StringsVal
- IntegerhoCol
- Set(Integer iItem Integer bChanged)
required Item interface
does nothing with this value
- IntegerItem_Changed_State(Integer iItem)
required Item interface
always returns values
- ResetEditMode(Boolean bWasEdit)
- BooleanbEdit
- FreezeColumn(Handle hoCol)
- IntegeriFreeze
- IntegeriCol
- IntegeriCol0
- BooleanbVisible
- IntegerhoCol0
- Request_Status_Help(Boolean bShow)
request status help. First check if their is a column help string
if not, see if the grid has a help string.
- StringsHelp
- IntegerhoStatusbar
- IntegerhoCol
- IntegerActivate()
augmented to set a flag which tells the idle handler to go into edit mode at the end
of its processes. This is needed so that the grid edit control takes the focus when it is first
activated and when switching between views.
- BooleanbHasFocus
- IntegeriFail
- Switch()
make sure the edit control is closed before the change
- Switch_Back()
make sure the edit control is closed before the change
- RequestColumnSearch(Handle hoCol Integer iKeyCode Integer iKeyShift)
do a popup search request for the passed column. The keys can provide a
seed value - they come from OnComKeyDown
- IntegerhoSearchDialog
- IntegeriCol
- BooleanbOk
- StringsValue
- Request_Search(Integer iKeyCode Integer iKeyShift)
do a popup search request for the sort column. The keys can provide a
seed value - they come from OnComKeyDown
- IntegeriCol
- IntegerhoCol
- ReInitializeData(Variant[] DataSource Boolean bKeepSelections)
reinitialize the static data in your grid. This is meant to be used where
you have taken the datasource and made a batch change like setting all checkboxes
in a column. The restores the current row, column and selections. This works best
if you keep the same number of rows. If you add or delete rows below the selected row
it will work ok. If you insert rows or delete records above the selected rows you
don't want to use this - Use InitializeData
- IntegerhoDataSource
- Integer[]SelectedRowIndexes
- IntegeriRow
- IntegeriCol
- IntegeriTop
- IntegeriOldSize
- IntegeriNewSize
- IntegeriSels
- IntegeriSel
- IntegeriNewSel
- BooleanbInitEnable
- BooleanbInEdit