IComponentDesignerStateService.xml

<Type Name="IComponentDesignerStateService" FullName="System.ComponentModel.Design.IComponentDesignerStateService">
  <TypeSignature Language="C#" Value="public interface IComponentDesignerStateService" />
  <TypeSignature Language="ILAsm" Value=".class public interface auto ansi abstract IComponentDesignerStateService" />
  <TypeSignature Language="DocId" Value="T:System.ComponentModel.Design.IComponentDesignerStateService" />
  <TypeSignature Language="VB.NET" Value="Public Interface IComponentDesignerStateService" />
  <TypeSignature Language="F#" Value="type IComponentDesignerStateService = interface" />
  <TypeSignature Language="C++ CLI" Value="public interface class IComponentDesignerStateService" />
  <AssemblyInfo>
    <AssemblyName>System.Design</AssemblyName>
    <AssemblyVersion>2.0.0.0</AssemblyVersion>
    <AssemblyVersion>4.0.0.0</AssemblyVersion>
  </AssemblyInfo>
  <Interfaces />
  <Docs>
    <summary>Allows a designer to store and retrieve its state.</summary>
    <remarks>
      <format type="text/markdown"><![CDATA[  
  
## Remarks  
 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.  
  
> [!CAUTION]
>  Do not store sensitive information to the <xref:System.ComponentModel.Design.IComponentDesignerStateService>. Sensitive information includes password and authentication data, or any data you do not want to expose to an unwanted source.  
  
 ]]></format>
    </remarks>
    <altmember cref="T:System.ComponentModel.IComponent" />
    <altmember cref="T:System.ComponentModel.Design.IDesignerHost" />
  </Docs>
  <Members>
    <Member MemberName="GetState">
      <MemberSignature Language="C#" Value="public object GetState (System.ComponentModel.IComponent component, string key);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance object GetState(class System.ComponentModel.IComponent component, string key) cil managed" />
      <MemberSignature Language="DocId" Value="M:System.ComponentModel.Design.IComponentDesignerStateService.GetState(System.ComponentModel.IComponent,System.String)" />
      <MemberSignature Language="VB.NET" Value="Public Function GetState (component As IComponent, key As String) As Object" />
      <MemberSignature Language="F#" Value="abstract member GetState : System.ComponentModel.IComponent * string -&gt; obj" Usage="iComponentDesignerStateService.GetState (component, key)" />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; System::Object ^ GetState(System::ComponentModel::IComponent ^ component, System::String ^ key);" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.Design</AssemblyName>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Object</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="component" Type="System.ComponentModel.IComponent" />
        <Parameter Name="key" Type="System.String" />
      </Parameters>
      <Docs>
        <param name="component">The component for which to retrieve the designer state item.</param>
        <param name="key">The name of the designer state item.</param>
        <summary>Gets a state item specified by the key for the given component.</summary>
        <returns>The designer state for <paramref name="component" /> specified by <paramref name="key" />.</returns>
        <remarks>To be added.</remarks>
        <altmember cref="T:System.ComponentModel.IComponent" />
        <altmember cref="T:System.ComponentModel.Design.IDesignerHost" />
      </Docs>
    </Member>
    <Member MemberName="SetState">
      <MemberSignature Language="C#" Value="public void SetState (System.ComponentModel.IComponent component, string key, object value);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void SetState(class System.ComponentModel.IComponent component, string key, object value) cil managed" />
      <MemberSignature Language="DocId" Value="M:System.ComponentModel.Design.IComponentDesignerStateService.SetState(System.ComponentModel.IComponent,System.String,System.Object)" />
      <MemberSignature Language="VB.NET" Value="Public Sub SetState (component As IComponent, key As String, value As Object)" />
      <MemberSignature Language="F#" Value="abstract member SetState : System.ComponentModel.IComponent * string * obj -&gt; unit" Usage="iComponentDesignerStateService.SetState (component, key, value)" />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; void SetState(System::ComponentModel::IComponent ^ component, System::String ^ key, System::Object ^ value);" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.Design</AssemblyName>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="component" Type="System.ComponentModel.IComponent" />
        <Parameter Name="key" Type="System.String" />
        <Parameter Name="value" Type="System.Object" />
      </Parameters>
      <Docs>
        <param name="component">The component for which to set the designer state item.</param>
        <param name="key">The name of the designer state item.</param>
        <param name="value">The designer state item for <paramref name="component" />.</param>
        <summary>Sets a state item specified by the key for the given component.</summary>
        <remarks>To be added.</remarks>
        <altmember cref="T:System.ComponentModel.IComponent" />
        <altmember cref="T:System.ComponentModel.Design.IDesignerHost" />
      </Docs>
    </Member>
  </Members>
</Type>