TextBoxBase.BeginChange Method

Begins a change block.

Namespace:  System.Windows.Controls.Primitives
Assembly:  PresentationFramework (in PresentationFramework.dll)

public function BeginChange()
You cannot use methods in XAML.

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.

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();

Windows 7, Windows Vista, Windows XP SP2, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

.NET Framework

Supported in: 3.5, 3.0
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft