IgbGrid において、デフォルト設定では画面上で非表示 (Hidden) に設定された列は、

下図のように、Excel エクスポート時に出力されません。

本記事では、IgbGrid の Excel エクスポート機能を利用して、非表示列( Hidden 設定の列)を Excel ファイルに含めて出力する設定方法をご紹介します。
IgbGrid の設定
非表示列を含めるには、IgbGridToolbarExporter のExportStartedScriptプロパティに、エクスポート処理開始時に実行するカスタムスクリプトを登録します。これにより、エクスポート処理が開始される直前に設定を変更できます。
<IgbGrid ....>
<IgbGridToolbar>
<IgbGridToolbarActions>
<IgbGridToolbarExporter ....
ExportStartedScript="OnGridExportIncludeHiddenColumns">
</IgbGridToolbarExporter>
</IgbGridToolbarActions>
....
</IgbGrid>
イベントハンドラの登録
Export 処理が開始すると、OnGridExportIncludeHiddenColumns イベントが発生します。非表示列もエクスポート対象とするには、以下のコードのように、オプション内のignoreColumnsVisibilityプロパティをtrueに設定します。
igRegisterScript("OnGridExportIncludeHiddenColumns", (ev) => {
// 非表示列もエクスポート対象にする
ev.detail.options.ignoreColumnsVisibility = true;
}, false);
実行結果
UI 上では非表示にした列も、Excel エクスポート時にはデータとして含まれ、Excel ファイルに出力されるようになります。
