BCGSuite for MFC

Detailed Description

The CBCGPGridItem class implements the functionality of a base value inserted in the grid control. The value is stored as a VARIANT value and is shown according to the VARIANT type.

Custom items that can't be interpreted and/or edited as a standard VARIANT type should be implemented in a derived class with overridden methods like OnDrawValue() and FormatItem().

See also
CBCGPGridCtrl
+ Inheritance diagram for CBCGPGridItem:

Public Member Functions

 AddOptionAdds a new option to an item.
 
 AdjustInPlaceEditRectSets bounding rectangles of in-place editor and spin control.
 
 ChangeTypeCalled by the framework when a grid control needs to change type of a grid item.
 
 ClearContentCalled by the framework when a grid control is requested to clear content of a grid item.
 
 CreateInPlaceEditCalled to create in-place edit control.
 
 EmptyValueMakes a grid item empty.
 
 EnableMarkupSpecifies whether the markup is enabled for this grid item.
 
 ExportTextCalled by the framework when the grid control is exported to the text.
 
 ExportToHTMLCalled by the framework when the grid control is exported to HTML.
 
 FindOptionSearches for the option by name.
 
 FindOptionByDataSearches for the option by data.
 
 FormatItemCalled by the framework to format the item.
 
 GetAlignReturns item alignment.
 
 GetBackgroundColorReturns background color of the grid item.
 
 GetButtonRectReturn a grid cell button bounds in the client coordinates. If cell don't have button, the return is empty
 
 GetGridItemIDReturns a grid item identifier.
 
 GetHorzAlignReturns grid item horizontal alignment.
 
 GetImageReturns the index of the grid item image.
 
 GetLabelReturns item label.
 
 GetLinkNameObtains the grid item link name.
 
 GetLinksCountReturns the number of the grid item links.
 
 GetLinkURLObtains the grid item link URL.
 
 GetMergedCellsReturns information about merged cells.
 
 GetMergedMainItemReturns a pointer to main item.
 
 GetMergedRangeRetrieves the range of merged items.
 
 GetMergedRectReturns a bounding rectangle around merged items.
 
 GetOptionReturns an option located at the specified index.
 
 GetOptionCountReturns the number of options that belong to an item.
 
 GetOptionDataReturns a user-defined data associated with option located at the specified index.
 
 GetParentRowReturns a pointer to the parent row.
 
 GetRectReturn a grid cell bounds in the client coordinates.
 
 GetSelectedImageReturns the index of the selected grid item image.
 
 GetSelectedOptionReturns the selected option zero-based index or -1 if no option is selected.
 
 GetTextColorReturns custom text color of grid item.
 
 GetValueReturns the item value.
 
 GetVertAlignReturns grid item vertical alignment.
 
 IsEmptyTells whether a grid item is empty.
 
 IsHotTrackEnabledTells whether Grid Cell mouse tracking is enabled.
 
 IsMarkupEnabledTells whether the markup is enabled for this grid item.
 
 IsMultilineTells whether a grid item displays multiline text.
 
 IsReadOnlywhether grid cell is a read only.
 
 MergeMerge this item with other items in the specified range.
 
 OnBeginInplaceEditCalled by the framework before creation of in-place edit.
 
 OnClickButtonCalled by the framework when the user clicks the button associated with the item.
 
 OnClickCommandIconCalled by the framework when the user clicks the command icon.
 
 OnClickLinkCalled by the framework when a grid item link has been clicked.
 
 OnDblClickCalled by the framework when the user double clicks the item.
 
 OnDrawBordersCalled to draw borders around a grid item.
 
 OnDrawButtonCalled by the framework when it needs to draw the item's button.
 
 OnDrawValueCalled by the framework when it needs to draw the item's value.
 
 OnEditCalled by the framework when the item's value should be edited.
 
 OnEndEditCalled by the framework when the item's value has been edited.
 
 OnEndInplaceEditCalled by the framework after in-place edit is closed
 
 OnFillBackgroundCalled to fill background of grid item.
 
 OnMouseLeaveCalled by the framewok when mouse cursor leaves the Grid Cell bounds.
 
 OnMouseMoveCalled by the framewok when mouse cursor is moved inside the Grid Cell bounds.
 
 ReadFromArchiveReads a grid item data from archive.
 
 RedrawRedraws the grid cell.
 
 RemoveAllOptionsRemoves all options from an item.
 
 SerializeSerialized a grid item data to/from archive.
 
 SetBackgroundColorSets custom background color to the grid item.
 
 SetComboFontSets font of in-place combobox.
 
 SetDataBarAdds a data bar to the grid item.
 
 SetDataColorScaleAdds a color scale to the grid item.
 
 SetDataIconAdds an icon (from the icon set) to the grid item.
 
 SetHorzAlignSpecifies grid item horizontal alignment.
 
 SetImageAssigns an image to the grid item.
 
 SetInPlaceEditFontCalled by the framework to set the font of the in-place editor of the grid item.
 
 SetModifiedFlagSets "modified" flag to the item.
 
 SetNotificationBadgeSets grid item notification badge.
 
 SetReadOnlySpecifies whether grid cell is a read only.
 
 SetSelectedImageAssigns an image to the selected grid item.
 
 SetTextColorSets new custom text color to grid item.
 
 SetValueSets the new grid item value.
 
 SetVertAlignSpecifies grid item vertical alignment.
 
 WriteToArchiveWrites a grid item data to archive.
 

Protected Member Functions

 GetCommandIconsCalled by the framework to obtain a cell commands.
 
 IsOptionPrefixOverride this method if you wish to customize drop-down item selection by keyboard.
 
 IsTextOverflowingAllowedTells whether a text overflowing allowed for the specific grid cell.
 
 NewInPlaceEditCalled by the Grid to create a new in-place edit control.
 
 OnAddComboBoxItemCalled by the Grid to add a combo box item.