OfficeExtension.ClientObject class

  • Ссылка
Пакет:
office

Абстрактный прокси-объект, представляющий объект в документе Office. Прокси-объекты создаются из контекста (или из других прокси-объектов), добавляются команды в очередь для действий с объектом, а затем синхронизируются состояние объекта прокси-сервера с документом путем вызова context.sync().

Свойства

context

Контекст запроса, связанный с объектом
isNullObject

Возвращает логическое значение, указывающее, является ли соответствующий объект объектом NULL. Необходимо вызвать перед context.sync() чтением свойства isNullObject.

Сведения о свойстве

context

Контекст запроса, связанный с объектом

context: ClientRequestContext;

Значение свойства

OfficeExtension.ClientRequestContext

Примеры

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

Возвращает логическое значение, указывающее, является ли соответствующий объект объектом NULL. Необходимо вызвать перед context.sync() чтением свойства isNullObject.

isNullObject: boolean;

Значение свойства

boolean

Примеры

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