OfficeExtension.ClientObject class

Paquete:

office

Objeto proxy abstracto que representa un objeto en un documento de Office. Los objetos proxy se crean desde el contexto (o desde otros objetos proxy), se agregan comandos a una cola para actuar sobre el objeto y, a continuación, se sincroniza el estado del objeto proxy con el documento mediante una llamada a context.sync().

Propiedades

context	Contexto de solicitud asociado al objeto
isNullObject	Devuelve un valor booleano para si el objeto correspondiente es un objeto NULL. Debe llamar a context.sync() antes de leer la propiedad isNullObject.

Detalles de las propiedades

context

Contexto de solicitud asociado al objeto

context: ClientRequestContext;

Valor de propiedad

OfficeExtension.ClientRequestContext

Ejemplos

// *.run methods automatically create an OfficeExtension.ClientRequestContext
// object to work with the Office file.
await Excel.run(async (context: Excel.RequestContext) => {
  // `context` is the Excel-specific extension of OfficeExtension.ClientRequestContext.
  
  const workbook = context.workbook;
  // Interact with the Excel workbook...
});

isNullObject

Devuelve un valor booleano para si el objeto correspondiente es un objeto NULL. Debe llamar a context.sync() antes de leer la propiedad isNullObject.

isNullObject: boolean;

Valor de propiedad

boolean

Ejemplos

// This Word snippet sets the hyperlink URL of a selected image. 
await Word.run(async (context) => {
    const selection = context.document.getSelection();
    const firstImage = selection.inlinePictures.getFirstOrNullObject();
    await context.sync();

    // Check if an image was selected before changing its property.
    if (!firstImage.isNullObject) {
        firstImage.hyperlink = "https://www.microsoft.com";
    } else {
        console.log("No image selected");
    }

    await context.sync();
});