Foxit PDF SDK

Public 成员函数 | 静态 Public 属性 | 所有成员列表
FSDK::ParagraphEditing类 参考

## Public 成员函数
| Activate ()
| 激活段落编辑。 更多...
| CanCopy ()
| 检查是否可以复制文本。 更多...
| CanCut ()
| 检查是否可以剪切文本。 更多...
| CanDelete ()
| 检查是否可以删除文本。 更多...
| CanDeselectAll ()
| 检查是否可以取消全选文本。 更多...
| CanPaste ()
| 检查是否可以粘贴文本。 更多...
| CanSelectAll ()
| 检查是否可以全选文本。 更多...
| CopySelected ()
| 复制选中的文本。 更多...
| CutSelected ()
| 剪切选中的文本。 更多...
| Deactivate ()
| 取消激活段落编辑。 更多...
| Dedent ()
| 为选中的文本移除缩进。 更多...
| DeleteSelected ()
| 删除选中的文本。 更多...
| DeselectAll ()
| 取消选中所有文本。 更多...
| ExitEditing (is_end_directly)
| 退出段落编辑。 更多...
| Indent ()
| 为选中的文本增加缩进。 更多...
| InsertText (text)
| 当将文本插入到页面中时调用此函数。 更多...
| IsEmpty ()
| 检查当前对象是否为空。 更多...
| OnChar (char_code)
| 当将要输入字符代码时调用此函数。 更多...
| OnKeyDown (key_code)
| 当键盘上的键按下时调用此函数。 更多...
| OnKeyUp (key_code)
| 当键盘上的键弹起时调用此函数。 更多...
| OnLButtonDoubleClick (page_index, point)
| 当鼠标左键双击时调用此函数。 更多...
| OnLButtonDown (page_index, point)
| 当鼠标左键按下时调用此函数。 更多...
| OnLButtonUp (page_index, point)
| 当鼠标左键弹起时调用此函数。 更多...
| OnMouseMove (page_index, point)
| 当鼠标移动时调用此函数。 更多...
| OnMouseWheel (page_index, point, delta)
| 当鼠标滚轮移动时调用此函数。 更多...
| PasteSelected ()
| 粘贴复制的文本。 更多...
| Render (page_index_array, renderer)
| 在渲染器上绘制当前段落编辑操作状态。 更多...
| SelectAll ()
| 全选文本。 更多...
| SetAlignment (alignment)
| 为选中的文本设置文本对齐方式。 更多...
| SetBold (is_bold)
| 为选中的文本设置粗体状态。 更多...
| SetBulletedList (bullet_type)
| 为选中的文本设置项目符号列表。 更多...
| SetCharHorizontalScale (scale)
| 为选中的文本设置字符水平缩放比例。 更多...
| SetCharSpace (char_space)
| 为选中的文本设置字符间距。 更多...
| SetFontName (font_name)
| 为选中的文本设置字体名称。 更多...
| SetFontSize (font_size)
| 为选中的文本设置字体大小。 更多...
| SetItalic (is_italic)
| 为选中的文本设置斜体状态。 更多...
| SetLineSpace (line_space)
| 为选中的文本设置行间距。 更多...
| SetNumberedList (numbering_type)
| 为选中的文本更改编号样式。 更多...
| SetParagraphSpacing (paragraph_space)
| 为选中的文本设置段落间距。 更多...
| SetStrikethrough (is_striketrough)
| 为选中的文本设置删除线样式。 更多...
| SetSubscript (is_subscript)
| 为选中的文本设置下标属性。 更多...
| SetSuperscript (is_superscript)
| 为选中的文本设置上标属性。 更多...
| SetTextColor (text_color)
| 为选中的文本设置文本颜色。 更多...
| SetUnderline (is_underline)
| 为选中的文本设置下划线。 更多...
| StartEditing (page_index, start_point, end_point)
| 退出段落编辑。 更多...

## 静态 Public 属性
static | e_BulletTypeBlackDiamondMinusWhite
| 项目符号类型：黑色菱形减去白色。
static | e_BulletTypeCheck
| 项目符号类型：勾选。
static | e_BulletTypeDiagonalUpRightArrow
| 项目符号类型：对角向右上箭头。
static | e_BulletTypeInverseTangentCircle
| 项目符号类型：反切圆。
static | e_BulletTypeNone
| 用于项目符号类型的枚举。 更多...
static | e_BulletTypeRightArrow
| 项目符号类型：右箭头（上白下黑）。
static | e_BulletTypeSolidCircle
| 项目符号类型：实心圆。
static | e_BulletTypeSolidDiamond
| 项目符号类型：实心菱形。
static | e_BulletTypeSolidRectangle
| 项目符号类型：实心矩形。
static | e_NumberingTypeDecimalDot
| 编号类型：1. 2. 3.
static | e_NumberingTypeDecimalRParen
| 编号类型：1) 2) 3)
static | e_NumberingTypeLowerLatinDot
| 编号类型：a. b. c.
static | e_NumberingTypeLowerLatinRParen
| 编号类型：a) b) c)
static | e_NumberingTypeNone
| 用于编号类型的枚举。 更多...
static | e_NumberingTypeUpperLatinDot
| 编号类型：A. B. C.

## 详细描述

此类表示段落编辑操作。 要启用段落编辑功能，用户必须调用函数 FSDK.ParagraphEditing.Activate，否则将 无法使用段落编辑功能。 用户不再使用段落编辑功能时，请调用函数 FSDK.ParagraphEditing.Deactivate 停止。

## 成员函数说明

## ◆ Activate()

FSDK::ParagraphEditing::Activate | ( |  | ) |

激活段落编辑。

## ◆ CanCopy()

FSDK::ParagraphEditing::CanCopy | ( |  | ) |

检查是否可以复制文本。

返回
  true 表示当前选中的文本对象可以被复制，而 false 表示不可以。

## ◆ CanCut()

FSDK::ParagraphEditing::CanCut | ( |  | ) |

检查是否可以剪切文本。

返回
  true 表示当前选中的文本可以被剪切，而 false 表示不可以。

## ◆ CanDelete()

FSDK::ParagraphEditing::CanDelete | ( |  | ) |

检查是否可以删除文本。

返回
  true 表示当前选中的文本可以被删除，而 false 表示不可以。

## ◆ CanDeselectAll()

FSDK::ParagraphEditing::CanDeselectAll | ( |  | ) |

检查是否可以取消全选文本。

返回
  true 表示当前可以取消选中所有文本，而 false 表示不可以。

## ◆ CanPaste()

FSDK::ParagraphEditing::CanPaste | ( |  | ) |

检查是否可以粘贴文本。

返回
  true 表示当前可以粘贴文本，而 false 表示不可以。

## ◆ CanSelectAll()

FSDK::ParagraphEditing::CanSelectAll | ( |  | ) |

检查是否可以全选文本。

返回
  true 表示当前所有文本可以被选中，而 false 表示不可以。

## ◆ CopySelected()

FSDK::ParagraphEditing::CopySelected | ( |  | ) |

复制选中的文本。

返回
  true 表示成功，而 false 表示失败。

## ◆ CutSelected()

FSDK::ParagraphEditing::CutSelected | ( |  | ) |

剪切选中的文本。

返回
  true 表示成功，而 false 表示失败。

## ◆ Deactivate()

FSDK::ParagraphEditing::Deactivate | ( |  | ) |

取消激活段落编辑。

返回
  true 表示成功，而 false 表示失败。

## ◆ Dedent()

FSDK::ParagraphEditing::Dedent | ( |  | ) |

为选中的文本移除缩进。

返回
  无。

## ◆ DeleteSelected()

FSDK::ParagraphEditing::DeleteSelected | ( |  | ) |

删除选中的文本。

返回
  true 表示成功，而 false 表示失败。

## ◆ DeselectAll()

FSDK::ParagraphEditing::DeselectAll | ( |  | ) |

取消选中所有文本。

返回
  true 表示成功，而 false 表示失败。

## ◆ ExitEditing()

FSDK::ParagraphEditing::ExitEditing | ( | is_end_directly |  | ) |

退出段落编辑。

参数

  [in] | is_end_directly | 是否直接结束编辑。

返回
  无。

## ◆ Indent()

FSDK::ParagraphEditing::Indent | ( |  | ) |

为选中的文本增加缩进。

返回
  无。

## ◆ InsertText()

FSDK::ParagraphEditing::InsertText | ( | text |  | ) |

当将文本插入到页面中时调用此函数。

参数

  [in] | text | 要插入的文本。

返回
  true 表示成功，而 false 表示失败。

## ◆ IsEmpty()

FSDK::ParagraphEditing::IsEmpty | ( |  | ) |

检查当前对象是否为空。

当当前对象为空时，表示当前对象无用。

返回
  true 表示当前对象为空，而 false 表示当前对象不为空。

## ◆ OnChar()

FSDK::ParagraphEditing::OnChar | ( | char_code |  | ) |

当将要输入字符代码时调用此函数。

参数

  [in] | char_code | 字符代码，使用 UTF16-LE 编码。

返回
  true 表示成功，而 false 表示失败。

## ◆ OnKeyDown()

FSDK::ParagraphEditing::OnKeyDown | ( | key_code |  | ) |

当键盘上的键按下时调用此函数。

参数

  [in] | key_code | 键代码。请参考从 FSDK.Filler.e_VkeyUnknown 开始的值， 这应该是这些值之一。

返回
  true 表示成功，而 false 表示失败。

## ◆ OnKeyUp()

FSDK::ParagraphEditing::OnKeyUp | ( | key_code |  | ) |

当键盘上的键弹起时调用此函数。

参数

  [in] | key_code | 键代码。请参考从 FSDK.Filler.e_VkeyUnknown 开始的值， 这应该是这些值之一。

返回
  true 表示成功，而 false 表示失败。

## ◆ OnLButtonDoubleClick()

FSDK::ParagraphEditing::OnLButtonDoubleClick | ( | page_index | ,
|  | point |
| ) |  |

当鼠标左键双击时调用此函数。

参数

  [in] | page | 有效的编辑器页面对象。
  [in] | point | 在页面中鼠标左键弹起的点，使用设备坐标系统。

返回
  true 表示成功，而 false 表示失败。

## ◆ OnLButtonDown()

FSDK::ParagraphEditing::OnLButtonDown | ( | page_index | ,
|  | point |
| ) |  |

当鼠标左键按下时调用此函数。

参数

  [in] | page | 有效的编辑器页面对象。
  [in] | point | 在页面中鼠标左键按下的点，使用设备坐标系统。

返回
  true 表示成功，而 false 表示失败。

## ◆ OnLButtonUp()

FSDK::ParagraphEditing::OnLButtonUp | ( | page_index | ,
|  | point |
| ) |  |

当鼠标左键弹起时调用此函数。

参数

  [in] | page | 有效的编辑器页面对象。
  [in] | point | 在页面中鼠标左键弹起的点，使用设备坐标系统。

返回
  true 表示成功，而 false 表示失败。

## ◆ OnMouseMove()

FSDK::ParagraphEditing::OnMouseMove | ( | page_index | ,
|  | point |
| ) |  |

当鼠标移动时调用此函数。

参数

  [in] | page | 有效的编辑器页面对象。
  [in] | point | 在页面中鼠标左键弹起的点，使用设备坐标系统。

返回
  true 表示成功，而 false 表示失败。

## ◆ OnMouseWheel()

FSDK::ParagraphEditing::OnMouseWheel | ( | page_index | ,
|  | point | ,
|  | delta |
| ) |  |

当鼠标滚轮移动时调用此函数。

参数

  [in] | page | 有效的编辑器页面对象。
  [in] | point | 在页面中鼠标左键弹起的点，使用设备坐标系统。
  [in] | delta | 指示鼠标滚轮已移动的量。正值表示向前移动， 而负值表示向后移动。

返回
  true 表示成功，而 false 表示失败。

## ◆ PasteSelected()

FSDK::ParagraphEditing::PasteSelected | ( |  | ) |

粘贴复制的文本。

返回
  true 表示成功，而 false 表示失败。

## ◆ Render()

FSDK::ParagraphEditing::Render | ( | page_index_array | ,
|  | renderer |
| ) |  |

在渲染器上绘制当前段落编辑操作状态。

此函数的渲染矩阵由 FSDK.ParagraphEditingProviderCallback.GetRenderMatrix 返回。

参数

  [in] | visible_editor_page | 要渲染的编辑器页面数组。
  [in] | renderer | 用于渲染的有效渲染器对象。

返回
  true 表示成功，而 false 表示失败。

## ◆ SelectAll()

FSDK::ParagraphEditing::SelectAll | ( |  | ) |

全选文本。

返回
  true 表示成功，而 false 表示失败。

## ◆ SetAlignment()

FSDK::ParagraphEditing::SetAlignment | ( | alignment |  | ) |

为选中的文本设置文本对齐方式。

参数

  [in] | alignment | 对齐方式值。请参考从 FSDK.e_AlignmentLeft 开始的值， 这应该是这些值之一。

返回
  无。

## ◆ SetBold()

FSDK::ParagraphEditing::SetBold | ( | is_bold |  | ) |

为选中的文本设置粗体状态。

参数

  [in] | is_bold | 是否将选中的文本设置为粗体。true 表示当前选中的文本将被设置为粗体，而 false 表示不设置。

返回
  无。

## ◆ SetBulletedList()

FSDK::ParagraphEditing::SetBulletedList | ( | bullet_type |  | ) |

为选中的文本设置项目符号列表。

参数

  [in] | bullet_type | 项目符号类型，请参考从 FSDK.ParagraphEditing.e_BulletTypeNone 开始的值， 这应该是这些值之一。

返回
  无。

## ◆ SetCharHorizontalScale()

FSDK::ParagraphEditing::SetCharHorizontalScale | ( | scale |  | ) |

为选中的文本设置字符水平缩放比例。

参数

  [in] | scale | 缩放比例。应该大于零。

返回
  无。

## ◆ SetCharSpace()

FSDK::ParagraphEditing::SetCharSpace | ( | char_space |  | ) |

为选中的文本设置字符间距。

参数

  [in] | char_space | 字符间距。单位为 pt（点）。

返回
  无。

## ◆ SetFontName()

FSDK::ParagraphEditing::SetFontName | ( | font_name |  | ) |

为选中的文本设置字体名称。

参数

  [in] | font_name | 字体名称。

返回
  无。

## ◆ SetFontSize()

FSDK::ParagraphEditing::SetFontSize | ( | font_size |  | ) |

为选中的文本设置字体大小。

参数

  [in] | font_size | 字体大小。

返回
  无。

## ◆ SetItalic()

FSDK::ParagraphEditing::SetItalic | ( | is_italic |  | ) |

为选中的文本设置斜体状态。

参数

  [in] | is_italic | 是否将选中的文本设置为斜体。true 表示当前选中的文本将被设置为斜体，而 false 表示不设置。

返回
  无。

## ◆ SetLineSpace()

FSDK::ParagraphEditing::SetLineSpace | ( | line_space |  | ) |

为选中的文本设置行间距。

参数

  [in] | line_space | 行间距。单位为 pt（点）。

返回
  无。

## ◆ SetNumberedList()

FSDK::ParagraphEditing::SetNumberedList | ( | numbering_type |  | ) |

为选中的文本更改编号样式。

参数

  [in] | numbering_type | 编号类型，请参考从 FSDK.ParagraphEditing.e_NumberingTypeNone 开始的值， 这应该是这些值之一。

返回
  无。

## ◆ SetParagraphSpacing()

FSDK::ParagraphEditing::SetParagraphSpacing | ( | paragraph_space |  | ) |

为选中的文本设置段落间距。

参数

  [in] | paragraph_space | 行距。

返回
  无。

## ◆ SetStrikethrough()

FSDK::ParagraphEditing::SetStrikethrough | ( | is_striketrough |  | ) |

为选中的文本设置删除线样式。

参数

  [in] | is_striketrough | 是否设置删除线样式。true 表示设置，而 false 表示不设置。

返回
  无。

## ◆ SetSubscript()

FSDK::ParagraphEditing::SetSubscript | ( | is_subscript |  | ) |

为选中的文本设置下标属性。

参数

  [in] | is_sub_script | 是否设置下标属性。 true 表示设置，而 false 表示不设置。

返回
  无。

## ◆ SetSuperscript()

FSDK::ParagraphEditing::SetSuperscript | ( | is_superscript |  | ) |

为选中的文本设置上标属性。

参数

  [in] | is_super_set | 是否设置上标属性。 true 表示设置，而 false 表示不设置。

返回
  无。

## ◆ SetTextColor()

FSDK::ParagraphEditing::SetTextColor | ( | text_color |  | ) |

为选中的文本设置文本颜色。

参数

  [in] | text_color | 文本颜色。

返回
  无。

## ◆ SetUnderline()

FSDK::ParagraphEditing::SetUnderline | ( | is_underline |  | ) |

为选中的文本设置下划线。

参数

  [in] | is_underline | 是否添加下划线。true 表示添加下划线，而 false 表示不添加。

返回
  无。

## ◆ StartEditing()

FSDK::ParagraphEditing::StartEditing | ( | page_index | ,
|  | start_point | ,
|  | end_point |
| ) |  |

退出段落编辑。

参数

  [in] | page_index | 页面索引。
  [in] | start_point | 在页面上开始编辑的点，使用设备坐标系统。
  [in] | end_point | 在页面上结束编辑的点，使用设备坐标系统。

返回
  无。

## 类成员变量说明

## ◆ e_BulletTypeNone

FSDK::ParagraphEditing::e_BulletTypeNone
| static

用于项目符号类型的枚举。

此枚举的值应单独使用。

项目符号类型：无。

## ◆ e_NumberingTypeNone

FSDK::ParagraphEditing::e_NumberingTypeNone
| static

用于编号类型的枚举。

此枚举的值应单独使用。

编号类型：无。