PowerPoint.BindingCollection class

パッケージ:: powerpoint

プレゼンテーションに含まれるすべてのバインドオブジェクトのコレクションを表します。

Extends: OfficeExtension.ClientObject

注釈

例

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

// Loads bindings.
await PowerPoint.run(async (context) => {
  const bindings = context.presentation.bindings;
  bindings.load("items");
  await context.sync();

  const bindingCount = bindings.items.length;
  if (bindingCount === 0) {
    console.log(`There are no bindings.`);
  } else if (bindingCount === 1) {
    console.log("There's 1 binding.");
  } else {
    console.log(`There are ${bindingCount} bindings.`);
  }

  bindings.items.forEach((binding) => {
    getShapeForBindingId(binding.id).then((shape) => {
      if (shape) {
        console.log(`Binding ID: ${binding.id} refers to shape ID ${shape.id}`);
      } else {
        console.log(`Binding ID: ${binding.id} doesn't refers to shape.`);
      }
    });
  });

  populateBindingsDropdown(bindings.items);
});

プロパティ

context	オブジェクトに関連付けられている要求コンテキスト。これにより、アドインのプロセスが Office ホストアプリケーションのプロセスに接続されます。
items	このコレクション内に読み込まれた子アイテムを取得します。

メソッド

add(shape, bindingType, id)	特定の Shape に新しいバインドを追加します。指定した ID がバインドによって既に使用されている場合は、既存のバインドが上書きされます。
add(shape, bindingType, id)	特定の Shape に新しいバインドを追加します。指定した ID がバインドによって既に使用されている場合は、既存のバインドが上書きされます。
addFromSelection(bindingType, id)	現在の選択に基づいて新しいバインドを追加します。選択範囲に複数の領域がある場合は、 `InvalidReference` エラーが返されます。
addFromSelection(bindingType, id)	現在の選択に基づいて新しいバインドを追加します。選択範囲に複数の領域がある場合は、 `InvalidReference` エラーが返されます。
getCount()	コレクションに含まれるバインドの数を取得します。
getItem(key)	ID を使用してバインドオブジェクトを取得します。その ID とのバインドがない場合は、ItemNotFoundException をスローします。
getItemAt(index)	項目の配列内の位置に基づいて、バインドオブジェクトを取得します。インデックスが 0 より小さい場合、またはコレクション内の項目の数以上の場合は、InvalidArgumentException をスローします。
getItemOrNullObject(id)	ID を使用してバインドオブジェクトを取得します。バインドオブジェクトが存在しない場合、このメソッドは `isNullObject` プロパティを `true` に設定したオブジェクトを返します。詳細については、「 *OrNullObject メソッドとプロパティ」を参照してください。
load(options)	オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。プロパティを読み取る前に、`context.sync()` を呼び出す必要があります。
load(propertyNames)	オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。プロパティを読み取る前に、`context.sync()` を呼び出す必要があります。
load(propertyNamesAndPaths)	オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。プロパティを読み取る前に、`context.sync()` を呼び出す必要があります。
toJSON()	API オブジェクトが`JSON.stringify()`に渡されたときにより便利な出力を提供するために、JavaScript `toJSON()` メソッドをオーバーライドします。 (`JSON.stringify`、それに渡されるオブジェクトの `toJSON` メソッドを呼び出します)。元の `PowerPoint.BindingCollection` オブジェクトは API オブジェクトですが、 `toJSON` メソッドは、コレクションの項目から読み込まれたプロパティの浅いコピーを含む "items" 配列を含むプレーンな JavaScript オブジェクト ( `PowerPoint.Interfaces.BindingCollectionData`として型指定) を返します。

プロパティの詳細

context

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

context: RequestContext;

プロパティ値

PowerPoint.RequestContext

items

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

readonly items: PowerPoint.Binding[];

プロパティ値

PowerPoint.Binding[]

メソッドの詳細

add(shape, bindingType, id)

特定の Shape に新しいバインドを追加します。指定した ID がバインドによって既に使用されている場合は、既存のバインドが上書きされます。

add(shape: PowerPoint.Shape, bindingType: PowerPoint.BindingType, id: string): PowerPoint.Binding;

パラメーター

shape: PowerPoint.Shape

バインドが追加される図形。

bindingType: PowerPoint.BindingType

バインドの種類。 BindingType を参照してください。

id: string

バインドの ID。

戻り値

PowerPoint.Binding

注釈

[ API セット: PowerPointApi 1.8 ]

例

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

// Inserts an image with binding.
await PowerPoint.run(async (context) => {
  const bindingId = (document.getElementById("temp-binding-id") as HTMLInputElement).value;
  const slide = context.presentation.getSelectedSlides().getItemAt(0);
  const myShape = slide.shapes.addGeometricShape(PowerPoint.GeometricShapeType.rectangle, {
    top: 100,
    left: 30,
    width: 200,
    height: 200
  });

  myShape.fill.setImage(flowerImage);
  context.presentation.bindings.add(myShape, PowerPoint.BindingType.shape, bindingId);
  await context.sync();

  const bindingsDropdown = document.getElementById("bindings-dropdown") as HTMLSelectElement;

  const option = new Option(`Binding ${bindingId}`, bindingId);

  // When a binding ID already exists, the binding is updated to refer to the new shape
  // so select the existing item rather than add a new one.
  const foundIndex = findDropdownItem(bindingsDropdown, option.text);
  if (foundIndex < 0) {
    bindingsDropdown.add(option);
    bindingsDropdown.selectedIndex = bindingsDropdown.options.length - 1;
  } else {
    bindingsDropdown.selectedIndex = foundIndex;
  }
});

add(shape, bindingType, id)

特定の Shape に新しいバインドを追加します。指定した ID がバインドによって既に使用されている場合は、既存のバインドが上書きされます。

add(shape: PowerPoint.Shape, bindingType: "Shape", id: string): PowerPoint.Binding;

パラメーター

shape: PowerPoint.Shape

バインドが追加される図形。

bindingType: "Shape"

バインドの種類。 BindingType を参照してください。

id: string

バインドの ID。

戻り値

PowerPoint.Binding

注釈

[ API セット: PowerPointApi 1.8 ]

addFromSelection(bindingType, id)

現在の選択に基づいて新しいバインドを追加します。選択範囲に複数の領域がある場合は、 InvalidReference エラーが返されます。

addFromSelection(bindingType: PowerPoint.BindingType, id: string): PowerPoint.Binding;

パラメーター

bindingType: PowerPoint.BindingType

バインドの種類。 BindingType を参照してください。

id: string

バインドの ID。

戻り値

PowerPoint.Binding

注釈

[ API セット: PowerPointApi 1.8 ]

addFromSelection(bindingType, id)

現在の選択に基づいて新しいバインドを追加します。選択範囲に複数の領域がある場合は、 InvalidReference エラーが返されます。

addFromSelection(bindingType: "Shape", id: string): PowerPoint.Binding;

パラメーター

bindingType: "Shape"

バインドの種類。 BindingType を参照してください。

id: string

バインドの ID。

戻り値

PowerPoint.Binding

注釈

[ API セット: PowerPointApi 1.8 ]

getCount()

コレクションに含まれるバインドの数を取得します。

getCount(): OfficeExtension.ClientResult<number>;

戻り値

OfficeExtension.ClientResult<number>

注釈

[ API セット: PowerPointApi 1.8 ]

getItem(key)

ID を使用してバインドオブジェクトを取得します。その ID とのバインドがない場合は、ItemNotFoundException をスローします。

getItem(key: string): PowerPoint.Binding;

パラメーター

key: string

取得するバインドオブジェクトの ID。

戻り値

PowerPoint.Binding

注釈

[ API セット: PowerPointApi 1.8 ]

例

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

async function getShapeForBindingId(bindingId: string): Promise<PowerPoint.Shape | undefined> {
  // Gets shape associated with binding ID.
  return PowerPoint.run(async (context) => {
    const binding = context.presentation.bindings.getItem(bindingId);
    const shape = binding.getShape();
    return shape;
  });
}

getItemAt(index)

項目の配列内の位置に基づいて、バインドオブジェクトを取得します。インデックスが 0 より小さい場合、またはコレクション内の項目の数以上の場合は、InvalidArgumentException をスローします。

getItemAt(index: number): PowerPoint.Binding;

パラメーター

index: number

取得するオブジェクトのインデックス値。 0 を起点とする番号になります。

戻り値

PowerPoint.Binding

注釈

[ API セット: PowerPointApi 1.8 ]

getItemOrNullObject(id)

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

getItemOrNullObject(id: string): PowerPoint.Binding;

パラメーター

id: string

取得するバインドオブジェクトの ID。

戻り値

PowerPoint.Binding

注釈

[ API セット: PowerPointApi 1.8 ]

load(options)

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

load(options?: PowerPoint.Interfaces.BindingCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions): PowerPoint.BindingCollection;

パラメーター

options: PowerPoint.Interfaces.BindingCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions

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

戻り値

PowerPoint.BindingCollection

load(propertyNames)

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

パラメーター

propertyNames: string | string[]

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

戻り値

PowerPoint.BindingCollection

load(propertyNamesAndPaths)

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

パラメーター

propertyNamesAndPaths: OfficeExtension.LoadOption

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

戻り値

PowerPoint.BindingCollection

toJSON()

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

toJSON(): PowerPoint.Interfaces.BindingCollectionData;

戻り値

PowerPoint.Interfaces.BindingCollectionData

フィードバック

このページはお役に立ちましたか?

次の方法で共有

PowerPoint.BindingCollection class

注釈

例

プロパティ

メソッド

プロパティの詳細

context

プロパティ値

items

プロパティ値

メソッドの詳細

add(shape, bindingType, id)

パラメーター

戻り値

注釈

例

add(shape, bindingType, id)

パラメーター

戻り値

注釈

addFromSelection(bindingType, id)

パラメーター

戻り値

注釈

addFromSelection(bindingType, id)

パラメーター

戻り値

注釈

getCount()

戻り値

注釈

getItem(key)

パラメーター

戻り値

注釈

例

getItemAt(index)

パラメーター

戻り値

注釈

getItemOrNullObject(id)

パラメーター

戻り値

注釈

load(options)

パラメーター

戻り値

load(propertyNames)

パラメーター

戻り値

load(propertyNamesAndPaths)

パラメーター

戻り値

toJSON()

戻り値

フィードバック