Word.Interfaces.ParagraphLoadOptions interface

表示选定内容、区域、内容控件或文档正文中的单个段落。

属性

$all

指定加载选项将 $all 加载所有标量属性 ((如 Range.address) ),但不会加载导航属性 ((如 Range.format.fill.color) )。

alignment

指定段落的对齐方式。 值可以是 leftcenteredright 或 。justified

firstLineIndent

指定首行或悬挂缩进的值(以磅为单位)。 用正数设置首行缩进的尺寸,用负数设置悬挂缩进的尺寸。

font

获取段落的文本格式。 使用此对象获取和设置字体名称、大小、颜色和其他属性。

isLastParagraph

指明 paragraph 是其父正文内的最后一个段落。

isListItem

检查 paragraph 是否为 listItem。

leftIndent

指定段落的左缩进值(以磅为单位)。

lineSpacing

指定指定段落的行距(以磅为单位)。 在 Word UI 中,该值应除以 12。

lineUnitAfter

指定段落后网格线的间距。

lineUnitBefore

以网格线为单位指定段落前面的间距。

list

获取 paragraph 所属的 List。 如果段落不在列表中,则引发 ItemNotFound 错误。

listItem

获取 paragraph 的 ListItem。 如果段落不在列表中,则引发 ItemNotFound 错误。

listItemOrNullObject

获取 paragraph 的 ListItem。 如果段落不是列表的一部分,则此方法将返回其 isNullObject 属性设置为 true的对象。 有关详细信息,请参阅 *OrNullObject 方法和属性

listOrNullObject

获取 paragraph 所属的 List。 如果段落不在列表中,则此方法将返回其 isNullObject 属性设置为 true的对象。 有关详细信息,请参阅 *OrNullObject 方法和属性

outlineLevel

指定段落的大纲级别。

parentBody

获取 paragraph 的父正文。

parentContentControl

获取包含段落的内容控件。 如果没有父内容控件,则引发 ItemNotFound 错误。

parentContentControlOrNullObject

获取包含段落的内容控件。 如果没有父内容控件,则此方法将返回其 isNullObject 属性设置为 true的对象。 有关详细信息,请参阅 *OrNullObject 方法和属性

parentTable

获取包含 paragraph 的 table。 如果表中未包含,则引发 ItemNotFound 错误。

parentTableCell

获取包含 paragraph 的 tableCell。 如果表单元格中未包含错误,则引发 ItemNotFound 错误。

parentTableCellOrNullObject

获取包含 paragraph 的 tableCell。 如果它未包含在表单元格中,则此方法将返回其 isNullObject 属性设置为 true的对象。 有关详细信息,请参阅 *OrNullObject 方法和属性

parentTableOrNullObject

获取包含 paragraph 的 table。 如果它未包含在表中,则此方法将返回其 isNullObject 属性设置为 true的对象。 有关详细信息,请参阅 *OrNullObject 方法和属性

rightIndent

指定段落的右缩进值(以磅为单位)。

shading

返回 ShadingUniversal 引用段落底纹格式的对象。

spaceAfter

指定段落后段距(以磅为单位)。

spaceBefore

指定段落前的间距(以磅为单位)。

style

指定段落的样式名称。 请对自定义样式和本地化样式名称使用此属性。 若要使用可以在区域设置之间移植的嵌入样式,请参阅“styleBuiltIn”属性。

styleBuiltIn

指定段落的内置样式名称。 请对可以在区域设置之间移植的嵌入样式使用此属性。 若要使用自定义样式或本地化样式名称,请参阅“style”属性。

tableNestingLevel

获取 paragraph 的表级别。 如果段落不在表格中,它将返回 0。

text

获取段落的文本。

uniqueLocalId

获取表示当前会话中段落标识符的字符串。 ID 采用不带大括号的标准 8-4-4-4-12 GUID 格式,并且在会话和共同创作者之间有所不同。

属性详细信息

$all

指定加载选项将 $all 加载所有标量属性 ((如 Range.address) ),但不会加载导航属性 ((如 Range.format.fill.color) )。

$all?: boolean;

属性值

boolean

alignment

指定段落的对齐方式。 值可以是 leftcenteredright 或 。justified

alignment?: boolean;

属性值

boolean

注解

API 集:WordApi 1.1

firstLineIndent

指定首行或悬挂缩进的值(以磅为单位)。 用正数设置首行缩进的尺寸,用负数设置悬挂缩进的尺寸。

firstLineIndent?: boolean;

属性值

boolean

注解

API 集:WordApi 1.1

font

获取段落的文本格式。 使用此对象获取和设置字体名称、大小、颜色和其他属性。

font?: Word.Interfaces.FontLoadOptions;

属性值

注解

API 集:WordApi 1.1

isLastParagraph

指明 paragraph 是其父正文内的最后一个段落。

isLastParagraph?: boolean;

属性值

boolean

注解

API 集:WordApi 1.3

isListItem

检查 paragraph 是否为 listItem。

isListItem?: boolean;

属性值

boolean

注解

API 集:WordApi 1.3

leftIndent

指定段落的左缩进值(以磅为单位)。

leftIndent?: boolean;

属性值

boolean

注解

API 集:WordApi 1.1

lineSpacing

指定指定段落的行距(以磅为单位)。 在 Word UI 中,该值应除以 12。

lineSpacing?: boolean;

属性值

boolean

注解

API 集:WordApi 1.1

lineUnitAfter

指定段落后网格线的间距。

lineUnitAfter?: boolean;

属性值

boolean

注解

API 集:WordApi 1.1

lineUnitBefore

以网格线为单位指定段落前面的间距。

lineUnitBefore?: boolean;

属性值

boolean

注解

API 集:WordApi 1.1

list

获取 paragraph 所属的 List。 如果段落不在列表中,则引发 ItemNotFound 错误。

list?: Word.Interfaces.ListLoadOptions;

属性值

注解

API 集:WordApi 1.3

listItem

获取 paragraph 的 ListItem。 如果段落不在列表中,则引发 ItemNotFound 错误。

listItem?: Word.Interfaces.ListItemLoadOptions;

属性值

注解

API 集:WordApi 1.3

listItemOrNullObject

获取 paragraph 的 ListItem。 如果段落不是列表的一部分,则此方法将返回其 isNullObject 属性设置为 true的对象。 有关详细信息,请参阅 *OrNullObject 方法和属性

listItemOrNullObject?: Word.Interfaces.ListItemLoadOptions;

属性值

注解

API 集:WordApi 1.3

listOrNullObject

获取 paragraph 所属的 List。 如果段落不在列表中,则此方法将返回其 isNullObject 属性设置为 true的对象。 有关详细信息,请参阅 *OrNullObject 方法和属性

listOrNullObject?: Word.Interfaces.ListLoadOptions;

属性值

注解

API 集:WordApi 1.3

outlineLevel

指定段落的大纲级别。

outlineLevel?: boolean;

属性值

boolean

注解

API 集:WordApi 1.1

parentBody

获取 paragraph 的父正文。

parentBody?: Word.Interfaces.BodyLoadOptions;

属性值

注解

API 集:WordApi 1.3

parentContentControl

获取包含段落的内容控件。 如果没有父内容控件,则引发 ItemNotFound 错误。

parentContentControl?: Word.Interfaces.ContentControlLoadOptions;

属性值

注解

API 集:WordApi 1.1

parentContentControlOrNullObject

获取包含段落的内容控件。 如果没有父内容控件,则此方法将返回其 isNullObject 属性设置为 true的对象。 有关详细信息,请参阅 *OrNullObject 方法和属性

parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions;

属性值

注解

API 集:WordApi 1.3

parentTable

获取包含 paragraph 的 table。 如果表中未包含,则引发 ItemNotFound 错误。

parentTable?: Word.Interfaces.TableLoadOptions;

属性值

注解

API 集:WordApi 1.3

parentTableCell

获取包含 paragraph 的 tableCell。 如果表单元格中未包含错误,则引发 ItemNotFound 错误。

parentTableCell?: Word.Interfaces.TableCellLoadOptions;

属性值

注解

API 集:WordApi 1.3

parentTableCellOrNullObject

获取包含 paragraph 的 tableCell。 如果它未包含在表单元格中,则此方法将返回其 isNullObject 属性设置为 true的对象。 有关详细信息,请参阅 *OrNullObject 方法和属性

parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions;

属性值

注解

API 集:WordApi 1.3

parentTableOrNullObject

获取包含 paragraph 的 table。 如果它未包含在表中,则此方法将返回其 isNullObject 属性设置为 true的对象。 有关详细信息,请参阅 *OrNullObject 方法和属性

parentTableOrNullObject?: Word.Interfaces.TableLoadOptions;

属性值

注解

API 集:WordApi 1.3

rightIndent

指定段落的右缩进值(以磅为单位)。

rightIndent?: boolean;

属性值

boolean

注解

API 集:WordApi 1.1

shading

返回 ShadingUniversal 引用段落底纹格式的对象。

shading?: Word.Interfaces.ShadingUniversalLoadOptions;

属性值

注解

API 集:WordApiDesktop 1.3

spaceAfter

指定段落后段距(以磅为单位)。

spaceAfter?: boolean;

属性值

boolean

注解

API 集:WordApi 1.1

spaceBefore

指定段落前的间距(以磅为单位)。

spaceBefore?: boolean;

属性值

boolean

注解

API 集:WordApi 1.1

style

指定段落的样式名称。 请对自定义样式和本地化样式名称使用此属性。 若要使用可以在区域设置之间移植的嵌入样式,请参阅“styleBuiltIn”属性。

style?: boolean;

属性值

boolean

注解

API 集:WordApi 1.1

styleBuiltIn

指定段落的内置样式名称。 请对可以在区域设置之间移植的嵌入样式使用此属性。 若要使用自定义样式或本地化样式名称,请参阅“style”属性。

styleBuiltIn?: boolean;

属性值

boolean

注解

API 集:WordApi 1.3

tableNestingLevel

获取 paragraph 的表级别。 如果段落不在表格中,它将返回 0。

tableNestingLevel?: boolean;

属性值

boolean

注解

API 集:WordApi 1.3

text

获取段落的文本。

text?: boolean;

属性值

boolean

注解

API 集:WordApi 1.1

uniqueLocalId

获取表示当前会话中段落标识符的字符串。 ID 采用不带大括号的标准 8-4-4-4-12 GUID 格式,并且在会话和共同创作者之间有所不同。

uniqueLocalId?: boolean;

属性值

boolean

注解

API 集:WordApi 1.6