Excel.Interfaces.ShapeCollectionLoadOptions interface

ワークシート内のすべての図形のコレクションを表します。

注釈

[ API セット: ExcelApi 1.9 ]

プロパティ

$all

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

altTextDescription

コレクション内の各項目に対して: オブジェクトの代替説明テキストを Shape 指定します。

altTextTitle

コレクション内の各項目に対して: オブジェクトの代替タイトル テキストを Shape 指定します。

connectionSiteCount

コレクション内の各項目について: この図形の接続サイトの数を返します。

displayName

コレクション内の各項目の場合: 図形の表示名を取得します。 新しく作成された図形には、ローカライズされ、その nameと一致しない可能性がある生成された名前があります。 このシナリオでは、この API を使用して、UI に表示される名前を取得できます。

fill

コレクション内の各項目の場合: この図形の塗りつぶしの書式を返します。

geometricShape

コレクション内の各項目について: 図形に関連付けられている幾何学的図形を返します。 図形の種類が "GeometricShape" ではない場合は、エラーがスローされます。

geometricShapeType

コレクション内の各項目に対して: この幾何学的図形の幾何学的図形の種類を指定します。 詳細は「Excel.GeometricShapeType」をご覧ください。 図形の null 種類が "GeometrShape" でない場合は を返します。

group

コレクション内の各項目の場合: 図形に関連付けられている図形グループを返します。 図形の種類が "GroupShape" ではない場合は、エラーがスローされます。

height

コレクション内の各項目の場合: 図形の高さをポイント単位で指定します。 負の InvalidArgument 値または 0 を入力として設定すると、例外がスローされます。

id

コレクション内の各項目の場合: 図形識別子を指定します。

image

コレクション内の各項目について: 図形に関連付けられているイメージを返します。 図形の種類が "Image" ではない場合は、エラーがスローされます。

left

コレクション内の各項目の場合: 図形の左側からワークシートの左側までの距離をポイント単位で指定します。 負の値を InvalidArgument 入力として設定すると、例外がスローされます。

level

コレクション内の各項目の場合: 指定した図形のレベルを指定します。 たとえば、レベル 0 は図形がどのグループの一部でもないことを意味し、レベル 1 は図形が最上位グループの一部であることを意味し、レベル 2 は図形が最上位レベルのサブグループの一部であることを意味します。

line

コレクション内の各項目の場合: 図形に関連付けられている行を返します。 図形の種類が "Line" ではない場合は、エラーがスローされます。

lineFormat

コレクション内の各項目の場合: この図形の行書式を返します。

lockAspectRatio

コレクション内の各項目の場合: この図形の縦横比がロックされているかどうかを指定します。

name

コレクション内の各項目の場合: 図形の名前を指定します。

parentGroup

コレクション内の各項目の場合: この図形の親グループを指定します。

placement

コレクション内の各項目について: オブジェクトの下のセルにオブジェクトをアタッチする方法を表します。

rotation

コレクション内の各項目の場合: 図形の回転を度単位で指定します。

textFrame

コレクション内の各項目について: この図形のテキスト フレーム オブジェクトを返します。

top

コレクション内の各項目の場合: 図形の上端からワークシートの上端までの距離をポイント単位で指定します。 負の値を InvalidArgument 入力として設定すると、例外がスローされます。

type

コレクション内の各項目について: この図形の型を返します。 詳細は「Excel.ShapeType」をご覧ください。

visible

コレクション内の各項目の場合: 図形が表示されるかどうかを指定します。

width

コレクション内の各項目の場合: 図形の幅をポイント単位で指定します。 負の InvalidArgument 値または 0 を入力として設定すると、例外がスローされます。

zOrderPosition

コレクション内の各項目の場合: 指定した図形の z オーダー内の位置を返し、0 は注文スタックの下部を表します。

プロパティの詳細

$all

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

$all?: boolean;

プロパティ値

boolean

altTextDescription

コレクション内の各項目に対して: オブジェクトの代替説明テキストを Shape 指定します。

altTextDescription?: boolean;

プロパティ値

boolean

注釈

[ API セット: ExcelApi 1.9 ]

altTextTitle

コレクション内の各項目に対して: オブジェクトの代替タイトル テキストを Shape 指定します。

altTextTitle?: boolean;

プロパティ値

boolean

注釈

[ API セット: ExcelApi 1.9 ]

connectionSiteCount

コレクション内の各項目について: この図形の接続サイトの数を返します。

connectionSiteCount?: boolean;

プロパティ値

boolean

注釈

[ API セット: ExcelApi 1.9 ]

displayName

コレクション内の各項目の場合: 図形の表示名を取得します。 新しく作成された図形には、ローカライズされ、その nameと一致しない可能性がある生成された名前があります。 このシナリオでは、この API を使用して、UI に表示される名前を取得できます。

displayName?: boolean;

プロパティ値

boolean

注釈

[ API セット: ExcelApi 1.15 ]

fill

コレクション内の各項目の場合: この図形の塗りつぶしの書式を返します。

fill?: Excel.Interfaces.ShapeFillLoadOptions;

プロパティ値

注釈

[ API セット: ExcelApi 1.9 ]

geometricShape

コレクション内の各項目について: 図形に関連付けられている幾何学的図形を返します。 図形の種類が "GeometricShape" ではない場合は、エラーがスローされます。

geometricShape?: Excel.Interfaces.GeometricShapeLoadOptions;

プロパティ値

注釈

[ API セット: ExcelApi 1.9 ]

geometricShapeType

コレクション内の各項目に対して: この幾何学的図形の幾何学的図形の種類を指定します。 詳細は「Excel.GeometricShapeType」をご覧ください。 図形の null 種類が "GeometrShape" でない場合は を返します。

geometricShapeType?: boolean;

プロパティ値

boolean

注釈

[ API セット: ExcelApi 1.9 ]

group

コレクション内の各項目の場合: 図形に関連付けられている図形グループを返します。 図形の種類が "GroupShape" ではない場合は、エラーがスローされます。

group?: Excel.Interfaces.ShapeGroupLoadOptions;

プロパティ値

注釈

[ API セット: ExcelApi 1.9 ]

height

コレクション内の各項目の場合: 図形の高さをポイント単位で指定します。 負の InvalidArgument 値または 0 を入力として設定すると、例外がスローされます。

height?: boolean;

プロパティ値

boolean

注釈

[ API セット: ExcelApi 1.9 ]

id

コレクション内の各項目の場合: 図形識別子を指定します。

id?: boolean;

プロパティ値

boolean

注釈

[ API セット: ExcelApi 1.9 ]

image

コレクション内の各項目について: 図形に関連付けられているイメージを返します。 図形の種類が "Image" ではない場合は、エラーがスローされます。

image?: Excel.Interfaces.ImageLoadOptions;

プロパティ値

注釈

[ API セット: ExcelApi 1.9 ]

left

コレクション内の各項目の場合: 図形の左側からワークシートの左側までの距離をポイント単位で指定します。 負の値を InvalidArgument 入力として設定すると、例外がスローされます。

left?: boolean;

プロパティ値

boolean

注釈

[ API セット: ExcelApi 1.9 ]

level

コレクション内の各項目の場合: 指定した図形のレベルを指定します。 たとえば、レベル 0 は図形がどのグループの一部でもないことを意味し、レベル 1 は図形が最上位グループの一部であることを意味し、レベル 2 は図形が最上位レベルのサブグループの一部であることを意味します。

level?: boolean;

プロパティ値

boolean

注釈

[ API セット: ExcelApi 1.9 ]

line

コレクション内の各項目の場合: 図形に関連付けられている行を返します。 図形の種類が "Line" ではない場合は、エラーがスローされます。

line?: Excel.Interfaces.LineLoadOptions;

プロパティ値

注釈

[ API セット: ExcelApi 1.9 ]

lineFormat

コレクション内の各項目の場合: この図形の行書式を返します。

lineFormat?: Excel.Interfaces.ShapeLineFormatLoadOptions;

プロパティ値

注釈

[ API セット: ExcelApi 1.9 ]

lockAspectRatio

コレクション内の各項目の場合: この図形の縦横比がロックされているかどうかを指定します。

lockAspectRatio?: boolean;

プロパティ値

boolean

注釈

[ API セット: ExcelApi 1.9 ]

name

コレクション内の各項目の場合: 図形の名前を指定します。

name?: boolean;

プロパティ値

boolean

注釈

[ API セット: ExcelApi 1.9 ]

parentGroup

コレクション内の各項目の場合: この図形の親グループを指定します。

parentGroup?: Excel.Interfaces.ShapeLoadOptions;

プロパティ値

注釈

[ API セット: ExcelApi 1.9 ]

placement

コレクション内の各項目について: オブジェクトの下のセルにオブジェクトをアタッチする方法を表します。

placement?: boolean;

プロパティ値

boolean

注釈

[ API セット: ExcelApi 1.10 ]

rotation

コレクション内の各項目の場合: 図形の回転を度単位で指定します。

rotation?: boolean;

プロパティ値

boolean

注釈

[ API セット: ExcelApi 1.9 ]

textFrame

コレクション内の各項目について: この図形のテキスト フレーム オブジェクトを返します。

textFrame?: Excel.Interfaces.TextFrameLoadOptions;

プロパティ値

注釈

[ API セット: ExcelApi 1.9 ]

top

コレクション内の各項目の場合: 図形の上端からワークシートの上端までの距離をポイント単位で指定します。 負の値を InvalidArgument 入力として設定すると、例外がスローされます。

top?: boolean;

プロパティ値

boolean

注釈

[ API セット: ExcelApi 1.9 ]

type

コレクション内の各項目について: この図形の型を返します。 詳細は「Excel.ShapeType」をご覧ください。

type?: boolean;

プロパティ値

boolean

注釈

[ API セット: ExcelApi 1.9 ]

visible

コレクション内の各項目の場合: 図形が表示されるかどうかを指定します。

visible?: boolean;

プロパティ値

boolean

注釈

[ API セット: ExcelApi 1.9 ]

width

コレクション内の各項目の場合: 図形の幅をポイント単位で指定します。 負の InvalidArgument 値または 0 を入力として設定すると、例外がスローされます。

width?: boolean;

プロパティ値

boolean

注釈

[ API セット: ExcelApi 1.9 ]

zOrderPosition

コレクション内の各項目の場合: 指定した図形の z オーダー内の位置を返し、0 は注文スタックの下部を表します。

zOrderPosition?: boolean;

プロパティ値

boolean

注釈

[ API セット: ExcelApi 1.9 ]