Ignite UI™ API ヘルプ

ig.excel.WorksheetShape

ワークシートのすべての形状（アトミックまたは複合）の抽象基本クラス。

備考

アトミック形状は、画像、ポリゴン、またはテキストなどの単一の形状エンティティです。複合形状は形状のグループで、WorksheetShapeGroup インスタンスによって表されます。

現在、すべての形状情報（形状の回転など）はカスタマイズできません。ただし、往復させる目的のため、形状は Excel ファイルから読み込むと、この情報は形状で保持されます。サポートされていないデータについての詳細は、WorksheetShape.clearUnknownData を参照してください。

依存関係

jquery-1.4.4.js

infragistics.util.js

infragistics.ext_core.js

infragistics.ext_collections.js

infragistics.ext_collectionsExtended.js

infragistics.ext_io.js

infragistics.ext_text.js

infragistics.documents.core_core.js

infragistics.ext_ui.js

詳細の表示

bottomRightCornerCell

.bottomRightCornerCell( );
返却型:: ig.excel.WorksheetCell
返却型の説明:: 形状の右下角の置かれるセル。

形状の右下角の置かれるセルを取得します。

例外

例外	説明
ig.ArgumentException	指定した値は、ワークシートがこの形状のワークシートと同じではないセルです。
ig.ArgumentNullException	指定した値は null で、この形状はすでにワークシートまたはグループに存在します。

備考

このアンカーセルは、WorksheetShape.topLeftCornerCell と共に、形状がワークシートに配置される場所を決定します。さらに、WorksheetShape.bottomRightCornerPosition および WorksheetShape.topLeftCornerPosition プロパティによって、形状の位置の詳細な制御ができます。

bottomRightCornerCell

.bottomRightCornerCell( value:ig.excel.WorksheetCell );
返却型:: ig.excel.WorksheetCell
返却型の説明:: 形状の右下角の置かれるセル。

形状の右下角の置かれるセルを取得します。

value
タイプ:ig.excel.WorksheetCell

例外

例外	説明
ig.ArgumentException	指定した値は、ワークシートがこの形状のワークシートと同じではないセルです。
ig.ArgumentNullException	指定した値は null で、この形状はすでにワークシートまたはグループに存在します。

備考

bottomRightCornerPosition

.bottomRightCornerPosition( );
返却型:: object
返却型の説明:: 形状の右下角の右下角セルの位置。これは、'x' および 'y' プロパティで数値があるオブジェクトです。

パーセントで表される、形状の右下隅の WorksheetShape.bottomRightCornerCell での位置。

例外

例外	説明
ig.ArgumentOutOfRangeException	指定した値の座標は 0.0 から 100.0 の範囲の外です。

備考

これらのパーセントは、セルの左上角から開始するセルの関連する寸法の距離として表されます。たとえば、(0.0, 0.0) はセルの左上角を表し、(100.0, 100.0) はセルの右下角を表します。(50.0, 10.0) は、水平方向にセンタリングされ、上から 10% 下に移動されたセルの位置を表します。

bottomRightCornerPosition

.bottomRightCornerPosition( value:object );
返却型:: object
返却型の説明:: 形状の右下角の右下角セルの位置。これは、'x' および 'y' プロパティで数値があるオブジェクトです。

パーセントで表される、形状の右下隅の WorksheetShape.bottomRightCornerCell での位置。

value
タイプ:object
これは、'x' および 'y' プロパティで数値があるオブジェクトです。例: { x: 1, y: 2 }。

例外

例外	説明
ig.ArgumentOutOfRangeException	指定した値の座標は 0.0 から 100.0 の範囲の外です。

備考

clearUnknownData

.clearUnknownData( );

解析された Excel ファイルからのリードインであったキャッシュされた不明な形状データをクリアします。

例外

例外	説明
ig.InvalidOperationException	このメソッドは、UnknownShape インスタンスで呼び出されます。

備考

このメソッドは、すべての形状情報がサポートされカスタマイズ可能であるまで必要になるだけです。すべての形状データが制御可能となった後、このメソッドは不要になります。現在、すべてのサポートされていないデータは、往復の目的のために形状で保存されます。たとえば、複雑でサポートされていない形状を持つ Excel ファイルが Workbook インスタンスに読み込みされると、一部のセル値は変更され、同じファイルに保存され、複雑な形状はワークブックに存在します。ただし、保存される前に読み込みされた形状が変更される必要がある場合、このメソッドによって、すべてのサポートされるデータを保持しながら、サポートされていないデータを削除できます。

注: このメソッドはサポートされていないデータのみをクリアします。製品の将来のバージョンでは、より多くの形状データがサポートされ、このメソッドは形状に異なる影響を及ぼし、最終的にすべてのデータがサポートされ、このメソッドは形状に影響を持たなくなります。

createPredefinedShape

.createPredefinedShape( shapeType:ig.excel.PredefinedShapeType );
返却型:: ig.excel.WorksheetShape
返却型の説明:: 定義済みの図形を表す、WorksheetShape から派生したインスタンス。

Microsoft Excel で定義済みの図形を作成します。

shapeType
タイプ:ig.excel.PredefinedShapeType
作成する図形のタイプ。

例外

例外	説明
ig.excel.InvalidEnumArgumentException	shapeType が PredefinedShapeType 列挙体で定義されていないです。

flippedHorizontally

.flippedHorizontally( );

図形が垂直方向の中央線に沿って水平に反転しているかどうかを示す値を取得または設定します。

例外

例外	説明
ig.InvalidOperationException	値は True に設定され、WorksheetChart のように、この図形は反転または回転を許可しません。

flippedHorizontally

.flippedHorizontally( value:boolean );

図形が垂直方向の中央線に沿って水平に反転しているかどうかを示す値を取得または設定します。

value
タイプ:boolean

例外

例外	説明
ig.InvalidOperationException	値は True に設定され、WorksheetChart のように、この図形は反転または回転を許可しません。

flippedVertically

.flippedVertically( );

図形が水平方向の中央線に沿って垂直に反転しているかどうかを示す値を取得します。

例外

例外	説明
ig.InvalidOperationException	値は True に設定され、WorksheetChart のように、この図形は反転または回転を許可しません。

flippedVertically

.flippedVertically( value:boolean );

図形が水平方向の中央線に沿って垂直に反転しているかどうかを示す値を取得します。

value
タイプ:boolean

例外

例外	説明
ig.InvalidOperationException	値は True に設定され、WorksheetChart のように、この図形は反転または回転を許可しません。

getBoundsInTwips

.getBoundsInTwips( );
返却型:: object
返却型の説明:: ワークシートの形状の境界。数値を持つ 'x'、'y'、'width'、'height'、'left'、'top'、'right'、および 'bottom' プロパティがあるオブジェクトです。

形状の境界を{\f9 トゥイップで取得します（ポイントの 1/20）。

例外

例外	説明
ig.InvalidOperationException	WorksheetShape.topLeftCornerCell または WorksheetShape.bottomRightCornerCell は null で、この場合は形状には境界がありません。

備考

このメソッドによって返される境界は、ワークシートの現在の構成に限って有効です。形状の前または形状内の行または列のサイズが変更されると、これらの境界は形状の位置を反映しません。

getBoundsInTwips

.getBoundsInTwips( options:ig.excel.PositioningOptions );
返却型:: object
返却型の説明:: ワークシートの形状の境界。数値を持つ 'x'、'y'、'width'、'height'、'left'、'top'、'right'、および 'bottom' プロパティがあるオブジェクトです。

形状の境界を{\f9 トゥイップで取得します（ポイントの 1/20）。

options
タイプ:ig.excel.PositioningOptions
図形の境界線を取得するときに使用するオプション。

例外

例外	説明
ig.InvalidOperationException	WorksheetShape.topLeftCornerCell または WorksheetShape.bottomRightCornerCell は null で、この場合は形状には境界がありません。

備考

positioningMode

.positioningMode( );
返却型:: ig.excel.ShapePositioningMode
返却型の説明:: 形状の前または形状内のセルのサイズが変更される時に Excel で形状が再配置される方法。

形状の前または形状内のセルのサイズが変更される時に Excel で形状が再配置される方法を取得します。

例外

例外	説明
ig.excel.InvalidEnumArgumentException	指定された値は、ShapePositioningMode 列挙体で定義されません。

備考

この値は WorksheetShapeGroup に含まれる形状のために保存されず、親グループからの配置モードを継承します。

positioningMode

.positioningMode( value:ig.excel.ShapePositioningMode );
返却型:: ig.excel.ShapePositioningMode
返却型の説明:: 形状の前または形状内のセルのサイズが変更される時に Excel で形状が再配置される方法。

形状の前または形状内のセルのサイズが変更される時に Excel で形状が再配置される方法を取得します。

value
タイプ:ig.excel.ShapePositioningMode

例外

例外	説明
ig.excel.InvalidEnumArgumentException	指定された値は、ShapePositioningMode 列挙体で定義されません。

備考

この値は WorksheetShapeGroup に含まれる形状のために保存されず、親グループからの配置モードを継承します。

setBoundsInTwips

.setBoundsInTwips( sheet:ig.excel.Sheet, bounds:object );

形状の境界をトゥイップで設定します（ポイントの　1/20）。

sheet
タイプ:ig.excel.Sheet
bounds
タイプ:object
形状が配置される新しい境界。数値を持つ 'x'、'y'、'width'、および 'height'、または 'left'、'top'、'right'、および 'bottom' プロパティがあるオブジェクトです。例: { x: 1, y: 2, width: 100, height: 200 }。

例外

例外	説明
ig.ArgumentNullException	ワークシートは null です。

備考

形状は指定した境界に限って配置され、ワークシートは現在の構成で維持されます。図形の WorksheetShape.positioningMode に基づいて、形状の行または列のサイズが変更される場合、境界線を変更する可能性があります。

setBoundsInTwips

.setBoundsInTwips( sheet:ig.excel.Sheet, bounds:object, options:ig.excel.PositioningOptions );

形状の境界をトゥイップで設定します（ポイントの　1/20）。

sheet
タイプ:ig.excel.Sheet
bounds
タイプ:object
形状が配置される新しい境界。数値を持つ 'x'、'y'、'width'、および 'height'、または 'left'、'top'、'right'、および 'bottom' プロパティがあるオブジェクトです。例: { x: 1, y: 2, width: 100, height: 200 }。
options
タイプ:ig.excel.PositioningOptions
図形の境界線を設定するときに使用するオプション。

例外

例外	説明
ig.ArgumentNullException	ワークシートは null です。

備考

topLeftCornerCell

.topLeftCornerCell( );
返却型:: ig.excel.WorksheetCell
返却型の説明:: 形状の左上角の置かれるセル。

形状の左上角の置かれるセルを取得します。

例外

例外	説明
ig.ArgumentException	指定した値は、ワークシートがこの形状のワークシートと同じではないセルです。
ig.ArgumentNullException	指定した値は null で、この形状はすでにワークシートまたはグループに存在します。

備考

このアンカーセルは、WorksheetShape.bottomRightCornerCell と共に、形状がワークシートに配置される場所を決定します。さらに、WorksheetShape.bottomRightCornerPosition および WorksheetShape.topLeftCornerPosition プロパティによって、形状の位置の詳細な制御ができます。

topLeftCornerCell

.topLeftCornerCell( value:ig.excel.WorksheetCell );
返却型:: ig.excel.WorksheetCell
返却型の説明:: 形状の左上角の置かれるセル。

形状の左上角の置かれるセルを取得します。

value
タイプ:ig.excel.WorksheetCell

例外

例外	説明
ig.ArgumentException	指定した値は、ワークシートがこの形状のワークシートと同じではないセルです。
ig.ArgumentNullException	指定した値は null で、この形状はすでにワークシートまたはグループに存在します。

備考

topLeftCornerPosition

.topLeftCornerPosition( );
返却型:: object
返却型の説明:: 形状の左上角の左上角セルの位置。これは、'x' および 'y' プロパティで数値があるオブジェクトです。

パーセントで表される、形状の右下隅の WorksheetShape.topLeftCornerCell での位置。

例外

例外	説明
ig.ArgumentOutOfRangeException	指定した値の座標は 0.0 から 100.0 の範囲の外です。

備考

topLeftCornerPosition

.topLeftCornerPosition( value:object );
返却型:: object
返却型の説明:: 形状の左上角の左上角セルの位置。これは、'x' および 'y' プロパティで数値があるオブジェクトです。

パーセントで表される、形状の右下隅の WorksheetShape.topLeftCornerCell での位置。

value
タイプ:object
これは、'x' および 'y' プロパティで数値があるオブジェクトです。例: { x: 1, y: 2 }。

例外

例外	説明
ig.ArgumentOutOfRangeException	指定した値の座標は 0.0 から 100.0 の範囲の外です。

Ignite UI for jQuery | API リファレンス

ig.excel.WorksheetShape

備考

依存関係