ColorDialog Class

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

Namespace: System.Windows.Forms
Assembly: System.Windows.Forms (in system.windows.forms.dll)

'Declaration
Public Class ColorDialog
	Inherits CommonDialog
'Usage
Dim instance As ColorDialog

public class ColorDialog extends CommonDialog
public class ColorDialog extends CommonDialog

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.

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 Sub button1_Click(sender As Object, e As System.EventArgs)
    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 'button1_Click

protected void button1_Click(Object sender, System.EventArgs e)
{
    ColorDialog myDialog = new ColorDialog();
    // Keeps the user from selecting a custom color.
    myDialog.set_AllowFullOpen(false);
    // Allows the user to get help. (The default is false.)
    myDialog.set_ShowHelp(true);
    // Sets the initial color select to the current text color.
    myDialog.set_Color(textBox1.get_ForeColor());
    // Update the text box color if the user clicks OK 
    if (myDialog.ShowDialog().Equals(get_DialogResult().OK)) {
        textBox1.set_ForeColor(myDialog.get_Color());
    }
} //button1_Click

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

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

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see System Requirements.

.NET Framework

Supported in: 2.0, 1.1, 1.0

Community Additions

ADD
Show: