Foxit PDF SDK
|
Public Types | |
enum | BulletType { BulletType.e_BulletTypeNone = 0, BulletType.e_BulletTypeSolidCircle = 1, BulletType.e_BulletTypeSolidRectangle = 2, BulletType.e_BulletTypeSolidDiamond = 3, BulletType.e_BulletTypeCheck = 4, BulletType.e_BulletTypeRightArrow = 5, BulletType.e_BulletTypeInverseTangentCircle = 6, BulletType.e_BulletTypeDiagonalUpRightArrow = 7, BulletType.e_BulletTypeBlackDiamondMinusWhite = 8 } |
Enumeration for bullet type. More... | |
enum | NumberingType { NumberingType.e_NumberingTypeNone = 0, NumberingType.e_NumberingTypeDecimalDot = 1, NumberingType.e_NumberingTypeDecimalRParen = 2, NumberingType.e_NumberingTypeUpperLatinDot = 3, NumberingType.e_NumberingTypeLowerLatinRParen = 4, NumberingType.e_NumberingTypeLowerLatinDot = 5 } |
Enumeration for numbering type. More... | |
Public Member Functions | |
ParagraphEditing (ParagraphEditing other) | |
Constructor, with another paragraph edit object. More... | |
bool | Activate () |
Activate paragraph editing. More... | |
bool | CanCopy () |
Check whether can copy text. More... | |
bool | CanCut () |
Check whether can cut text. More... | |
bool | CanDelete () |
Check whether can delete text. More... | |
bool | CanDeselectAll () |
Check whether can deselect all text. More... | |
bool | CanPaste () |
Check whether can paste text. More... | |
bool | CanSelectAll () |
Check whether can select all text. More... | |
bool | CopySelected () |
Copy the selected text. More... | |
bool | CutSelected () |
Cut the selected text. More... | |
bool | Deactivate () |
Deactivate paragraph editing. More... | |
void | Dedent () |
Decrease indent for text. More... | |
bool | DeleteSelected () |
Delete the selected text. More... | |
bool | DeselectAll () |
Deselect all text. More... | |
void | ExitEditing (bool is_end_directly) |
Exit paragraph editing. More... | |
void | Indent () |
Increase indent for text. More... | |
bool | InsertText (string text) |
Call this function when insert text into the page. More... | |
bool | IsEmpty () |
Check whether current object is empty or not. More... | |
bool | OnChar (int char_code) |
Call this function when a character code is being input. More... | |
bool | OnKeyDown (int key_code) |
Call this function when key on the keyboard is down. More... | |
bool | OnKeyUp (int key_code) |
Call this function when key on the keyboard is up. More... | |
bool | OnLButtonDoubleClick (int page_index, PointF point) |
Call this function when left mouse button is double clicked. More... | |
bool | OnLButtonDown (int page_index, PointF point) |
Call this function when left mouse button is down. More... | |
bool | OnLButtonUp (int page_index, PointF point) |
Call this function when left mouse button is up. More... | |
bool | OnMouseMove (int page_index, PointF point) |
Call this function when mouse moves. More... | |
bool | OnMouseWheel (int page_index, PointF point, int delta) |
Call this function when scrolling the mouse wheel. More... | |
bool | PasteSelected () |
Paste the copied text. More... | |
bool | Render (Int32Array page_index_array, Renderer renderer) |
Draw the current paragraph editing operation status on the rendering. More... | |
bool | SelectAll () |
Select all text. More... | |
void | SetAlignment (Alignment alignment) |
Set text alignment for text. More... | |
void | SetBold (bool is_bold) |
Set bold status for text. More... | |
void | SetBulletedList (ParagraphEditing.BulletType bullet_type) |
Set bullet list for text. More... | |
void | SetCharHorizontalScale (int scale) |
Set char horizontal scale for text. More... | |
void | SetCharSpace (float char_space) |
Set char space for text. More... | |
void | SetFontName (string font_name) |
Set font name for text. More... | |
void | SetFontSize (float font_size) |
Set the font size for text. More... | |
void | SetItalic (bool is_italic) |
Set italic status for text. More... | |
void | SetLineSpace (float line_space) |
Set line space for text. More... | |
void | SetNumberedList (ParagraphEditing.NumberingType numbering_type) |
Set the look of numbering for text. More... | |
void | SetParagraphSpacing (float paragraph_space) |
Set paragraph spacing for text. More... | |
void | SetStrikethrough (bool is_striketrough) |
Set strikeout word style for text. More... | |
void | SetSubscript (bool is_subscript) |
Set the word property of subscript type for text. More... | |
void | SetSuperscript (bool is_superscript) |
Set the word property of superscript type for text. More... | |
void | SetTextColor (int text_color) |
Set text color for text. More... | |
void | SetUnderline (bool is_underline) |
Set underline for text. More... | |
void | StartEditing (int page_index, PointF start_point, PointF 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 ParagraphEditing.Activate has been called. Please call the function ParagraphEditing.Deactivate to deactivate when no need to use any paragraph edit function.
Enumeration for bullet type.
Values of this enumeration should be used alone.
Enumeration for numbering type.
Values of this enumeration should be used alone.
|
inline |
Constructor, with another paragraph edit object.
[in] | other | Another paragraph edit object. |
|
inline |
Activate paragraph editing.
|
inline |
Check whether can copy text.
|
inline |
Check whether can cut text.
|
inline |
Check whether can delete text.
|
inline |
Check whether can deselect all text.
|
inline |
Check whether can paste text.
|
inline |
Check whether can select all text.
|
inline |
Copy the selected text.
|
inline |
Cut the selected text.
|
inline |
Deactivate paragraph editing.
|
inline |
Decrease indent for text.
|
inline |
Delete the selected text.
|
inline |
Deselect all text.
|
inline |
Exit paragraph editing.
[in] | is_end_directly | Whether to end editing directly. |
|
inline |
Increase indent for text.
|
inline |
Call this function when insert text into the page.
[in] | text | The text to be inserted. |
|
inline |
Check whether current object is empty or not.
When the current object is empty, that means current object is useless.
|
inline |
Call this function when a character code is being input.
[in] | char_code | A character code, in UTF16-LE encoding. |
|
inline |
Call this function when key on the keyboard is down.
[in] | key_code | The key code. Please refer to values starting from foxit.pdf.interform.Filler.VirtualKeyCode.e_VkeyUnknown and this should be one of these values. |
|
inline |
Call this function when key on the keyboard is up.
[in] | key_code | The key code. Please refer to values starting from foxit.pdf.interform.Filler.VirtualKeyCode.e_VkeyUnknown and this should be one of these values. |
|
inline |
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. |
|
inline |
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. |
|
inline |
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. |
|
inline |
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. |
|
inline |
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. |
|
inline |
Paste the copied text.
|
inline |
Draw the current paragraph editing operation status on the rendering.
The matrix used in the rendering process is returned by ParagraphEditingProviderCallback.GetRenderMatrix .
[in] | page_index_array | The page index array to render. |
[in] | renderer | A valid renderer object for rendering. |
|
inline |
Select all text.
|
inline |
Set text alignment for text.
[in] | alignment | Alignment value.Please refer to values starting from foxit.common.Alignment.e_AlignmentLeft and this should be one of these values. |
|
inline |
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. |
|
inline |
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. None. |
|
inline |
Set char horizontal scale for text.
[in] | scale | The scale. It should be bigger than 0. |
|
inline |
Set char space for text.
[in] | char_space | The char space (unit is 1/72 inch). |
|
inline |
Set font name for text.
[in] | font_name | The font name. |
|
inline |
Set the font size for text.
[in] | font_size | The font size. |
|
inline |
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. |
|
inline |
Set line space for text.
[in] | line_space | The line space (unit is 1/72 inch). |
|
inline |
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. None. |
|
inline |
Set paragraph spacing for text.
[in] | paragraph_space | The paragraph spacing. |
|
inline |
Set strikeout word style for text.
[in] | is_striketrough | true means to set the strikeout word style, while false means not. |
|
inline |
Set the word property of subscript type for text.
|
inline |
Set the word property of superscript type for text.
|
inline |
Set text color for text.
[in] | text_color | The text color. |
|
inline |
Set underline for text.
[in] | is_underline | true means to underline text, while false means not. |
|
inline |
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. |