Jo Shields a575963da9 Imported Upstream version 3.6.0
Former-commit-id: da6be194a6b1221998fc28233f2503bd61dd9d14
2014-08-13 10:39:27 +01:00

148 lines
8.0 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<Type Name="LiteralControl" FullName="System.Web.UI.LiteralControl">
<TypeSignature Language="C#" Maintainer="auto" Value="public class LiteralControl : System.Web.UI.Control, System.Web.UI.ITextControl" />
<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.Control</BaseTypeName>
</Base>
<Interfaces>
<Interface>
<InterfaceName>System.Web.UI.ITextControl</InterfaceName>
</Interface>
</Interfaces>
<Attributes>
<Attribute>
<AttributeName>System.ComponentModel.ToolboxItem(false)</AttributeName>
</Attribute>
</Attributes>
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>ASP.NET compiles all HTML elements and readable text that do not require server-side processing into instances of this class. For example, an HTML element that does not contain a runat="server" attribute/value pair in its opening tag is compiled into a <see cref="T:System.Web.UI.LiteralControl" /> object. <see cref="T:System.Web.UI.LiteralControl" /> objects do not maintain view state, so the contents of a <see cref="T:System.Web.UI.LiteralControl" /> object must be recreated on each request.</para>
<para>Literal controls behave as text holders, meaning that you can extract text from the literal control and remove the literal control from the parent server control's <see cref="T:System.Web.UI.ControlCollection" /> collection through the parent's <see cref="P:System.Web.UI.Control.Controls" /> property. Therefore, when you develop a custom control derived from the <see cref="T:System.Web.UI.LiteralControl" /> class, make sure your control performs any required preprocessing steps itself, rather than using a call to the <see cref="M:System.Web.UI.LiteralControl.Render(System.Web.UI.HtmlTextWriter)" /> method to accomplish them. Typically, you would do this to improve the response time of your Web application.</para>
<para>You can add or remove literal controls from a page or server control programmatically using the <see cref="M:System.Web.UI.ControlCollection.Add(System.Web.UI.Control)" /> or the <see cref="M:System.Web.UI.ControlCollection.Remove(System.Web.UI.Control)" /> method, respectively.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Represents HTML elements, text, and any other strings in an ASP.NET page that do not require processing on the server.</para>
</summary>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public LiteralControl ();" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<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.LiteralControl" /> class that contains a literal string to be rendered on the requested ASP.NET page.</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 LiteralControl (string text);" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="text" Type="System.String" />
</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.LiteralControl" /> class with the specified text.</para>
</summary>
<param name="text">
<attribution license="cc4" from="Microsoft" modified="false" />The text to be rendered on the requested Web page. </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>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>By default, <see cref="T:System.Web.UI.LiteralControl" /> objects contain only text and no child server controls. If you want to change this behavior, you must override this method.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Creates an <see cref="T:System.Web.UI.EmptyControlCollection" /> object for the current instance of the <see cref="T:System.Web.UI.LiteralControl" /> class.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="T:System.Web.UI.EmptyControlCollection" /> for the current control.</para>
</returns>
</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>
<param name="writer">a <see cref="T:System.Web.UI.HtmlTextWriter" /></param>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>When you create a custom server control and want to render specific HTML or text to a client, you can improve the performance of the control by passing the value of the <see cref="P:System.Web.UI.LiteralControl.Text" /> property to the <see cref="M:System.Web.UI.Control.Render(System.Web.UI.HtmlTextWriter)" /> method rather than calling the <see cref="M:System.Web.UI.LiteralControl.Render(System.Web.UI.HtmlTextWriter)" /> method.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Writes the content of the <see cref="T:System.Web.UI.LiteralControl" /> object to the ASP.NET page.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="Text">
<MemberSignature Language="C#" Value="public virtual string Text { set; get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<value>To be added: an object of type 'string'</value>
<remarks>To be added</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets or sets the text content of the <see cref="T:System.Web.UI.LiteralControl" /> object.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
</Members>
</Type>