Word.Interfaces.BodyLoadOptions interface

Representa o corpo de um documento ou de uma seção.

Comentários

[ Conjunto de API: WordApi 1.1 ]

Propriedades

$all

Especificar $all para o LoadOptions carrega todas as propriedades escalares (por exemplo: Range.address) mas não as propriedades de navegação (por exemplo: Range.format.fill.color).

font

Obtém o formato de texto do corpo. Use isso para obter e definir nome da fonte, tamanho, cor e outras propriedades.

parentBody

Obtém o corpo pai do corpo. Por exemplo, o corpo pai do corpo de uma célula de tabela poderia ser um cabeçalho. Gerará um ItemNotFound erro se não houver um corpo pai.

parentBodyOrNullObject

Obtém o corpo pai do corpo. Por exemplo, o corpo pai do corpo de uma célula de tabela poderia ser um cabeçalho. Se não houver um corpo pai, esse método retornará um objeto com sua isNullObject propriedade definida como true. Para obter mais informações, consulte *Métodos e propriedades orNullObject.

parentContentControl

Obtém o controle de conteúdo que inclui o corpo. Gerará um ItemNotFound erro se não houver um controle de conteúdo pai.

parentContentControlOrNullObject

Obtém o controle de conteúdo que inclui o corpo. Se não houver um controle de conteúdo pai, esse método retornará um objeto com sua isNullObject propriedade definida como true. Para obter mais informações, consulte *Métodos e propriedades orNullObject.

parentSection

Obtém a seção pai do corpo. Gerará um ItemNotFound erro se não houver uma seção pai.

parentSectionOrNullObject

Obtém a seção pai do corpo. Se não houver uma seção pai, esse método retornará um objeto com sua isNullObject propriedade definida como true. Para obter mais informações, consulte *Métodos e propriedades orNullObject.

style

Especifica o nome de estilo do corpo. Use esta propriedade de estilos personalizados e nomes de estilo localizados. Para usar os estilos internos que são portáteis entre localidades, confira a propriedade "styleBuiltIn".

styleBuiltIn

Especifica o nome de estilo interno do corpo. Use esta propriedade para estilos internos que são portáteis entre localidades. Para usar estilos personalizados ou nomes de estilo localizados, confira a propriedade "estilo".

text

Obtém o texto do corpo. Usa o método insertText para inserir texto.

type

Obtém o tipo do corpo. O tipo pode ser 'MainDoc', 'Section', 'Header', 'Footer' ou 'TableCell'. Os tipos adicionais 'Footnote', 'Endnote' e 'NoteItem' têm suporte no WordAPIOnline 1.1 e posterior.

Detalhes da propriedade

$all

Especificar $all para o LoadOptions carrega todas as propriedades escalares (por exemplo: Range.address) mas não as propriedades de navegação (por exemplo: Range.format.fill.color).

$all?: boolean;

Valor da propriedade

boolean

font

Obtém o formato de texto do corpo. Use isso para obter e definir nome da fonte, tamanho, cor e outras propriedades.

font?: Word.Interfaces.FontLoadOptions;

Valor da propriedade

Comentários

[ Conjunto de API: WordApi 1.1 ]

parentBody

Obtém o corpo pai do corpo. Por exemplo, o corpo pai do corpo de uma célula de tabela poderia ser um cabeçalho. Gerará um ItemNotFound erro se não houver um corpo pai.

parentBody?: Word.Interfaces.BodyLoadOptions;

Valor da propriedade

Comentários

[ Conjunto de API: WordApi 1.3 ]

parentBodyOrNullObject

Obtém o corpo pai do corpo. Por exemplo, o corpo pai do corpo de uma célula de tabela poderia ser um cabeçalho. Se não houver um corpo pai, esse método retornará um objeto com sua isNullObject propriedade definida como true. Para obter mais informações, consulte *Métodos e propriedades orNullObject.

parentBodyOrNullObject?: Word.Interfaces.BodyLoadOptions;

Valor da propriedade

Comentários

[ Conjunto de API: WordApi 1.3 ]

parentContentControl

Obtém o controle de conteúdo que inclui o corpo. Gerará um ItemNotFound erro se não houver um controle de conteúdo pai.

parentContentControl?: Word.Interfaces.ContentControlLoadOptions;

Valor da propriedade

Comentários

[ Conjunto de API: WordApi 1.1 ]

parentContentControlOrNullObject

Obtém o controle de conteúdo que inclui o corpo. Se não houver um controle de conteúdo pai, esse método retornará um objeto com sua isNullObject propriedade definida como true. Para obter mais informações, consulte *Métodos e propriedades orNullObject.

parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions;

Valor da propriedade

Comentários

[ Conjunto de API: WordApi 1.3 ]

parentSection

Obtém a seção pai do corpo. Gerará um ItemNotFound erro se não houver uma seção pai.

parentSection?: Word.Interfaces.SectionLoadOptions;

Valor da propriedade

Comentários

[ Conjunto de API: WordApi 1.3 ]

parentSectionOrNullObject

Obtém a seção pai do corpo. Se não houver uma seção pai, esse método retornará um objeto com sua isNullObject propriedade definida como true. Para obter mais informações, consulte *Métodos e propriedades orNullObject.

parentSectionOrNullObject?: Word.Interfaces.SectionLoadOptions;

Valor da propriedade

Comentários

[ Conjunto de API: WordApi 1.3 ]

style

Especifica o nome de estilo do corpo. Use esta propriedade de estilos personalizados e nomes de estilo localizados. Para usar os estilos internos que são portáteis entre localidades, confira a propriedade "styleBuiltIn".

style?: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: WordApi 1.1 ]

styleBuiltIn

Especifica o nome de estilo interno do corpo. Use esta propriedade para estilos internos que são portáteis entre localidades. Para usar estilos personalizados ou nomes de estilo localizados, confira a propriedade "estilo".

styleBuiltIn?: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: WordApi 1.3 ]

text

Obtém o texto do corpo. Usa o método insertText para inserir texto.

text?: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: WordApi 1.1 ]

type

Obtém o tipo do corpo. O tipo pode ser 'MainDoc', 'Section', 'Header', 'Footer' ou 'TableCell'. Os tipos adicionais 'Footnote', 'Endnote' e 'NoteItem' têm suporte no WordAPIOnline 1.1 e posterior.

type?: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: WordApi 1.3 ]