Public Member Functions | |
PSInk () | |
Constructor. | |
PSInk (Annot annot) | |
Constructor, with parent class. | |
![]() | |
Annot (PDFPage page, PDFDictionary annot_dict) | |
Constructor, with PDF page and annotation's PDF dictionary. More... | |
Annot (Annot annot) | |
Constructor, with another annot object. | |
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... | |
Class PSInk represents a Foxit custom annotation type, not a standard annotation type, which is used to store data of pressure sensitive ink to PDF page. An existed PSInk annotation can be retrieved from PDF page by functions pdf::PDFPage::GetAnnot and pdf::PDFPage::GetAnnotAtPoint. A new PSInk annotation would be returned by function PSI::ConvertToPDFAnnot, instead of pdf::PDFPage::AddAnnot.
Class PSInk is derived from class Annot and also offers functions to get/set annotation's basic properties of a PSInk annotation. Currently, some functions (which are to change annotation's related properties) can be called for a PSInk annotation, but will not have any effect on the appearance of PSInk annotation. These functions include Annot::SetBorderInfo, Annot::SetBorderColor, Annot::RemoveProperty.
Besides, currently Foxit PDF SDK does not support to move a PSInk annotation by function Annot::Move. Since PSink is not a standard annotation, so is cannot be added to page by function pdf::PDFPage::AddAnnot; instead, PSInk could be converted from a FSPSI object by function PSI::ConvertToPDFAnnot.