Show / Hide Table of Contents

Class Highlight

Text markup annotations shall appear as highlights, underlines, strikeouts (all PDF 1.3), or jagged (“squiggly”) underlines (PDF 1.4) in the text of a document. When opened, they shall display a pop-up window containing the text of the associated note.

Inheritance
System.Object
Annot
Markup
TextMarkup
Highlight
Implements
System.IDisposable
Inherited Members
TextMarkup.GetQuadPointCount()
TextMarkup.GetQuadPoint(Int32)
TextMarkup.SetQuadPoint(Int32, QuadPoint)
Markup.GetTitle()
Markup.SetTitle(String)
Markup.GetPopup()
Markup.SetPopup(Popup)
Markup.GetOpacity()
Markup.SetOpacity(Double)
Markup.GetSubject()
Markup.SetSubject(String)
Markup.GetCreationDates()
Markup.SetCreationDates(Date)
Markup.GetBorderEffect()
Markup.SetBorderEffect(Markup.BorderEffect)
Markup.GetBorderEffectIntensity()
Markup.SetBorderEffectIntensity(Double)
Markup.GetInteriorColor()
Markup.GetInteriorColorCompNum()
Markup.SetInteriorColor(ColorPt, Int32)
Markup.GetContentRect()
Markup.SetContentRect(Rect)
Markup.GetPadding()
Markup.SetPadding(Rect)
Markup.RotateAppearance(Double)
Annot.Dispose()
Annot.Dispose(Boolean)
Annot.GetHandleInternal()
Annot.GetRefHandleInternal()
Annot.CreateInternal(IntPtr, Object)
Annot.Create(SDFDoc, Annot.Type, Rect)
Annot.op_Assign(Annot)
Annot.Equals(Object)
Annot.IsValid()
Annot.GetSDFObj()
Annot.GetType()
Annot.IsMarkup()
Annot.GetRect()
Annot.GetVisibleContentBox()
Annot.SetRect(Rect)
Annot.GetContents()
Annot.SetContents(String)
Annot.GetPage()
Annot.SetPage(Page)
Annot.GetUniqueID()
Annot.SetUniqueID(String)
Annot.GetDate()
Annot.SetDate(Date)
Annot.GetFlag(Annot.Flag)
Annot.SetFlag(Annot.Flag, Boolean)
Annot.GetBorderStyle()
Annot.SetBorderStyle(Annot.BorderStyle)
Annot.GetAppearance()
Annot.GetAppearance(Annot.AnnotationState)
Annot.GetAppearance(Annot.AnnotationState, String)
Annot.SetAppearance(Obj)
Annot.SetAppearance(Obj, Annot.AnnotationState)
Annot.SetAppearance(Obj, Annot.AnnotationState, String)
Annot.RemoveAppearance()
Annot.RemoveAppearance(Annot.AnnotationState)
Annot.RemoveAppearance(Annot.AnnotationState, String)
Annot.Flatten(Page)
Annot.GetActiveAppearanceState()
Annot.SetActiveAppearanceState(String)
Annot.GetColorAsRGB()
Annot.GetColorAsCMYK()
Annot.GetColorAsGray()
Annot.GetColorCompNum()
Annot.SetColor(ColorPt, Int32)
Annot.SetColor(ColorPt)
Annot.GetStructParent()
Annot.SetStructParent(Int32)
Annot.GetOptionalContent()
Annot.SetOptionalContent(Obj)
Annot.Resize(Rect)
Annot.GetRotation()
Annot.SetRotation(Int32)
Annot.RefreshAppearance()
Annot.GetCustomData(String)
Annot.SetCustomData(String, String)
Annot.DeleteCustomData(String)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.MemberwiseClone()
System.Object.ToString()
System.Object.ReferenceEquals(System.Object, System.Object)
Namespace: pdftron.PDF.Annots
Assembly: PDFNetiOS.dll
Syntax
public class Highlight : TextMarkup, IDisposable

Constructors

Highlight(Annot)

Creates a Highlight annotation and initialize it using given annotation object.

Declaration
public Highlight(Annot ann)
Parameters
Type Name Description
Annot ann

the annot

Remarks

The constructor does not copy any data, but is instead the logical equivalent of a type cast.

Exceptions
Type Condition
PDFNetException

PDFNetException the PDFNet exception

Highlight(Obj)

Creates a Highlight annotation and initialize it using given Cos/SDF object.

Declaration
public Highlight(Obj d)
Parameters
Type Name Description
Obj d

the d

Remarks

The constructor does not copy any data, but is instead the logical equivalent of a type cast.

Methods

Create(SDFDoc, Rect)

Creates a new Highlight annotation, in the specified document.

Declaration
public static Highlight Create(SDFDoc doc, Rect pos)
Parameters
Type Name Description
SDFDoc doc

A document to which the Popup annotation is added.

Rect pos

A rectangle specifying the Popup annotation's bounds, specified in user space coordinates.

Returns
Type Description
Highlight

A newly created blank Highlight annotation.

Exceptions
Type Condition
PDFNetException

PDFNetException the PDFNet exception

Finalize()

Releases all resources used by the Highlight

Declaration
protected void Finalize()

Implements

System.IDisposable
In This Article
Back to top Generated by DocFX