Xceed Grid for WinForms v4.3 Documentation
Xceed.Grid.v4.3 Assembly / Xceed.Grid.Viewers Namespace / ImageViewer Class / GetImageCore Method
An object representing the value of the underlying cell.
A Xceed.Grid.CellImageFormatInfo which provides image formatting information.
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).


In This Topic
    GetImageCore Method (ImageViewer)
    In This Topic
    Retrieves the image that is displayed by the ImageViewer.
    Syntax
    'Declaration
     
    Protected Overrides Function GetImageCore( _
       ByVal value As Object, _
       ByVal formatInfo As CellImageFormatInfo, _
       ByVal gridElement As GridElement _
    ) As Image
    'Usage
     
    Dim instance As ImageViewer
    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 reference to the System.Drawing.Image displayed by the ImageViewer.
    Remarks

    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