AnnotationHelper.CreateHighlightForSelection メソッド

定義

名前空間:
System.Windows.Annotations
アセンブリ:
PresentationFramework.dll

指定した AnnotationServiceに関連付けられているビューアー コントロールの現在の選択範囲に強調表示注釈を作成します。

public:
 static System::Windows::Annotations::Annotation ^ CreateHighlightForSelection(System::Windows::Annotations::AnnotationService ^ service, System::String ^ author, System::Windows::Media::Brush ^ highlightBrush);
public static System.Windows.Annotations.Annotation CreateHighlightForSelection(System.Windows.Annotations.AnnotationService service, string author, System.Windows.Media.Brush highlightBrush);
static member CreateHighlightForSelection : System.Windows.Annotations.AnnotationService * string * System.Windows.Media.Brush -> System.Windows.Annotations.Annotation
Public Shared Function CreateHighlightForSelection (service As AnnotationService, author As String, highlightBrush As Brush) As Annotation

パラメーター

service
AnnotationService

強調表示注釈の作成に使用する注釈サービス。

author
String

注釈の作成者。

highlightBrush
Brush

選択したコンテンツにハイライトを描画するために使用するブラシ。

返品

Annotation

強調表示注釈。または、強調表示するコンテンツが選択されていない場合は nullします。

例外

ArgumentNullException

service は nullです。

ArgumentException

service が有効になっていません。

-または-

highlightBrush SolidColorBrushではありません。

InvalidOperationException

ビューアー コントロールにコンテンツの選択が含まれています。

注釈

強調表示注釈は、AnnotationService コンストラクターに指定されているDocumentViewerBase、DocumentViewer、FlowDocumentPageViewer、FlowDocumentScrollViewer、またはFlowDocumentReader コントロールの現在の選択によって定義されたコンテンツに固定されます。

選択したコンテンツがない場合 (選択の長さが 0 の場合)、注釈は作成されず、 InvalidOperationException がスローされます。

author は、 null として指定できます。その場合、作成者は定義されていません。

highlightBrushがnullされている場合は、指定された注釈serviceの既定の強調表示ブラシが使用されます。

指定された注釈serviceは、CreateHighlightForSelectionを呼び出す前にAnnotationService.Enableを呼び出すことによって有効にする必要があります。

適用対象

こちらもご覧ください