Skip to content
Permalink
Branch: master
Find file Copy path
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
164 lines (155 sloc) 10.4 KB
<Type Name="LiteralControlBuilder" FullName="System.Web.UI.WebControls.LiteralControlBuilder">
<TypeSignature Language="C#" Value="public class LiteralControlBuilder : System.Web.UI.ControlBuilder" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit LiteralControlBuilder extends System.Web.UI.ControlBuilder" />
<TypeSignature Language="DocId" Value="T:System.Web.UI.WebControls.LiteralControlBuilder" />
<TypeSignature Language="VB.NET" Value="Public Class LiteralControlBuilder&#xA;Inherits ControlBuilder" />
<TypeSignature Language="C++ CLI" Value="public ref class LiteralControlBuilder : System::Web::UI::ControlBuilder" />
<TypeSignature Language="F#" Value="type LiteralControlBuilder = class&#xA; inherit ControlBuilder" />
<AssemblyInfo>
<AssemblyName>System.Web</AssemblyName>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Web.UI.ControlBuilder</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>Interacts with the parser to build a <see cref="T:System.Web.UI.WebControls.Literal" /> control.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
This class is used primarily for control developers. To create a custom control builder for a <xref:System.Web.UI.WebControls.Literal> derived control, you need to inherit from this class.
]]></format>
</remarks>
<altmember cref="T:System.Web.UI.ControlBuilder" />
<related type="Article" href="https://msdn.microsoft.com/library/9f856045-c514-4efb-8c6c-30c0c29cc780">Literal Web Server Control Overview</related>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public LiteralControlBuilder ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:System.Web.UI.WebControls.LiteralControlBuilder.#ctor" />
<MemberSignature Language="VB.NET" Value="Public Sub New ()" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; LiteralControlBuilder();" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>System.Web</AssemblyName>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="netframework-4.0">
<AttributeName>System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")</AttributeName>
</Attribute>
</Attributes>
<Parameters />
<Docs>
<summary>Initializes a new instance of the <see cref="T:System.Web.UI.WebControls.LiteralControlBuilder" /> class.</summary>
<remarks>To be added.</remarks>
<altmember cref="T:System.Web.UI.ControlBuilder" />
</Docs>
</Member>
<Member MemberName="AllowWhitespaceLiterals">
<MemberSignature Language="C#" Value="public override bool AllowWhitespaceLiterals ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance bool AllowWhitespaceLiterals() cil managed" />
<MemberSignature Language="DocId" Value="M:System.Web.UI.WebControls.LiteralControlBuilder.AllowWhitespaceLiterals" />
<MemberSignature Language="VB.NET" Value="Public Overrides Function AllowWhitespaceLiterals () As Boolean" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; override bool AllowWhitespaceLiterals();" />
<MemberSignature Language="F#" Value="override this.AllowWhitespaceLiterals : unit -&gt; bool" Usage="literalControlBuilder.AllowWhitespaceLiterals " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Web</AssemblyName>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Determines whether the control builder should process the white space literals that are represented by the <see cref="T:System.Web.UI.WebControls.Literal" /> control.</summary>
<returns>
<see langword="false" />.</returns>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The <xref:System.Web.UI.WebControls.LiteralControlBuilder.AllowWhitespaceLiterals%2A> method overrides the inherited implementation of the <xref:System.Web.UI.ControlBuilder.AllowWhitespaceLiterals%2A?displayProperty=nameWithType> method to always indicate that white spaces in the text that are associated with the <xref:System.Web.UI.WebControls.Literal> control are not represented by <xref:System.Web.UI.WebControls.Literal?displayProperty=nameWithType> objects.
]]></format>
</remarks>
<altmember cref="M:System.Web.UI.ControlBuilder.AllowWhitespaceLiterals" />
<altmember cref="T:System.Web.UI.ControlBuilder" />
<altmember cref="T:System.Web.UI.LiteralControl" />
</Docs>
</Member>
<Member MemberName="AppendLiteralString">
<MemberSignature Language="C#" Value="public override void AppendLiteralString (string s);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance void AppendLiteralString(string s) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Web.UI.WebControls.LiteralControlBuilder.AppendLiteralString(System.String)" />
<MemberSignature Language="VB.NET" Value="Public Overrides Sub AppendLiteralString (s As String)" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; override void AppendLiteralString(System::String ^ s);" />
<MemberSignature Language="F#" Value="override this.AppendLiteralString : string -&gt; unit" Usage="literalControlBuilder.AppendLiteralString s" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Web</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="s" Type="System.String" Index="0" FrameworkAlternate="netframework-2.0;netframework-3.0;netframework-3.5;netframework-4.0;netframework-4.5;netframework-4.5.1;netframework-4.5.2;netframework-4.6;netframework-4.6.1;netframework-4.6.2;netframework-4.7;netframework-4.7.1;netframework-4.7.2;netframework-4.8" />
</Parameters>
<Docs>
<param name="s">The content to add to the control.</param>
<summary>Adds the specified literal content to a control. The <see cref="M:System.Web.UI.WebControls.LiteralControlBuilder.AppendLiteralString(System.String)" /> method is called by the ASP.NET page framework.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
If the string is white space, it is handled according to the setting of the <xref:System.Web.UI.WebControls.LiteralControlBuilder.AllowWhitespaceLiterals%2A> method. Otherwise, it is treated as if the inner text represents the <xref:System.Web.UI.WebControls.Literal.Text%2A> property.
]]></format>
</remarks>
<exception cref="T:System.Web.HttpException">The string literal is not well formed.</exception>
<altmember cref="M:System.Web.UI.ControlBuilder.AppendLiteralString(System.String)" />
</Docs>
</Member>
<Member MemberName="AppendSubBuilder">
<MemberSignature Language="C#" Value="public override void AppendSubBuilder (System.Web.UI.ControlBuilder subBuilder);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance void AppendSubBuilder(class System.Web.UI.ControlBuilder subBuilder) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Web.UI.WebControls.LiteralControlBuilder.AppendSubBuilder(System.Web.UI.ControlBuilder)" />
<MemberSignature Language="VB.NET" Value="Public Overrides Sub AppendSubBuilder (subBuilder As ControlBuilder)" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; override void AppendSubBuilder(System::Web::UI::ControlBuilder ^ subBuilder);" />
<MemberSignature Language="F#" Value="override this.AppendSubBuilder : System.Web.UI.ControlBuilder -&gt; unit" Usage="literalControlBuilder.AppendSubBuilder subBuilder" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Web</AssemblyName>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="subBuilder" Type="System.Web.UI.ControlBuilder" />
</Parameters>
<Docs>
<param name="subBuilder">The <see cref="T:System.Web.UI.ControlBuilder" /> object to add the child control builders to.</param>
<summary>Throws <see cref="T:System.Web.HttpException" />, because adding child control builders does not apply to the <see cref="T:System.Web.UI.WebControls.Literal" /> control.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
In the <xref:System.Web.UI.ControlBuilder> base class, this method adds the builders of all child controls associated with the <xref:System.Web.UI.WebControls.Literal> control to the specified <xref:System.Web.UI.ControlBuilder?displayProperty=nameWithType> object. This method is inherited from the <xref:System.Web.UI.ControlBuilder?displayProperty=nameWithType> class and is not applicable to the <xref:System.Web.UI.WebControls.LiteralControlBuilder>. In the overridden implementation in <xref:System.Web.UI.WebControls.LiteralControlBuilder>, the method always throws <xref:System.Web.HttpException>.
]]></format>
</remarks>
<exception cref="T:System.Web.HttpException">An attempt is made to use this method.</exception>
<altmember cref="M:System.Web.UI.ControlBuilder.AppendSubBuilder(System.Web.UI.ControlBuilder)" />
<altmember cref="T:System.Web.UI.ControlBuilder" />
</Docs>
</Member>
</Members>
</Type>
You can’t perform that action at this time.