Public Member Functions | |
Ink () | |
Constructor. | |
Ink (Annot annot) | |
Constructor, with parent class object. More... | |
Path | GetInkList () |
Get ink list data. More... | |
void | SetInkList (Path ink_list) |
Set ink list data. 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... | |
Note | AddStateAnnot (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... | |
Note | GetStateAnnot (Markup.StateModel model, int index) |
Get a state annotation, under a specified state model. More... | |
int | GetStateAnnotCount (Markup.StateModel model) |
Get the count of state annotations, under a specified state model. More... | |
string | GetSubject () |
Get subject string. More... | |
string | GetTitle () |
Get title string. 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 state annotations. More... | |
bool | RemoveReply (int index) |
Remove a reply 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 | 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 Annot 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 (bool is_transform_icon, Matrix2D matrix) |
Get annotation rectangle in device coordinate system. More... | |
PDFDictionary | GetDict () |
Get annotation's dictionary object. 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 | 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 . 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... | |
An ink annotation represents a freehand "scribble" composed of one or more disjoint paths. Ink annotation is a kind of markup annotation, so class Ink is derived from class Markup, offers functions to get/set ink annotation's properties and also and reset appearance stream of an ink annotation.
For a ink annotation, ink list property is required. So please ensure that an ink annotation has valid ink list property before resetting its appearance stream; otherwise the ink annotation cannot be reset appearance stream.
|
inline |
Constructor, with parent class object.
annot | Parent class object. |
|
inline |
Get ink list data.
Ink list property is required for an ink annotation and this property has effect on ink annotation's appearance. The ink list contains one or more stroked path.
In Foxit PDF SDK, class Path is used to represent the ink list data, but the point types for Path object have been specially simplified for ink list. Only e_TypeMoveTo and e_TypeLineTo types are used for points in the ink list:
a point with type e_TypeMoveTo means that this point is the start point of a stroked path. Usually the first in Path object should be this type.
a point with type e_TypeLineTo means that this point is in a stroked path, which is started by a point with type e_TypeMoveTo, and when function Ink::ResetAppearanceStream is called, Foxit PDF SDK will connect this point with other points by curves.
Operations such as move the ink annotation, or set a new ink path to this annotation will update the ink path data, so that the previous returned Path object would become invalid. In this case, user should call this function again to obtain the new Path object.
|
inline |
Set ink list data.
Ink list property is required for an ink annotation and this property has effect on ink annotation's appearance. The ink list contains one or more stroked path.
In Foxit PDF SDK, class Path is used to represent the ink list data, but the point types for Path object have been specially simplified for ink list. Only e_TypeMoveTo and e_TypeLineTo types are used for points in the ink list:
a point with type e_TypeMoveTo means that this point is the start point of a stroked path. Usually the first in Path object should be this type.
a point with type e_TypeLineTo means that this point is in a stroked path, which is started by a point with with type e_TypeMoveTo, and when function Ink::ResetAppearanceStream is called, Foxit PDF SDK will connect this point with other points by curves.
Specially, if input parameter ink_list contains bezier points (for example, added by function common::Path::CubicBezierTo), the control points will be ignored and only the target point will be used in the ink list data.
User is strongly recommended to pass a valid Path object only with point types e_TypeMoveTo and e_TypeLineTo.
If user wants the effect to be shown in annotation's appearance, please call function Annot::ResetAppearanceStream after this function.
ink_list | New Path object which specifies the new list data. |