RichTextBox.GetSpellingError(TextPointer) Method

Definition

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

public:
 System::Windows::Controls::SpellingError ^ GetSpellingError(System::Windows::Documents::TextPointer ^ position);
public System.Windows.Controls.SpellingError GetSpellingError (System.Windows.Documents.TextPointer position);
member this.GetSpellingError : System.Windows.Documents.TextPointer -> System.Windows.Controls.SpellingError
Public Function GetSpellingError (position As TextPointer) As SpellingError

Parameters

position
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.

Returns

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.

Remarks

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

Applies to

See also