Xceed Grid for WinForms v4.3 Documentation
Xceed.Grid.v4.3 Assembly / Xceed.Grid.Viewers Namespace / DateViewer Class / GetDate Method
An object representing the value of the underlying cell.
A Xceed.Grid.CellTextFormatInfo which provides text 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
    GetDate Method
    In This Topic
    Retrieves the date displayed by the viewer.
    Syntax
    'Declaration
     
    Protected Overridable Function GetDate( _
       ByVal value As Object, _
       ByVal formatInfo As CellTextFormatInfo, _
       ByVal gridElement As GridElement _
    ) As Date
    'Usage
     
    Dim instance As DateViewer
    Dim value As Object
    Dim formatInfo As CellTextFormatInfo
    Dim gridElement As GridElement
    Dim value As Date
     
    value = instance.GetDate(value, formatInfo, gridElement)
    protected virtual DateTime GetDate( 
       object value,
       CellTextFormatInfo formatInfo,
       GridElement gridElement
    )

    Parameters

    value
    An object representing the value of the underlying cell.
    formatInfo
    A Xceed.Grid.CellTextFormatInfo which provides text 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 System.DateTime value representing the date displayed by the viewer.
    Remarks

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

    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