IComponentDesignerStateService Interface


Allows a designer to store and retrieve its state.

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

type IComponentDesignerStateService = interface end

System_CAPS_pubmethodGetState(IComponent, String)

Gets a state item specified by the key for the given component.

System_CAPS_pubmethodSetState(IComponent, String, Object)

Sets a state item specified by the key for the given component.

Designer state is keyed by the component with which the designer is associated. The Web Forms design surface offers this service and component designers use the service. This is an optional host service, and control designers should not assume it will always be provided.

Designer state is represented as a set of name/value pairs, in the form of a dictionary. Values stored in the dictionary must be serializable. The specified component should be sited in the designer and should have a non-empty name.


Do not store sensitive information to the IComponentDesignerStateService. Sensitive information includes password and authentication data, or any data you do not want to expose to an unwanted source.

.NET Framework
Available since 2.0
Return to top