ApiHighlightAnnotation

ApiHighlightAnnotation is a subclass of ApiBaseMarkupAnnotation.

Methods

Method	Returns	Description
AddReply	boolean	Adds reply on this annot.
Delete	boolean	Removes annotation from document.
GetAuthorName	string	Gets annotation author name.
GetBorderColor	ApiColor	Gets annotation border color.
GetBorderEffectIntensity	boolean	Gets annotation border effect intensity.
GetBorderEffectStyle	AnnotBorderEffectStyle	Gets annotation border effect style.
GetBorderStyle	AnnotBorderStyle	Gets annotation border style.
GetBorderWidth	pt	Gets annotation border width.
GetClassType	"highlightAnnot"	Returns a type of the ApiHighlightAnnotation class.
GetContents	string	Gets annotation contents.
GetCreationDate	number	Gets annotation creation date.
GetDashPattern	number[]	Gets annotation dash pattern.
GetDisplay	DisplayType	Gets annotation display type.
GetFillColor	ApiColor	Gets annotation fill color.
GetModDate	number	Gets annotation last modification date.
GetOpacity	string	Gets annotation opacity.
GetPosition	Point	Gets annotation position.
GetQuads	Quad[]	Gets quads from current markup annotation.
GetRect	Rect	Sets annotation rect.
GetReplies	ApiTextAnnotation[]	Gets replies on this annot.
GetSubject	string	Gets annotation subject.
GetUniqueName	string	Gets annotation unique name.
SetAuthorName	boolean	Sets annotation author name.
SetBorderColor	boolean	Sets annotation border color.
SetBorderEffectIntensity	boolean	Sets annotation border effect intensity. 💡 Can be applied to circle, square, freeText and polygon annotations
SetBorderEffectStyle	boolean	Sets annotation border effect style. 💡 Can be applied to circle, square, freeText and polygon annotations
SetBorderStyle	boolean	Sets annotation border style.
SetBorderWidth	boolean	Sets annotation border width.
SetContents	boolean	Sets annotation contents.
SetCreationDate	boolean	Sets annotation creation date.
SetDashPattern	boolean	Sets annotation dash pattern. 💡 The border style property must be set to "dashed".
SetDisplay	boolean	Sets annotation display type.
SetFillColor	boolean	Sets annotation fill color.
SetModDate	boolean	Sets annotation last modification date.
SetOpacity	boolean	Sets annotation opacity.
SetPosition	boolean	Sets annotation position.
SetQuads	boolean	Sets quads to current markup annotation.
SetRect	boolean	Sets annotation rect.
SetSubject	boolean	Sets annotation subject.
SetUniqueName	boolean	Sets annotation unique name.