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

<?xml version="1.0" encoding="utf-8"?>
<Type Name="ChtmlTextWriter" FullName="System.Web.UI.ChtmlTextWriter">
  <TypeSignature Language="C#" Value="public class ChtmlTextWriter : System.Web.UI.Html32TextWriter" />
  <AssemblyInfo>
    <AssemblyName>System.Web</AssemblyName>
    <AssemblyVersion>2.0.0.0</AssemblyVersion>
  </AssemblyInfo>
  <Base>
    <BaseTypeName>System.Web.UI.Html32TextWriter</BaseTypeName>
  </Base>
  <Interfaces />
  <Docs>
    <since version=".NET 2.0" />
    <remarks>
      <attribution license="cc4" from="Microsoft" modified="false" />
      <para>Compact HTML, or cHTML, is a subset of HTML 2.0, HTML 3.2, and HTML 4.0, and is designed to render on devices with limited memory and CPU power, along with small display screens, limited formatting capabilities, and a limited number of input options (such as a cell phone touch pad). Therefore, cHTML does not support the following: </para>
      <list type="bullet">
        <item>
          <para>JPEG images. </para>
        </item>
        <item>
          <para>Tables. </para>
        </item>
        <item>
          <para>Image maps. </para>
        </item>
        <item>
          <para>Multiple character fonts and styles. </para>
        </item>
        <item>
          <para>Background colors and images. </para>
        </item>
        <item>
          <para>Frames. </para>
        </item>
        <item>
          <para>Style sheets. </para>
        </item>
      </list>
      <para>The <see cref="T:System.Web.UI.ChtmlTextWriter" /> class derives from the <see cref="T:System.Web.UI.Html32TextWriter" /> class and much of its functionality is provided by the <see cref="T:System.Web.UI.Html32TextWriter" /> and the base class for all markup text writers, which is the <see cref="T:System.Web.UI.HtmlTextWriter" /> class.</para>
    </remarks>
    <summary>
      <attribution license="cc4" from="Microsoft" modified="false" />
      <para>Writes a series of cHTML-specific characters and text to the output stream of an ASP.NET server control. The <see cref="T:System.Web.UI.ChtmlTextWriter" /> class provides formatting capabilities that ASP.NET server controls use when rendering cHTML content to clients.</para>
    </summary>
  </Docs>
  <Members>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public ChtmlTextWriter (System.IO.TextWriter writer);" />
      <MemberType>Constructor</MemberType>
      <Parameters>
        <Parameter Name="writer" Type="System.IO.TextWriter" />
      </Parameters>
      <Docs>
        <since version=".NET 2.0" />
        <remarks>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>The <see cref="T:System.Web.UI.ChtmlTextWriter" /> class has two constructors, which is standard for all classes that derive directly or indirectly from the <see cref="T:System.Web.UI.HtmlTextWriter" /> class.</para>
          <para>The <see cref="M:System.Web.UI.ChtmlTextWriter.#ctor(System.IO.TextWriter)" /> constructor, which takes an instance of the <see cref="T:System.IO.TextWriter" /> class as a parameter, calls the second constructor and passes it two parameter values: </para>
          <list type="bullet">
            <item>
              <para>The <see cref="T:System.IO.TextWriter" />.</para>
            </item>
            <item>
              <para>The string value that is specified in the <see cref="F:System.Web.UI.HtmlTextWriter.DefaultTabString" /> field, which defines the tab spacing that is used by the XHTML text writer.</para>
            </item>
          </list>
        </remarks>
        <summary>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>Initializes a new instance of the <see cref="T:System.Web.UI.ChtmlTextWriter" /> class that uses the <see cref="F:System.Web.UI.HtmlTextWriter.DefaultTabString" /> constant to indent lines.</para>
        </summary>
        <param name="writer">
          <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.IO.TextWriter" /> that renders the markup content. </param>
      </Docs>
      <AssemblyInfo>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
    </Member>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public ChtmlTextWriter (System.IO.TextWriter writer, string tabString);" />
      <MemberType>Constructor</MemberType>
      <Parameters>
        <Parameter Name="writer" Type="System.IO.TextWriter" />
        <Parameter Name="tabString" Type="System.String" />
      </Parameters>
      <Docs>
        <since version=".NET 2.0" />
        <remarks>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>The <see cref="M:System.Web.UI.ChtmlTextWriter.#ctor(System.IO.TextWriter,System.String)" /> constructor, which takes both an instance of the <see cref="T:System.IO.TextWriter" /> class and a string as parameters, calls the <see cref="T:System.Web.UI.Html32TextWriter" /> constructor that takes the same parameters when it creates an instance of the <see cref="T:System.Web.UI.ChtmlTextWriter" /> class. </para>
        </remarks>
        <summary>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>Initializes a new instance of the <see cref="T:System.Web.UI.ChtmlTextWriter" /> class with the specified line indentation.</para>
        </summary>
        <param name="writer">
          <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.IO.TextWriter" /> that renders the markup content. </param>
        <param name="tabString">
          <attribution license="cc4" from="Microsoft" modified="false" />The number of spaces defined in the <see cref="P:System.Web.UI.HtmlTextWriter.Indent" />. </param>
      </Docs>
      <AssemblyInfo>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
    </Member>
    <Member MemberName="AddRecognizedAttribute">
      <MemberSignature Language="C#" Value="public virtual void AddRecognizedAttribute (string elementName, string attributeName);" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="elementName" Type="System.String" />
        <Parameter Name="attributeName" Type="System.String" />
      </Parameters>
      <Docs>
        <since version=".NET 2.0" />
        <remarks>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>The <see cref="M:System.Web.UI.ChtmlTextWriter.AddRecognizedAttribute(System.String,System.String)" /> method adds an attribute to a cHTML element. The recognized attribute is stored in the recognized attributes <see cref="T:System.Collections.Hashtable" /> collection of the <see cref="T:System.Web.UI.ChtmlTextWriter" /> object that is referenced by the <see cref="P:System.Web.UI.ChtmlTextWriter.RecognizedAttributes" /> property.</para>
        </remarks>
        <summary>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>Adds an attribute to a cHTML element of the <see cref="T:System.Web.UI.ChtmlTextWriter" /> object.</para>
        </summary>
        <param name="elementName">
          <attribution license="cc4" from="Microsoft" modified="false" />The cHTML element to add the attribute to.</param>
        <param name="attributeName">
          <attribution license="cc4" from="Microsoft" modified="false" />The attribute to add to <paramref name="elementName" />.</param>
      </Docs>
      <AssemblyInfo>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
    </Member>
    <Member MemberName="GlobalSuppressedAttributes">
      <MemberSignature Language="C#" Value="protected System.Collections.Hashtable GlobalSuppressedAttributes { get; }" />
      <MemberType>Property</MemberType>
      <ReturnValue>
        <ReturnType>System.Collections.Hashtable</ReturnType>
      </ReturnValue>
      <Docs>
        <value>To be added.</value>
        <since version=".NET 2.0" />
        <remarks>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>The following list shows the globally suppressed attributes that are set when a new instance of the <see cref="T:System.Web.UI.ChtmlTextWriter" /> class is created.</para>
          <list type="table">
            <item>
              <term>
                <para>onclick</para>
              </term>
              <description>
                <para>onmousemove</para>
              </description>
            </item>
            <item>
              <term>
                <para>ondblclick</para>
              </term>
              <description>
                <para>onmouseout</para>
              </description>
            </item>
            <item>
              <term>
                <para>onmousedown</para>
              </term>
              <description>
                <para>onkeypress</para>
              </description>
            </item>
            <item>
              <term>
                <para>onmouseup</para>
              </term>
              <description>
                <para>onkeydown</para>
              </description>
            </item>
            <item>
              <term>
                <para>onmouseover</para>
              </term>
              <description>
                <para>onkeyup</para>
              </description>
            </item>
          </list>
        </remarks>
        <summary>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>Gets a <see cref="T:System.Collections.Hashtable" /> object of globally suppressed attributes that cannot be rendered on cHTML elements. </para>
        </summary>
      </Docs>
      <AssemblyInfo>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
    </Member>
    <Member MemberName="OnAttributeRender">
      <MemberSignature Language="C#" Value="protected override bool OnAttributeRender (string name, string value, System.Web.UI.HtmlTextWriterAttribute key);" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Boolean</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="name" Type="System.String" />
        <Parameter Name="value" Type="System.String" />
        <Parameter Name="key" Type="System.Web.UI.HtmlTextWriterAttribute" />
      </Parameters>
      <Docs>
        <since version=".NET 2.0" />
        <remarks>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>By default, the <see cref="M:System.Web.UI.ChtmlTextWriter.OnAttributeRender(System.String,System.String,System.Web.UI.HtmlTextWriterAttribute)" /> method prevents globally suppressed attributes that are listed in the <see cref="P:System.Web.UI.ChtmlTextWriter.GlobalSuppressedAttributes" /> property and element-specific, suppressed attributes that are listed in the <see cref="P:System.Web.UI.ChtmlTextWriter.SuppressedAttributes" /> property from being written to the output stream. You can override the behavior of the <see cref="M:System.Web.UI.ChtmlTextWriter.OnAttributeRender(System.String,System.String,System.Web.UI.HtmlTextWriterAttribute)" /> method in classes that are derived from the <see cref="T:System.Web.UI.ChtmlTextWriter" /> class.</para>
        </remarks>
        <summary>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>Determines whether the specified cHTML attribute and its value are rendered to the requesting page. You can override the <see cref="M:System.Web.UI.ChtmlTextWriter.OnAttributeRender(System.String,System.String,System.Web.UI.HtmlTextWriterAttribute)" /> method in classes that derive from the <see cref="T:System.Web.UI.ChtmlTextWriter" /> class to filter out attributes that you do not want to render on devices that support cHTML.</para>
        </summary>
        <returns>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>true to write the attribute and its value to the <see cref="T:System.Web.UI.ChtmlTextWriter" /> output stream; otherwise, false.</para>
        </returns>
        <param name="name">
          <attribution license="cc4" from="Microsoft" modified="false" />The cHTML attribute to render. </param>
        <param name="value">
          <attribution license="cc4" from="Microsoft" modified="false" />The value assigned to <paramref name="name" />. </param>
        <param name="key">
          <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Web.UI.HtmlTextWriterAttribute" /> associated with <paramref name="name" />. </param>
      </Docs>
      <AssemblyInfo>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
    </Member>
    <Member MemberName="OnStyleAttributeRender">
      <MemberSignature Language="C#" Value="protected override bool OnStyleAttributeRender (string styleAttrName, string value, System.Web.UI.HtmlTextWriterStyle key);" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Boolean</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="styleAttrName" Type="System.String" />
        <Parameter Name="value" Type="System.String" />
        <Parameter Name="key" Type="System.Web.UI.HtmlTextWriterStyle" />
      </Parameters>
      <Docs>
        <param name="styleAttrName">To be added.</param>
        <since version=".NET 2.0" />
        <remarks>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>The <see cref="M:System.Web.UI.ChtmlTextWriter.OnStyleAttributeRender(System.String,System.String,System.Web.UI.HtmlTextWriterStyle)" /> method returns false when <paramref name="key" /> is equal to the <see cref="F:System.Web.UI.HtmlTextWriterStyle.TextDecoration" /> field and the value is "line-through".</para>
        </remarks>
        <summary>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>Determines whether the specified cHTML markup style attribute and its value can be rendered to the current markup element.</para>
        </summary>
        <returns>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>true if the style can be rendered; otherwise, false.</para>
        </returns>
        <param name="value">
          <attribution license="cc4" from="Microsoft" modified="false" />A string containing the value that is assigned to <paramref name="name" />. </param>
        <param name="key">
          <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Web.UI.HtmlTextWriterStyle" /> associated with <paramref name="name" />.</param>
      </Docs>
      <AssemblyInfo>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
    </Member>
    <Member MemberName="OnTagRender">
      <MemberSignature Language="C#" Value="protected override bool OnTagRender (string name, System.Web.UI.HtmlTextWriterTag tag);" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Boolean</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="name" Type="System.String" />
        <Parameter Name="tag" Type="System.Web.UI.HtmlTextWriterTag" />
      </Parameters>
      <Docs>
        <param name="tag">To be added.</param>
        <since version=".NET 2.0" />
        <remarks>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>If the cHTML element is a span element, the <see cref="M:System.Web.UI.ChtmlTextWriter.OnTagRender(System.String,System.Web.UI.HtmlTextWriterTag)" /> method returns false. For all other tags, it returns true.</para>
        </remarks>
        <summary>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>Determines whether the specified cHTML markup element is rendered to the requesting page. </para>
        </summary>
        <returns>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>true if the specified cHTML markup element can be rendered; otherwise, false.</para>
        </returns>
        <param name="name">
          <attribution license="cc4" from="Microsoft" modified="false" />A string containing the name of the cHTML element to render.</param>
      </Docs>
      <AssemblyInfo>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
    </Member>
    <Member MemberName="RecognizedAttributes">
      <MemberSignature Language="C#" Value="protected System.Collections.Hashtable RecognizedAttributes { get; }" />
      <MemberType>Property</MemberType>
      <ReturnValue>
        <ReturnType>System.Collections.Hashtable</ReturnType>
      </ReturnValue>
      <Docs>
        <value>To be added.</value>
        <since version=".NET 2.0" />
        <remarks>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>Use the <see cref="M:System.Web.UI.ChtmlTextWriter.AddRecognizedAttribute(System.String,System.String)" /> method to add recognized attributes to the recognized attributes collection.</para>
        </remarks>
        <summary>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>Gets a <see cref="T:System.Collections.Hashtable" /> object of recognized attributes that could be rendered on cHTML elements.</para>
        </summary>
      </Docs>
      <AssemblyInfo>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
    </Member>
    <Member MemberName="RemoveRecognizedAttribute">
      <MemberSignature Language="C#" Value="public virtual void RemoveRecognizedAttribute (string elementName, string attributeName);" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="elementName" Type="System.String" />
        <Parameter Name="attributeName" Type="System.String" />
      </Parameters>
      <Docs>
        <since version=".NET 2.0" />
        <remarks>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>The <see cref="M:System.Web.UI.ChtmlTextWriter.RemoveRecognizedAttribute(System.String,System.String)" /> method removes an attribute from a cHTML element. The recognized attribute is removed from the recognized attributes <see cref="T:System.Collections.Hashtable" /> collection of the <see cref="T:System.Web.UI.ChtmlTextWriter" /> object that is referenced by the <see cref="P:System.Web.UI.ChtmlTextWriter.RecognizedAttributes" /> property.</para>
        </remarks>
        <summary>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>Removes an attribute of a cHTML element of the <see cref="T:System.Web.UI.ChtmlTextWriter" /> object.</para>
        </summary>
        <param name="elementName">
          <attribution license="cc4" from="Microsoft" modified="false" />The cHTML element to remove an attribute from.</param>
        <param name="attributeName">
          <attribution license="cc4" from="Microsoft" modified="false" />The attribute to remove from <paramref name="elementName" />.</param>
      </Docs>
      <AssemblyInfo>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
    </Member>
    <Member MemberName="SuppressedAttributes">
      <MemberSignature Language="C#" Value="protected System.Collections.Hashtable SuppressedAttributes { get; }" />
      <MemberType>Property</MemberType>
      <ReturnValue>
        <ReturnType>System.Collections.Hashtable</ReturnType>
      </ReturnValue>
      <Docs>
        <value>To be added.</value>
        <since version=".NET 2.0" />
        <remarks>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>Use the <see cref="M:System.Web.UI.ChtmlTextWriter.RemoveRecognizedAttribute(System.String,System.String)" /> method to add attributes to the suppressed attributes collection.</para>
          <para>The following list shows the default suppressed attributes that are set for a div element when a new instance of the <see cref="T:System.Web.UI.ChtmlTextWriter" /> class is created.</para>
          <list type="table">
            <item>
              <term>
                <para>accesskey</para>
              </term>
              <description>
                <para>gridlines</para>
              </description>
            </item>
            <item>
              <term>
                <para>cellspacing</para>
              </term>
              <description>
                <para>rules</para>
              </description>
            </item>
            <item>
              <term>
                <para>cellpadding</para>
              </term>
              <description>
                <para> </para>
              </description>
            </item>
          </list>
          <para>The following list shows the default suppressed attributes that are set for a span element when a new instance of the <see cref="T:System.Web.UI.ChtmlTextWriter" /> class is created.</para>
          <list type="table">
            <item>
              <term>
                <para>cellspacing</para>
              </term>
              <description>
                <para>gridlines</para>
              </description>
            </item>
            <item>
              <term>
                <para>cellpadding</para>
              </term>
              <description>
                <para>rules</para>
              </description>
            </item>
          </list>
        </remarks>
        <summary>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>Gets a <see cref="T:System.Collections.Hashtable" /> object of user-specified suppressed attributes that are not rendered on cHTML elements.</para>
        </summary>
      </Docs>
      <AssemblyInfo>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
    </Member>
    <Member MemberName="WriteBreak">
      <MemberSignature Language="C#" Value="public override void WriteBreak ();" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <since version=".NET 2.0" />
        <remarks>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>Use the <see cref="M:System.Web.UI.ChtmlTextWriter.WriteBreak" /> method to insert a line break into a stream of cHMTL.</para>
        </remarks>
        <summary>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>Writes a br element to the cHTML output stream.</para>
        </summary>
      </Docs>
      <AssemblyInfo>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
    </Member>
    <Member MemberName="WriteEncodedText">
      <MemberSignature Language="C#" Value="public override void WriteEncodedText (string text);" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="text" Type="System.String" />
      </Parameters>
      <Docs>
        <since version=".NET 2.0" />
        <remarks>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>If the text parameter passed into the <see cref="M:System.Web.UI.ChtmlTextWriter.WriteEncodedText(System.String)" /> method is null or has a length of zero, then nothing is written.</para>
          <para>Use the <see cref="M:System.Web.UI.ChtmlTextWriter.WriteEncodedText(System.String)" /> method when a string contains angle brackets (&lt; or &gt;) or an ampersand (&amp;) and you want to ensure that they are rendered correctly on the requesting device. </para>
          <para>The <see cref="M:System.Web.UI.ChtmlTextWriter.WriteEncodedText(System.String)" /> method uses the base class's <see cref="M:System.Web.UI.HtmlTextWriter.WriteEncodedText(System.String)" /> method.</para>
        </remarks>
        <summary>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>Encodes the specified text for the requesting device, and then writes it to the output stream. </para>
        </summary>
        <param name="text">
          <attribution license="cc4" from="Microsoft" modified="false" />The text string to encode and write to the output stream. </param>
      </Docs>
      <AssemblyInfo>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
    </Member>
  </Members>
</Type>