Class Annotations.FreeTextAnnotation
Extends
Annotations.IPathAnnotation.
| Constructor Attributes | Constructor Name and Description |
|---|---|
|
Represents a free text annotation.
|
| Field Attributes | Field Name and Description |
|---|---|
|
The horizontal alignment of the annotation's text (left, right, center)
|
|
|
The color of the text in the annotation
|
- Fields borrowed from class Annotations.Annotation:
- Author, Custom, DateModified, elementName, Height, Hidden, Id, IsAdded, IsDeleted, IsModified, NoMove, NoResize, NoRotate, NoZoom, PageNumber, Subject, Width, X, Y
| Method Attributes | Method Name and Description |
|---|---|
|
Gets the intent of the FreeText annotation e.g.
|
|
|
Get the rectangle difference of the annotation bounding rect and the text rect
|
|
|
Gets the start style of the line.
|
|
|
setIntent(intent)
Sets the intent of the FreeText annotation
|
|
|
setPadding(rect)
Sets the rectangle difference of the annotation bounding rect and the text rect
|
|
|
setStartStyle(startStyle)
Sets the start style of the line.
|
- Methods borrowed from class Annotations.IPathAnnotation:
- addPathPoint, adjustRect, getPath, getPathPoint, popPath, setPathPoint
- Methods borrowed from class Annotations.Annotation:
- deserialize, draw, GetBottom, getContents, GetCustom, getFlag, GetHeight, GetLeft, GetPageNumber, GetPopupComment, getRect, getRectPadding, getReplies, GetRight, GetTop, GetWidth, GetX, GetY, isReply, resize, serialize, setContents, SetCustom, setFlag, SetHeight, SetPageNumber, SetPopupComment, setRect, SetWidth, SetX, SetY
Field Detail
{string}
TextAlign
The horizontal alignment of the annotation's text (left, right, center)
{Annotations.Color}
TextColor
The color of the text in the annotation
Method Detail
{string}
getIntent()
Gets the intent of the FreeText annotation e.g. FreeTextCallout
- Returns:
- {string} The intent of the annotation
{Annotations.Rect}
getPadding()
Get the rectangle difference of the annotation bounding rect and the text rect
- Returns:
- {Annotations.Rect} the rectangle difference
{string}
getStartStyle()
Gets the start style of the line. Only applicable for callout annotations
- Returns:
- {string} The start style
setIntent(intent)
Sets the intent of the FreeText annotation
- Parameters:
- {string} intent
- The new intent for the annotation
setPadding(rect)
Sets the rectangle difference of the annotation bounding rect and the text rect
- Parameters:
- {Annotations.Rect} rect
- The new rectangle difference
setStartStyle(startStyle)
Sets the start style of the line. Only applicable for callout annotations.
- Parameters:
- {string} startStyle
- The starting style