GridView.GetRowPreviewDisplayText(Int32) Method

Gets the text displayed within a row's preview section.

Namespace: DevExpress.XtraGrid.Views.Grid

Assembly: DevExpress.XtraGrid.v20.1.dll

Declaration

public virtual string GetRowPreviewDisplayText(
    int rowHandle
)
Public Overridable Function GetRowPreviewDisplayText(
    rowHandle As Integer
) As String

Parameters

Name Type Description
rowHandle Int32

An integer value specifying the handle of the row whose preview section's content is to be obtained. Row handles are not data source indexes, see the Accessing Rows in Code. Row Handles section of the "Rows" article for more information.

Returns

Type Description
String

A string value representing the text displayed within the specified preview section.

Remarks

First, the GetRowPreviewDisplayText method tries to obtain the value of the field specified by the GridView.PreviewFieldName property. If the GridView.CalcPreviewText event is not handled, the method returns the value obtained. Otherwise, the method's return value is the string specified by the event handler. An empty string if returned if the GridView.PreviewFieldName property value is not set and the GridView.CalcPreviewText event handler doesn't provide any text.

The GetRowPreviewDisplayText method may be useful when custom painting preview sections. To do so, handle the GridView.CustomDrawRowPreview event.

Please refer to the Row Preview Sections topic for additional information.

NOTE

Detail pattern Views do not contain data and they are never displayed within XtraGrid. So, the GetRowPreviewDisplayText member must not be invoked for these Views. The GetRowPreviewDisplayText member can only be used with real Views that are displayed within the Grid Control. The real Views with which an end-user interacts at runtime can be accessed using the following methods.

See Also