Foxit PDF SDK
|
Public Member Functions | |
TextMarkup () | |
Constructor. | |
TextMarkup (Annot annot) | |
Constructor, with parent class object. More... | |
QuadPointsArray | GetQuadPoints () |
Get quadrilaterals. More... | |
void | SetQuadPoints (QuadPointsArray quad_points_array) |
Set quadrilaterals. More... | |
![]() | |
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 string. 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 | 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... | |
Text markup annotations appear as highlights, underlines, strikeouts, or squiggly lines in the text of a document. Text markup annotations are all markup annotations, so class TextMarkup is derived from class Markup . It is the base class for all PDF text markup annotations. It offers the base functions to get/set text markup annotation's common properties.
Especially, for a text markup annotation, quadrilaterals are required. So please ensure that a text markup annotation has valid quadrilaterals before resetting its appearance stream.
For concrete text markup annotation types, please refer to derived classes.
|
inline |
Constructor, with parent class object.
[in] | annot | Parent class object. |
|
inline |
Get quadrilaterals.
This property has effect on text markup annotation's appearance. The order of points in a quadrilateral should be:
The first point is the point in left-top corner of the quadrilateral.
The second point is the point in right-top corner of the quadrilateral.
The third point is the point in left-bottom corner of the quadrilateral.
The fourth point is the point in right-bottom corner of the quadrilateral.
|
inline |
Set quadrilaterals.
For a text markup annotation, quadrilaterals are required. This property has effect on text markup annotation's appearance. After setting new quadrilaterals, rectangle of current text markup annotation will be updated as well. The order of points in a quadrilateral should be:
The first point is the point in left-top corner of the quadrilateral.
The second point is the point in right-top corner of the quadrilateral.
The third point is the point in left-bottom corner of the quadrilateral.
The fourth point is the point in right-bottom corner of the quadrilateral.
If user wants the new quadrilaterals has effect on annotation's appearance, please call function Annot.ResetAppearanceStream after setting quadrilaterals.
[in] | quad_points_array | A valid array of quadrilaterals. It should not be an empty array. |