P005-文字を色付きで表示

今日の目標→

文字に色を付けたり、行をスクロールさせるなど、RichTextBoxを使ったテキスト表示のテクニックを探る。

●プロジェクトの作成

1. 「TextWork2」という名前で、新規プロジェクトを作る
2. Form1.csのコードを開き、前回（TextWork）のForm1.csのコードをコピペする
3. コードを次のように修正する。

using System; using System.Drawing; using System.Windows.Forms; namespace TextWork2 { public partial class Form1 : Form { // コントロール private RichTextBox MyTextBox; private Button MyStartButton; private Button MyEndButton; private Timer MyTimer; private int MyCounter; // フォームのコンストラクタ 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; // 停止ボタンを作る MyEndButton = new Button(); MyEndButton.Name = "MyEndButton"; MyEndButton.Anchor = AnchorStyles.Left | AnchorStyles.Bottom; MyEndButton.Left = MyStartButton.Right + 4; MyEndButton.Top = MyStartButton.Top; MyEndButton.Width = 100; MyEndButton.Height = 24; MyEndButton.Text = "停止(&E)"; MyEndButton.Click += MyEndButton_Click; // コントロールをフォームに配置する this.SuspendLayout(); this.Controls.Add(MyTextBox); this.Controls.Add(MyStartButton); this.Controls.Add(MyEndButton); this.ResumeLayout(); // タイマーを作る MyTimer = new Timer(); MyTimer.Tick += MyTimer_Tick; } // 「開始(S)」ボタンのクリック private void MyStartButton_Click(object sender, EventArgs e) { if (!MyTimer.Enabled) { // 開始メッセージ表示 ColorPrint(Color.Red, "タイマー処理を"); ColorPrint(Color.Blue, "開始します。\n"); // カウンタをゼロリセット MyCounter = 0; // 周期250ミリ秒（0.25秒）でタイマー処理を開始 MyTimer.Interval = 250; MyTimer.Start(); } } // 「停止(E)」ボタンのクリック private void MyEndButton_Click(object sender, EventArgs e) { if (MyTimer.Enabled) { // タイマー処理を停止 MyTimer.Stop(); // 停止メッセージ表示 ColorPrint(Color.Blue, "タイマー処理を"); ColorPrint(Color.Red, "停止しました。\n"); } } // タイマー周期ごとの処理 private void MyTimer_Tick(object sender, EventArgs e) { // カウンター値と現在時刻を表示する string text = string.Format("{0}: {1}\n", ++MyCounter, DateTime.Now); Print(text); } // 色なしのテキスト表示 private void Print(string text) { // デフォルトの文字色で表示する ColorPrint(MyTextBox.ForeColor, text); } // 色付きのテキスト表示 private 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(); } } }

これも「開始(S)」ボタンで表示が始まり、「停止(E)」ボタンで止まる。見どころは次の3つ。

• 開始と停止メッセージに色がついている
• 文字表示が最下部に達するとスクロールする
• 行数が20行を超えると先頭行から順に消えていく

（実行画面が入る予定）

●文字に色

RichTextBoxで、文字に色を付ける方法は2つある。

(A) すでに表示されている文字の色を変えるには

1. Select()メソッドで、色を変えたい文字範囲を選択
2. SelectionColorプロパティで、その範囲の色を設定

(B) これから表示する文字の色を変えるには

1. Select()メソッドで、テキスト末尾の「長さ0の範囲」を選択
2. SelectionColorプロパティで、文字色を設定
3. この状態でAppendText()メソッドを実行すると文字に色がつく

今回はAddText()の定義の中で(B)の方法を使っているので見てみてね。

●余分な行を削除

行の削除にはコツがある。というのも、RichTextBoxの操作は基本的にキャラクタ単位で行うため、行単位の操作は面倒なのだ。そこで次の2つのメソッドの出番となる。

• GetLineFromCharIndex() -- 文字の位置から行番号を得る
• GetFirstCharIndexFromLine() -- 行番号からその行の先頭の文字位置を返す

今回はCheckLines()の定義の中でこれらを使っている。

●最下行までスクロール

RichTextBoxにはScrollToCaret()メソッドというものがあって、キャレットが見える位置までウィンドウをスクロールできる。キャレットというのは、文字入力の位置でチカチカ点滅している線のことだ。文字カーソルともいう。

キャレットを移動するには、Select()メソッドで、任意の文字位置に「長さ0の範囲」を指定すればよい。

今回はScrollToEnd()の定義の中でこの方法を使っている。

以上、とても駆け足の説明でした。まあ、詳しいことはコードを読んでください。

●今日から投稿は丑三つ時に

今後の投稿ペースですが、できれば毎日1記事を目指します。 もちろん全部プログラムネタは無理っぽいので、ただの独り言の場合もあります。

投稿時刻はブログの設定で毎回午前2:00に統一しようと思います。あまりバラバラな投稿時刻だと、どんな生活リズムだと思われそうで恥ずかしいから…。