ValidateLabelEdit Event

Occurs before text in the label edit is committed to a node.

Syntax

Visual Basic

'Declaration
 
Public Event ValidateLabelEdit As ValidateLabelEditEventHandler

C#

public event ValidateLabelEditEventHandler ValidateLabelEdit

Event Data

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

Property	Description
Cancel (Inherited from System.ComponentModel.CancelEventArgs)
LabelEditText	Gets/sets the text of the node being edited.
Node	Returns the node being edited
OriginalText	Returns the original text of the node.
StayInEditMode	Gets/sets whether the node will remain in edit mode.

Remarks

This event can be used to validate the new node text entered into the edit window before it is committed to the node.

The e.NodeText parameter gets/sets the new node text.

Example

The following sample code illustrates some of the information available in the ValidateLabelEdit event.

For an overview of how to handle events in Visual Basic or Visual C#, see Event Handlers in Visual Basic and Visual C#. For specific information and code examples illustrating how to consume events in your application, see Consuming Events in the .NET Framework Developer's Guide.

Visual Basic

Imports Infragistics.Win.UltraWinTree

Private Sub ultraTree1_ValidateLabelEdit(ByVal sender As Object, ByVal e As Infragistics.Win.UltraWinTree.ValidateLabelEditEventArgs) Handles ultraTree1.ValidateLabelEdit

    Dim tree As Infragistics.Win.UltraWinTree.UltraTree

    tree = sender

    Dim sb As New System.Text.StringBuilder()

    sb.Append("Node: ")
    sb.Append(tree.ActiveNode.Key)

    sb.Append("'s text is being changed to: ")
    sb.Append(e.LabelEditText)

    Dim dr As DialogResult
    dr = MessageBox.Show(Me, _
      sb.ToString(), _
      "Node text changing", _
      MessageBoxButtons.OKCancel)


    If dr = DialogResult.Cancel Then e.Cancel = True

    ' Note: Instead of canceling the edit you can 
    ' change the text by setting the LabelEditText
    ' property of the event parameters in this event.
    'e.LabelEditText = "some new text"

End Sub

C#

using System.Diagnostics;
using Infragistics.Win.UltraWinTree;

private void ultraTree1_ValidateLabelEdit(object sender, Infragistics.Win.UltraWinTree.ValidateLabelEditEventArgs e)
{

	Infragistics.Win.UltraWinTree.UltraTree tree;
	
	tree = sender as Infragistics.Win.UltraWinTree.UltraTree;

	System.Text.StringBuilder sb = new System.Text.StringBuilder();

	sb.Append("Node: ");
	sb.Append(tree.ActiveNode.Key);
	
	sb.Append("'s text is being changed to: ");
	sb.Append(e.LabelEditText);
		
	DialogResult dr = MessageBox.Show( this,
						  sb.ToString(),
						  "Node text changing",
						  MessageBoxButtons.OKCancel );
						  
		
	if ( dr == DialogResult.Cancel )
		e.Cancel = true;

	// Note: Instead of canceling the edit you can 
	// change the text by setting the LabelEditText
	// property of the event parameters in this event.
	//e.LabelEditText = "some new text";

}

Requirements

Target Platforms: Windows 10, Windows 8.1, Windows 8, Windows 7, Windows Server 2012, 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