Compartilhar via


Word.Interfaces.FieldLoadOptions interface

Representa um campo.

Comentários

[ Conjunto de API: WordApi 1.4 ]

Importante: para saber mais sobre os campos que podem ser inseridos, veja a Word.Range.insertField API introduzida no conjunto de requisitos 1.5. O suporte para gerir campos é semelhante ao que está disponível na IU do Word. No entanto, embora a IU Word na Web apenas suporte campos como só de leitura (consulte Códigos de campo no Word para a Web), o Addin campo é editável. Para saber mais sobre Word clientes de IU que suportam mais totalmente campos, consulte a lista de produtos no início de Inserir, editar e ver campos no Word.

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).

code

Especifica a instrução de código do campo.

data

Especifica dados num campo "Addin". Se o campo não for um campo "Addin", é null e emitirá uma exceção geral quando o código tentar defini-lo.

kind

Obtém a amável do campo.

locked

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

parentBody

Obtém o corpo principal do campo.

parentContentControl

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

parentContentControlOrNullObject

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

parentTable

Obtém a tabela que contém o campo. Gera um ItemNotFound erro se não estiver contido numa tabela.

parentTableCell

Obtém a célula da tabela que contém o campo. Gera um ItemNotFound erro se não estiver contido numa célula de tabela.

parentTableCellOrNullObject

Obtém a célula da tabela que contém o campo. Se não estiver contido numa célula de tabela, 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).

parentTableOrNullObject

Obtém a tabela que contém o campo. Se não estiver contido numa tabela, 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).

result

Obtém os dados de resultados do campo.

showCodes

Especifica se os códigos de campo são apresentados para o campo especificado. true se os códigos de campo forem apresentados, false caso contrário.

type

Obtém o tipo do campo.

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

code

Especifica a instrução de código do campo.

code?: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: WordApi 1.4 ]

Nota: a capacidade de definir o código foi introduzida no WordApi 1.5.

data

Especifica dados num campo "Addin". Se o campo não for um campo "Addin", é null e emitirá 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 a amável 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 principal do campo.

parentBody?: Word.Interfaces.BodyLoadOptions;

Valor da propriedade

Comentários

[ Conjunto de API: WordApi 1.4 ]

parentContentControl

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

parentContentControlOrNullObject

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

parentTable

Obtém a tabela que contém o campo. Gera um ItemNotFound erro se não estiver contido numa tabela.

parentTable?: Word.Interfaces.TableLoadOptions;

Valor da propriedade

Comentários

[ Conjunto de API: WordApi 1.4 ]

parentTableCell

Obtém a célula da tabela que contém o campo. Gera um ItemNotFound erro se não estiver contido numa célula de tabela.

parentTableCell?: Word.Interfaces.TableCellLoadOptions;

Valor da propriedade

Comentários

[ Conjunto de API: WordApi 1.4 ]

parentTableCellOrNullObject

Obtém a célula da tabela que contém o campo. Se não estiver contido numa célula de tabela, 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).

parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions;

Valor da propriedade

Comentários

[ Conjunto de API: WordApi 1.4 ]

parentTableOrNullObject

Obtém a tabela que contém o campo. Se não estiver contido numa tabela, 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).

parentTableOrNullObject?: Word.Interfaces.TableLoadOptions;

Valor da propriedade

Comentários

[ Conjunto de API: WordApi 1.4 ]

result

Obtém os dados de resultados do campo.

result?: Word.Interfaces.RangeLoadOptions;

Valor da propriedade

Comentários

[ Conjunto de API: WordApi 1.4 ]

showCodes

Especifica se os códigos de campo são apresentados para o campo especificado. true se os códigos de campo forem apresentados, false caso contrário.

showCodes?: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: WordApiDesktop 1.1 ]

type

Obtém o tipo do campo.

type?: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: WordApi 1.5 ]