Userコントロール

Size: px

Start display at page:

Download "Userコントロール"

あきひさすえがら
4 years ago
Views:

1 User コントロール初めてのユーザーコントロールの作成作成したクラスは他のプログラムで再利用出来る為同じコードを何度も繰り返し作成する必要が無いコントロールも複数のプロジェクトで再利用出来るクラスで有る同じユーザーインターフェイスを何度も繰り返してデザインすると謂う経験は恐らく誰でも有る例えば姓と名を入力する為の TextBox コントロールを追加した後で両方を組み合わせてフルネームを作成するコードを追加する等の作業で有る然うした余分な手間を省く事が出来れば楽に成る其の様な場合にはユーザーコントロールを利用出来るユーザーコントロールとは可視のオブジェクトを作成する為のクラスだと考える事が出来る詰まり Visual Basic 2005 に標準装備されて居るコントロールと同様に再利用出来る独自のカスタムコントロールで有る大半のユーザーコントロールは複合コントロールで有る詰まり 1 つ又は複数の Visual Basic 2005 標準コントロールで構成されるコントロールで有る以降の資料では他のプログラムで再利用出来る複合ユーザーコントロールを作成する方法を説明するユーザーコントロールデザイナに付いて此の資料ではユーザーコントロールデザイナを使用して独自のコントロールを作成する方法に付いて説明するユーザーコントロールとは画面に表示されるクラスに過ぎないユーザーコントロールは Visual Basic 2005 に用意されて居る標準コントロールと全く同様にデザイン時にフォーム上に配置出来プログラムの実行時に表示されるプログラムをデザインする時にコントロールを配置して其の見た目を決定する場所がフォームデザイナで有る亦ユーザーコントロール用のデザイナも有る其れがユーザーコントロールデザイナで有る開発者は此れを使用してコントロールの見た目を決定出来るユーザーコントロールの作成ユーザーコントロールは他のクラスと似て居るがツールボックスに配置出来フォーム上に表示出来ると謂う追加的な機能を持つクラスモジュールにはコードしか無いのに対しユーザーコントロールモジュールにはコードとデザイナの両方が有るユーザーコントロールデザイナはフォームデザイナと似て居りユーザーコントロールの外観と動作を制御する為のプロパティを持つユーザーコントロールを作成する方法は使用して居る Visual Basic のバージョンに依り多少異なる Visual Basic 2005 の場合は Windows コントロールライブラリと謂うプロジェクトの種類が有るのに対し Visual Basic Express Edition の場合は先ずクラスライブラリプロジェクトを作成してからユーザーコントロールテンプレートを追加する必要が有る Visual Basic Express Edition を使用してユーザーコントロールを作成するには 1.[ ファイル ] メニューの [ 新規作成 ] をポイントし [ プロジェクト ] をクリックする -1-

2 2.[ 新しいプロジェクト ] ダイアログボックスの [ テンプレート ] ペインで [ クラスライブラリ ] をクリックし [OK] をクリックする 3.[ プロジェクト ] メニューの [ ユーザーコントロールの追加 ] をクリックする 4.[ 新しい項目の追加 ] ダイアログボックスで [ ユーザーコントロール ] をクリックする 5.[ ファイル名 ] ボックスに NamesControl と入力し [ 追加 ] をクリックする新しいユーザーコントロールテンプレートがプロジェクトに追加されユーザーコントロールデザイナが開く 6. ソリューションエクスプローラで Class1.vb を右クリックし [ 削除 ] をクリックして [OK] をクリックする 7.[ ファイル ] メニューの [ 総てを保存 ] をクリックする 8.[ プロジェクトの保存 ] ダイアログボックスで NamesUserControl と入力し [ 保存 ] をクリックする Visual Studio 2005 を使用してユーザーコントロールを作成するには 1.[ ファイル ] メニューの [ 新規作成 ] をポイントし [ プロジェクト ] をクリックする 2.[ 新しいプロジェクト ] ダイアログボックスの [ テンプレート ] ペインで [Windows コントロールライブラリ ] をクリックする 3.[ プロジェクト名 ] ボックスに NamesControl と入力し [OK] をクリックする新しいユーザーコントロールテンプレートがプロジェクトに追加されユーザーコントロールデザイナが開く 4.[ ファイル ] メニューの [ 総てを保存 ] をクリックする 5.[ プロジェクトの保存 ] ダイアログボックスで NamesUserControl と入力し [ 保存 ] をクリックするユーザーコントロールへのコントロールの追加此の資料ではコントロールを追加して複合ユーザーコントロールを作成する方法を説明するユーザーコントロールのデザイン先にも述べた様にユーザーコントロールの大多数が複合コントロール詰まり 1 つ以上の標準 Windows フォームコントロールを組み合わせたコントロールで有るコントロールはフォームをデザインする場合と同様ツールボックスからユーザーコントロールデザイナにドラッグする事に依ってユーザーコントロールテンプレートに追加出来るコントロールを追加したらデザイナでサイズ変更や移動を行ったり [ プロパティ ] ウィンドウでプロパティを設定したり出来る例えば Label コントロールを追加してフルネームを表示し 3 つの TextBox コントロールを追加して -2-

3 ファーストネームラストネーム及びミドルネームを表示する事が可能で有るユーザーコントロールにコントロールを追加するには 1. 前の項で作成した NamesUserControl プロジェクトを開くプロジェクトを保存しなかった場合は先ず前の項ユーザーコントロールデザイナに付いてに戻って其の項の手順を完了する必要が有る 2. ソリューションエクスプローラの NamesControl.vb をクリックし [ 表示 ] メニューの [ デザイナ ] をクリックする 3. ツールボックスからデザイナに Label コントロールをドラッグするヒント : ウィンドウを開いた儘に仕て居る場合はツールボックスを使用する方が簡単で有る此れは押しピンの様に表示されて居る [ 自動的に隠す ] アイコンをクリックする事で実行出来る 4.[ プロパティ ] ウィンドウで Name プロパティを FullName に変更する 5. ツールボックスからデザイナに 3 つの Textbox コントロールをドラッグするコントロールを好きな位置に配置して良い 6.[ プロパティ ] ウィンドウで Name プロパティを FirstName MiddleName 及び LastName に変更する 7.[ ファイル ] メニューの [ 総てを保存 ] をクリックして変更を保存するユーザーコントロールへのコードの追加此の資料ではユーザーコントロールにコードを追加してフルネームの表示と新しいプロパティの公開を行う方法に付いて説明するユーザーコントロールにも標準コントロールと同じ様にプロパティメソッド及びイベントが有るコントロールのイベントを処理するコードの記述やコントロールのユーザーに何のプロパティを公開するかの判断はコントロールの開発者が行うユーザーコントロールのイベント処理ユーザーコントロールの利便性を高める為にはコントロールのイベントを処理するコードを記述する必要が有るユーザーコントロールのイベント処理プロシージャを記述するのはフォームやコントロールのイベント処理プロシージャを記述するのと変わらない此の例では TextChanged イベントハンドラを使用して FirstName MiddleName 及び LastName の各ボックスへの入力時に其の内容で FullName ラベルを更新するイベントプロシージャを記述するユーザーコントロールにコードを追加するには 1. 前の項で作成した NamesUserControl プロジェクトを開くプロジェクトを保存しなかった場合は先ず前の項ユーザーコントロールデザイナに付いてに戻って其の項の手順を完了する -3-

4 必要が有る 2. ソリューションエクスプローラの NamesControl.vb をクリックし [ 表示 ] メニューの [ コード ] をクリックする 3. コードエディタで FirstName_TextChanged イベントハンドラに次のコードを追加する Private Sub FirstName_TextChanged( _ ByVal sender As System.Object, ByVal e As System.EventArgs) _ Handles FirstName.TextChanged, MiddleName.TextChanged, LastName.TextChanged ' 3 個のテキストボックスの内容をラベルに表示 FullName.Text = FirstName.Text & " " & MiddleName.Text & " " & LastName.Text End Sub 4.F5 キーを押してプログラムを実行する [ ユーザーコントロールテストコンテナ ] が開きユーザーコントロールが表示される 5. 名ミドルネーム及び姓を 3 つのテキストボックスに入力する入力時に FullName ラベルに名前が表示される上で入力したコードを見ると宣言の Handles 句に依り 3 つの TextBox コントロール総ての TextChanged イベントが処理される事が解る何のテキストボックスを最初に入力した場合でも入力に合わせて FullName ラベルが常に更新されるユーザーコントロールのプロパティの公開標準コントロールではコントロールのデザイン時と実行時にプロパティの値を設定取得出来るユーザーコントロールでもプロパティを利用出来る様にする必要が有る然うするとデザイン時に [ プロパティ ] ウィンドウで設定出来コードでも参照出来る様に成るユーザーコントロールのプロパティを公開するのはクラスのプロパティを公開するのと非常に良く似て居る大きな違いはユーザーコントロールに含まれて居るコントロールのプロパティも公開出来ると謂う点で有るクラスと同様にプロパティを宣言しプロシージャと Set プロシージャにコードを追加するユーザーコントロールの中に含まれて居るコントロールのプロパティを公開する場合其の値を格納する為のプライベート変数を宣言する必要は無い其のコントロールのプロパティが格納する現時点では FirstName MiddleName 及び LastName の各コントロールに入力されて居るテキストや FullName ラベルの値を取得する方法は用意して居ないコントロールの利便性を高める為には此等の値をプロパティとして公開する必要が有る FullName ラベルの値は外部のコードから変更出来ない様読み取り専用のプロパティと仕て公開する必要が有るプロパティを追加するには 1. コードエディタで FirstName MiddleName 及び LastName の各値をプロパティと仕て公開する次のコードを追加する Property FirstNameText( ) As String Return FirstName.Text -4-

5 End FirstName.Text = value Property MiddleNameText( ) As String Return MiddleName.Text End MiddleName.Text = value Property LastNameText( ) As String Return LastName.Text End LastName.Text = value 2.FullName ラベルの値を読み取り専用プロパティと仕て公開する次のコードを追加する ReadOnly Property FullNameText( ) As String Return FullName.Text End 3.F5 キーを押してプログラムを実行する 4.[ ユーザーコントロールテストコンテナ ] で [ プロパティ ] グリッドの一番下にスクロールし FirstNameText プロパティを選択する名前を入力し FullNameText プロパティを選択する FirstName テキストボックスに名前が表示され FullNameText プロパティと一致する他のプロパティの幾つかを [ プロパティ ] グリッドとコントロール自体の両方で変更して観て両者の関係を確認する此れは此のコントロールのユーザーがデザイン時に経験する事と同じで有る 5.[ ファイル ] メニューの [ 総てを保存 ] をクリックして変更を保存するユーザーコントロールのテスト此の資料ではユーザーコントロールを他のプロジェクトでテストして実行時の動作を確認する方法に付いて説明する実行時の動作ユーザーコントロールが完成しテストコンテナでデザイン時の動作をテストしたらプログラムで使用した時の動作を確認する必要が有る Visual Basic 2005 では Windows アプリケーションプロジェクトを追加する事に依りユーザーコントロールを簡単にテスト出来る -5-

6 ユーザーコントロールはツールボックスに自動的に表示される然して他のコントロールの場合と同様にフォームに追加してプロパティを設定出来るユーザーコントロールをテストするには 1. 前の項で作成した NamesUserControl プロジェクトを開くプロジェクトを保存しなかった場合は先ず前の項ユーザーコントロールへのコードの追加に戻って其の項の手順を完了する必要が有る 2.[ ファイル ] メニューの [ 追加 ] をポイントし [ 新しいプロジェクト ] をクリックする 3.[ 新しいプロジェクトの追加 ] ダイアログボックスで [Windows アプリケーション ] をクリックする 4.[ プロジェクト名 ] ボックスに UserControlTest と入力し [OK] をクリックする新しいプロジェクトがソリューションエクスプローラに追加され新しいフォームが表示される 5. ソリューションエクスプローラの UserControlTest プロジェクトをクリックし [ プロジェクト ] メニューの [ スタートアッププロジェクトに設定 ] をクリックする 6. ツールボックスで NamesControl をクリックしフォームにドラッグする 7.[ プロパティ ] ウィンドウで FirstNameText MiddleNameText 及び LastNameText の各プロパティを自分の名前に合わせて設定する 8.F5 キーを押してプログラムを実行するテキストボックスで名前を変更してラベルが正しく更新される事を確認する 9.[ ファイル ] メニューの [ 総てを保存 ] をクリックして変更を保存する -6-

7 名前付き値を持つプロパティの追加此の資料では値のリストを含むプロパティをユーザーコントロールに追加する方法を解説する名前付き値此処迄でユーザーコントロールに追加したプロパティは総て文字列値に記録されたがプロパティの型は各種選択出来る以前の項で設定した PictureBox コントロールの SizeMode プロパティの様に事前設定された値の選択可能なリストを提供した方が良い場合も有る例えば FullName ラベルでの名前の表示方法を選択出来る NamesControl のプロパティを作成する場合を考えて観る選択する値のリスト (first name first last name first first and last name only 等 ) が必要で有る Visual Basic で必要な値を含む列挙型を作成出来る列挙とは箇条書きを意味する装飾的な用語で有る Visual Basic は名前で数値を参照出来る様に数値を保存する次の例で示す様に列挙型は Enum キーワードを使用して記述する Public Enum Display FirstMiddleLast FirstLast LastFirstMiddle LastFirst End Enum 作成した列挙型は他の型と同じ要領で使用出来る値のリストを表示するプロパティを追加するには最初に Enum と同じ型の変数を記述し次に同じ型のプロパティを宣言するデザイン時に列挙に含まれて居る値のリストが [ プロパティ ] ウィンドウに表示される値のリストを表示するプロパティを追加するには 1. 前の項で作成した NamesUserControl プロジェクトを開くプロジェクトを保存しなかった場合は先ず前の項ユーザーコントロールへのコードの追加に戻って其の項の手順を完了する必要が有る 2. ソリューションエクスプローラの NamesControl.vb をクリックし [ 表示 ] メニューの [ コード ] をクリックする 3. コードエディタで列挙を作成する次のコードをクラスに追加する Public Enum Display FirstMiddleLast FirstLast LastFirstMiddle LastFirst End Enum 4. 次のコードを追加する事に依り新しいプロパティを追加する Private DisplayStyleList As Display -7-

8 Property DisplayStyle() As Display Return DisplayStyleList End Set(ByVal value As Display) DisplayStyleList = value 5.FirstName_TextChanged イベントハンドラ内で既存のコードを削除し其れを次のコードに置換する Select Case DisplayStyleList Case Display.FirstLast FullName.Text = FirstName.Text & " " & LastName.Text Case Display.FirstMiddleLast FullName.Text = FirstName.Text & " " & MiddleName.Text & " " & LastName.Text Case Display.LastFirst FullName.Text = LastName.Text & ", " & FirstName.Text Case Display.LastFirstMiddle FullName.Text = LastName.Text & ", " & FirstName.Text & " " & MiddleName.Text End Select 6.F5 キーを押してプログラムを実行する 3 つのテキストボックスにファーストネームラストネーム及びミドルネームを入力する 7.[ ユーザーコントロールテストコンテナ ] で [ プロパティ ] グリッドの一番下にスクロールし DisplayStyle プロパティを選択する別の値を選択し孰れかのテキストボックスのテキストを変更する事でラベルが何の様に変化するか観察する 8.[ ファイル ] メニューの [ 総てを保存 ] をクリックして変更を保存するユーザーコントロールのカスタマイズ此の資料ではユーザーコントロールの利便性を高める様にカスタマイズする方法に付いて説明するラベルの追加前の項で NamesControl ユーザーコントロールをテストし正しく動作する事を確認した此のコントロールには改良の余地が有る例えば何のテキストボックスに何の名前を入力するのかが明確でない点やユーザーに 3 つの名前総てを確実に入力して貰えるとは限らない点で有る此のユーザーコントロールの利便性を高める為に各テキストボックスを識別するラベルを追加出来るラベルのテキストを "First Name" "Middle Name" 及び "Last Name" と設定しても良いが若し後で "Middle Initial" が必要と成った場合は何うすれば良いだろうかテキストをデザイン時に変更出来る様にし亦各プロパティに既定値を用意出来る様ラベルテキストを表すプロパティを作成する方が適切で有るユーザーコントロールをカスタマイズするには -8-

9 1. 前の項で作成した NamesUserControl プロジェクトを開くプロジェクトを保存しなかった場合は先ず前の項ユーザーコントロールのテストに戻って其の項の手順を完了する必要が有る 2. ソリューションエクスプローラの NamesControl.vb をクリックし [ 表示 ] メニューの [ デザイナ ] をクリックする 3. ツールボックスから 3 つの Label コントロールをデザイナにドラッグし各 TextBox の上に配置する 4. ソリューションエクスプローラの NamesControl.vb をクリックし [ 表示 ] メニューの [ コード ] をクリックする 5. コードエディタでラベルテキストのプロパティを作成する次のコードをクラスに追加する Private text1 As String = "First Name" Property Label1Text() As String Return text1 End text1 = value Label1.Text = text1 Private text2 As String = "Middle Name" Property Label2Text() As String Return text2 End text2 = value Label2.Text = text2 Private text3 As String = "Last Name" Property Label3Text() As String Return text3 End text3 = value Label3.Text = text3 此のコードではラベルテキストを表す 3 つの Private 変数を宣言して居り表示する既定値を指定して居る 6. コードエディタで左のドロップダウンボックスの [(NamesControl イベント )] を選択し右のドロップダウンボックスの [Load] イベントを選択する 7.NamesControl_Load イベントハンドラに次のコードを追加する -9-

10 ' Initialize the three labels Me.Label1.Text = Label1Text Me.Label2.Text = Label2Text Me.Label3.Text = Label3Text 8.[ ビルド ] メニューの [ ソリューションのビルド ] をクリックする 9. ソリューションエクスプローラで Form1.vb を選択して [ 表示 ] メニューの [ デザイナ ] をクリックするラベルに既定のテキストが含まれて居る事を確認する [ プロパティ ] ウィンドウで Label1Text プロパティを変更しコントロールでも同様に変更される事を確認する A.[ ファイル ] メニューの [ 閉じる ] をクリックしてフォームデザイナを閉じる検証の追加利便性を高める為の今 1 つのカスタマイズと仕ては入力内容を検証して正しいか何うかを確認するコードの追加が有る各 TextBox コントロールを個別に検証しなくても済むユーザーコントロール全体用の検証コードを作成出来る大半のコントロールにはフォーカスが他に移動した時に発生する Validating イベントが有る検証コードは其処に入力する此処では各テキストボックスに名前が入力されて居る事を確認するコードを記述する必要が有る空のテキストボックスが有る場合名前を入力する様ユーザーに通知するメッセージボックスを表示する既定のメッセージを格納するプロパティを用意するとコントロールのユーザーがメッセージを変更して必要な内容を通知出来る亦コントロールのユーザーに依ってはミドルネームを必要としない可能性も有るので MiddleName テキストボックスの検証をオフにする為の Boolean プロパティも追加する必要が有る検証を追加するには 1. コードエディタで検証に関連する 2 つのプロパティのコードを追加する 1 つはミドルネームが必要か何うかを指定するプロパティ今 1 つは検証が失敗した場合に表示するメッセージを指定するプロパティで有る Private required As Boolean = True Property MiddleNameRequired() As Boolean Return required End Set(ByVal value As Boolean) required = value Private errormessage As String = "Please enter your name." Property ValidationErrorMessage() As String -10-

11 Return errormessage End errormessage = value 2. コードエディタで左のドロップダウンボックスの [(NamesControl イベント )] を選択し右のドロップダウンボックスの [ 検証中 ] イベントを選択する 3.NamesControl_Validating イベントハンドラに次のコードを追加する If MiddleNameRequired = True Then If FirstName.Text = "" Or MiddleName.Text = "" Or _ LastName.Text = "" Then MsgBox(ValidationErrorMessage) End If Else ' Middle name isn't required. If FirstName.Text = "" Or LastName.Text = "" Then MsgBox(ValidationErrorMessage) End If End If 4.[ ビルド ] メニューの [ ソリューションのビルド ] をクリックする 5. ソリューションエクスプローラで Form1.vb を選択して [ 表示 ] メニューの [ デザイナ ] をクリックするフォーム上のユーザーコントロールを選択し 2 つの新しいプロパティが [ プロパティ ] ウィンドウに表示される事を確認する 6. ツールボックスからフォームに Button コントロールをドラッグする 7.F5 キーを押してプログラムを実行する姓と名を入力するミドルネームは入力せずに置くボタンをクリックすると ValidationErrorMessage の内容を伝えるメッセージボックスが表示される 8.[ ファイル ] メニューの [ 総てを保存 ] をクリックして変更を保存する -11-

ＶＢ．ＮＥＴ解説

ＶＢ．ＮＥＴ解説 Visual Basic.NET 印刷編目次印刷の概要... 2 印刷の流れ... 2 標準の Windows フォーム印刷ジョブの作成... 3 実行時に於ける Windows フォーム印刷オプションの変更... 3 Windows フォームに於ける接続されたプリンタの選択... 4 Windows フォームでのグラフィックスの印刷... 5 Windows フォームでのテキストの印刷...