タイマにより一定時間間隔で処理を行うには？（Windowsタイマ編）：.NET TIPS

Windowsフォームアプリでは、System.Windows.Forms.Timerクラス（Timerコンポーネント）を使うことで、一定間隔で処理を実行できるようになる。

» 2018年11月07日 05時00分公開

[遠藤孝信, 山本康彦，共著]

連載「.NET TIPS」

本稿は2005/11/11に初版公開された記事を改訂し、Visual Studio 2017でコードの動作検証、図版の追加、全般的な構成の変更などを行ったものです。

　.NET Frameworkには一定時間間隔で処理を行う（メソッドを呼び出す）ためのタイマ機能として、以下の3種類のTimerクラスが用意されている。

Windowsタイマ：System.Windows.Forms.Timerクラス
スレッドタイマ：System.Threading.Timeクラス（解説TIPSへ）
サーバベースタイマ：System.Timers.Timerクラス（解説TIPSへ）

　本稿では1のWindowsタイマについて、その基本的な使い方をまとめる。

POINT　Windowsタイマの使い方

Windowsタイマの使い方まとめ

　特定のトピックをすぐに知りたいという方は以下のリンクを活用してほしい。

Windowsタイマ：System.Windows.Forms.Timerクラス
Windowsフォームの場合
Windowsタイマを利用するときの注意点

Windowsタイマ：System.Windows.Forms.Timerクラス

　Windowsアプリ（Windowsフォームアプリ）でタイマを利用したい場合には、通常System.Windows.Forms名前空間のTimerクラスを利用する。

　このタイマはWindows OSのタイマメッセージ（WM_TIMERメッセージ）をベースにしており、タイマを利用するにはメッセージループの実行が必要である（一般的なWindowsフォームアプリはApplication.Runメソッドの呼び出しを含んでおり、このメソッドによりメッセージループが実行される）。

　このTimerクラスでは、EventHandlerデリゲート（System名前空間）を使用して、タイマにより呼び出されるメソッド（以下、タイマメソッドと記す）のデリゲートを作成し、TimerクラスのTickイベントに登録する。

　タイマメソッドの呼び出し間隔はIntervalプロパティにより設定し（単位はミリ秒）、タイマの開始／停止は、Enabledプロパティにtrue／falseを設定して行う（あるいはStart／Stopメソッドを呼び出してもよい）。

　以下にWindowsタイマを使用したサンプルプログラムを示す。このプログラムではTimerクラスに関する記述を分かりやすくするために、コンソールアプリとして記述している。MyClockメソッドがタイマにより一定間隔で実行されるメソッドである。Visual StudioでC#／VBのコンソールアプリプロジェクトを新規に作成して、以下のコードを試す場合には、System.Windows.Formsアセンブリへの参照をプロジェクトに追加する必要がある。また、VBではソリューションエクスプローラーの［My Project］をダブルクリックして、［アプリケーション］タブにある［スタートアップオブジェクト］に［Sub Main］か［FormsTimerTest］に変更する必要がある。

// formstimer.cs

using System;
using System.Windows.Forms;

public class FormsTimerTest {

static void Main() {
    FormsTimerTest ftt = new FormsTimerTest();
    ftt.Run();
}

public void Run() {
    Timer timer = new Timer();
    timer.Tick += new EventHandler(MyClock);
    timer.Interval = 1000;
    timer.Enabled = true; // timer.Start()と同じ

    Application.Run(); // メッセージループを開始
}

public void MyClock(object sender, EventArgs e) {
    Console.WriteLine(DateTime.Now);
    // 出力例：
    // 2005/11/08 19:59:10
    // 2005/11/08 19:59:11
    // 2005/11/08 19:59:12
    // ……
}
}

// コンパイル方法：csc formstimer.cs

' formstimer.vb

Imports System
Imports System.Windows.Forms

Public Class FormsTimerTest

Shared Sub Main()
    Dim ftt As FormsTimerTest = New FormsTimerTest()
    ftt.Run()
End Sub

Public Sub Run()
    Dim timer As Timer = New Timer()
    AddHandler timer.Tick, New EventHandler(AddressOf MyClock)
    timer.Interval = 1000
    timer.Enabled = true ' timer.Start()と同じ

    Application.Run() ' メッセージループを開始
End Sub

Public Sub MyClock(sender As Object, e As EventArgs)
    Console.WriteLine(DateTime.Now)
    ' 出力例：
    ' 2005/11/08 19:59:10
    ' 2005/11/08 19:59:11
    ' 2005/11/08 19:59:12
    ' ……
End Sub
End Class

' コンパイル方法：vbc formstimer.vb

Windowsタイマを使用したサンプルプログラム
C#版サンプルプログラムのダウンロード
VB版サンプルプログラムのダウンロード

Windowsフォームの場合

　Visual Studioでプログラミングしている場合には、ツールボックスの［すべての Windows フォーム］タブからTimerコンポーネントをフォームにドラッグ＆ドロップするだけでタイマが利用可能な状態となる（次の画像）。配置したTimerコンポーネントをダブルクリックすれば、タイマメソッド（Tickイベントハンドラ）が自動的に作成される。