ig.excel.WorksheetShapeCollection
依存関係
jquery-1.4.4.js
infragistics.util.js
infragistics.ext_collections.js
infragistics.ext_collectionsExtended.js
infragistics.ext_io.js
infragistics.ext_text.js
infragistics.ext_core.js
infragistics.documents.core_core.js
infragistics.ext_ui.js
このコントロールにオプションはありません。
このコントロールにイベントはありません。
-
add
- .add( shapeType:ig.excel.PredefinedShapeType, worksheet:ig.excel.Worksheet, boundsInTwips:object );
- 返却型:
- ig.excel.WorksheetShape
- 返却型の説明:
- 定義済みの図形を表す、WorksheetShape から派生したインスタンス。
定義済みの形状を、指定した境界線を持つコレクションに追加します。
- shapeType
- タイプ:ig.excel.PredefinedShapeType
- コレクションに追加する形状のタイプ。
- worksheet
- タイプ:ig.excel.Worksheet
- boundsInTwips の関連先の WorksheetShapeCollection.worksheet。
- boundsInTwips
- タイプ:object
- トゥイップ (ポイントの 1/20) 単位の、 ワークシートの形状の境界。 数値を持つ 'x'、'y'、'width'、および 'height'、または 'left'、'top'、'right'、および 'bottom' プロパティがあるオブジェクトです。例: { x: 1, y: 2, width: 100, height: 200 }。
例外
例外 説明 ig.ArgumentNullException ワークシートは null です。 ig.excel.InvalidEnumArgumentException shapeType が PredefinedShapeType 列挙体で定義されていないです。 -
add
- .add( shapeType:ig.excel.PredefinedShapeType, topLeftCornerCell:ig.excel.WorksheetCell, topLeftCornerPosition:object, bottomRightCornerCell:ig.excel.WorksheetCell, bottomRightCornerPosition:object );
- 返却型:
- ig.excel.WorksheetShape
- 返却型の説明:
- 定義済みの図形を表す、WorksheetShape から派生したインスタンス。
定義済みの形状を、指定した境界線を持つコレクションに追加します。
- shapeType
- タイプ:ig.excel.PredefinedShapeType
- コレクションに追加する形状のタイプ。
- topLeftCornerCell
- タイプ:ig.excel.WorksheetCell
- 形状の左上角の置かれるセル。
- topLeftCornerPosition
- タイプ:object
- パーセントで表される、形状の左上隅の topLeftCornerCell での位置。 これは、'x' および 'y' プロパティで数値があるオブジェクトです。例: { x: 1, y: 2 }。
- bottomRightCornerCell
- タイプ:ig.excel.WorksheetCell
- 形状の右下角の置かれるセル。
- bottomRightCornerPosition
- タイプ:object
- パーセントで表される、形状の右下隅の bottomRightCornerCell での位置。 これは、'x' および 'y' プロパティで数値があるオブジェクトです。例: { x: 1, y: 2 }。
例外
例外 説明 ig.excel.InvalidEnumArgumentException shapeType が PredefinedShapeType 列挙体で定義されていないです。 ig.InvalidOperationException topLeftCornerCell または bottomRightCornerCell は null です。 ig.InvalidOperationException topLeftCornerCell または bottomRightCornerCell は null です。 -
add
- .add( shapeType:ig.excel.PredefinedShapeType, boundsInTwips:object );
- 返却型:
- ig.excel.WorksheetShape
- 返却型の説明:
- 定義済みの図形を表す、WorksheetShape から派生したインスタンス。
定義済みの形状を、指定した境界線を持つコレクションに追加します。
- shapeType
- タイプ:ig.excel.PredefinedShapeType
- コレクションに追加する形状のタイプ。
- boundsInTwips
- タイプ:object
- トゥイップ (ポイントの 1/20) 単位の、 ワークシートの形状の境界。 数値を持つ 'x'、'y'、'width'、および 'height'、または 'left'、'top'、'right'、および 'bottom' プロパティがあるオブジェクトです。例: { x: 1, y: 2, width: 100, height: 200 }。
例外
例外 説明 ig.InvalidOperationException topLeftCornerCell または bottomRightCornerCell は null です。 ig.excel.InvalidEnumArgumentException shapeType が PredefinedShapeType 列挙体で定義されていないです。 -
add
- .add( shape:ig.excel.WorksheetShape );
定義済みの形状を、指定した境界線を持つコレクションに追加します。
- shape
- タイプ:ig.excel.WorksheetShape
- コレクションに追加する形状。
例外
例外 説明 ig.ArgumentNullException ワークシートは null です。 ig.InvalidOperationException topLeftCornerCell または bottomRightCornerCell は null です。 ig.InvalidOperationException topLeftCornerCell または bottomRightCornerCell は null です。 ig.InvalidOperationException topLeftCornerCell または bottomRightCornerCell は null です。 ig.InvalidOperationException topLeftCornerCell または bottomRightCornerCell は null です。 -
clear
- .clear( );
このコレクションからすべての形状をクリアします。
-
contains
- .contains( shape:ig.excel.WorksheetShape );
- 返却型:
- boolean
- 返却型の説明:
- 形状が見つかった場合は True、そうでなければ False。
形状がコレクションにあるかどうかを決定します。
- shape
- タイプ:ig.excel.WorksheetShape
- このコレクションで見つけ出す形状。
-
count
- .count( );
- 返却型:
- number
- 返却型の説明:
- このコレクション内の形状の数。
このコレクション内の形状の数を取得します。
-
item
- .item( index:number );
- 返却型:
- ig.excel.WorksheetShape
- 返却型の説明:
- 指定されたインデックスにある形状。
指定したインデックスにある、コレクション内の形状を取得します。
- index
- タイプ:number
- 取得する形状の 0 から始まるインデックス。
例外
例外 説明 ig.ArgumentOutOfRangeException インデックスは 0 未満であるか、または、インデックスが WorksheetShapeCollection.count 以上です。 -
remove
- .remove( shape:ig.excel.WorksheetShape );
- 返却型:
- boolean
- 返却型の説明:
- 形状がコレクションから問題なく削除された場合は True、形状がコレクションに存在しなかった場合は False。
指定した形状をコレクションから削除します。
- shape
- タイプ:ig.excel.WorksheetShape
- コレクションから削除する形状。
-
removeAt
- .removeAt( index:number );
指定したインデックスにある形状をコレクションから削除します。
- index
- タイプ:number
- コレクションから削除する形状のインデックス。
例外
例外 説明 ig.ArgumentOutOfRangeException インデックスは 0 未満であるか、または、インデックスが WorksheetShapeCollection.count 以上です。