Word.Interfaces.BodyData interface

包:: word

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

注解

使用方

Word.正文：toJSON

属性

contentControls	获取正文中 RTF 内容控件对象的集合。
fields	获取正文中的对象集合 `Field` 。
font	获取正文的文本格式。使用此对象获取和设置字体名称、大小、颜色和其他属性。
inlinePictures	获取正文中的对象集合 `InlinePicture` 。该集合不包括浮动图像。
lists	获取正文中的对象集合 `List` 。
paragraphs	获取正文中的对象集合 `Paragraph` 。
shapes	获取正文中的对象集合 `Shape` ，包括内联形状和浮动形状。目前仅支持以下形状：文本框、几何形状、组、图片和画布。
style	指定正文的样式名称。请对自定义样式和本地化样式名称使用此属性。若要使用可以在区域设置之间移植的嵌入样式，请参阅“styleBuiltIn”属性。
styleBuiltIn	指定正文的内置样式名称。请对可以在区域设置之间移植的嵌入样式使用此属性。若要使用自定义样式或本地化样式名称，请参阅“style”属性。
tables	获取正文中的对象集合 `Table` 。
text	获取正文的文本。使用 `insertText` 插入文本的方法。
type	获取 body 的类型。类型可以是 `mainDoc`、`section`、`header`、 `footer`或。`tableCell` WordApi 1.5 及更高版本支持其他类型 `footnote`、 `endnote`和 `noteItem` 。

属性详细信息

contentControls

获取正文中 RTF 内容控件对象的集合。

contentControls?: Word.Interfaces.ContentControlData[];

属性值

Word.Interfaces.ContentControlData[]

注解

API 集：WordApi 1.1

fields

获取正文中的对象集合 Field 。

fields?: Word.Interfaces.FieldData[];

属性值

Word.Interfaces.FieldData[]

注解

API 集：WordApi 1.4

font

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

font?: Word.Interfaces.FontData;

属性值

Word.Interfaces.FontData

注解

API 集：WordApi 1.1

inlinePictures

获取正文中的对象集合 InlinePicture 。该集合不包括浮动图像。

inlinePictures?: Word.Interfaces.InlinePictureData[];

属性值

Word.Interfaces.InlinePictureData[]

注解

API 集：WordApi 1.1

lists

获取正文中的对象集合 List 。

lists?: Word.Interfaces.ListData[];

属性值

Word.Interfaces.ListData[]

注解

API 集：WordApi 1.3

paragraphs

获取正文中的对象集合 Paragraph 。

paragraphs?: Word.Interfaces.ParagraphData[];

属性值

Word.Interfaces.ParagraphData[]

注解

API 集：WordApi 1.1

重要提示：要求集 1.1 和 1.2 不会返回表中的段落。从要求集 1.3 中，还返回表中的段落。

shapes

获取正文中的对象集合 Shape ，包括内联形状和浮动形状。目前仅支持以下形状：文本框、几何形状、组、图片和画布。

shapes?: Word.Interfaces.ShapeData[];

属性值

Word.Interfaces.ShapeData[]

注解

API 集：WordApiDesktop 1.2

重要提示：请注意，随着时间的推移，可能会支持其他类型的形状。因此，加载项应请求和处理特定类型的形状。

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";

属性值

注解

API 集：WordApi 1.3

tables

获取正文中的对象集合 Table 。

tables?: Word.Interfaces.TableData[];

属性值

Word.Interfaces.TableData[]

注解

API 集：WordApi 1.3

text

获取正文的文本。使用 insertText 插入文本的方法。

text?: string;

属性值

string

注解

API 集：WordApi 1.1

type

获取 body 的类型。类型可以是 mainDoc、section、header、 footer或。tableCell WordApi 1.5 及更高版本支持其他类型 footnote、 endnote和 noteItem 。

type?: Word.BodyType | "Unknown" | "MainDoc" | "Section" | "Header" | "Footer" | "TableCell" | "Footnote" | "Endnote" | "NoteItem" | "Shape";

属性值

注解

API 集：WordApi 1.3

反馈

此页面是否有帮助？