バージョン

WinPivotGrid アクション

トピックの概要

目的

このトピックでは、対応するサブ項目および動作を表示するための UltraPivotGridTestObject オブジェクトを使用し、WinPivotGrid™ コントロール プロキシ内での記録および再生アクションについての概要を提供します。

識別ドロップ項目

インデックス モード

以下のプレビューは、インデックスモードを簡単に識別できるようの整数として表示します。ただし、ヘッダーは主要ヘッダーにのみ識別できます (セルに隣接するヘッダーなど)。

WinPivotGrid Actions 1.png

座標系インデックス モード

座標系を使用するインデックスモードは 0 から始まる 2 次元配列に構成される。

最初のインデックスはヘッダーの行です。

2 番目のインデックスはヘッダーの列です。

列は行および列にまたがり、様々な座標の組み合わせによって 1 つのヘッダーを返すことが可能です。以下の画像にある色付き要素 (縁付き) の座標を参照してください。

  • 淡い青色の環境を持つリセラーの輸送は ARRAY(4,1) で示されます。

  • 淡い緑色環境を持つ CY 2001 は次の ARRAY(3,1)、ARRAY (3,2) また ARRAY(3,3) の配列で示されます。

WinPivotGrid Actions 2.png

文字列モード

文字列モードは文字列の配列で、パスを示します。列の場合、パスはトップ行から下へ示されます。行の場合、左の列から右へ示されます。複製文字列値は同じ親に属する場合もあります。その場合、記録の時、複製文字列値に0から始まるインデックス識別が含まれます。ほとんどの場合、それは集計行または列に示されます。

たとえば、リセラーの輸送費用は上記のようになります。

ARRAY(”すべての製品”、”アクセサリー”、すべての製品、”リセラー”の輸送費用)

Note

注: ”すべての製品”および”リセラー輸送費用” は反復しても、それは同じ親下で反復されないため識別子は不要です。

淡い緑の色の環境を持つ CY 2001 は ARRAY(“すべての期間”, “CY 2001#1”) として識別されます。それは、CY 2001 は 2 番目のそのテキストを持つ子だからです。

WinPivotGrid アクション

概要

WinPivotGrid 要素は様々なアクションに対してユーザー入力にトリガーされるサブ項目に識別されます。このセクションでは、記録されたスクリプトの例を持つアクションおよび動作についての詳細な情報を提供しています。

Note

注: このトピックで ”DropItem” はデータ セレクターの環境またメジャーリストからピボット グリッドにドロップされたおよびピボット グリッドから削除された項目という意味で使用されている。

ActivateCell

説明

識別されたピボット セルを有効にします。

パラメーター

以下の表はコード例に続いてメソッド変数を説明します。

パラメーター 説明

oRowArg oColumnArg

整数のインデックス、テキストパスの文字列配列、整数の行の 2 次元配列、適切なヘッダーの場所を示す列の位置も含まれます。

以下の 3 つコード例は同じセルを有効にします。

SwfTable("Identifier").ActivateCell 0,0
SwfTable("Identifier").ActivateCell ARRAY(0, 3), ARRAY(3,0)
SwfTable("Identifier").ActivateCell ARRAY(“All Periods”, “CY 2001”, “H2 CY 2001”, “Q3 CY 2001”), ARRAY(“All Products”, “Accessories”, “All Products”, Reseller Sales Amount”)

発生する可能性がある例外

以下の表は、このメソッドで発生する可能性のある例外またはその原因について示します。

  • 指定した {0} インデックス [{1}] が範囲外です。

  • 次の {0} [{1}] は見つかりませんでした。

SortColumn

説明

識別された列を並べ替えます。

パラメーター

以下の表はコード例に続いてメソッド変数を説明します。

パラメーター 説明

oColumnArg

整数のインデックス、テキストパスの文字列配列、整数の行の 2 次元配列、適切なヘッダーの場所を示す列の位置も含まれます。

oeSortDirection

PvtGSortDirection 列挙体で並べ替え方向を表示する列挙値、文字列名前また整数値が含まれます。

[オプショナル]bExtend

並べ替えが拡張される場合、ブール値が含まれます。

以下の 3 つコード例は同じセルを有効にします。

SwfTable("Identifier").SortColumn 0, pvtgAscending
SwfTable("Identifier").SortColumn ARRAY(0, 3), pvtgDescending
SwfTable("Identifier").SortColumn ARRAY(“All Products”, “Accessories”, “All Products”, Reseller Sales Amount”), pvtgAscending

発生する可能性がある例外

以下の表は、このメソッドで発生する可能性のある例外またはその原因について示します。

  • 指定の {0} インデックスの [{1}] が範囲外です。

  • 以下の {0} [{1}] は見つかりません。

  • 並べ替えは無効になります。

  • 操作を実行するために必要なポイントは表示されていません。

  • 指定の [oeSortDirection] は無効です。

SelectHeader

説明

識別された行または列を選択します。

パラメーター

以下の表はコード例に続いてメソッド変数を説明します。

パラメーター 説明

oeHeaderType

PvtGSortDirection列挙体で並べ替え方向を表示する列挙値、文字列名前また整数値が含まれます。

oHeaderArg

整数のインデックス、テキストパスの文字列配列、整数の行の 2 次元配列、適切なヘッダーの場所を示す列の位置も含まれます。

[オプショナル]bShift

シフトキーが押されている場合、ブール値が含まれます。

[オプショナル]bCtrl

シフトキーを押している場合、ブール値が含まれます。

最初の行を選択します。

SwfTable("Identifier").SelectHeader pvtgHeaderRow, 0

すべての期間、CY 2003、H2 CY 2003を行のヘッダーに選択します。

SwfTable("Identifier"). SelectHeader pvtgHeaderRow, ARRAY(“All Periods”, “CY 2003”, “H2 CY 2003”), true

選択に列のヘッダーを追加します。

SwfTable("Identifier"). SelectHeader pvtgHeaderColumn, 2, false, true

発生する可能性がある例外

以下の表は、このメソッドで発生する可能性のある例外またはその原因について示します。

  • 提供されたオプションは無効なオプションです。有効なオプションは [pvtgHeaderRow, pvtgHeaderColumn] です。

  • 指定した {0} インデックス [{1}] は範囲外です。次の {0} [{1}] は見つかりませんでした。

  • 項目タイプ [{0}] の選択は有効化されていません。

  • 複数のタイプに及ぶスパン選択は実行できません。

SelectCell

説明

指定されたセルを選択します。

パラメーター

以下の表はコード例に続いてメソッド変数を説明します。

パラメーター 説明

oRowArg oColumnArg

整数のインデックス、テキストパスの文字列配列、整数の行の2次元配列、適切なヘッダーの場所を示す列の位置も含まれます。

[オプショナル]bShift

シフトキーが押されている場合、ブール値が含まれます。

[オプショナル]bCtrl

シフトキーを押している場合、ブール値が含まれます。

最初の行を選択します。

SwfTable("Identifier").SelectHeader pvtgHeaderRow, 0

すべての期間、CY 2003、H2 CY 2003を行のヘッダーに選択します。

SwfTable("Identifier"). SelectHeader pvtgHeaderRow, ARRAY(“All Periods”, “CY 2003”, “H2 CY 2003”), true

選択に列のヘッダーを追加します。

SwfTable("Identifier"). SelectHeader pvtgHeaderColumn, 2, false, true

発生する可能性がある例外

以下の表は、このメソッドで発生する可能性のある例外またはその原因について示します。

  • 提供されたオプションは無効なオプションです。有効なオプションは[pvtgHeaderRow, pvtgHeaderColumn] のみです。

  • 指定した {0} インデックス[{1}] が範囲外です。

  • 以下の {0} [{1}] は見つかりません。

  • 項目タイプ [{0}] の選択は有効化されていません。

  • 複数のタイプに及ぶスパン選択は実行できません。

ExpandHeader

説明

識別されたヘッダーを展開します。

パラメーター

以下の表はコード例に続いてメソッド変数を説明します。

パラメーター 説明

oeHeaderType

PvtGSortDirection 列挙体で並べ替え方向を表示する列挙値、文字列名前また整数値が含まれます。

oHeaderArg

整数のインデックス、テキストパスの文字列配列、整数の行の2次元配列、適切なヘッダーの場所を示す列の位置も含まれます。

アクティブ行を展開します。

SwfTable("Identifier").ExpandHeader pvtgHeaderRow, 0

行ヘッダー、すべての期間、CY 2001、 H2 CY 2001 および Q3 CY 2001 を展開します。

SwfTable("Identifier"). ExpandHeader pvtgHeaderRow, ARRAY(“All Periods”, “CY 2001”, “H2 CY2001”, “Q3 CY 2001”)

発生する可能性がある例外

以下の表はこのメソッドの可能性のある例外またはその原因について示します。

  • 提供されたオプションは無効なオプションです。有効なオプションは [pvtgHeaderRow, pvtgHeaderColumn] のみです。

  • 指定した {0} インデックス [{1}] が範囲外です。

  • 次の {0} [{1}] は見つかりませんでした。

  • 指定のヘッダーは展開できません。

CollapseHeader

説明

識別されたヘッダーを展開します。

パラメーター

以下の表はコード例に続いてメソッド変数を説明します。

パラメーター 説明

oeHeaderType

PvtGSortDirection 列挙体で並べ替え方向を表示する列挙値、文字列名前また整数値が含まれます。

oHeaderArg

整数のインデックス、テキストパスの文字列配列、整数の行の2次元配列、適切なヘッダーの場所を示す列の位置も含まれます。

行0、列2の行ヘッダーを展開します。

SwfTable("Identifier").CollapseHeader pvtgHeaderRow, ARRAY(0, 2)

行ヘッダー、すべての期間、CY 2001、 H2 CY 2001および Q3 CY 2001 を展開します。

SwfTable("Identifier"). CollapseHeader pvtgHeaderRow, ARRAY(“All Periods”, “CY 2001”, “H2 CY 2001”)

発生する可能性がある例外

以下の表は、このメソッドで発生する可能性のある例外またはその原因について示します。

  • 指定のオプションは有効なオプションではありません。有効なオプションは [{0}]

  • 指定した {0} インデックス [{1}] が範囲外です。

  • 次の {0} [{1}] は見つかりませんでした。

  • 指定のヘッダーは縮小できません。

ResizeHeader

説明

識別されたヘッダーを展開します。

パラメーター

以下の表はコード例に続いてメソッド変数を説明します。

パラメーター 説明

oeHeaderType

PvtGSortDirection 列挙体で並べ替え方向を表示する列挙値、文字列名前また整数値が含まれます。

oHeaderArg

整数のインデックス、テキストパスの文字列配列、整数の行の2次元配列、適切なヘッダーの場所を示す列の位置も含まれます。

[オプショナル]oiNewSize

oiNewSize にサイズを指定していない場合、幅は自動的にサイズ設定されます。サイズを指定した場合、ヘッダーに適用されます。

Note

注:現在の実装 (14.1) に列のサイズを変更できません。行ヘッダー サイズのみ変更できます。

2 番目の列を自動サイズ変更します。

SwfTable("Identifier").ExpandHeader pvtgHeaderColumn, 1

行ヘッダー、すべての期間、CY 2001、 H2 CY 2001 および Q3 CY 2001 を展開します。

SwfTable("Identifier"). ExpandHeader pvtgHeaderColumn, ARRAY(“All Periods”, “CY 2001”, “H2 CY2001”, “Q3 CY 2001”), 200

発生する可能性がある例外

以下の表は、このメソッドで発生する可能性のある例外またはその原因について示します。

  • 指定のオプションは有効なオプションではありません。有効なオプションは [{0}]

  • 指定の {0} インデックスの [{1}] が範囲外です。

  • 次の {0} [{1}] は見つかりませんでした。

  • 指定のヘッダーはサイズ変更できません。

RemoveDropItem

説明

クリックし、DropItem を PivotGrid DropItemArea から削除します。

パラメーター

以下の表はコード例に続いてメソッド変数を説明します。

パラメーター 説明

oeDropItemArea

PvtGSortDirection 列挙体で並べ替え方向を表示する列挙値、文字列名前また整数値が含まれます。

oDropItemArg

DropItem の整数インデックス、文字列 Key また、文字列の表示されるテキストが含まれます。

DropItem を削除します。

SwfTable("Identifier").RemoveDropItem pvtgColumnArea, “Category”

DropItem の最初の測定値を削除します。

SwfTable("Identifier"). RemoveDropItem pvtgMeasureArea, 0

発生する可能性がある例外

以下は、このメソッドの発生する可能性のある唯一の例外またその原因について示します。

指定のオプションは有効なオプションではありません。有効なオプションは [{0}]

DropdownDropItemFilter

説明

識別された DropItem のフィルターをドロップダウンします。

パラメーター

以下の表はコード例に続いてメソッド変数を説明します。

パラメーター 説明

oeDropItemArea

PvtGSortDirection 列挙体で並べ替え方向を表示する列挙値、文字列名前また整数値が含まれます。

oDropItemArg

DropItem の整数インデックス、文字列 Key また、文字列の表示されるテキストが含まれます。

Column DropItem のカテゴリーをドロップダウンします。

SwfTable("Identifier").DropdownDropItemFilter pvtgColumnArea, “Category”

DropItem のフィルターをドロップダウンします。

SwfTable("Identifier"). DropdownDropItemFilter pvtgMeasureArea, 0

発生する可能性がある例外

以下の表は、このメソッドで発生する可能性のある例外またはその原因について示します。

  • 指定のオプションは有効なオプションではありません。有効なオプションは [{0}]

  • [{1}] ではフィルター機能は有効化されていません。

CloseupDropItemFilter

説明

識別された DropItem のフィルターを閉じます。

パラメーター

以下の表はコード例に続いてメソッド変数を説明します。

パラメーター 説明

oeDropItemArea

PvtGDropItemArea 列挙体で並べ替え方向を表示する列挙値、文字列名前また整数値が含まれます。

oDropItemArg

DropItem の整数インデックス、文字列 Key また、文字列の表示されるテキストが含まれます。

Column DropItem のカテゴリーを閉じます。

SwfTable("Identifier").DropdownDropItemFilter pvtgColumnArea, “Category”

最初の測定値の DropItem のフィルターを閉じます。

SwfTable("Identifier").DropdownDropItemFilter pvtgMeasureArea, 0

発生する可能性がある例外

以下の表は、このメソッドで発生する可能性のある例外またはその原因について示します。

  • 指定のオプションは有効なオプションではありません。有効なオプションは [{0}]

  • [oDropItemArg]にフィルタリングは無効になります。

DragSubItem

説明

マウスを下へ移動し、左マウスボタンを長押ししながらカーソルを動かすことにより、指定されたサブ項目上でドラッグ操作を開始します。

Note

注:アクションを正しく実行するために、ドラッグの後にドロップアクションが必要です。(記録方法を参照してください)

Note

さらに、 WinPivotGrid の基本実装はグリッドに要素をドラッグすることを無効にします。この目的は DataSelector からグリッドへドラッグすることを有効することです。

記録方法:

マウスをサブ項目 (DataSelectorから) の上に移動し、ボタンを押し、グリッドへドラックアクションを開始します。

パラメーター

以下の表はコード例に続いてメソッド変数を説明します。

パラメーター 説明

oeSubItemType

PvtGSubItemType 列挙体で並べ替え方向を表示する列挙値、文字列名前また整数値が含まれます。

oSubItem

定義されたタイプのサブ項目を表示する単一の値:

  • oRowArg\oColumnArgと似ている行/列のヘッダー

  • セル、oRowArgおよびoColumnArgに構成された配列

  • DropAreaはPvtGDropItemArea列挙値です。

  • DropAreaItem は列挙値 PvtGDropItemArea および DropItemArg に構成された値です。

[オプショナル]oeRegion

QTPRectRegion 列挙体および PvtGSubItemType によって相対的なマウスの位置を定義する列挙値、文字列名前また、整数値が含まれています。

[オプショナル]oInt1, oInt2

相対的マウス位置を定義する整数値オフセットを表示します。oeRegionパラメーターに基づきます。

発生する可能性がある例外

以下の表は、このメソッドで発生する可能性のある例外またはその原因について示します。

  • オプション [{oRegion}] は有効なオプションではありません。

  • オプション [{oeSubItemType}] は有効なオプションではありません。

  • 以下の項目 {eSubItemType} [{oSubItem}] は見つかりません。

  • {oSubItem} は表示されていません。

DropOnSubItem

説明

カーソルをサブ項目上へ移動し、左マウスボタンを放すことで指定されたサブ項目上へのラッグ操作を終了します。

Note

注:ドロップ操作が正常に終了するには、ドラッグ操作が正常に開始されている必要があります。(記録方法: を参照してください)

記録方法:

ドラッグ操作を開始してから、カーソルを DataSelector のツリーノード構造の上に移動し、マウス ボタンを放します。

パラメーター

以下の表はコード例に続いてメソッド変数を説明します。

パラメーター 説明

oeSubItemType

PvtGSubItemType 列挙体で並べ替え方向を表示する列挙値、文字列名前また整数値が含まれます。

oSubItem

定義されたタイプのサブ項目を表示する単一の値:

  • oRowArg\oColumnArg と似ている行/列のヘッダー

  • セル、oRowArgおよびoColumnArg に構成された配列

  • DropArea は PvtGDropItemArea 列挙値です。

DropAreaItem は列挙値 PvtGDropItemArea および DropItemArg に構成された値です。

[オプショナル]oeRegion

QTPRectRegion 列挙体および PvtGSubItemType によって相対的なマウスの位置を定義する列挙値、文字列名前また、整数値が含まれています。

[オプショナル]oInt1, oInt2

相対的マウス位置を定義する整数値オフセットを表示します。oeRegionパラメーターに基づきます。

発生する可能性がある例外

以下の表は、このメソッドで発生する可能性のある例外またはその原因について示します。

  • オプション [{oRegion}] は有効なオプションではありません。

  • オプション [{oeSubItemType}] は有効なオプションではありません。

  • 以下の項目 {eSubItemType} [{oSubItem}] は見つかりません。

  • {oSubItem} は表示されていません。

DropOnControl

説明

カーサをサブ項目上へ移動し、左マウスボタンを放すことで指定されたサブ項目上へのラッグ操作を終了します。

Note

注:ドロップ操作が正常に終了するためには、ドラッグ操作が正常に開始されている必要があります。(記録方法を参照してください)

記録方法:

ドラッグ操作を開始してから、カーソルを DataSelector のツリーノード構造の上に移動し、マウス ボタンを放します。

パラメーター

以下の表はコード例に続いてメソッド変数を説明します。

パラメーター 説明

[オプショナル]oeRegion

QTPRectRegion 列挙体および PvtGSubItemType によって相対的なマウスの位置を定義する列挙値、文字列名前また、整数値が含まれています。

[オプショナル]oInt1, oInt2

相対的マウス位置を定義する整数値オフセットを表示します。oeRegion パラメーターに基づきます。

発生する可能性がある例外

以下はこのメソッドの唯一の例外またそれを起こした可能性のある原因を示します。

オプション [{oRegion}] は有効なオプションではありません。

ScrollDropArea

説明

提供された方向にドロップ領域をスクロールします。

パラメーター

以下の表はコード例に続いてメソッド変数を説明します。

パラメーター 説明

oeDropItemArea

PvtGSortDirection 列挙体で並べ替え方向を表示する列挙値、文字列名前また整数値が含まれます。

oeScrollDirection

QTPScrollDirection 列挙体で並べ替え方向を表示する列挙値、文字列名前また整数値が含まれます。

発生する可能性がある例外

以下の表は、このメソッドで発生する可能性のある例外またはその原因について示します。

  • 指定のオプションは有効なオプションではありません。有効なオプションは [{0}]

  • 指定のオプションは有効なオプションではありません。有効なオプションは [micScrollLeftOrUp, micScrollRightOrDown]。

WinPivotGrid 再生専用アクション

GetRowPathOfActiveCell

説明

アクティブセルの行パスの区切り文字列を返します。

GetColumnPathOfActiveCell

アクティブセルの列パスの区切り文字列を返します。

GetCellData

セルの値を返します。

パラメーター

以下の表はコード例に続いてメソッド変数を説明します。

パラメーター 説明

oRowArg oColumnArg

整数のインデックス、テキストパスの文字列配列、整数の行の2次元配列、適切なヘッダーの場所を示す列の位置も含まれます。

発生する可能性がある例外

以下の表は、このメソッドで発生する可能性のある例外またはその原因について示します。

  • 指定のオプションは有効なオプションではありません。有効なオプションは [pvtgHeaderRow, pvtgHeaderColumn]

  • 指定の {0} インデックスの [{1}] が範囲外です。

  • 次の {0} [{1}] は見つかりませんでした。

GetCellFormattedData

説明

セルの値を返します。

パラメーター

以下の表はコード例に続いてメソッド変数を説明します。

パラメーター 説明

oRowArg oColumnArg

整数のインデックス、テキストパスの文字列配列、整数の行の2次元配列、適切なヘッダーの場所を示す列の位置も含まれます。

発生する可能性がある例外

以下の表は、このメソッドで発生する可能性のある例外またはその原因について示します。

  • 指定のオプションは有効なオプションではありません。有効なオプションは [pvtgHeaderRow, pvtgHeaderColumn]

  • 指定の {0} インデックスの [{1}] が範囲外です。

  • 次の {0} [{1}] は見つかりませんでした。

GetColumnCount

説明

列数を返します。

GetRowCount

行数を返します。

GetItemsInDropArea

DropArea のドロップ項目を取得します。

パラメーター

以下の表はコード例に続いてメソッド変数を説明します。

パラメーター 説明

oeDropItemArea

PvtGSortDirection 列挙体で並べ替え方向を表示する列挙値、文字列名前また整数値が含まれます。

発生する可能性がある例外

以下はこのメソッドの唯一の例外またそれを起こした可能性のある原因を示します。

指定のオプションは有効なオプションではありません。有効なオプションは [{0}]

関連コンテンツ

トピック

このトピックの追加情報については、以下のトピックも合わせてご参照ください。

トピック 目的

このトピックでは、ユーザーの操作による実行される WinPivotGrid コントロールのアクションについての情報を提供します。

このトピックでは、 WinPivotGrid コントロールをテストするための一般的な列挙体に関する参照情報を提供します。