VGridControlBase.GetCellDisplayText(BaseRow, Int32) Method

Returns the display text of the specified cell.

Namespace: DevExpress.XtraVerticalGrid

Assembly: DevExpress.XtraVerticalGrid.v19.2.dll

Declaration

C#

public string GetCellDisplayText(
    BaseRow row,
    int recordIndex
)

VB.NET

Public Function GetCellDisplayText(
    row As BaseRow,
    recordIndex As Integer
) As String

Parameters

Name	Type	Description
row	BaseRow	A BaseRow descendant that represents the row where the desired cell resides.
recordIndex	Int32	A zero-based integer that specifies the index of the record which contains the cell.

Returns

Type	Description
String	A String value that represents the cell’s display text.

Remarks

The GetCellDisplayText method returns a textual representation of a specific cell value. The returned string is formatted as specified by the row’s RowProperties.Format property.

To obtain the cell’s value, use the VGridControlBase.GetCellValue method.

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the GetCellDisplayText(BaseRow, Int32) method.

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#

how-to-create-a-propertygridcontrol-descendant-class-supporting-paintvalue-in-uitypeeditor-t124141/CS/dxPaintValue/MyVGridPainter.cs#L28

    Rectangle textBounds = new Rectangle(e.Bounds.X + bounds.Width + 2 * indent+ indent, e.Bounds.Y, e.Bounds.Width - bounds.Width + 2 * indent, e.Bounds.Height);
    grid.Appearance.RecordValue.DrawString(e.Cache, grid.GetCellDisplayText(properties.Row, 0), textBounds);
}

VB.NET

how-to-create-a-propertygridcontrol-descendant-class-supporting-paintvalue-in-uitypeeditor-t124141/VB/dxPaintValue/MyVGridPainter.vb#L32

    Dim textBounds As New Rectangle(e.Bounds.X + bounds.Width + 2 * indent+ indent, e.Bounds.Y, e.Bounds.Width - bounds.Width + 2 * indent, e.Bounds.Height)
    grid.Appearance.RecordValue.DrawString(e.Cache, grid.GetCellDisplayText(properties.Row, 0), textBounds)
Else