PowerPoint.Interfaces.ShapeScopedCollectionLoadOptions interface

図形のコレクションを表します。

プロパティ

$all

読み込みオプションに $all を指定すると、すべてのスカラー プロパティ ( Range.address など) が読み込まれますが、ナビゲーション プロパティ ( Range.format.fill.color など) は読み込まれません。

adjustments

For each ITEM in the collection: この図形のすべての調整の調整値を含む Adjustments オブジェクトを返します。

altTextDescription

コレクション内の各アイテムの場合: 図形の代替テキストの説明。

代替テキストは、図形に含まれる情報の代替テキスト ベースの表現を提供します。 この情報は、形を見たり理解したりできない視覚または認知障害のあるユーザーに役立ちます。

altTextTitle

コレクション内の各アイテムの場合: 図形の代替テキスト タイトル。

代替テキストは、図形に含まれる情報の代替テキスト ベースの表現を提供します。 この情報は、形を見たり理解したりできない視覚または認知障害のあるユーザーに役立ちます。 タイトルは障碍のある人に読み上げることができ、コンテンツの説明を聞くかどうかを判断するために使用されます。

creationId

コレクション内の各アイテムの場合: 図形の作成 ID を取得します。 図形に作成 ID がない場合は null を返します。

fill

For each ITEM in the collection: この図形の塗りつぶしの書式設定を返します。

group

コレクション内の各アイテムの場合: 図形に関連付けられている ShapeGroup を返します。 図形の種類が groupでない場合、このメソッドは GeneralException エラーを返します。

height

コレクション内の各アイテムの場合: 図形の高さをポイント単位で指定します。 負の値に設定されている場合は、 InvalidArgument 例外をスローします。

id

コレクション内の各アイテムの場合: 図形の一意の ID を取得します。

isDecorative

コレクション内の各アイテムの場合: 図形が装飾的かどうかを表します。

装飾的なオブジェクトは視覚的な興味をそそりますが、情報的ではありません (様式的な罫線など)。 スクリーン リーダーを使用している People は、これらが装飾用であると読み上げられるため、重要な情報を聞き逃しているわけではないことがわかります。

left

コレクション内の各アイテムの場合: 図形の左側からスライドの左側までの距離 (ポイント単位)。

level

For each ITEM in the collection: 指定した図形のレベルを返します。

  • レベル 0 は、図形がグループの一部ではないことを意味します。

  • レベル 1 は、図形が最上位グループの一部であることを意味します。

  • レベルが 1 より大きい場合、図形が入れ子になったグループであることを示します。

lineFormat

For each ITEM in the collection: この図形の線の書式設定を返します。

name

コレクション内の各アイテムの場合: この図形の名前を指定します。

parentGroup

For each ITEM in the collection: この図形の親グループを返します。 図形がグループに含まれていない場合、このメソッドは GeneralException エラーを返します。

placeholderFormat

For each ITEM in the collection: このプレースホルダーに特に適用されるプロパティを返します。 図形の種類が placeholderでない場合、このメソッドは GeneralException エラーを返します。

rotation

コレクション内の各アイテムの場合: z 軸を中心とした図形の回転を度数で指定します。 正の値は時計回りの回転を示し、負の値は反時計回りの回転を示します。

textFrame

For each ITEM in the collection: このShapeの PowerPoint.TextFrame オブジェクトを返します。 図形がTextFrameをサポートしていない場合は、InvalidArgument例外をスローします。

top

コレクション内の各アイテムの場合: 図形の上端からスライドの上端までの距離 (ポイント単位)。

type

For each ITEM in the collection: この図形の型を返します。 詳細については 、PowerPoint.ShapeType を参照してください。

visible

For each ITEM in the collection: 図形が表示されるかどうかを指定します。

width

コレクション内の各アイテムの場合: 図形の幅をポイント単位で指定します。 負の値に設定されている場合は、 InvalidArgument 例外をスローします。

zOrderPosition

For each ITEM in the collection: 図形の Z オーダー位置を返します。0 はスタックの下部を表します。 スライド上のすべての図形に一意の Z オーダーが設定されていますが、スライドごとに一意の Z オーダーのスタックもあるため、別々のスライド上の 2 つの図形に同じ Z オーダー番号を付けることができます。

プロパティの詳細

$all

読み込みオプションに $all を指定すると、すべてのスカラー プロパティ ( Range.address など) が読み込まれますが、ナビゲーション プロパティ ( Range.format.fill.color など) は読み込まれません。

$all?: boolean;

プロパティ値

boolean

adjustments

For each ITEM in the collection: この図形のすべての調整の調整値を含む Adjustments オブジェクトを返します。

adjustments?: PowerPoint.Interfaces.AdjustmentsLoadOptions;

プロパティ値

注釈

API セット: PowerPointApi 1.10

altTextDescription

コレクション内の各アイテムの場合: 図形の代替テキストの説明。

代替テキストは、図形に含まれる情報の代替テキスト ベースの表現を提供します。 この情報は、形を見たり理解したりできない視覚または認知障害のあるユーザーに役立ちます。

altTextDescription?: boolean;

プロパティ値

boolean

注釈

API セット: PowerPointApi 1.10

altTextTitle

コレクション内の各アイテムの場合: 図形の代替テキスト タイトル。

代替テキストは、図形に含まれる情報の代替テキスト ベースの表現を提供します。 この情報は、形を見たり理解したりできない視覚または認知障害のあるユーザーに役立ちます。 タイトルは障碍のある人に読み上げることができ、コンテンツの説明を聞くかどうかを判断するために使用されます。

altTextTitle?: boolean;

プロパティ値

boolean

注釈

API セット: PowerPointApi 1.10

creationId

コレクション内の各アイテムの場合: 図形の作成 ID を取得します。 図形に作成 ID がない場合は null を返します。

creationId?: boolean;

プロパティ値

boolean

注釈

API セット: PowerPointApi 1.10

fill

For each ITEM in the collection: この図形の塗りつぶしの書式設定を返します。

fill?: PowerPoint.Interfaces.ShapeFillLoadOptions;

プロパティ値

注釈

API セット: PowerPointApi 1.5

group

コレクション内の各アイテムの場合: 図形に関連付けられている ShapeGroup を返します。 図形の種類が groupでない場合、このメソッドは GeneralException エラーを返します。

group?: PowerPoint.Interfaces.ShapeGroupLoadOptions;

プロパティ値

注釈

API セット: PowerPointApi 1.8

height

コレクション内の各アイテムの場合: 図形の高さをポイント単位で指定します。 負の値に設定されている場合は、 InvalidArgument 例外をスローします。

height?: boolean;

プロパティ値

boolean

注釈

API セット: PowerPointApi 1.4

id

コレクション内の各アイテムの場合: 図形の一意の ID を取得します。

id?: boolean;

プロパティ値

boolean

注釈

API セット: PowerPointApi 1.3

isDecorative

コレクション内の各アイテムの場合: 図形が装飾的かどうかを表します。

装飾的なオブジェクトは視覚的な興味をそそりますが、情報的ではありません (様式的な罫線など)。 スクリーン リーダーを使用している People は、これらが装飾用であると読み上げられるため、重要な情報を聞き逃しているわけではないことがわかります。

isDecorative?: boolean;

プロパティ値

boolean

注釈

API セット: PowerPointApi 1.10

left

コレクション内の各アイテムの場合: 図形の左側からスライドの左側までの距離 (ポイント単位)。

left?: boolean;

プロパティ値

boolean

注釈

API セット: PowerPointApi 1.4

level

For each ITEM in the collection: 指定した図形のレベルを返します。

  • レベル 0 は、図形がグループの一部ではないことを意味します。

  • レベル 1 は、図形が最上位グループの一部であることを意味します。

  • レベルが 1 より大きい場合、図形が入れ子になったグループであることを示します。

level?: boolean;

プロパティ値

boolean

注釈

API セット: PowerPointApi 1.8

lineFormat

For each ITEM in the collection: この図形の線の書式設定を返します。

lineFormat?: PowerPoint.Interfaces.ShapeLineFormatLoadOptions;

プロパティ値

注釈

API セット: PowerPointApi 1.5

name

コレクション内の各アイテムの場合: この図形の名前を指定します。

name?: boolean;

プロパティ値

boolean

注釈

API セット: PowerPointApi 1.4

parentGroup

For each ITEM in the collection: この図形の親グループを返します。 図形がグループに含まれていない場合、このメソッドは GeneralException エラーを返します。

parentGroup?: PowerPoint.Interfaces.ShapeLoadOptions;

プロパティ値

注釈

API セット: PowerPointApi 1.8

placeholderFormat

For each ITEM in the collection: このプレースホルダーに特に適用されるプロパティを返します。 図形の種類が placeholderでない場合、このメソッドは GeneralException エラーを返します。

placeholderFormat?: PowerPoint.Interfaces.PlaceholderFormatLoadOptions;

プロパティ値

注釈

API セット: PowerPointApi 1.8

rotation

コレクション内の各アイテムの場合: z 軸を中心とした図形の回転を度数で指定します。 正の値は時計回りの回転を示し、負の値は反時計回りの回転を示します。

rotation?: boolean;

プロパティ値

boolean

注釈

API セット: PowerPointApi 1.10

textFrame

For each ITEM in the collection: このShapeの PowerPoint.TextFrame オブジェクトを返します。 図形がTextFrameをサポートしていない場合は、InvalidArgument例外をスローします。

textFrame?: PowerPoint.Interfaces.TextFrameLoadOptions;

プロパティ値

注釈

API セット: PowerPointApi 1.5

top

コレクション内の各アイテムの場合: 図形の上端からスライドの上端までの距離 (ポイント単位)。

top?: boolean;

プロパティ値

boolean

注釈

API セット: PowerPointApi 1.4

type

For each ITEM in the collection: この図形の型を返します。 詳細については 、PowerPoint.ShapeType を参照してください。

type?: boolean;

プロパティ値

boolean

注釈

API セット: PowerPointApi 1.4

visible

For each ITEM in the collection: 図形が表示されるかどうかを指定します。

visible?: boolean;

プロパティ値

boolean

注釈

API セット: PowerPointApi 1.10

width

コレクション内の各アイテムの場合: 図形の幅をポイント単位で指定します。 負の値に設定されている場合は、 InvalidArgument 例外をスローします。

width?: boolean;

プロパティ値

boolean

注釈

API セット: PowerPointApi 1.4

zOrderPosition

For each ITEM in the collection: 図形の Z オーダー位置を返します。0 はスタックの下部を表します。 スライド上のすべての図形に一意の Z オーダーが設定されていますが、スライドごとに一意の Z オーダーのスタックもあるため、別々のスライド上の 2 つの図形に同じ Z オーダー番号を付けることができます。

zOrderPosition?: boolean;

プロパティ値

boolean

注釈

API セット: PowerPointApi 1.8