fsdk.ParagraphEditing类 参考

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

详细描述

此类表示段落编辑操作。 在使用段落编辑功能的任何方法之前，请确保已调用函数 fsdk.ParagraphEditing.Activate 。 不需要使用任何段落编辑功能时，请调用函数 fsdk.ParagraphEditing.Deactivate 来停用。

成员函数说明

Activate()

def fsdk.ParagraphEditing.Activate

(

)

激活段落编辑。

返回

true 表示成功，false 表示失败。

CanCopy()

def fsdk.ParagraphEditing.CanCopy

(

)

检查是否可以复制文本。

返回

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

CanCut()

def fsdk.ParagraphEditing.CanCut

(

)

检查是否可以剪切文本。

返回

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

CanDelete()

def fsdk.ParagraphEditing.CanDelete

(

)

检查是否可以删除文本。

返回

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

CanDeselectAll()

def fsdk.ParagraphEditing.CanDeselectAll

(

)

检查是否可以取消选择所有文本。

返回

true 表示当前选中的文本可以被取消选择，false 表示不可以。

CanPaste()

def fsdk.ParagraphEditing.CanPaste

(

)

检查是否可以粘贴文本。

返回

true 表示当前选中的文本可以被粘贴，false 表示不可以。

CanSelectAll()

def fsdk.ParagraphEditing.CanSelectAll

(

)

检查是否可以全选文本。

返回

true 表示当前所有文本可以被选择，false 表示不可以。

CopySelected()

def fsdk.ParagraphEditing.CopySelected

(

)

复制选中的文本。

返回

true 表示成功，false 表示失败。

CutSelected()

def fsdk.ParagraphEditing.CutSelected

(

)

剪切选中的文本。

返回

true 表示成功，false 表示失败。

Deactivate()

def fsdk.ParagraphEditing.Deactivate

(

)

停用段落编辑。

返回

true 表示成功，false 表示失败。

Dedent()

def fsdk.ParagraphEditing.Dedent

(

)

减少文本缩进。

返回

无。

DeleteSelected()

def fsdk.ParagraphEditing.DeleteSelected

(

)

删除选中的文本。

返回

true 表示成功，false 表示失败。

DeselectAll()

def fsdk.ParagraphEditing.DeselectAll

(

)

取消选择所有文本。

返回

true 表示成功，false 表示失败。

ExitEditing()

def fsdk.ParagraphEditing.ExitEditing

(

is_end_directly

)

退出段落编辑。

参数

[in]

is_end_directly

是否直接结束编辑。

返回

无。

Indent()

def fsdk.ParagraphEditing.Indent

(

)

增加文本缩进。

返回

无。

InsertText()

def fsdk.ParagraphEditing.InsertText

(

text

)

在页面中插入文本时调用此函数。

参数

[in]

text

要插入的文本。

返回

true 表示成功，false 表示失败。

IsEmpty()

def fsdk.ParagraphEditing.IsEmpty

(

)

检查当前对象是否为空。

当当前对象为空时，意味着当前对象无用。

返回

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

OnChar()

def fsdk.ParagraphEditing.OnChar

(

char_code

)

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

参数

[in]

char_code

字符代码，采用 UTF16-LE 编码。

返回

true 表示成功，false 表示失败。

OnKeyDown()

def fsdk.ParagraphEditing.OnKeyDown

(

key_code

)

键盘按键按下时调用此函数。

参数

[in]

key_code

键代码。请参考从 fsdk.FillerE_VkeyUnknown 开始的值， 应该是这些值中的一个。

返回

true 表示成功，false 表示失败。

OnKeyUp()

def fsdk.ParagraphEditing.OnKeyUp

(

key_code

)

键盘按键抬起时调用此函数。

参数

[in]

key_code

键代码。请参考从 fsdk.FillerE_VkeyUnknown 开始的值， 应该是这些值中的一个。

返回

true 表示成功，false 表示失败。

OnLButtonDoubleClick()

def fsdk.ParagraphEditing.OnLButtonDoubleClick	(		page_index,
			point
	)

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

参数

[in]	page_index	页面索引。
[in]	point	鼠标左键在页面中双击的点，以设备坐标系表示。

返回

true 表示成功，false 表示失败。

OnLButtonDown()

def fsdk.ParagraphEditing.OnLButtonDown	(		page_index,
			point
	)

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

参数

[in]	page_index	页面索引。
[in]	point	鼠标左键在页面中按下的点，以设备坐标系表示。

返回

true 表示成功，false 表示失败。

OnLButtonUp()

def fsdk.ParagraphEditing.OnLButtonUp	(		page_index,
			point
	)

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

参数

[in]	page_index	页面索引。
[in]	point	鼠标左键在页面中抬起的点，以设备坐标系表示。

返回

true 表示成功，false 表示失败。

OnMouseMove()

def fsdk.ParagraphEditing.OnMouseMove	(		page_index,
			point
	)

鼠标移动时调用此函数。

参数

[in]	page_index	页面索引。
[in]	point	鼠标在页面中的点，以设备坐标系表示。

返回

true 表示成功，false 表示失败。

OnMouseWheel()

def fsdk.ParagraphEditing.OnMouseWheel	(		page_index,
			point,
			delta
	)

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

参数

[in]	page_index	页面索引。
[in]	point	鼠标在页面中的点，以设备坐标系表示。
[in]	delta	指示鼠标滚轮移动的量。正值表示向前移动， 负值表示向后移动。

返回

true 表示成功，false 表示失败。

PasteSelected()

def fsdk.ParagraphEditing.PasteSelected

(

)

粘贴复制的文本。

返回

true 表示成功，false 表示失败。

Render()

def fsdk.ParagraphEditing.Render	(		page_index_array,
			renderer
	)

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

渲染过程中使用的矩阵由 fsdk.ParagraphEditingProviderCallback.GetRenderMatrix 返回。

参数

[in]	page_index_array	要渲染的页面索引数组。
[in]	renderer	用于渲染的有效渲染器对象。

返回

true 表示成功，false 表示失败。

SelectAll()

def fsdk.ParagraphEditing.SelectAll

(

)

全选文本。

返回

true 表示成功，false 表示失败。

SetAlignment()

def fsdk.ParagraphEditing.SetAlignment

(

alignment

)

为文本设置文本对齐方式。

参数

[in]

alignment

对齐值。请参考从 fsdk.E_AlignmentLeft 开始的值， 应该是这些值中的一个。

返回

无。

SetBold()

def fsdk.ParagraphEditing.SetBold

(

is_bold

)

为文本设置粗体状态。

参数

[in]

is_bold

是否将选中的文本设置为粗体。true 表示当前选中的文本将被设置为粗体，false 表示不设置。

返回

无。

SetBulletedList()

def fsdk.ParagraphEditing.SetBulletedList

(

bullet_type

)

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

在设置项目符号列表之前，请确保已安装 "wingding.ttf" 字体。

参数

[in]

bullet_type

项目符号类型。请参考从 开始的值， 应该是这些值中的一个。 无。

SetCharHorizontalScale()

def fsdk.ParagraphEditing.SetCharHorizontalScale

(

scale

)

为文本设置字符水平缩放。

参数

[in]

scale

缩放比例。应该大于 0。

返回

无。

SetCharSpace()

def fsdk.ParagraphEditing.SetCharSpace

(

char_space

)

为文本设置字符间距。

参数

[in]

char_space

字符间距（单位为 1/72 英寸）。

返回

无。

SetFontName()

def fsdk.ParagraphEditing.SetFontName

(

font_name

)

为文本设置字体名称。

参数

[in]

font_name

字体名称。

返回

无。

SetFontSize()

def fsdk.ParagraphEditing.SetFontSize

(

font_size

)

为文本设置字体大小。

参数

[in]

font_size

字体大小。

返回

无。

SetItalic()

def fsdk.ParagraphEditing.SetItalic

(

is_italic

)

为文本设置斜体状态。

参数

[in]

is_italic

是否将选中的文本设置为斜体。true 表示当前选中的文本将被设置为斜体，false 表示不设置。

返回

无。

SetLineSpace()

def fsdk.ParagraphEditing.SetLineSpace

(

line_space

)

为文本设置行间距。

参数

[in]

line_space

行间距（单位为 1/72 英寸）。

返回

无。

SetNumberedList()

def fsdk.ParagraphEditing.SetNumberedList

(

numbering_type

)

为文本设置编号列表的外观。

参数

[in]

numbering_type

编号类型。请参考从 开始的值， 应该是这些值中的一个。 无。

SetParagraphSpacing()

def fsdk.ParagraphEditing.SetParagraphSpacing

(

paragraph_space

)

为文本设置段落间距。

参数

[in]

paragraph_space

段落间距。

返回

无。

SetStrikethrough()

def fsdk.ParagraphEditing.SetStrikethrough

(

is_striketrough

)

为文本设置删除线样式。

参数

[in]

is_striketrough

true 表示设置删除线样式，false 表示不设置。

返回

无。

SetSubscript()

def fsdk.ParagraphEditing.SetSubscript

(

is_subscript

)

为文本设置下标属性。

返回

无。

SetSuperscript()

def fsdk.ParagraphEditing.SetSuperscript

(

is_superscript

)

为文本设置上标属性。

返回

无。

SetTextColor()

def fsdk.ParagraphEditing.SetTextColor

(

text_color

)

为文本设置文本颜色。

参数

[in]

text_color

文本颜色。

返回

无。

SetUnderline()

def fsdk.ParagraphEditing.SetUnderline

(

is_underline

)

为文本设置下划线。

参数

[in]

is_underline

true 表示给文本加下划线，false 表示不加。

返回

无。

StartEditing()

def fsdk.ParagraphEditing.StartEditing	(		page_index,
			start_point,
			end_point
	)

开始段落编辑。

参数

[in]	page_index	页面索引。
[in]	start_point	在页面上开始编辑的点，以设备坐标系表示。
[in]	end_point	在页面上结束编辑的点，以设备坐标系表示。

返回

无。