FreeText Class |
A free text annotation (PDF 1.3) 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 shall be always visible.
Inheritance HierarchyNamespace: pdftron.PDF.Annots
Assembly: pdftron (in pdftron.dll) Version: 255.255.255.255
Syntaxpublic sealed class FreeText : IClosable, IAnnot, IMarkup
The FreeText type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | FreeText | Creates an FreeText annotation and initialize it using given Cos/SDF object.
|
Methods| Name | Description | |
|---|---|---|
| Close | |
 | Create | Creates a new FreeText annotation, in the specified document.
|
| DeleteCustomData | Deletes custom data associated with the given key.
|
| Equals | (Inherited from Object.) |
| Flatten | Flatten/Merge the existing annotation appearances with the page content and
delete this annotation from a given page.
Annotation 'flattening' refers to the operation that changes active annotations
(such as markup, widgets, 3D models, etc.) into a static area that is part of the
PDF document, just like the other text and images in the document.
|
| GetAnnotType | Gets the type.
|
| GetAppearance | Gets the annotation’s appearance for the given combination of annotation
and appearance states.
|
| GetAppearance(AnnotAnnotationState) | Gets the annotation’s appearance for the given combination of annotation
and appearance states.
|
| GetAppearance(AnnotAnnotationState, String) | Gets the annotation’s appearance for the given combination of annotation
and appearance states.
|
| GetBorderEffect | Gets the Border Effect of the Markup Annotation.
|
| GetBorderEffectIntensity | Sets the Border Effect of the Markup Annotation.
(Optional; PDF 1.5 )
|
| GetBorderStyle | Gets the border style for the annotation. Typically used for Link annotations.
|
| GetCalloutLinePoints | Gets p1 of the callout line points of the FreeText annotation.
|
| GetColorAsCMYK | Gets an annotation's color.
|
| GetColorAsGray | Gets an annotation's color.
|
| GetColorAsRGB | Gets the annotation’s active appearance state.
|
| GetColorCompNum | Gets the color space the annotation's color is represented in.
|
| GetContentRect | Gets the inner bounding rectangle of the Square.
(Optional; PDF 1.5)
|
| GetContents | Gets the contents.
|
| GetCreationDates | Gets the creation date of the Markup Annotation
|
| GetCustomData | Returns custom data associated with the given key.
|
| GetDate | Gets an annotation's last modified date.
|
| GetDefaultAppearance | Gets the default appearance of the FreeText annotation.
|
| GetEndingStyle | Gets the ending style of the callout line of the FreeText Annotation.
|
| GetFlag | Gets the flag.
|
| GetFontSize | Returns the font size of the FreeText Annotation.
|
| GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
| GetIntentName | Gets the Intent name as an entry from the enum "IntentName"
of the annnotation type.
|
| GetInteriorColor | Sets the interior color of the Square.
(Optional; PDF 1.4 )
|
| GetInteriorColorCompNum | Gets the number indicating interior color space of the Square.
|
| GetLineColor | Returns the line and border color of the FreeText Annotation.
|
| GetLineColorCompNum | Returns the number of color components in the line and border color
of the FreeText Annotation.
|
| GetOpacity | Gets the contant opacity value corresponding to the annotation.
|
| GetOptionalContent | Gets optional content of an annotation.
|
| GetPadding | Gets the rectangle difference of the Square.
(Optional; PDF 1.5)
|
| GetPage | Gets the page the annotation is associated with.
|
| GetPopup | Gets the Popup object associated with this Markup annotation.
|
| GetQuaddingFormat | Gets the quading format of the FreeText annotation.
|
| GetRect | Gets the rect.
|
| GetRotation | Gets the rotation value of the annotation.The Rotation specifies the number of degrees by which the
annotation shall be rotated counterclockwise relative to the page.
The value shall be a multiple of 90.
|
| GetSDFObj | Gets the SDFObj.
|
| GetStructParent | Gets the struct parent of an annotation.
(Required if the annotation is a structural content item; PDF 1.3)
|
| GetSubject | Gets subject of the Markup Annotation.
|
| GetTextColor | Returns the text color of the FreeText Annotation.
|
| GetTextColorCompNum | Returns the number of color components in the line and border color
of the FreeText Annotation.
|
| GetTitle | Gets the title of the Markup Annotation.
|
| GetTriggerAction | Get the Action associated with the selected Annot Trigger event
|
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| GetUniqueID | Gets the unique ID.
|
| IsMarkup | Checks if is markup.
|
| IsValid | Checks if is valid.
|
| RefreshAppearance | Regenerates the appearance stream for the annotation.
This method can be used to auto-generate the annotation appearance after creating
or modifying the annotation without providing an explicit appearance or
setting the "NeedAppearances" flag in the AcroForm dictionary.
|
| RefreshAppearance(RefreshOptions) | A version of RefreshAppearance allowing custom options to make slight tweaks in behaviour.
|
| RemoveAppearance | Removes the annotation's appearance
|
| RemoveAppearance(AnnotAnnotationState) | Removes the annotation's appearance for the given combination of annotation
and appearance states.
|
| RemoveAppearance(AnnotAnnotationState, String) | Removes the annotation's appearance for the given combination of annotation
and appearance states.
|
| Resize | Resize.
|
| SetAppearance(Obj) | Sets the annotation’s appearance for the given combination of annotation
and appearance states.
(Optional; PDF 1.2)
|
| SetAppearance(Obj, AnnotAnnotationState) | Removes the annotation's appearance for the given combination of annotation
and appearance states.
|
| SetAppearance(Obj, AnnotAnnotationState, String) | Sets the annotation’s appearance for the given combination of annotation
and appearance states.
(Optional; PDF 1.2)
|
| SetBorderEffectIntensity | Sets the Border Effect Intensity of the Markup Annotation.
(Optional; valid only if Border effect is Cloudy)
|
| SetBorderStyle | Sets the border style for the annotation. Typically used for Link annotations.
|
| SetCalloutLinePoints(Point, Point) | Sets the callout line points of the FreeText annotation.
(Optional; meaningful only if IT is FreeTextCallout; PDF 1.6)
|
| SetCalloutLinePoints(Point, Point, Point) | Sets the callout line points of the FreeText annotation.
(Optional; meaningful only if IT is FreeTextCallout; PDF 1.6)
|
| SetColor(ColorPt) | Sets an annotation's color.
(Optional; PDF 1.1)
|
| SetColor(ColorPt, Int32) | Sets an annotation's color.
(Optional; PDF 1.1)
|
| SetContentRect | Sets the inner bounding rectangle of the Square.
(Optional; PDF 1.5)
|
| SetContents | Sets the contents.
|
| SetCreationDates | Sets the creation date of the Markup Annotation.
(Optional; PDF 1.5 )
|
| SetCustomData | Sets the custom data associated with the specified key.
|
| SetDate | Sets an annotation's last modified date.
|
| SetDateToNow |
Sets an annotation's modification date and time to the current time.
This corresponds to the value of the "M" field of annotation dictionary(PDF 1.1)
|
| SetDefaultAppearance | Sets the default appearance of the FreeText annotation.
|
| SetEndingStyle(String) | Sets the ending style of the callout line of the FreeText Annotation.
(Optional; meaningful only if CL is present; PDF 1.6)
|
| SetEndingStyle(LineEndingStyle) | Sets the ending style of the callout line of the FreeText Annotation.
(Optional; meaningful only if CL is present; PDF 1.6)
|
| SetFlag | Sets the value of given Flag.
|
| SetFontSize | Sets the font size of the FreeText Annotation.
|
| SetIntentName | Sets the Intent name as an entry from the enum "IntentName"
of the annnotation type.
(Optional; PDF 1.4)
|
| SetIntentName(FreeTextIntentName) | Sets the Intent name as an entry from the enum "IntentName"
of the annnotation type.
(Optional; PDF 1.4)
|
| SetInteriorColor | Gets the interior color of the Square.
|
| SetLineColor | Sets the line and border color of the FreeText Annotation.
|
| SetOpacity | Sets the contant opacity value corresponding to the annotation.
(Optional; PDF 1.4 )
|
| SetOptionalContent | Sets optional content of an annotation.
(Optional, PDF1.5).
|
| SetPadding | Sets the rectangle difference of the Square.
(Optional; PDF 1.5)
|
| SetPage | Sets the reference to a page the annotation is associated with.
(Optional PDF 1.3; not used in FDF files)
|
| SetPopup | Sets the Popup object associated with this Markup annotation.
(Optional; PDF 1.3 )
|
| SetQuaddingFormat | Sets the quading format of the FreeText annotation.
(Optional; PDF 1.4)
|
| SetRect | Sets the size and location of an annotation on its page.
|
| SetRotation | Sets the rotation value of the annotation.The Rotation specifies the number of degrees by which the
annotation shall be rotated counterclockwise relative to the page.
The value shall be a multiple of 90.
(Optional)
|
| SetStructParent | Sets the struct parent of an annotation.
(Required if the annotation is a structural content item; PDF 1.3)
|
| SetSubject | Sets subject of the Markup Annotation.
(Optional; PDF 1.5 )
|
| SetTextColor | Sets the text color of the FreeText Annotation.
|
| SetTitle | Sets the title of the Markup Annotation.
(Optional; PDF 1.1)
|
| SetUniqueID | Sets the unique identifier for this annotation.
|
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
See Also