Word.FieldCollection class
Contém uma coleção de Word. Objetos de campo.
- Extends
Comentários
[ Conjunto de API: WordApi 1.4 ]
Importante: para saber mais sobre quais campos podem ser inseridos, consulte o Word. API Range.insertField introduzida no conjunto de requisitos 1.5. O suporte para o gerenciamento de campos é semelhante ao que está disponível na interface do usuário Word. No entanto, enquanto o Word interface do usuário na Web dá suporte principalmente apenas a campos como somente leitura (consulte Códigos de campo em Word para a Web), o Addin campo é editável. Para saber mais sobre Word clientes de interface do usuário que oferecem suporte mais completo aos campos, confira a lista de produtos no início dos campos Inserir, editar e exibir em Word.
Propriedades
| context | O contexto de solicitação associado ao objeto. Isso conecta o processo do suplemento ao processo do aplicativo host do Office. |
| items | Obtém os itens filhos carregados nesta coleção. |
Métodos
| get |
Obtém a coleção de objetos Field, incluindo os tipos de campos especificados. |
| get |
Obtém o primeiro campo desta coleção. Gerará um |
| get |
Obtém o primeiro campo desta coleção. Se essa coleção estiver vazia, esse método retornará um objeto com sua |
| load(options) | Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar |
| load(property |
Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar |
| load(property |
Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar |
| toJSON() | Substitui o método JavaScript |
| track() | Acompanha o objeto para ajuste automático com base nas alterações adjacentes no documento. Essa chamada é uma abreviação para context.trackedObjects.add(thisObject). Se você estiver usando esse objeto entre |
| untrack() | Libere a memória associada a este objeto, se ele já tiver sido rastreado anteriormente. Essa chamada é abreviada para context.trackedObjects.remove(thisObject). Ter muitos objetos rastreados desacelera o aplicativo host, por isso, lembre-se de liberar todos os objetos adicionados após usá-los. Você precisará chamar |
Detalhes da propriedade
context
O contexto de solicitação associado ao objeto. Isso conecta o processo do suplemento ao processo do aplicativo host do Office.
context: RequestContext;Valor da propriedade
items
Obtém os itens filhos carregados nesta coleção.
readonly items: Word.Field[];Valor da propriedade
Exemplos
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/manage-fields.yaml
// Gets all fields in the document body.
await Word.run(async (context) => {
const fields = context.document.body.fields.load("items");
await context.sync();
if (fields.items.length === 0) {
console.log("No fields in this document.");
} else {
fields.load(["code", "result"]);
await context.sync();
for (let i = 0; i < fields.items.length; i++) {
console.log(`Field ${i + 1}'s code: ${fields.items[i].code}`);
console.log(`Field ${i + 1}'s result: ${JSON.stringify(fields.items[i].result)}`);
}
}
});
Detalhes do método
getByTypes(types)
Obtém a coleção de objetos Field, incluindo os tipos de campos especificados.
getByTypes(types: Word.FieldType[]): Word.FieldCollection;Parâmetros
- types
Obrigatório. Uma matriz de tipos de campo.
Retornos
Comentários
getFirst()
Obtém o primeiro campo desta coleção. Gerará um ItemNotFound erro se essa coleção estiver vazia.
getFirst(): Word.Field;Retornos
Comentários
getFirstOrNullObject()
Obtém o primeiro campo desta coleção. Se essa coleção estiver vazia, esse método retornará um objeto com sua isNullObject propriedade definida como true. Para obter mais informações, consulte *Métodos e propriedades orNullObject.
getFirstOrNullObject(): Word.Field;Retornos
Comentários
[ Conjunto de API: WordApi 1.4 ]
Exemplos
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/manage-fields.yaml
// Gets the first field in the document.
await Word.run(async (context) => {
const field = context.document.body.fields.getFirstOrNullObject();
field.load(["code", "result", "locked", "type", "data", "kind"]);
await context.sync();
if (field.isNullObject) {
console.log("This document has no fields.");
} else {
console.log("Code of first field: " + field.code);
console.log("Result of first field: " + JSON.stringify(field.result));
console.log("Type of first field: " + field.type);
console.log("Is the first field locked? " + field.locked);
console.log("Kind of the first field: " + field.kind);
}
});
load(options)
Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.
load(options?: Word.Interfaces.FieldCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.FieldCollection;Parâmetros
Fornece opções para quais propriedades do objeto carregar.
Retornos
load(propertyNames)
Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.
load(propertyNames?: string | string[]): Word.FieldCollection;Parâmetros
- propertyNames
-
string | string[]
Uma cadeia de caracteres delimitada por vírgulas ou uma matriz de cadeias de caracteres que especificam as propriedades a serem carregadas.
Retornos
load(propertyNamesAndPaths)
Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.FieldCollection;Parâmetros
- propertyNamesAndPaths
- OfficeExtension.LoadOption
propertyNamesAndPaths.select é uma cadeia de caracteres delimitada por vírgulas que especifica as propriedades a serem carregadas e propertyNamesAndPaths.expand é uma cadeia de caracteres delimitada por vírgulas que especifica as propriedades de navegação a serem carregadas.
Retornos
toJSON()
Substitui o método JavaScript toJSON() para fornecer uma saída mais útil quando um objeto de API é passado para JSON.stringify(). (JSON.stringifypor sua vez, chama o toJSON método do objeto que é passado para ele.) Considerando que o objeto original Word.FieldCollection é um objeto API, o toJSON método retorna um objeto JavaScript simples (digitado como Word.Interfaces.FieldCollectionData) que contém uma matriz de "itens" com cópias rasas de quaisquer propriedades carregadas dos itens da coleção.
toJSON(): Word.Interfaces.FieldCollectionData;Retornos
track()
Acompanha o objeto para ajuste automático com base nas alterações adjacentes no documento. Essa chamada é uma abreviação para context.trackedObjects.add(thisObject). Se você estiver usando esse objeto entre .sync chamadas e fora da execução sequencial de um lote ".run" e receber um erro "InvalidObjectPath" ao definir uma propriedade ou invocar um método no objeto, você precisará adicionar o objeto à coleção de objetos rastreados quando o objeto foi criado pela primeira vez. Se esse objeto fizer parte de uma coleção, você também deverá acompanhar a coleção pai.
track(): Word.FieldCollection;Retornos
untrack()
Libere a memória associada a este objeto, se ele já tiver sido rastreado anteriormente. Essa chamada é abreviada para context.trackedObjects.remove(thisObject). Ter muitos objetos rastreados desacelera o aplicativo host, por isso, lembre-se de liberar todos os objetos adicionados após usá-los. Você precisará chamar context.sync() antes que a versão da memória entre em vigor.
untrack(): Word.FieldCollection;Retornos
Comentários
Em breve: Ao longo de 2024, eliminaremos os problemas do GitHub como o mecanismo de comentários para conteúdo e o substituiremos por um novo sistema de comentários. Para obter mais informações, consulte https://aka.ms/ContentUserFeedback.
Enviar e exibir comentários de