チュートリアル: テキストを強調表示する

[アーティクル]
01/13/2024

Managed Extensibility Framework (MEF) コンポーネントパーツを作成して、エディターにさまざまな視覚効果を追加できます。このチュートリアルでは、テキストファイル内に現在の単語が出現するたびに強調表示する方法について説明します。 1 つの単語がテキストファイル内に複数回出現し、キャレットを 1 つの出現位置に配置すると、すべての出現箇所が強調表示されます。

MEF プロジェクトを作成する

C# VSIX プロジェクトを作成します。 ([新しいプロジェクト] ダイアログで、[Visual C#]、[拡張機能]、[VSIX プロジェクト] の順に選択します。) ソリューションに HighlightWordTest という名前を付けます。
プロジェクトに、[エディター分類子] 項目テンプレートを追加します。詳細については、「エディター項目テンプレートを使用して拡張機能を作成する」を参照してください。
既存のクラスファイルを削除します。

TextMarkerTag を定義する

テキストを強調表示する最初の手順では、TextMarkerTag をサブクラス化し、その外観を定義します。

TextMarkerTag と MarkerFormatDefinition を定義するには

クラスファイルを追加して、その名前を HighlightWordTag にします。
次の参照を追加します:
1. Microsoft.VisualStudio.CoreUtility
2. Microsoft.VisualStudio.Text.Data
3. Microsoft.VisualStudio.Text.Logic
4. Microsoft.VisualStudio.Text.UI
5. Microsoft.VisualStudio.Text.UI.Wpf
6. System.ComponentModel.Composition
7. Presentation.Core
8. Presentation.Framework

次の名前空間をインポートします。

using System;
using System.Collections.Generic;
using System.ComponentModel.Composition;
using System.Linq;
using System.Threading;
using Microsoft.VisualStudio.Text;
using Microsoft.VisualStudio.Text.Classification;
using Microsoft.VisualStudio.Text.Editor;
using Microsoft.VisualStudio.Text.Operations;
using Microsoft.VisualStudio.Text.Tagging;
using Microsoft.VisualStudio.Utilities;
using System.Windows.Media;

TextMarkerTag を継承するクラスを作成し、その名前を HighlightWordTag にします。
```
internal class HighlightWordTag : TextMarkerTag
{

}
```
MarkerFormatDefinition を継承する 2 番目のクラスを作成し、その名前を HighlightWordFormatDefinition にします。タグにこの形式定義を使用するには、次の属性を使用してエクスポートする必要があります。
- NameAttribute: この形式を参照するためにタグでこれが使用されます
- UserVisibleAttribute: これにより、形式が UI に表示されます
```
[Export(typeof(EditorFormatDefinition))]
[Name("MarkerFormatDefinition/HighlightWordFormatDefinition")]
[UserVisible(true)]
internal class HighlightWordFormatDefinition : MarkerFormatDefinition
{

}
```
HighlightWordFormatDefinition のコンストラクターで、その表示名と外観を定義します。 Background プロパティで塗りつぶしの色を定義し、Foreground プロパティで境界線の色を定義します。
```
public HighlightWordFormatDefinition()
{
    this.BackgroundColor = Colors.LightBlue;
    this.ForegroundColor = Colors.DarkBlue;
    this.DisplayName = "Highlight Word";
    this.ZOrder = 5;
}
```
HighlightWordTag のコンストラクターで、作成した形式定義の名前を渡します。
```
public HighlightWordTag() : base("MarkerFormatDefinition/HighlightWordFormatDefinition") { }
```

ITagger を実装する

次の手順は ITagger<T> インターフェイスの実装です。このインターフェイスでは、テキストの強調表示やその他の視覚効果を提供するタグを、特定のテキストバッファーに割り当てます。

タガーを実装するには

種類が HighlightWordTag の ITagger<T> を実装するクラスを作成し、その名前を HighlightWordTagger にします。
```
internal class HighlightWordTagger : ITagger<HighlightWordTag>
{

}
```
次のプライベートフィールドとプロパティをクラスに追加します。
- 現在のテキストビューに対応する ITextView。
- テキストビューの基になるテキストバッファーに対応する ITextBuffer。
- テキストの検索に使用される ITextSearchService。
- テキスト範囲内で移動するためのメソッドを含む ITextStructureNavigator。
- 強調表示する単語のセットを含む NormalizedSnapshotSpanCollection。
- 現在の単語に対応する SnapshotSpan。
- キャレットの現在の位置に対応する SnapshotPoint。
- ロックオブジェクト。
```
ITextView View { get; set; }
ITextBuffer SourceBuffer { get; set; }
ITextSearchService TextSearchService { get; set; }
ITextStructureNavigator TextStructureNavigator { get; set; }
NormalizedSnapshotSpanCollection WordSpans { get; set; }
SnapshotSpan? CurrentWord { get; set; }
SnapshotPoint RequestedPoint { get; set; }
object updateLock = new object();
```

前に一覧表示したプロパティを初期化し、LayoutChanged および PositionChanged イベントハンドラーを追加するコンストラクターを追加します。

public HighlightWordTagger(ITextView view, ITextBuffer sourceBuffer, ITextSearchService textSearchService,
ITextStructureNavigator textStructureNavigator)
{
    this.View = view;
    this.SourceBuffer = sourceBuffer;
    this.TextSearchService = textSearchService;
    this.TextStructureNavigator = textStructureNavigator;
    this.WordSpans = new NormalizedSnapshotSpanCollection();
    this.CurrentWord = null;
    this.View.Caret.PositionChanged += CaretPositionChanged;
    this.View.LayoutChanged += ViewLayoutChanged;
}

どちらのイベントハンドラーも UpdateAtCaretPosition メソッドを呼び出します。

void ViewLayoutChanged(object sender, TextViewLayoutChangedEventArgs e)
{
    // If a new snapshot wasn't generated, then skip this layout 
    if (e.NewSnapshot != e.OldSnapshot)
    {
        UpdateAtCaretPosition(View.Caret.Position);
    }
}

void CaretPositionChanged(object sender, CaretPositionChangedEventArgs e)
{
    UpdateAtCaretPosition(e.NewPosition);
}

また、更新メソッドによって呼び出されるTagsChanged イベントも追加する必要があります。

public event EventHandler<SnapshotSpanEventArgs> TagsChanged;

Public Event TagsChanged(ByVal sender As Object, ByVal e As SnapshotSpanEventArgs) _
    Implements ITagger(Of HighlightWordTag).TagsChanged

UpdateAtCaretPosition() メソッドでは、カーソルが置かれている単語と一致するすべての単語をテキストバッファー内で検索し、見つかったそれぞれの単語に対応する SnapshotSpan オブジェクトの一覧を構築します。続いて SynchronousUpdate が呼び出され、これによって TagsChanged イベントが発生します。

void UpdateAtCaretPosition(CaretPosition caretPosition)
{
    SnapshotPoint? point = caretPosition.Point.GetPoint(SourceBuffer, caretPosition.Affinity);

    if (!point.HasValue)
        return;

    // If the new caret position is still within the current word (and on the same snapshot), we don't need to check it 
    if (CurrentWord.HasValue
        && CurrentWord.Value.Snapshot == View.TextSnapshot
        && point.Value >= CurrentWord.Value.Start
        && point.Value <= CurrentWord.Value.End)
    {
        return;
    }

    RequestedPoint = point.Value;
    UpdateWordAdornments();
}

void UpdateWordAdornments()
{
    SnapshotPoint currentRequest = RequestedPoint;
    List<SnapshotSpan> wordSpans = new List<SnapshotSpan>();
    //Find all words in the buffer like the one the caret is on
    TextExtent word = TextStructureNavigator.GetExtentOfWord(currentRequest);
    bool foundWord = true;
    //If we've selected something not worth highlighting, we might have missed a "word" by a little bit
    if (!WordExtentIsValid(currentRequest, word))
    {
        //Before we retry, make sure it is worthwhile 
        if (word.Span.Start != currentRequest
             || currentRequest == currentRequest.GetContainingLine().Start
             || char.IsWhiteSpace((currentRequest - 1).GetChar()))
        {
            foundWord = false;
        }
        else
        {
            // Try again, one character previous.  
            //If the caret is at the end of a word, pick up the word.
            word = TextStructureNavigator.GetExtentOfWord(currentRequest - 1);

            //If the word still isn't valid, we're done 
            if (!WordExtentIsValid(currentRequest, word))
                foundWord = false;
        }
    }

    if (!foundWord)
    {
        //If we couldn't find a word, clear out the existing markers
        SynchronousUpdate(currentRequest, new NormalizedSnapshotSpanCollection(), null);
        return;
    }

    SnapshotSpan currentWord = word.Span;
    //If this is the current word, and the caret moved within a word, we're done. 
    if (CurrentWord.HasValue && currentWord == CurrentWord)
        return;

    //Find the new spans
    FindData findData = new FindData(currentWord.GetText(), currentWord.Snapshot);
    findData.FindOptions = FindOptions.WholeWord | FindOptions.MatchCase;

    wordSpans.AddRange(TextSearchService.FindAll(findData));

    //If another change hasn't happened, do a real update 
    if (currentRequest == RequestedPoint)
        SynchronousUpdate(currentRequest, new NormalizedSnapshotSpanCollection(wordSpans), currentWord);
}
static bool WordExtentIsValid(SnapshotPoint currentRequest, TextExtent word)
{
    return word.IsSignificant
        && currentRequest.Snapshot.GetText(word.Span).Any(c => char.IsLetter(c));
}

SynchronousUpdate により、WordSpans および CurrentWord プロパティで同期更新が実行され、TagsChanged イベントが発生します。

void SynchronousUpdate(SnapshotPoint currentRequest, NormalizedSnapshotSpanCollection newSpans, SnapshotSpan? newCurrentWord)
{
    lock (updateLock)
    {
        if (currentRequest != RequestedPoint)
            return;

        WordSpans = newSpans;
        CurrentWord = newCurrentWord;

        var tempEvent = TagsChanged;
        if (tempEvent != null)
            tempEvent(this, new SnapshotSpanEventArgs(new SnapshotSpan(SourceBuffer.CurrentSnapshot, 0, SourceBuffer.CurrentSnapshot.Length)));
    }
}

GetTags メソッドを実装する必要があります。このメソッドでは、SnapshotSpan オブジェクトのコレクションが取得され、タグの範囲の列挙体が返されます。

C# では、このメソッドを yield 列挙子として実装します。これにより、タグのレイジー評価 (つまり、個々の項目がアクセスされたときのみのセットの評価) を行えるようになります。 Visual BASIC では、一覧にタグを追加して、一覧を返します。

ここで、メソッドにより、青い背景を表示する "blue" TextMarkerTag を持った TagSpan<T> オブジェクトが返されます。

public IEnumerable<ITagSpan<HighlightWordTag>> GetTags(NormalizedSnapshotSpanCollection spans)
{
    if (CurrentWord == null)
        yield break;

    // Hold on to a "snapshot" of the word spans and current word, so that we maintain the same
    // collection throughout
    SnapshotSpan currentWord = CurrentWord.Value;
    NormalizedSnapshotSpanCollection wordSpans = WordSpans;

    if (spans.Count == 0 || wordSpans.Count == 0)
        yield break;

    // If the requested snapshot isn't the same as the one our words are on, translate our spans to the expected snapshot 
    if (spans[0].Snapshot != wordSpans[0].Snapshot)
    {
        wordSpans = new NormalizedSnapshotSpanCollection(
            wordSpans.Select(span => span.TranslateTo(spans[0].Snapshot, SpanTrackingMode.EdgeExclusive)));

        currentWord = currentWord.TranslateTo(spans[0].Snapshot, SpanTrackingMode.EdgeExclusive);
    }

    // First, yield back the word the cursor is under (if it overlaps) 
    // Note that we'll yield back the same word again in the wordspans collection; 
    // the duplication here is expected. 
    if (spans.OverlapsWith(new NormalizedSnapshotSpanCollection(currentWord)))
        yield return new TagSpan<HighlightWordTag>(currentWord, new HighlightWordTag());

    // Second, yield all the other words in the file 
    foreach (SnapshotSpan span in NormalizedSnapshotSpanCollection.Overlap(spans, wordSpans))
    {
        yield return new TagSpan<HighlightWordTag>(span, new HighlightWordTag());
    }
}

タガープロバイダーを作成する

タガーを作成するには、IViewTaggerProvider を実装する必要があります。このクラスは、MEF コンポーネントパーツであるため、この拡張機能が認識されるように正しい属性を設定する必要があります。

Note

MEF の詳細については、「Managed Extensibility Framework (MEF)」を参照してださい。

タガープロバイダーを作成するには

IViewTaggerProvider を実装する、HighlightWordTaggerProvider という名前のクラスを作成し、ContentTypeAttribute として "text"、TagTypeAttribute として TextMarkerTag を指定してそれをエクスポートします。
```
[Export(typeof(IViewTaggerProvider))]
[ContentType("text")]
[TagType(typeof(TextMarkerTag))]
internal class HighlightWordTaggerProvider : IViewTaggerProvider
{ }
```
タグをインスタンス化するには、ITextSearchService と ITextStructureNavigatorSelectorService という 2 つのエディターサービスをインポートする必要があります。
```
[Import]
internal ITextSearchService TextSearchService { get; set; }

[Import]
internal ITextStructureNavigatorSelectorService TextStructureNavigatorSelector { get; set; }
```

HighlightWordTagger のインスタンスを返すための CreateTagger メソッドを実装します。

public ITagger<T> CreateTagger<T>(ITextView textView, ITextBuffer buffer) where T : ITag
{
    //provide highlighting only on the top buffer 
    if (textView.TextBuffer != buffer)
        return null;

    ITextStructureNavigator textStructureNavigator =
        TextStructureNavigatorSelector.GetTextStructureNavigator(buffer);

    return new HighlightWordTagger(textView, buffer, TextSearchService, textStructureNavigator) as ITagger<T>;
}

コードのビルドとテスト

このコードをテストするには、HighlightWordTest ソリューションをビルドし、実験用インスタンスで実行します。

HighlightWordTest ソリューションをビルドしてテストするには

ソリューションをビルドします。
デバッガーでこのプロジェクトを実行すると、Visual Studio の 2 つ目のインスタンスが起動されます。
テキストファイルを作成し、単語が繰り返されるテキスト ("hello hello hello" など) を入力します。
"hello" のいずれかの出現箇所にカーソルを置きます。すべての出現箇所が青色で強調表示されます。

チュートリアル: コンテンツタイプとファイル名拡張子とをリンクさせる

次の方法で共有

チュートリアル: テキストを強調表示する

MEF プロジェクトを作成する

TextMarkerTag を定義する

TextMarkerTag と MarkerFormatDefinition を定義するには

ITagger を実装する

タガーを実装するには

タガープロバイダーを作成する

タガープロバイダーを作成するには

コードのビルドとテスト

HighlightWordTest ソリューションをビルドしてテストするには

その他のリソース

次の方法で共有

チュートリアル: テキストを強調表示する

MEF プロジェクトを作成する

TextMarkerTag を定義する

TextMarkerTag と MarkerFormatDefinition を定義するには

ITagger を実装する

タガーを実装するには

タガー プロバイダーを作成する

タガー プロバイダーを作成するには

コードのビルドとテスト

HighlightWordTest ソリューションをビルドしてテストするには

関連するコンテンツ

その他のリソース

タガープロバイダーを作成する

タガープロバイダーを作成するには