P006-色付き表示をライブラリ化

今日の目標→

前回は、「色付き文字を出力するメソッド」を作った。使ってみたら結構便利なので、他のプログラムからでも利用できるように、これをライブラリ化してみる。

●プロジェクトの作成

とりあえず「TextWork3」という名前で、新規プロジェクトを作る

●色付き文字表示用クラスRichReporterの作成

1. メニューバーから「プロジェクト」→「クラスの追加」を選ぶとクラス追加ウィンドウが開く
2. 左のカテゴリで「コード」を選び、右のアイコンから「クラス」を選ぶ
3. 名前を「RichReporter.cs」として「追加」を押すと、新しいコードウィンドウが開く
4. 次のコードを入力する

// RichReporter.cs using System.Drawing; using System.Windows.Forms; namespace TextWork3 { // リッチテキストボックスに色付き文字表示するクラス public class RichReporter { // 出力先のリッチテキストボックス private RichTextBox MyTextBox; // コンストラクタ：引数で出力先を指定する public RichReporter(RichTextBox target) { MyTextBox = target; } // 色なしのテキスト表示 public void Print(string text) { // デフォルトの文字色で表示する ColorPrint(MyTextBox.ForeColor, text); } // 色付きのテキスト表示 public void ColorPrint(Color textColor, string text) { // テキストを末尾に追加する AddText(textColor, text); // 20行を超えたら先頭行から削除する CheckLines(20); // もし必要なら末尾までスクロールする ScrollToEnd(); } // リッチテキストボックスの末尾に色付きのテキストを追加する private void AddText(Color textColor, string text) { // 文書データの末尾を選択する MyTextBox.Select(MyTextBox.TextLength, 0); // 文字の色を指定する if (MyTextBox.SelectionColor != textColor) { MyTextBox.SelectionColor = textColor; } // テキストを追加する MyTextBox.AppendText(text); } // リッチテキストボックスの行数がmaxLinesを超えないようチェックする private void CheckLines(int maxLines) { // 全体の行数を得る int nLines = MyTextBox.GetLineFromCharIndex(MyTextBox.TextLength); if (nLines > maxLines) { // 余分な行数を得る int delLines = nLines - maxLines; // 余分な文字数を得る int delChars = MyTextBox.GetFirstCharIndexFromLine(delLines); // 余分な文字を先頭から削除する MyTextBox.Select(0, delChars); MyTextBox.SelectedText = ""; } } // 末尾の文字が見える位置まで、リッチテキストボックスをスクロールする private void ScrollToEnd() { // 文書データの末尾を選択する MyTextBox.Select(MyTextBox.TextLength, 0); // 選択位置までスクロールする MyTextBox.ScrollToCaret(); } } }

メソッドの中身は、前回（TextWork2）のForm1.csとまったく変わらないので、ほとんどコピペでいけるはず。ただしPrint()とColorPrint()は公開メソッドにするので、private宣言をpublicに修正してちょ。

●フォームからRichReporterクラスを利用する

1. Form1.csを開く
2. 次のコードを入力する

// Form1.cs using System; using System.Drawing; using System.Windows.Forms; namespace TextWork3 { public partial class Form1 : Form { // コントロール private RichTextBox MyTextBox; private Button MyStartButton; private RichReporter MyReporter; // フォームのコンストラクタ public Form1() { InitializeComponent(); // タイトルバーにプログラム名を表示する this.Text = Application.ProductName; // リッチテキストボックスを作る MyTextBox = new RichTextBox(); MyTextBox.Name = "MyTextBox"; MyTextBox.Anchor = AnchorStyles.Left | AnchorStyles.Right | AnchorStyles.Top | AnchorStyles.Bottom; MyTextBox.Left = 4; MyTextBox.Top = 4; MyTextBox.Width = this.ClientSize.Width - 8; MyTextBox.Height = this.ClientSize.Height - 36; MyTextBox.Font = new Font("ＭＳ ゴシック", 12, FontStyle.Bold); // 開始ボタンを作る MyStartButton = new Button(); MyStartButton.Name = "MyStartButton"; MyStartButton.Anchor = AnchorStyles.Left | AnchorStyles.Bottom; MyStartButton.Left = 4; MyStartButton.Top = this.ClientSize.Height - 28; MyStartButton.Width = 100; MyStartButton.Height = 24; MyStartButton.Text = "開始(&S)"; MyStartButton.Click += MyStartButton_Click; // コントロールをフォームに配置する this.SuspendLayout(); this.Controls.Add(MyTextBox); this.Controls.Add(MyStartButton); this.ResumeLayout(); // 文字出力用のオブジェクトを作る MyReporter = new RichReporter(MyTextBox); } // 「開始(S)」ボタンのクリック private void MyStartButton_Click(object sender, EventArgs e) { MyReporter.Print("開始ボタンを"); MyReporter.ColorPrint(Color.Red, "押しましたね？\n"); } } }

RichReporterクラスの使い方は、まず

MyReporter = new RichReporter(MyTextBox);

のように、出力先を指定してRichReporterのオブジェクトを作る。そして、

MyReporter.ColorPrint(Color.Red, "ほげほげ");

みたいな形でメソッドを呼び出せば、指定した出力先にテキストが表示されるという寸法だ。ね、簡単でしょう？（反語表現）

●次回の予告

次回はこのRichRepoterライブラリを、ソースコードのままリンクして利用する方法と、DLL化して利用する方法について説明する。