TextElementEditingBehaviorAttribute Class


Specifies how a RichTextBox should handle a custom text element.

public ref class TextElementEditingBehaviorAttribute sealed : Attribute
public sealed class TextElementEditingBehaviorAttribute : Attribute
type TextElementEditingBehaviorAttribute = class
    inherit Attribute
Public NotInheritable Class TextElementEditingBehaviorAttribute
Inherits Attribute


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 Versions and Dependencies.



Initializes a new instance of the TextElementEditingBehaviorAttribute class.



Gets or sets a value indicating whether the RichTextBox can merge two adjacent text elements.


Gets or sets a value indicating whether the text element provides formatting on a character basis, or if the formatting applies to the entire element.


When implemented in a derived class, gets a unique identifier for this Attribute.

(Inherited from Attribute)



Returns a value that indicates whether this instance is equal to a specified object.

(Inherited from Attribute)

Returns the hash code for this instance.

(Inherited from Attribute)

Gets the Type of the current instance.

(Inherited from Object)

When overridden in a derived class, indicates whether the value of this instance is the default value for the derived class.

(Inherited from Attribute)

When overridden in a derived class, returns a value that indicates whether this instance equals a specified object.

(Inherited from Attribute)

Creates a shallow copy of the current Object.

(Inherited from Object)

Returns a string that represents the current object.

(Inherited from Object)

Explicit Interface Implementations

_Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr)

Maps a set of names to a corresponding set of dispatch identifiers.

(Inherited from Attribute)
_Attribute.GetTypeInfo(UInt32, UInt32, IntPtr)

Retrieves the type information for an object, which can be used to get the type information for an interface.

(Inherited from Attribute)

Retrieves the number of type information interfaces that an object provides (either 0 or 1).

(Inherited from Attribute)
_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)

Provides access to properties and methods exposed by an object.

(Inherited from Attribute)

Applies to