Foxit PDF SDK
|
Inherits SystemIDisposable.
Public Types | |
enum | AppInfoType { AppInfoType.e_AppInfoTypeFormsVersion = 0x0, AppInfoType.e_AppInfoTypeViewerType = 0x01, AppInfoType.e_AppInfoTypeViewerVariation = 0x02, AppInfoType.e_AppInfoTypeViewerVersion = 0x03, AppInfoType.e_AppInfoTypeAppVersion = 0x04 } |
Enumeration for application's information type. More... | |
enum | Language { Language.e_LanguageUnknown = 0, Language.e_LanguageCHS = 1, Language.e_LanguageCHT = 2, Language.e_LanguageDAN = 3, Language.e_LanguageDEU = 4, Language.e_LanguageENU = 5, Language.e_LanguageESP = 6, Language.e_LanguageFRA = 7, Language.e_LanguageITA = 8, Language.e_LanguageKOR = 9, Language.e_LanguageJPN = 10, Language.e_LanguageNLD = 11, Language.e_LanguageNOR = 12, Language.e_LanguagePTB = 13, Language.e_LanguageSUO = 14, Language.e_LanguageSVE = 15 } |
Enumeration for language. More... | |
enum | MailType { MailType.e_MailTypeDoc = 0, MailType.e_MailTypeForm = 1, MailType.e_MailTypeMsg = 2 } |
Enumeration for data type to be mailed. More... | |
Public Member Functions | |
virtual int | Alert (string msg, string title, int type, int icon) |
A callback function used to pop up a dialog to show warnings or hints. More... | |
virtual bool | Beep (int type) |
A callback function to cause the system to play a sound. More... | |
virtual string | BrowseFile () |
A callback function to show a file selection dialog, and the selected file path should be returned. More... | |
virtual bool | ExecuteNamedAction (PDFDoc document, string named_action) |
A callback function to execute a named action. More... | |
virtual string | GetAppInfo (ActionCallback.AppInfoType type) |
A callback function to get application information. More... | |
virtual int | GetCurrentPage (PDFDoc document) |
A callback function used to receive current page index. More... | |
virtual bool | GetDocChangeMark (PDFDoc document) |
A callback function to receive the change mark which indicates whether the content of document is changed or not. More... | |
virtual string | GetFilePath (PDFDoc document) |
A callback function to get the file path of current PDF document. More... | |
virtual IdentityProperties | GetIdentityProperties () |
A callback function used to get identity properties of current user. More... | |
virtual ActionCallback.Language | GetLanguage () |
A callback function to get the language of the running viewer application. More... | |
virtual PDFDoc | GetOpenedDoc (int index) |
A callback function to receive an opened PDF document object by index. More... | |
virtual int | GetOpenedDocCount () |
A callback function to receive the count of opened documents. More... | |
virtual Rotation | GetPageRotation (PDFDoc document, int page_index) |
A callback function used to receive current displaying rotation of a page on PDF viewer. More... | |
virtual bool | InvalidateRect (PDFDoc document, int page_index, RectF pdf_rect) |
A callback function to invalidate the client area within the specified rectangle. More... | |
virtual bool | LaunchURL (string url) |
A callback function to launch to a specified url. More... | |
virtual bool | MailData (global::System.IntPtr data, ActionCallback.MailType data_type, bool is_ui, string to, string subject, string cc, string bcc, string message) |
A callback function to mail data or message, with or without user interaction. More... | |
virtual string | PopupMenu (MenuListArray menus) |
A callback function to pop up a menu window. More... | |
virtual bool | Print (PDFDoc document, bool is_ui, Range page_range, bool is_silent, bool is_shrunk_to_fit, bool is_printed_as_image, bool is_reversed, bool is_to_print_annots) |
A callback function to print pages within a specified index range. More... | |
virtual void | Release () |
A callback function used to release current callback object itself. More... | |
virtual string | Response (string question, string title, string default_value, string label, bool is_password) |
A callback function to display a dialog box containing a question and an entry field for the user to reply to the question. More... | |
virtual void | SetCurrentPage (PDFDoc document, int page_index) |
A callback function used to set the current page by index. More... | |
virtual bool | SetDocChangeMark (PDFDoc document, bool change_mark) |
A callback function to set the change mark which indicates whether the content of document is changed or not. More... | |
virtual bool | SetPageRotation (PDFDoc document, int page_index, Rotation rotation) |
A callback function used to set the rotation value of a page on PDF viewer. More... | |
virtual bool | SubmitForm (PDFDoc document, global::System.IntPtr form_data, int length, string url) |
A callback function to submit the form data to a specified url. More... | |
virtual uint | VerifySignature (PDFDoc document, Signature pdf_signature) |
A callback function to verify specified signature.. More... | |
This class represents a callback object for performing PDF actions. All the pure virtual functions in this class are used as callback functions and should be implemented by user, to perform PDF actions, such as javascript actions.
|
strong |
Enumeration for application's information type.
Values of this enumeration should be used alone.
|
strong |
Enumeration for language.
Values of this enumeration should be used alone.
|
strong |
|
inlinevirtual |
A callback function used to pop up a dialog to show warnings or hints.
This callback function is optional, so it can be implemented to do nothing and just return a useless value.
[in] | msg | The message string to be displayed in the dialog. |
[in] | title | The title of the dialog. |
[in] | type | Type of button group. It would be one of following values:
|
[in] | icon | Icon type. It would be one of following values:
|
1: OK;
2: Cancel;
3: NO;
4: Yes;
|
inlinevirtual |
A callback function to cause the system to play a sound.
This callback function is optional, so it can be implemented to do nothing and just return a useless value.
[in] | type | Sound type. The value would be on of following values:
|
|
inlinevirtual |
A callback function to show a file selection dialog, and the selected file path should be returned.
This callback function is optional, so it can be implemented to do nothing and just return a useless value.
|
inlinevirtual |
A callback function to execute a named action.
Please refer to description of "Named Actions" in Section 8.5.3 of <PDF Reference 1.7> for more details. This callback function is optional, so it can be implemented to do nothing and just return a useless value.
[in] | document | A PDF document object. It would be valid. |
[in] | named_action | A string to specify a named action. |
|
inlinevirtual |
A callback function to get application information.
This callback function is optional, so it can be implemented to do nothing and just return a useless value.
For the digital information like foxit.pdf.actions.ActionCallback.AppInfoType.e_AppInfoTypeViewerVersion , foxit.pdf.actions.ActionCallback.AppInfoType.e_AppInfoTypeAppVersion and foxit.pdf.actions.ActionCallback.AppInfoType.e_AppInfoTypeFormsVersion , please use string to represent it.
[in] | type | Type of information. Please refer to values starting from foxit.pdf.actions.ActionCallback.AppInfoType.e_AppInfoTypeFormsVersion and this would be one of these values. |
|
inlinevirtual |
A callback function used to receive current page index.
This callback function is optional, so it can be implemented to do nothing and just return a useless value.
[in] | document | A PDF document object. It would be valid. |
|
inlinevirtual |
A callback function to receive the change mark which indicates whether the content of document is changed or not.
This callback function is optional, so it can be implemented to do nothing and just return a useless value.
[in] | document | A PDF document object. It would be valid. |
|
inlinevirtual |
A callback function to get the file path of current PDF document.
This callback function is optional, so it can be implemented to do nothing and just return a useless value.
[in] | document | A PDF document object. It would be valid. |
|
inlinevirtual |
A callback function used to get identity properties of current user.
This callback function is optional, so it can be implemented to do nothing and just return a useless value.
|
inlinevirtual |
A callback function to get the language of the running viewer application.
This callback function is optional, so it can be implemented to do nothing and just return a useless value.
|
inlinevirtual |
A callback function to receive an opened PDF document object by index.
This callback function is optional, so it can be implemented to do nothing and just return a useless value.
[in] | index | The index of an opened PDF documents. Valid range: from 0 to count-1. countt is returned by callback function ActionCallback.GetOpenedDocCount ; |
|
inlinevirtual |
A callback function to receive the count of opened documents.
This callback function is optional, so it can be implemented to do nothing and just return a useless value.
|
inlinevirtual |
A callback function used to receive current displaying rotation of a page on PDF viewer.
This callback function is optional, so it can be implemented to do nothing and just return a useless value.
[in] | document | A PDF document object. It would be valid. |
[in] | page_index | A page index, used to specify which page's rotation is to be retrieved. The index would start from 0 and less than page count of the specified document. |
|
inlinevirtual |
A callback function to invalidate the client area within the specified rectangle.
All positions are measured in PDF "user space". Implementation should call function common.Renderer.StartRender for repainting a specified page area.
[in] | document | A PDF document object. It would be valid. |
[in] | page_index | A page index. It would start from 0 and less than page count of the specified document. |
[in] | pdf_rect | A rectangle that specifies the page area in PDF coordinate system. |
|
inlinevirtual |
A callback function to launch to a specified url.
This callback function is optional, so it can be implemented to do nothing and just return a useless value.
[in] | url | A url. |
|
inlinevirtual |
A callback function to mail data or message, with or without user interaction.
This callback function is optional, so it can be implemented to do nothing and just return a useless value.
[in] | data | A data which is to be mailed. The value and type of the data depends on parameter data_type:
|
[in] | data_type | Mail type. Please refer to values starting from foxit.pdf.actions.ActionCallback.MailType.e_MailTypeDoc and this would be one of these values. |
[in] | is_ui | true means that the remaining parameters are used to seed the compose-new-message window which is displayed to the user. false means that the parameter to is required and all other parameters are optional. |
[in] | to | A string that specifies a semicolon-delimited list of recipients for the message. |
[in] | subject | A string that specifies the subject of the message. The limit of this string's length is 64 KB. |
[in] | cc | A string that specifies a semicolon-delimited list of CC recipients for the message. |
[in] | bcc | A string that specifies a semicolon-delimited list of BCC recipients for the message. |
[in] | message | A string that specifies the content of the message. The limit of this string's length is 64 KB. |
|
inlinevirtual |
A callback function to pop up a menu window.
The position of menu window is same as cursor's. This callback function is optional, so it can be implemented to do nothing and just return a useless value.
[in] | menus | An array of menu list objects. |
|
inlinevirtual |
A callback function to print pages within a specified index range.
This callback function is optional, so it can be implemented to do nothing and just return a useless value.
[in] | document | A PDF document object. It would be valid. |
[in] | is_ui | true means that a UI should be presented to the user to obtain printing information and confirm the action. |
[in] | page_range | A range object to specify the page range for printing. All the indexes represented in this range would start from 0 and less than page count of the specified document. |
[in] | is_silent | true means that the cancel dialog box should be suppressed while the document is printing. |
[in] | is_shrunk_to_fit | true means that the page should be shrunk (if necessary) to fit within the area of the printed page. |
[in] | is_printed_as_image | true means that pages should be printed as image. |
[in] | is_reversed | true means that the printing order should be from parameter end to parameter start. |
[in] | is_to_print_annots | true means that annotations should be printed with page. |
|
inlinevirtual |
A callback function used to release current callback object itself.
|
inlinevirtual |
A callback function to display a dialog box containing a question and an entry field for the user to reply to the question.
This callback function is optional, so it can be implemented to do nothing and just return a useless value.
[in] | question | A string that specifies the question to be posed to the user. |
[in] | title | A string that specifies the title of the dialog box. |
[in] | default_value | A string that specifies a default value as the answer to the question. If the answer is not specified, no default value is presented. |
[in] | label | A string that specifies a short string to appear in front of the edit text field. |
[in] | is_password | A boolean value that indicates whether user's response should be masked to show: true means that the user's response should show as asterisks (*) or bullets (?) to mask the response, which might be sensitive information. Default: false. |
|
inlinevirtual |
A callback function used to set the current page by index.
This callback function is optional, so it can be implemented to do nothing.
[in] | document | A PDF document object. It would be valid. |
[in] | page_index | A page index which is used to change current page. The index would start from 0 and less than page count of the specified document. |
|
inlinevirtual |
A callback function to set the change mark which indicates whether the content of document is changed or not.
This callback function is optional, so it can be implemented to do nothing and just return a useless value.
[in] | document | A PDF document object. It would be valid. |
[in] | change_mark | A boolean value that indicates whether the content of document is changed or not. |
|
inlinevirtual |
A callback function used to set the rotation value of a page on PDF viewer.
This callback function is optional, so it can be implemented to do nothing.
[in] | document | A PDF document object. It would be valid. |
[in] | page_index | A page index, used to specify which page's rotation is to be changed. The index would start from 0 and less than page count of the specified document. |
[in] | rotation | New rotation value. Please refer to values starting from foxit.common.Rotation.e_Rotation0 and this should be one of these values except foxit.common.Rotation.e_RotationUnknown . |
|
inlinevirtual |
A callback function to submit the form data to a specified url.
This callback function is optional, so it can be implemented to do nothing and just return a useless value.
[in] | document | A PDF document object. It would be valid. |
[in] | form_data | A form data buffer which is to be submit. |
[in] | length | The size (in bytes) of the buffer parameterform_data. |
[in] | url | A url, to which the form data will be submit. |
|
inlinevirtual |
A callback function to verify specified signature..
This callback function will be triggered when a signature is to be verified by an action. If user does not want to verify the signature, just implement this function to do nothing and just return foxit.pdf.Signature.States.e_StateUnknown . User is recommended to use class foxit.pdf.LTVVerifier to verify if a signed signature is valid or not.
[in] | document | A PDF document object. It would be valid. |
[in] | pdf_signature | A PDF signature which is signed. This signature belongs to input paramter document. |