linux-packaging-mono/mcs/class/System.Design/Documentation/en/System.Web.UI.Design/ContainerControlDesigner.xml

<?xml version="1.0" encoding="utf-8"?>
<Type Name="ContainerControlDesigner" FullName="System.Web.UI.Design.ContainerControlDesigner">
  <TypeSignature Language="C#" Value="public class ContainerControlDesigner : System.Web.UI.Design.ControlDesigner" />
  <AssemblyInfo>
    <AssemblyName>System.Design</AssemblyName>
    <AssemblyVersion>2.0.0.0</AssemblyVersion>
  </AssemblyInfo>
  <Base>
    <BaseTypeName>System.Web.UI.Design.ControlDesigner</BaseTypeName>
  </Base>
  <Interfaces />
  <Docs>
    <remarks>
      <attribution license="cc4" from="Microsoft" modified="false" />
      <para>The <see cref="T:System.Web.UI.Design.ContainerControlDesigner" /> class provides a base designer class for controls that can be modified on the design surface. This includes controls that contain child controls or editable inner properties. The <see cref="T:System.Web.UI.Design.ContainerControlDesigner" /> provides a single framed region to represent the control, and automatically handles rendering the control at design time.</para>
      <para>Apply the <see cref="T:System.Web.UI.ParseChildrenAttribute" /> attribute on the associated control to determine the design-time behavior of the <see cref="T:System.Web.UI.Design.ContainerControlDesigner" />. Apply the <see cref="T:System.Web.UI.ParseChildrenAttribute" /> settings on the associated control as follows: </para>
      <list type="bullet">
        <item>
          <para>false to indicate that the <see cref="T:System.Web.UI.Design.ContainerControlDesigner" /> represents the contents of the editable design region as child controls. </para>
        </item>
        <item>
          <para>true to indicate that the <see cref="T:System.Web.UI.Design.ContainerControlDesigner" /> represents the contents of the editable design region as editable inner properties of the control.</para>
        </item>
      </list>
      <para>Control developers can derive and extend a custom designer from one of several base designers depending on the kind of control that is being developed, as defined in the following list:</para>
      <list type="bullet">
        <item>
          <para>Controls that allow child controls to be added to it at design time can derive from the <see cref="T:System.Web.UI.Design.ContainerControlDesigner" /> class. For example, the <see cref="T:System.Web.UI.Design.WebControls.PanelContainerDesigner" /> class is derived from the <see cref="T:System.Web.UI.Design.ContainerControlDesigner" /> class and represents a <see cref="T:System.Web.UI.WebControls.Panel" /> control on the design surface.</para>
        </item>
        <item>
          <para>Controls that have one or more child controls, and might also have an editable designer region where controls can be added at design time, can derive from the <see cref="T:System.Web.UI.Design.WebControls.CompositeControlDesigner" /> class.</para>
        </item>
        <item>
          <para>Controls that require custom design-time processing can derive from the base <see cref="T:System.Web.UI.Design.ControlDesigner" /> class.</para>
        </item>
      </list>
      <block subset="none" type="note">
        <para>  The <see cref="T:System.Web.UI.Design.ContainerControlDesigner" /> class replaces the obsolete <see cref="T:System.Web.UI.Design.ReadWriteControlDesigner" /> class.</para>
      </block>
      <para>Use the <see cref="T:System.ComponentModel.DesignerAttribute" /> attribute to associate a custom designer class together with a custom control implementation. For detailed information about how to use control designers with custom controls, see <format type="text/html"><a href="27e44af0-6e12-4b7d-b17f-db35f1b6a052">Walkthrough:  Creating a Basic Control Designer for a Web Server Control</a></format>.</para>
    </remarks>
    <summary>
      <attribution license="cc4" from="Microsoft" modified="false" />
      <para>Provides designer functionality for controls that contain child controls or properties that can be modified at design time.</para>
    </summary>
  </Docs>
  <Members>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public ContainerControlDesigner ();" />
      <MemberType>Constructor</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Parameters />
      <Docs>
        <remarks>To be added.</remarks>
        <summary>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>Initializes a new instance of the <see cref="T:System.Web.UI.Design.ContainerControlDesigner" /> class.</para>
        </summary>
      </Docs>
    </Member>
    <Member MemberName="AddDesignTimeCssAttributes">
      <MemberSignature Language="C#" Value="protected virtual void AddDesignTimeCssAttributes (System.Collections.IDictionary styleAttributes);" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="styleAttributes" Type="System.Collections.IDictionary" />
      </Parameters>
      <Docs>
        <remarks>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>The <see cref="M:System.Web.UI.Design.ContainerControlDesigner.AddDesignTimeCssAttributes(System.Collections.IDictionary)" /> method adds a set of style attributes for the design-time representation of the control. The style attribute values are added to the <paramref name="styleAttributes" /> collection, keyed by the style attribute name. For example, you can access the height value in the collection as styleAttributes["height"] for C# or styleAttributes("height") for Microsoft Visual Basic.</para>
          <para>If the associated control is not derived from the <see cref="T:System.Web.UI.WebControls.WebControl" /> class, the <see cref="M:System.Web.UI.Design.ContainerControlDesigner.AddDesignTimeCssAttributes(System.Collections.IDictionary)" /> method does not add attribute values to the <paramref name="styleAttributes" /> collection.</para>
        </remarks>
        <summary>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>Adds the style attributes for the control at design time.</para>
        </summary>
        <param name="styleAttributes">
          <attribution license="cc4" from="Microsoft" modified="false" />A keyed collection of style attributes.</param>
      </Docs>
    </Member>
    <Member MemberName="AllowResize">
      <MemberSignature Language="C#" Value="public override bool AllowResize { get; }" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Boolean</ReturnType>
      </ReturnValue>
      <Docs>
        <value>To be added.</value>
        <remarks>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>The base implementation for the <see cref="P:System.Web.UI.Design.ContainerControlDesigner.AllowResize" /> property returns true. This indicates that the designer supports resizing of the control on the design surface.</para>
        </remarks>
        <summary>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>Gets a value indicating if the control can be resized at design time.</para>
        </summary>
      </Docs>
    </Member>
    <Member MemberName="FrameCaption">
      <MemberSignature Language="C#" Value="public virtual string FrameCaption { get; }" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Docs>
        <value>To be added.</value>
        <remarks>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>The <see cref="P:System.Web.UI.Design.ContainerControlDesigner.FrameCaption" /> string is the caption that is displayed in the frame around the editable region of the control on the design surface.</para>
          <para>The default caption for a <see cref="T:System.Web.UI.Design.ContainerControlDesigner" /> frame is the <see cref="P:System.Web.UI.Design.ControlDesigner.ID" /> property of the designer instance. This is typically the same as the run-time <see cref="P:System.Web.UI.Control.ID" /> property of the control.</para>
        </remarks>
        <summary>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>Gets the caption that is displayed for a control at design time.</para>
        </summary>
      </Docs>
    </Member>
    <Member MemberName="FrameStyle">
      <MemberSignature Language="C#" Value="public virtual System.Web.UI.WebControls.Style FrameStyle { get; }" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Web.UI.WebControls.Style</ReturnType>
      </ReturnValue>
      <Docs>
        <value>To be added.</value>
        <remarks>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>The <see cref="P:System.Web.UI.Design.ContainerControlDesigner.FrameStyle" /> property indicates the style properties of the frame around the editable region of the control on the design surface.</para>
        </remarks>
        <summary>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>Gets the style that is applied to the control frame at design time.</para>
        </summary>
      </Docs>
    </Member>
    <Member MemberName="GetDesignTimeCssAttributes">
      <MemberSignature Language="C#" Value="public virtual System.Collections.IDictionary GetDesignTimeCssAttributes ();" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Collections.IDictionary</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <remarks>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>The <see cref="M:System.Web.UI.Design.ContainerControlDesigner.GetDesignTimeCssAttributes" /> method returns a collection of style attributes for the design-time representation of the control.</para>
          <para>To examine a style attribute value at design time for a control, use the style attribute name as a key to the returned collection. Style attribute values are stored as strings in the collection. For example, you can access the height value in the collection as styleAttributes["height"] for C# or styleAttributes("height") for Microsoft Visual Basic.</para>
          <para>If the associated control is not derived from the <see cref="T:System.Web.UI.WebControls.WebControl" /> class, the <see cref="M:System.Web.UI.Design.ContainerControlDesigner.GetDesignTimeCssAttributes" /> method returns an empty collection.</para>
        </remarks>
        <summary>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>Returns the collection of style attributes for the control at design time.</para>
        </summary>
        <returns>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>A collection of style attributes applied to the control on the design surface. The style attribute names are keys used to access the style attribute values in the <see cref="T:System.Collections.IDictionary" />.</para>
        </returns>
      </Docs>
    </Member>
    <Member MemberName="GetDesignTimeHtml">
      <MemberSignature Language="C#" Value="public override string GetDesignTimeHtml (System.Web.UI.Design.DesignerRegionCollection regions);" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="regions" Type="System.Web.UI.Design.DesignerRegionCollection" />
      </Parameters>
      <Docs>
        <remarks>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>Use the <see cref="M:System.Web.UI.Design.ContainerControlDesigner.GetDesignTimeHtml(System.Web.UI.Design.DesignerRegionCollection)" /> method to get the HTML for the control. Child controls that are contained in the editable design region are rendered using their associated control designers.</para>
          <para>The <see cref="M:System.Web.UI.Design.ContainerControlDesigner.GetDesignTimeHtml(System.Web.UI.Design.DesignerRegionCollection)" /> method initializes a new <see cref="T:System.Web.UI.Design.EditableDesignerRegion" /> object for the editable region of associated control, and then returns the region through the <paramref name="regions" /> collection.</para>
        </remarks>
        <summary>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>Returns the HTML markup that is used to represent the control at design time.</para>
        </summary>
        <returns>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>An HTML markup string that represents the control.</para>
        </returns>
        <param name="regions">
          <attribution license="cc4" from="Microsoft" modified="false" />A collection of designer regions.</param>
      </Docs>
    </Member>
    <Member MemberName="GetEditableDesignerRegionContent">
      <MemberSignature Language="C#" Value="public override string GetEditableDesignerRegionContent (System.Web.UI.Design.EditableDesignerRegion region);" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="region" Type="System.Web.UI.Design.EditableDesignerRegion" />
      </Parameters>
      <Docs>
        <remarks>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>The <see cref="T:System.Web.UI.Design.ContainerControlDesigner" /> class implements a single designer region instead of a collection of designer regions. Therefore, the <paramref name="region" /> parameter is ignored, and the <see cref="M:System.Web.UI.Design.ContainerControlDesigner.GetEditableDesignerRegionContent(System.Web.UI.Design.EditableDesignerRegion)" /> method returns the content for the single designer region that is contained in the control designer.</para>
        </remarks>
        <summary>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>Returns the content for the editable region of the control at design time.</para>
        </summary>
        <returns>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>The persisted content of the region contained within the <see cref="T:System.Web.UI.Design.ContainerControlDesigner" />.</para>
        </returns>
        <param name="region">
          <attribution license="cc4" from="Microsoft" modified="false" />An editable design region contained within the control.</param>
      </Docs>
    </Member>
    <Member MemberName="GetPersistenceContent">
      <MemberSignature Language="C#" Value="public override string GetPersistenceContent ();" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <remarks>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>The <see cref="M:System.Web.UI.Design.ContainerControlDesigner.GetPersistenceContent" /> method returns null to indicate that the <see cref="T:System.Web.UI.Design.ContainerControlDesigner" /> class does not have persisted inner content.</para>
        </remarks>
        <summary>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>Returns the persistable content of the control at design time.</para>
        </summary>
        <returns>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>null.</para>
        </returns>
      </Docs>
    </Member>
    <Member MemberName="SetEditableDesignerRegionContent">
      <MemberSignature Language="C#" Value="public override void SetEditableDesignerRegionContent (System.Web.UI.Design.EditableDesignerRegion region, string content);" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="region" Type="System.Web.UI.Design.EditableDesignerRegion" />
        <Parameter Name="content" Type="System.String" />
      </Parameters>
      <Docs>
        <remarks>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>The <see cref="T:System.Web.UI.Design.ContainerControlDesigner" /> class implements a single designer region instead of a collection of designer regions. Therefore, the <paramref name="region" /> parameter is ignored, and the <see cref="M:System.Web.UI.Design.ContainerControlDesigner.SetEditableDesignerRegionContent(System.Web.UI.Design.EditableDesignerRegion,System.String)" /> method sets the content for the single designer region that is contained in the control designer.</para>
        </remarks>
        <summary>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>Sets the content for the editable region of the control at design time.</para>
        </summary>
        <param name="region">
          <attribution license="cc4" from="Microsoft" modified="false" />An editable design region contained within the control.</param>
        <param name="content">
          <attribution license="cc4" from="Microsoft" modified="false" />Content to assign for the editable design region.</param>
      </Docs>
    </Member>
  </Members>
</Type>