Foxit PDF SDK
|
Inherits SystemIDisposable.
Public Member Functions | |
virtual void | DisplayCaret (int page_index, bool is_visible, RectF rect) |
A callback function used to display or hide caret. More... | |
virtual void | ExportData (XFADoc doc, string file_path) |
A callback function used to export data to file. More... | |
virtual int | GetCurrentPage (XFADoc doc) |
A callback function used to get index of current page. More... | |
virtual uint | GetHighlightColor (XFADoc doc) |
A callback function get the highlight color. More... | |
virtual bool | GetPopupPos (int page_index, float min_popup, float max_popup, RectF rect_widget, RectF inout_rect_popup) |
A callback function used to get the pop-up position. More... | |
virtual string | GetTitle (XFADoc doc) |
A callback function used to get title of current XFA document. More... | |
virtual void | GotoURL (XFADoc doc, string url) |
A callback function used to go to a specified URL. More... | |
virtual void | ImportData (XFADoc doc, string file_path) |
A callback function used to import data from file. More... | |
virtual void | InvalidateRect (int page_index, RectF rect, DocProviderCallback.InvalidateFlag flag) |
A callback function used to invalidate rectangle according the flag. More... | |
virtual void | PageViewEvent (int page_index, DocProviderCallback.PageViewEventType page_view_event_type) |
A callback function to execute page view event. More... | |
virtual bool | PopupMenu (int page_index, PointF rect_popup) |
A callback function used to pop up the context menu. More... | |
virtual void | Print (XFADoc doc, int start_page_index, int end_page_index, int options) |
A callback function used to print. More... | |
virtual void | Release () |
A callback function used to release current callback object itself. More... | |
virtual void | SetChangeMark (XFADoc doc) |
A callback function used to set change mark flag to current XFA document. More... | |
virtual void | SetCurrentPage (XFADoc doc, int current_page_index) |
A callback function used to set index of current page. More... | |
virtual void | SetFocus (XFAWidget xfa_widget) |
A callback function used to set focus widget. More... | |
virtual bool | SubmitData (XFADoc doc, string target, DocProviderCallback.SubmitFormat format, DocProviderCallback.TextEncoding text_encoding, string content) |
A callback function to submit data. More... | |
virtual void | WidgetEvent (XFAWidget xfa_widget, DocProviderCallback.WidgetEventType widget_event_type) |
A callback function to execute XFA widget event. More... | |
This class represents a callback object as an XFA document provider. All the functions in this class are used as callback functions. Pure virtual functions should be implemented by user.
Enumeration for the event type of page view.
Values of this enumeration should be used alone.
Enumeration for XFA print options.
Values of this enumeration should be used alone.
Enumeration for XFA submit format.
Values of this enumeration should be used alone.
Enumeration for text encoding for XFA submit.
Values of this enumeration should be used alone.
|
inlinevirtual |
A callback function used to display or hide caret.
[in] | page_index | The index of page. |
[in] | is_visible | Used to decide whether the caret is visible or not: true means visible, while false means invisible. |
[in] | rect | A rectangle. |
|
inlinevirtual |
A callback function used to export data to file.
[in] | doc | Current XFA document. |
[in] | file_path | A file path, to which the data should be exported. If this is an empty string, user should specify a path as the exported file path. In this case, application can show a dialog to user to let user select the file manually. |
|
inlinevirtual |
A callback function used to get index of current page.
[in] | doc | Current XFA document. |
|
inlinevirtual |
A callback function get the highlight color.
[in] | doc | Current XFA document. |
|
inlinevirtual |
A callback function used to get the pop-up position.
[in] | page_index | The index of page. |
[in] | min_popup | The minimum height of drop-down box. |
[in] | max_popup | The maximum height of drop-down box. |
[in] | rect_widget | The rectangle of current widget. |
[in,out] | inout_rect_popup | A rectangle. When this function calls, this is used as an input parameter that specifies the width of drop-down box. When this function returns, this is used as an output parameter that receives the height of drop-down box. |
|
inlinevirtual |
A callback function used to get title of current XFA document.
[in] | doc | Current XFA document. |
|
inlinevirtual |
A callback function used to go to a specified URL.
[in] | doc | Current XFA document. |
[in] | url | A URL string. |
|
inlinevirtual |
A callback function used to import data from file.
[in] | doc | Current XFA document. |
[in] | file_path | A file path, from which the data would be imported. If this is an empty string, user should specify a path as the imported file path. In this case, application can show a dialog to user to let user select the file manually. |
|
inlinevirtual |
A callback function used to invalidate rectangle according the flag.
This callback function would be used in dynamic XFA document.
[in] | page_index | The index of page. |
[in] | rect | A rectangle to be invalidate. |
[in] | flag | Invalidate flag. Please refer to values starting from foxit.addon.xfa.DocProviderCallback.InvalidateFlag.e_InvalidateFlagAllPages and this would be one of these values. |
|
inlinevirtual |
A callback function to execute page view event.
[in] | page_index | The page index. |
[in] | page_view_event_type | Page view event type. Please refer to values starting from foxit.addon.xfa.DocProviderCallback.PageViewEventType.e_PageViewEventTypeAdded and this would be one of these values. |
|
inlinevirtual |
A callback function used to pop up the context menu.
[in] | page_index | The index of page. |
[in] | rect_popup | The rectangle where to pop up menu. |
|
inlinevirtual |
A callback function used to print.
[in] | doc | Current XFA document. |
[in] | start_page_index | The index of start page. |
[in] | end_page_index | The index of end page. |
[in] | options | Print options. Please refer to values starting from foxit.addon.xfa.DocProviderCallback.PrintOption.e_PrintOptionShowDialog and this would be one or a combination of these values. |
|
inlinevirtual |
A callback function used to release current callback object itself.
|
inlinevirtual |
A callback function used to set change mark flag to current XFA document.
[in] | doc | Current XFA document. |
|
inlinevirtual |
A callback function used to set index of current page.
[in] | doc | Current XFA document. |
[in] | current_page_index | The index would be set. |
|
inlinevirtual |
A callback function used to set focus widget.
[in] | xfa_widget | An XFA widget to be set focus on. |
|
inlinevirtual |
A callback function to submit data.
[in] | doc | Current XFA document. |
[in] | target | A string that represents the target of data to be submit. |
[in] | format | The format of data to be submit. Please refer to values starting from foxit.addon.xfa.DocProviderCallback.SubmitFormat.e_SubmitInXDP and this would be one of these values. |
[in] | text_encoding | The text encoding of data to be submit. Please refer to values starting from foxit.addon.xfa.DocProviderCallback.TextEncoding.e_TextEncodingNone and this would be one of these values. |
[in] | content | The content of data to be submit. |
|
inlinevirtual |
A callback function to execute XFA widget event.
[in] | xfa_widget | An XFA widget which sends the event. |
[in] | widget_event_type | Widget event type. Please refer to values starting from foxit.addon.xfa.DocProviderCallback.WidgetEventType.e_WidgetEventTypeAdded and this would be one of these values. |