次の方法で共有


PowerPoint.Slide class

プレゼンテーションの 1 つのスライドを表します。

Extends

注釈

[ API セット: PowerPointApi 1.2 ]

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

プロパティ

context

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

customXmlParts

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

hyperlinks

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

id

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

index

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

layout

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

shapes

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

slideMaster

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

tags

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

メソッド

applyLayout(slideLayout)

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

delete()

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

exportAsBase64()

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

getImageAsBase64(options)

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

load(options)

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

load(propertyNames)

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

load(propertyNamesAndPaths)

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

moveTo(slideIndex)

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

setSelectedShapes(shapeIds)

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

toJSON()

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

プロパティの詳細

context

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

context: RequestContext;

プロパティ値

customXmlParts

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

readonly customXmlParts: PowerPoint.CustomXmlPartCollection;

プロパティ値

注釈

[ API set: PowerPointApi 1.7 ]

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

readonly hyperlinks: PowerPoint.HyperlinkCollection;

プロパティ値

注釈

[ API セット: PowerPointApi 1.6 ]

id

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

readonly id: string;

プロパティ値

string

注釈

[ API セット: PowerPointApi 1.2 ]

index

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

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

readonly index: number;

プロパティ値

number

注釈

[ API セット: PowerPointApi BETA (プレビューのみ) ]

layout

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

readonly layout: PowerPoint.SlideLayout;

プロパティ値

注釈

[ API セット: PowerPointApi 1.3 ]

shapes

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

readonly shapes: PowerPoint.ShapeCollection;

プロパティ値

注釈

[ API セット: PowerPointApi 1.3 ]

slideMaster

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

readonly slideMaster: PowerPoint.SlideMaster;

プロパティ値

注釈

[ API セット: PowerPointApi 1.3 ]

tags

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

readonly tags: PowerPoint.TagCollection;

プロパティ値

注釈

[ API セット: PowerPointApi 1.3 ]

メソッドの詳細

applyLayout(slideLayout)

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

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

applyLayout(slideLayout: PowerPoint.SlideLayout): void;

パラメーター

slideLayout
PowerPoint.SlideLayout

スライドに適用するレイアウト。 これは通常、スライド マスターからの定義済みのレイアウトのインスタンスです。

戻り値

void

注釈

[ API セット: PowerPointApi BETA (プレビューのみ) ]

delete()

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

delete(): void;

戻り値

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

exportAsBase64()

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

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

exportAsBase64(): OfficeExtension.ClientResult<string>;

戻り値

注釈

[ API セット: PowerPointApi BETA (プレビューのみ) ]

getImageAsBase64(options)

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

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

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

パラメーター

options
PowerPoint.SlideGetImageOptions

省略可能。 スライド イメージの目的のサイズを指定するオプション。

戻り値

PNG 形式のスライド イメージの base64 文字列。

注釈

[ API セット: PowerPointApi BETA (プレビューのみ) ]

load(options)

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

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

パラメーター

options
PowerPoint.Interfaces.SlideLoadOptions

読み込むオブジェクトのプロパティのオプションを提供します。

戻り値

load(propertyNames)

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

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

パラメーター

propertyNames

string | string[]

読み込むプロパティを指定するコンマ区切り文字列または文字列の配列。

戻り値

load(propertyNamesAndPaths)

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

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

パラメーター

propertyNamesAndPaths

{ select?: string; expand?: string; }

propertyNamesAndPaths.select は読み込むプロパティを指定するコンマ区切りの文字列で、 propertyNamesAndPaths.expand は読み込むナビゲーション プロパティを指定するコンマ区切りの文字列です。

戻り値

moveTo(slideIndex)

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

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

moveTo(slideIndex: number): void;

パラメーター

slideIndex

number

スライドを移動する 0 から始まるインデックス。

戻り値

void

注釈

[ API セット: PowerPointApi BETA (プレビューのみ) ]

setSelectedShapes(shapeIds)

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

setSelectedShapes(shapeIds: string[]): void;

パラメーター

shapeIds

string[]

スライドで選択する図形 ID の一覧。 リストが空の場合、選択はクリアされます。

戻り値

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");
  await context.sync();
  const shapes: PowerPoint.ShapeCollection = slide1.shapes;
  const shape1: PowerPoint.Shape = shapes.getItemAt(0);
  const shape2: PowerPoint.Shape = shapes.getItemAt(1);
  shape1.load("id");
  shape2.load("id");
  await context.sync();
  slide1.setSelectedShapes([shape1.id, shape2.id]);
  await context.sync();
});

toJSON()

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

toJSON(): PowerPoint.Interfaces.SlideData;

戻り値