linux-packaging-mono/mcs/class/System.Web/Documentation/en/System.Web.UI.HtmlControls/HtmlContainerControl.xml

<?xml version="1.0" encoding="utf-8"?>
<Type Name="HtmlContainerControl" FullName="System.Web.UI.HtmlControls.HtmlContainerControl">
  <TypeSignature Language="C#" Maintainer="auto" Value="public abstract class HtmlContainerControl : System.Web.UI.HtmlControls.HtmlControl" />
  <AssemblyInfo>
    <AssemblyName>System.Web</AssemblyName>
    <AssemblyPublicKey>
    </AssemblyPublicKey>
    <AssemblyVersion>1.0.5000.0</AssemblyVersion>
    <AssemblyVersion>2.0.0.0</AssemblyVersion>
  </AssemblyInfo>
  <ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the &lt;link location="node:gtk-sharp/programming/threads"&gt;Gtk# Thread Programming&lt;/link&gt; for details.</ThreadSafetyStatement>
  <Base>
    <BaseTypeName>System.Web.UI.HtmlControls.HtmlControl</BaseTypeName>
  </Base>
  <Interfaces>
  </Interfaces>
  <Docs>
    <remarks>
      <attribution license="cc4" from="Microsoft" modified="false" />
      <para>The most common controls with a closing tag are the &lt;form&gt;, &lt;table&gt;, &lt;tr&gt;, &lt;td&gt;, &lt;a&gt;, and &lt;span&gt; elements.</para>
      <para>The <see cref="P:System.Web.UI.HtmlControls.HtmlContainerControl.InnerText" /> and <see cref="P:System.Web.UI.HtmlControls.HtmlContainerControl.InnerHtml" /> properties allow you to manipulate the content between the opening and closing tags of <see cref="T:System.Web.UI.HtmlControls.HtmlContainerControl" />-derived controls.</para>
      <para>For a list of initial property values for an instance of <see cref="T:System.Web.UI.HtmlControls.HtmlContainerControl" />, see the <see cref="M:System.Web.UI.HtmlControls.HtmlContainerControl.#ctor" /> constructor.</para>
      <para>A new instance of this class is not created directly.</para>
      <block subset="none" type="note">
        <para>If you use the <see cref="P:System.Web.UI.HtmlControls.HtmlContainerControl.InnerHtml" /> property to specify the text between the opening and closing tags of an HTML server control, the text is not HTML encoded. This makes it possible to embed script within HTML tags in the text. When using the <see cref="P:System.Web.UI.HtmlControls.HtmlContainerControl.InnerHtml" /> property, be sure to validate the value to reduce security vulnerabilities. Otherwise, consider using the <see cref="P:System.Web.UI.HtmlControls.HtmlContainerControl.InnerText" /> property instead.</para>
      </block>
    </remarks>
    <summary>
      <attribution license="cc4" from="Microsoft" modified="false" />
      <para>Serves as the abstract base class for HTML server controls that map to HTML elements that are required to have an opening and a closing tag.</para>
    </summary>
  </Docs>
  <Members>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="protected HtmlContainerControl ();" />
      <MemberType>Constructor</MemberType>
      <ReturnValue />
      <Parameters />
      <Docs>
        <remarks>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>Use this constructor to create and initialize a new instance of the <see cref="T:System.Web.UI.HtmlControls.HtmlContainerControl" /> class using default values.</para>
          <block subset="none" type="note">
            <para>An instance of this class is not created directly. This constructor is called from the constructor of other HTML control classes to initialize properties defined in this class.</para>
          </block>
          <para>The following table shows initial property values for an instance of <see cref="T:System.Web.UI.HtmlControls.HtmlContainerControl" />.</para>
          <list type="table">
            <listheader>
              <item>
                <term>
                  <para>Property </para>
                </term>
                <description>
                  <para>Initial Value </para>
                </description>
              </item>
            </listheader>
            <item>
              <term>
                <para>
                  <see cref="P:System.Web.UI.HtmlControls.HtmlControl.TagName" /> </para>
              </term>
              <description>
                <para>The "span" literal string. </para>
              </description>
            </item>
          </list>
        </remarks>
        <summary>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>Initializes a new instance of the <see cref="T:System.Web.UI.HtmlControls.HtmlContainerControl" /> class using default values.</para>
        </summary>
      </Docs>
      <AssemblyInfo>
        <AssemblyVersion>1.0.5000.0</AssemblyVersion>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
    </Member>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public HtmlContainerControl (string tag);" />
      <MemberType>Constructor</MemberType>
      <ReturnValue />
      <Parameters>
        <Parameter Name="tag" Type="System.String" />
      </Parameters>
      <Docs>
        <remarks>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>Use this constructor to create and initialize a new instance of the <see cref="T:System.Web.UI.HtmlControls.HtmlContainerControl" /> class using the specified tag.</para>
          <block subset="none" type="note">
            <para>An instance of this class is not created directly. This constructor is called from the constructor of other HTML control classes to initialize properties defined in this class.</para>
          </block>
          <para>The following table shows initial property values for an instance of <see cref="T:System.Web.UI.HtmlControls.HtmlContainerControl" />.</para>
          <list type="table">
            <listheader>
              <item>
                <term>
                  <para>Property </para>
                </term>
                <description>
                  <para>Initial Value </para>
                </description>
              </item>
            </listheader>
            <item>
              <term>
                <para>
                  <see cref="P:System.Web.UI.HtmlControls.HtmlControl.TagName" /> </para>
              </term>
              <description>
                <para>The value specified by the <paramref name="tag" /> parameter. </para>
              </description>
            </item>
          </list>
        </remarks>
        <summary>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>Initializes a new instance of the <see cref="T:System.Web.UI.HtmlControls.HtmlContainerControl" /> class using the specified tag name.</para>
        </summary>
        <param name="tag">
          <attribution license="cc4" from="Microsoft" modified="false" />A string that specifies the tag name of the control. </param>
      </Docs>
      <AssemblyInfo>
        <AssemblyVersion>1.0.5000.0</AssemblyVersion>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
    </Member>
    <Member MemberName="CreateControlCollection">
      <MemberSignature Language="C#" Value="protected override System.Web.UI.ControlCollection CreateControlCollection ();" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Web.UI.ControlCollection</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>To be added</summary>
        <returns>a <see cref="T:System.Web.UI.ControlCollection" /></returns>
        <remarks>To be added</remarks>
      </Docs>
      <AssemblyInfo>
        <AssemblyVersion>1.0.5000.0</AssemblyVersion>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
    </Member>
    <Member MemberName="InnerHtml">
      <MemberSignature Language="C#" Value="public virtual string InnerHtml { set; get; }" />
      <MemberType>Property</MemberType>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <value>To be added: an object of type 'string'</value>
        <remarks>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>Use the <see cref="P:System.Web.UI.HtmlControls.HtmlContainerControl.InnerHtml" /> property to programmatically modify the contents between the opening and closing tags of an HTML server control.</para>
          <para>The <see cref="P:System.Web.UI.HtmlControls.HtmlContainerControl.InnerHtml" /> property does not automatically encode special characters to and from HTML entities. HTML entities allow you to display special characters, such as the &lt; character, that a browser would ordinarily interpret as having special meaning. The &lt; character would be interpreted as the start of a tag and is not displayed on the page. To display the &lt; character, you would need to use the entity &amp;lt;.</para>
          <para>For example, if the <see cref="P:System.Web.UI.HtmlControls.HtmlContainerControl.InnerHtml" /> property is set to "&lt;b&gt; Hello &lt;/b&gt;", the &lt; and &gt; characters are not converted to &amp;lt; and &amp;gt;, respectively. The rendered output would still be: &lt;b&gt; Hello &lt;/b&gt;. The browser will detect the &lt;b&gt; tags and display the text, Hello, in a bold font.</para>
          <block subset="none" type="note">
            <para>Because the text is not HTML encoded, it possible to embed script within HTML tags in the text. If this property is set dynamically using user input, be sure to validate the value to reduce security vulnerabilities. For more information, see <format type="text/html"><a href="9141076a-96c9-4b01-93de-366bb1d858bc">Security and User Input</a></format>.</para>
          </block>
          <para>To provide automatic HTML encoding and decoding, use the <see cref="P:System.Web.UI.HtmlControls.HtmlContainerControl.InnerText" /> property.</para>
          <block subset="none" type="note">
            <para>If there are no child controls, the <see cref="P:System.Web.UI.HtmlControls.HtmlContainerControl.InnerHtml" /> property contains the value <see cref="F:System.String.Empty" />.</para>
          </block>
        </remarks>
        <summary>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>Gets or sets the content found between the opening and closing tags of the specified HTML server control.</para>
        </summary>
      </Docs>
      <AssemblyInfo>
        <AssemblyVersion>1.0.5000.0</AssemblyVersion>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Attributes>
        <Attribute>
          <AttributeName>System.ComponentModel.DesignerSerializationVisibility(System.ComponentModel.DesignerSerializationVisibility.Hidden)</AttributeName>
        </Attribute>
        <Attribute>
          <AttributeName>System.ComponentModel.Browsable(false)</AttributeName>
        </Attribute>
      </Attributes>
    </Member>
    <Member MemberName="InnerText">
      <MemberSignature Language="C#" Value="public virtual string InnerText { set; get; }" />
      <MemberType>Property</MemberType>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <value>To be added: an object of type 'string'</value>
        <remarks>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>Use the <see cref="P:System.Web.UI.HtmlControls.HtmlContainerControl.InnerText" /> property to programmatically modify the text between the opening and closing tags of an HTML server control.</para>
          <para>Unlike the <see cref="P:System.Web.UI.HtmlControls.HtmlContainerControl.InnerHtml" /> property, the <see cref="P:System.Web.UI.HtmlControls.HtmlContainerControl.InnerText" /> property automatically encodes special characters to and from HTML entities. HTML entities allow you to display special characters, such as the &lt; character, that a browser would ordinarily interpret as having special meaning. The &lt; character would be interpreted as the start of a tag and is not displayed on the page. To display the &lt; character, you would need to use the entity &amp;lt;.</para>
          <para>For example, if the <see cref="P:System.Web.UI.HtmlControls.HtmlContainerControl.InnerText" /> property is set to "&lt;b&gt; Hello &lt;/b&gt;", the &lt; and &gt; symbols are converted to &amp;lt; and &amp;gt;, respectively. The rendered output would be: &amp;lt; b &amp;gt; Hello &amp;lt; /b &amp;gt;. The &amp;lt; and &amp;gt; entities would indicate to the browser that these characters are to be displayed on the page. The browser will not detect the &lt;b&gt; tags and display the text in a bold font. The text displayed on the page is: &lt;b&gt; Hello &lt;/b&gt;.</para>
          <para>To prevent automatic HTML encoding and decoding, use the <see cref="P:System.Web.UI.HtmlControls.HtmlContainerControl.InnerHtml" /> property.</para>
          <block subset="none" type="note">
            <para>If there are no child controls, the <see cref="P:System.Web.UI.HtmlControls.HtmlContainerControl.InnerHtml" /> property contains the value <see cref="F:System.String.Empty" />.</para>
          </block>
        </remarks>
        <summary>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>Gets or sets the text between the opening and closing tags of the specified HTML server control.</para>
        </summary>
      </Docs>
      <AssemblyInfo>
        <AssemblyVersion>1.0.5000.0</AssemblyVersion>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Attributes>
        <Attribute>
          <AttributeName>System.ComponentModel.DesignerSerializationVisibility(System.ComponentModel.DesignerSerializationVisibility.Hidden)</AttributeName>
        </Attribute>
        <Attribute>
          <AttributeName>System.ComponentModel.Browsable(false)</AttributeName>
        </Attribute>
      </Attributes>
    </Member>
    <Member MemberName="LoadViewState">
      <MemberSignature Language="C#" Value="protected override void LoadViewState (object savedState);" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="savedState" Type="System.Object" />
      </Parameters>
      <Docs>
        <remarks>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>This method is used primarily by the .NET Framework infrastructure and is not intended to be used directly from your code. However, control developers can override this method to specify how a custom server control restores its view state. For more information, see <format type="text/html"><a href="0218d965-5d30-445b-b6a6-8870e70e63ce">ASP.NET State Management Overview</a></format>.</para>
          <para>The <see cref="M:System.Web.UI.HtmlControls.HtmlContainerControl.LoadViewState(System.Object)" /> method calls the base class's <see cref="M:System.Web.UI.Control.LoadViewState(System.Object)" /> method. In addition, the <see cref="M:System.Web.UI.HtmlControls.HtmlContainerControl.LoadViewState(System.Object)" /> method sets the <see cref="P:System.Web.UI.HtmlControls.HtmlContainerControl.InnerHtml" /> property.</para>
        </remarks>
        <summary>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>Restores the <see cref="T:System.Web.UI.HtmlControls.HtmlContainerControl" /> control's view state from a previous page request that was saved by the <see cref="M:System.Web.UI.Control.SaveViewState" /> method.</para>
        </summary>
        <param name="savedState">
          <attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.Object" /> that represents the control state to be restored.</param>
      </Docs>
      <AssemblyInfo>
        <AssemblyVersion>1.0.5000.0</AssemblyVersion>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
    </Member>
    <Member MemberName="Render">
      <MemberSignature Language="C#" Value="protected override void Render (System.Web.UI.HtmlTextWriter writer);" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="writer" Type="System.Web.UI.HtmlTextWriter" />
      </Parameters>
      <Docs>
        <remarks>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>The <see cref="M:System.Web.UI.HtmlControls.HtmlContainerControl.Render(System.Web.UI.HtmlTextWriter)" /> method overrides the <see cref="M:System.Web.UI.HtmlControls.HtmlControl.Render(System.Web.UI.HtmlTextWriter)" /> method to render the opening tag, child controls, and closing tag of the <see cref="T:System.Web.UI.HtmlControls.HtmlContainerControl" /> control.</para>
          <para>The <see cref="M:System.Web.UI.HtmlControls.HtmlContainerControl.Render(System.Web.UI.HtmlTextWriter)" /> method is used primarily by control developers extending the functionality of the <see cref="T:System.Web.UI.HtmlControls.HtmlContainerControl" /> control.</para>
        </remarks>
        <summary>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>Renders the <see cref="T:System.Web.UI.HtmlControls.HtmlContainerControl" /> control to the specified <see cref="T:System.Web.UI.HtmlTextWriter" /> object.</para>
        </summary>
        <param name="writer">
          <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Web.UI.HtmlTextWriter" /> that receives the <see cref="T:System.Web.UI.HtmlControls.HtmlContainerControl" /> content.</param>
      </Docs>
      <AssemblyInfo>
        <AssemblyVersion>1.0.5000.0</AssemblyVersion>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
    </Member>
    <Member MemberName="RenderAttributes">
      <MemberSignature Language="C#" Value="protected override void RenderAttributes (System.Web.UI.HtmlTextWriter writer);" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="writer" Type="System.Web.UI.HtmlTextWriter" />
      </Parameters>
      <Docs>
        <remarks>To be added</remarks>
        <summary>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>Renders the <see cref="T:System.Web.UI.HtmlControls.HtmlContainerControl" /> control's attributes to the specified <see cref="T:System.Web.UI.HtmlTextWriter" /> object.</para>
        </summary>
        <param name="writer">
          <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Web.UI.HtmlTextWriter" /> instance that receives the rendered content.</param>
      </Docs>
      <AssemblyInfo>
        <AssemblyVersion>1.0.5000.0</AssemblyVersion>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
    </Member>
    <Member MemberName="RenderEndTag">
      <MemberSignature Language="C#" Value="protected virtual void RenderEndTag (System.Web.UI.HtmlTextWriter writer);" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="writer" Type="System.Web.UI.HtmlTextWriter" />
      </Parameters>
      <Docs>
        <remarks>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>The <see cref="M:System.Web.UI.HtmlControls.HtmlContainerControl.RenderEndTag(System.Web.UI.HtmlTextWriter)" /> method is called by the <see cref="M:System.Web.UI.HtmlControls.HtmlContainerControl.Render(System.Web.UI.HtmlTextWriter)" /> method to render the closing tag of the <see cref="T:System.Web.UI.HtmlControls.HtmlContainerControl" /> control.</para>
          <para>The <see cref="M:System.Web.UI.HtmlControls.HtmlContainerControl.RenderEndTag(System.Web.UI.HtmlTextWriter)" /> method is used primarily by control developers extending the functionality of the <see cref="T:System.Web.UI.HtmlControls.HtmlContainerControl" /> control.</para>
        </remarks>
        <summary>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>Renders the closing tag for the <see cref="T:System.Web.UI.HtmlControls.HtmlContainerControl" /> control to the specified <see cref="T:System.Web.UI.HtmlTextWriter" /> object.</para>
        </summary>
        <param name="writer">
          <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Web.UI.HtmlTextWriter" /> that receives the rendered content.</param>
      </Docs>
      <AssemblyInfo>
        <AssemblyVersion>1.0.5000.0</AssemblyVersion>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
    </Member>
  </Members>
</Type>