OfficeExtension.ClientObject class

  • リファレンス
パッケージ:
office

Office ドキュメント内のオブジェクトを表す抽象プロキシ オブジェクト。 コンテキスト (または他のプロキシ オブジェクトから) からプロキシ オブジェクトを作成し、オブジェクトを操作するコマンドをキューに追加し、 context.sync()を呼び出してプロキシ オブジェクトの状態をドキュメントと同期します。

プロパティ

context

オブジェクトに関連付けられている要求コンテキスト
isNullObject

対応するオブジェクトが null オブジェクトであるかどうかを示すブール値を返します。 isNullObject プロパティを読み取る前に、 context.sync() を呼び出す必要があります。

プロパティの詳細

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 オブジェクトであるかどうかを示すブール値を返します。 isNullObject プロパティを読み取る前に、 context.sync() を呼び出す必要があります。

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