AnnotationHelper.CreateHighlightForSelection Método

Definição

Cria uma anotação de realce na seleção atual do controle de visualizador associado ao AnnotationService especificado.

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

Parâmetros

service
AnnotationService

O serviço de anotação a ser usado para criar a anotação de realce.

author
String

O autor da anotação.

highlightBrush
Brush

O pincel a ser usado para desenhar o realce sobre o conteúdo selecionado.

Retornos

Annotation

A anotação de realce; ou null, se não houver nenhum conteúdo selecionado para realçar.

Exceções

service é null.

service não está habilitado.

- ou - highlightBrush não é um SolidColorBrush.

O controle do visualizador não contém nenhuma seleção de conteúdo.

Comentários

A anotação de realce é ancorada no conteúdo definido pela seleção atual do DocumentViewerBaseDocumentViewer, , FlowDocumentPageViewerou FlowDocumentScrollViewerFlowDocumentReader controle especificado para o AnnotationService construtor.

Se não houver nenhum conteúdo selecionado (o comprimento da seleção for de comprimento zero), nenhuma anotação será criada e uma InvalidOperationException será lançada.

author pode ser especificado, pois null nesse caso nenhum autor é definido.

Se highlightBrush for null, o pincel de realce padrão da anotação service fornecida é usado.

A anotação service determinada deve ser habilitada por meio de uma chamada para AnnotationService.Enable antes da chamada CreateHighlightForSelection.

Aplica-se a

Confira também