'Declaration
 
Protected Overrides Function GetImageCore( _
   ByVal value As Object, _
   ByVal formatInfo As CellImageFormatInfo, _
   ByVal gridElement As GridElement _
) As Image

'Usage
 
Dim instance As CheckBoxViewer
Dim value As Object
Dim formatInfo As CellImageFormatInfo
Dim gridElement As GridElement
Dim value As Image
 
value = instance.GetImageCore(value, formatInfo, gridElement)

protected override Image GetImageCore( 
   object value,
   CellImageFormatInfo formatInfo,
   GridElement gridElement
)

Parameters

value

An object representing the value of the underlying cell.

formatInfo

A Xceed.Grid.CellImageFormatInfo which provides image formatting information.

gridElement

The Xceed.Grid.GridElement associated with the value. The gridElement is usually a Xceed.Grid.Cell or Xceed.Grid.Column and can be a null reference (Nothing in Visual Basic).

Return Value

A cell viewer can display an image and text representing the content of the cell to which it is associated. If a image is displayed, it is displayed to the left or right of the text. If no text is displayed, the image will occupy the entire space. The text can be retrieved using the GetText(Object) method.

When generating a report using the reporting capabilities of Xceed Grid for .NET, CellViewerManagers will only be reproduced in the report if the GetImage(Object) and/or GetText(Object) methods return the image or text that is to be displayed (GetImageCore and/or GetTextCore have been overridden). In the case where the GetImageCore and/or GetTextCore methods have not been overridden to return the desired image and/or text, the string representation of the underlying cell's content will be displayed in the report.

Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

Reference

CheckBoxViewer Class
CheckBoxViewer Members
Base Implementation in GetImageCore