This documentation is archived and is not being maintained.

TextElementEditingBehaviorAttribute Class

Specifies how a RichTextBox should handle a custom text element.

Namespace:  System.Windows.Documents
Assembly:  PresentationFramework (in PresentationFramework.dll)

public final class TextElementEditingBehaviorAttribute extends Attribute
<TextElementEditingBehaviorAttribute .../>

When you create a custom text element, you can use the TextElementEditingBehaviorAttribute attribute to specify that the element should be treated as a single, unbreakable entity. When the IsMergeable and IsTypographicOnly properties are set to false, a RichTextBox preserves the boundaries and content of the element when the user edits the RichTextBox. In general, the custom element behaves similar to a Hyperlink. The following behavior occurs when you use this class and set both of its properties to false:

  • When a user copies and pastes a part of the content in a custom element, the formatting of the copied text is not preserved.

  • When a user types before or after the content of the custom element, the new content does not acquire the custom element's formatting information.

  • The user cannot insert a line break in the custom element.

When you create a custom element, use the TextRange.Save(Stream, String, Boolean) method and set preserveTextElements to true to preserve the custom element and property values when you serialize it to the disk or clipboard.

TextElementEditingBehaviorAttribute is introduced in the .NET Framework version 3.5. For more information, see .NET Framework 3.5 Architecture.


Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

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 SP1, 3.0 SP1