Foxit PDF SDK
|
Public Member Functions | |
Redact () | |
Constructor. | |
Redact (Annot annot) | |
Constructor, with parent class object. More... | |
bool | Apply () |
Apply current redact annotation: remove the text or graphics under annotation rectangle permanently. More... | |
int | GetApplyFillColor () |
Get the filling color which is used for rollover appearance and will be used after redaction is applied. More... | |
DefaultAppearance | GetDefaultAppearance () |
Get default appearance data. More... | |
int | GetFillColor () |
Get fill color. More... | |
string | GetOverlayText () |
Get the overlay text. More... | |
Alignment | GetOverlayTextAlignment () |
Get alignment value of overlay text. More... | |
QuadPointsArray | GetQuadPoints () |
Get quadrilaterals. More... | |
void | SetApplyFillColor (int fill_color) |
Set the filling color which is used for rollover appearance and will be used after redaction is applied. More... | |
bool | SetDefaultAppearance (DefaultAppearance default_ap) |
Set default appearance data. More... | |
void | SetFillColor (int fill_color) |
Set fill color. More... | |
void | SetOverlayText (string overlay_text) |
Set the overlay text. More... | |
void | SetOverlayTextAlignment (Alignment alignment) |
Set alignment value of overlay text. 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... | |
Class Redact represents a Foxit custom annotation type (not a standard annotation type). This kind of annotation is used to mark some content of a PDF page and these content will be removed once the redact annotations are applied. An existed redact annotation can be retrieved from PDF page by functions pdf.PDFPage.GetAnnot and pdf.PDFPage.GetAnnotAtPoint . A new redact annotation would be returned by function addon.Redaction.MarkRedactAnnot , instead of pdf.PDFPage.AddAnnot .
Class foxit.pdf.annots.Redact is derived from class Markup and also offers functions to get/set markup annotation's basic properties of a redact annotation. Currently, Annot.SetBorderInfo can be used for a redact annotation, but will not have any effect on the appearance of redact annotation. Besides, redact annotation cannot be moved by function Annot.Move .
|
inline |
Constructor, with parent class object.
[in] | annot | Parent class object. |
|
inline |
Apply current redact annotation: remove the text or graphics under annotation rectangle permanently.
Once this functions is called successfully, all page content(text object, image object, and path object) within area of current redact annotation rectangle will be removed permanently. And current redact annotation will be removed (with its pop-up annotation if any) as well - that means current annotation object will be useless when this function succeeds. Area of current redact annotation rectangle will be filled by the color specified by function pdf.annots.Redact.SetApplyFillColor .
|
inline |
Get the filling color which is used for rollover appearance and will be used after redaction is applied.
|
inline |
Get default appearance data.
This property has effect on redact annotation's appearance. Default appearance data can be used in formatting text.
|
inline |
Get fill color.
|
inline |
Get the overlay text.
|
inline |
Get alignment value of overlay text.
This property has effect on the overlay text of redact annotation's appearance.
|
inline |
Get quadrilaterals.
The order of points in a quadrilateral should be:
|
inline |
Set the filling color which is used for rollover appearance and will be used after redaction is applied.
[in] | fill_color | New fill color to be set. Format: 0xRRGGBB. |
|
inline |
Set default appearance data.
This property has effect on redact 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.
[in] | fill_color | New fill color to be set. Format: 0xRRGGBB. |
|
inline |
Set the overlay text.
[in] | overlay_text | The overlay text string to be set. |
|
inline |
Set alignment value of overlay text.
This property has effect on the overlay text of redact annotation's appearance. If user wants the new alignment has effect on the overlay text of 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. |
|
inline |
Set quadrilaterals.
This property has effect on the redact annotation's appearance.The order of points in a quadrilateral should be :
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. |