Word.Interfaces.FieldLoadOptions interface

Pacote:

word

Representa um campo.

Comentários

[ Conjunto de API: WordApi 1.4 ]

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).
code	Especifica as instruções de código do campo.
data	Especifica dados em um campo "Addin". Se o campo não for um campo "Addin", ele será nulo e gerará uma exceção geral quando o código tentar defini-lo.
kind	Obtém o tipo do campo.
locked	Especifica se o campo está bloqueado. true se o campo estiver bloqueado, false caso contrário.
parentBody	Obtém o corpo pai do campo.
parentContentControl	Obtém o controle de conteúdo que contém o campo. Gerará um ItemNotFound erro se não houver um controle de conteúdo pai.
parentContentControlOrNullObject	Obtém o controle de conteúdo que contém o campo. 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.
parentTable	Obtém a tabela que contém o campo. Gerará um ItemNotFound erro se ele não estiver contido em uma tabela.
parentTableCell	Obtém a célula de tabela que contém o campo. Gerará um ItemNotFound erro se ele não estiver contido em uma célula de tabela.
parentTableCellOrNullObject	Obtém a célula de tabela que contém o campo. Se ele não estiver contido em uma célula de tabela, esse método retornará um objeto com sua isNullObject propriedade definida como true. Para obter mais informações, consulte *Métodos e propriedades orNullObject.
parentTableOrNullObject	Obtém a tabela que contém o campo. Se ele não estiver contido em uma tabela, esse método retornará um objeto com sua isNullObject propriedade definida como true. Para obter mais informações, consulte *Métodos e propriedades orNullObject.
result	Obtém os dados de resultado do campo.
type	Obtém o tipo do campo.

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

code

Especifica as instruções de código do campo.

code?: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: WordApi 1.4 ]

Observação: a capacidade de definir o código foi introduzida no WordApi 1.5.

data

Especifica dados em um campo "Addin". Se o campo não for um campo "Addin", ele será nulo e gerará uma exceção geral quando o código tentar defini-lo.

data?: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: WordApi 1.5 ]

kind

Obtém o tipo do campo.

kind?: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: WordApi 1.5 ]

locked

Especifica se o campo está bloqueado. true se o campo estiver bloqueado, false caso contrário.

locked?: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: WordApi 1.5 ]

parentBody

Obtém o corpo pai do campo.

parentBody?: Word.Interfaces.BodyLoadOptions;

Valor da propriedade

Word.Interfaces.BodyLoadOptions

Comentários

[ Conjunto de API: WordApi 1.4 ]

parentContentControl

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

parentContentControl?: Word.Interfaces.ContentControlLoadOptions;

Valor da propriedade

Word.Interfaces.ContentControlLoadOptions

Comentários

[ Conjunto de API: WordApi 1.4 ]

parentContentControlOrNullObject

Obtém o controle de conteúdo que contém o campo. 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

Word.Interfaces.ContentControlLoadOptions

Comentários

[ Conjunto de API: WordApi 1.4 ]

parentTable

Obtém a tabela que contém o campo. Gerará um ItemNotFound erro se ele não estiver contido em uma tabela.

parentTable?: Word.Interfaces.TableLoadOptions;

Valor da propriedade

Word.Interfaces.TableLoadOptions

Comentários

[ Conjunto de API: WordApi 1.4 ]

parentTableCell

Obtém a célula de tabela que contém o campo. Gerará um ItemNotFound erro se ele não estiver contido em uma célula de tabela.

parentTableCell?: Word.Interfaces.TableCellLoadOptions;

Valor da propriedade

Word.Interfaces.TableCellLoadOptions

Comentários

[ Conjunto de API: WordApi 1.4 ]

parentTableCellOrNullObject

Obtém a célula de tabela que contém o campo. Se ele não estiver contido em uma célula de tabela, esse método retornará um objeto com sua isNullObject propriedade definida como true. Para obter mais informações, consulte *Métodos e propriedades orNullObject.

parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions;

Valor da propriedade

Word.Interfaces.TableCellLoadOptions

Comentários

[ Conjunto de API: WordApi 1.4 ]

parentTableOrNullObject

Obtém a tabela que contém o campo. Se ele não estiver contido em uma tabela, esse método retornará um objeto com sua isNullObject propriedade definida como true. Para obter mais informações, consulte *Métodos e propriedades orNullObject.

parentTableOrNullObject?: Word.Interfaces.TableLoadOptions;

Valor da propriedade

Word.Interfaces.TableLoadOptions

Comentários

[ Conjunto de API: WordApi 1.4 ]

result

Obtém os dados de resultado do campo.

result?: Word.Interfaces.RangeLoadOptions;

Valor da propriedade

Word.Interfaces.RangeLoadOptions

Comentários

[ Conjunto de API: WordApi 1.4 ]

type

Obtém o tipo do campo.

type?: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: WordApi 1.5 ]