TextBoxBase.BeginChange Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Begins a change block.
public:
void BeginChange();public void BeginChange ();member this.BeginChange : unit -> unitPublic Sub BeginChange ()Examples
The following example shows how to use the BeginChange and EndChange methods to create a change block.
TextBox myTextBox = new TextBox();
// Begin the change block. Once BeginChange() is called
// no text content or selection change events will be raised
// until EndChange is called. Also, all edits made within
// a BeginChange/EndChange block are wraped in a single undo block.
myTextBox.BeginChange();
// Put some initial text in the TextBox.
myTextBox.Text = "Initial text in TextBox";
// Make other changes if desired...
// Whenever BeginChange() is called EndChange() must also be
// called to end the change block.
myTextBox.EndChange();
Dim myTextBox As New TextBox()
' Begin the change block. Once BeginChange() is called
' no text content or selection change events will be raised
' until EndChange is called. Also, all edits made within
' a BeginChange/EndChange block are wraped in a single undo block.
myTextBox.BeginChange()
' Put some initial text in the TextBox.
myTextBox.Text = "Initial text in TextBox"
' Make other changes if desired...
' Whenever BeginChange() is called EndChange() must also be
' called to end the change block.
myTextBox.EndChange()
Remarks
Note
When you call BeginChange, you must also call EndChange to complete the change block otherwise an exception will be thrown.
A change block logically groups multiple changes into a single undo unit and prevents text content or selection change events from being raised until after the change block. This way you can make multiple edits to the text element without the danger of the text element being changed at the same time by another listener. A change block is created by calling the DeclareChangeBlock method. Calling the BeginChange method causes all subsequent changes to be included in the specified change block until a corresponding call to the EndChange method is made.
