Word.Interfaces.ParagraphData interface

一个接口,用于描述通过调用 paragraph.toJSON()返回的数据。

属性

alignment

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

borders

返回一个 BorderUniversalCollection 对象,该对象代表段落的所有边框。

fields

获取段落中字段的集合。

firstLineIndent

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

font

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

inlinePictures

获取段落中对象的集合 InlinePicture 。 集合不包括浮动图像。

isLastParagraph

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

isListItem

检查 paragraph 是否为 listItem。

leftIndent

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

lineSpacing

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

lineUnitAfter

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

lineUnitBefore

指定段落前的网格线间距量。

listItem

获取 paragraph 的 ListItem。 如果段落不是列表的一 ItemNotFound 部分,则引发错误。

listItemOrNullObject

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

outlineLevel

指定段落的大纲级别。

rightIndent

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

shading

返回一个 ShadingUniversal 对象,该对象引用段落的底纹格式。

shapes

获取在段落中定位的对象集合 Shape ,包括内联形状和浮动形状。 目前,仅支持以下形状:文本框、几何形状、组、图片和画布。

spaceAfter

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

spaceBefore

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

style

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

styleBuiltIn

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

tableNestingLevel

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

text

获取段落的文本。

uniqueLocalId

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

属性详细信息

alignment

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

alignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified";

属性值

Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"

注解

[ API 集:WordApi 1.1 ]

borders

返回一个 BorderUniversalCollection 对象,该对象代表段落的所有边框。

borders?: Word.Interfaces.BorderUniversalData[];

属性值

注解

[ API 集:WordApiDesktop 1.3 ]

fields

获取段落中字段的集合。

fields?: Word.Interfaces.FieldData[];

属性值

注解

[ API 集:WordApi 1.4 ]

firstLineIndent

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

firstLineIndent?: number;

属性值

number

注解

[ API 集:WordApi 1.1 ]

font

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

font?: Word.Interfaces.FontData;

属性值

注解

[ API 集:WordApi 1.1 ]

inlinePictures

获取段落中对象的集合 InlinePicture 。 集合不包括浮动图像。

inlinePictures?: Word.Interfaces.InlinePictureData[];

属性值

注解

[ 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?: number;

属性值

number

注解

[ API 集:WordApi 1.1 ]

lineSpacing

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

lineSpacing?: number;

属性值

number

注解

[ API 集:WordApi 1.1 ]

lineUnitAfter

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

lineUnitAfter?: number;

属性值

number

注解

[ API 集:WordApi 1.1 ]

lineUnitBefore

指定段落前的网格线间距量。

lineUnitBefore?: number;

属性值

number

注解

[ API 集:WordApi 1.1 ]

listItem

获取 paragraph 的 ListItem。 如果段落不是列表的一 ItemNotFound 部分,则引发错误。

listItem?: Word.Interfaces.ListItemData;

属性值

注解

[ API 集:WordApi 1.3 ]

listItemOrNullObject

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

listItemOrNullObject?: Word.Interfaces.ListItemData;

属性值

注解

[ API 集:WordApi 1.3 ]

outlineLevel

指定段落的大纲级别。

outlineLevel?: number;

属性值

number

注解

[ API 集:WordApi 1.1 ]

rightIndent

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

rightIndent?: number;

属性值

number

注解

[ API 集:WordApi 1.1 ]

shading

返回一个 ShadingUniversal 对象,该对象引用段落的底纹格式。

shading?: Word.Interfaces.ShadingUniversalData;

属性值

注解

[ API 集:WordApiDesktop 1.3 ]

shapes

获取在段落中定位的对象集合 Shape ,包括内联形状和浮动形状。 目前,仅支持以下形状:文本框、几何形状、组、图片和画布。

shapes?: Word.Interfaces.ShapeData[];

属性值

注解

[ API 集:WordApiDesktop 1.2 ]

重要提示:请注意,随着时间的推移,可能会支持其他类型的形状。 因此,外接程序应请求并处理特定类型的形状。

spaceAfter

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

spaceAfter?: number;

属性值

number

注解

[ API 集:WordApi 1.1 ]

spaceBefore

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

spaceBefore?: number;

属性值

number

注解

[ API 集:WordApi 1.1 ]

style

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

style?: string;

属性值

string

注解

[ API 集:WordApi 1.1 ]

styleBuiltIn

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

styleBuiltIn?: Word.BuiltInStyleName | "Other" | "Normal" | "Heading1" | "Heading2" | "Heading3" | "Heading4" | "Heading5" | "Heading6" | "Heading7" | "Heading8" | "Heading9" | "Toc1" | "Toc2" | "Toc3" | "Toc4" | "Toc5" | "Toc6" | "Toc7" | "Toc8" | "Toc9" | "FootnoteText" | "Header" | "Footer" | "Caption" | "FootnoteReference" | "EndnoteReference" | "EndnoteText" | "Title" | "Subtitle" | "Hyperlink" | "Strong" | "Emphasis" | "NoSpacing" | "ListParagraph" | "Quote" | "IntenseQuote" | "SubtleEmphasis" | "IntenseEmphasis" | "SubtleReference" | "IntenseReference" | "BookTitle" | "Bibliography" | "TocHeading" | "TableGrid" | "PlainTable1" | "PlainTable2" | "PlainTable3" | "PlainTable4" | "PlainTable5" | "TableGridLight" | "GridTable1Light" | "GridTable1Light_Accent1" | "GridTable1Light_Accent2" | "GridTable1Light_Accent3" | "GridTable1Light_Accent4" | "GridTable1Light_Accent5" | "GridTable1Light_Accent6" | "GridTable2" | "GridTable2_Accent1" | "GridTable2_Accent2" | "GridTable2_Accent3" | "GridTable2_Accent4" | "GridTable2_Accent5" | "GridTable2_Accent6" | "GridTable3" | "GridTable3_Accent1" | "GridTable3_Accent2" | "GridTable3_Accent3" | "GridTable3_Accent4" | "GridTable3_Accent5" | "GridTable3_Accent6" | "GridTable4" | "GridTable4_Accent1" | "GridTable4_Accent2" | "GridTable4_Accent3" | "GridTable4_Accent4" | "GridTable4_Accent5" | "GridTable4_Accent6" | "GridTable5Dark" | "GridTable5Dark_Accent1" | "GridTable5Dark_Accent2" | "GridTable5Dark_Accent3" | "GridTable5Dark_Accent4" | "GridTable5Dark_Accent5" | "GridTable5Dark_Accent6" | "GridTable6Colorful" | "GridTable6Colorful_Accent1" | "GridTable6Colorful_Accent2" | "GridTable6Colorful_Accent3" | "GridTable6Colorful_Accent4" | "GridTable6Colorful_Accent5" | "GridTable6Colorful_Accent6" | "GridTable7Colorful" | "GridTable7Colorful_Accent1" | "GridTable7Colorful_Accent2" | "GridTable7Colorful_Accent3" | "GridTable7Colorful_Accent4" | "GridTable7Colorful_Accent5" | "GridTable7Colorful_Accent6" | "ListTable1Light" | "ListTable1Light_Accent1" | "ListTable1Light_Accent2" | "ListTable1Light_Accent3" | "ListTable1Light_Accent4" | "ListTable1Light_Accent5" | "ListTable1Light_Accent6" | "ListTable2" | "ListTable2_Accent1" | "ListTable2_Accent2" | "ListTable2_Accent3" | "ListTable2_Accent4" | "ListTable2_Accent5" | "ListTable2_Accent6" | "ListTable3" | "ListTable3_Accent1" | "ListTable3_Accent2" | "ListTable3_Accent3" | "ListTable3_Accent4" | "ListTable3_Accent5" | "ListTable3_Accent6" | "ListTable4" | "ListTable4_Accent1" | "ListTable4_Accent2" | "ListTable4_Accent3" | "ListTable4_Accent4" | "ListTable4_Accent5" | "ListTable4_Accent6" | "ListTable5Dark" | "ListTable5Dark_Accent1" | "ListTable5Dark_Accent2" | "ListTable5Dark_Accent3" | "ListTable5Dark_Accent4" | "ListTable5Dark_Accent5" | "ListTable5Dark_Accent6" | "ListTable6Colorful" | "ListTable6Colorful_Accent1" | "ListTable6Colorful_Accent2" | "ListTable6Colorful_Accent3" | "ListTable6Colorful_Accent4" | "ListTable6Colorful_Accent5" | "ListTable6Colorful_Accent6" | "ListTable7Colorful" | "ListTable7Colorful_Accent1" | "ListTable7Colorful_Accent2" | "ListTable7Colorful_Accent3" | "ListTable7Colorful_Accent4" | "ListTable7Colorful_Accent5" | "ListTable7Colorful_Accent6";

属性值

Word.BuiltInStyleName | "Other" | "Normal" | "Heading1" | "Heading2" | "Heading3" | "Heading4" | "Heading5" | "Heading6" | "Heading7" | "Heading8" | "Heading9" | "Toc1" | "Toc2" | "Toc3" | "Toc4" | "Toc5" | "Toc6" | "Toc7" | "Toc8" | "Toc9" | "FootnoteText" | "Header" | "Footer" | "Caption" | "FootnoteReference" | "EndnoteReference" | "EndnoteText" | "Title" | "Subtitle" | "Hyperlink" | "Strong" | "Emphasis" | "NoSpacing" | "ListParagraph" | "Quote" | "IntenseQuote" | "SubtleEmphasis" | "IntenseEmphasis" | "SubtleReference" | "IntenseReference" | "BookTitle" | "Bibliography" | "TocHeading" | "TableGrid" | "PlainTable1" | "PlainTable2" | "PlainTable3" | "PlainTable4" | "PlainTable5" | "TableGridLight" | "GridTable1Light" | "GridTable1Light_Accent1" | "GridTable1Light_Accent2" | "GridTable1Light_Accent3" | "GridTable1Light_Accent4" | "GridTable1Light_Accent5" | "GridTable1Light_Accent6" | "GridTable2" | "GridTable2_Accent1" | "GridTable2_Accent2" | "GridTable2_Accent3" | "GridTable2_Accent4" | "GridTable2_Accent5" | "GridTable2_Accent6" | "GridTable3" | "GridTable3_Accent1" | "GridTable3_Accent2" | "GridTable3_Accent3" | "GridTable3_Accent4" | "GridTable3_Accent5" | "GridTable3_Accent6" | "GridTable4" | "GridTable4_Accent1" | "GridTable4_Accent2" | "GridTable4_Accent3" | "GridTable4_Accent4" | "GridTable4_Accent5" | "GridTable4_Accent6" | "GridTable5Dark" | "GridTable5Dark_Accent1" | "GridTable5Dark_Accent2" | "GridTable5Dark_Accent3" | "GridTable5Dark_Accent4" | "GridTable5Dark_Accent5" | "GridTable5Dark_Accent6" | "GridTable6Colorful" | "GridTable6Colorful_Accent1" | "GridTable6Colorful_Accent2" | "GridTable6Colorful_Accent3" | "GridTable6Colorful_Accent4" | "GridTable6Colorful_Accent5" | "GridTable6Colorful_Accent6" | "GridTable7Colorful" | "GridTable7Colorful_Accent1" | "GridTable7Colorful_Accent2" | "GridTable7Colorful_Accent3" | "GridTable7Colorful_Accent4" | "GridTable7Colorful_Accent5" | "GridTable7Colorful_Accent6" | "ListTable1Light" | "ListTable1Light_Accent1" | "ListTable1Light_Accent2" | "ListTable1Light_Accent3" | "ListTable1Light_Accent4" | "ListTable1Light_Accent5" | "ListTable1Light_Accent6" | "ListTable2" | "ListTable2_Accent1" | "ListTable2_Accent2" | "ListTable2_Accent3" | "ListTable2_Accent4" | "ListTable2_Accent5" | "ListTable2_Accent6" | "ListTable3" | "ListTable3_Accent1" | "ListTable3_Accent2" | "ListTable3_Accent3" | "ListTable3_Accent4" | "ListTable3_Accent5" | "ListTable3_Accent6" | "ListTable4" | "ListTable4_Accent1" | "ListTable4_Accent2" | "ListTable4_Accent3" | "ListTable4_Accent4" | "ListTable4_Accent5" | "ListTable4_Accent6" | "ListTable5Dark" | "ListTable5Dark_Accent1" | "ListTable5Dark_Accent2" | "ListTable5Dark_Accent3" | "ListTable5Dark_Accent4" | "ListTable5Dark_Accent5" | "ListTable5Dark_Accent6" | "ListTable6Colorful" | "ListTable6Colorful_Accent1" | "ListTable6Colorful_Accent2" | "ListTable6Colorful_Accent3" | "ListTable6Colorful_Accent4" | "ListTable6Colorful_Accent5" | "ListTable6Colorful_Accent6" | "ListTable7Colorful" | "ListTable7Colorful_Accent1" | "ListTable7Colorful_Accent2" | "ListTable7Colorful_Accent3" | "ListTable7Colorful_Accent4" | "ListTable7Colorful_Accent5" | "ListTable7Colorful_Accent6"

注解

[ API 集:WordApi 1.3 ]

tableNestingLevel

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

tableNestingLevel?: number;

属性值

number

注解

[ API 集:WordApi 1.3 ]

text

获取段落的文本。

text?: string;

属性值

string

注解

[ API 集:WordApi 1.1 ]

uniqueLocalId

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

uniqueLocalId?: string;

属性值

string

注解

[ API 集:WordApi 1.6 ]