Creates a highlight annotation on the current selection of the viewer control associated with the specified AnnotationService.

Namespace: FirstFloor.Documents.Annotations
Assembly: FirstFloor.Documents (in FirstFloor.Documents.dll) Version: 2.5.0.0 (2.5.1.0)

Syntax

C#
public static Annotation CreateHighlightForSelection(
	AnnotationService service,
	string author,
	Nullable<Color> highlightBackground
)
Visual Basic
Public Shared Function CreateHighlightForSelection ( _
	service As AnnotationService, _
	author As String, _
	highlightBackground As Nullable(Of Color) _
) As Annotation
Visual C++
public:
static Annotation^ CreateHighlightForSelection(
	AnnotationService^ service, 
	String^ author, 
	Nullable<Color> highlightBackground
)

Parameters

service
Type: FirstFloor.Documents.Annotations..::..AnnotationService
The service.
author
Type: System..::..String
The author of the annotation.
highlightBackground
Type: System..::..Nullable<(Of <(<'Color>)>)>
The color to use to draw the highlight over the selected content.

Return Value

The created highlight annotation.

Remarks

If the current text selection is empty, null is returned.

See Also