sgcGrid:Delphi 向けのデータ対応 DBGrid 代替
sgcGrid は、DBGrid が使っている TDataSet にそのままバインドできるデータ対応の Delphi グリッドで、同じ行をグループ化、集計、フィルター、エクスポートできます。
sgcGrid は、DBGrid が使っている TDataSet にそのままバインドできるデータ対応の Delphi グリッドで、同じ行をグループ化、集計、フィルター、エクスポートできます。
データベースのコードはそのまま使えます。変わるのはグリッドと、グリッドとデータセットを結ぶリンクだけです。
sgcGrid は FireDAC の TFDQuery、TClientDataSet、その他のデータセットにバインドできます。TDBGrid が表示する内容に加えて、行のグループ化と合計、フィルター行、列フィルター、検索パネルによるフィルター、Excel エクスポート、変更された行のその場更新を、VCL と FireMonkey で実現します。
TDBGrid は TDataSource を通じてデータセットを読み取ります。sgcGrid では、TsgcGridSource_DataSet が TDataSource の代わりになります。Grid と DataSet を設定して Active にすれば、行が表示されます。データセットは FireDAC のクエリ、TClientDataSet、その他の TDataSet の派生クラスのいずれでも構いません。
KeyField を指定すると、グリッドは再読み込みではなく同期されます。変更された行はその場で更新されて点滅し、新しいキーは追加され、存在しなくなったキーは削除されます。LiveUpdates を使うと、グリッドはデータセットの Post、Delete、Refresh のたびに追従します。AutoColumns は、グリッドに列がない場合にフィールドから列を作成します。デザインした列は保持され、FieldName で照合されます。DisableControls を使って走査され、現在のレコードは元に戻されます。データセットを閉じても行は保持されます。BooleanFields は S と N のようにテキストや数値で保存されたフラグをチェックボックスとして表示します。uses
SysUtils, Classes, DB, FireDAC.Comp.Client,
sgcUICore_Canvas, sgcUICore_Theme, sgcUICore_Table, sgcGrid_Columns,
sgcGrid_Data, sgcGrid_Format, sgcGrid_Render, sgcGrid_IO,
sgcGrid_Source_DataSet, sgcGrid_XLSX, sgcGrid_VCL;
procedure TOrdersForm.FormCreate(Sender: TObject);
begin
// the query that fed the TDBGrid stays as it is
qryOrders.Open;
// TsgcGridSource_DataSet takes the place of the TDataSource
FSource := TsgcGridSource_DataSet.Create(Self);
FSource.Grid := sgcVCLGrid1;
FSource.DataSet := qryOrders;
FSource.KeyField := 'ID'; // changed rows update in place
FSource.AutoColumns := True; // columns from the fields
FSource.LiveUpdates := True; // follow Post, Delete and Refresh
FSource.Active := True;
end;
ソースはコンポーネントなので、同じバインディングをフォームファイルに持たせ、オブジェクトインスペクターで設定できます:
object SourceDB: TsgcGridSource_DataSet
DataSet = cdsProducts
Grid = GridDB
KeyField = 'ID'
end
同じソースが、同じコードで FireMonkey の TsgcFMXGrid もバインドします。バインディング、グループ化、集計、フィルターは、無料の Delphi Community エディションを含むすべてのエディションに含まれます。
行はデータセットから取得され、グループ化、集計、フィルター、エクスポートはグリッドで実行されます。
GroupBy を呼ぶか、ヘッダーをグループパネルにドラッグして行いますSummaryType によるフッターとすべてのグループ行の合計、件数、平均、最小、最大OnApplySort はソートをフィールド名として渡します(たとえば FireDAC クエリの IndexFieldNames 用)SaveToXLSX は外部ライブラリなしで Excel ブックを書き出し、グループを折りたたみ可能なアウトライン、グループ合計を SUBTOTAL 数式として出力します(Registered エディション)
行が更新されると変更されたセルが点滅します。
2 段階のグループ、詳細行、着色されたセル。
フィルターしてから、複数の列でソートします。
TsgcGridSource_DataSet を通じて TClientDataSet にバインド。
procedure TOrdersForm.SetupGrid;
begin
// group by region; users drag more columns to the group panel
sgcVCLGrid1.ShowGroupPanel := True;
sgcVCLGrid1.GroupBy(['Region']);
// totals in the footer and in every group row
sgcVCLGrid1.Columns.FindByField('Amount').SummaryType := gsuSum;
sgcVCLGrid1.Columns.FindByField('ID').SummaryType := gsuCount;
sgcVCLGrid1.ShowFooter := True;
// a filter row under the header and the find panel
sgcVCLGrid1.ShowFilterRow := True;
sgcVCLGrid1.ShowFindPanel := True;
end;
procedure TOrdersForm.btnExcelClick(Sender: TObject);
begin
// Registered edition: the sheet keeps the groups and the totals
sgcVCLGrid1.SaveToXLSX('orders.xlsx', 'Orders');
end;
標準の VCL TDBGrid はデータセットを表示し編集します。この表は、追加コードなしで各グリッドができることをまとめたものです。
| 機能 | TDBGrid | sgcGrid | sgcGrid のエディション |
|---|---|---|---|
| TDataSet のバインド | TDataSource 経由 | DataSet、Grid、KeyField を指定した TsgcGridSource_DataSet | すべて |
| デザインした列 | TColumn の Columns | FieldName で照合する Columns、または AutoColumns | すべて |
| 変更された行をフラッシュ付きでその場更新 | No | はい、KeyField による | すべて |
| ヘッダークリックによるソート | OnTitleClick のコード | 組み込み。データセット向けに OnApplySort あり | すべて |
| グループ化とグループパネル | No | GroupBy, ShowGroupPanel | すべて |
| フッターとグループの集計 | No | SummaryType gsuSum、gsuCount、gsuAverage、gsuMin、gsuMax | すべて |
| フィルター行と列フィルター | No | ShowFilterRow, ShowFilterButtons | すべて |
| 検索パネル | No | ShowFindPanel, FindOnlyMatches | すべて |
| バンド、最適幅、保存したレイアウト | No | Bands, BestFitColumns, SaveLayoutToFile, AutoSaveLayout | すべて |
| 描画コードなしのセルごとの色 | OnDrawColumnCell のコード | FormatRules、OnGetCellStyle、カスタム描画用の OnCustomDrawCell | すべて |
| 複数行の選択 | dgMultiSelect, SelectedRows | SelectionMode gsmMultiRow、GetSelectedKeys | すべて |
| データセットへの編集と Post | はい、dgEditing を使用 | WriteBack はすべての編集を該当レコードに Post し、SyncCursor は現在のレコードを同期させます | Registered |
| Excel エクスポート | No | SaveToXLSX(ファイルまたはストリームへ) | Registered |
| 読み込めないほど大きなテーブル | No | TsgcGridServerProvider_DataSet によるサーバーモード(1 ページずつ) | Registered |
| FireMonkey | いいえ、VCL のみ | Windows、macOS、iOS、Android 上の TsgcFMXGrid | すべて |
| .NET | No | WinForms、WPF、Avalonia のグリッド | すべて |
sgcGrid 機能マトリックス、ベンチマーク、sgcGrid 比較もご覧ください。
WriteBack を有効にすると、ソースはグリッドでの編集をすべてその行のレコードに書き込みます。KeyField でレコードを特定し、値を Post します。BeforePost のチェックなどで Post が失敗した場合は、レコードがキャンセルされ、セルは元の値のままになります。
SyncCursor は現在のレコードとフォーカスされた行を一致させるため、同じデータセット上の TDBNavigator や TDBEdit コントロールがグリッドに追従し、グリッドもそれらに追従しますAllowInsert:Ins キーでレコードを追加して Post し、データセットの OnNewRecord で既定値を設定しますApplyFilter は、グリッドに表示されている行だけをデータセットに保持させるため、そのデータセット上のデータ対応コントロールやレポートにもフィルター後の行が見えますWriteBack、SyncCursor、挿入、削除、貼り付け、元に戻すは Registered エディションに含まれます。体験版には評価用にこれらが含まれています。
DataSet 編集のヘルプトピックを読む3 つのステップです。デザイン時に列をインポートし、プロパティとイベントを置き換え、DB グリッドを削除します。データは同じ TDataSet のままです。
TsgcVCLGrid を配置します。TsgcGridSource_DataSet の作成、位置とサイズ(Parent、Align、Anchors、TabOrder など)のコピー、イベントハンドラーのコピー、先にグリッドの列をクリアする、の 4 つです。インポートでは、FieldName、Title.Caption(Caption へ)、Width(フォームの PixelsPerInch で DIP に変換)、Visible、Alignment、ReadOnly(Editable へ)、PickList がコピーされます。コードからは、ユニット sgcGrid_Import_VCL の sgcGridImportDBGrid が実行時に同じ処理を行います。
| TDBGrid | sgcGrid |
|---|---|
| TDBGrid | TsgcVCLGrid(ユニット sgcGrid_VCL) |
| DataSource | TsgcGridSource_DataSet:DataSet、Grid、KeyField を設定し、Active := True(ユニット sgcGrid_Source_DataSet) |
| Columns、TColumn.FieldName | Columns, Columns[i].FieldName |
| ReadOnly、Options dgEditing | グリッドの ReadOnly とソースの WriteBack(Registered) |
| dgRowSelect | SelectionMode := gsmRow |
| dgMultiSelect、SelectedRows | SelectionMode := gsmMultiRow, SelectedRows, GetSelectedKeys |
| dgIndicator | RowHeader := [grhIndicator]、grhNumbers と grhCheckBox も利用可 |
| dgColLines、dgRowLines | GridLinesV, GridLinesH |
| OnDrawColumnCell | OnCustomDrawCell。色だけなら OnGetCellStyle または FormatRules |
| OnTitleClick | OnHeaderClick。ソートはグリッドが自動で行います |
| OnColEnter、OnColExit | OnSelectionChange(SelectedCol と併用) |
TDBGrid 移行キットには、すべてのメンバーの対応表、MigrateFromDBGrid デモの移行前と移行後のコード(Delphi 7 と Delphi 13 の Win32 および Win64 でコンパイル可能)、既知の相違点が含まれています。他のキットは sgcUI 移行のページにあります。
1 つのグリッドモデルが VCL と FireMonkey のグリッドを動かすため、VCL フォームと FireMonkey フォームでバインディングのコードを共有できます。
| ターゲット | コンポーネント | プラットフォーム |
|---|---|---|
| Delphi 7 から 13、VCL | TsgcVCLGrid | Win32、および XE2 から Win64 |
| Delphi XE6 から 13、FireMonkey | TsgcFMXGrid | Windows、macOS、iOS、Android |
| C++ Builder 2007 から 13 | TsgcVCLGrid、TsgcFMXGrid | 生成された .hpp ヘッダーとスタティックライブラリ |
| .NET Framework 4.7.2、.NET 8、9、10 | TsgcWinFormsGrid、WPF と Avalonia のグリッド | WinForms、WPF、Avalonia |
TDBGrid 列のインポートは VCL フォームデザイナーで実行されます。FireMonkey フォームでは、同じ TsgcGridSource_DataSet でデータセットをバインドします。
FieldName で照合するデザイン済み列を使った DataSet バインディング、ルックアップフィールド、セル、行、複数行の選択、行ヘッダー、カスタム描画、Ctrl+C、グループパネル、フッターとグループの集計、フィルター行、Excel 形式の列フィルター、検索パネル、バンド、最適幅、JSON レイアウトの保存と読み込み。無料の Delphi Community エディションには sgcGrid が同梱されています。
データセットへの双方向編集(WriteBack)、カーソル同期(SyncCursor)、挿入、削除、貼り付け、元に戻す、Excel エクスポート、カードビュー、非常に大きなテーブル向けのサーバーモード。sgcGrid は Single、Team、Site ライセンスと全ソースコード付きで単体販売されており、sgcUI の Standard、Professional、Enterprise、All-Access にも含まれます。
sgcGrid の価格を見るか、評価用にすべての Registered 機能を含む体験版をダウンロードしてください。
TDBGrid の隣に TsgcVCLGrid を配置し、右クリックして Import columns from DB grid を選びます。インポートでは列がコピーされ、同じデータセットにリンクした TsgcGridSource_DataSet が作成され、位置とサイズ、イベントハンドラーがコピーされ、手作業で移植が必要なイベントが報告されます。その後、TDBGrid を削除します。移行キットがすべてのプロパティとイベントを対応づけています。
TDBGrid は VCL コントロールです。sgcGrid には、Windows、macOS、iOS、Android 上の Delphi XE6 から 13 に対応した FireMonkey グリッド TsgcFMXGrid があり、同じ TsgcGridSource_DataSet が、VCL グリッドと同じコードで任意の TDataSet にバインドします。
はい。フィールド名を指定して GroupBy を呼ぶか、ユーザーが列ヘッダーをグループパネルにドラッグします。列に SummaryType(合計、件数、平均、最小、最大)を設定して ShowFooter をオンにすると、フッターとすべてのグループ行に合計が表示されます。グループ化と集計は、Community を含むすべてのエディションに含まれます。
データセットを sgcGrid にバインドし、ファイル名またはストリームを指定して SaveToXLSX を呼びます。ブックは外部ライブラリが不要で、ユーザーに見えている内容が維持されます。表示順の列とその幅や数値書式、固定されたヘッダー、折りたたみ可能なアウトラインとしてのグループ、SUBTOTAL 数式としてのグループ合計です。Excel エクスポートは Registered エディションに含まれ、Community エディションでは JSON と CSV をエクスポートできます。
はい。TFDQuery や TFDTable は TDataSet なので、TsgcGridSource_DataSet は TClientDataSet と同様にバインドします。OnApplySort はグリッドのソートを FireDAC の IndexFieldNames の形式(たとえば Name;Date:D)で渡します。読み込めないほど大きなテーブルには、TsgcGridServerProvider_DataSet を使ったサーバーモード(Registered)が 1 ページずつ読み込み、FireDAC などのクエリコンポーネントで実行される SQL により、データベース側でソート、フィルター、カウント、グループ化を行います。
はい、Registered エディションで可能です。WriteBack を使うと、ソースは KeyField で特定した行のレコードにすべての編集を Post し、SyncCursor が現在のレコードとフォーカスされた行を一致させるため、同じデータセット上の TDBNavigator や TDBEdit コントロールも同期を保ちます。Community エディションでは、グリッドはデータセットを読み取り専用で表示します。