ComPDFKit.Desk

A redact annotation displays text directly on the page.

Gets the areas that should be covered by the redaction annotation.

Gets the text attribute displayed in the specified area after applying the redaction.

Gets the text alignment displayed in the specified area after applying the redaction.

Gets the color used for the redaction’s border in its marked state. Defaults to red.

Gets the fill color displayed in the specified area after applying the redaction. The color is drawn on the specified rect. Defaults to black.

Border width.

Gets the text displayed in the specified area after applying the redaction.

Gets the rectangle of Redact annotation on the page.

Uses the rects property to set the areas that should be covered by the redaction annotation.

Page area list Returns true on success, false on failure

Sets the text attribute displayed in the specified area after applying the redaction.

Text attribute Returns true on success, false on failure

Sets the text alignment displayed in the specified area after applying the redaction.

Text alignmnent Returns true on success, false on failure

Sets border width.

Border width Returns true on success, false on failure

Sets the color used for the redaction’s border in its marked state. Defaults to red.

RGB color value, range0-255 Returns true on success, false on failure

Removes the color used for the redaction’s border in its marked state. Defaults to red.

Sets the fill color displayed in the specified area after applying the redaction. The color is drawn on the specified rect. Defaults to black.

RGB color value, range0-255 Returns true on success, false on failure

Sets the text displayed in the specified area after applying the redaction.

Text content Returns true on success, false on failure

Sets annotation rectangle. The page coordinate system has its origin at the left-bottom corner of the page, with the X-axis on the bottom going to the right, and the Y-axis on the left side going up. The device coordinate system is device dependent. For screen device, its origin is at the left-top corner of the window.

PDF page rectangle area Returns true on success, false on failure

Applies redaction annotation.

Returns true on success, false on failure.

A single checkbox form control which can be toggled to on or off.

Sets the state of CheckBox, true means selected, false otherwise.

State of CheckBox, true means selected, false otherwise. Returns true on success, false on failure

Gets the state of CheckBox, true means selected, false otherwise.

Selected state of CheckBox true if CheckBox is selected, false otherwise

A form control which displays drop-down list. When isEditable() flag is set, it can be accompanied by an editable text box for editing custom value.

Whether Combobox is editable.

Returns whether Combobox is editable

A form field which displays scrollable list with choices.

A simple push button that responds immediately to user input without retaining any state.

Sets response action of PushButtonget. There are multiple subtypes of the action, and different actions are determined according tomore:

Response action of PushButton Returns true on success, false on failure

Gets response action of PushButtonget. There are multiple subtypes of the action, and different actions are determined according tomore:

Returns response of PushButton, more:

Sets PushButton label.

PushButton label Returns true on success, false on failure

Gets PushButton label.

Returns PushButton title

Releases resources. When the object is no longer in use, call this method to release resources.

Multiple RadioButton controls can be a list, when clicking a RadioButton, it is set as selected, others in the list set as unselected. Method to set multiple RadioButton in the same list: Set the fieldName of multiple RadioButton to the same value, such as: radiobutton1.SetFieldName("xxx"); radiobutton2.SetFieldName("xxx"); radiobutton3.SetFieldName("xxx");

Sets whether Radiobutton is selected, true means selected, false otherwise.

Whether it is selected Returns true on success, false on failure

Whether Radiobutton is selected, true means selected, false otherwise.

Returns the selected state of Radiobutton, true: selected, false: unselected.

Represents a signature field in a form. This is usually used to place a signature onto a page using an CPDFInkAnnotation.

Whether signature form is signed.

Whether Signature form is signed

Updates form appearance by text.

Text content of signature Font name of signature text Text color Rotation value, range0,1,2,3 Returns true on success, false on failure

Updates form appearance by image.

Bitmap data of image Image width Image height The zoom rule for filling the image into the form Rotation value, range0,1,2,3 Returns true on success, false on failure

Sets Signature form as signed.

Returns true on success, false on failure

Types of text field.

Text format

Date

A text form field in a PDF form. Allows the user to enter custom text.

Gets the text content of TextField.

Whether to display multiline PDF text fields.

Whether the TextField content display password, password :*****

Gets the text attribute of TextField text, more:

Gets the the text alignment in TextField, more:

Gets the content format of TextField, format type:

Sets the text content of TextField.

Text content Returns true on success, false on failure

Sets to display multiline PDF text fields.

Whether to display multiline PDF text fields. Returns true on success, false on failure

Sets the text attribute of TextField, more:

Text attribute Returns true on success, false on failure

Sets the text alignment of TextField, more:

Text alignment Returns true on success, false on failure

Sets the content format of TextField, format type:

Whether it is date Returns true on success, false on failure

Form type.

PushButton

CheckBox

Radiobutton

TextField

Combobox

Listbox

Signature

Unknown type

Fill type of CheckBox and Radiobutton.

√

Solid circle

Solid diamond

Solid square

Solid star

A visible form control. Every form element has a single parent CPDFWidget. Each form element is associated with a single CPDFAnnotation that is a visual representation of the form element in the document.

Gets form type. Refer to:

Sets internal name for the field.

List name of forms

Gets internal name for the field. If multiple forms have the same internal name, these forms are seen as one list, and their action affect each other. For example, in the CheckBox and Radiobutton list, when a form is set to be selected, others are set to be unselected.

Returns name of form list

Sets form flag.

Form flag Returns true on success, false on failure

Gets form flag.

Returns the form identifier

Sets the form field type.

Form field type Returns true on success, false on failure

Gets the form field type.

Form field type

Sets the background color of the form.

RGB color value Returns true on success, false on failure

Gets the background color of the form.

RGB color value

Sets the border color of the form.

Color Returns true on success, false on failure

Gets the background color of the form.

RGB color value

Sets border style of the form, more:

Border style Returns true on success, false on failure

Gets the border style of the form, more:

Returns the border style of the form

Sets the fill style of CheckBox or Radiobutton; more

Fill style Returns true on success, false on failure

Gets the fill style of CheckBox or Radiobutton; more

Returns true on success, false on failure

Sets fill color of CheckBox or Radiobutton.

Color value of fill content of CheckBox or Radiobutton forms Returns true on success, false on failure

Gets fill color of CheckBox or Radiobutton.

Fill color of CheckBox or Radiobutton

Updates form appearance.

Returns true on success, false on failure

Resets forms.

Returns true on success, false on failure

Parent of Listbox or Combobox forms.

Gets all items in ListBox or Combobox. more:

Returns all items in ListBox or Combobox

Gets the total count of items in ListBox or Combobox forms.

Returns the total count of ListBox or Combobox forms

Sets the index item as selected in ListBox or Combobox.

Index of the selected item Returns true on success, false on failure

Gets the selected items in ListBox or Combobox forms, more:

Returns the selected item in ListBox or Combobox forms

Whether to allow to select multiple items in Listbox.

Returns whether to allow to select multiple items in Listbox.

Inserts item in ListBox or Combobox at the specified index point.

Index value of new items Value of new items Text content of new items Returns true on success, false on failure

Removes item in ListBox or Combobox at the specified index point.

Index value of item to be removed. Returns true on success, false on failure

Content of items in listbox and combobox form.

Value of item.

Text content of item.

Annotation type.

Unknown type.

Note annotation.

Link annotation.

Freetext annotation.

Line annotation.

Square annotation.

Circle annotation.

Polygon annotation.(not support currently)

Polyline annotation.(not support currently)

Highlight annotation.

Underline annotation.

Squiggly annotation.

Strikeout annotation.

Stamp annotation.

not support currently.

Ink annotation

Popup annotation.(not support currently)

File attachment annotation.(not support currently)

Sound annotation.(not support currently)

Movie annotation.(not support currently)

Form form.

Not support currently.

Watermark annotation.(not support currently)

3D annotation.(not support currently)

Not support currently.

Border style of annotation.

Solid line

Dashed line

Not support currently

A enum of flags specifying various characteristics of the annotation. ComPDFKit doesn't support all of those flag settings.

[IGNORED] If set, ignore annotation AP stream if there is no handler available.

If set, do not display or print the annotation or allow it to interact with the user.

[IGNORED] If set, print the annotation when the page is printed.

[IGNORED] If set, don't scale the annotation’s appearance to match the magnification of the page.

[IGNORED] If set, don't rotate the annotation’s appearance to match the rotation of the page.

[IGNORED] If set, don't display the annotation on the screen. (But printing might be allowed)

If set, don’t allow the annotation to be deleted or its properties to be modified, including `contents`. This is ignored for widget annotations (form elements). For widget annotations the `GetIsReadOnly` property of the associated form field should be used instead. This flag only restricts the ComPDFKit UI and does not impact programmatic modification of the annotation.

If set, don’t allow the annotation to be deleted or its properties to be modified, except for `contents`.

[IGNORED] If set, invert the interpretation of the `.noView` flag for certain events.

[IGNORED] If set, don't allow the `contents` of the annotation to be modified by the user.

An annotation associates an object such as a note, sound, or movie with a location on a page of a PDF document, or provides a way to interact with the user by means of the mouse and keyboard.PDF includes a wide variety of standard annotation types. Class Annot is the base class for all kinds of PDF annotations.It offers the base functions to get/set annotation's common properties, to move an annotation or reset appearance stream of an annotation. For concrete annotation types, please refer to derived classes. To get the count of annotations or get/add/remove an annotation, please refer to class CPDFPage. This class object can also be used to construct objects of other classes in order to do some more operation in annotation or access specified information of annotation.

Returns the page that the annotation is associated with.

Gets annotation type.

Whether the object is valid.

Returns true if valid, otherwise false

Releases resources of the object.

Sets rectangle on the page.

Rectangle on the page Returns true on success, false on failure

Gets rectangle on the page.

Page rectangle area

Returns the flag of the annotation.

The flag of the annotation.

Sets the flag of the annotation.

The flag of the annotation. Returns true on success, false on failure.

This is a convenience property that checks for `CPDFAnnotationFlagHidden` in `flags`.

This is a convenience property that checks for `CPDFAnnotationFlagReadOnly` in `flags`.

This is a convenience property that checks for `CPDFAnnotationFlagLocked` in `flags`.

Sets border width of the annotation.

Border width Returns true on success, false on failure.

Gets border width of the annotation.

Annotation border width

Sets annotation color.

RGB color value Returns true on success, false on failure

Gets annotation color.

RGB color

Gets annotation opacity.

Annotation opacity

Sets annotation fill color.

Color Returns true on success, false on failure

Gets annotation fill color.

Color Returns true on success, false on failure

Sets annotation fill color opacity.

Opacity Returns true on success, false on failure

Sets fill color opacity.

Opaicty

Clears fill RGB color.

Returns true on success, false on failure

Clears fill color opacity.

Returns true on success, false on failure

Sets annotation content.

Content Returns true on success, false on failure

Gets annotation content.

Content

Sets the creation date of annotation.

Date Returns true on success, false on failure

Gets the creation date of annotation.

Date

Sets the modification date of annotation.

Date Returns true on success, false on failure

Gets the modification date of annotation.

Date

Sets annotation author.

Author Returns true on success, false on failure

Gets annotation author.

Annotation author

Updates annotation appearance.

Returns true on success, false on failure

Upadates annotation appearance by Bitmap.

Image data Image width Image height Rotation value Returns true on success, false on failure

Renders contents of the annotation to image.

Annotation width Annotation height Image data Appearance type

Renders contents of the annotation to image.

Annotation width Annotation height Image data handle Appearance type

Gets annotation text attribute, more:

Text attribute

Sets text attribute of annotation, more:

Text attribute Returns true on success, false on failure

Gets the author of annotation.

Author

Sets the author of annotation.

Author Returns true on success, false on failure

Removes annotation.

Returns true on success, false on failure

Gets rotation angle of annotaton appearance.

Rotation angle

Circle annotation is an ellipse on the page. Despite the name "circle", a circle annotation can represent either a circle or a oval, which means the width and height of the annotation rectangle need not be equal.

Gets the border color.

Gets the background color.

Gets the border opacity.

Whether the background color exists.

Gets the border width.

Gets annotation rectangle. The page coordinate system has its origin at the left-bottom corner of the page, with the X-axis on the bottom going to the right, and the Y-axis on the left side going up. The device coordinate system is device dependent. For screen device, its origin is at the left-top corner of the window.

Gets the border style.

Gets the line dash array.

Sets the border color.

RGB color value, range0-255 Returns true on success, false on failure

Sets the background color.

RGB color value, range0-255 Returns true on success, false on failure

Sets color opacity.

Color opacity, range0-255 Returns true on success, false on failure

Clears background color.

Returns true on success, false on failure

Sets the border width.

Border width Returns true on success, false on failure

Sets the rectangle of circle on the page.

Rectangle on the page Returns true on success, false on failure

Sets the border style.

Border style Sets the line dash array. Returns true on success, false on failure

Text alignment.

Unknown type.

Left alignment.

Center alignment.

Right alignment.

A free text annotation displays text directly on the page.

Gets Freetext font style, more:

Gets text alignment of Freetext.

Border color.

Background color.

Opacity.

Whether the background color exists.

Border width.

Gets the rectangle of FreeText annotation on the page.

Gets content of FreeText annotation.

Sets Freetext font style, more:

Text attribute Returns true on success, false on failure

Sets text alignment of Freetext.

Text alignmnent Returns true on success, false on failure

Sets border width.

Border width Returns true on success, false on failure

Sets opacity.

Color opacity, range 0-255 Returns true on success, false on failure

Sets border color.

RGB color value, range0-255 Returns true on success, false on failure

Sets background color.

RGB color value, range0-255 Returns true on success, false on failure

Clears background color.

Returns true on success, false on failure

PDF page rectangle area Returns true on success, false on failure

Sets content of FreeText annotation.

Text content Returns true on success, false on failure

Highlight annotation is a kind of text markup annotation, which is shown as a highlight area for the text in a PDF document.

Ink annotation.

Gets color.

Gets opacity.

Gets border width of ink annotation.

Gets the border style.

Gets the line dash array.

Sets color.

RGB color value, range0-255 Returns true on success, false on failure

Sets opacity.

Color opacity, range0-255 Returns true on success, false on failure

Sets border width of ink annotation.

Line width Returns true on success, false on failure

Page rectangle area Returns true on success, false on failure

Sets rectangle of ink annotation on the page.

Rectangle on the page Returns true on success, false on failure

Sets the border style.

Border style Sets the line dash array. Returns true on success, false on failure

Start and end point type of line.

Unknown type

Line(no arrow type)

Hollow arrow type

Solid arrow type

Square type

Circle type

Diamond type

Butt type

Reverse hollow arrow type

Reverse solid arrow type

Slash type

A CPDFLineAnnotation object displays a single line on a page.

Line style for the starting point of the line, more:

Line style for the ending point of the line, more:

Gets line color.

Gets line opacity.

Gets line width.

Gets start point and end point of the line.

Gets border style.

Gets the line dash array.

Sets start point and end point of the line.

Start point End point Returns true on success, false on failure

Sets the line style for the starting point and ending point of the line, more:

Start point type End point type Returns true on success, false on failure

Sets line color.

RGB color value, range0-255 Returns true on success, false on failure

Sets color opacity.

Color opacity, range0-255 Returns true on success, false on failure

Sets line width.

Line width Returns true on success, false on failure

Sets border style.

Line style Sets the line dash array Returns true on success, false on failure

A link annotation represents an action to be performed.

Sets the response action of the link annotation. There are multiple subtypes of the action, and different actions are determined according to, the action type can be obtained through , more:

Response action of link annotation Returns true on success, false on failure

Gets the response action of the link annotation. There are multiple subtypes of the action, and different actions are determined according to, the action type can be obtained through ,more:

Returns the response action of link annotatiion, more:

Gets link information of document, more:

This class is about CPDFDocument, one CPDFDocument class for one document Returns link information of document.

Sets link information of document, more:

This class is about CPDFDocument, one CPDFDocument class for one document. Returns detailed imformation of destination page Returns true on success, false on failure

When the annotation is no longer in use, call this function to release resources.

Markup annotations are used primarily to mark up PDF documents. These annotations have text that appears as part of the annotation and may be displayed in other ways by a viewer application, such as in a Comments pane. Markup base class includes sub class: highlight, underline, strikeout, squiggly.

Gets color.

Gets opacity.

Gets the array of quadrilateral points defining the bounds of the markup.

Gets the rectangle of the annotation on the page.

Sets the array of quadrilateral points defining the bounds of the markup.

Page area list Returns true on success, false on failure

Sets color.

RGB color value,range0-255 Returns true on success, false on failure

Sets opacity.

Color opacity,range0-255 Returns true on success, false on failure

A CPDFMovieAnnotation object contains animated graphics and sound to be presented on the computer screen and through the speakers.

Represents an audio file added to a page. Sound annotations can be created from recording audio using the device's microphone or by importing an existing audio file. Sound annotations are stored inside the PDF file itself. On a page, CPDFSoundAnnotation are represented by an icon, similar to CPDFTextAnnotation.

Whether to contain audio resources.

Returns true if contains, false otherwise.

Sets audio resource.

Audio resource path. Returns whether to successfully set audio resource.

Gets audio resource.

Saved file folder path. Saved file folder name. Returns absolute path of audio resouce file.

Square annotation is a rectangle on the page. Despite the name "square", a square annotation can represent either a square or a rectangle, which means the width and height of the annotation rectangle need not be equal.

Gets border color.

Gets background color.

Gets border opacity.

Whether the background color exists.

Gets border width.

Gets the rectangle of the square on the page.

Gets border style.

Gets the line dash array.

Sets border color.

RGB color value, range0-255 Returns true on success, false on failure

Sets background color.

RGB color value, range0-255 Returns true on success, false on failure

Sets border opacity.

Color opacity, range0-255 Returns true on success, false on failure

Clears background color.

Returns true on success, false on failure

Sets border width.

Border width Returns true on success, false on failure

Sets the rectangle of rectangle on the page.

Rectangle on the page Returns true on success, false on failure

Sets border style.

Border style Dahed line density, valid if border style is dashed line, such as[2,5] Returns true on success, false on failure

A squiggly text underline on the page.

Border style enumeration of text stamp.

Square

Left arrow

Right arrow

None

Color enumeration of text stamp.

Opacity

Red

Green

Blue

Stamp type.

Unknown type

Standard stamp

Image stamp

Text stamp

A stamp annotation displays text or graphics intended to look as if they were stamped on the page with a rubber stamp. A stamp annotation's appearance can be with an icon or a bitmap.

Sets standard stamp type.

Text content Rotation angle Returns true on success, false on failure

Gets standard stamp type.

Returns standard stamp type.

Sets attribute of text stamp.

Text content Date Shape Color Rotation angle Returns true on success, false on failure

Gets attribute of text stamp.

Text content Date Shape Color Returns true on success, false on failure

Sets resources of image stamp.

Image data Image width Image height Rotation angle Returns true on success, false on failure

Gets stamp type.

Stamp type, more

设置图章为伪签名注释，签署之后不能随意修改。

是否为伪签名注释成功返回true,失败返回false

判断图章是否为伪签名图章

是否为伪签名注释

Gets image for the appearance stream of the text stamp.

Text Date Shape Color Width of stamp Height of stamp Width of image Height of image Rotation angle Image data

A strike-out text on the page.

A note (shown as an icon) on the page.

Gets note color.

Gets note opacity.

Sets note color.

RGB color value Returns true on success, false on failure

Sets note opacity.

Opacity Returns true on success, false on failure

Underline annotation is a kind of text markup annotation, which is shown as a underline under the text in a PDF document.

Text attribute helper.

Gets font name.

Gets font size.

Font color.

Constructor function.

Clones current object.

Returns the copy of current object.

Three font types supported

Three font types supported.

Unknown type

Courier font

Helvetica font

Times_Roman font

Gets font name according to fontType, isBold, isItalic, more:

Standard font type Whether it is bold Whether it is iatlic Returns font name

Gets standard font enumeration according to font name, more:

Font name Returns standard font enumeration

Whether it is bold according to font name.

Font name Whether it is bold

Whether it is italic according to font name.

Font name Whether it is italic

Enumeration value of action type, type based on the Adobe PDF Specification (1.7), Table 8.48: Event types.

Unknown type.

Go to a destination in the current document.

(“Go-to remote”) Go to a destination in another document.

(“Go-to embedded”; PDF 1.6) Go to a destination in an embedded file.

Launch an application, usually to open a file.

Begin reading an article thread.

Resolve a uniform resource identifier.

(PDF 1.2) Play a sound.

(PDF 1.2) Play a movie.

(PDF 1.2) Set an annotation’s Hidden flag.

(PDF1.2) Execute an event predefined by the conforming reader.

(PDF 1.2) Send data to a uniform resource locator.

(PDF 1.2) Set fields to their default values.

(PDF 1.2) Import field values from a file.

(PDF 1.3) Execute a JavaScript script.

(PDF 1.5) Set the states of optional content groups.

(PDF 1.5) Controls the playing of multimedia content.

(PDF 1.5) Updates the display of a document, using a transition dictionary.

(PDF 1.6) Set the current view of a 3D annotation

Unlock uop.

Error type.

A PDF action may have sub-actions. When this action is triggered, its sub-actions should also be triggered in turn.

Action handle.

Get action type, more:

Constructor function, used for initialization action.

Event type Event handle

Constructor function, used for creating action.

Event type

Whether the object is valid.

Returns true if valid, otherwise false

Releases resources of the object.

PDF action representing a change to another page.

Constructor function, used for initializing GoTo event.

Action handle

Constructor function, used for creating GoTo event.

Gets the destination associated with the action, more:

CPDFDocument object Destination

Sets the destination associated with the action, more:

CPDFDocument object Target position Returns true on success, false on failure

A remote go-to action is similar to an ordinary go-to event but jumps to a destination in another PDF file instead of the current file.

Constructor function, used for initializing GoToR action.

Action handle

Constructor function, used for creating GoToR action.

Gets the file in which the destination shall be located.

File path

Sets the specified file path of GoToR action.

File path Returns true on success, false on failure.

Gets the destination associated with the action, more:

CPDFDocument object. Destination

Sets the target position of GotoR action, more:

CPDFDocument object. Target position. Returns true on success, false on failure.

JavaScript事件

获取JS内容

JS内容

Launcher事件

获取指定文件路径

文件路径

设置指定文件路径

文件路径

Named action is an action that executes an event predefined by the viewer application. A CPDFNamedAction object represents an action with a defined name.

Constructor function, used for initializing Named action.

Action handle

Constructor function, used for creating Named action.

Gets action name.

Name value.

Sets action name.

重置表单事件,暂未实现

提交事件,暂未实现

Action of link annotation which includes accessing to website and sending mail.

Constructor function, used for initializing Uri action.

Event handle

Constructor function, used for creating Uri action.

Gets URI.

URI value.

Sets URI.

Uri value. Returns true on success, false on failure.

Adds and removes the bates numbers.

Updates the bates numbers.

Returns true on success, false on failure.

Removes the bates numbers.

Returns true on success, false on failure.

Releases CPDFBates object resource.

Adds and removes the header & footer.

Whether object is valid, false means the object resource is released, you cannot use the object to call any method.

Gets the text of the header & footer at the specified index.

the specified index the text of the header & footer

Sets the text of the header & footer at the specified index.

the specified index the text of the header & footer Returns true on success, false on failure.

Gets the font name of the header & footer at the specified index.

the specified index the font name

Sets the font name of the header & footer at the specified index.

the specified index Returns true on success, false on failure.

Gets the font size of the header & footer at the specified index.

the specified index the font size

Sets the font size of the header & footer at the specified index.

the specified index the font size Returns true on success, false on failure.

Gets the font color of the header & footer at the specified index.

the specified index the font color

Sets the font color of the header & footer at the specified index.

the specified index the font color Returns true on success, false on failure.

Gets the margins of the header & footer.

the margins

Sets the margins of the header & footer.

the margins Returns true on success, false on failure.

Gets the start page number of the header & footer.

the start page number

Sets the start page number of the header & footer.

the start page number Returns true on success, false on failure.

Gets the page range of the header & footer by string, such as "0,3,5-7".

the page range

Gets the page range of the header & footer by string, such as "0,3,5-7".

the page range Returns true on success, false on failure.

Updates the header & footer.

Returns true on success, false on failure.

Removes the header & footer.

Returns true on success, false on failure.

Releases header & footer object resource.

File permission related class includes whether to allow printing, modifying and so on.

Whether to allow printing.

Whether to allow high-quality printing.

Whether to allow copying of content to the Pasteboard, such as: text, image, etc.

Whether to allow document changes.

Whether to allow to manage a document by inserting, deleting, and rotating pages.

Whether to allow creating or modifying document annotations, including form field entries.

Whether to allow modifying form field entries even if you can't edit document annotations.

Bookmark.

The page index that the bookmark refers to.

Bookmark title.

Creation date of bookmark.

A CPDFDestination object describes a point on a PDF page.

Destination page index.

The x coordinate of the specified page.

The y coordinate of the specified page.

The page zoom ratio.

Error type enumeration of loading document

Success.

Unknown error.

File not found or could not be opened.

File not in PDF format or corrupted.

Password required or incorrect password.

Unsupported security scheme.

Error page.

PDF/A conformance levels.

Document instance. One CPDFDocument object for one document. This class is used to represent a specified directory, which contains PDF files and user wants to search among these PDF files.

Whether document is encrypted.

Whether the document is locked.

The total count of document pages.

Whether document is repaired.

Error message for the document loading. To determine the error type, use the code to obtain error of type CPDFDocumentError. Except for the CPDFDocumentPasswordError error, other errors cannot open the document. If CPDFDocumentPasswordError, reading the document requires a password.

The path for the document

Gets document name.

Initializes a CPDFDocument object with the contents at the specified URL.

Path of document CPDFDocument object.

Initializes a CPDFDocument object with new PDF.

CPDFDocument object

Attempts to unlock an encrypted document. If the password is correct, this method returns true, else returns false. Once unlocked, you cannot use this function to relock the document.

The password to unlock an encrypted document (you cannot lock an unlocked PDF document by using an incorrect password). If the password is correct, this method returns true, else returns false.

Writes the document to the original path.

Returns true on success, false on failure.

Writes the document to a location specified by the passed-in URL.

Returns true on success, false on failure.

Writes the document to the specified URL after flattening.

Path of the flattened document. Returns true on success, false on failure.

Gets document information.

Document information.

Sets document information.

Document information. Returns true on success, false on failure.

Gets permission information of document.

Permission information.

Gets page size

Page number Page size

Gets outline list of document.

Outline list

Releases resources of the object.

Gets outline root of document.

Outline root

Gets bookmark list of document.

Bookmark list

Adds bookmark

Bookmark object Returns true on success, false on failure

Edits bookmark title at the specified page index.

Page number where bookmark is Bookmark title Returns true on success, false on failure

Removes the bookmark at the specified index.

The specified index. Returns true on success, false on failure.

Returns the bookmark at the specified index. Indexes are zero based. This method will return null if index is out of bounds.

The specified index. The bookmark object.

Inserts a blank page with image at the specified index point. Indexes are zero based. The index must lie within bounds, or be equal to the length of bounds.

The specified index point. The page width. The page height. Image path, if empty create a blank page. Returns true on success, false on failure.

Remove page(s).

The specified index array. Returns true on success, false on failure.

Imports page(s) from another document at the end of the document.

Document that need to be imported. The page range of the imported document, for example :1,3,5; 6-10; Returns true on success, false on failure.

Imports page(s) from another document at the specified index point.

Document that need to be imported. The page range of the imported document, for example :1,3,5; 6-10; The specified index point. Returns true on success, false on failure.

Moves one page to another. This method will return false if either index value is out of bounds.

The start index number. The end index number. Returns true on success, false on failure.

Exchanges one page with another. This method will return false if either index value is out of bounds.

The first exchange index number The second exchange index number Returns true on success, false on failure.

Rotates page at the specified index number.

The specified index number. Rotation Angle value; Value is: -3,-2,-1,0,1,2,3 Returns true on success, false on failure.

Returns a CPDFPage object representing the page at index. Indexes are zero based. This method will return null if index is out of bounds.

The page index Whether to parse. CPDFPage object.

Release page list.

Encrypts document.

User password Permission password Permission

Decrypts document.

The position to save the document after decryption Returns true on success, false on failure

Exports annotations to XFDF document.

The export path. Temporary path. Returns true on success, false on failure.

Imports annotations from XFDF document.

The import path. Temporary path. Returns true on success, false on failure.

Creates watermark.

Watermark type. Watermark object.

Removes all watermarks in the document.

Converts the specified page(s) to image.

Page range, such as:1,3,5;6-10; Save path. Returns true on success, false on failure.

Converts the specified page(s) to text.

Page range, such as:1,3,5;6-10; Save path. Returns true on success, false on failure.

Exports all the images on the page.

Page range, such as:1,3,5;6-10; Save path. Returns true on success, false on failure.

添加页眉页脚

文字数据间距页面范围起始页码

删除页眉页脚

添加贝茨码

文字数据间距页面范围

删除贝茨码

Gets the document’s header & footer.

the document’s header & footer

Gets the document’s bates.

the document’s bates

Gets the document’s background.

the document’s background

压缩初始化

图片质量页码回调委托用于压缩的句柄

压缩开始

压缩句柄保存路径成功返回true,失败返回false

压缩取消

压缩句柄

Gets PDF/A conformance levels.

PDF/A conformance levels.

Converts existing PDF files to PDF/A compliant documents, including PDF/A-1a and PDF/A-1b only. The conversion option analyzes the content of existing PDF files and performs a sequence of modifications in order to produce a PDF/A compliant document. Features that are not suitable for long-term archiving(such as encryption, obsolete compression schemes, missing fonts, or device-dependent color) are replaced with their PDF/A compliant equivalents.Because the conversion process applies only necessary changes to the source file, the information loss is minimal.

PDF/A conformance levels. Path of the converted document. Returns whether to convert successfully.

Applies redaction annotations in current documentation.

Returns true on success, false on failure.

Releases resource of the object.

Releases resources of the specified page or release resources of all page objects if pageIndex is -1

Page index

Basic information of PDF document.

PDF title.

PDF author.

PDF subject.

PDF creator.

PDF producer.

Creation date of PDF.

Recent modification date of PDF.

PDF keywords.

PDF version string.

A document outline (or "table of contents entry"), usually the header of a chapter. Outline objects can be retrieved via ChildList(). They can carry an Action and thus allow quick navigation to document pages, or even external resources.

Outline level

Outline title

Gets all the items within an outline hierarchy.

Whether the object is valid.

Valid ruturns true, otherwise false

Sets outline title

Outline title Returns true on success, false on failure.

Sets the action performed when users click the outline, more:

The action performed when users click the outline Returns true on success, false on failure.

Gets the action performed when users click the outline, more:

The action performed when users click the outline.

Gets the destination associated with the outline, more:

CPDFDocument object. The destination associated with the outline.

Sets the destination associated with the outline, more:

CPDFDocument object. The destination associated with the outline. Returns true on success, false on failure.

Gets the parent outline object of the outline.

Returns the parent outline object of the outline.

Creates an outline object and inserts the outline object at the specified index.

CPDFDocument object. Child item index of outline. The new index object. Returns true on success, false on failure.

Moves child outline to specified index.

CPDFDocument object. Child outline. Specified index. Returns true on success, false on failure.

Removes the outline object from its parent.

CPDFDocument object. Returns true on success, false on failure.

Background type.

Unknown type

Text background

Image background

Vertical alignment.

Unknown type

Align horizontally to left

Align horizontally centered

Align horizontally to right

Vertical alignment.

Unknown type

Align Vertically to the top

Align Vertically centered

Align Vertically to the bottom

Adds and removes the background.

Whether object is valid, false means the object resource is released, you cannot use the object to call any method.

Releases Background object resource.

Gets the type of the background.

the type of the background

Sets the type of the background.

the type of the background Returns true on success, false on failure.

Gets the opacity of the background.

the opacity of the background

Sets the opacity of the background.

the opacity of the background Returns true on success, false on failure.

Gets the scale of the background.

the scale of the background

Sets the scale of the background.

the scale of the background Returns true on success, false on failure.

Gets the rotation angle of the background.

the rotation angle of the background

Sets the rotation angle of the background.

the rotation angle of the background Returns true on success, false on failure.

Gets the horizontal alignment of the background.

the horizontal alignment

Sets the horizontal alignment of the background.

the horizontal alignment Returns true on success, false on failure.

Gets the vertical alignment of the background.

the vertical alignment

Sets the vertical alignment of the background.

the vertical alignment Returns true on success, false on failure.

Gets the horizontal offset of the background.

the horizontal offset

Sets the horizontal offset of the background.

the horizontal offset Returns true on success, false on failure.

Gets the vertical offset of the background.

the vertical offset

Sets the vertical offset of the background.

the vertical offset Returns true on success, false on failure.

Gets whether to support the background to be displayed.

whether to support the background to be displayed

Sets whether to support the background to be displayed.

whether to support the background to be displayed Returns true on success, false on failure.

Gets whether to support the background to be printed.

whether to support the background to be printed

Sets whether to support the background to be printed.

whether to support the background to be printed Returns true on success, false on failure.

Gets the page range of the background by string, such as "0,3,5-7".

the page range for the background

Sets the page range of the background by string, such as "0,3,5-7".

the page range of the background Returns true on success, false on failure.

Gets the image of the background.

the image of the background

Gets the image of the background.

Image resource. Image width. Image height. The zoom rule for filling the image into the background Returns true on success, false on failure.

Gets the color of the background.

the color of the background

Sets the color of the background.

the color of the background Returns true on success, false on failure.

Updates the background.

Returns true on success, false on failure.

Removes the background.

Returns true on success, false on failure.

Quickly pinpoint changes by comparing two versions of a PDF file.

Initialize it with the given two versions of a document. By default, it will generate a comparison document according to the order of pages, starting from the first page of both versions of the document.

The old version of document. The new version of document.

Specifies pages and types to compare.

Sets to replace the highlight color.

Sets to insert the highlight color.

Sets to remove the highlight color.

Saves the comparison document.

Releases CPDFCompareContent object resource.

Overlay Comparison is used to visually compare pages of different documents. It’s helpful for things such as construction plans and detailed drawings, as well as other content that requires precise placement.

Initialize it with the given two versions of a document. and indices of the pages on which the points should be selected in both versions of a document.

The old version of a document. The page range of the old document, for example: 1,3,5,6-10. The new version of a document. The page range of the new document, for example: 1,3,5,6-10.

The old version of document. The new version of document.

Compares the document.

Sets the color that will be used to replace all strokes in the old version of a document.

RGB color value, range 0-255. Returns true on success, false on failure.

Sets the color that will be used to replace all strokes in the new version of a document.

RGB color value, range 0-255. Returns true on success, false on failure.

Sets the opacity that will be used to replace all strokes in the old version of a document.

Opacity value, range 0-1. Returns true on success, false on failure.

Sets the opacity that will be used to replace all strokes in the new version of a document.

Opacity value, range 0-1. Returns true on success, false on failure.

Sets the fill opacity that will be used to replace all strokes in the old version of a document.

Opacity value, range 0-1. Returns true on success, false on failure.

Sets the fill opacity that will be used to replace all strokes in the new version of a document.

Opacity value, range 0-1. Returns true on success, false on failure.

Sets whether the path is filled with white.

Returns true on success, false on failure

Sets the blend mode that will be used when overlaying the new version of a document onto the old version.

Blend mode. Returns true on success, false on failure.

Gets the generated comparison document once the user compares both versions of a document.

The generated document.

Releases CPDFCompareOverlay object resource.

This class is about the information about a result of comparing content.

Gets the type of a result of comparing content.

Gets the old version page index of a result of comparing content.

Gets the new version page index of a result of comparing content.

Gets the old version page range of a result of comparing content.

Gets the new version page range of a result of comparing content.

This class is about the results of comparing content.

Gets the array of the results of comparing text.

Gets the array of the results of comparing image.

Gets the count of removal.

Gets the count of insert.

Gets the count of replacement.

Edit Type.

None.

Text.

Image.

This class is about PDF contents editing.

Gets a list of editing areas of the page.

Whether to obtain it again. A list of editing areas.

Whether the text editing page object is valid.

Returns true for valid, false for invalid.

Releases the text editing page object.

Begins editing PDF contents.

Edit type.

Ends editing PDF contents.

Whether it can be redone.

Returns true if can, false otherwise.

Whether it can be undone.

Returns true if can, false otherwise.

Redo.

Position of text cursor.

Undo.

Position of text cursor.

Creates a new text area.

Rectangle on the page. Font name. Font size. Font color. Text area.

Creates a new image area.

Rectangle on the page. Image resource. Image width. Image height. Image area.

Removes the editing area.

Editing area index.

CPDFPage defines methods used to render PDF pages and work with annotations, text, selections and so on.

Gets the rotation angle for the page in degrees:0,1,2,3

Gets page index.

Gets page size.

Constructor function

CPDFDocument object Page number Whether it needs to be parsed

Whether the object is valid.

Returns true if valid, otherwise false

Gets the count of annotations on the page.

Count of annotations

Releases all annotation resources on the page.

Gets all the annotation collections on the page.

List of all annotations

Render contents of a page to a device independent bitmap.

Zoom level Render range Background color Image data Render flag, set 1 if annotation are to be rendered, 0 for normal display Whether to render form widgets

Render contents of the page to image data.

X coordinate in the upper left corner Y coordinate in the upper left corner Horizontal size (in pixels) for displaying the page. Vertical size (in pixels) for displaying the page. Background color Image data Render flag, set 1 if annotation are to be rendered, 0 for normal display Whether to render form widgets

Render contents of the page at the specified rectangle to image data handle.

Zoom level Render area Background color Image data handle Render flag, set 1 if annotation are to be rendered, 0 for normal display Whether to render form widgets

Render contents of the page to image data handle.

X coordinate in the upper left corner Y coordinate in the upper left corner Horizontal size (in pixels) for displaying the page Vertical size (in pixels) for displaying the page. Background color Image data handle Render flag, set 1 if annotation are to be rendered, 0 for normal display Whether to render form widgets

Gets TextPage, this class is for text related functions, more:

Text page object.

Gets EditPage, this class is for text related functions, more:

Edit page object.

Gets crop rectangle.

Returns crop rectangle.

Releases resources of the page object.

Adds annotations on page according to the type of annotation.

Annotation type Annotation object

Creates form widgets on the page according to the type of form widgets.

Form widget type Form widget object

Applies redaction annotations in current page.

Returns true on success, false on failure.

This class is about PDF page text content.

Whether the object is valid.

Returns true if valid, otherwise false.

Releases resource of the object.

Gets a range representing text in specified area.

Start point coordinate End point coordinate Tolerance range Rectangle list

Gets the text enclosed within the specified range.

Start point coordinate End point coordinate Text

Gets index of the character at or nearby a certain position on the page.

Coordinate Tolerance Text index

Given a point in page-space, gets a selection representing a whole word at that point.

Coordinate Tolerance range Corresponding rectangle of the word Word string

Enumeration value of text search option.

Case insensitive

Case sensitive

Match whole word

not in use currently

This class is about text search.

Constructor function.

Whether the object is valid.

Valid returns true, otherwise false

Starts searching text.

Text page object, more: Keyword Search option, more: Searches keyword from the specified index on the page. Returns true on success, false on failure

Search for next matched pattern.

Page object, more: Text page object, more: Text rectangle Content Start page index Returns true on success, false on failure.

Stops searching.

The base class is about editing area.

Editing type.

Whether the object is valid.

Returns true if valid, otherwise false.

Gets rectangle of editing area on the page.

Rectangle on the page.

Sets rectangle of editing area on the page.

Rectangle on the page. Returns true on success, false on failure.

This class is about image editing.

Gets the rotation angle of image.

Rotation angle, range -180 - 180.

Rotates the image.

Rotation angle,range -180 - 180. Returns true on success, false on failure.

Mirrors the image horizontally.

Returns true on success, false on failure.

Mirrors the image vertically.

Returns true on success, false on failure.

Crops the image with rectangle.

Rectangle on the image. Returns true on success, false on failure.

Gets the clipping rectangle.

Rectangle on the image.

Gets the bitmap of image.

The bitmap of image.

Extracts the image to the specified file path.

The specified file path. Returns true on success, false on failure.

Text alignment.

None.

Left alignment.

Right alignment.

Justify alignment.

Middle alignment.

This class is about text editing.

Gets a list of the area of selected lines on the page.

Gets the selected text content.

Gets the position of text cursor when pressing Prev.

Position of text cursor.

Gets the position of text cursor when pressing Next.

Position of text cursor.

Gets the position of text cursor when pressing Up.

Position of text cursor.

Gets the position of text cursor when pressing Down.

Position of text cursor.

Gets the position of text cursor in specified position.

Cursor in specified position. Position of text cursor.

Gets the page area of each selected line in specified area.

Start point. End point.

Gets the last selected text content.

Selects all text in the text block.

Clears the selected text.

Deletes character behind the text cursor and returns position of text cursor.

Position of text cursor.

Deletes character before the text cursor and returns position of text cursor.

Position of text cursor.

Deletes all selected text in page area and returns position of text cursor.

Position of text cursor.

Sets the font size of selected text.

Font size.

Sets the font color of selected text.

Red. Green. Blue.

Inserts new text content behind the text cursor and returns position of text cursor.

Text content that needs to be inserted. Position of text cursor.

Gets the page area of the word in specified position.

Specified position. Page area of the word.

Gets the page area of the whole line in specified position.

Specified position Page area of the whole line.

Gets the text content of the current paragraph based on coordinates.

The specified coordinates. Returns true on success, false on failure.

Get the text style of the current position of text cursor.

Font size. Font color.

Gets the coordinates of the top and bottom of the text cursor.

The coordinates of the bottom of the text cursor. The coordinates of the top of the text cursor. Returns true on success, false on failure

Sets the alignment of text in a text area.

The alignment of text. Returns true on success, false on failure.

Sets the text alignment of the current paragraph.

The text alignment. Returns true on success, false on failure.

Sets the text alignment of selected text.

The text alignment. Returns true on success, false on failure.

Gets the text alignment of the current paragraph.

The text alignment.

Image watermark.

Text watermark.

Watermark type.

Unknown type

Text watermark

Image watermark

Vertical alignment.

Unknown type

Align Vertically to the top

Align Vertically centered

Align Vertically to the bottom

Horizontal alignment.

Unknown type

Align horizontally to left

Align horizontally centered

Align horizontally to right

This class is mainly used to construct a watermark with specified parameters, and then insert it to PDF page. The watermark object can be constructed from text, bitmap or image, and PDF page.

Gets watermark type,more:

Whether object is valid, false means the object resource is released, you cannot use the object to call any method.

Sets zoom level.

Zoom level. Returns whether to successfully set zoom level.

Sets rotation angle.

Rotation angle. Returns whether to successfully set rotation angle.

Sets opacity.

Opacity. Returns whether to successfully set opacity.

Sets vertical alignment,more:

Vertical alignment. Returns whether to successfully set vertical alignment.

Sets horizontal alignment,more:

Horizontal alignment. Returns whether to successfully set horizontal alignment.

Sets vertical deviation.

Vertical deviation. Returns whether to successfully set vertical deviation.

Sets horizontal deviation.

Horizontal deviation. Returns whether to successfully set horizontal deviation.

Sets page range of watermark. Page range, such as:1,2,3 or 1-3

Page range,such as:1,2,3 or 1-3 Returns whether to successfully set page range of watermark.

Sets watermark layer. True means watermark is in front of text, false means behind text.

Whether it is in front of text. Returns whether to successfully set watermark layer.

Sets tiled watermark.

Whether it is tiled watermark. Returns whether to successfully set tiled watermark.

Sets the horizontal spacing for the tiled watermark.

Horizontal spacing for the tiled watermark. Returns whether to successfully set the horizontal spacing for the tiled watermark.

Sets vertical spacing for the tiled watermark.

Vertical spacing for the tiled watermark. Returns whether to successfully set vertical spacing for the tiled watermark.

Sets content of text watermark.

Content of text watermark. Returns whether to successfully se content of text watermark.

Sets font of text watermark.

Font of text watermark. Returns whether to successfully set font of text watermark.

Sets font size of text watermark.

Font size of text watermark Returns whether to successfully set font size of text watermark.

Sets font color of text watermark.

Font color of text watermark. Returns whether to successfully set font color of text watermark.

Sets image watermark with Bitmap by pixel.

Image resource. Image width. Image height. Whether to successfully set image watermark with Bitmap by pixel.

Creates watermark.

Whether to successfully create watermark.

Removes watermark.

Whether to successfully remove watermark.

Updates watermark.

Whether to successfully update watermark.

Releases Watermark object resource.