バージョン

選択 (xamSyntaxEditor)

トピックの概要

目的

このトピックでは、 xamSyntaxEditor™ コントロールの選択機能をコードで使用する方法を紹介します。

前提条件

このトピックを理解するためには、以下のトピックを理解しておく必要があります。

トピック 目的

このトピックでは、 xamSyntaxEditor の機能を分かりやすく解説します。

このトピックでは、 xamSyntaxEditor を短時間で起動、実行するのに役立つ体系的な操作方法を紹介します。

このトピックでは、開発者とユーザー双方の視点から xamSyntaxEditor コントロールのテキスト編集機能をまとめました。

このトピックの内容

このトピックは、以下のセクションで構成されます。

はじめに

選択概要

選択機能は、ドキュメントでテキストが隣接する部分を選択する機能を有効にします。選択は他の背景色によって強調表示されます。EditorDocumentView クラスの SelectionManager プロパティを使用してコードでテキストを選択できます。SelectionManager のタイプは ViewSelectionManager です。以下の操作を実行できます。

  • 現在選択されているテキストを取得します

  • 現在選択されているテキストを置き換えます

  • 現在の選択の開始、終了、および長さを取得します

  • ViewSelectionManager メソッドを使用して選択したテキストを操作します

選択の操作の概要

選択構成の概要表

以下の表は xamSyntaxEditor の選択機能の構成可能な要素を表示します。

タスク 詳細 プロパティ

現在選択されているテキストを取得します

現在の選択の長さを取得します

現在の選択を置き換えるか、カレットの位置にテキストを挿入します

現在の選択の開始を取得または設定します

現在選択されているテキストの取得

概要

現在選択されているテキストを取得するには、SelectedText プロパティを使用します。

プロパティ設定

目的: 使用するプロパティ: 操作:

現在選択されているテキストを取得または設定します

SelectedText

タイプ String の変数に設定します

現在の選択の長さの取得

概要

SelectionLength プロパティは、現在の選択にある文字の数を表す整数を返します。

プロパティ設定

目的: 使用するプロパティ: 操作:

現在の選択の長さを取得します

SelectionLength

タイプ Integer の変数に設定します

現在選択されているテキストの置き換え

概要

現在選択されているテキストを新しいテキストと置き換えるには、SelectedText プロパティを新しいテキストに設定します。選択されているテキストがない場合、SelectedText プロパティに設定した新しいテキストはカレット位置に挿入されます。

プロパティ設定

目的: 使用するプロパティ: 設定する引数:

現在の選択を置き換えるか、カレットの位置にテキストを挿入します

SelectedText

  • 文字列型の新しい値

選択の開始位置および終了位置の設定と取得

概要

SelectionStart プロパティおよび SelectionEnd プロパティを使用すると、選択の開始位置および終了位置を取得または設定できます。このプロパティの値は TextDocumentSnapshot の開始からのゼロから始まる開始または終了オフセットを表します。

プロパティ設定

目的: 使用するプロパティ: 設定する引数:

現在の選択の開始/終了インデックスを取得または設定します

SelectionStart

SelectionEnd

  • startTextLocation

  • endTextLocation

または

  • startSnapshotPoint

  • endSnapshotPoint

コード例

コード例の概要

以下の表は、このトピックで使用したコード例をまとめたものです。

例 解説

この例は、5 の開始インデックスおよび 60 の終了インデックスのテキストを選択するコードを紹介します。

選択されているテキストの長さを取得する方法を紹介します。

コード例: コードでテキストの選択

説明

この例は、5 の開始インデックスおよび 60 の終了インデックスのテキストを選択するコードを紹介します。

コード

C# の場合:

int startIndex = 5;
int endIndex = 60;
TextDocumentSnapshot tdsp = this.mySyntaxEditor.ActiveDocumentView.CurrentSnapshot;
TextLocation stl = tdsp.LocationFromOffset(startIndex);
TextLocation etl = tdsp.LocationFromOffset(endIndex);
SnapshotPoint ssp = SnapshotPoint.FromTextLocation(stl, tdsp);
SnapshotPoint esp = SnapshotPoint.FromTextLocation(etl, tdsp);
this.mySyntaxEditor.ActiveDocumentView.SelectionManager.SelectionStart = ssp;
this.mySyntaxEditor.ActiveDocumentView.SelectionManager.SelectionEnd = esp;

Visual Basic の場合:

Dim startIndex As Integer = 5
Dim endIndex As Integer = 60
Dim tdsp As TextDocumentSnapshot = Me.mySyntaxEditor.ActiveDocumentView.CurrentSnapshot
Dim stl As TextLocation = tdsp.LocationFromOffset(startIndex)
Dim etl As TextLocation = tdsp.LocationFromOffset(endIndex)
Dim ssp As SnapshotPoint = SnapshotPoint.FromTextLocation(stl, tdsp)
Dim esp As SnapshotPoint = SnapshotPoint.FromTextLocation(etl, tdsp)
Me.mySyntaxEditor.ActiveDocumentView.SelectionManager.SelectionStart = ssp
Me.mySyntaxEditor.ActiveDocumentView.SelectionManager.SelectionEnd = esp

コード例: 選択の長さの取得

説明

現在のテキスト選択の長さを取得する方法を紹介します。

コード

C# の場合:

int lengthOfSelection = this.xamSyntaxEditor1.ActiveDocumentView.SelectionManager.SelectionLength();

Visual Basic の場合:

Dim lengthOfSelection As Integer
lengthOfSelection = Me.xamSyntaxEditor1.ActiveDocumentView.SelectionManager.SelectionLength()

関連コンテンツ

このトピックにの追加情報については、以下のトピックも合わせてご参照ください。

トピック 目的

このトピックでは、 xamSyntaxEditor アプリケーションの構築とともにユーザーが利用できるイベントとサポート対象コマンドを紹介します。

このトピックでは、 xamSyntaxEditor のドキュメント分割機能を解説し、カスタマイズする方法について解説します。