PowerPoint.Slide class

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

context: RequestContext;

プロパティ値

スライド内のカスタム XML パーツのコレクションを返します。

readonly customXmlParts: PowerPoint.CustomXmlPartCollection;

プロパティ値

注釈

[ API set: PowerPointApi 1.7 ]

スライド内のハイパーリンクのコレクションを返します。

readonly hyperlinks: PowerPoint.HyperlinkCollection;

プロパティ値

注釈

[ API セット: PowerPointApi 1.6 ]

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

readonly id: string;

プロパティ値

注釈

[ API セット: PowerPointApi 1.2 ]

プレゼンテーション内の位置を表すスライドの 0 から始まるインデックスを返します。

readonly index: number;

プロパティ値

注釈

[ API セット: PowerPointApi 1.8 ]

スライドのレイアウトを取得します。

readonly layout: PowerPoint.SlideLayout;

プロパティ値

注釈

[ API セット: PowerPointApi 1.3 ]

スライド内の図形のコレクションを返します。

readonly shapes: PowerPoint.ShapeCollection;

プロパティ値

注釈

[ API セット: PowerPointApi 1.3 ]

スライドの既定のコンテンツを表す SlideMaster オブジェクトを取得します。

readonly slideMaster: PowerPoint.SlideMaster;

プロパティ値

注釈

[ API セット: PowerPointApi 1.3 ]

スライド内のタグのコレクションを返します。

readonly tags: PowerPoint.TagCollection;

プロパティ値

注釈

[ API セット: PowerPointApi 1.3 ]

指定したレイアウトをスライドに適用し、選択したレイアウトに従ってデザインと構造を変更します。

applyLayout(slideLayout: PowerPoint.SlideLayout): void;

パラメーター

戻り値

注釈

[ API セット: PowerPointApi 1.8 ]

プレゼンテーションからスライドを削除します。 スライドが存在しない場合は何も行いません。

delete(): void;

戻り値

注釈

[ 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

// Deletes the selected slides.
await PowerPoint.run(async (context) => {
  context.presentation.load("slides");
  await context.sync();
  const slides: PowerPoint.SlideScopedCollection = context.presentation.getSelectedSlides();
  const slideCount = slides.getCount();
  slides.load("items");
  await context.sync();
  slides.items.map((slide) => {
    slide.delete();
  });
});

スライドを独自のプレゼンテーション ファイルにエクスポートし、Base64 でエンコードされたデータとして返します。

注: このメソッドは、1 つのスライドをエクスポートするように最適化されています。 複数のスライドをエクスポートすると、パフォーマンスに影響する可能性があります。

exportAsBase64(): OfficeExtension.ClientResult<string>;

戻り値

注釈

[ API セット: PowerPointApi 1.8 ]

例

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

// Exports current slide.
await PowerPoint.run(async (context) => {
  const slide = context.presentation.getSelectedSlides().getItemAt(0);
  const slideBase64DataResult = slide.exportAsBase64();
  const imageBase64DataResult = slide.getImageAsBase64({ height: 300 });
  await context.sync();

  localStorage.setItem("exportedSlide", slideBase64DataResult.value);
  localStorage.setItem("exportedSlideImage", imageBase64DataResult.value);

  updateSlideImage(imageBase64DataResult.value);

  console.log("Slide was exported.");
});

スライドのイメージをレンダリングします。 イメージは、目的の寸法に合わせてスケーリングされます。 幅と高さを指定しない場合は、スライドの真のサイズが使用されます。 幅または高さの 1 つだけを指定した場合、もう一方は縦横比を維持するために計算されます。

getImageAsBase64(options?: PowerPoint.SlideGetImageOptions): OfficeExtension.ClientResult<string>;

パラメーター

戻り値

PNG 形式のスライド イメージの Base64 でエンコードされた文字列。

注釈

[ API セット: PowerPointApi 1.8 ]

例

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

// Exports current slide.
await PowerPoint.run(async (context) => {
  const slide = context.presentation.getSelectedSlides().getItemAt(0);
  const slideBase64DataResult = slide.exportAsBase64();
  const imageBase64DataResult = slide.getImageAsBase64({ height: 300 });
  await context.sync();

  localStorage.setItem("exportedSlide", slideBase64DataResult.value);
  localStorage.setItem("exportedSlideImage", imageBase64DataResult.value);

  updateSlideImage(imageBase64DataResult.value);

  console.log("Slide was exported.");
});

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

load(options?: PowerPoint.Interfaces.SlideLoadOptions): PowerPoint.Slide;

パラメーター

戻り値

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

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

パラメーター

戻り値

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

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): PowerPoint.Slide;

パラメーター

戻り値

スライドをプレゼンテーション内の新しい位置に移動します。

moveTo(slideIndex: number): void;

パラメーター

戻り値

注釈

[ API セット: PowerPointApi 1.8 ]

指定した図形を選択します。 既存の図形の選択は、新しい選択に置き換えられます。

setSelectedShapes(shapeIds: string[]): void;

パラメーター

戻り値

注釈

[ API セット: PowerPointApi 1.5 ]

例

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

// Reselects shapes that were saved previously.
await PowerPoint.run(async (context) => {
  const slide1: PowerPoint.Slide = context.presentation.slides.getItem(savedSlideSelection[0]);
  await context.sync();
  slide1.setSelectedShapes(savedShapeSelection);
  await context.sync();
});

...

// Selects the first two shapes on slide 1.
await PowerPoint.run(async (context) => {
  context.presentation.load("slides");
  await context.sync();
  const slide1 = context.presentation.slides.getItemAt(0);
  slide1.load("shapes/items/type");
  await context.sync();

  const shapes = slide1.shapes.items.filter((item) => item.type === PowerPoint.ShapeType.geometricShape);
  const shape1: PowerPoint.Shape = shapes[0];
  const shape2: PowerPoint.Shape = shapes[1];
  shape1.load("id");
  shape2.load("id");
  await context.sync();

  console.log(`IDs: ${shape1.id}, ${shape2.id}`);
  slide1.setSelectedShapes([shape1.id, shape2.id]);
  await context.sync();
});

API オブジェクトがJSON.stringify()に渡されたときにより便利な出力を提供するために、JavaScript toJSON() メソッドをオーバーライドします。 (JSON.stringify、それに渡されるオブジェクトの toJSON メソッドを呼び出します)。元の PowerPoint.Slide オブジェクトは API オブジェクトですが、 toJSON メソッドは、元のオブジェクトから読み込まれた子プロパティの浅いコピーを含むプレーンな JavaScript オブジェクト ( PowerPoint.Interfaces.SlideData として型指定) を返します。

toJSON(): PowerPoint.Interfaces.SlideData;

戻り値