ColorDialog Class
TOC
Collapse the table of content
Expand the table of content

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)

System.Object
  System.MarshalByRefObject
    System.ComponentModel.Component
      System.Windows.Forms.CommonDialog
        System.Windows.Forms.ColorDialog

type ColorDialog = 
    class
        inherit CommonDialog
    end

NameDescription
System_CAPS_pubmethodColorDialog()

Initializes a new instance of the ColorDialog class.

NameDescription
System_CAPS_pubpropertyAllowFullOpen

Gets or sets a value indicating whether the user can use the dialog box to define custom colors.

System_CAPS_pubpropertyAnyColor

Gets or sets a value indicating whether the dialog box displays all available colors in the set of basic colors.

System_CAPS_protpropertyCanRaiseEvents

Gets a value indicating whether the component can raise an event.(Inherited from Component.)

System_CAPS_pubpropertyColor

Gets or sets the color selected by the user.

System_CAPS_pubpropertyContainer

Gets the IContainer that contains the Component.(Inherited from Component.)

System_CAPS_pubpropertyCustomColors

Gets or sets the set of custom colors shown in the dialog box.

System_CAPS_protpropertyDesignMode

Gets a value that indicates whether the Component is currently in design mode.(Inherited from Component.)

System_CAPS_protpropertyEvents

Gets the list of event handlers that are attached to this Component.(Inherited from Component.)

System_CAPS_pubpropertyFullOpen

Gets or sets a value indicating whether the controls used to create custom colors are visible when the dialog box is opened

System_CAPS_protpropertyInstance

This API supports the product infrastructure and is not intended to be used directly from your code. Gets the underlying window instance handle (HINSTANCE).

System_CAPS_protpropertyOptions

This API supports the product infrastructure and is not intended to be used directly from your code. Gets values to initialize the ColorDialog.

System_CAPS_pubpropertyShowHelp

Gets or sets a value indicating whether a Help button appears in the color dialog box.

System_CAPS_pubpropertySite

Gets or sets the ISite of the Component.(Inherited from Component.)

System_CAPS_pubpropertySolidColorOnly

Gets or sets a value indicating whether the dialog box will restrict users to selecting solid colors only.

System_CAPS_pubpropertyTag

Gets or sets an object that contains data about the control. (Inherited from CommonDialog.)

NameDescription
System_CAPS_pubmethodCreateObjRef(Type)

Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object.(Inherited from MarshalByRefObject.)

System_CAPS_pubmethodDispose()

Releases all resources used by the Component.(Inherited from Component.)

System_CAPS_protmethodDispose(Boolean)

Releases the unmanaged resources used by the Component and optionally releases the managed resources.(Inherited from Component.)

System_CAPS_pubmethodEquals(Object)

Determines whether the specified object is equal to the current object.(Inherited from Object.)

System_CAPS_protmethodFinalize()

Releases unmanaged resources and performs other cleanup operations before the Component is reclaimed by garbage collection.(Inherited from Component.)

System_CAPS_pubmethodGetHashCode()

Serves as the default hash function. (Inherited from Object.)

System_CAPS_pubmethodGetLifetimeService()

Retrieves the current lifetime service object that controls the lifetime policy for this instance.(Inherited from MarshalByRefObject.)

System_CAPS_protmethodGetService(Type)

Returns an object that represents a service provided by the Component or by its Container.(Inherited from Component.)

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_protmethodHookProc(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.)

System_CAPS_pubmethodInitializeLifetimeService()

Obtains a lifetime service object to control the lifetime policy for this instance.(Inherited from MarshalByRefObject.)

System_CAPS_protmethodMemberwiseClone()

Creates a shallow copy of the current Object.(Inherited from Object.)

System_CAPS_protmethodMemberwiseClone(Boolean)

Creates a shallow copy of the current MarshalByRefObject object.(Inherited from MarshalByRefObject.)

System_CAPS_protmethodOnHelpRequest(EventArgs)

Raises the HelpRequest event.(Inherited from CommonDialog.)

System_CAPS_protmethodOwnerWndProc(IntPtr, Int32, IntPtr, IntPtr)

Defines the owner window procedure that is overridden to add specific functionality to a common dialog box.(Inherited from CommonDialog.)

System_CAPS_pubmethodReset()

Resets all options to their default values, the last selected color to black, and the custom colors to their default values.(Overrides CommonDialog.Reset().)

System_CAPS_protmethodRunDialog(IntPtr)

This API supports the product infrastructure and is not intended to be used directly from your code. When overridden in a derived class, specifies a common dialog box.(Overrides CommonDialog.RunDialog(IntPtr).)

System_CAPS_pubmethodShowDialog()

Runs a common dialog box with a default owner.(Inherited from CommonDialog.)

System_CAPS_pubmethodShowDialog(IWin32Window)

Runs a common dialog box with the specified owner.(Inherited from CommonDialog.)

System_CAPS_pubmethodToString()

This API supports the product infrastructure and is not intended to be used directly from your code. Returns a string that represents the ColorDialog.(Overrides Component.ToString().)

NameDescription
System_CAPS_pubeventDisposed

Occurs when the component is disposed by a call to the Dispose method. (Inherited from Component.)

System_CAPS_pubeventHelpRequest

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.

No code example is currently available or this language may not be supported.

.NET Framework
Available since 1.1

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

Return to top
Show:
© 2016 Microsoft