OfficeExtension.ClientObject class

Pacote:
office

Um objeto proxy abstrato que representa um objeto em um documento do Office. Você cria objetos proxy a partir do contexto (ou de outros objetos proxy), adiciona comandos a uma fila para agir sobre o objeto e, em seguida, sincroniza o estado do objeto proxy com o documento chamando context.sync().

Comentários

Usada por

Propriedades

context

O contexto de solicitação associado ao objeto
isNullObject

Retorna um valor booleano para saber se o objeto correspondente é um objeto nulo. Você deve chamar context.sync() antes de ler a propriedade isNullObject .

Detalhes da propriedade

context

O contexto de solicitação associado ao objeto

context: ClientRequestContext;

Valor da propriedade

OfficeExtension.ClientRequestContext

Exemplos

// *.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

Retorna um valor booleano para saber se o objeto correspondente é um objeto nulo. Você deve chamar context.sync() antes de ler a propriedade isNullObject .

isNullObject: boolean;

Valor da propriedade

boolean

Exemplos

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