Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
Export (0) Print
Expand All

RichTextBox.CaretPosition Property

Gets or sets the position of the input caret.

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

'Declaration
Public Property CaretPosition As TextPointer

Property Value

Type: System.Windows.Documents.TextPointer
A TextPointer object specifying the position of the input caret.
By default, the caret is at the first insertion position at the beginning of the content hosted by the RichTextBox. See TextPointer for more information on text position terminology like "insertion position".

ExceptionCondition
ArgumentNullException

An attempt is made to set this property to Nothing.

ArgumentException

An attempt is made to set this property to a TextPointer that references a position outside of the current document.

The following example illustrates the use of this property.



			' Create a new FlowDocument, and add 3 paragraphs.
			Dim flowDoc As New FlowDocument()
			flowDoc.Blocks.Add(New Paragraph(New Run("Paragraph 1")))
			flowDoc.Blocks.Add(New Paragraph(New Run("Paragraph 2")))
			flowDoc.Blocks.Add(New Paragraph(New Run("Paragraph 3")))
			' Set the FlowDocument to be the content for a new RichTextBox.
			Dim rtb As New RichTextBox(flowDoc)

			' Get the current caret position.
			Dim caretPos As TextPointer = rtb.CaretPosition

			' Set the TextPointer to the end of the current document.
			caretPos = caretPos.DocumentEnd

			' Specify the new caret position at the end of the current document.
			rtb.CaretPosition = caretPos


.NET Framework

Supported in: 4, 3.5, 3.0

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

Community Additions

ADD
Show:
© 2015 Microsoft