Detailed Description

The CBCGPReportCtrl class extends the functionality of the grid control and provides you with the easy way to create reports in Microsoft Outlook style. The report control uses custom row and item objects to achieve this goal.

You can use CBCGPReportView class to simplify integration of the report control with MFC's Document/View architecture.

See also: CBCGPGridCtrl, CBCGPReportRow

Inheritance diagram for CBCGPReportCtrl:

Public Member Functions

CreateRow Creates a new row.

Public Member Functions inherited from CBCGPGridCtrl

CBCGPGridCtrl The constructor.

AddItemFromArchive Adds a grid item from archive at the specified location.

AddRow Adds a new row to the grid control.

AdjustLayout Adjusts layout of the grid items.

AllowRowExtraHeight Enables preview pane.

CalcPages Calculates the number of pages to print.

CanClearRange Tells whether all items in the specified range can be cleared.

CanDropColumn Tells whether a column can be dropped at specified positions.

CanDropColumnToColumnChooser Tells whether a column can be dropped on the Column Chooser.

CanHideColumn Called by the framework to determine whether it should hide a column during drag-and-drop operations.

CanReplaceItem Determines whether an item can be replaced with another item of specified type.

CanShowColumnInColumnChooser

Tells whether a column can be displayed on the Column Chooser.

Parameters

nColumn Specifies the zero-based index of column.

Returns: TRUE if we can show column in column chooser, FALSE if not.

Clear Clears items within selected ranges.

ClearRange Clears items in range,

CloseFindReplaceDlg Closes the Find/Replace dialog box.

Copy Copies selected items to the Clipboard.

CopyCSV Copies grid items to the Clipboard in CSV (comma-separated values) format.

CopyHTML Copies grid items to the Clipboard in HTML format.

CreateItem Called by the framework to create a new item at the specified position.

CreateItemFromArchive Creates a grid item from archive.

CreateMultiLineRow Creates a multi-line row with specified text lines numbers

CreateRowFromArchive Creates a grid row from archive.

CreateSerializeManager Creates a serialization manager.

Cut Cuts selected items and places them to the Clipboard.

DeleteAllColumns Removes all columns from the grid control.

DeleteColumn Deletes a column from the grid control.

DestroyRow Called by the framework when a grid row is being destroyed.

EditItem called by the framework when the user begins to edit an item.

EnableAlternateRows Specifies whether alternate coloring for Even and Odd rows shoud be used.

EnableAutoHideScrollBars Scpecifies whether control's scroll bars should be hidden when scroll bars are inactive (mouse cursor is located outside of scrollbar).

EnableCheckBoxes Turns on or off grid rows check box (located on the row left side).

EnableColumnAutoSize Enables or disables column auto-sizing feature of the grid control

EnableColumnFilterEdit Shows or hides the filter edit control for a column.

EnableColumnWidthAutoSizeOnHeaderDblClick Specifies whether double-clicking column header divider will resize the column to fit the column content.

EnableCustomToolTips Enables or disables custom tooltips.

EnableDragHeaderItems Enables or disables the ability to drag header items.

EnableDragSelection Enables or disables Drag Selection mode.

EnableDragSelectionBorder Enables or disables Drag Selection Border mode.

EnableExpandOnDblClick Specifies whether the grid row should be expanded or collapsed when the user double-click it.

EnableFilter Enables filtering.

EnableFilterBar Enables or disables "filter bar" mode.

EnableGridLines Turns on or off grid lines.

EnableGroupByBox Enables or disables visual grouping of columns.

EnableHeader Shows or hides the header.

EnableHeaderSelectAllMarker Shows or hides "Select All" grid marker.

EnableInvertSelOnCtrl Defines grid's behavior on single click with CTRL key pressed.

EnableLineNumbers Turns on or off line numbering.

EnableMarkSortedColumn Enables the option to mark a selected column by a different background color.

EnableMultipleSort Enables or disables the multiple sort mode.

EnableRowHeader Shows or hides vertical header at left.

EnableSearchAndExpandCollapsedGroups Specifies whether a search should be performed in the hidden (located in collapsed groups) rows.

EnableTextOverflowing Specifies whether a text overflowing is enabled.

EnableTreeButtons Turns on or off grid tree expand/collapse buttons.

EnableTreeLines Turns on or off grid tree lines.

EnableVirtualMode Enables virtual mode.

EnableZoom Enables/disables Grid zooming by the mouse wheel (when Ctrl is pressed) or gesture zoom.

EndEditItem Called by the framework when the user has finished to edit a grid item

EnsureVisible Scrolls the grid control to make the specified item visible.

ExpandAll Expands or collapse all grid items containing any sub-items.

ExpandRow Expands/collapses Grid row.

ExportRangeToText Exports the specified range to text.

ExportToHTML Exports grid data to HTML format.

Find Called by the framework to initiate the find operation.

FindRowByData Finds a row by user-defined data.

FreezeColumns Freezes one or more columns.

FreezeGroups Allows to disable horizontal scrolling of groups in the grid control.

FreezeRows Freezes one or more rows.

GetBkColor Returns background color.

GetBoldFont Returns a bold font object.

GetCallbackFunc Returns a pointer to callback function used in virtual mode.

GetChangeSelectionTransitionTime Returns a time of the selection changing transition..

GetColorTheme Returns the current color theme.

GetColumnAlign Retrieves text justification flag of the specified column in a grid control.

GetColumnCount Returns the number of columns in the grid control.

GetColumnLocked Tells whether the column's width is locked, or not

GetColumnName Retrieves the name of the specified column in a grid control.

GetColumnOrderArray Retrieves the order of columns.

GetColumnsInfo Retrieves detailed information about the columns of the grid control.

GetColumnVisible Tells whether a column is visible, or not.

GetColumnWidth Retrieves the width of the specified column in a grid control.

GetCurSel Returns currently selected row and active item.

GetCurSelItem Returns selected item.

GetCurSelItemID Returns the currently selected item.

GetCustomColors Retrieves custom grid colors.

GetExportTextDelimiter Returns a delimiter for exported text according to specified flags.

GetFilterCallbackFunct Returns a pointer to the current filtering callback function.

GetFocusedFilterBar Returns a zero-based index of the focused filter bar edit box or -1 if filter bar is not focused.

GetFrozenColumns Returns a frozen columns number.

GetFrozenRows Returns a frozen rows number.

GetGridFooterRect Returns bounding rectangle of grid footer.

GetGridHeaderRect Returns bounding rectangle of grid header.

GetHeaderAlign Retrieves text justification flag of the column header item.

GetHeaderBtnImageList Returns an image list that is assigned to header buttons.

GetHeaderFlags Retrieves the current header options.

GetHeaderImageList Retrieves image list associated with the header.

GetHeaderImageSize Retrieves a header image list icon size.

GetHeaderRect Returns bounding rectangle of grid header.

GetImageList Retrieves a pointer to image list used by grid items.

GetImageMargin Returns a space (in pexels) between grid cell icon and left/right border. Override this method if you wish to specify your custom space value.

GetImageSize Retrieves a grid image list icon size.

GetLargeRowHeight Determines the height of a group.

GetListRect Returns the bounding rectangle of the grid list.

GetPreviewTextColor Returns text color for preview pane.

GetPrintDC Returns print DC.

GetPrintParams Returns printing parameters.

GetRow Returns a row at the specified position (index).

GetRowCount Returns the number of rows in the grid.

GetRowHeight Returns the height of a row in the grid control.

GetScale Returns control font scale.

GetScrollBarsStyle Returns the current style of scroll bars.

GetSel Tells whether a specified grid item is selected.

GetSelectedItemCount Returns a number of the currently selected items.

GetSortColumn Returns the index of sorted column.

GetTextColor Returns text color.

GetTextLeftOffset Reserved for future versions.

GetTextMargin Returns a space (in pexels) between grid cell text and left/right border. Override this method if you wish to specify your custom space value.

GetTextVMargin Returns a space (in pexels) between grid cell text and top/bottom border. Override this method if you wish to specify your custom space value.

GetTotalRowCount Returns a number of rows in a grid control.

GetVirtualRow Returns a virtual row at the specified position (index).

HitTest Returns the current position of the cursor related to the CBCGPGridCtrl object.

HitTestSelectionBorder Checks if the specified point is inside selection border.

InsertColumn Inserts the new column into a grid control at the specified index.

InsertGroupColumn Inserts a column into list of columns the grid items are grouped by.

InsertRowAfter Inserts a row after specified position.

InsertRowBefore Inserts a row before specified position.

IsAllSelected Tells whether all grid items are selected, or not.

IsAlternateRowsEnabled Tells whether alternate coloring for Even and Odd rows is used.

IsCheckBoxesEnabled Tells whether grid rows check box is enabled.

IsClearEnabled Tells whether clear operation is enabled for a grid control.

IsColumnAutoSizeEnabled Tells whether the column auto-size feature is enabled or disabled.

IsColumnsChooserVisible Tells whether the column chooser is visible or not.

IsColumnSelected Tells whether a column is selected, or not.

IsColumnWidthAutoSizeOnHeaderDblClickEnabled Tells whether double-clicking column header divider will resize the column to fit the column content.

IsControlBarColors Tells whether the grid control uses colors of the parent control bar, or not.

IsCopyEnabled Tells whether copy operation is enabled for a grid control.

IsCustomToolTipEnabled Tells whether the grid custom tooltips are enabled, or not.

IsCutEnabled Tells whether cut operation is enabled for a grid control.

IsDisabledTextColor Tells whether disabled grid has a special (grayed) text color.

IsDisableWholeSelHeaderHighlighting Tells whether header items are highlighted when all items in row are selected.

IsDragHeaderItemsEnabled Tells whether the dragging of headers items is enabled or disabled.

IsDragSelectionBorderEnabled Tells whether "Drag Selection Border" mode is enabled, or not.

IsDragSelectionEnabled Tells whether drag selection is enabled, or disabled.

IsDrawCellsWithCustomColorsOnSelection Tells whether selected grid item(s) will be drawn using grid item foreground/background colors.

IsEnabledSearchAndExpandCollapsedGroups Tells whether a search should be performed in the hidden (located in collapsed groups) rows.

IsExpandOnDblClickEnabled Tells whether the grid row should be expanded or collapsed when the user double-click it.

IsFilterBarEnabled Tells whether the "filter bar" mode is activated or not.

IsFilterEnabled Tells whether the filtering is enabled.

IsFocused Tells whether the grid control has the focus, or not.

IsGridItemBordersEnabled Tells whether grid items borders are enabled or not.

IsGridLinesEnabled Tells whether grid lines are enabled or not.

IsGroupByBox Determines whether the visual grouping is enabled or not

IsGrouping Tells whether the auto-grouping is enabled, or not.

IsHeaderEnabled Tells whether the header is displayed or not.

IsHeaderSelectAllMarkerEnabled Tells whether "Select All" grid marker is displayed or not.

IsInvertSelOnCtrlEnabled Tells whether invert selection with Ctrl key mode is enabled, or not.

IsItemSelected Tells whether specified item is inside of one of selected ranges.

IsLineNumbersEnabled Tells whether grid line numbers are enabled or not.

IsMarkSortedColumn Tells whether the grid marks sorted column.

IsMultipleSort Tells whether the grid control is in multiple sort mode.

IsPasteEnabled Tells whether paste operation is enabled for a grid control.

IsReadOnly Tells whether the grid control is read-only.

IsRowExtraHeightAllowed Tells whether grid rows have some extra height to accommodate preview panes.

IsRowHeaderEnabled Tells whether the row header (on the left) is displayed or not.

IsRowMarker Tells whether row marker is enabled, or not.

IsRowSelected Tells whether the grid control has at least one selected item in the specified row, or not.

IsScrollBarAutoHideEnabled Tells whether control's scroll bars are auto-hidden.

IsSelectionBorder Tells whether to draw selection border around selected items, or not.

IsShowDragContext Tells whether the grid control shows context while dragging splitters, or not.

IsShowInPlaceToolTip Tells whether the grid uses custom tooltips, or standard tooltips.

IsSingleSel Tells whether the grid control uses single selection, or multiple selection.

IsSortingMode Tells whether the grid control is sorted, or not.

IsTextColumn Tells whether the specified column has the "text column" flag.

IsTextOverflowing Tells whether a text overflowing is enabled.

IsTreeButtonsEnabled Tells whether grid tree expand/collapse buttons are enabled or not.

IsTreeLinesEnabled Tells whether grid tree lines are enabled or not.

IsVirtualMode Tells whether the virtual mode is enabled or not.

IsVisualManagerStyle Tells whether a grid control uses visual manager style.

IsWholeRowSel Tells whether the grid control uses selection by rows, or selection by items.

IsWholeRowSelected Checks whether all items in a row are selected.

IsZoomEnabled Tells whether Grid zooming is enabled.

MergeRange Merges cells within the specified range.

MergeSelection Merges cells in the current selection range.

MoveRow Moves a grid row to a new position.

OnAddGridPageRowForPrint Called when a grid control needs to place a row on a page, and extend a row on several pages when necessary.

OnAfterTrackHeader Called by the Grid after header item was resized by the user.

OnBeforeReplaceItem Called by the grid before item replacing.

OnBeginDrag Called by the framework every time a grid is about to start drag-and-drop operation.

OnBeginPrinting Called by the framework when it's about to begin the print or print preview job.

OnBreakColumnAcrossPrintPages Called when the printing logic decides whether to break a column across print pages if it doesn't fit, or start it from a new page.

OnCalcPrintPages Called by the framework to layout the pages and calculates the number of pages to print.

OnChangeSelection Called by the framework when the grid control changes the selection.

OnClickButton Called by the framework when a button contained in a grid item has been clicked.

OnClickItemCommandIcon Called by the framework when a command icon contained in a grid item has been clicked.

OnClickItemLink Called by the framework when a grid item link has been clicked.

OnDrawItem Called by the framework to draw a grid control row.

OnEndPrinting Called by the framework after a document has been printed or previewed.

OnFilterBarChanged Should be called when the data in any filter edit controls is changed.

OnGetPageMargins Returns sizes of page margins.

OnItemChanged Called by the grid control when the grid item has been changed.

OnKeepGroupWithChildrenOnNewPrintPage Called by the framework before printing a grid group.

OnMeasureListRect Calculates dimensions of grid content in logical units.

OnMergeCellsChanged Called when a merged cell has been unmerged, or when a range of cells has been merged.

OnMergeCellsChanging Called when a merged cell is being unmerged, or when a range of cells is being merged.

OnPrepareFindString Called by the framework to prepare a search string.

OnPreparePrintPages Called by the framework to prepare printing.

OnPrepareTextString Called by the grid control when it needs to prepare a text string for export to requested format.

OnPrint Called by the framework to print a certain page.

OnPrintItem Called by the framework to print the certain grid row.

OnPrintPageFooter Called by the framework to print the page footer.

OnPrintPageHeader Called by the framework to print the page header.

OnQueryClearNonEmptyItem Called by a grid control to determine whether a non-empty grid item can be cleared.

OnQueryClearSkipStaticItem Called by the framework for each static (non-editable) grid item when the grid performs the Clear operation for multiple items.

OnQueryReplaceNonEmptyItem Called by a grid control to determine whether a non-empty grid item can be replaced.

OnStartColumnOnNewPrintPage Called when a column is about to be printed on a new page.

OnTextFound Called by the framework when the Grid has found a result during search.

OnTextNotFound Called by the framework when the grid has finished searching without finding any items.

OpenFindReplaceDlg Opens Find/Replace dialog box.

Paste Pastes grid items from the Clipboard.

Print Prints the content of the grid control.

PrintLayout Calculates the layout of the page.

RemoveAll Removes all rows (items) from the grid control.

RemoveGroupColumn Removes the column from the list of grouping columns.

RemoveRow Removes a row at the specified position.

RemoveSortColumn Removes the specified sort column from the list of sorted columns.

ReplaceItemFromArchive Replaces a grid item from archive.

ScrollToRow Vertically scrolls the grid to the specified row.

SelectAll Selects a whole grid.

SelectArea Selects an area specified by bounds.

SelectColumn Selects a column.

SelectFirstLastItemInColumn Moves selection to the top/bottom cell in the current column.

SelectFirstLastItemInRow Moves selection to the first/last cell in the current row.

SelectRow Selects a row.

SetBoldFont Tells the grid control to use bold font.

SetBoolLabels Defines how the text for the items of the boolean type should be displayed

SetChangeSelectionTransitionTime Specifies a time of the selection changing transition.

SetClearInplaceEditOnEnter Specifies behavior of grid control when it starts in-place editing on pressing ENTER key.

SetColorTheme Sets the new color theme

SetColumnAlign Sets alignment of the column text.

SetColumnLocked Locks the width of a column.

SetColumnName Sets the name of the specified column in a grid control.

SetColumnOrderArray Allows to set a specific column order.

SetColumnVisible Hides or shows a column.

SetColumnWidth Sets the width of a column in the grid control.

SetCurSel Selects a row.

SetCustomColors Sets custom grid control colors.

SetCustomLargeRowHeight Specifies a large (group) row height.

SetCustomRowHeight Specifies a row height.

SetDefaultItemRTC Sets runtime class information to create items of custom type.

SetDisabledTextColor Specifies whether disabled grid has a special (grayed) text color.

SetDisableWholeSelHeaderHighlighting Specifies whether header items are highlighted when all items in row are selected.

SetDrawCellsWithCustomColorsOnSelection Specifies whether selected grid item(s) will be drawn using grid item foreground/background colors.

SetEditFirstClick Enables in-place editing of a grid item on first mouse click.

SetFilterBarText Sets filter bar text for the specific grid column.

SetGridFooterHeight Reserves space for grid footer.

SetGridHeaderHeight Reserves space for the grid header.

SetHeaderAlign Sets text justification flag for column header item.

SetHeaderBtnImageList Sets images for header buttons.

SetHeaderImageList Sets the image list associated with the header.

SetImageList Sets image list to be used by grid items.

SetItemRTC Sets runtime class information to create items of custom type in the specified column.

SetListDelimiter Customizes formatting text for grid rows

SetPreviewTextColor Sets text color for preview pane.

SetPrinterFont Sets the font for printing.

SetReadOnly Turns the read-only flag on and off.

SetRowMarker Enables row marker for the grid control.

SetScale Specifies control font scale.

SetScalingRange Specifies control font scaling range.

SetScrollBarsStyle Tells the Grid Control to use either Windows standard, or owner draw scroll bar.

SetSel Changes a specified grid item selection state.

SetSelectionBorder Enables or disables a selection border around grid items.

SetShowDragContext Specifies whether the grid control should show context while dragging splitters.

SetShowInPlaceToolTip Enables or disables in-place tooltips.

SetSingleSel Switches between single and multiple selection modes.

SetSortColumn Set the current sorting column and sort order

SetTextColor Specifis the grid control text color

SetTextColumn Required for "preview" support. Tells that the preview text may begin from this column.

SetVirtualRows Sets the number of rows in virtual mode.

SetVisualManagerColorTheme Sets the visual manager-style color theme

SetWholeRowSel Switches between selection by row and selection by item.

ShowColumnsChooser Displays or hides the column chooser.

ShowHorzScrollBar Shows or hides the horizontal scrollbar.

ShowVertScrollBar Shows or hides the vertical scrollbar.

Sort Sorts the grid control.

SortChildRows Sorting child rows at one level of hierarchy.

SortChildRowsCB Sorting child rows at one level of hierarchy using the callback function.

UnfreezeColumns Disables the "frozen columns" feature.

UnfreezeRows Disables the "frozen rows" feature.

UnMergeRange Unmerges cells within the specified range.

UnMergeSelection Unmerges cells within the current selection.

ValidateItemData Called by the framework to validate an item data.

Public Member Functions inherited from CBCGPAnimationManager

CBCGPAnimationManager Default constructor.

GetAnimatedValue Gets current animated value.

GetAnimationDuration Gets animation duration.

GetLastAnimationError Gets the animation error returned by recent call to Windows Animation API.

IsAnimated Checks if animation is running.

StartAnimation Starts an animation.

StartFlashAnimation Starts "flash" animation.

StopAnimation Stops an animation.

Protected Member Functions
	AllowInPlaceEdit	Tells whether in-place editing is allowed, or not.

Protected Member Functions inherited from CBCGPGridCtrl
	CanBeginInplaceEditOnChar	Specifies how grid control handles keyboard.

	CanEndInplaceEditOnChar	Defines how grid control handles keyboard inside in-place editor.

	CompareGroup	Compares two rows by the given column.

	CompareItems	Compares two items or two rows by the given column.

	CompareItems	Compares two items or two rows by the given column.

	GetGridItem	Obtain a grid item by ID.

	GetItemCustomTooltip	Called by the framework to obtain the cell custom tooltip.

	GetNextItemID	Helper function to navigate to the next item inside the grid.

	GoToNextItem	Called by the framework when it needs to move current selection to next grid item.

	IsAcceleratorKey	Defines how grid control handles keyboard.

	IsEditFirstClick	Tells whether the grid control starts in-place editing on first mouse click or not.

	OnAfterInplaceEditCreated	Called just after the in-place edit has been created.

	OnBeginInplaceEdit	Called by the framework before in-place edit control is created.

	OnColumnsOrderChanged	Called when a grid columns order has been changed.

	OnCreateFilterBarCtrl	Called by the grid control to create a filter edit.

	OnDrawGridFooter	Called by the framework to draw grid footer.

	OnDrawGridHeader	Called by the framework to draw grid header.

	OnDrawHeaderItemBorder	Called by the framework when it needs to draw the border of header item.

	OnDrawSelectionBorder	Called by the framework when it needs to draw the border around the selected items in the grid.

	OnDropToGroupByBox	Called by the framework when a header item (column) is dropped on the "group by" box.

	OnEndInplaceEdit	Called by the framework after in-place edit is closed.

	OnFillHeaderBackground	Called by the framework when it needs to fill background of header item

	OnFillLeftOffset	Called by the framework when it needs to draw the left margin area of the grid control.

	OnFillRowDynamicSubItems	Called by the framework when the grid row with dynamically-created subitems is expanded, and subitems should be created.

	OnFillSelItem	Called by the framework when it needs to fill the background of a selected item.

	OnGetColumnAutoSize	Called by the Grid control to determine automatic size of a particular column.

	OnGetGroupByBoxRect	Called by the framework when it needs to calculate the bounding rectangle of the group-by box.

	OnGetHeaderRect	Called by the framework when it needs to calculate the bounding rectangle of the grid header.

	OnGetPageFooterRect	Called by the framework when it needs to calculate the bounding rectangle of the page footer.

	OnGetPageHeaderRect	Called by the framework when it needs to calculate the bounding rectangle of the page header

	OnGetSelectionRect	Called by the framework when it needs to calculate the border around the selected items.

	OnHeaderCheckBoxClick	Called by the framework when the user clicks the grid column header checkbox.

	OnHeaderColumnClick	Called by the framework when user clicks the grid header.

	OnHeaderDividerDblClick	Called by the framework when the user double-clicked the divider area of the grid column header.

	OnHeaderMenuButtonClick	Called by the framework when user clicks the header menu button.

	OnHideColumnChooser

	OnInplaceEditKeyDown	Specifies how grid control handles WM_KEYDOWN message inside in-place editor.

	OnInplaceEditSetSel	Defines how grid control manages selection of in-place editor content when in-place editor has been created.

	OnItemUpdateFailed	Called when the grid fails to update an item.

	OnPrintHeader	Called by the framework to print the grid header.

	OnRowCheckBoxClick	Called by the framework when the user clicks the grid row checkbox.

	OnRowHeaderClick	Called by the framework when a row header is clicked.

	OnRowHeaderDblClick	Called by the framework when a row header is double clicked.

	OnSelChanged	Called by the framework when the grid control has changed the selection.

	OnSelChanging	Called by the framework when the grid control is changing the selection.

Protected Member Functions inherited from CBCGPAnimationManager
	OnAnimationIdle	Called by the framework in an animation idle time.

Additional Inherited Members
Public Types inherited from CBCGPAnimationManager
enum	BCGPAnimationType

Static Public Member Functions inherited from CBCGPAnimationManager
	IsAnimationSupportedByOS	Checks if animation is supported by OS.

Static Public Attributes inherited from CBCGPGridCtrl
	m_bEnableAssertValidInDebug	Enables or disables ASSERT_VALID macro usage in debug mode.

Protected Attributes inherited from CBCGPGridCtrl
	m_bGridItemBorders	Enables or disables borders for grid items.

	m_nRowsBlockSize	Specifies the memory-allocation granularity for internal containers

Detailed Description

Public Member Functions

Protected Member Functions

Additional Inherited Members