PowerPoint.SlideScopedCollection class

オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。

context: RequestContext;

プロパティ値

このコレクション内に読み込まれた子アイテムを取得します。

readonly items: PowerPoint.Slide[];

プロパティ値

このコレクション内のすべてのスライドを、Base64 エンコード データとして返される専用のプレゼンテーション ファイルにエクスポートします。

exportAsBase64Presentation(): OfficeExtension.ClientResult<string>;

返品

Base64 でエンコードされた文字列。

注釈

API セット: PowerPointApi 1.10

コレクション内のスライドの数を取得します。

getCount(): OfficeExtension.ClientResult<number>;

返品

コレクション内のスライドの数。

注釈

API セット: PowerPointApi 1.5

一意の ID を使用してスライドを取得します。

getItem(key: string): PowerPoint.Slide;

パラメーター

返品

一意の ID を持つスライド。 そのようなスライドが存在しない場合は、エラーがスローされます。

注釈

API セット: PowerPointApi 1.5

コレクション内の 0 から始まるインデックスを使用してスライドを取得します。

getItemAt(index: number): PowerPoint.Slide;

パラメーター

返品

指定したインデックス位置のスライド。 index が範囲外の場合は、エラーがスローされます。

注釈

API セット: PowerPointApi 1.5

一意の ID を使用してスライドを取得します。 そのようなスライドが存在しない場合は、 isNullObject プロパティが true に設定されたオブジェクトが返されます。 詳細については、「 *OrNullObject のメソッドとプロパティ」を参照してください。

getItemOrNullObject(id: string): PowerPoint.Slide;

パラメーター

返品

一意の ID を持つスライド。

注釈

API セット: PowerPointApi 1.5

例

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/slide-management/get-slide-by-id.yaml

// Uses getItemOrNullObject to find a slide by ID within the selected slides.
// If the ID isn't found in the selected slides, the returned object's isNullObject property is true.
// If the ID is found in the selected slides, presentation displays that slide.
await PowerPoint.run(async (context) => {
  const slideId = (document.getElementById("slide-id-input") as HTMLInputElement).value.trim();
  if (!slideId) {
    console.log("Enter a slide ID in the text box first.");
    return;
  }

  const selectedSlides: PowerPoint.SlideScopedCollection = context.presentation.getSelectedSlides();

  // getItemOrNullObject returns a Slide object without throwing if the ID isn't found.
  const slide: PowerPoint.Slide = selectedSlides.getItemOrNullObject(slideId);
  slide.load("id");
  await context.sync();

  if (slide.isNullObject) {
    console.log(`Slide ID "${slideId}" was not found in the selected slides.`);
  } else {
    console.log(`Slide found in the selected slides.`);
    console.log(`  ID: ${slide.id}`);

    // Switch to the slide.
    context.presentation.setSelectedSlides([slide.id]);
    await context.sync();

    console.log(`Switched to the slide - ID: ${slide.id}`);
  }
});

オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。

load(options?: PowerPoint.Interfaces.SlideScopedCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions): PowerPoint.SlideScopedCollection;

パラメーター

返品

オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。

load(propertyNames?: string | string[]): PowerPoint.SlideScopedCollection;

パラメーター

返品

オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。

load(propertyNamesAndPaths?: OfficeExtension.LoadOption): PowerPoint.SlideScopedCollection;

パラメーター

返品

API オブジェクトが JSON.stringify() に渡されるときに、より有用な出力を提供するために、JavaScript toJSON() メソッドをオーバーライドします。 (次に、JSON.stringify渡されたオブジェクトの toJSON メソッドを呼び出します)。元の PowerPoint.SlideScopedCollection オブジェクトが API オブジェクトであるのに対し、 toJSON メソッドは、コレクションの項目から読み込まれたプロパティの浅いコピーを含む "items" 配列を含むプレーンな JavaScript オブジェクト ( PowerPoint.Interfaces.SlideScopedCollectionData として型指定された) を返します。

toJSON(): PowerPoint.Interfaces.SlideScopedCollectionData;

返品