Excel.Interfaces.ShapeCollectionLoadOptions interface
ワークシート内のすべての図形のコレクションを表します。
注釈
プロパティ
| $all | 読み込みオプションに |
| alt |
コレクション内の各項目の場合: |
| alt |
コレクション内の各項目の場合: |
| connection |
コレクション内の各項目について: この図形の接続サイトの数を返します。 |
| display |
コレクション内の各項目の場合: 図形の表示名を取得します。 新しく作成された図形には、ローカライズされた生成された名前があり、その |
| fill | コレクション内の各項目の場合: この図形の塗りつぶしの書式を返します。 |
| geometric |
コレクション内の各項目について: 図形に関連付けられている幾何学的図形を返します。 図形の種類が "GeometricShape" ではない場合は、エラーがスローされます。 |
| geometric |
コレクション内の各項目に対して: この幾何学的図形の幾何学的図形の種類を指定します。 詳細は「 |
| group | コレクション内の各項目の場合: 図形に関連付けられている図形グループを返します。 図形の種類が "GroupShape" ではない場合は、エラーがスローされます。 |
| height | コレクション内の各項目の場合: 図形の高さをポイント単位で指定します。 負の値または 0 を入力として設定すると、 |
| id | コレクション内の各項目の場合: 図形識別子を指定します。 |
| image | コレクション内の各項目について: 図形に関連付けられているイメージを返します。 図形の種類が "Image" ではない場合は、エラーがスローされます。 |
| left | コレクション内の各項目の場合: 図形の左側からワークシートの左側までの距離をポイント単位で指定します。 負の値を入力として設定すると、 |
| level | コレクション内の各項目の場合: 指定した図形のレベルを指定します。 たとえば、レベル 0 は図形がどのグループの一部でもないことを意味し、レベル 1 は図形が最上位グループの一部であることを意味し、レベル 2 は図形が最上位レベルのサブグループの一部であることを意味します。 |
| line | コレクション内の各項目について: 図形に関連付けられている行を返します。 図形の種類が "Line" ではない場合は、エラーがスローされます。 |
| line |
コレクション内の各項目の場合: この図形の行書式を返します。 |
| lock |
コレクション内の各項目の場合: この図形の縦横比がロックされているかどうかを指定します。 |
| name | コレクション内の各項目の場合: 図形の名前を指定します。 |
| parent |
コレクション内の各項目の場合: この図形の親グループを指定します。 |
| placement | コレクション内の各項目について: オブジェクトの下のセルにオブジェクトをアタッチする方法を表します。 |
| rotation | コレクション内の各項目の場合: 図形の回転を度単位で指定します。 |
| text |
コレクション内の各項目について: この図形のテキスト フレーム オブジェクトを返します。 |
| top | コレクション内の各項目の場合: 図形の上端からワークシートの上端までの距離をポイント単位で指定します。 負の値を入力として設定すると、 |
| type | コレクション内の各項目について: この図形の型を返します。 詳細は「 |
| visible | コレクション内の各項目の場合: 図形が表示されるかどうかを指定します。 |
| width | コレクション内の各項目の場合: 図形の幅をポイント単位で指定します。 負の値または 0 を入力として設定すると、 |
| z |
コレクション内の各項目の場合: 指定した図形の z オーダー内の位置を返し、0 は注文スタックの下部を表します。 |
プロパティの詳細
$all
読み込みオプションに $all を指定すると、すべてのスカラー プロパティ ( Range.addressなど) が読み込まれますが、ナビゲーション プロパティ ( Range.format.fill.color など) は読み込まれません。
$all?: boolean;
プロパティ値
boolean
altTextDescription
コレクション内の各項目の場合: Shape オブジェクトの代替説明テキストを指定します。
altTextDescription?: boolean;
プロパティ値
boolean
注釈
altTextTitle
コレクション内の各項目の場合: Shape オブジェクトの代替タイトル テキストを指定します。
altTextTitle?: boolean;
プロパティ値
boolean
注釈
connectionSiteCount
コレクション内の各項目について: この図形の接続サイトの数を返します。
connectionSiteCount?: boolean;
プロパティ値
boolean
注釈
displayName
コレクション内の各項目の場合: 図形の表示名を取得します。 新しく作成された図形には、ローカライズされた生成された名前があり、その nameと一致しない可能性があります。 このシナリオでは、この API を使用して、UI に表示される名前を取得できます。
displayName?: boolean;
プロパティ値
boolean
注釈
fill
コレクション内の各項目の場合: この図形の塗りつぶしの書式を返します。
fill?: Excel.Interfaces.ShapeFillLoadOptions;
プロパティ値
注釈
geometricShape
コレクション内の各項目について: 図形に関連付けられている幾何学的図形を返します。 図形の種類が "GeometricShape" ではない場合は、エラーがスローされます。
geometricShape?: Excel.Interfaces.GeometricShapeLoadOptions;
プロパティ値
注釈
geometricShapeType
コレクション内の各項目に対して: この幾何学的図形の幾何学的図形の種類を指定します。 詳細は「Excel.GeometricShapeType」をご覧ください。 図形の種類が "GeometrShape" でない場合は、 null を返します。
geometricShapeType?: boolean;
プロパティ値
boolean
注釈
group
コレクション内の各項目の場合: 図形に関連付けられている図形グループを返します。 図形の種類が "GroupShape" ではない場合は、エラーがスローされます。
group?: Excel.Interfaces.ShapeGroupLoadOptions;
プロパティ値
注釈
height
コレクション内の各項目の場合: 図形の高さをポイント単位で指定します。 負の値または 0 を入力として設定すると、 InvalidArgument 例外がスローされます。
height?: boolean;
プロパティ値
boolean
注釈
id
image
コレクション内の各項目について: 図形に関連付けられているイメージを返します。 図形の種類が "Image" ではない場合は、エラーがスローされます。
image?: Excel.Interfaces.ImageLoadOptions;
プロパティ値
注釈
left
コレクション内の各項目の場合: 図形の左側からワークシートの左側までの距離をポイント単位で指定します。 負の値を入力として設定すると、 InvalidArgument 例外がスローされます。
left?: boolean;
プロパティ値
boolean
注釈
level
コレクション内の各項目の場合: 指定した図形のレベルを指定します。 たとえば、レベル 0 は図形がどのグループの一部でもないことを意味し、レベル 1 は図形が最上位グループの一部であることを意味し、レベル 2 は図形が最上位レベルのサブグループの一部であることを意味します。
level?: boolean;
プロパティ値
boolean
注釈
line
コレクション内の各項目について: 図形に関連付けられている行を返します。 図形の種類が "Line" ではない場合は、エラーがスローされます。
line?: Excel.Interfaces.LineLoadOptions;
プロパティ値
注釈
lineFormat
コレクション内の各項目の場合: この図形の行書式を返します。
lineFormat?: Excel.Interfaces.ShapeLineFormatLoadOptions;
プロパティ値
注釈
lockAspectRatio
コレクション内の各項目の場合: この図形の縦横比がロックされているかどうかを指定します。
lockAspectRatio?: boolean;
プロパティ値
boolean
注釈
name
parentGroup
コレクション内の各項目の場合: この図形の親グループを指定します。
parentGroup?: Excel.Interfaces.ShapeLoadOptions;
プロパティ値
注釈
placement
コレクション内の各項目について: オブジェクトの下のセルにオブジェクトをアタッチする方法を表します。
placement?: boolean;
プロパティ値
boolean
注釈
rotation
textFrame
コレクション内の各項目について: この図形のテキスト フレーム オブジェクトを返します。
textFrame?: Excel.Interfaces.TextFrameLoadOptions;
プロパティ値
注釈
top
コレクション内の各項目の場合: 図形の上端からワークシートの上端までの距離をポイント単位で指定します。 負の値を入力として設定すると、 InvalidArgument 例外がスローされます。
top?: boolean;
プロパティ値
boolean
注釈
type
コレクション内の各項目について: この図形の型を返します。 詳細は「Excel.ShapeType」をご覧ください。
type?: boolean;
プロパティ値
boolean
注釈
visible
width
コレクション内の各項目の場合: 図形の幅をポイント単位で指定します。 負の値または 0 を入力として設定すると、 InvalidArgument 例外がスローされます。
width?: boolean;
プロパティ値
boolean
注釈
zOrderPosition
コレクション内の各項目の場合: 指定した図形の z オーダー内の位置を返し、0 は注文スタックの下部を表します。
zOrderPosition?: boolean;
プロパティ値
boolean