Word.Field class

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

code: string;

Valor da propriedade

Comentários

Conjunto de APIs: WordApi 1.4

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

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: Word.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, "Result of first field: " + JSON.stringify(field.result), "Type of first field: " + field.type, "Is the first field locked? " + field.locked, "Kind of the first field: " + field.kind);
  }
});

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

Especifica dados em um campo de addin tipo. Se o campo não for um addin tipo, ele será null e lançará uma exceção geral quando o código tentar defini-lo.

data: string;

Valor da propriedade

Comentários

Conjunto de APIs: WordApi 1.5

Obtém o tipo do campo.

readonly kind: Word.FieldKind | "None" | "Hot" | "Warm" | "Cold";

Valor da propriedade

Comentários

Conjunto de APIs: WordApi 1.5

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: Word.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, "Result of first field: " + JSON.stringify(field.result), "Type of first field: " + field.type, "Is the first field locked? " + field.locked, "Kind of the first field: " + field.kind);
  }
});

Obtém um LinkFormat objeto que representa as opções de vínculo do campo.

readonly linkFormat: Word.LinkFormat;

Valor da propriedade

Comentários

Conjunto de APIs: WordApiDesktop 1.4

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

locked: boolean;

Valor da propriedade

Comentários

Conjunto de APIs: WordApi 1.5

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 selection and toggles between setting it to locked or unlocked.
await Word.run(async (context) => {
  let field = context.document.getSelection().fields.getFirstOrNullObject();
  field.load(["code", "result", "type", "locked"]);
  await context.sync();

  if (field.isNullObject) {
    console.log("The selection has no fields.");
  } else {
    console.log(`The first field in the selection is currently ${field.locked ? "locked" : "unlocked"}.`);
    field.locked = !field.locked;
    await context.sync();

    console.log(`The first field in the selection is now ${field.locked ? "locked" : "unlocked"}.`);
  }
});

Obtém um OleFormat objeto que representa as características OLE (diferente da vinculação) para o campo.

readonly oleFormat: Word.OleFormat;

Valor da propriedade

Comentários

Conjunto de APIs: WordApiDesktop 1.4

Obtém o corpo pai do campo.

readonly parentBody: Word.Body;

Valor da propriedade

Comentários

Conjunto de APIs: 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 parent body of the first field in the document.
await Word.run(async (context) => {
  const field: Word.Field = context.document.body.fields.getFirstOrNullObject();
  field.load("parentBody/text");

  await context.sync();

  if (field.isNullObject) {
    console.log("This document has no fields.");
  } else {
    const parentBody: Word.Body = field.parentBody;
    console.log("Text of first field's parent body: " + JSON.stringify(parentBody.text));
  }
});

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

readonly parentContentControl: Word.ContentControl;

Valor da propriedade

Comentários

Conjunto de APIs: WordApi 1.4

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.

readonly parentContentControlOrNullObject: Word.ContentControl;

Valor da propriedade

Comentários

Conjunto de APIs: WordApi 1.4

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

readonly parentTable: Word.Table;

Valor da propriedade

Comentários

Conjunto de APIs: WordApi 1.4

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

readonly parentTableCell: Word.TableCell;

Valor da propriedade

Comentários

Conjunto de APIs: WordApi 1.4

Obtém a célula da tabela que contém o campo. Se ele não estiver contido em uma célula da 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.

readonly parentTableCellOrNullObject: Word.TableCell;

Valor da propriedade

Comentários

Conjunto de APIs: WordApi 1.4

Obtém a tabela que contém o campo. Se 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.

readonly parentTableOrNullObject: Word.Table;

Valor da propriedade

Comentários

Conjunto de APIs: WordApi 1.4

Obtém os dados de resultado do campo.

readonly result: Word.Range;

Valor da propriedade

Comentários

Conjunto de APIs: 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: Word.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, "Result of first field: " + JSON.stringify(field.result), "Type of first field: " + field.type, "Is the first field locked? " + field.locked, "Kind of the first field: " + field.kind);
  }
});

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

showCodes: boolean;

Valor da propriedade

Comentários

Conjunto de APIs: WordApiDesktop 1.1

Obtém o tipo do campo.

readonly type: Word.FieldType | "Addin" | "AddressBlock" | "Advance" | "Ask" | "Author" | "AutoText" | "AutoTextList" | "BarCode" | "Bibliography" | "BidiOutline" | "Citation" | "Comments" | "Compare" | "CreateDate" | "Data" | "Database" | "Date" | "DisplayBarcode" | "DocProperty" | "DocVariable" | "EditTime" | "Embedded" | "EQ" | "Expression" | "FileName" | "FileSize" | "FillIn" | "FormCheckbox" | "FormDropdown" | "FormText" | "GotoButton" | "GreetingLine" | "Hyperlink" | "If" | "Import" | "Include" | "IncludePicture" | "IncludeText" | "Index" | "Info" | "Keywords" | "LastSavedBy" | "Link" | "ListNum" | "MacroButton" | "MergeBarcode" | "MergeField" | "MergeRec" | "MergeSeq" | "Next" | "NextIf" | "NoteRef" | "NumChars" | "NumPages" | "NumWords" | "OCX" | "Page" | "PageRef" | "Print" | "PrintDate" | "Private" | "Quote" | "RD" | "Ref" | "RevNum" | "SaveDate" | "Section" | "SectionPages" | "Seq" | "Set" | "Shape" | "SkipIf" | "StyleRef" | "Subject" | "Subscriber" | "Symbol" | "TA" | "TC" | "Template" | "Time" | "Title" | "TOA" | "TOC" | "UserAddress" | "UserInitials" | "UserName" | "XE" | "Empty" | "Others" | "Undefined";

Valor da propriedade

Comentários

Conjunto de APIs: WordApi 1.5

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: Word.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, "Result of first field: " + JSON.stringify(field.result), "Type of first field: " + field.type, "Is the first field locked? " + field.locked, "Kind of the first field: " + field.kind);
  }
});

Copia o campo para a área de transferência.

copyToClipboard(): void;

Retornos

Comentários

Conjunto de APIs: WordApiDesktop 1.4

Remove o campo do documento e o coloca na Área de Transferência.

cut(): void;

Retornos

Comentários

Conjunto de APIs: WordApiDesktop 1.4

Exclui o campo.

delete(): void;

Retornos

Comentários

Conjunto de APIs: WordApi 1.5

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/manage-fields.yaml

// Deletes the first field in the document.
await Word.run(async (context) => {
  const field: Word.Field = context.document.body.fields.getFirstOrNullObject();
  field.load();

  await context.sync();

  if (field.isNullObject) {
    console.log("This document has no fields.");
  } else {
    field.delete();
    await context.sync();

    console.log("The first field in the document was deleted.");
  }
});

Clicar no campo.

doClick(): void;

Retornos

Comentários

Conjunto de APIs: WordApiDesktop 1.4

Obtém o próximo campo. Gera um ItemNotFound erro se este campo for o último.

getNext(): Word.Field;

Retornos

Comentários

Conjunto de APIs: WordApi 1.4

Obtém o próximo campo. Se esse campo for o último, esse método retornará um objeto com sua isNullObject propriedade definida como true. Para obter mais informações, consulte métodos e propriedades *OrNullObject.

getNextOrNullObject(): Word.Field;

Retornos

Comentários

Conjunto de APIs: WordApi 1.4

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.FieldLoadOptions): Word.Field;

Parâmetros

Retornos

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.Field;

Parâmetros

Retornos

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Word.Field;

Parâmetros

Retornos

Seleciona o campo.

select(selectionMode?: Word.SelectionMode): void;

Parâmetros

Retornos

Comentários

Conjunto de APIs: WordApi 1.5

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/manage-fields.yaml

// Gets and updates the first field in the selection.
await Word.run(async (context) => {
  let field = context.document.getSelection().fields.getFirstOrNullObject();
  field.load(["code", "result", "type", "locked"]);

  await context.sync();

  if (field.isNullObject) {
    console.log("No field in selection.");
  } else {
    console.log("Before updating:", "Code of first field: " + field.code, "Result of first field: " + JSON.stringify(field.result));

    field.updateResult();
    field.select();
    await context.sync();

    field.load(["code", "result"]);
    await context.sync();

    console.log("After updating:", "Code of first field: " + field.code, "Result of first field: " + JSON.stringify(field.result));
  }
});

Seleciona o campo.

select(selectionMode?: "Select" | "Start" | "End"): void;

Parâmetros

Retornos

Comentários

Conjunto de APIs: WordApi 1.5

Define várias propriedades de um objeto ao mesmo tempo. Você pode passar um objeto simples com as propriedades apropriadas ou outro objeto de API do mesmo tipo.

set(properties: Interfaces.FieldUpdateData, options?: OfficeExtension.UpdateOptions): void;

Parâmetros

Retornos

Define várias propriedades no objeto ao mesmo tempo, com base em um objeto carregado existente.

set(properties: Word.Field): void;

Parâmetros

Retornos

Substitui o método JavaScript toJSON() para fornecer uma saída mais útil quando um objeto de API é passado para JSON.stringify(). (JSON.stringify, por sua vez, chama o toJSON método do objeto que é passado para ele.) Enquanto o objeto original Word.Field é um objeto de API, o toJSON método retorna um objeto JavaScript simples (digitado como Word.Interfaces.FieldData) que contém cópias superficiais de todas as propriedades filho carregadas do objeto original.

toJSON(): Word.Interfaces.FieldData;

Retornos

Acompanha o objeto para ajuste automático com base nas alterações adjacentes no documento. Essa chamada é uma abreviação de 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, 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.Field;

Retornos

Substitui o campo pelo seu resultado mais recente.

unlink(): void;

Retornos

Comentários

Conjunto de APIs: WordApiDesktop 1.4

Libere a memória associada a este objeto, se ele já tiver sido rastreado anteriormente. Essa chamada é a forma abreviada de 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á ligar context.sync() antes que a liberação de memória entre em vigor.

untrack(): Word.Field;

Retornos

Atualizações o campo.

updateResult(): void;

Retornos

Comentários

Conjunto de APIs: WordApi 1.5

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/manage-fields.yaml

// Gets and updates the first field in the selection.
await Word.run(async (context) => {
  let field = context.document.getSelection().fields.getFirstOrNullObject();
  field.load(["code", "result", "type", "locked"]);

  await context.sync();

  if (field.isNullObject) {
    console.log("No field in selection.");
  } else {
    console.log("Before updating:", "Code of first field: " + field.code, "Result of first field: " + JSON.stringify(field.result));

    field.updateResult();
    field.select();
    await context.sync();

    field.load(["code", "result"]);
    await context.sync();

    console.log("After updating:", "Code of first field: " + field.code, "Result of first field: " + JSON.stringify(field.result));
  }
});

Salva as alterações feitas nos resultados de um campo INCLUDETEXT de volta para o documento de origem.

updateSource(): void;

Retornos

Comentários

Conjunto de APIs: WordApiDesktop 1.4