RichTextBox::GetSpellingError Method (TextPointer^)

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Returns a SpellingError object associated with any spelling error at a specified position in the contents of the RichTextBox.

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

public:
SpellingError^ GetSpellingError(
	TextPointer^ position
)

Parameters

position
Type: System.Windows.Documents::TextPointer^

A TextPointer that specifies a position and logical direction that resolves to a character to examine for a spelling error. Use the LogicalDirection property of this TextPointer to specify the direction of the character to examine.

Return Value

Type: System.Windows.Controls::SpellingError^

A SpellingError object containing the details of the spelling error found at the character indicated by position, or null if no spelling error exists at the specified character.

A TextPointer like position usually specifies a position between two characters. Use the LogicalDirection property of position to specify which character to examine.

.NET Framework
Available since 3.0
Return to top
Show: