ApiFreeTextAnnotation

Class representing a freeText annotation.

ApiFreeTextAnnotation is a subclass of ApiBaseAnnotation.

Methods

The following table lists the available 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 | null | undefined	Gets annotation border color.
GetBorderEffectIntensity	number	Gets annotation border effect intensity.
GetBorderEffectStyle	AnnotBorderEffectStyle	Gets annotation border effect style.
GetBorderStyle	AnnotBorderStyle	Gets annotation border style.
GetBorderWidth	pt	Gets annotation border width.
GetCallout	FreeTextCallout | null | undefined	Gets annot callout.
GetClassType	"freeTextAnnot"	Returns a type of the ApiFreeTextAnnotation class.
GetContent	ApiRichContent	Gets annotation rich content.
GetContents	string | null | undefined	Gets annotation contents.
GetCreationDate	number	Gets annotation creation date.
GetDashPattern	number[]	Gets annotation dash pattern.
GetDisplay	DisplayType	Gets annotation display type.
GetEndStyle	LineEndStyle	Gets a line end style.
GetFillColor	ApiColor | null | undefined	Gets annotation fill color.
GetIntent	FreeTextIntent	Gets intent type of this annotation.
GetInternalId	string	Returns an internal ID of the current annotation.
GetModDate	number	Gets annotation last modification date.
GetOpacity	string	Gets annotation opacity.
GetPosition	Point	Gets annotation position.
GetRect	Rect	Gets annotation rect.
GetRectDiff	Rect	Gets annotation rect difference.
GetReplies	ApiTextAnnotation[]	Gets replies on this annot.
GetSubject	string | null | undefined	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.
SetBorderEffectStyle	boolean	Sets annotation border effect style.
SetBorderStyle	boolean	Sets annotation border style.
SetBorderWidth	boolean	Sets annotation border width.
SetCallout	boolean	Sets annot callout.
SetContents	boolean	Sets annotation contents.
SetCreationDate	boolean	Sets annotation creation date.
SetDashPattern	boolean	Sets annotation dash pattern.
SetDisplay	boolean	Sets annotation display type.
SetEndStyle	boolean	Sets a line end style.
SetFillColor	boolean	Sets annotation fill color.
SetIntent	boolean	Sets intent type for this annotation.
SetModDate	boolean	Sets annotation last modification date.
SetOpacity	boolean	Sets annotation opacity.
SetPosition	boolean	Sets annotation position.
SetRect	boolean	Sets annotation rect.
SetRectDiff	boolean	Sets annotation rect difference.
SetSubject	boolean	Sets annotation subject.
SetUniqueName	boolean	Sets annotation unique name.