Back to Devexpress

PdfLinkAnnotationFacade.HighlightMode Property

officefileapi-devexpress-dot-pdf-dot-pdflinkannotationfacade.md

latest3.5 KB
Original Source

PdfLinkAnnotationFacade.HighlightMode Property

Gets or sets the annotation’s highlight mode activated when the mouse button is pressed or held down inside the annotation’s active area.

Namespace : DevExpress.Pdf

Assembly : DevExpress.Pdf.v25.2.Core.dll

NuGet Package : DevExpress.Pdf.Core

Declaration

csharp
public PdfAnnotationHighlightingMode HighlightMode { get; set; }
vb
Public Property HighlightMode As PdfAnnotationHighlightingMode

Property Value

TypeDescription
PdfAnnotationHighlightingMode

Indicates the annotation highlight mode.

|

Available values:

NameDescription
None

No highlight.

| | Invert |

Invert the contents of the annotation rectangle.

| | Outline |

Invert the annotation’s border.

| | Push |

Display the annotation as if it was pushed below the surface of the page.

| | Toggle |

Display the annotation’s down appearance.

|

The following code snippets (auto-collected from DevExpress Examples) contain references to the HighlightMode property.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

pdf-document-api-add-link-to-page/CS/AddLinkToPage/Program.cs#L36

csharp
linkPageFacade.AddLinkAnnotation(linkRectangle, destination);
    linkAnnotation.HighlightMode = PdfAnnotationHighlightingMode.Push;
}

pdf-document-api-add-link-to-uri/CS/AddLinkToUri/Program.cs#L30

csharp
uriAnnotation.Name = "link1";
    uriAnnotation.HighlightMode = PdfAnnotationHighlightingMode.Push;
}

pdf-document-api-add-link-to-page/VB/AddLinkToPage/Program.vb#L33

vb
Dim linkAnnotation As PdfLinkAnnotationFacade = linkPageFacade.AddLinkAnnotation(linkRectangle, destination)
    linkAnnotation.HighlightMode = PdfAnnotationHighlightingMode.Push
End If

pdf-document-api-add-link-to-uri/VB/AddLinkToUri/Program.vb#L28

vb
uriAnnotation.Name = "link1"
    uriAnnotation.HighlightMode = PdfAnnotationHighlightingMode.Push
End If

See Also

PdfLinkAnnotationFacade Class

PdfLinkAnnotationFacade Members

DevExpress.Pdf Namespace