Cell.DisplayText Property

Returns a cell’s displayed value.

Namespace: DevExpress.Spreadsheet

Assembly: DevExpress.Spreadsheet.v24.1.Core.dll

NuGet Package: DevExpress.Spreadsheet.Core

Declaration

C#

string DisplayText { get; }

VB.NET

ReadOnly Property DisplayText As String

Property Value

Type	Description
String	The cell’s display text.

Remarks

Use the Cell.Value property to access and modify a cell’s value. A cell can contain different data types. Assign a number format pattern to the Cell.NumberFormat property to format a numeric value in a cell as a percentage, currency, fraction, date and time, and so on. The DisplayText property returns the cell’s formatted value.

C#

// Add a formula to the cell "A1".
worksheet.Cells["A1"].Formula = "= Now()";
// Format the cell's value.
worksheet.Cells["A1"].NumberFormat = "m/d/yy h:mm";
// Obtain the cell's display text.
// The property returns the current date and time
// (for instance, "6/19/2020 13:13").
string displayText1 = worksheet.Cells["A1"].DisplayText;

// Add a number to the cell "B1".
worksheet.Cells["B1"].Value = 1.6;
// Format the number as a percentage.
worksheet.Cells["B1"].NumberFormat = "0.0%";
// Obtain the cell's display text.
// The property returns "160.0%".
string displayText2 = worksheet.Cells["B1"].DisplayText;

VB.NET

' Add a formula to the cell "A1".
worksheet.Cells("A1").Formula = "= Now()"
' Format the cell's value.
worksheet.Cells("A1").NumberFormat = "m/d/yy h:mm"
' Obtain the cell's display text.
' The property returns the current date and time
' (for instance, "6/19/2020 13:13").
Dim displayText1 As String = worksheet.Cells("A1").DisplayText

' Add a number to the cell "B1".
worksheet.Cells("B1").Value = 1.6
' Format the number as a percentage.
worksheet.Cells("B1").NumberFormat = "0.0%"
' Obtain the cell's display text.
' The property returns "160.0%".
Dim displayText2 As String = worksheet.Cells("B1").DisplayText

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the DisplayText property.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

winforms-spreadsheet-custom-draw-example/CS/CustomDrawExample/Form1.cs#L37

Worksheet settingsSheet = spreadsheetControl1.Document.Worksheets["SheetSettings"];
string text = settingsSheet.Cells[0, e.ColumnIndex].DisplayText;
if (text != String.Empty)

wpf-spreadsheet-bind-spreadsheet-to-ms-sql-server-database/CS/WpfSpreadsheet_BindToDataSource/MainWindow.xaml.cs#L76

        sheet["E4"].Value.TextValue, sheet["E6"].Value.TextValue, sheet["E8"].Value.TextValue,
        sheet.Cells["G4"].DisplayText, sheet.Cells["G6"].DisplayText);
}

spreadsheet-document-api-use-worksheet-table-as-data-source/CS/SpreadsheetDocumentServerAsDataSourceExample/MyColumnDetector.cs#L11

{
    return range[-1, offset].DisplayText;
}

winforms-spreadsheet-bind-to-ms-sql-server-database/CS/SuppliersExample/Form1.cs#L63

        sheet["E4"].Value.TextValue, sheet["E6"].Value.TextValue, sheet["E8"].Value.TextValue,
        sheet.Cells["G4"].DisplayText, sheet.Cells["G6"].DisplayText);
}

winforms-spreadsheet-use-a-spreadsheet-control-as-inplace-editor/CS/WindowsFormsApplication1/Form1.cs#L64

{
    newRow[j] = workSheet.Cells[i,j].DisplayText;
}

VB.NET

winforms-spreadsheet-custom-draw-example/VB/CustomDrawExample/Form1.vb#L34

Dim settingsSheet As Worksheet = spreadsheetControl1.Document.Worksheets("SheetSettings")
Dim text As String = settingsSheet.Cells(0, e.ColumnIndex).DisplayText
If Not Equals(text, String.Empty) Then

winforms-spreadsheet-how-to-edit-rich-text/VB/SpreadsheetRichText/RichTextEditForm.vb#L46

Else
    RichEditControl1.Text = cell.DisplayText
End If

wpf-spreadsheet-bind-spreadsheet-to-ms-sql-server-database/VB/WpfSpreadsheet_BindToDataSource/MainWindow.xaml.vb#L67

    ' Append a new row to the "Suppliers" data table.
    dataSet.Suppliers.AddSuppliersRow(sheet("C4").Value.TextValue, sheet("C6").Value.TextValue, sheet("C8").Value.TextValue, sheet("E4").Value.TextValue, sheet("E6").Value.TextValue, sheet("E8").Value.TextValue, sheet.Cells("G4").DisplayText, sheet.Cells("G6").DisplayText)
Catch ex As Exception

spreadsheet-document-api-use-worksheet-table-as-data-source/VB/SpreadsheetDocumentServerAsDataSourceExample/MyColumnDetector.vb#L10

Public Function GetColumnName(ByVal index As Integer, ByVal offset As Integer, ByVal range As CellRange) As String Implements IDataSourceColumnTypeDetector.GetColumnName
    Return range(-1, offset).DisplayText
End Function

winforms-spreadsheet-bind-to-ms-sql-server-database/VB/SuppliersExample/Form1.vb#L61

    ' Append a new row to the "Suppliers" data table.
    dataSet.Suppliers.AddSuppliersRow(sheet("C4").Value.TextValue, sheet("C6").Value.TextValue, sheet("C8").Value.TextValue, sheet("E4").Value.TextValue, sheet("E6").Value.TextValue, sheet("E8").Value.TextValue, sheet.Cells("G4").DisplayText, sheet.Cells("G6").DisplayText)
Catch ex As Exception