MS Excel を使用して、データフィールド、式フィールド、シート名フィールドなどを含む帳票テンプレートを作成したら、これらのテンプレートフィールドにデータソースを連結する必要があります。AddDataSource メソッドを使用してデータソースを追加し、ProcessTemplate メソッドを使用してテンプレートフィールドにデータを連結します。これにより、データソースからテンプレートフィールドにデータが入力され、Excel 帳票が作成されます。
なお、ProcessTemplate メソッドを使用した場合、Excel 帳票を作成する際に帳票テンプレートのワークブックは上書きされ、同じワークブックに帳票が作成されます。帳票テンプレートのワークブックを保持したまま Excel 帳票を作成するには、本トピックの最後にある「帳票テンプレートを保持したままの Excel 帳票作成」を参照してください。
また、連結するデータソースには、複数のデータソースやデータテーブルも使用できます。この場合、テンプレート構文では、データソースのオブジェクトに続いてデータフィールドを指定する必要があります。例えば、以下の帳票テンプレートでは、各クラスの情報を異なるデータソースから連結するように設定しています。
テンプレート構文は、以下のデータソースに対応しています。
DataTable とは、任意の種類のデータベースの行と列のコレクションを持つ単一テーブルです。
テンプレート構文:[データソースの別名].[列名]
例:
{{ds.ID}}
{{ds.Name}}
DataTable のデータソースを連結
C# |
コードのコピー
|
---|---|
var datasource = new System.Data.DataTable(); datasource.Columns.Add(new DataColumn("ID", typeof(Int32))); datasource.Columns.Add(new DataColumn("Name", typeof(string))); datasource.Columns.Add(new DataColumn("Score", typeof(Int32))); datasource.Columns.Add(new DataColumn("Team", typeof(string))); ...// データを初期化します // データソースを追加します workbook.AddDataSource("ds", datasource); |
DataSet とは、1つ以上の DataTable のコレクションです。
テンプレート構文:[データソースの別名].[テーブル名].[列名]
例:
{{ds.Table1.ID}}
{{ds.Table2.Team}}
DataSet のデータソースを連結
C# |
コードのコピー
|
---|---|
var Table1 = new System.Data.DataTable(); var Table2 = new System.Data.DataTable(); ...// データを初期化します var datasource = new System.Data.DataSet(); datasource.Tables.Add(Table1); datasource.Tables.Add(Table2); // データソースを追加します workbook.AddDataSource("ds", datasource); |
カスタムオブジェクトとは、コードにてユーザーが定義したオブジェクト、または JSON 文字列/ファイル/XML などのシリアライズされたオブジェクトのことです。テンプレート構文では、カスタムオブジェクトとしてシリアライズできる任意のデータソースに対応しています。
テンプレート構文:[データソースの別名].[フィールド名] または [データソースの別名].[プロパティ名]
例:
{{ds.Sales.Area}}
{{ds.Sales.Name}}
カスタムオブジェクトのデータソースを連結
C# |
コードのコピー
|
---|---|
// カスタムクラスの定義 public class SalesData { public List<SalesRecord> Sales; } public class SalesRecord { public string Area; public string City; public string Category; public string Name; public double Revenue; } |
C# |
コードのコピー
|
---|---|
var datasource = new SalesData { Sales = new List<SalesRecord>() }; var record1 = new SalesRecord { Area = "北米", City = "シカゴ", Category = "家電製品", Name = "Bose 785593-0050", Revenue = 92800 }; datasource.Sales.Add(record1); var record2 = new SalesRecord { Area = "北米", City = "ニューヨーク", Category = "家電製品", Name = "Bose 785593-0050", Revenue = 92800 }; datasource.Sales.Add(record2); ...// データを初期化します // データソースを追加します workbook.AddDataSource("ds", datasource); |
DioDocs for Excel では、JsonDataSource クラスのインスタンスをカスタムオブジェクトとして作成できます。つまり、データソースとして JSON を使用する際、JSON ファイルから直接取得した JSON 文字列にて JsonDataSource クラスのインスタンスを作成し、そのインスタンスをデータソースとして指定することができます。
これにより、JSON からデータを取得するためのマッピングクラスを作成する必要がなくなり、以下のテンプレート構文のように、JSON のフィールドまたはメンバーを構文で直接指定できるようになります。
テンプレート構文:[データソースの別名].[フィールド名]
例:
{{ds.student.family.father.name}}
{{ds.student.family.father.occupation}}
{{ds.student.family.mother.name}}
JSONサンプル
{ "student": [ { "name": "Jane", "address": "101, Halford Avenue, Fremont, CA", "family": [ { "father": { "name": "Patrick James", "occupation": "Surgeon" }, "mother": { "name": "Diana James", "occupation": "Surgeon" } }, { "father": { "name": "father James", "occupation": "doctor" }, "mother": { "name": "mother James", "occupation": "teacher" } } ] }, { "name": "Mark", "address": "101, Halford Avenue, Fremont, CA", "family": [ { "father": { "name": "Jonathan Williams", "occupation": "Product Engineer" }, "mother": { "name": "Joanna Williams", "occupation": "Surgeon" } } ] } ] }
JSON のデータソースを連結
C# |
コードのコピー
|
---|---|
// JSON 文字列を読み込みます var jsonText = File.OpenText("Template_FamilyInfo.json").ReadToEnd(); // JsonDataSource を作成します var datasource = new JsonDataSource(jsonText); // データソースを追加します workbook.AddDataSource("ds", datasource); |
コードにてユーザーが定義した変数のことです。
テンプレート構文:[データソースの別名]
例:
{{cName}}
{{count}}
{{owner}}
変数のデータソースを連結
C# |
コードのコピー
|
---|---|
var className = "Class 3"; var count = 500; // データソースを追加します workbook.AddDataSource("cName", className); workbook.AddDataSource("count", count); workbook.AddDataSource("owner", "Hunter Liu"); |
コードにてユーザーが定義した配列またはリストのことです。
テンプレート構文
例:
{{p.Name}}
{{p.Age}}
{{countries}}
{{numbers}}
配列またはリストのデータソースを連結
C# |
コードのコピー
|
---|---|
// カスタムクラスの定義 public class Person { public string Name; public int Age; } |
C# |
コードのコピー
|
---|---|
int[] numbers = new int[] {10, 12, 8, 15}; List<string> countries = new List<string>() {"アメリカ", "日本", "イギリス", "インド"}; List<Person> peoples = new List<Person>(); Person p1 = new Person(); p1.Name = "Helen"; p1.Age = 12; peoples.Add(p1); Person p2 = new Person(); p2.Name = "Jack"; p2.Age = 23; peoples.Add(p2); Person p3 = new Person(); p3.Name = "Fancy"; p3.Age = 25; peoples.Add(p3); workbook.AddDataSource("p", peoples); workbook.AddDataSource("countries", countries); workbook.AddDataSource("numbers", numbers); |
IWorkbook インターフェースの GenerateReport メソッドを使用すると、帳票テンプレートのワークブックを保持したまま、作成した Excel 帳票を新しいワークブックのインスタンスとして返します。また、このメソッドには、特定のワークシートのみを使用して Excel 帳票を作成できるオーバーロードもあります。
GenerateReport メソッドを使用して Excel 帳票を作成する方法については、以下のサンプルコードを参照してください。
C# |
コードのコピー
|
---|---|
// 帳票を作成し、新しいワークブックのインスタンスとして返します IWorkbook report = workbook.GenerateReport(); // 指定されたワークシートのみの帳票を作成して返します IWorkbook report = workbook.GenerateReport(workbook.Worksheets["Sales"]); |
詳細な方法については、デモを参照してください。
DioDocs for Excel では、CancellationToken型のパラメータを受け取るProcessTemplateメソッドのオーバーロードを使用して、ProcessTemplateメソッドをキャンセルできます。キャンセル要求はワークブックを所有していないスレッドによって送信されるため、キャンセルはスレッドセーフです。CancellationTokenSourceの次のメソッドを使用して、CancellationTokenにシグナルを送信できます。
メソッド | 説明 |
---|---|
Cancel | ProcessTemplateメソッドを直ちにキャンセルします。 |
CancelAfter | 特定の遅延時間後にProcessTemplateメソッドをキャンセルします。 |
Dispose | 現在のインスタンスが使用しているすべてのリソースを解放します。 |
ProcessTemplateメソッドのオーバーロードは、次の条件が満たされた場合にテンプレート処理をキャンセルします。
リクエストに応じて、またはタイムアウトに達した後にテンプレートの処理をキャンセルする方法については、以下のサンプルコードを参照してください。
C# |
コードのコピー
|
---|---|
//ワークブックを初期化します var workbook = new GrapeCity.Documents.Excel.Workbook(); //リソースからテンプレートファイルを読み込みます workbook.Open("Template_SalesDataGroup_DataTable.xlsx"); Console.WriteLine("Creating test data."); //DataTableにデータを追加します。 var datasource = new System.Data.DataTable(); datasource.Columns.Add(new DataColumn("地域", typeof(string))); datasource.Columns.Add(new DataColumn("市", typeof(string))); datasource.Columns.Add(new DataColumn("カテゴリー", typeof(string))); datasource.Columns.Add(new DataColumn("製品", typeof(string))); datasource.Columns.Add(new DataColumn("収益", typeof(double))); var areas = new[] { "北米", "南米" }; var cities = new[] { "シカゴ", "ニューヨーク", "サンティアゴ", "キト", "フリーモント", "ブエノスアイレス", "メデジン", "ミネソタ" }; var categories = new[] { "家電製品", "携帯電話" }; var category1NamePrefixes = new[] { "Bose ", "Canon ", "Haier ", "IFB ", "Mi ", "Sennheiser " }; var category2NamePrefixes = new[] { "iPhone ", "OnePlus ", "Redmi ", "Samsung " }; Random rand = new Random(); var rows = datasource.Rows; //必要であれば、ループ数を増やすことができます for (var i = 0; i < 50000; i++) { var area = areas[rand.Next(0, areas.Length)]; var city = cities[rand.Next(0, cities.Length)]; var categoryId = rand.Next(0, categories.Length); var category = categories[categoryId]; var names = (categoryId == 0) ? category1NamePrefixes : category2NamePrefixes; var name = names[rand.Next(0, names.Length)] + rand.Next(10, 10000).ToString(); var revenue = rand.Next(10000, 100000); rows.Add(area, city, category, name, revenue); } //テンプレートのグローバル設定を追加します workbook.Names.Add("TemplateOptions.KeepLineSize", "true"); //データソースを追加します workbook.AddDataSource("ds", datasource); //Cancelキーが押されるかタイムアウト時間に達すると、データソースの連結ドをキャンセルします using (CancellationTokenSource cancellation = new CancellationTokenSource()) { void cancelHandler(object sender, ConsoleCancelEventArgs e) { //処理を終了します e.Cancel = true; //ProcessTemplateが完了またはキャンセルされたときにcancelHandlerを入力しません #if NETCOREAPP3_0_OR_GREATER Console.CancelKeyPress -= cancelHandler; #endif //Cancelキーが押された場合、キャンセルします cancellation.Cancel(); }; Console.CancelKeyPress += cancelHandler; //タイムアウト時間に達した場合、キャンセルします cancellation.CancelAfter(TimeSpan.FromSeconds(10)); Console.WriteLine("Start ProcessTemplate."); try { workbook.ProcessTemplate(cancellation.Token); Console.WriteLine("ProcessTemplate finished."); } catch (OperationCanceledException ex) when (ex.CancellationToken == cancellation.Token) { Console.WriteLine("ProcessTemplate was canceled."); } //ProcessTemplateが完了またはキャンセルされたときにcancelHandlerを入力しません #if NETCOREAPP3_0_OR_GREATER Console.CancelKeyPress -= cancelHandler; #endif } //ワークブックを保存します workbook.Save("CancelTemplateProcessing.xlsx"); |