Word. Field class

Nota: La capacidad de establecer el código se introdujo en WordApi 1.5.

Ejemplos

// 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);
  }
});

context

El contexto de solicitud asociado al objeto. De esta forma, se conecta el proceso del complemento con el proceso de la aplicación host de Office.

context: RequestContext;

Valor de propiedad

Word.RequestContext

data

Especifica los datos de un campo de addin tipo. Si el campo no es un addin tipo, lo es null y arrojará una excepción general cuando el código intente establecerlo.

data: string;

Valor de propiedad

string

Comentarios

kind

Obtiene el tipo del campo.

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

Valor de propiedad

Word.FieldKind | "None" | "Hot" | "Warm" | "Cold"

Comentarios

Ejemplos

// 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);
  }
});

linkFormat

Obtiene un LinkFormat objeto que representa las opciones de vínculo del campo.

readonly linkFormat: Word.LinkFormat;

Valor de propiedad

Word.LinkFormat

Comentarios

locked

Especifica si el campo está bloqueado. true si el campo está bloqueado, false de lo contrario.

locked: boolean;

Valor de propiedad

boolean

Comentarios

Ejemplos

// 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"}.`);
  }
});

oleFormat

Obtiene un OleFormat objeto que representa las características OLE (distintas de la vinculación) del campo.

readonly oleFormat: Word.OleFormat;

Valor de propiedad

Word.OleFormat

Comentarios

parentBody

Obtiene el cuerpo primario del campo.

readonly parentBody: Word.Body;

Valor de propiedad

Word.Body

Comentarios

Ejemplos

// 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));
  }
});

parentContentControl

Obtiene el control de contenido que contiene el campo. Genera un ItemNotFound error si no hay un control de contenido primario.

readonly parentContentControl: Word.ContentControl;

Valor de propiedad

Word.ContentControl

Comentarios

parentContentControlOrNullObject

Obtiene el control de contenido que contiene el campo. Si no hay un control de contenido primario, este método devolverá un objeto con su isNullObject propiedad establecida en true. Para obtener más información, vea los métodos y propiedades *OrNullObject.

readonly parentContentControlOrNullObject: Word.ContentControl;

Valor de propiedad

Word.ContentControl

Comentarios

parentTable

Obtiene la tabla que contiene el campo. Genera un ItemNotFound error si no está incluido en una tabla.

readonly parentTable: Word.Table;

Valor de propiedad

Word.Table

Comentarios

parentTableCell

Obtiene la celda de tabla que contiene el campo. Genera un ItemNotFound error si no está contenido en una celda de tabla.

readonly parentTableCell: Word.TableCell;

Valor de propiedad

Word.TableCell

Comentarios

parentTableCellOrNullObject

Obtiene la celda de tabla que contiene el campo. Si no está en una celda de tabla, este método devolverá un objeto con su isNullObject propiedad establecida en true. Para obtener más información, vea los métodos y propiedades *OrNullObject.

readonly parentTableCellOrNullObject: Word.TableCell;

Valor de propiedad

Word.TableCell

Comentarios

parentTableOrNullObject

Obtiene la tabla que contiene el campo. Si no está contenido en una tabla, este método devolverá un objeto con su isNullObject propiedad establecida en true. Para obtener más información, vea los métodos y propiedades *OrNullObject.

readonly parentTableOrNullObject: Word.Table;

Valor de propiedad

Word.Table

Comentarios

result

Obtiene los datos de resultados del campo.

readonly result: Word.Range;

Valor de propiedad

Word.Range

Comentarios

Conjunto de API: WordApiDesktop 1.1

Ejemplos

// 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);
  }
});

showCodes

Especifica si se muestran los códigos de campo del campo especificado. true si se muestran los códigos de campo, false en caso contrario.

showCodes: boolean;

Valor de propiedad

boolean

Comentarios

type

Obtiene el tipo del 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 de propiedad

Comentarios

Ejemplos

// 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);
  }
});

copyToClipboard()

Copia el campo en el Portapapeles.

copyToClipboard(): void;

Devoluciones

void

Comentarios

cut()

Quita el campo del documento y lo coloca en el Portapapeles.

cut(): void;

Devoluciones

void

Comentarios

delete()

Elimina el campo.

delete(): void;

Devoluciones

void

Comentarios

Ejemplos

// 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.");
  }
});

doClick()

Hace clic en el campo.

doClick(): void;

Devoluciones

void

Comentarios

getNext()

Obtiene el campo siguiente. Genera un ItemNotFound error si este campo es el último.

getNext(): Word.Field;

Devoluciones

Word.Field

Comentarios

getNextOrNullObject()

Obtiene el campo siguiente. Si este campo es el último, este método devolverá un objeto con su isNullObject propiedad establecida en true. Para obtener más información, vea los métodos y propiedades *OrNullObject.

getNextOrNullObject(): Word.Field;

Devoluciones

Word.Field

Comentarios

load(options)

Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.

load(options?: Word.Interfaces.FieldLoadOptions): Word.Field;

Parámetros

options: Word.Interfaces.FieldLoadOptions

Proporciona opciones para las propiedades del objeto que se van a cargar.

Devoluciones

Word.Field

load(propertyNames)

Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.

load(propertyNames?: string | string[]): Word.Field;

Parámetros

propertyNames: string | string[]

Una cadena delimitada por comas o una matriz de cadenas que especifican las propiedades que se van a cargar.

Devoluciones

Word.Field

load(propertyNamesAndPaths)

Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.

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

Parámetros

propertyNamesAndPaths: { select?: string; expand?: string; }

propertyNamesAndPaths.select es una cadena delimitada por comas que especifica las propiedades que se van a cargar y propertyNamesAndPaths.expand es una cadena delimitada por comas que especifica las propiedades de navegación que se van a cargar.

Devoluciones

Word.Field

select(selectionMode)

Selecciona el campo.

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

Parámetros

selectionMode: Word.SelectionMode

Opcional. El modo de selección debe ser select, start, o end. select es el valor predeterminado.

Devoluciones

void

Comentarios

Ejemplos

// 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));
  }
});

select(selectionMode)

Selecciona el campo.

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

Parámetros

selectionMode: "Select" | "Start" | "End"

Opcional. El modo de selección debe ser select, start, o end. select es el valor predeterminado.

Devoluciones

void

Comentarios

set(properties, options)

Establece varias propiedades de un objeto al mismo tiempo. Puede pasar un objeto sin formato con las propiedades adecuadas u otro objeto API del mismo tipo.

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

Parámetros

properties: Word.Interfaces.FieldUpdateData

Un objeto JavaScript con propiedades que están estructuradas isomorfamente a las propiedades del objeto en el que se llama al método.

options: OfficeExtension.UpdateOptions

Proporciona una opción para suprimir errores si el objeto properties intenta establecer propiedades de solo lectura.

Devoluciones

void

set(properties)

Establece varias propiedades en el objeto al mismo tiempo, basadas en un objeto cargado existente.

set(properties: Word.Field): void;

Parámetros

properties: Word.Field

Devoluciones

void

toJSON()

Reemplaza el método JavaScript toJSON() para proporcionar una salida más útil cuando se pasa un objeto API a JSON.stringify(). (JSON.stringify, a su vez, llama al toJSON método del objeto que se le pasa). Mientras que el objeto original Word.Field es un objeto API, el toJSON método devuelve un objeto JavaScript simple (escrito como Word.Interfaces.FieldData) que contiene copias superficiales de cualquier propiedad secundaria cargada del objeto original.

toJSON(): Word.Interfaces.FieldData;

Devoluciones

Word.Interfaces.FieldData

track()

Realiza un seguimiento del objeto de ajuste automático según cambios adyacentes en el documento. Esta llamada es una abreviatura de context.trackedObjects.add(thisObject). Si usa este objeto entre .sync llamadas y fuera de la ejecución secuencial de un lote ".run" y recibe un error "InvalidObjectPath" al establecer una propiedad o invocar un método en el objeto, debe agregar el objeto a la colección de objetos objeto de seguimiento cuando se creó el objeto por primera vez. Si este objeto forma parte de una colección, también debe realizar un seguimiento de la colección primaria.

track(): Word.Field;

Devoluciones

Word.Field

unlink()

Reemplaza el campo con su resultado más reciente.

unlink(): void;

Devoluciones

void

Comentarios

untrack()

Libere la memoria asociada a este objeto, si se ha realizado un seguimiento de él anteriormente. Esta llamada es la abreviatura de context.trackedObjects.remove(thisObject). Tener muchos objetos marcados ralentiza la aplicación host, así que debe recordar liberar los objetos que agregue cuando haya terminado con ellos. Deberá llamar context.sync() antes de que la liberación de memoria surta efecto.

untrack(): Word.Field;

Devoluciones

Word.Field

updateResult()

Novedades el campo.

updateResult(): void;

Devoluciones

void

Comentarios

Ejemplos

// 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));
  }
});

updateSource()

Guarda los cambios realizados en los resultados de un campo INCLUDETEXT de nuevo en el documento de origen.

updateSource(): void;

Devoluciones

void

Comentarios