RichTextBox.CaretPosition プロパティ

定義

入力キャレットの位置を取得または設定します。

public:
 property System::Windows::Documents::TextPointer ^ CaretPosition { System::Windows::Documents::TextPointer ^ get(); void set(System::Windows::Documents::TextPointer ^ value); };
public System.Windows.Documents.TextPointer CaretPosition { get; set; }
member this.CaretPosition : System.Windows.Documents.TextPointer with get, set
Public Property CaretPosition As TextPointer

プロパティ値

入力キャレットの位置を指定する TextPointer オブジェクト。

既定では、キャレットは、RichTextBox でホストされているコンテンツの先頭にある最初の挿入位置にあります。 "挿入位置" など、テキストの位置に関する用語の詳細については、TextPointer を参照してください。

例外

このプロパティを null に設定しようとしました。

このプロパティを、現在のドキュメントの外部の位置を参照する TextPointer に設定しようとしました。

次の例は、このプロパティの使用方法を示しています。


// Create a new FlowDocument, and add 3 paragraphs.
FlowDocument flowDoc = 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.
RichTextBox rtb = new RichTextBox(flowDoc);

// Get the current caret position.
TextPointer caretPos = 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;

' 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

適用対象

こちらもご覧ください