public final class FreeTextAnnotation extends MarkupAnnotation
Represents a free text annotation that displays text directly on the page. Unlike an ordinary text annotation, a free text annotation has no open or closed state; instead of being displayed in a pop-up window, the text is always visible.
_disableUpdateAppearance| Constructor and Description |
|---|
FreeTextAnnotation(IDocument document,
DefaultAppearance appearance)
Constructor to use with Generator.
|
FreeTextAnnotation(Page page,
Rectangle rect,
DefaultAppearance appearance)
Creates new FreeText annotation on the specified page.
|
| Modifier and Type | Method and Description |
|---|---|
void |
accept(AnnotationSelector visitor)
Accepts visitor object to process the annotation.
|
int |
getAnnotationType()
Gets type of annotation.
|
Point[] |
getCallout()
Array of point specifying callout line.
|
String |
getDefaultAppearance()
Gets the default appearance string to be used in formatting the text.
|
DefaultAppearance |
getDefaultAppearanceObject()
Object which represents default appearance of FreeText annotation.
|
String |
getDefaultStyle()
Gets a default style string.
|
int |
getEndingStyle()
Gets line ending style for line ending point.
|
int |
getIntent()
Gets the intent of the free text annotation.
|
int |
getJustification()
Gets a code specifying the form of quadding (justification) to be used in displaying the
annotation's text.
|
int |
getRotate()
Angle of annotation rotation.
|
int |
getStartingStyle()
Gets or sets line ending style for line ending point.
|
Rectangle |
getTextRectangle()
Rectangle describing the numerical differences between two rectangles: the Rect entry of the annotation
and a rectangle contained within that rectangle.
|
TextStyle |
getTextStyle()
Gets or sets style of the text in appearance. when text style is changed, text appearance is
updated.
|
void |
setCallout(Point[] value)
Array of point specifying callout line.
|
void |
setDefaultAppearance(String value)
Sets the default appearance string to be used in formatting the text.
|
void |
setDefaultStyle(String value)
Sets a default style string.
|
void |
setEndingStyle(int value)
Sets line ending style for line ending point.
|
void |
setIntent(int value)
Sets the intent of the free text annotation.
|
void |
setJustification(int value)
Sets a code specifying the form of quadding (justification) to be used in displaying the
annotation's text.
|
void |
setRotate(int value)
Angle of annotation rotation.
|
void |
setStartingStyle(int value)
Gets or sets line ending style for line ending point.
|
void |
setTextRectangle(Rectangle value)
Rectangle describing the numerical differences between two rectangles: the Rect entry of the annotation
and a rectangle contained within that rectangle.
|
void |
setTextStyle(TextStyle value)
Sets style of the text in appearance. when text style is changed, text appearance is updated.
|
getCreationDate, getInReplyTo, getOpacity, getPopup, getReplyType, getRichText, getSubject, getTitle, setInReplyTo, setOpacity, setPopup, setReplyType, setRichText, setSubject, setTitlecreateAnnotation, flatten, getActiveState, getAlignment, getAppearance, getBorder, getCharacteristics, getColor, getContents, getEngineDict, getEngineObj, getFlags, getFullName, getHeight, getHorizontalAlignment_Annotation_New, getModified, getModifiedInternal, getName, getNormalAppearance, getPage, getPageIndex, getPageIndex, getPdfActions, getRect, getRectangle, getStates, getWidth, initialize, isUpdateAppearanceOnConvert, isUseFontSubset, setActiveState, setAlignment, setBorder, setColor, setContents, setFlags, setHeight, setHorizontalAlignment_Annotation_New, setModified, setModifiedInternal, setName, setRect, setStructParent, setUpdateAppearanceOnConvert, setUseFontSubset, setWidthdeepClone, getHorizontalAlignment, getHyperlink, getMargin, getVerticalAlignment, getZIndex, isFirstParagraphInColumn, isInLineParagraph, isInNewPage, isKeptWithNext, setFirstParagraphInColumn, setHorizontalAlignment, setHyperlink, setInLineParagraph, setInNewPage, setKeptWithNext, setMargin, setVerticalAlignment, setZIndexpublic FreeTextAnnotation(IDocument document, DefaultAppearance appearance)
Constructor to use with Generator.
document - Document where annotation will be created.appearance - Default Appearancepublic FreeTextAnnotation(Page page, Rectangle rect, DefaultAppearance appearance)
Creates new FreeText annotation on the specified page.
page - The document's page where annotation should be created.rect - The annotation rectangle, defining the location of the annotation on the page.appearance - The default appearance string to be used in formatting the text.public final int getStartingStyle()
Gets or sets line ending style for line ending point. OThis property is obsolete, please use EndingStyle.
public final void setStartingStyle(int value)
Gets or sets line ending style for line ending point. OThis property is obsolete, please use EndingStyle.
value - LineEnding elementpublic int getEndingStyle()
Gets line ending style for line ending point.
LineEndingpublic void setEndingStyle(int value)
Sets line ending style for line ending point.
value - LineEnding valueLineEndingpublic int getJustification()
Gets a code specifying the form of quadding (justification) to be used in displaying the annotation's text.
Justificationpublic void setJustification(int value)
Sets a code specifying the form of quadding (justification) to be used in displaying the annotation's text.
value - int valueJustificationpublic void accept(AnnotationSelector visitor)
Accepts visitor object to process the annotation.
accept in class Annotationvisitor - Visitor object.public String getDefaultAppearance()
Gets the default appearance string to be used in formatting the text.
public void setDefaultAppearance(String value)
Sets the default appearance string to be used in formatting the text.
value - String valuepublic final DefaultAppearance getDefaultAppearanceObject()
Object which represents default appearance of FreeText annotation.
public int getIntent()
Gets the intent of the free text annotation.
FreeTextIntentpublic void setIntent(int value)
Sets the intent of the free text annotation.
value - int valueFreeTextIntentpublic String getDefaultStyle()
Gets a default style string.
public void setDefaultStyle(String value)
Sets a default style string.
value - String valuepublic TextStyle getTextStyle()
Gets or sets style of the text in appearance. when text style is changed, text appearance is updated.
public void setTextStyle(TextStyle value)
Sets style of the text in appearance. when text style is changed, text appearance is updated.
value - TextStyle objectpublic int getRotate()
Angle of annotation rotation.
Rotationpublic void setRotate(int value)
Angle of annotation rotation.
value - Rotation elementRotationpublic int getAnnotationType()
Gets type of annotation.
getAnnotationType in class AnnotationAnnotationTypepublic final Point[] getCallout()
Array of point specifying callout line.
public final void setCallout(Point[] value)
Array of point specifying callout line.
value - array of Pointpublic final Rectangle getTextRectangle()
Rectangle describing the numerical differences between two rectangles: the Rect entry of the annotation and a rectangle contained within that rectangle. The inner rectangle is where the annotation�s text should be displayed.
public final void setTextRectangle(Rectangle value)
Rectangle describing the numerical differences between two rectangles: the Rect entry of the annotation and a rectangle contained within that rectangle. The inner rectangle is where the annotation�s text should be displayed.
value - Rectangle instance