Foxit PDF SDK
|
Public Member Functions | |
FreeText () | |
Constructor. | |
FreeText (Annot annot) | |
Constructor, with parent class object. More... | |
void | AllowTextOverflow (bool is_text_overflow) |
Decide whether to allow the text of freetext to overflow or not. More... | |
Alignment | GetAlignment () |
Markup.EndingStyle | GetCalloutLineEndingStyle () |
Get line ending style of the start point in a callout line. More... | |
PointFArray | GetCalloutLinePoints () |
Get a point of callout line points. More... | |
DefaultAppearance | GetDefaultAppearance () |
Get default appearance data. More... | |
int | GetFillColor () |
Get fill color. More... | |
RectF | GetInnerRect () |
Get the inner rectangle. More... | |
Rotation | GetRotation () |
Get current rotation value (in clockwise). More... | |
Matrix2D | GetTextMatrix () |
void | Rotate (Rotation rotation) |
Rotate current annotation from current state with specified rotation value (in clockwise). More... | |
void | SetAlignment (Alignment alignment) |
void | SetCalloutLineEndingStyle (Markup.EndingStyle ending_style) |
Set line ending style of the start point in a callout line. More... | |
void | SetCalloutLinePoints (PointFArray point_array) |
Set points for callout line. More... | |
bool | SetDefaultAppearance (DefaultAppearance default_ap) |
Set default appearance data. More... | |
void | SetFillColor (int fill_color) |
Set fill color. More... | |
void | SetInnerRect (RectF inner_rect) |
Set the inner rectangle. More... | |
void | SetRotation (Rotation rotation) |
Set rotation value (in clockwise). More... | |
void | SetTextMatrix (Matrix2D text_matrix) |
![]() | |
Markup (Annot annot) | |
Constructor, with parent class object. More... | |
Markup () | |
Constructor. | |
Note | AddReply () |
Add a new reply to the end of reply list. More... | |
void | AddRichText (string content, RichTextStyle style) |
Add a new rich text string to the end. More... | |
Note | AddStateAnnot (string title, Markup.StateModel model, Markup.State state) |
Add a new state annotation. More... | |
DateTime | GetCreationDateTime () |
Get creation date time. More... | |
MarkupArray | GetGroupElements () |
Get an element (as markup annotation) from the group that current markup annotation belongs to. More... | |
Markup | GetGroupHeader () |
Get the header annotation (as primary annotation) of the group that current markup annotation belongs to. More... | |
string | GetIntent () |
Get intent name. More... | |
float | GetOpacity () |
Get opacity value. More... | |
Popup | GetPopup () |
Get related pop-up annotation. More... | |
Note | GetReply (int index) |
Get a reply by index. More... | |
int | GetReplyCount () |
Count all replies. More... | |
string | GetRichTextContent (int index) |
Get text string of a rich text string specified by index. More... | |
int | GetRichTextCount () |
Get the count of rich text strings. More... | |
RichTextStyle | GetRichTextStyle (int index) |
Get style data of a rich text string specified by index. More... | |
NoteArray | GetStateAnnots (Markup.StateModel model) |
Get all state annotations in a specified state model. More... | |
string | GetSubject () |
Get subject string. More... | |
string | GetTitle () |
Get title string. More... | |
void | InsertRichText (int index, string content, RichTextStyle style) |
Insert a new rich text string to the place which is specified by index. More... | |
bool | IsGrouped () |
Check whether current markup annotation is in a group or not. More... | |
bool | RemoveAllReplies () |
Remove all the replies. More... | |
bool | RemoveAllStateAnnots () |
Remove all the state annotations. More... | |
bool | RemovePopup () |
Remove related pop-up annotation. More... | |
bool | RemoveReply (int index) |
Remove a reply by index. More... | |
void | RemoveRichText (int index) |
Remove a rich text string specified by index. More... | |
void | SetCreationDateTime (DateTime date_time) |
Set creation date time. More... | |
void | SetIntent (string intent) |
Set intent name. More... | |
void | SetOpacity (float opacity) |
Set opacity value. More... | |
void | SetPopup (Popup popup) |
Set related pop-up annotation. More... | |
void | SetRichTextContent (int index, string content) |
Set text string of a rich text string specified by index. More... | |
void | SetRichTextStyle (int index, RichTextStyle style) |
Set style data of a rich text string specified by index. More... | |
void | SetSubject (string subject) |
Set subject string. More... | |
void | SetTitle (string title) |
Set title string. More... | |
bool | Ungroup () |
Ungroup current markup annotation from the group it belongs to. More... | |
![]() | |
Annot (PDFPage page, PDFDictionary annot_dict) | |
Constructor, with PDF page and annotation's PDF dictionary. More... | |
Annot (Annot annot) | |
Constructor, with another annotation object. More... | |
Annot () | |
Constructor. | |
PDFStream | GetAppearanceStream (Annot.AppearanceType type, string appearance_state) |
Get annotation's appearance stream with specified type and state. More... | |
int | GetBorderColor () |
Get border color. More... | |
BorderInfo | GetBorderInfo () |
Get border information. More... | |
string | GetContent () |
Get content. More... | |
RectI | GetDeviceRect (Matrix2D matrix) |
Get annotation rectangle in device coordinate system. More... | |
PDFDictionary | GetDict () |
Get annotation's dictionary object. More... | |
Matrix2D | GetDisplayMatrix (Matrix2D page_display_matrix) |
Get the display matrix, from PDF coordinate system to targeted device coordinate system. More... | |
int | GetFlags () |
Get annotation flags. More... | |
int | GetIndex () |
Get the index of current annotation in the page which current annotation belongs to. More... | |
DateTime | GetModifiedDateTime () |
Get last modified date time. More... | |
PDFDictionary | GetOptionalContent () |
Get the PDF dictionary of annotation's optional content. More... | |
PDFPage | GetPage () |
Get the related PDF page. More... | |
RectF | GetRect () |
Get rectangle, in PDF coordinate system. More... | |
Annot.Type | GetType () |
Get actual annotation type of current annotation. More... | |
string | GetUniqueID () |
Get unique ID. More... | |
bool | HasProperty (Annot.Property property) |
Whether current annotation has the specified annotation's property. More... | |
bool | IsEmpty () |
Check whether current object is empty or not. More... | |
bool | IsMarkup () |
Check if current annotation is a markup annotation. More... | |
bool | Move (RectF rect) |
Move current annotation to a new position, specified by a new rectangle in [PDF coordinate system] (foxit.pdf.PDFPage). More... | |
bool | RemoveProperty (Annot.Property property) |
Remove a specified annotation's property. More... | |
bool | ResetAppearanceStream () |
Reset appearance stream. More... | |
void | SetBorderColor (int color) |
Set border color. More... | |
void | SetBorderInfo (BorderInfo border) |
Set border information. More... | |
void | SetContent (string content) |
Set content. More... | |
void | SetFlags (int flags) |
Set annotation flags. More... | |
void | SetModifiedDateTime (DateTime date_time) |
Set last modified date time. More... | |
void | SetUniqueID (string unique_id) |
Set unique ID. More... | |
A free text annotation displays text directly on the page. So free text annotation does not need a related pop-up annotation to show the text.
Free text annotation is a kind of markup annotation, so class FreeText is derived from class Markup , and also offers functions to get/set free text annotation's properties and reset appearance stream of a free text annotation.
|
inline |
Constructor, with parent class object.
[in] | annot | Parent class object. |
|
inline |
Decide whether to allow the text of freetext to overflow or not.
For callout object and textbox object, if this function is not called,text of callout or textbox is allowed to overflow by default. For typewriter object, if this function is not called, text of typerwriter is not allowed to overflow by default.
[in] | is_text_overflow | A boolean value to decide whether text content is allowed to overflow or not when the size of the freetext rectangle is smaller than the size of the text content:
|
|
inline |
This property has effect on free text annotation's appearance.
|
inline |
Get line ending style of the start point in a callout line.
Only when the intent name of a free text annotation is "FreeTextCallout", this free text annotation can have line ending style property, and this property has effect on this kind of free text annotation's appearance.
|
inline |
Get a point of callout line points.
Only when the intent name of a free text annotation is "FreeTextCallout", this free text annotation can have callout line points property, and this property has effect on this kind of free text annotation's appearance. For a callout line, it can contain 2 or 3 points:
|
inline |
Get default appearance data.
This property has effect on free text annotation's appearance. Default appearance data can be used in formatting text.
|
inline |
Get fill color.
This property has effect on free text annotation's appearance. Fill color is used to fill the background of text box, and also for some callout line ending styles:
"Square", "Circle", "Diamond", "ClosedArrow", "RClosedArrow".
|
inline |
Get the inner rectangle.
This property has effect on free text annotation's appearance. For a free text annotation, inner rectangle is where the annotation's text should be displayed. The inner rectangle could be just the same as or less than the annotation's rectangle, and should never be larger than annotation's rectangle.
|
inline |
Get current rotation value (in clockwise).
|
inline |
This property has effect on free text annotation's appearance. This property can be used to change the skew of text's display.
|
inline |
Rotate current annotation from current state with specified rotation value (in clockwise).
[in] | rotation | Rotation value which represents the degree used to rotate current annotation from current state in clockwise. Please refer to values starting from foxit.common.Rotation.e_Rotation0 and this should be one of these values except foxit.common.Rotation.e_RotationUnknown . Specially, if the input value is foxit.common.Rotation.e_Rotation0 (which means not to rotate current annotation), current function will do nothing. |
|
inline |
This property has effect on free text annotation's appearance. If user wants the new alignment has effect on annotation's appearance, please call function Annot.ResetAppearanceStream after setting new alignment.
[in] | alignment | The new alignment value. Please refer to values starting from foxit.common.Alignment.e_AlignmentLeft and this should be one of these values. If other values is used to set, foxit.common.Alignment.e_AlignmentLeft will be used by default. |
|
inline |
Set line ending style of the start point in a callout line.
Only when the intent name of a free text annotation is "FreeTextCallout", this free text annotation can have line ending style property, and this property has effect on this kind of free text annotation's appearance.
If user wants the new line ending style has effect on annotation's appearance, please call function Annot.ResetAppearanceStream after setting new line ending style.
[in] | ending_style | The line ending style for the start point to be set. Please refer to values starting from foxit.pdf.annots.Markup.EndingStyle.e_EndingStyleNone and this should be one of these values. |
|
inline |
Set points for callout line.
Only when the intent name of a free text annotation is "FreeTextCallout", this free text annotation can have callout line points property, and this property has effect on this kind of free text annotation's appearance. For a callout line, it can contain 2 or 3 points:
If user wants the new callout line points has effect on annotation's appearance, please call function Annot.ResetAppearanceStream after setting new callout line points.
[in] | point_array | New point array that specifies the starting point, knee point(if any) and ending point of the callout line. The count of elements should be 2 or 3: 2 points meand starting point and ending point; 3 points means the startign point, knee point and ending point. If the count of elements is above 3, only the first 3 points will be used to set callout line. |
|
inline |
Set default appearance data.
This property has effect on free text annotation's appearance. Default appearance data can be used in formatting text.
If user wants the new default appearance data has effect on annotation's appearance, please call function Annot.ResetAppearanceStream after setting new default appearance data.
[in] | default_ap | The new default appearance data to be set. flags of input data can be used to decide which information is/are to be updated with the new data; for those no updated data, they will keep to use old data. |
|
inline |
Set fill color.
This property has effect on free text annotation's appearance. Fill color is used to fill the background of text box, and also for some callout line ending styles:
"Square", "Circle", "Diamond", "ClosedArrow", "RClosedArrow".
If user wants the new fill color has effect on annotation's appearance, please call function Annot.ResetAppearanceStream after setting new fill color.
[in] | fill_color | New fill color to be set. Format: 0xRRGGBB. |
|
inline |
Set the inner rectangle.
This property has effect on free text annotation's appearance. For a free text annotation, inner rectangle is where the annotation's text should be displayed. The inner rectangle could be just the same as or less than the annotation's rectangle, and should never be larger than annotation's rectangle.
If user wants the new inner rectangle has effect on annotation's appearance, please call function Annot.ResetAppearanceStream after setting new inner rectangle.
[in] | inner_rect | New inner rectangle to be set. It should be same as or less than annotation's rectangle. |
|
inline |
Set rotation value (in clockwise).
This property has effect on free text annotation's appearance. If user wants the new rotation has effect on annotation's appearance, please call function Annot.ResetAppearanceStream after setting new rotation.
[in] | rotation | New rotation value (in clockwise) to be set to current free text annotation. Please refer to values starting from foxit.common.Rotation.e_Rotation0 and this should be one of these values except foxit.common.Rotation.e_RotationUnknown . |
|
inline |
This property has effect on free text annotation's appearance. This property can be used to change the skew of text's display.
If user wants the new text matrix has effect on annotation's appearance, please call function Annot.ResetAppearanceStream after setting new text matrix.
[in] | text_matrix | The new text matrix. |