CommonDialog.HelpRequest イベント

.NET Framework クラス ライブラリ リファレンス

CommonDialog.HelpRequest イベント

ユーザーがコモン ダイアログ ボックスの [?] ボタンをクリックすると発生します。

名前空間: System.Windows.Forms
アセンブリ: System.Windows.Forms (system.windows.forms.dll 内)
構文

Visual Basic (宣言)

Public Event HelpRequest As
 EventHandler

Visual Basic (使用法)

Dim instance As CommonDialog
Dim handler As EventHandler

AddHandler instance.HelpRequest, handler

C#

public event EventHandler HelpRequest

C++

public:
event EventHandler^ HelpRequest {
    void add (EventHandler^ value);
    void remove (EventHandler^ value);
}

J#

/** @event */
public void add_HelpRequest (EventHandler value)

/** @event */
public void remove_HelpRequest (EventHandler
 value)

JScript

JScript では、イベントは使用できますが、新規に宣言することはできません。

解説

イベント処理の詳細については、「イベントの利用」を参照してください。

使用例

AnyColor プロパティと AllowFullOpen プロパティを設定して ColorDialog オブジェクトを初期化する方法を次のコード例に示します。ColorDialog オブジェクトではユーザーがカスタム カラーを設定することはできません。ただし、基本色セットはすべて表示できます。SolidColorOnly プロパティを false に設定すると、256 色以下のシステム上の色を組み合わせた色を表示できるようになります。またこの例では、ShowHelp プロパティの設定方法と、ダイアログの HelpRequest イベントの処理方法も示します。この例を実行するには、次のコードをフォームに貼り付けて、フォームのコンストラクタまたは Load メソッドで InitializeColorDialog メソッドを呼び出します。この例では、ボタンの Click イベントが、この例で定義されているイベント ハンドラに関連付けられている必要があります。

Visual Basic

' This method initializes ColorDialog1 to allow any colors, 
' and combination colors on systems with 256 colors or less, 
' but will not allow the user to set custom colors.  The
' dialog will contain the help button.
Private Sub InitializeColorDialog()
    Me.ColorDialog1 = New System.Windows.Forms.ColorDialog
    Me.ColorDialog1.AllowFullOpen = False
    Me.ColorDialog1.AnyColor = True
    Me.ColorDialog1.SolidColorOnly = False
    Me.ColorDialog1.ShowHelp = True
End Sub
  

' This method opens the dialog and checks the DialogResult value. 
' If the result is OK, the text box's background color will be changed
 
' to the user-selected color.
Private Sub Button1_Click(ByVal
 sender As System.Object,  _
    ByVal e As System.EventArgs) Handles
 Button1.Click
    Dim result As DialogResult = ColorDialog1.ShowDialog()
    If (result.Equals(DialogResult.OK)) Then
        TextBox1.BackColor = ColorDialog1.Color
    End If
End Sub
 
  
' This method is called when the HelpRequest event is raised, 
'which occurs when the user clicks the Help button on the ColorDialog
 object.
Private Sub ColorDialog1_HelpRequest(ByVal
 sender As Object, _ 
    ByVal e As System.EventArgs) Handles
 ColorDialog1.HelpRequest

    MessageBox.Show("Please select a color by clicking it."
 _
    & "This will change the BackColor property of the TextBox.")
End Sub

C#

// This method initializes ColorDialog1 to allow any colors, 
// and combination colors on systems with 256 colors or less, 
// but will not allow the user to set custom colors.  The
// dialog will contain the help button.
private void InitializeColorDialog()
{
    this.ColorDialog1 = new System.Windows.Forms.ColorDialog();
    this.ColorDialog1.AllowFullOpen = false;
    this.ColorDialog1.AnyColor = true;
    this.ColorDialog1.SolidColorOnly = false;
    this.ColorDialog1.ShowHelp = true;
    
    // Associate the event-handling method with
    // the HelpRequest event.
    this.ColorDialog1.HelpRequest 
        += new System.EventHandler(ColorDialog1_HelpRequest);
}


// This method opens the dialog and checks the DialogResult value. 
// If the result is OK, the text box's background color will be changed
 
// to the user-selected color.
private void Button1_Click(System.Object sender,
 System.EventArgs e)
{
    DialogResult result = ColorDialog1.ShowDialog();
    if (result.Equals(DialogResult.OK))
    {
        TextBox1.BackColor = ColorDialog1.Color;
    }
}

// This method is called when the HelpRequest event is raised, 
//which occurs when the user clicks the Help button on the ColorDialog
 object.
private void ColorDialog1_HelpRequest(object
 sender, System.EventArgs e)
{

    MessageBox.Show("Please select a color by clicking it. "
       + "This will change the BackColor property of the TextBox.");
}

C++

// This method initializes ColorDialog1 to allow any colors, 
// and combination colors on systems with 256 colors or less, 
// but will not allow the user to set custom colors.  The
// dialog will contain the help button.
void InitializeColorDialog()
{
   this->ColorDialog1 = gcnew System::Windows::Forms::ColorDialog;
   this->ColorDialog1->AllowFullOpen = false;
   this->ColorDialog1->AnyColor = true;
   this->ColorDialog1->SolidColorOnly = false;
   this->ColorDialog1->ShowHelp = true;
   
   // Associate the event-handling method with
   // the HelpRequest event.
   this->ColorDialog1->HelpRequest +=
      gcnew System::EventHandler( this, &Form1::ColorDialog1_HelpRequest
 );
}

// This method opens the dialog and checks the DialogResult value. 
// If the result is OK, the text box's background color will be changed
 
// to the user-selected color.
void Button1_Click( System::Object^ sender, System::EventArgs^
 e )
{
   ::DialogResult result = ColorDialog1->ShowDialog();
   if ( result == ::DialogResult::OK )
   {
      TextBox1->BackColor = ColorDialog1->Color;
   }
}

// This method is called when the HelpRequest event is raised, 
//which occurs when the user clicks the Help button on the ColorDialog
 object.
void ColorDialog1_HelpRequest( Object^ sender, System::EventArgs^
 e )
{
   MessageBox::Show( "Please select a color by clicking it. " +
      "This will change the BackColor property of the TextBox." );
}

J#

// This method initializes colorDialog1 to allow any colors, 
// and combination colors on systems with 256 colors or less, 
// but will not allow the user to set custom colors.  The
// dialog will contain the help button.
private void InitializeColorDialog()
{
    this.colorDialog1 = new System.Windows.Forms.ColorDialog();
    this.colorDialog1.set_AllowFullOpen(false);
    this.colorDialog1.set_AnyColor(true);
    this.colorDialog1.set_SolidColorOnly(false);
    this.colorDialog1.set_ShowHelp(true);
    // Associate the event-handling method with
    // the HelpRequest event.
    this.colorDialog1.add_HelpRequest(new System.EventHandler(
        colorDialog1_HelpRequest));
} //InitializeColorDialog

// This method opens the dialog and checks the DialogResult value. 
// If the result is OK, the text box's background color will be changed
 
// to the user-selected color.
private void button1_Click(System.Object sender,
 System.EventArgs e)
{
    DialogResult result = colorDialog1.ShowDialog();
    if (result.Equals(DialogResult.OK)) {
        textBox1.set_BackColor(colorDialog1.get_Color());
    }
} //button1_Click

// This method is called when the HelpRequest event is raised, 
//which occurs when the user clicks the Help button on the ColorDialog
 object.
private void colorDialog1_HelpRequest(Object
 sender, System.EventArgs e)
{
    MessageBox.Show("Please select a color by clicking it. " 
        + "This will change the BackColor property of the TextBox.");
} //colorDialog1_HelpRequest

プラットフォーム

Windows 98, Windows 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0、1.1、1.0

参照

関連項目
CommonDialog クラス
CommonDialog メンバ
System.Windows.Forms 名前空間
OnHelpRequest