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 sealed class TextElementEditingBehaviorAttribute : Attribute
<TextElementEditingBehaviorAttribute .../>

The TextElementEditingBehaviorAttribute type exposes the following members.

Public methodTextElementEditingBehaviorAttributeInitializes a new instance of the TextElementEditingBehaviorAttribute class.

Public propertyIsMergeableGets or sets a value indicating whether the RichTextBox can merge two adjacent text elements.
Public propertyIsTypographicOnlyGets or sets a value indicating whether the text element provides formatting on a character basis, or if the formatting applies to the entire element.
Public propertyTypeIdWhen implemented in a derived class, gets a unique identifier for this Attribute. (Inherited from Attribute.)

Public methodEqualsInfrastructure. Returns a value that indicates whether this instance is equal to a specified object. (Inherited from Attribute.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeReturns the hash code for this instance. (Inherited from Attribute.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodIsDefaultAttributeWhen overridden in a derived class, indicates whether the value of this instance is the default value for the derived class. (Inherited from Attribute.)
Public methodMatchWhen overridden in a derived class, returns a value that indicates whether this instance equals a specified object. (Inherited from Attribute.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)

Explicit interface implemetationPrivate method_Attribute.GetIDsOfNamesMaps a set of names to a corresponding set of dispatch identifiers. (Inherited from Attribute.)
Explicit interface implemetationPrivate method_Attribute.GetTypeInfoRetrieves the type information for an object, which can be used to get the type information for an interface. (Inherited from Attribute.)
Explicit interface implemetationPrivate method_Attribute.GetTypeInfoCountRetrieves the number of type information interfaces that an object provides (either 0 or 1). (Inherited from Attribute.)
Explicit interface implemetationPrivate method_Attribute.InvokeProvides access to properties and methods exposed by an object. (Inherited from 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 .NET Framework Versions and Dependencies.

.NET Framework

Supported in: 4, 3.5 SP1, 3.0 SP1

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

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

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

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