Xceed Grid for WinForms v4.3 Documentation
GetTextCore Method (TextViewer)


Xceed.Grid.v4.3 Assembly > Xceed.Grid.Viewers Namespace > TextViewer Class : GetTextCore 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).
Retrieves the text displayed by the viewer.
Syntax
'Declaration
 
Protected Overrides Function GetTextCore( _
   ByVal value As Object, _
   ByVal formatInfo As CellTextFormatInfo, _
   ByVal gridElement As GridElement _
) As String
'Usage
 
Dim instance As TextViewer
Dim value As Object
Dim formatInfo As CellTextFormatInfo
Dim gridElement As GridElement
Dim value As String
 
value = instance.GetTextCore(value, formatInfo, gridElement)
protected override string GetTextCore( 
   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 string representing the text 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 an 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 image can be retrieved using the GetImage(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

TextViewer Class
TextViewer Members
Base Implementation in GetTextCore