Word.Interfaces.FieldCollectionLoadOptions interface

Contém uma coleção de Word. Objetos de 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

Para CADA ITEM na coleção: especifica a instrução de código do campo.

data

Para CADA ITEM na coleção: 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

Para CADA ITEM na coleção: obtém o tipo do campo.

locked

Para CADA ITEM na coleção: especifica se o campo está bloqueado. true se o campo estiver bloqueado, false caso contrário.

parentBody

Para CADA ITEM na coleção: obtém o corpo pai do campo.

parentContentControl

Para CADA ITEM na coleção: 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

Para CADA ITEM na coleção: 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

Para CADA ITEM na coleção: obtém a tabela que contém o campo. Gerará um ItemNotFound erro se ele não estiver contido em uma tabela.

parentTableCell

Para CADA ITEM na coleção: 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

Para CADA ITEM na coleção: 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

Para CADA ITEM na coleção: 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

Para CADA ITEM na coleção: obtém os dados de resultado do campo.

showCodes

Para CADA ITEM na coleção: especifica se os códigos de campo são exibidos para o campo especificado. true se os códigos de campo forem exibidos, false caso contrário.

type

Para CADA ITEM na coleção: 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

Para CADA ITEM na coleção: especifica a instrução 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

Para CADA ITEM na coleção: 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

Para CADA ITEM na coleção: obtém o tipo do campo.

kind?: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: WordApi 1.5 ]

locked

Para CADA ITEM na coleção: 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

Para CADA ITEM na coleção: obtém o corpo pai do campo.

parentBody?: Word.Interfaces.BodyLoadOptions;

Valor da propriedade

Comentários

[ Conjunto de API: WordApi 1.4 ]

parentContentControl

Para CADA ITEM na coleção: 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

Comentários

[ Conjunto de API: WordApi 1.4 ]

parentContentControlOrNullObject

Para CADA ITEM na coleção: 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

Comentários

[ Conjunto de API: WordApi 1.4 ]

parentTable

Para CADA ITEM na coleção: 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

Comentários

[ Conjunto de API: WordApi 1.4 ]

parentTableCell

Para CADA ITEM na coleção: 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

Comentários

[ Conjunto de API: WordApi 1.4 ]

parentTableCellOrNullObject

Para CADA ITEM na coleção: 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

Comentários

[ Conjunto de API: WordApi 1.4 ]

parentTableOrNullObject

Para CADA ITEM na coleção: 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

Comentários

[ Conjunto de API: WordApi 1.4 ]

result

Para CADA ITEM na coleção: obtém os dados de resultado do campo.

result?: Word.Interfaces.RangeLoadOptions;

Valor da propriedade

Comentários

[ Conjunto de API: WordApi 1.4 ]

showCodes

Observação

Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

Para CADA ITEM na coleção: especifica se os códigos de campo são exibidos para o campo especificado. true se os códigos de campo forem exibidos, false caso contrário.

showCodes?: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: WordApi BETA (SOMENTE VERSÃO PRÉVIA) ]

type

Para CADA ITEM na coleção: obtém o tipo do campo.

type?: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: WordApi 1.5 ]