DesignerOptionService Class


Provides a base class for getting and setting option values for a designer.

Namespace:   System.ComponentModel.Design
Assembly:  System (in System.dll)


[HostProtectionAttribute(SecurityAction::LinkDemand, SharedState = true)]
public ref class DesignerOptionService abstract : IDesignerOptionService


Initializes a new instance of the DesignerOptionService class.


Gets the options collection for this service.

System_CAPS_protmethodCreateOptionCollection(DesignerOptionService::DesignerOptionCollection^, String^, Object^)

Creates a new DesignerOptionService::DesignerOptionCollection with the given name and adds it to the given parent.


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


Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)


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


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


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

System_CAPS_protmethodShowDialog(DesignerOptionService::DesignerOptionCollection^, Object^)

Shows the options dialog box for the given object.


Returns a string that represents the current object.(Inherited from Object.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIDesignerOptionService::GetOptionValue(String^, String^)

Gets the value of an option defined in this package.

System_CAPS_pubinterfaceSystem_CAPS_privmethodIDesignerOptionService::SetOptionValue(String^, String^, Object^)

Sets the value of an option defined in this package.

The DesignerOptionService class provides a collection of options. Each of these option collections has an indexer that enables it to be further filtered. Each option collection contains its own set of options, as well as a rollup of all of its child options. In the event of a naming conflict between properties, the outermost options object takes precedence. The following Tools | Options user interface (UI) structure shows how the outermost options object takes on greater importance:

WindowsFormsDesigner | General

  • SnapToGrid

  • ShowGrid

  • GridSize

Given a IDesignerOptionService named service, to get to the value of the GridSize property, you would make the following call:

// Obtains and shows the size of the standard design-mode grid square.
System::Drawing::Size size =  *dynamic_cast<System::Drawing::Size^>(designerOptionService->GetOptionValue( "WindowsFormsDesigner\\General", "GridSize" ));

This works, until you want to move GridSize to another page. Also, IDesignerOptionService provides no discovery mechanism. If you do not know what string to pass in, the service cannot find the property value.

The DesignerOptionService class addresses these issues. You can query collections, and there is a type converter defined on the DesignerOptionService::DesignerOptionCollection object that marks the collection as expandable. With this type converter, you can pass the entire designer option service to a property window and visually inspect the service.

The following code example demonstrates accessing the DesignerOptionService to display the current values of the standard options.

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

.NET Framework
Available since 2.0

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