Xceed Grid for WinForms v4.3 Documentation
GetImage(Object,CellImageFormatInfo) Method


Xceed.Grid.v4.3 Assembly > Xceed.Grid.Viewers Namespace > CellViewerManager Class > GetImage Method : GetImage(Object,CellImageFormatInfo) Method
An object representing the value of the underlying cell.
A Xceed.Grid.CellImageFormatInfo which provides image formatting information.
Retrieves the image displayed by the viewer and raises the QueryImage event.
Syntax
'Declaration
 
Public Overloads Function GetImage( _
   ByVal value As Object, _
   ByVal formatInfo As CellImageFormatInfo _
) As Image
'Usage
 
Dim instance As CellViewerManager
Dim value As Object
Dim formatInfo As CellImageFormatInfo
Dim value As Image
 
value = instance.GetImage(value, formatInfo)
public Image GetImage( 
   object value,
   CellImageFormatInfo formatInfo
)

Parameters

value
An object representing the value of the underlying cell.
formatInfo
A Xceed.Grid.CellImageFormatInfo which provides image formatting information.

Return Value

An System.Drawing.Image representing the image. displayed by the viewer.
Remarks

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.

Requirements

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

See Also

Reference

CellViewerManager Class
CellViewerManager Members
Overload List