ASP.NETでファイルをダウンロードするボタン

クリックするとファイルをダウンロードするボタンを作りました。
主な機能は以下のとおりです。

• クリックするとFileプロパティにセットされたファイルをダウンロードする
• FileプロパティはClickイベントやDownloadingイベントでセットすることもできる
• Downloadedイベントで動的に作成したファイルを削除することもできる

使用するには、以下の手順に従います。

1. FileDownloadButtonをプロジェクトに追加する
2. FileDownloadButtonをツールボックスへ追加する
   参考: 方法 : Visual Studio でカスタム ASP.NET サーバー コントロールを使用するの「カスタム コントロールをツールボックスに追加するには」
3. *.aspxへFileDownloadButtonを配置し、イベントハンドラを設定する
   例:

   <cc1:FileDownloadButton ID="FileDownloadButton1" runat="server"
                           Text="Download"
                           OnDownloading="FileDownloadButton1_Downloading"
                           OnDownloaded="FileDownloadButton1_Downloaded"/>
   

4. *.csでイベントハンドラを実装する
   例:

           protected void FileDownloadButton1_Downloading(object sender, EventArgs e)
           {
               // Tempファイルを作成する
               var path = Path.GetTempFileName();
               var file = new FileInfo(path);
   
               // Tempファイルへデータを出力する
               using (var s = file.OpenWrite())
               using (var w = new StreamWriter(s))
               {
                   w.WriteLine("Hello");
                   w.Flush();
               }
   
               // FileDownloadButtonのFileプロパティへTempファイルをセットする
               FileDownloadButton1.File = file;
           }
   
           protected void FileDownloadButton1_Downloaded(object sender, EventArgs e)
           {
               // Tempファイルを削除する
               FileDownloadButton1.File.Delete();
           }
   

Content-Typeの設定やレスポンスの呼び出しなど、低レベルな処理をカプセル化できるので、導入のメリットはそこそこあると思います。よろしければご利用ください。

以下、FileDownloadButtonのソースです。

ASP.NETで動的に画像を生成して返す(IHttpHandler版)

ASP.NETで動的に画像を生成して返すようなときは、WebFormを使用するのが一般的なようです。

• ［ASP.NET］任意の画像を出力してブラウザで表示するには？［C#、VB］
• Dynamic Image Generation with ASP.Net

この記事ではIHttpHandlerインターフェイスを実装して画像を生成して返す方法を紹介します。
以下２つの手順に従います。

1. IHttpHandlerインターフェイスを実装した画像を出力するクラスを実装する
2. 1のクラスをweb.configファイルへ登録する

まず「IHttpHandlerインターフェイスを実装した画像を出力するクラスを実装する」について説明します。このクラスのポイントは3つあります。

1. IHttpHandlerインターフェイスを実装すること
2. 画像のバイナリデータをHTTPレスポンスへ出力すること
3. Content-Typeヘッダを適切に設定すること

次のサンプルプログラム(一部)をご覧ください。

namespace HttpHandlerSample
{
    // 動的にPNG画像を生成するクラス
    public class PngHandler : IHttpHandler
    {
        // このオブジェクトが再利用可能かを返すプロパティ
        public bool IsReusable
        {
            get
            {
                return true;
            }
        }

        // ...略...

        // HTTPリクエストを処理するメソッド
        public void ProcessRequest(HttpContext context)
        {
            // 画像を生成する
            using (var image = GenerateImage())
            {
                // PNG形式でHTTPレスポンスへ出力する
                var output = context.Response.OutputStream;
                image.Save(output, ImageFormat.Png);
                output.Flush();
            }

            // Content-TypeヘッダをPNG形式に設定する
            context.Response.ContentType = "image/png";
        }

        // ...略...

    }
}

IHttpHandlerにはIsReusableプロパティとProcessRequestメソッドが定義されています。このProcessRequestメソッドを実装することで機能を実現します。
画像のバイナリデータを出力するには、Image#Saveメソッドを使用します。
Content-Typeヘッダを指定するには、HttpResponse#ContentTypeプロパティを使用します。画像の形式が一致するように設定します。

次に、上のクラスをweb.configへ以下のように設定します。

<configuration>
  <system.webServer>
    <handlers>
      <add name="PngHandler" path="*.png" verb="GET" type="HttpHandlerSample.PngHandler"/>
    </handlers>
  </system.webServer>
</configuration>

ちなみに

以上で動的な画像の生成が実現できます。
以下、サンプルコード全体です。

ASP.NET開発を始めるにあたって参考にした記事3つ

ASP.NETアプリケーション開発に取り組んで1ヶ月になりました。
開発も終盤にさしかかってきたので、忘れないうちに開発スタート時に参考にした記事を3つ紹介します。

@IT　プログラミングASP.NET
ASP.NETについて、基本から解説してあります。（連載なので、正確には1記事ではないかも）
全体を把握するのにおすすめです。特に重要だと感じたキーワードを挙げておきます。

• ポストバック
• ビューステート
• データバインド

ASP.NET Page Life Cycle Overview
ASP.NETプログラミングの特徴のひとつに、イベントドリブン方式で実装することがあります。この特徴を活用するには、イベントの順番を把握しなければなりません。この記事ではそれが紹介されています。
今回のプロジェクトで主に使用したイベントと、用途を紹介します。

• Page_Init…ページやコントロールのフィールドを初期化する。オブジェクトをセッションから取得するなど。
• Page_Load…コントロールの初期化をする。ドロップダウンリストの項目をセットするなど。
• Button_Click…ユーザーの入力値を受け取る。入力値をもとに業務ロジックを呼び出して結果を受け取る。
• Page_PreRender…業務ロジックの結果をコントロールへ反映する。

ASP.NET Application Life Cycle Overview for IIS 7.0
上で紹介したライフサイクルよりも、大きなサイクルについての記事です。アプリケーションやセッションの初期処理を組み込もうとするときに参考になります。

これまで食わず嫌いでASP.NETには手をつけてこなかったのですが、実際に開発をしてみるとすんなり進められました。今後は、ASP.NET案件にも積極的に取り組んでいこうと思います。

ASP.NETでJavaScriptからポストバックを発生させる方法

ASP.NETアプリケーションをコーディングしていて、JavaScriptからポストバックしたいというケースがあります。例えば、検索結果の一覧をテーブルで表示しており、任意のセルをクリックした時に詳細を表示する画面へ遷移するケースなどです。

こういう状況に対応できるのが、次のクラスとインターフェイスです。

• ClientScriptManager
• IPostBackEventHandler

まず、JavaScriptのイベントハンドラに対して、ClientScriptManager.GetPostBackEventReferenceで取得した文字列を呼び出すように実装します。このとき、引数として渡した文字列が、次で実装するポストバックイベントハンドラの引数になります。ClientScriptManagerオブジェクトは、Page.ClientScriptから取得できます。

class MyPage : Page {

     protected void Page_PreRender(object sender, EventArgs e) {
         var args = "xxx"; // 例えば、詳細情報を表示するためのプライマリキー
         var js = ClientScript.GetPostBackEventReference(this, args);
         Table1.Rows[0].Cells[0].Attributes.Add("onclick", js);
     }

}

次に、ポストバックを受けるクラスが、IPostBackEventHandler.RaisePostBackEventを実装します。

// 上のクラスへIPostBackEventHandlerを実装
class MyPage : Page, IPostBackEventHandler { 
    ...
    public void RaisePostBackEvent(string eventArgs) {
        // 例えばセッションへeventArgsをセットして詳細ページへ遷移する
        Session.Add("key", eventArgs);
        var detail = ResolveUrl("~/MyDetailPage.aspx");
        Server.Transfer(detail);
    }
}

以上でJavaScriptからのポストバックが機能します。私が最初に思いついたのは、CSSで非表示にしたボタンをJavaScriptからクリックするという方法でした。しかし、こちらのほうが何倍もスマートだと思います。

ClientScriptManagerには、他にも様々なメソッドがあります。まだまだ便利な機能がありそうです。

参考：

ClientScriptManager
IPostBackEventHandler

ASP.NETアプリケーションの起動時にWeb.configファイルを読み込むには

ASP.NETアプリケーションの起動時に設定ファイルを読み込み、システムの初期設定をしたいというケースがあると重います。

設定ファイルを読み込むための、WebConfigurationManager.OpenWebConfigurationメソッドには、引数として設定ファイルの仮想パスが必要です。仮想パスの取得方法として、ASP.NET Web プロジェクトの仮想パスに手順が記載されていますが、アプリケーションの起動時には適用できません。なぜなら、紹介されている方法ではHttpRequestクラスを使用するのですが、アプリケーション起動時には、HttpRequestオブジェクトが使える状態にないからです。

そこで、代わりに使用するのが、HttpRuntimeクラスです。このクラスの、AppDomainVirtualPathプロパティから、アプリケーションの仮想パスを取得できるので、あとはファイル名を結合するだけです。結合には、VirtualPathUtilityクラスを使うとベターでしょう。

var path = VirtualPathUtility.Combine(HttpRuntime.AppDomainVirtualPath,
                                      "Web.config");
var conf = WebConfigurationManager.OpenWebConfiguration(path);

仮想パスをいい加減に扱うと、サーバーへインストールしたら動かなくなることがあります。HttpRuntimeクラスを使い、環境の変化に強いコードを書きましょう。