Word.Interfaces.BodyLoadOptions interface

表示文档或节的正文。

注解

[ API 集:WordApi 1.1 ]

属性

$all

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

font

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

parentBody

获取 body 的父正文。 例如,表格单元格 body 的父正文可能是标题。 ItemNotFound如果没有父正文,则引发错误。

parentBodyOrNullObject

获取 body 的父正文。 例如,表格单元格 body 的父正文可能是标题。 如果没有父正文,则此方法将返回其属性设置为 true的对象isNullObject。 有关详细信息,请参阅 *OrNullObject 方法和属性

parentContentControl

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

parentContentControlOrNullObject

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

parentSection

获取 body 的父节。 如果没有父节,则 ItemNotFound 引发错误。

parentSectionOrNullObject

获取 body 的父节。 如果没有父节,则此方法将返回一个对象,其 isNullObject 属性设置为 true。 有关详细信息,请参阅 *OrNullObject 方法和属性

style

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

styleBuiltIn

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

text

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

type

获取 body 的类型。 类型可取值为“MainDoc”、“Section”、“Header”、“Footer”或“TableCell”。 WordAPIOnline 1.1 及更高版本中支持其他类型“Footnote”、“Endnote”和“NoteItem”。

属性详细信息

$all

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

$all?: boolean;

属性值

boolean

font

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

font?: Word.Interfaces.FontLoadOptions;

属性值

注解

[ API 集:WordApi 1.1 ]

parentBody

获取 body 的父正文。 例如,表格单元格 body 的父正文可能是标题。 ItemNotFound如果没有父正文,则引发错误。

parentBody?: Word.Interfaces.BodyLoadOptions;

属性值

注解

[ API 集:WordApi 1.3 ]

parentBodyOrNullObject

获取 body 的父正文。 例如,表格单元格 body 的父正文可能是标题。 如果没有父正文,则此方法将返回其属性设置为 true的对象isNullObject。 有关详细信息,请参阅 *OrNullObject 方法和属性

parentBodyOrNullObject?: Word.Interfaces.BodyLoadOptions;

属性值

注解

[ API 集:WordApi 1.3 ]

parentContentControl

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

parentContentControl?: Word.Interfaces.ContentControlLoadOptions;

属性值

注解

[ API 集:WordApi 1.1 ]

parentContentControlOrNullObject

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

parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions;

属性值

注解

[ API 集:WordApi 1.3 ]

parentSection

获取 body 的父节。 如果没有父节,则 ItemNotFound 引发错误。

parentSection?: Word.Interfaces.SectionLoadOptions;

属性值

注解

[ API 集:WordApi 1.3 ]

parentSectionOrNullObject

获取 body 的父节。 如果没有父节,则此方法将返回一个对象,其 isNullObject 属性设置为 true。 有关详细信息,请参阅 *OrNullObject 方法和属性

parentSectionOrNullObject?: Word.Interfaces.SectionLoadOptions;

属性值

注解

[ API 集:WordApi 1.3 ]

style

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

style?: boolean;

属性值

boolean

注解

[ API 集:WordApi 1.1 ]

styleBuiltIn

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

styleBuiltIn?: boolean;

属性值

boolean

注解

[ API 集:WordApi 1.3 ]

text

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

text?: boolean;

属性值

boolean

注解

[ API 集:WordApi 1.1 ]

type

获取 body 的类型。 类型可取值为“MainDoc”、“Section”、“Header”、“Footer”或“TableCell”。 WordAPIOnline 1.1 及更高版本中支持其他类型“Footnote”、“Endnote”和“NoteItem”。

type?: boolean;

属性值

boolean

注解

[ API 集:WordApi 1.3 ]