Postmark のデータをDevExpress Data Grid にデータバインドする。
CData API Driver for ADO.NET は、サードパーティ製コントロールと組み合わせて使える標準的なADO.NET データアクセスコンポーネントを備えています。通常のADO.NET データバインドの手順に沿って進めるだけで、UI コントロールからリアルタイムデータへの双方向アクセスを実現できます。この記事では、CData のコンポーネントを使って DevExpress UI コントロール(Windows Forms およびWeb コントロール) にデータバインドする方法を紹介します。今回は、リアルタイムのデータを可視化するチャートにデータバインドしていきます。
API キー認証の設定
Postmark は、リクエストの認証にサーバー API トークンを使用します。各 Postmark サーバーは独自の API トークンを持ち、そのサーバーに関連付けられたメッセージ、バウンス、テンプレート、統計情報へのアクセスを制御します。
Server API Token を取得するには、Postmark アカウントにログインし、接続したいサーバーに移動します。サーバー設定の API Tokens に移動して、Server API token というラベルのトークンをコピーしてください。
以下の接続プロパティを設定して接続を確立してください:
- AuthScheme:APIKey に設定します。
- APIKey:Postmark の Server API Token に設定します。この値は、すべてのリクエストで X-Postmark-Server-Token ヘッダーとして送信されます。
接続文字列の例:
Profile=C:\profiles\Postmark.apip;AuthScheme=APIKey;ProfileSettings="APIKey=your-server-api-token"
Postmark への接続
認証を設定すると、Postmark に接続して、OutboundMessages、Bounces、Templates などの利用可能なテーブルからデータをクエリできます。
Windows Forms コントロール
下のコードでは、Postmark でDevExpress のチャートに追加する方法を説明します。APIDataAdapter はチャートコントロールのSeries プロパティにバインドします。コントロールのDiagram プロパティはx 軸とy 軸をカラム名として定義します。
using (APIConnection connection = new APIConnection(
"Profile=C:\profiles\Postmark.apip;AuthScheme=APIKey;ProfileSettings="APIKey=your-server-api-token"")) {
APIDataAdapter dataAdapter = new APIDataAdapter(
"SELECT , FROM Bounces WHERE = ''", connection);
DataTable table = new DataTable();
dataAdapter.Fill(table);
DevExpress.XtraCharts.Series series = new DevExpress.XtraCharts.Series();
chartControl1.Series.Add(series);
DataTable table = new DataTable();
series.ValueDataMembers.AddRange(new string[] { "" });
series.ArgumentScaleType = DevExpress.XtraCharts.ScaleType.Qualitative;
series.ArgumentDataMember = "";
series.ValueScaleType = DevExpress.XtraCharts.ScaleType.Numerical;
chartControl1.Legend.Visibility = DevExpress.Utils.DefaultBoolean.False;
((DevExpress.XtraCharts.SideBySideBarSeriesView)series.View).ColorEach = true;
}
Web コントロール
下のコードではPostmark でDevExpress Web を操作するための設定方法を説明します。APIDataAdapter はチャートのSeries プロパティにバインドします。Diagram プロパティはx 軸とy 軸をカラム名として定義します。
using DevExpress.XtraCharts;
using (APIConnection connection = new APIConnection(
"Profile=C:\profiles\Postmark.apip;AuthScheme=APIKey;ProfileSettings="APIKey=your-server-api-token""))
{
APIDataAdapter APIDataAdapter1 = new APIDataAdapter("SELECT , FROM Bounces WHERE = ''", connection);
DataTable table = new DataTable();
APIDataAdapter1.Fill(table);
DevExpress.XtraCharts.Series series = new Series("Series1", ViewType.Bar);
WebChartControl1.Series.Add(series);
DataTable table = new DataTable();
series.ValueDataMembers.AddRange(new string[] { "" });
series.ArgumentScaleType = ScaleType.Qualitative;
series.ArgumentDataMember = "";
series.ValueScaleType = ScaleType.Numerical;
((DevExpress.XtraCharts.SideBySideBarSeriesView)series.View).ColorEach = true;
}