Excel.Interfaces.GroupShapeCollectionLoadOptions interface

図形グループ内の図形コレクションを表します。

プロパティ

$all

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

altTextDescription

For each ITEM in the collection: Shape オブジェクトの代替説明テキストを指定します。

altTextTitle

For each ITEM in the collection: Shape オブジェクトの代替タイトル テキストを指定します。

connectionSiteCount

For each ITEM in the collection: この図形の接続サイトの数を返します。

displayName

For each ITEM in the collection: 図形の表示名を取得します。 新しく作成された図形は、ローカライズされた生成された名前を持ち、その nameと一致しない可能性があります。 このシナリオでは、この API を使用して、UI に表示される名前を取得できます。

fill

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

geometricShape

For each ITEM in the collection: 図形に関連付けられている幾何学的図形を返します。 図形の種類が "GeometricShape" ではない場合は、エラーがスローされます。

geometricShapeType

コレクション内の各アイテムの場合: この幾何学的形状の幾何学的形状タイプを指定します。 詳細は「Excel.GeometricShapeType」をご覧ください。 形状の種類が "GeometricShape" ではない場合に null を返します。

group

For each ITEM in the collection: 図形に関連付けられている図形グループを返します。 図形の種類が "GroupShape" ではない場合は、エラーがスローされます。

height

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

id

For each ITEM in the collection: 図形の識別子を指定します。

image

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

left

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

level

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

line

For each ITEM in the collection: 図形に関連付けられている線を返します。 図形の種類が "Line" ではない場合は、エラーがスローされます。

lineFormat

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

lockAspectRatio

For each ITEM in the collection: この図形の縦横比がロックされているかどうかを指定します。

name

For each ITEM in the collection: 図形の名前を指定します。

parentGroup

For each ITEM in the collection: この図形の親グループを指定します。

placement

コレクション内の各アイテムの場合: オブジェクトがその下のセルにどのようにアタッチされるかを表します。

rotation

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

textFrame

For each ITEM in the collection: この図形のテキスト フレーム オブジェクトを返します。

top

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

type

For each ITEM in the collection: この図形の型を返します。 詳細は「Excel.ShapeType」をご覧ください。

visible

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

width

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

zOrderPosition

For EACH ITEM in the collection: 指定された図形の Z-オーダーの位置を返します。0 はスタックの下部を表します。

プロパティの詳細

$all

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

$all?: boolean;

プロパティ値

boolean

altTextDescription

For each ITEM in the collection: Shape オブジェクトの代替説明テキストを指定します。

altTextDescription?: boolean;

プロパティ値

boolean

注釈

API セット: ExcelApi 1.9

altTextTitle

For each ITEM in the collection: Shape オブジェクトの代替タイトル テキストを指定します。

altTextTitle?: boolean;

プロパティ値

boolean

注釈

API セット: ExcelApi 1.9

connectionSiteCount

For each ITEM in the collection: この図形の接続サイトの数を返します。

connectionSiteCount?: boolean;

プロパティ値

boolean

注釈

API セット: ExcelApi 1.9

displayName

For each ITEM in the collection: 図形の表示名を取得します。 新しく作成された図形は、ローカライズされた生成された名前を持ち、その nameと一致しない可能性があります。 このシナリオでは、この API を使用して、UI に表示される名前を取得できます。

displayName?: boolean;

プロパティ値

boolean

注釈

API セット: ExcelApi 1.15

fill

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

fill?: Excel.Interfaces.ShapeFillLoadOptions;

プロパティ値

注釈

API セット: ExcelApi 1.9

geometricShape

For each ITEM in the collection: 図形に関連付けられている幾何学的図形を返します。 図形の種類が "GeometricShape" ではない場合は、エラーがスローされます。

geometricShape?: Excel.Interfaces.GeometricShapeLoadOptions;

プロパティ値

注釈

API セット: ExcelApi 1.9

geometricShapeType

コレクション内の各アイテムの場合: この幾何学的形状の幾何学的形状タイプを指定します。 詳細は「Excel.GeometricShapeType」をご覧ください。 形状の種類が "GeometricShape" ではない場合に null を返します。

geometricShapeType?: boolean;

プロパティ値

boolean

注釈

API セット: ExcelApi 1.9

group

For each ITEM in the collection: 図形に関連付けられている図形グループを返します。 図形の種類が "GroupShape" ではない場合は、エラーがスローされます。

group?: Excel.Interfaces.ShapeGroupLoadOptions;

プロパティ値

注釈

API セット: ExcelApi 1.9

height

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

height?: boolean;

プロパティ値

boolean

注釈

API セット: ExcelApi 1.9

id

For each ITEM in the collection: 図形の識別子を指定します。

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

For each ITEM in the collection: 図形に関連付けられている線を返します。 図形の種類が "Line" ではない場合は、エラーがスローされます。

line?: Excel.Interfaces.LineLoadOptions;

プロパティ値

注釈

API セット: ExcelApi 1.9

lineFormat

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

lineFormat?: Excel.Interfaces.ShapeLineFormatLoadOptions;

プロパティ値

注釈

API セット: ExcelApi 1.9

lockAspectRatio

For each ITEM in the collection: この図形の縦横比がロックされているかどうかを指定します。

lockAspectRatio?: boolean;

プロパティ値

boolean

注釈

API セット: ExcelApi 1.9

name

For each ITEM in the collection: 図形の名前を指定します。

name?: boolean;

プロパティ値

boolean

注釈

API セット: ExcelApi 1.9

parentGroup

For each ITEM in the collection: この図形の親グループを指定します。

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

For each ITEM in the collection: この図形のテキスト フレーム オブジェクトを返します。

textFrame?: Excel.Interfaces.TextFrameLoadOptions;

プロパティ値

注釈

API セット: ExcelApi 1.9

top

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

top?: boolean;

プロパティ値

boolean

注釈

API セット: ExcelApi 1.9

type

For each ITEM in the collection: この図形の型を返します。 詳細は「Excel.ShapeType」をご覧ください。

type?: boolean;

プロパティ値

boolean

注釈

API セット: ExcelApi 1.9

visible

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

visible?: boolean;

プロパティ値

boolean

注釈

API セット: ExcelApi 1.9

width

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

width?: boolean;

プロパティ値

boolean

注釈

API セット: ExcelApi 1.9

zOrderPosition

For EACH ITEM in the collection: 指定された図形の Z-オーダーの位置を返します。0 はスタックの下部を表します。

zOrderPosition?: boolean;

プロパティ値

boolean

注釈

API セット: ExcelApi 1.9