PowerPoint.SlideCollection class

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

context: RequestContext;

プロパティ値

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

readonly items: PowerPoint.Slide[];

プロパティ値

コレクションに新しいスライドを追加します。

add(options?: PowerPoint.AddSlideOptions): void;

パラメーター

返品

注釈

API セット: PowerPointApi 1.3

例

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

const chosenMaster = (document.getElementById("master-id") as HTMLInputElement).value;
const chosenLayout = (document.getElementById("layout-id") as HTMLInputElement).value;

await PowerPoint.run(async function(context) {
  // Create a new slide using an existing master slide and layout.
  const newSlideOptions: PowerPoint.AddSlideOptions = {
    slideMasterId: chosenMaster, /* An ID from `Presentation.slideMasters`. */
    layoutId: chosenLayout /* An ID from `SlideMaster.layouts`. */
  };
  context.presentation.slides.add(newSlideOptions);
  await context.sync();
});

このコレクションに含まれている 1 つ以上のスライドを、Base64 でエンコードされたデータとして返される専用のプレゼンテーション ファイルにエクスポートします。 指定されたスライド ID または Slide オブジェクトがこのコレクションに見つからない場合は、InvalidArgument例外をスローします。

exportAsBase64Presentation(values: Array<string | Slide>): OfficeExtension.ClientResult<string>;

パラメーター

返品

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

注釈

API セット: PowerPointApi 1.10

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

getCount(): OfficeExtension.ClientResult<number>;

返品

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

注釈

API セット: PowerPointApi 1.2

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

getItem(key: string): PowerPoint.Slide;

パラメーター

返品

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

注釈

API セット: PowerPointApi 1.2

コレクション内の 0 から始まるインデックスを使用してスライドを取得します。 スライドは、プレゼンテーションと同じ順序で保存されます。

getItemAt(index: number): PowerPoint.Slide;

パラメーター

返品

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

注釈

API セット: PowerPointApi 1.2

例

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

// Selects slides 2, 4, and 5.
await PowerPoint.run(async (context) => {
  context.presentation.load("slides");
  await context.sync();
  const slide2: PowerPoint.Slide = context.presentation.slides.getItemAt(1);
  const slide4: PowerPoint.Slide = context.presentation.slides.getItemAt(3);
  const slide5: PowerPoint.Slide = context.presentation.slides.getItemAt(4);
  slide2.load("id");
  slide4.load("id");
  slide5.load("id");
  try {
    await context.sync();
  } catch (error) {
    console.warn("This action requires at least 5 slides in the presentation.");
    return;
  }
  await context.sync();
  context.presentation.setSelectedSlides([slide2.id, slide4.id, slide5.id]);
  await context.sync();
});

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

getItemOrNullObject(id: string): PowerPoint.Slide;

パラメーター

返品

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

注釈

API セット: PowerPointApi 1.2

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

load(options?: PowerPoint.Interfaces.SlideCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions): PowerPoint.SlideCollection;

パラメーター

返品

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

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

パラメーター

返品

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

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

パラメーター

返品

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

toJSON(): PowerPoint.Interfaces.SlideCollectionData;

返品