ColorDialog Class

Definition

Namespace:

System.Windows.Forms

Assembly:

System.Windows.Forms.dll

Source:

ColorDialog.cs

Represents a common dialog box that displays available colors along with controls that enable the user to define custom colors.

public ref class ColorDialog : System::Windows::Forms::CommonDialog

public class ColorDialog : System.Windows.Forms.CommonDialog

type ColorDialog = class
    inherit CommonDialog

Public Class ColorDialog
Inherits CommonDialog

Inheritance

Object

MarshalByRefObject

Component

CommonDialog

ColorDialog

Examples

The following example illustrates the creation of new ColorDialog. This example requires that the method is called from within an existing form that has a TextBox and Button placed on it.

private:
   void button1_Click( Object^ /*sender*/, System::EventArgs^ /*e*/ )
   {
      ColorDialog^ MyDialog = gcnew ColorDialog;
      // Keeps the user from selecting a custom color.
      MyDialog->AllowFullOpen = false;
      // Allows the user to get help. (The default is false.)
      MyDialog->ShowHelp = true;
      // Sets the initial color select to the current text color.
      MyDialog->Color = textBox1->ForeColor;
      
      // Update the text box color if the user clicks OK 
      if ( MyDialog->ShowDialog() == ::System::Windows::Forms::DialogResult::OK )
      {
         textBox1->ForeColor = MyDialog->Color;
      }
   }

private void button1_Click(object sender, System.EventArgs e)
 {
    ColorDialog MyDialog = new ColorDialog();
    // Keeps the user from selecting a custom color.
    MyDialog.AllowFullOpen = false ;
    // Allows the user to get help. (The default is false.)
    MyDialog.ShowHelp = true ;
    // Sets the initial color select to the current text color.
    MyDialog.Color = textBox1.ForeColor ;
    
    // Update the text box color if the user clicks OK 
    if (MyDialog.ShowDialog() == DialogResult.OK)
        textBox1.ForeColor =  MyDialog.Color;
 }

Private Sub Button1_Click(ByVal sender As System.Object, ByVal e As System.EventArgs) Handles Button1.Click
    Dim MyDialog As New ColorDialog()
    ' Keeps the user from selecting a custom color.
    MyDialog.AllowFullOpen = False
    ' Allows the user to get help. (The default is false.)
    MyDialog.ShowHelp = True
    ' Sets the initial color select to the current text color,
    MyDialog.Color = TextBox1.ForeColor

    ' Update the text box color if the user clicks OK 
    If (MyDialog.ShowDialog() = DialogResult.OK) Then
        TextBox1.ForeColor = MyDialog.Color
    End If
End Sub

Remarks

The inherited member ShowDialog must be invoked to create this specific common dialog box. HookProc can be overridden to implement specific dialog box hook functionality. Use Color to retrieve the color selected by the user.

When you create an instance of ColorDialog, some of the read/write properties are set to initial values. For a list of these values, see the ColorDialog constructor.

Constructors

Name	Description
ColorDialog()	Initializes a new instance of the ColorDialog class.

Properties

Name	Description
AllowFullOpen	Gets or sets a value indicating whether the user can use the dialog box to define custom colors.
AnyColor	Gets or sets a value indicating whether the dialog box displays all available colors in the set of basic colors.
Color	Gets or sets the color selected by the user.
CustomColors	Gets or sets the set of custom colors shown in the dialog box.
FullOpen	Gets or sets a value indicating whether the controls used to create custom colors are visible when the dialog box is opened.
Instance	Gets the underlying window instance handle (HINSTANCE).
Options	Gets values to initialize the ColorDialog.
ShowHelp	Gets or sets a value indicating whether a Help button appears in the color dialog box.
SolidColorOnly	Gets or sets a value indicating whether the dialog box will restrict users to selecting solid colors only.
Tag	Gets or sets an object that contains data about the control. (Inherited from CommonDialog)

Methods

Name	Description
HookProc(IntPtr, Int32, IntPtr, IntPtr)	Defines the common dialog box hook procedure that is overridden to add specific functionality to a common dialog box. (Inherited from CommonDialog)
OnHelpRequest(EventArgs)	Raises the HelpRequest event. (Inherited from CommonDialog)
OwnerWndProc(IntPtr, Int32, IntPtr, IntPtr)	Defines the owner window procedure that is overridden to add specific functionality to a common dialog box. (Inherited from CommonDialog)
Reset()	Resets all options to their default values, the last selected color to black, and the custom colors to their default values.
RunDialog(IntPtr)	When overridden in a derived class, specifies a common dialog box.
ShowDialog()	Runs a common dialog box with a default owner. (Inherited from CommonDialog)
ShowDialog(IWin32Window)	Runs a common dialog box with the specified owner. (Inherited from CommonDialog)
ToString()	Returns a string that represents the ColorDialog.

Events

Name	Description
HelpRequest	Occurs when the user clicks the Help button on a common dialog box. (Inherited from CommonDialog)

See also

• CommonDialog