Compartilhar via


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 as opções de carga carrega todas as propriedades escalares (como Range.address) mas não as propriedades de navegação (como Range.format.fill.color).

font

Obtém o formato de texto do corpo. Utilize esta opção para obter e definir o nome, tamanho, cor e outras propriedades do tipo de letra.

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. Gera um ItemNotFound erro se não existir um corpo principal.

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 existir um corpo principal, este método devolverá um objeto com a respetiva isNullObject propriedade definida como true. Para obter mais informações, veja *OrNullObject methods and properties (Métodos e propriedades do OrNullObject).

parentContentControl

Obtém o controle de conteúdo que inclui o corpo. Gera um ItemNotFound erro se não existir um controlo de conteúdo principal.

parentContentControlOrNullObject

Obtém o controle de conteúdo que inclui o corpo. Se não existir um controlo de conteúdo principal, este método devolverá um objeto com a respetiva isNullObject propriedade definida como true. Para obter mais informações, veja *OrNullObject methods and properties (Métodos e propriedades do OrNullObject).

parentSection

Obtém a seção pai do corpo. Gera um ItemNotFound erro se não existir uma secção principal.

parentSectionOrNullObject

Obtém a seção pai do corpo. Se não existir uma secção principal, este método devolverá um objeto com a respetiva isNullObject propriedade definida como true. Para obter mais informações, veja *OrNullObject methods and properties (Métodos e propriedades do OrNullObject).

style

Especifica o nome do 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 incorporado para o 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 "Nota de Rodapé", "Nota de Fim" e "NoteItem" são suportados no WordAPIOnline 1.1 e posterior.

Detalhes da propriedade

$all

Especificar $all para as opções de carga carrega todas as propriedades escalares (como Range.address) mas não as propriedades de navegação (como Range.format.fill.color).

$all?: boolean;

Valor da propriedade

boolean

font

Obtém o formato de texto do corpo. Utilize esta opção para obter e definir o nome, tamanho, cor e outras propriedades do tipo de letra.

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. Gera um ItemNotFound erro se não existir um corpo principal.

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 existir um corpo principal, este método devolverá um objeto com a respetiva isNullObject propriedade definida como true. Para obter mais informações, veja *OrNullObject methods and properties (Métodos e propriedades do 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. Gera um ItemNotFound erro se não existir um controlo de conteúdo principal.

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 existir um controlo de conteúdo principal, este método devolverá um objeto com a respetiva isNullObject propriedade definida como true. Para obter mais informações, veja *OrNullObject methods and properties (Métodos e propriedades do 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. Gera um ItemNotFound erro se não existir uma secção principal.

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 existir uma secção principal, este método devolverá um objeto com a respetiva isNullObject propriedade definida como true. Para obter mais informações, veja *OrNullObject methods and properties (Métodos e propriedades do OrNullObject).

parentSectionOrNullObject?: Word.Interfaces.SectionLoadOptions;

Valor da propriedade

Comentários

[ Conjunto de API: WordApi 1.3 ]

style

Especifica o nome do 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 incorporado para o 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 "Nota de Rodapé", "Nota de Fim" e "NoteItem" são suportados no WordAPIOnline 1.1 e posterior.

type?: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: WordApi 1.3 ]