CellErrorTextNeeded Event

Occurs when a cell's error text is needed.

Syntax

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

<SRDescriptionAttribute("Occurs when a cell's error text is needed. ")>
<SRCategoryAttribute("Data")>
Public Event CellErrorTextNeeded As EventHandler(Of CellErrorTextNeededEventArgs)

Dim instance As GcMultiRow
Dim handler As EventHandler(Of CellErrorTextNeededEventArgs)
 
AddHandler instance.CellErrorTextNeeded, handler

[SRDescription("Occurs when a cell's error text is needed. ")]
[SRCategory("Data")]
public event EventHandler<CellErrorTextNeededEventArgs> CellErrorTextNeeded

Event Data

The event handler receives an argument of type CellErrorTextNeededEventArgs containing data related to this event. The following CellErrorTextNeededEventArgs properties provide information specific to this event.

Property	Description
CellIndex	Gets the cell index in its parent Section. (Inherited from GrapeCity.Win.MultiRow.CellEventArgs)
CellName	Gets the cell name. (Inherited from GrapeCity.Win.MultiRow.CellEventArgs)
ErrorText	Gets or sets a string that describes the error for the current Cell.
RowIndex	Gets the index of the owner Row that the event occurs for. (Inherited from GrapeCity.Win.MultiRow.CellEventArgs)
Scope	Gets the area of the cell that the event occurs for. (Inherited from GrapeCity.Win.MultiRow.CellEventArgs)
SectionIndex	Gets the index of the owner Section that the event occurs for. (Inherited from GrapeCity.Win.MultiRow.CellEventArgs)

Remarks

The CellErrorTextNeeded event occurs only when the GcMultiRow control DataSource property is set or its VirtualMode property is true. Handling the CellErrorTextNeeded event is useful when the user wants to determine the error for a cell depending on its value or state.
When the user handles the CellErrorTextNeeded event and specifies error text in the handler, an error glyph appears in the cell unless the ShowCellErrors property is set to false. When the user moves the mouse pointer over the error glyph, the error text appears in a ToolTip.
The CellErrorTextNeeded event also occurs when the value of the Cell.ErrorText property is retrieved.
The user can use the CellEventArgs.RowIndex (or CellEventArgs.SectionIndex) and CellEventArgs.CellIndex (or CellEventArgs.CellName) and the CellEventArgs.Scope property to determine the state or value of a cell. They can also use this information to change or modify the CellErrorTextNeededEventArgs.ErrorText property. /// This property is initialized with the cell ErrorText property value, which the event value overrides.

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

GcMultiRow Class
GcMultiRow Members