OfficeExtension.ClientObject class

Paquet:

office

Objet proxy abstrait qui représente un objet dans un document Office. Vous créez des objets proxy à partir du contexte (ou d’autres objets proxy), ajoutez des commandes à une file d’attente pour agir sur l’objet, puis synchronisez l’état de l’objet proxy avec le document en appelant context.sync().

Propriétés

context	Contexte de requête associé à l’objet
isNullObject	Retourne une valeur booléenne indiquant si l’objet correspondant est un objet null. Vous devez appeler context.sync() avant de lire la propriété isNullObject.

Détails de la propriété

context

Contexte de requête associé à l’objet

context: ClientRequestContext;

Valeur de propriété

OfficeExtension.ClientRequestContext

Exemples

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

Retourne une valeur booléenne indiquant si l’objet correspondant est un objet null. Vous devez appeler context.sync() avant de lire la propriété isNullObject.

isNullObject: boolean;

Valeur de propriété

boolean

Exemples

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