C#

C# サブスレッドからフォームの表示を行う(Invoke)

投稿日:

C#でスレッドを生成して、処理を行うとその処理状態やデータなどをフォーム上に表示したくなります。

サブスレッドからフォームに表示しようとしてみる

下記のコードは、スレッドを生成してサブスレッドでカウントアップしたカウンタをフォームに表示しようとするコードです。

    public partial class Form1 : Form
    {
        Thread thread;
  
        public Form1()
        {
            InitializeComponent();
        }

        private void Form1_Load(object sender, EventArgs e)
        {
            //
            count = 0;
            label1.Text = "";
            // スレッドを生成して開始する
            thread = new Thread(new ThreadStart(ThreadProc));
            thread.Start();
            UpdateText();
        }

        private void btnExit_Click(object sender, EventArgs e)
        {
            // サブスレッドは終了させる
            thread.Abort();
            thread.Join();
            // フォームを閉じてプログラムを終了します
            this.Close();
        }

        private int count;

        private void UpdateText()
        {
            label1.Text = string.Format("{0}", count);
        }

        private void ThreadProc()
        {
            // サブスレッドの処理
            while(true)
            {
                // カウンタの値をフォームに表示する
                UpdateText();

                count++;
                if(count >= int.MaxValue)
                {
                    count = int.MinValue;
                }
                System.Threading.Thread.Sleep(20);
            }
        }
    }

ですが、このコードはビルドできて実行すると起動するのですが、サブスレッドからUpdateText()というメソッドを呼んだ途端にInvalidOperationExceptionという例外が発生して動かなくなります。
フォームのクラス(UpdateText()はForm1クラス)メンバなので、普通に動いてもよさそうですが、実際には動いてくれません。

理由は、このUpdateText()というメソッドを呼ぶ「スレッド」が異なるからです。
(ですので、このUpdateText()はフォームを表示しているスレッドで呼び出すと普通に動作します)

ですが、このプログラムの場合、サブスレッドで値を変更しているので、サブスレッドから画面表示を呼びたいところです。

サブスレッドから画面表示ができるようにする

実は「フォームを表示しているスレッド以外のスレッドからフォーム(コントロール)の操作ができない」のではなく、「フォームを表示しているスレッド以外のスレッドからフォーム(コントロール)の操作をするときのための手順が必要」なのです。

ControlクラスのメンバにInvokeメソッドと呼ばれるメソッドがあり、このメソッド経由で呼び出すことでフォームを表示しているスレッド以外のスレッドからフォーム(コントロール)の操作を行うことが可能になります。

    public partial class Form1 : Form
    {
        Thread thread;
  
        public Form1()
        {
            InitializeComponent();
        }

        private void Form1_Load(object sender, EventArgs e)
        {
            //
            count = 0;
            label1.Text = "";
            // スレッドを生成して開始する
            thread = new Thread(new ThreadStart(ThreadProc));
            thread.Start();
            UpdateText();
        }

        private void btnExit_Click(object sender, EventArgs e)
        {
            // サブスレッドは終了させる
            thread.Abort();
            thread.Join();
            // フォームを閉じてプログラムを終了します
            this.Close();
        }

        private int count;

        public delegate void DelegateUpdateText();

        private void OnUpdateText()
        {
            label1.Text = string.Format("{0}", count);
        }

        private void UpdateText()
        {
            //label1.Text = string.Format("{0}", count);
            this.Invoke(new DelegateUpdateText(this.OnUpdateText));
        }

        private void ThreadProc()
        {
            // サブスレッドの処理
            while(true)
            {
                // カウンタの値をフォームに表示する
                UpdateText();

                count++;
                if(count >= int.MaxValue)
                {
                    count = int.MinValue;
                }
                System.Threading.Thread.Sleep(20);
            }
        }
    }

確かに動くのですが、「Invokeを呼び出すだけのメソッドがある。」というはちょっと気になります。
(実際、フォームを表示しているスレッドから呼び出したときは、Invokeメソッドを使う必要はありません)

 

複数のスレッドから一つのメソッドで画面表示ができるようにする

できることならこの2つのスレッドから画面表示を行うメソッドは1か所で、Invokeを呼ぶためだけのメソッドが存在するというのは避けたいところです。

これを実現するには、

  • フォームを表示しているスレッド以外から呼び出されたらInvokeで処理する
  • フォームを表示しているスレッドであればそのまま画面表示処理を行う

という実装に変更します。

下記のようになりました。

    public partial class Form1 : Form
    {
        Thread thread;
  
        public Form1()
        {
            InitializeComponent();
        }

        private void Form1_Load(object sender, EventArgs e)
        {
            //
            count = 0;
            label1.Text = "";
            // スレッドを生成して開始する
            thread = new Thread(new ThreadStart(ThreadProc));
            thread.Start();
            UpdateText();
        }

        private void btnExit_Click(object sender, EventArgs e)
        {
            // サブスレッドは終了させる
            thread.Abort();
            thread.Join();
            // フォームを閉じてプログラムを終了します
            this.Close();
        }

        private int count;

        public delegate void DelegateUpdateText();

        private void UpdateText()
        {
            //label1.Text = string.Format("{0}", count);
            if(this.InvokeRequired)
            {
                this.Invoke(new DelegateUpdateText(this.UpdateText));
                return;
            }
            label1.Text = string.Format("{0}", count);
        }

        private void ThreadProc()
        {
            // サブスレッドの処理
            while(true)
            {
                // カウンタの値をフォームに表示する
                UpdateText();

                count++;
                if(count >= int.MaxValue)
                {
                    count = int.MinValue;
                }
                System.Threading.Thread.Sleep(20);
            }
        }
    }

 

-C#
-, , , ,

Copyright© プログラミングテクニック集キヤミー , 2020 All Rights Reserved.