CBCGPGridItem

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
	AddOption	Adds a new option to an item.
	AdjustInPlaceEditRect	Sets bounding rectangles of in-place editor and spin control.
	ChangeType	Called by the framework when a grid control needs to change type of a grid item.
	ClearContent	Called by the framework when a grid control is requested to clear content of a grid item.
	CreateInPlaceEdit	Called to create in-place edit control.
	EmptyValue	Makes a grid item empty.
	EnableMarkup	Specifies whether the markup is enabled for this grid item.
	ExportText	Called by the framework when the grid control is exported to the text.
	ExportToHTML	Called by the framework when the grid control is exported to HTML.
	FindOption	Searches for the option by name.
	FindOptionByData	Searches for the option by data.
	FormatItem	Called by the framework to format the item.
	GetAlign	Returns item alignment.
	GetBackgroundColor	Returns background color of the grid item.
	GetButtonRect	Return a grid cell button bounds in the client coordinates. If cell don't have button, the return is empty
	GetGridItemID	Returns a grid item identifier.
	GetHorzAlign	Returns grid item horizontal alignment.
	GetImage	Returns the index of the grid item image.
	GetLabel	Returns item label.
	GetLinkName	Obtains the grid item link name.
	GetLinksCount	Returns the number of the grid item links.
	GetLinkURL	Obtains the grid item link URL.
	GetMergedCells	Returns information about merged cells.
	GetMergedMainItem	Returns a pointer to main item.
	GetMergedRange	Retrieves the range of merged items.
	GetMergedRect	Returns a bounding rectangle around merged items.
	GetOption	Returns an option located at the specified index.
	GetOptionCount	Returns the number of options that belong to an item.
	GetOptionData	Returns a user-defined data associated with option located at the specified index.
	GetParentRow	Returns a pointer to the parent row.
	GetRect	Return a grid cell bounds in the client coordinates.
	GetSelectedImage	Returns the index of the selected grid item image.
	GetSelectedOption	Returns the selected option zero-based index or -1 if no option is selected.
	GetTextColor	Returns custom text color of grid item.
	GetValue	Returns the item value.
	GetVertAlign	Returns grid item vertical alignment.
	IsEmpty	Tells whether a grid item is empty.
	IsHotTrackEnabled	Tells whether Grid Cell mouse tracking is enabled.
	IsMarkupEnabled	Tells whether the markup is enabled for this grid item.
	IsMultiline	Tells whether a grid item displays multiline text.
	IsReadOnly	whether grid cell is a read only.
	Merge	Merge this item with other items in the specified range.
	OnBeginInplaceEdit	Called by the framework before creation of in-place edit.
	OnClickButton	Called by the framework when the user clicks the button associated with the item.
	OnClickCommandIcon	Called by the framework when the user clicks the command icon.
	OnClickLink	Called by the framework when a grid item link has been clicked.
	OnDblClick	Called by the framework when the user double clicks the item.
	OnDrawBorders	Called to draw borders around a grid item.
	OnDrawButton	Called by the framework when it needs to draw the item's button.
	OnDrawValue	Called by the framework when it needs to draw the item's value.
	OnEdit	Called by the framework when the item's value should be edited.
	OnEndEdit	Called by the framework when the item's value has been edited.
	OnEndInplaceEdit	Called by the framework after in-place edit is closed
	OnFillBackground	Called to fill background of grid item.
	OnMouseLeave	Called by the framewok when mouse cursor leaves the Grid Cell bounds.
	OnMouseMove	Called by the framewok when mouse cursor is moved inside the Grid Cell bounds.
	ReadFromArchive	Reads a grid item data from archive.
	Redraw	Redraws the grid cell.
	RemoveAllOptions	Removes all options from an item.
	Serialize	Serialized a grid item data to/from archive.
	SetBackgroundColor	Sets custom background color to the grid item.
	SetComboFont	Sets font of in-place combobox.
	SetDataBar	Adds a data bar to the grid item.
	SetDataColorScale	Adds a color scale to the grid item.
	SetDataIcon	Adds an icon (from the icon set) to the grid item.
	SetHorzAlign	Specifies grid item horizontal alignment.
	SetImage	Assigns an image to the grid item.
	SetInPlaceEditFont	Called by the framework to set the font of the in-place editor of the grid item.
	SetModifiedFlag	Sets "modified" flag to the item.
	SetNotificationBadge	Sets grid item notification badge.
	SetReadOnly	Specifies whether grid cell is a read only.
	SetSelectedImage	Assigns an image to the selected grid item.
	SetTextColor	Sets new custom text color to grid item.
	SetValue	Sets the new grid item value.
	SetVertAlign	Specifies grid item vertical alignment.
	WriteToArchive	Writes a grid item data to archive.

Protected Member Functions
	GetCommandIcons	Called by the framework to obtain a cell commands.
	IsOptionPrefix	Override this method if you wish to customize drop-down item selection by keyboard.
	IsTextOverflowingAllowed	Tells whether a text overflowing allowed for the specific grid cell.
	NewInPlaceEdit	Called by the Grid to create a new in-place edit control.
	OnAddComboBoxItem	Called by the Grid to add a combo box item.