ShowRowError Property

Gets or sets a value that indicates whether to display row errors in the RowHeaderCell.

Syntax

Visual Basic (Declaration)
Visual Basic (Usage)
C#

<SRDescriptionAttribute("Indicates whether the error information of the row is shown.")>
<SRCategoryAttribute("Appearance")>
<DefaultValueAttribute()>
Public Property ShowRowError As Boolean

Dim instance As RowHeaderCell
Dim value As Boolean
 
instance.ShowRowError = value
 
value = instance.ShowRowError

[SRDescription("Indicates whether the error information of the row is shown.")]
[SRCategory("Appearance")]
[DefaultValue()]
public bool ShowRowError {get; set;}

Property Value

true if an error glyph appears in the cell when the row's Row.ErrorText is set; otherwise, false. The default is true.

Remarks

If this property value is true and the owner Row's Row.ErrorText property is not a null reference (Nothing in Visual Basic) or String.Empty the RowHeaderCell displays the error icon. If this property is false, the RowHeaderCell determines whether to show an error icon based on its own Cell.ErrorText property value.

Example

The following code example shows some important properties of row header cells. The RowHeaderCell draws the appearance using the FlatAppearance. Because the ShowIndicator is false, the editing icon and new row icon are not displayed. Although the Row.ErrorText is set, the ShowRowError is false, so the error icon is not displayed in the RowHeaderCell. This code example is part of a larger example provided for the RowHeaderCell class.

private void Form1_Load(object sender, EventArgs e)
        {
            Template template1 = Template.CreateGridTemplate(10, 80, 21, Int32.MaxValue, AutoGenerateGridTemplateStyles.RowHeader, 50);
            //Set this property, an error icon glyph is displayed on the RowHeaderCell, if RowHeaderCell.ShowRowError is false, no icon is shown.
            template1.Row.ErrorText = "Row Error";

            RowHeaderCell rowHeaderCell1 = template1.Row.Cells[10] as RowHeaderCell;
            //Click the RowHeaderCell, the current row is selected.
            rowHeaderCell1.SelectionMode = MultiRowSelectionMode.Row;
            //Set FlatStyle to Flat, and customize the appearance.
            rowHeaderCell1.FlatStyle = FlatStyle.Flat;
            rowHeaderCell1.FlatAppearance.BorderColor = Color.Black;
            rowHeaderCell1.FlatAppearance.BorderSize = 1;
            rowHeaderCell1.FlatAppearance.MouseDownBackColor = Color.Khaki;
            rowHeaderCell1.FlatAppearance.MouseOverBackColor = Color.Orange;

            rowHeaderCell1.Style.BackColor = Color.DarkKhaki;
            rowHeaderCell1.Style.SelectionBackColor = Color.LightBlue;

            //The editing icon and new row icon do not display.
            rowHeaderCell1.ShowIndicator = false;
            //Set ShowRowError to false to hide the row's error icon.
            rowHeaderCell1.ShowRowError = false;
            //Set the RowHeaderCell's caption. It displays "A1, A2, A3, ...".
            rowHeaderCell1.ValueFormat = "A1";

            gcMultiRow1.Template = template1;
            gcMultiRow1.RowCount = 100;
        }

VB.NET

Private Sub Form1_Load(ByVal sender As Object, ByVal e As EventArgs) Handles Me.Load
        Dim template1 As Template = Template.CreateGridTemplate(10, 80, 21, Int32.MaxValue, AutoGenerateGridTemplateStyles.RowHeader, 50)
        'Set this property, an error icon glyph is displayed on the RowHeaderCell, if RowHeaderCell.ShowRowError is false, no icon is shown.
        template1.Row.ErrorText = "Row Error"

        Dim rowHeaderCell1 As RowHeaderCell = TryCast(template1.Row.Cells(10), RowHeaderCell)
        'Click the RowHeaderCell, the current row is selected.
        rowHeaderCell1.SelectionMode = MultiRowSelectionMode.Row
        'Set FlatStyle to Flat, and customize the appearance.
        rowHeaderCell1.FlatStyle = FlatStyle.Flat
        rowHeaderCell1.FlatAppearance.BorderColor = Color.Black
        rowHeaderCell1.FlatAppearance.BorderSize = 1
        rowHeaderCell1.FlatAppearance.MouseDownBackColor = Color.Khaki
        rowHeaderCell1.FlatAppearance.MouseOverBackColor = Color.Orange

        rowHeaderCell1.Style.BackColor = Color.DarkKhaki
        rowHeaderCell1.Style.SelectionBackColor = Color.LightBlue

        'The editing icon and new row icon do not display.
        rowHeaderCell1.ShowIndicator = False
        'Set ShowRowError to false to hide the row's error icon.
        rowHeaderCell1.ShowRowError = False
        'Set the RowHeaderCell's caption. It displays "A1, A2, A3, ...".
        rowHeaderCell1.ValueFormat = "A1"

        gcMultiRow1.Template = template1
        gcMultiRow1.RowCount = 100
    End Sub

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

Reference

RowHeaderCell Class
RowHeaderCell Members