ColorDialog Class
Represents a common dialog box that displays available colors along with controls that enable the user to define custom colors.
System::MarshalByRefObject
System.ComponentModel::Component
System.Windows.Forms::CommonDialog
System.Windows.Forms::ColorDialog
Assembly: System.Windows.Forms (in System.Windows.Forms.dll)
The ColorDialog type exposes the following members.
| 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. |
![]() | CanRaiseEvents | Gets a value indicating whether the component can raise an event. (Inherited from Component.) |
![]() | Color | Gets or sets the color selected by the user. |
![]() | Container | Gets the IContainer that contains the Component. (Inherited from Component.) |
![]() | CustomColors | Gets or sets the set of custom colors shown in the dialog box. |
![]() | DesignMode | Gets a value that indicates whether the Component is currently in design mode. (Inherited from Component.) |
![]() | Events | Gets the list of event handlers that are attached to this Component. (Inherited from Component.) |
![]() | FullOpen | Gets or sets a value indicating whether the controls used to create custom colors are visible when the dialog box is opened |
![]() | Instance | Infrastructure. Gets the underlying window instance handle (HINSTANCE). |
![]() | Options | Infrastructure. Gets values to initialize the ColorDialog. |
![]() | ShowHelp | Gets or sets a value indicating whether a Help button appears in the color dialog box. |
![]() | Site | Gets or sets the ISite of the Component. (Inherited from Component.) |
![]() | 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.) |
| Name | Description | |
|---|---|---|
![]() | CreateObjRef | Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. (Inherited from MarshalByRefObject.) |
![]() | Dispose() | Releases all resources used by the Component. (Inherited from Component.) |
![]() | Dispose(Boolean) | Releases the unmanaged resources used by the Component and optionally releases the managed resources. (Inherited from Component.) |
![]() | Equals(Object) | Determines whether the specified Object is equal to the current Object. (Inherited from Object.) |
![]() | Finalize | Releases unmanaged resources and performs other cleanup operations before the Component is reclaimed by garbage collection. (Inherited from Component.) |
![]() | GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
![]() | GetLifetimeService | Retrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from MarshalByRefObject.) |
![]() | GetService | Returns an object that represents a service provided by the Component or by its Container. (Inherited from Component.) |
![]() | GetType | Gets the Type of the current instance. (Inherited from Object.) |
![]() | HookProc | Defines the common dialog box hook procedure that is overridden to add specific functionality to a common dialog box. (Inherited from CommonDialog.) |
![]() | InitializeLifetimeService | Obtains a lifetime service object to control the lifetime policy for this instance. (Inherited from MarshalByRefObject.) |
![]() | MemberwiseClone() | Creates a shallow copy of the current Object. (Inherited from Object.) |
![]() | MemberwiseClone(Boolean) | Creates a shallow copy of the current MarshalByRefObject object. (Inherited from MarshalByRefObject.) |
![]() | OnHelpRequest | Raises the HelpRequest event. (Inherited from CommonDialog.) |
![]() | OwnerWndProc | 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. (Overrides CommonDialog::Reset().) |
![]() | RunDialog | Infrastructure. When overridden in a derived class, specifies a common dialog box. (Overrides CommonDialog::RunDialog(IntPtr).) |
![]() | 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 | Infrastructure. Returns a string that represents the ColorDialog. (Overrides Component::ToString().) |
| Name | Description | |
|---|---|---|
![]() | Disposed | Occurs when the component is disposed by a call to the Dispose method. (Inherited from Component.) |
![]() | HelpRequest | Occurs when the user clicks the Help button on a common dialog box. (Inherited from 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: 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; } }
Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2
The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
