Excel ファイルを出力するには、コントロールの SaveExcel メソッドを使用します。
SaveExcel メソッドの引数には ExcelSaveSettings クラスのインスタンスを設定し Excel ファイルの出力に関する詳細を指定します。ExcelSaveSettings クラスで設定できる機能は次のとおりです。
機能 | 内容 |
---|---|
ファイルの種類 | FileFormat プロパティを使用してファイルの種類をBIFF8(xls)形式で出力するかOpen XML(xlsx)形式で出力するかを設定できます。既定値は ExcelFileFormat.Xls(BIFF8形式)です。 |
行ヘッダの設定 | IncludeRowHeader プロパティを true に 設定すると 行ヘッダに表示されるテキストを出力します。既定値は false です。 |
列ヘッダの設定 | IncludeColumnHeader プロパティを true に設定すると列ヘッダに表示されるテキストを出力します。既定値は falseです。 |
パスワード | Password プロパティを使用して出力するExcelファイルにパスワードを設定できます。 |
シート名 | SheetName プロパティを使用して出力するExcelファイルのシート名を設定できます。 |
1レコード複数行 | UseLayoutTemplate プロパティを true に設定すると、レイアウト テンプレートの列の並び順でデータを出力します。ただし、この場合、数式は出力されません。既定値は false です。 |
非表示行/列の出力 | IgnoreHiddenCells プロパティを true に設定すると、非表示行および列のデータを出力しません。既定値は false です。 |
次のサンプルコードは、ファイルの種類をOpen XML形式に指定し、パスワードを設定する例です。
C# |
コードのコピー |
---|---|
gcSpreadGrid1.SaveExcel(@"C:\ProgramData\test.xlsx", new ExcelSaveSettings() { FileFormat = ExcelFileFormat.Xlsx, Password = "GrapeCity" }); |
Visual Basic |
コードのコピー |
---|---|
GcSpreadGrid1.SaveExcel("C:\ProgramData\test.xlsx", New ExcelSaveSettings() With { .FileFormat = ExcelFileFormat.Xlsx, .Password = "GrapeCity"}) |
SaveExcel メソッドの引数に LimitedExcelSaveSettings クラスのインスタンスを設定すると、処理速度およびメモリ使用量に関するパフォーマンスを重視したモードで Excel ファイルへの出力ができます。ただし、以下の制限事項があります。
通常は、ExcelSaveSettings クラスのインスタンスを引数に設定する方法でExcel出力しますが、この方法は、数千列以上かつ数千行以上などの大量のデータを出力する際に、通常のExcel出力ではパフォーマンスに問題が発生する場合に有効です。
なお、LimitedExcelSaveSettings クラスで設定できる機能は次のとおりです。
機能 | 内容 |
---|---|
行ヘッダの設定 | IncludeRowHeader プロパティを true に 設定すると 行ヘッダに表示されるテキストを出力します。既定値は false です。 |
列ヘッダの設定 | IncludeColumnHeader プロパティを true に設定すると列ヘッダに表示されるテキストを出力します。既定値は falseです。 |
パスワード | Password プロパティを使用して出力するExcelファイルにパスワードを設定できます。 |
シート名 | SheetName プロパティを使用して出力するExcelファイルのシート名を設定できます。 |
非表示行/列の出力 | IgnoreHiddenCells プロパティを true に設定すると、非表示行および列のデータを出力しません。既定値は false です。 |