AnnotationHelper.ClearHighlightsForSelection(AnnotationService) Method

Reference

Definition

Namespace:: System.Windows.Annotations

Assembly:: PresentationFramework.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Clears all highlight annotations from the current selection of the viewer control associated with the given AnnotationService.

public:
 static void ClearHighlightsForSelection(System::Windows::Annotations::AnnotationService ^ service);

public static void ClearHighlightsForSelection (System.Windows.Annotations.AnnotationService service);

static member ClearHighlightsForSelection : System.Windows.Annotations.AnnotationService -> unit

Public Shared Sub ClearHighlightsForSelection (service As AnnotationService)

Parameters

service: AnnotationService

The annotation service from which to remove highlight annotations.

Exceptions

ArgumentNullException

service is null.

ArgumentException

service is not enabled.

Remarks

If the current viewer selection is zero length or does not overlap any annotation highlights, ClearHighlightsForSelection performs no operation.

If the current viewer selection overlaps a highlight only partially, only the portion of the selection that overlaps is cleared and the unselected portion of the annotation highlight remains.

Applies to

Jaa