Forguncy

ListView クラス

リストビューオブジェクトを表します。

階層

ListView

メソッド

addNewRow

addNewRow(rowValues: {} | any[], isText?: boolean): void

リストビューに新しい行を追加します。

使用例

// 本サンプルコードでは、リストビューに列が3つ存在する場合の例を示します。
// 最初の列の列名は「Name」です。
// 2列目の列名は「Birthday」です
// 3列目の列名は「Department」で、テンプレート行のセル型はコンボボックスです。値は[1, 2, 3]、表示テキスト値は["DD1", "DD2", "DD3"]です。
// 現在のページを取得する。
var page = Forguncy.Page;
// リストビューオブジェクトを取得する。
var listview = page.getListView("リストビュー1");
// 次の3つは、すべて同じ内容の行を追加するコードです。
listview.addNewRow({"Name":"Lily","Birthday":new Date(1990,1,3),"Department":1});
listview.addNewRow(["Lily",new Date(1990,1,3),1]);
listview.addNewRow({"Name":"Lily","Birthday":"1990/02/03","Department":"DD1"}, true);

引数

rowValues: {} | any[]

追加する新しい行のデータ。
オプション isText: boolean

rowValues内のデータに表示テキストが含まれている場合には、本パラメーターをtrueにします。trueの場合、新しい行のデータが追加される前に表示テキストのデータが値に変換されます。既定値はfalseです。本パラメーターは省略可能です。

戻り値 void

addSelectedRow

addSelectedRow(rowIndex: number): void

指定したリストビューの行を選択状態にします。リストビューが複数選択を許可している場合、このメソッドを複数回実行することで、複数の行を選択状態にすることができます。リストビューが複数選択を許可していない場合、このメソッドを使用して指定した行を選択すると、それ以前に選択されていた行の選択状態が解除されます。
使用例
```
// 本サンプルコードでは、addSelectedRowメソッドを使用してリストビューの指定した行を選択状態にする例を示します。
// 現在のページを取得する。
var page = Forguncy.Page;
// リストビューオブジェクトを取得する。
var listview = page.getListView("リストビュー1");
// 指定した行を選択状態にする
listview.addSelectedRow(2);
```
引数
- rowIndex: number
  
  選択状態にしたい行の行番号。行番号は0から始まります。
戻り値 void

bind

bind(type: string, data?: any, fn?: any): void

リストビューが持つイベントに対してイベントハンドラを関連付けます。

・イベントへのデータの受け渡しイベントハンドラーにデータを受け渡すには、第2パラメーターに指定します。その場合、イベントハンドラーは第3パラメーターに指定します。受け渡されたデータは、イベントハンドラーにおける第1パラメーターのdataプロパティから参照できます。
使用例
```
// 本サンプルコードでは、bindメソッドを使用してSelectionChangedイベントにイベントハンドラーを関連付ける例を示します。
// 現在のページからリストビューを取得する。
var listivew = Forguncy.Page.getListView("リストビュー1");

// イベントハンドラーにパラメーターを渡さない場合：
listivew.bind("SelectionChanged", function () {
    alert("Forguncy");
});

// イベントハンドラーにパラメーターを渡す場合：
var text = "Forguncy";
listivew.bind("SelectionChanged", text, function (arg) {
    alert(arg.data);
});
```
引数
- type: string
  
  関連付けするイベントを表す文字列。セルでサポートされているイベントについては、ListViewEventsクラスを参照してください。
- オプション data: any
  
  イベントハンドラーに渡すデータ。関数では第1パラメーターのdataプロパティから参照します。省略可能。
- オプション fn: any
  
  イベント発生時に実行される関数。
戻り値 void

clearAllColumnFilters

clearAllColumnFilters(): void

リスビューのフィルター設定をすべてクリアします。

使用例

// 本サンプルコードではclearAllColumnFiltersメソッドを利用してすべてのフィルターの設定をクリアする例を示します。
// 現在のページを取得する。
var page = Forguncy.Page;
// リストビューオブジェクトを取得する。
var listview = page.getListView("リストビュー1");
// リスビューのフィルター設定をクリア。
listview.clearAllColumnFilters();

戻り値 void

clearAllSelectedRows

clearAllSelectedRows(): void

リストビュー内のすべての行の選択状態を解除します。

使用例

// 本サンプルコードでは、clearAllSelectedRowsメソッドを使用してリストビュー内のすべての選択行を解除する例を示します。
// 現在のページを取得する。
var page = Forguncy.Page;
// リストビューオブジェクトを取得する。
var listview = page.getListView("リストビュー1");
// リストビュー内のすべての選択行を解除する。
listview.clearAllSelectedRows();

戻り値 void

clearSelectedRow

clearSelectedRow(rowIndex: number): void

リストビューで指定して行の選択状態を解除します。

使用例

// 本サンプルコードでは、clearSelectedRowメソッドを使用してリストビューの指定した行の選択状態を解除する例を示します。
// 現在のページを取得する。
var page = Forguncy.Page;
// リストビューオブジェクトを取得する。
var listview = page.getListView("リストビュー1");
// 指定した行の選択状態を解除する。
listview.clearSelectedRow(1);

引数

rowIndex: number

選択状態を解除したい行の行番号。行番号は0から始まります。

戻り値 void

clearSelectedRowByQuery

clearSelectedRowByQuery(query: Object): void

クエリー条件に基づいてリストビューの選択した行を削除します。

使用例

// 本サンプルコードでは、clearSelectedRowByQueryメソッドを使用して、指定する行を削除する例を示します。
// 現在のページを取得する。
var page = Forguncy.Page;
// リストビューオブジェクトを取得する。
var listview = page.getListView("リストビュー1");
// クエリ条件に基づいて、リストビューの行を削除する。
listview.clearSelectedRowByQuery({ID:1});

引数

query: Object

削除対象特定するためのクエリー条件。keyに主キーのフィールド名をvalueに対応するデータを指定したJSONオブジェクト。

戻り値 void

deleteRow

deleteRow(rowIndex: number): void

リストビューの行を削除します。

使用例

// 本サンプルコードでは、deleteRowメソッドを使用して指定した行を削除する例を示します。
// 現在のページを取得する。
var page = Forguncy.Page;
// リストビューオブジェクトを取得する。
var listview = page.getListView("リストビュー1");
// リストビューの指定した行を削除する。
listview.deleteRow(1);

引数

rowIndex: number

削除したい行の行番号。行番号は0から始まります。

戻り値 void

getDataTableName

getDataTableName(): string

リストビューに連結されているテーブル、またはビューの名前を取得します。

使用例

// 本サンプルコードでは、getDataTableNameメソッドを使用して、リストビューに連結しているテーブル、またはビューの名前を取得する例を示します。
// 現在のページを取得する。
var page = Forguncy.Page;
// リストビューオブジェクトを取得する。
var listview = page.getListView("リストビュー1");
// リストビューに連結しているテーブル、またはビューの名前を取得する。
var name = listview.getDataTableName();
// 取得したテーブル、またはビューの名前をダイアログボックスに表示する
alert(name);

戻り値 string

getDesignerRangeInfo

getDesignerRangeInfo(): CellRange

Forguncy Builder上におけるリストビューの範囲情報を取得します。範囲情報は、開始行インデックス、開始列インデックス、行数、列数が含まれ、インデックスは0から始まります。

使用例

// 本サンプルコードでは、getDesignerRangeInfoメソッドを使用してForguncy Builder上のリストビュー範囲情報を取得する例を示します。
// 現在のページを取得する。
var page = Forguncy.Page;
// リストビューオブジェクトを取得する。
var listview = page.getListView("リストビュー1");
// Forguncy Builder上のリストビュー位置情報を取得する。
var range = listview.getDesignerRangeInfo();
// 取得したリストビューの範囲情報をダイアログボックスに表示する。
alert( "開始行インデックス："+range.Row+"\n"+"開始列インデックス："+range.Column+"\n"+"リストビュー領域の行数："+range.RowCount+"\n"+"リストビュー領域の列数："+range.ColumnCount);

戻り値 CellRange

getMergedColumnInfos

getMergedColumnInfos(): IMergedColumnInfo[]

リストビューのすべての列に関する情報（行ヘッダー、列の選択、列の非表示などを含む）を取得します。

使用例

// 本サンプルコードでは、getMergedColumnInfosメソッドを使用してリストビュー内のすべての列に関する情報を取得する例を示します。
// 現在のページを取得する。
var page = Forguncy.Page;
// リストビューオブジェクトを取得する。
var listview = page.getListViews()[0];
// リストビュー内のすべての列に関する情報を取得する。
var infos=listview.getMergedColumnInfos();
// 取得したすべての列に関する情報をダイアログボックスに表示する。
alert(JSON.stringify(infos, null, " "));

戻り値 IMergedColumnInfo []

getName

getName(): string

リストビューの名前を取得します。

使用例

// 本サンプルコードでは、getNameメソッドを使用してリストビューの名前を取得する例を示します。
// 現在のページを取得する。
var page = Forguncy.Page;
// リストビューオブジェクトを取得する。
var listview = page.getListView("リストビュー1");
// リストビューの名前を取得する
var name = listview.getName();
// リストビューの名前をダイアログボックスに表示する。
alert(name);

戻り値 string

getPaginationInfo

getPaginationInfo(): ListviewPaginationInfo

リストビューがページングされている時、ページング情報（1ページの最大行数、ページ数、インデックス番号(1～)）を取得します。ページングされていない時の戻り値はnullです。

戻り値の例

```javascript { // ページ数 "PageCount":3, // ページのインデックス番号 "PageIndex":1, // 1ページの最大行数 "MaxRowCountOfOnePage":10 } ```

使用例

// PageDefaultDataLoadedイベントで本メソッドを使用することを推奨します。それ以外のイベントの場合、リストビューデータの読み込みが完了していない可能性があります。
Forguncy.Page.bind(Forguncy.PageEvents.PageDefaultDataLoaded, function () {
    var listview = Forguncy.Page.getListView("リストビュー1");
    // リストビューのページング情報を取得する。
    var pagingInfo = listview.getPaginationInfo();
    listview.bind(Forguncy.ListViewEvents.Reloaded, function() {
        // ページナビゲーション型セルで［前へ］、または［次へ］をクリックすると、リストビューのデータが再読み込みされ、ページング情報が更新されます。
        var pagingInfo = listview.getPaginationInfo();
        // ページング情報をダイアログボックスに表示する。
        alert(JSON.stringify(pagingInfo, null, " "));
    });
});

戻り値 ListviewPaginationInfo

getQuery

getQuery(rowIndex: number): Object

指定したリストビュー行のクエリー条件（主キーフィールドとその値）を取得します。

使用例

// 本サンプルコードでは、getQueryメソッドを使用してリストビューの指定した行の主キー情報を取得する例を示します。
// 現在のページを取得する。
var page = Forguncy.Page;
// リストビューオブジェクトを取得する。
var listview = page.getListView("リストビュー1");
// 指定した行の主キーを取得する。
var query = listview.getQuery(0);
// 取得した主キー情報をダイアログボックスに表示する。
alert(JSON.stringify(query, null, " "));

引数

rowIndex: number

取得したい行の番号。

戻り値 Object

getRowCount

getRowCount(): number

リストビューに表示されているデータの行数を取得します。（表示されている行数であるため全体の結果とは異なります。ページナビゲーション型セルや、ページロード時の取得レコード数、ロードオンデマンド、ページ表示時にリストビューのデータを読み込まない等の設定により表示件数を制限していた場合、コード実行時に表示されている行数が取得されます。）
使用例
```
// 本サンプルコードでは、getRowCountメソッドを使用してリストビューの行数を取得する例を示します。
// 現在のページを取得する。
var page = Forguncy.Page;
// リストビューオブジェクトを取得する。
var listview = page.getListView("リストビュー1");
// リストビューの行数を取得する。
var count= listview.getRowCount();
// 取得したリストビューの行数をダイアログボックスに表示する。
alert(count);
```
戻り値 number

getRunTimePageName

getRunTimePageName(): string

このリストビューが実行されているページ名を取得します。

戻り値 string

getSelectedRowIndex

getSelectedRowIndex(): number

リストビューの現在行（カレントレコード）の行番号（インデックス）を取得します。行番号は0から始まります。

使用例

// 本サンプルコードでは、getSelectedRowIndexメソッドを使用してリストビューの現在行の行番号を取得する例を示します。
// 現在のページを取得する。
var page = Forguncy.Page;
// リストビューオブジェクトを取得する。
var listview = page.getListView("リストビュー1");
// リストビューの現在行の行番号を取得する。
var index = listview.getSelectedRowIndex();
// 取得したリストビューの現在行の行番号をダイアログボックスに表示する。
alert(index);

戻り値 number

getSelectedRowIndexs

getSelectedRowIndexs(): number[]

リストビューの選択行の行番号を取得します。もし行が選択されていない場合、配列には現在行が含まれます。行番号は0から始まります。

使用例

// 本サンプルコードでは、getSelectedRowIndexsメソッドを使用して選択されている行の行番号を取得する例を示します。
// 現在のページを取得する。
var page = Forguncy.Page;
// リストビューオブジェクトを取得する。
var listview = page.getListView("リストビュー1");
// 選択されている行の行番号を取得する。
var index = listview.getSelectedRowIndexs();
// 取得した行の行番号をダイアログボックスに表示する。
alert(JSON.stringify(index, null, " "));

戻り値 number []

getSelectedRowsData

getSelectedRowsData(): RowData[]

選択された行データの配列を取得します。選択した行の行インデックス、クエリ条件、およびデータが含まれます。

使用例

// 本サンプルコードでは、getSelectedRowsDataメソッドを使用してリストビューの選択行のデータを取得する例を示します。
// 現在のページを取得する。
var page = Forguncy.Page;
// リストビューオブジェクトを取得する。
var listview = page.getListView("リストビュー1");
// リストビューの選択行のデータを取得する。
var rows = listview.getSelectedRowsData();
// 取得した選択行のデータをダイアログボックスに表示する。
alert(JSON.stringify(rows, null, " "));

戻り値 RowData []

getText

getText(rowIndex: number, column: string | number): any

リストビューの指定されたセルの表示テキストを取得します。表示テキストは実際の値ではなく、書式設定が適用された画面に表示されている文字列です。
使用例
```
// 本サンプルコードでは、最初の列は「Name」、2番目の列は「Age」という名前の列があるリストビューを例として使用します。
// 「Age」列の最初の行の表示テキストを取得する場合、次の2つの方法が存在します。
// 現在のページを取得する。
var page = Forguncy.Page;
// リストビューオブジェクトを取得する。
var listview = page.getListView("リストビュー1");
// 方法1：
var text = listview.getText(0,"Age");
// 方法2：
var text = listview.getText(0,1);
```
引数
- rowIndex: number
  
  取得したいセルの行番号。行番号は0から始まります。
- column: string | number
  
  取得したいセルのリストビュー上の列名、もしくは列番号。列名はヘッダー名ではなく、右ペインから各列に対して設定する値であることに注意してください。列番号は0から始まります。
戻り値 any

getValue

getValue(rowIndex: number, column: string | number): any

リストビュー内の指定したセルの値を取得します。この値は実際に画面に表示されている文字列とは異なる場合があります。たとえば、日付/時刻型フィールドの実際の値は数値であるため、このメソッドを使用した場合には数値が取得されます。
使用例
```
// 本サンプルコードでは、最初の列は「Name」、2番目の列は「Age」という名前となっているリストビューを例として使用します。
// 「Age」列の最初の行の値を取得する場合、次の2つの方法が存在します。
// 現在のページを取得する。
var page = Forguncy.Page;
// リストビューオブジェクトを取得する。
var listview = page.getListView("リストビュー1");
// 方法1：
var text = listview.getValue(0,"Age");
// 方法2：
var text = listview.getValue(0,1);
```
引数
- rowIndex: number
  
  値を取得したいセルの行番号。行番号は0から始まります。
- column: string | number
  
  値を取得したいセルのリストビュー上の列名、もしくは列番号。列名はヘッダー名ではなく、右ペインから各列に対して設定する値であることに注意してください。列番号は0から始まります。
戻り値 any

goToFirstPage

goToFirstPage(): void

ページナビゲーション型セルを使用してリストビューのページングを行っている場合に、最初のページを表示します。

使用例

// 本サンプルコードでは、goToFirstPageメソッドを使用してページングの最初のページを表示する例を示します。
// 現在のページを取得する。
var page = Forguncy.Page;
// リストビューオブジェクトを取得する。
var listview = page.getListView("リストビュー1");
// ページングの最初のページを表示する。
listview.goToFirstPage()

戻り値 void

goToLastPage

goToLastPage(): void

ページナビゲーション型セルを使用してリストビューのページングを行っている場合に、最後のページを表示します。

使用例

// 本サンプルコードでは、goToNextPageメソッドを使用してページングで表示している現在のページの次のページを表示する例を示します。
// 現在のページを取得する。
var page = Forguncy.Page;
// リストビューオブジェクトを取得する。
var listview = page.getListView("リストビュー1");
// ページングの最後のページを表示する。
listview.goToLastPage()

戻り値 void

goToNextPage

goToNextPage(): void

ページナビゲーション型セルを使用してリストビューのページングを行っている場合に、現在のページの次のページを表示します。

使用例

// 本サンプルコードでは、goToNextPageメソッドを使用してページングで表示している現在のページの次のページを表示する例を示します。
// 現在のページを取得する。
var page = Forguncy.Page;
// リストビューオブジェクトを取得する。
var listview = page.getListView("リストビュー1");
// ページングで表示している現在のページの次のページを表示する。
listview.goToNextPage()

戻り値 void

goToPreviousPage

goToPreviousPage(): void

ページナビゲーション型セルを使用してリストビューのページングを行っている場合に、現在のページの前のページを表示します。

使用例

// 本サンプルコードでは、goToPreviousPageメソッドを使用してページングで表示している現在のページの前のページを表示する例を示します。
// 現在のページを取得する。
var page = Forguncy.Page;
// リストビューオブジェクトを取得する。
var listview = page.getListView("リストビュー1");
// ページングで表示している現在のページの前のページを表示する。
listview.goToPreviousPage()

戻り値 void

goToSpecifiedPage

goToSpecifiedPage(pageIndex: number): void

ページナビゲーション型セルを使用してリストビューのページングを行っている場合に、指定したページを表示します。

使用例

// 本サンプルコードでは、goToSpecifiedPageメソッドを使用してページングで表示しているリストビューのページを指定した番号のページへと変更します。
// 現在のページを取得する。
var page = Forguncy.Page;
// リストビューオブジェクトを取得する。
var listview = page.getListView("リストビュー1");
// ページングで表示しているリストビューのページを指定した番号のページへと変更します。
listview.goToSpecifiedPage(3)

引数

pageIndex: number

ページングにおける表示するページ番号。

戻り値 void

hiddenLoadingIndicator

hiddenLoadingIndicator(): void

showLoadingIndicatorメソッドを呼び出すと、リストビューの表示が完了していないにも関わらずユーザーがリストビューに対して操作を行わないようにするために、読み込みインジケーター（プログレスリング）が表示されている間リストビューを無効にできます。本メソッドが呼び出されると、リストビューは有効になります。

使用例

// 本サンプルコードでは、showLoadingIndicatorメソッドとhiddenLoadingIndicatorメソッドを使用してリストビューに読み込みインジケーターを表示して一時的にリストビューを無効化する例を示します。
// 現在のページを取得する。
var page = Forguncy.Page;
// リストビューオブジェクトを取得する。
var listview = page.getListView("リストビュー1");

listview.showLoadingIndicator();

// 何らかの処理を行う。

listview.hiddenLoadingIndicator();

戻り値 void

hideColumns

hideColumns(columns: (string | number)[]): void

リストビューの列を非表示にします。

使用例

// 本サンプルコードでは、リストビューの列を非表示にする方法を示します。
// 現在のページを取得する。
var page = Forguncy.Page;
// リストビューオブジェクトを取得する。
var listview = page.getListView("リストビュー1");

// 列名が「Text」および「Text1」の列を非表示にします。
listview.hideColumns(["Text", "Text1"]);

// リストビューの2番目と3番目の列を非表示にします。セルを結合に関係なく列を数える必要があります。
listview.hideColumns([1,2]);

引数

columns: (string | number)[]

リストビューの列名の配列、もしくは列インデックスの配列。列インデックスは設計時の列インデックスであり、0から始まります。

戻り値 void

isSelectedRow

isSelectedRow(rowIndex: number): boolean

指定した行が選択されているかどうかを取得します。戻り値は、選択されている場合がtrue、選択されていない倍がfalseです。

使用例

// 本サンプルコードでは、isSelectedRowメソッドを使用して使用して、指定した行の選択状態を表示する例を示します。
// 現在のページを取得する。
var page = Forguncy.Page;
// リストビューオブジェクトを取得する。
var listview = page.getListView("リストビュー1");
// 指定する行が選択されているかどうかを取得する。
var row = listview.isSelectedRow(2);
// 行の選択状態をダイアログボックスに表示する。
alert(row);

引数

rowIndex: number

選択されているかどうかを取得したい行の行番号。行番号は0から始まります。

戻り値 boolean

reload

reload(): void

リストビューのデータをサーバーから再読み込みします。リストビューの設定において「一定間隔で最新データに更新」の機能が使用可能です。その使用が適さない場合、本メソッドを使用してリストビューのデータをサーバーから再読み込みする方法を検討してください。

使用例

// 本サンプルコードでは、reloadメソッドを使用して、リストビューのデータをサーバーから再読み込みする例を示します。
// 現在のページを取得する。
var page = Forguncy.Page;
// リストビューオブジェクトを取得する。
var listview = page.getListView("リストビュー1");
// リストビューのデータをサーバーから再読み込みする。
listview.reload();

戻り値 void

selectAllRows

selectAllRows(): void

リストビュー内のすべての行を選択状態にします。

使用例

// 本サンプルコードでは、selectAllRowsメソッドを使用してリストビュー内のすべての行を選択状態にする例を示します。
// 現在のページを取得する。
var page = Forguncy.Page;
// リストビューオブジェクトを取得する。
var listview = page.getListView("リストビュー1");
// リストビュー内のすべての行を選択状態にする。
listview.selectAllRows();

戻り値 void

selectRow

selectRow(rowIndex: number): void

リストビューの現在行（カレントレコード）を設定します。

使用例

// 本サンプルコードでは、selectRowメソッドを使用して指定した行を現在行に設定する例を示します。
// 現在のページを取得する。
var page = Forguncy.Page;
// リストビューオブジェクトを取得する。
var listview = page.getListView("リストビュー1");
// 指定した行を現在行に設定する。
listview.selectRow(2);

引数

rowIndex: number

行番号

戻り値 void

setText

setText(rowIndex: number, column: string | number, text: any): void

リストビュー内の指定したセルに表示テキストを設定します。

使用例

// 本サンプルコードでは、最初の列が「Name」という名前となっており、かつその列のテンプレート行のセルがコンボボックス型に設定されているリストビューを例として使用します。
// 「Name」列の最初の行の表示テキストを設定したい場合、次の2つの方法が存在します。
// 現在のページを取得する。
var page = Forguncy.Page;
// リストビューオブジェクトを取得する。
var listview = page.getListView("リストビュー1");
// 方法1：
listview.setText(0,"Name","Bob");
// 方法2：
listview.setText(0,0,"Bob");

引数

rowIndex: number

表示テキストを設定したいセルの行番号。行番号は0から始まります。
column: string | number

表示テキストを設定したいセルのリストビュー上の列名、もしくは列番号。列名はヘッダー名ではなく、右ペインから各列に対して設定する値であることに注意してください。列番号は0から始まります。
text: any

設定する表示テキスト。

戻り値 void

setValue

setValue(rowIndex: number, column: string | number, value: any): void

リストビュー内の指定したセルに値を設定します。

使用例

// 本サンプルコードでは、最初の列は「Name」、2番目の列は「Age」という名前となっているリストビューを例として使用します。
// 「Age」列の最初の行に値を設定する場合、次の2つの方法が存在します。
// 現在のページを取得する。
var page = Forguncy.Page;
// リストビューオブジェクトを取得する。
var listview = page.getListView("リストビュー1");
// 方法1：
listview.setValue(0,"Age",12);
// 方法2：
listview.setValue(0,1,12);

引数

rowIndex: number

値を設定したいセルの行番号。行番号は0から始まります。
column: string | number

値を設定したいセルのリストビュー上の列名、もしくは列番号。列名はヘッダー名ではなく、右ペインから各列に対して設定する値であることに注意してください。列番号は0から始まります。
value: any

設定する値。

戻り値 void

showColumns

showColumns(columns: (string | number)[]): void

hideColumnsメソッド、もしくは［リストビューの列カスタマイズ］コマンドによって非表示となっているリストビューの列を表示させます。

使用例

// 本サンプルコードでは、hideColumnsメソッド、もしくは［リストビューの列カスタマイズ］コマンドによって非表示となっているリストビューの列を表示させる例を示します。
// 現在のページを取得する。
var page = Forguncy.Page;
// リストビューオブジェクトを取得する。
var listview = page.getListView("リストビュー1");

// 列名が「Text」および「Text1」の列を表示させます。
listview.showColumns(["Text", "Text1"]);

// リストビューの2番目と3番目の列を表示させます。セルを結合に関係なく列を数える必要があります。
listview.showColumns([1,2]);

引数

columns: (string | number)[]

リストビューの列名の配列、もしくは列インデックスの配列。列インデックスは設計時の列インデックスであり、0から始まります。

戻り値 void

showLoadingIndicator

showLoadingIndicator(): void

本メソッドを呼び出すと、リストビューの表示が完了していないにも関わらずユーザーがリストビューに対して操作を行わないようにするために、読み込みインジケーター（プログレスリング）が表示されている間リストビューを無効にできます。hiddenLoadingIndicatorメソッドが呼び出されると、リストビューは有効になります。

使用例

// 本サンプルコードでは、showLoadingIndicatorメソッドとhiddenLoadingIndicatorメソッドを使用してリストビューに読み込みインジケーターを表示して一時的にリストビューを無効化する例を示します。
// 現在のページを取得する。
var page = Forguncy.Page;
// リストビューオブジェクトを取得する。
var listview = page.getListView("リストビュー1");

listview.showLoadingIndicator();

// 何らかの処理を行う。

listview.hiddenLoadingIndicator();

戻り値 void

unbind

unbind(type: any, fn?: any): void

リストビューから指定したイベントハンドラの関連付けを解除します。第2パラメーターを省略した場合、指定イベントに関連付けされたすべてのイベントハンドラの関連付けが解除されます。

使用例

// 本サンプルコードでは、unbindメソッドを使用してリストビューイベントの関連付けを解除する方法をいくつか示します。
// イベントハンドラーの定義。
var onSelectionChanged = function () {
    alert("Forguncy");
}
// 現在のページを取得する。
var page = Forguncy.Page;
// リストビューオブジェクトを取得する。
var listview = page.getListView("リストビュー1");
// イベントハンドラーの関連付けを行う。
listivew.bind("SelectionChanged", onSelectionChanged);
// イベントハンドラーの関連付けを行う。
listivew.unbind("SelectionChanged", onSelectionChanged);
// SelectionChangedイベントに関連付けられているすべてのイベントハンドラーの関連付けを解除する。
listivew.unbind("SelectionChanged");

引数

type: any

関連付けを削除するイベントを表す文字列。ページでサポートされているイベントについては、ListViewEventsクラスを参照してください。
オプション fn: any

対象ページ名。すべてのページのイベントに対する関連付けを解除する場合は、「*」を指定します。省略した場合、現在のページに対してイベントに対する関連付け解除を行います。本パラメーターは省略可能です。

戻り値 void

usePaginationDisplay

usePaginationDisplay(pageRowCount: number, pageIndex?: number): void

ページごとに表示される行数を設定し、指定したページ番号を表示します。（ページナビゲーション型セルと同時に使った場合、ページナビゲーション型セルの表示されている数値は連動して動きません。「ページ表示時にリストビューのデータを読み込まない」を設定しており、ページロード時のコマンドに本コマンドを設定している場合、最初にページを表示した際はデータは表示されませんが、もしその後、本コマンドやページナビゲーション型セルにて別のページを表示し、再度このページにアクセスした場合、ページロード時にデータが表示されてしまうため、ご注意ください。）
使用例
```
// 本サンプルコードでは、usePaginationDisplayメソッドを使用して、ページごとに表示される行数を再設定し、指定された番号のページを表示する例を示します。
// 現在のページを取得する。
var page = Forguncy.Page;
// リストビューオブジェクトを取得する。
var listview = page.getListView("リストビュー1");
// ページごとに表示される行数を再設定し、指定された番号のページを表示する。
listview.usePaginationDisplay(6, 2)
```
引数
- pageRowCount: number
  
  ページごとに表示される行数。
- オプション pageIndex: number
  
  表示さるページ番号。省略された場合、最初のページを表示します。ページ番号は1から始まります。
戻り値 void

ListView クラス

階層

メソッド

メソッド

addNewRow

引数

rowValues: {} | any[]

オプション isText: boolean

戻り値 void

addSelectedRow

引数

rowIndex: number

戻り値 void

bind

引数

type: string

オプション data: any

オプション fn: any

戻り値 void

clearAllColumnFilters

戻り値 void

clearAllSelectedRows

戻り値 void

clearSelectedRow

引数

rowIndex: number

戻り値 void

clearSelectedRowByQuery

引数

query: Object

戻り値 void

deleteRow

引数

rowIndex: number

戻り値 void

getDataTableName

戻り値 string

getDesignerRangeInfo

戻り値 CellRange

getMergedColumnInfos

戻り値 IMergedColumnInfo []

getName

戻り値 string

getPaginationInfo

戻り値の例

戻り値 ListviewPaginationInfo

getQuery

引数

rowIndex: number

戻り値 Object

getRowCount

戻り値 number

getRunTimePageName

戻り値 string

getSelectedRowIndex

戻り値 number

getSelectedRowIndexs

戻り値 number []

getSelectedRowsData

戻り値 RowData []

getText

引数

rowIndex: number

column: string | number

戻り値 any

getValue

引数

rowIndex: number

column: string | number

戻り値 any

goToFirstPage

戻り値 void

goToLastPage

戻り値 void

goToNextPage

戻り値 void

goToPreviousPage

戻り値 void

goToSpecifiedPage

引数