VGridControlBase.SetRowError(RowProperties, String, ErrorType) Method

For the VGridControl, this method sets an error description and icon type for a cell within the focused record. For the PropertyGridControl, this method sets an error description and icon type for the specified row.

Namespace: DevExpress.XtraVerticalGrid

Assembly: DevExpress.XtraVerticalGrid.v20.1.dll

Declaration

public virtual void SetRowError(
    RowProperties props,
    string errorText,
    ErrorType errorType
)
Public Overridable Sub SetRowError(
    props As RowProperties,
    errorText As String,
    errorType As ErrorType
)

Parameters

Name Type Description
props RowProperties

A RowProperties object that is the row item that contains an error cell.

errorText String

A string value that specifies an error description. An empty string to clear the assigned error.

errorType ErrorType

A ErrorType value that is the error icon type.

Remarks

Use the SetRowError method to assign errors to records or individual cells. This can be useful if you perform input validation by handling the VGridControlBase.ValidateRecord event, and want to indicate input errors within cells.

Setting an error description for a cell results in displaying an error icon for the cell. Pointing to error icons with the mouse displays a hint with an appropriate error description.

Calling the SetRowError method has no effect if no record is currently focused (the vertical grid's VGridControlBase.FocusedRecord property value is -1).

See Also