Click or drag to resize
Pdftools logo

Highlight Class

An text highlighting annotation

Inheritance Hierarchy
SystemObject
  PdfTools.Toolbox.InternalNativeBase
    PdfTools.Toolbox.InternalNativeObject
      PdfTools.Toolbox.Pdf.AnnotationsAnnotation
        PdfTools.Toolbox.Pdf.AnnotationsMarkupAnnotation
          PdfTools.Toolbox.Pdf.AnnotationsTextMarkup
            PdfTools.Toolbox.Pdf.AnnotationsHighlight

Namespace: PdfTools.Toolbox.Pdf.Annotations
Assembly: PdfTools.Toolbox (in PdfTools.Toolbox.dll) Version: 1.0.0+fdabb036503e9f99735634a6d4f5be875399e9f5
Syntax
C#
public class Highlight : TextMarkup

The Highlight type exposes the following members.

Properties
 NameDescription
Public propertyBoundingBox

The location on the page


(Inherited from Annotation)
Public propertyHidden

The annotation's visibility

If then the annotation is present, but is invisible and not available for user interaction. Depending on the NoPrint property it will, however, still be visible when printing.
(Inherited from Annotation)
Public propertyId

The annotation identifier

A text string uniquely identifying it among all the annotations on its page. When creating annotations using the SDK, a unique ID is set automatically.
(Inherited from Annotation)
Public propertyInfo

The information content of this markup


(Inherited from MarkupAnnotation)
Public propertyLocked

Whether the markup annotation can be modified

This does not restrict modification of the markup annotation's content.
(Inherited from MarkupAnnotation)
Public propertyMarkupArea

The markup area

This list of Quadrilaterals defines the markup area on the page.
(Inherited from TextMarkup)
Public propertyNoPrint

The annotation's visibility when printing

If then the annotation is not present in a print output of the document.
(Inherited from Annotation)
Public propertyNoRotate

The annotation's rotation behavior

If then the annotation's visual appearance does not rotate with the rotation set in a PDF viewer.
(Inherited from Annotation)
Public propertyNoZoom

The annotation's scaling behavior

If then the annotation's visual appearance does not scale with the zoom factor of a PDF viewer.
(Inherited from Annotation)
Public propertyPaint

The paint the annotation and the popup


(Inherited from TextMarkup)
Public propertyPopup

The pop-up


(Inherited from TextMarkup)
Public propertyReplies

The replies to this markup


(Inherited from MarkupAnnotation)
Top
Methods
 NameDescription
Public methodStatic memberCreateFromQuadrilaterals

Create a new highlight with defined area

The highlight area is defined by the given markupArea. The returned object is associated with the targetDocument but not yet part of any page. It can be added to a page's list of annotations.
Public methodEquals
(Inherited from NativeObject)
Public methodGetHashCode
(Inherited from NativeObject)
Top
See Also