|
Foxit PDF SDK
|
Public Member Functions | |
| def | Activate () |
| Activate paragraph editing. More... | |
| def | CanCopy () |
| Check whether can copy text. More... | |
| def | CanCut () |
| Check whether can cut text. More... | |
| def | CanDelete () |
| Check whether can delete text. More... | |
| def | CanDeselectAll () |
| Check whether can deselect all text. More... | |
| def | CanPaste () |
| Check whether can paste text. More... | |
| def | CanSelectAll () |
| Check whether can select all text. More... | |
| def | CopySelected () |
| Copy the selected text. More... | |
| def | CutSelected () |
| Cut the selected text. More... | |
| def | Deactivate () |
| Deactivate paragraph editing. More... | |
| def | Dedent () |
| Decrease indent for text. More... | |
| def | DeleteSelected () |
| Delete the selected text. More... | |
| def | DeselectAll () |
| Deselect all text. More... | |
| def | ExitEditing (is_end_directly) |
| Exit paragraph editing. More... | |
| def | Indent () |
| Increase indent for text. More... | |
| def | InsertText (text) |
| Call this function when insert text into the page. More... | |
| def | IsEmpty () |
| Check whether current object is empty or not. More... | |
| def | OnChar (char_code) |
| Call this function when a character code is being input. More... | |
| def | OnKeyDown (key_code) |
| Call this function when key on the keyboard is down. More... | |
| def | OnKeyUp (key_code) |
| Call this function when key on the keyboard is up. More... | |
| def | OnLButtonDoubleClick (page_index, point) |
| Call this function when left mouse button is double clicked. More... | |
| def | OnLButtonDown (page_index, point) |
| Call this function when left mouse button is down. More... | |
| def | OnLButtonUp (page_index, point) |
| Call this function when left mouse button is up. More... | |
| def | OnMouseMove (page_index, point) |
| Call this function when mouse moves. More... | |
| def | OnMouseWheel (page_index, point, delta) |
| Call this function when scrolling the mouse wheel. More... | |
| def | PasteSelected () |
| Paste the copied text. More... | |
| def | Render (page_index_array, renderer) |
| Draw the current paragraph editing operation status on the rendering. More... | |
| def | SelectAll () |
| Select all text. More... | |
| def | SetAlignment (alignment) |
| Set text alignment for text. More... | |
| def | SetBold (is_bold) |
| Set bold status for text. More... | |
| def | SetBulletedList (bullet_type) |
| Set bullet list for text. More... | |
| def | SetCharHorizontalScale (scale) |
| Set char horizontal scale for text. More... | |
| def | SetCharSpace (char_space) |
| Set char space for text. More... | |
| def | SetFontName (font_name) |
| Set font name for text. More... | |
| def | SetFontSize (font_size) |
| Set the font size for text. More... | |
| def | SetItalic (is_italic) |
| Set italic status for text. More... | |
| def | SetLineSpace (line_space) |
| Set line space for text. More... | |
| def | SetNumberedList (numbering_type) |
| Set the look of numbering for text. More... | |
| def | SetParagraphSpacing (paragraph_space) |
| Set paragraph spacing for text. More... | |
| def | SetStrikethrough (is_striketrough) |
| Set strikeout word style for text. More... | |
| def | SetSubscript (is_subscript) |
| Set the word property of subscript type for text. More... | |
| def | SetSuperscript (is_superscript) |
| Set the word property of superscript type for text. More... | |
| def | SetTextColor (text_color) |
| Set text color for text. More... | |
| def | SetUnderline (is_underline) |
| Set underline for text. More... | |
| def | StartEditing (page_index, start_point, end_point) |
| Start paragraph editing. More... | |
This class represents a paragraph edit operation. Before use any methods of paragraph edit function, please ensure the function fsdk.ParagraphEditing.Activate has been called. Please call the function fsdk.ParagraphEditing.Deactivate to deactivate when no need to use any paragraph edit function.
| def fsdk.ParagraphEditing.Activate | ( | ) |
Activate paragraph editing.
| def fsdk.ParagraphEditing.CanCopy | ( | ) |
Check whether can copy text.
| def fsdk.ParagraphEditing.CanCut | ( | ) |
Check whether can cut text.
| def fsdk.ParagraphEditing.CanDelete | ( | ) |
Check whether can delete text.
| def fsdk.ParagraphEditing.CanDeselectAll | ( | ) |
Check whether can deselect all text.
| def fsdk.ParagraphEditing.CanPaste | ( | ) |
Check whether can paste text.
| def fsdk.ParagraphEditing.CanSelectAll | ( | ) |
Check whether can select all text.
| def fsdk.ParagraphEditing.CopySelected | ( | ) |
Copy the selected text.
| def fsdk.ParagraphEditing.CutSelected | ( | ) |
Cut the selected text.
| def fsdk.ParagraphEditing.Deactivate | ( | ) |
Deactivate paragraph editing.
| def fsdk.ParagraphEditing.Dedent | ( | ) |
Decrease indent for text.
| def fsdk.ParagraphEditing.DeleteSelected | ( | ) |
Delete the selected text.
| def fsdk.ParagraphEditing.DeselectAll | ( | ) |
Deselect all text.
| def fsdk.ParagraphEditing.ExitEditing | ( | is_end_directly | ) |
Exit paragraph editing.
| [in] | is_end_directly | Whether to end editing directly. |
| def fsdk.ParagraphEditing.Indent | ( | ) |
Increase indent for text.
| def fsdk.ParagraphEditing.InsertText | ( | text | ) |
Call this function when insert text into the page.
| [in] | text | The text to be inserted. |
| def fsdk.ParagraphEditing.IsEmpty | ( | ) |
Check whether current object is empty or not.
When the current object is empty, that means current object is useless.
| def fsdk.ParagraphEditing.OnChar | ( | char_code | ) |
Call this function when a character code is being input.
| [in] | char_code | A character code, in UTF16-LE encoding. |
| def fsdk.ParagraphEditing.OnKeyDown | ( | key_code | ) |
Call this function when key on the keyboard is down.
| [in] | key_code | The key code. Please refer to values starting from fsdk.FillerE_VkeyUnknown and this should be one of these values. |
| def fsdk.ParagraphEditing.OnKeyUp | ( | key_code | ) |
Call this function when key on the keyboard is up.
| [in] | key_code | The key code. Please refer to values starting from fsdk.FillerE_VkeyUnknown and this should be one of these values. |
| def fsdk.ParagraphEditing.OnLButtonDoubleClick | ( | page_index, | |
| point | |||
| ) |
Call this function when left mouse button is double clicked.
| [in] | page_index | The page index. |
| [in] | point | A point where left mouse button is double-clicked in the page, in device coordinate system. |
| def fsdk.ParagraphEditing.OnLButtonDown | ( | page_index, | |
| point | |||
| ) |
Call this function when left mouse button is down.
| [in] | page_index | The page index. |
| [in] | point | A point where left mouse button is down in the page, in device coordinate system. |
| def fsdk.ParagraphEditing.OnLButtonUp | ( | page_index, | |
| point | |||
| ) |
Call this function when left mouse button is up.
| [in] | page_index | The page index. |
| [in] | point | A point where left mouse button is up in the page, in device coordinate system. |
| def fsdk.ParagraphEditing.OnMouseMove | ( | page_index, | |
| point | |||
| ) |
Call this function when mouse moves.
| [in] | page_index | The page index. |
| [in] | point | A point where the mouse in the page, in device coordinate system. |
| def fsdk.ParagraphEditing.OnMouseWheel | ( | page_index, | |
| point, | |||
| delta | |||
| ) |
Call this function when scrolling the mouse wheel.
| [in] | page_index | The page index. |
| [in] | point | A point where the mouse in the page, in device coordinate system. |
| [in] | delta | Indicates the amount the mouse wheel has been moved. A positive value means to be moved forward, and a negative value means to be moved backward. |
| def fsdk.ParagraphEditing.PasteSelected | ( | ) |
Paste the copied text.
| def fsdk.ParagraphEditing.Render | ( | page_index_array, | |
| renderer | |||
| ) |
Draw the current paragraph editing operation status on the rendering.
The matrix used in the rendering process is returned by fsdk.ParagraphEditingProviderCallback.GetRenderMatrix .
| [in] | page_index_array | The page index array to render. |
| [in] | renderer | A valid renderer object for rendering. |
| def fsdk.ParagraphEditing.SelectAll | ( | ) |
Select all text.
| def fsdk.ParagraphEditing.SetAlignment | ( | alignment | ) |
Set text alignment for text.
| [in] | alignment | Alignment value.Please refer to values starting from fsdk.E_AlignmentLeft and this should be one of these values. |
| def fsdk.ParagraphEditing.SetBold | ( | is_bold | ) |
Set bold status for text.
| [in] | is_bold | Whether to set selected text as bold. true means current selected text will be set as bold, while false means not. |
| def fsdk.ParagraphEditing.SetBulletedList | ( | bullet_type | ) |
Set bullet list for text.
Before setting a bullet list, ensure the "wingding.ttf" font has been installed.
| [in] | bullet_type | The type of bullet. Please refer to values starting from and this should be one of these values. |
| def fsdk.ParagraphEditing.SetCharHorizontalScale | ( | scale | ) |
Set char horizontal scale for text.
| [in] | scale | The scale. It should be bigger than 0. |
| def fsdk.ParagraphEditing.SetCharSpace | ( | char_space | ) |
Set char space for text.
| [in] | char_space | The char space (unit is 1/72 inch). |
| def fsdk.ParagraphEditing.SetFontName | ( | font_name | ) |
Set font name for text.
| [in] | font_name | The font name. |
| def fsdk.ParagraphEditing.SetFontSize | ( | font_size | ) |
Set the font size for text.
| [in] | font_size | The font size. |
| def fsdk.ParagraphEditing.SetItalic | ( | is_italic | ) |
Set italic status for text.
| [in] | is_italic | Whether to set selected text as italic. true means current selected text will be set as italic, while false means not. |
| def fsdk.ParagraphEditing.SetLineSpace | ( | line_space | ) |
Set line space for text.
| [in] | line_space | The line space (unit is 1/72 inch). |
| def fsdk.ParagraphEditing.SetNumberedList | ( | numbering_type | ) |
Set the look of numbering for text.
| [in] | numbering_type | The type of numbering. Please refer to values starting from and this should be one of these values. |
| def fsdk.ParagraphEditing.SetParagraphSpacing | ( | paragraph_space | ) |
Set paragraph spacing for text.
| [in] | paragraph_space | The paragraph spacing. |
| def fsdk.ParagraphEditing.SetStrikethrough | ( | is_striketrough | ) |
Set strikeout word style for text.
| [in] | is_striketrough | true means to set the strikeout word style, while false means not. |
| def fsdk.ParagraphEditing.SetSubscript | ( | is_subscript | ) |
Set the word property of subscript type for text.
| def fsdk.ParagraphEditing.SetSuperscript | ( | is_superscript | ) |
Set the word property of superscript type for text.
| def fsdk.ParagraphEditing.SetTextColor | ( | text_color | ) |
Set text color for text.
| [in] | text_color | The text color. |
| def fsdk.ParagraphEditing.SetUnderline | ( | is_underline | ) |
Set underline for text.
| [in] | is_underline | true means to underline text, while false means not. |
| def fsdk.ParagraphEditing.StartEditing | ( | page_index, | |
| start_point, | |||
| end_point | |||
| ) |
Start paragraph editing.
| [in] | page_index | The page index. |
| [in] | start_point | A point to start editing on the page, in the device coordinate system. |
| [in] | end_point | A point to end editing on the page, in the device coordinate system. |