TagHelperOutputExtensions.xml

<Type Name="TagHelperOutputExtensions" FullName="Microsoft.AspNetCore.Mvc.TagHelpers.TagHelperOutputExtensions">
  <TypeSignature Language="C++ CLI" Value="public ref class TagHelperOutputExtensions abstract sealed" />
  <TypeSignature Language="C#" Value="public static class TagHelperOutputExtensions" />
  <TypeSignature Language="ILAsm" Value=".class public auto ansi abstract sealed beforefieldinit TagHelperOutputExtensions extends System.Object" />
  <TypeSignature Language="DocId" Value="T:Microsoft.AspNetCore.Mvc.TagHelpers.TagHelperOutputExtensions" />
  <TypeSignature Language="VB.NET" Value="Public Module TagHelperOutputExtensions" />
  <TypeSignature Language="F#" Value="type TagHelperOutputExtensions = class" />
  <AssemblyInfo>
    <AssemblyName>Microsoft.AspNetCore.Mvc.TagHelpers</AssemblyName>
    <AssemblyVersion>1.0.0.0</AssemblyVersion>
    <AssemblyVersion>1.1.0.0</AssemblyVersion>
    <AssemblyVersion>2.0.0.0</AssemblyVersion>
    <AssemblyVersion>2.1.0.0</AssemblyVersion>
    <AssemblyVersion>2.2.0.0</AssemblyVersion>
    <AssemblyVersion>3.0.0.0</AssemblyVersion>
    <AssemblyVersion>3.1.0.0</AssemblyVersion>
    <AssemblyVersion>5.0.0.0</AssemblyVersion>
    <AssemblyVersion>6.0.0.0</AssemblyVersion>
    <AssemblyVersion>7.0.0.0</AssemblyVersion>
    <AssemblyVersion>8.0.0.0</AssemblyVersion>
  </AssemblyInfo>
  <Base>
    <BaseTypeName>System.Object</BaseTypeName>
  </Base>
  <Interfaces />
  <Docs>
    <summary>
            Utility related extensions for <see cref="T:Microsoft.AspNetCore.Razor.TagHelpers.TagHelperOutput" />.
            </summary>
    <remarks>To be added.</remarks>
  </Docs>
  <Members>
    <Member MemberName="AddClass">
      <MemberSignature Language="C++ CLI" Value="public:&#xA;[System::Runtime::CompilerServices::Extension]&#xA; static void AddClass(Microsoft::AspNetCore::Razor::TagHelpers::TagHelperOutput ^ tagHelperOutput, System::String ^ classValue, System::Text::Encodings::Web::HtmlEncoder ^ htmlEncoder);" />
      <MemberSignature Language="C#" Value="public static void AddClass (this Microsoft.AspNetCore.Razor.TagHelpers.TagHelperOutput tagHelperOutput, string classValue, System.Text.Encodings.Web.HtmlEncoder htmlEncoder);" />
      <MemberSignature Language="ILAsm" Value=".method public static hidebysig void AddClass(class Microsoft.AspNetCore.Razor.TagHelpers.TagHelperOutput tagHelperOutput, string classValue, class System.Text.Encodings.Web.HtmlEncoder htmlEncoder) cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.AspNetCore.Mvc.TagHelpers.TagHelperOutputExtensions.AddClass(Microsoft.AspNetCore.Razor.TagHelpers.TagHelperOutput,System.String,System.Text.Encodings.Web.HtmlEncoder)" />
      <MemberSignature Language="VB.NET" Value="&lt;Extension()&gt;&#xA;Public Sub AddClass (tagHelperOutput As TagHelperOutput, classValue As String, htmlEncoder As HtmlEncoder)" />
      <MemberSignature Language="F#" Value="static member AddClass : Microsoft.AspNetCore.Razor.TagHelpers.TagHelperOutput * string * System.Text.Encodings.Web.HtmlEncoder -&gt; unit" Usage="Microsoft.AspNetCore.Mvc.TagHelpers.TagHelperOutputExtensions.AddClass (tagHelperOutput, classValue, htmlEncoder)" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.AspNetCore.Mvc.TagHelpers</AssemblyName>
        <AssemblyVersion>2.1.0.0</AssemblyVersion>
        <AssemblyVersion>2.2.0.0</AssemblyVersion>
        <AssemblyVersion>3.0.0.0</AssemblyVersion>
        <AssemblyVersion>3.1.0.0</AssemblyVersion>
        <AssemblyVersion>5.0.0.0</AssemblyVersion>
        <AssemblyVersion>6.0.0.0</AssemblyVersion>
        <AssemblyVersion>7.0.0.0</AssemblyVersion>
        <AssemblyVersion>8.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="tagHelperOutput" Type="Microsoft.AspNetCore.Razor.TagHelpers.TagHelperOutput" RefType="this" Index="0" FrameworkAlternate="aspnetcore-2.1;aspnetcore-2.2;aspnetcore-3.0;aspnetcore-3.1;aspnetcore-5.0;aspnetcore-6.0;aspnetcore-7.0;aspnetcore-8.0" />
        <Parameter Name="classValue" Type="System.String" Index="1" FrameworkAlternate="aspnetcore-2.1;aspnetcore-2.2;aspnetcore-3.0;aspnetcore-3.1;aspnetcore-5.0;aspnetcore-6.0;aspnetcore-7.0;aspnetcore-8.0" />
        <Parameter Name="htmlEncoder" Type="System.Text.Encodings.Web.HtmlEncoder" Index="2" FrameworkAlternate="aspnetcore-2.1;aspnetcore-2.2;aspnetcore-3.0;aspnetcore-3.1;aspnetcore-5.0;aspnetcore-6.0;aspnetcore-7.0;aspnetcore-8.0" />
      </Parameters>
      <Docs>
        <param name="tagHelperOutput">The <see cref="T:Microsoft.AspNetCore.Razor.TagHelpers.TagHelperOutput" /> this method extends.</param>
        <param name="classValue">The class value to add.</param>
        <param name="htmlEncoder">The current HTML encoder.</param>
        <summary>
            Adds the given <paramref name="classValue" /> to the <paramref name="tagHelperOutput" />'s
            <see cref="P:Microsoft.AspNetCore.Razor.TagHelpers.TagHelperOutput.Attributes" />.
            </summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="CopyHtmlAttribute">
      <MemberSignature Language="C++ CLI" Value="public:&#xA;[System::Runtime::CompilerServices::Extension]&#xA; static void CopyHtmlAttribute(Microsoft::AspNetCore::Razor::TagHelpers::TagHelperOutput ^ tagHelperOutput, System::String ^ attributeName, Microsoft::AspNetCore::Razor::TagHelpers::TagHelperContext ^ context);" />
      <MemberSignature Language="C#" Value="public static void CopyHtmlAttribute (this Microsoft.AspNetCore.Razor.TagHelpers.TagHelperOutput tagHelperOutput, string attributeName, Microsoft.AspNetCore.Razor.TagHelpers.TagHelperContext context);" />
      <MemberSignature Language="ILAsm" Value=".method public static hidebysig void CopyHtmlAttribute(class Microsoft.AspNetCore.Razor.TagHelpers.TagHelperOutput tagHelperOutput, string attributeName, class Microsoft.AspNetCore.Razor.TagHelpers.TagHelperContext context) cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.AspNetCore.Mvc.TagHelpers.TagHelperOutputExtensions.CopyHtmlAttribute(Microsoft.AspNetCore.Razor.TagHelpers.TagHelperOutput,System.String,Microsoft.AspNetCore.Razor.TagHelpers.TagHelperContext)" />
      <MemberSignature Language="VB.NET" Value="&lt;Extension()&gt;&#xA;Public Sub CopyHtmlAttribute (tagHelperOutput As TagHelperOutput, attributeName As String, context As TagHelperContext)" />
      <MemberSignature Language="F#" Value="static member CopyHtmlAttribute : Microsoft.AspNetCore.Razor.TagHelpers.TagHelperOutput * string * Microsoft.AspNetCore.Razor.TagHelpers.TagHelperContext -&gt; unit" Usage="Microsoft.AspNetCore.Mvc.TagHelpers.TagHelperOutputExtensions.CopyHtmlAttribute (tagHelperOutput, attributeName, context)" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.AspNetCore.Mvc.TagHelpers</AssemblyName>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
        <AssemblyVersion>1.1.0.0</AssemblyVersion>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
        <AssemblyVersion>2.1.0.0</AssemblyVersion>
        <AssemblyVersion>2.2.0.0</AssemblyVersion>
        <AssemblyVersion>3.0.0.0</AssemblyVersion>
        <AssemblyVersion>3.1.0.0</AssemblyVersion>
        <AssemblyVersion>5.0.0.0</AssemblyVersion>
        <AssemblyVersion>6.0.0.0</AssemblyVersion>
        <AssemblyVersion>7.0.0.0</AssemblyVersion>
        <AssemblyVersion>8.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="tagHelperOutput" Type="Microsoft.AspNetCore.Razor.TagHelpers.TagHelperOutput" RefType="this" />
        <Parameter Name="attributeName" Type="System.String" />
        <Parameter Name="context" Type="Microsoft.AspNetCore.Razor.TagHelpers.TagHelperContext" />
      </Parameters>
      <Docs>
        <param name="tagHelperOutput">The <see cref="T:Microsoft.AspNetCore.Razor.TagHelpers.TagHelperOutput" /> this method extends.</param>
        <param name="attributeName">The name of the bound attribute.</param>
        <param name="context">The <see cref="T:Microsoft.AspNetCore.Razor.TagHelpers.TagHelperContext" />.</param>
        <summary>
            Copies a user-provided attribute from <paramref name="context" />'s
            <see cref="P:Microsoft.AspNetCore.Razor.TagHelpers.TagHelperContext.AllAttributes" /> to <paramref name="tagHelperOutput" />'s
            <see cref="P:Microsoft.AspNetCore.Razor.TagHelpers.TagHelperOutput.Attributes" />.
            </summary>
        <remarks>
          <para>
            Only copies the attribute if <paramref name="tagHelperOutput" />'s
            <see cref="P:Microsoft.AspNetCore.Razor.TagHelpers.TagHelperOutput.Attributes" /> does not contain an attribute with the given
            <paramref name="attributeName" />.
            </para>
          <para>
            Duplicate attributes same name in <paramref name="context" />'s <see cref="P:Microsoft.AspNetCore.Razor.TagHelpers.TagHelperContext.AllAttributes" />
            or <paramref name="tagHelperOutput" />'s <see cref="P:Microsoft.AspNetCore.Razor.TagHelpers.TagHelperOutput.Attributes" /> may result in copied
            attribute order not being maintained.
            </para>
        </remarks>
      </Docs>
    </Member>
    <Member MemberName="MergeAttributes">
      <MemberSignature Language="C++ CLI" Value="public:&#xA;[System::Runtime::CompilerServices::Extension]&#xA; static void MergeAttributes(Microsoft::AspNetCore::Razor::TagHelpers::TagHelperOutput ^ tagHelperOutput, Microsoft::AspNetCore::Mvc::Rendering::TagBuilder ^ tagBuilder);" />
      <MemberSignature Language="C#" Value="public static void MergeAttributes (this Microsoft.AspNetCore.Razor.TagHelpers.TagHelperOutput tagHelperOutput, Microsoft.AspNetCore.Mvc.Rendering.TagBuilder tagBuilder);" />
      <MemberSignature Language="ILAsm" Value=".method public static hidebysig void MergeAttributes(class Microsoft.AspNetCore.Razor.TagHelpers.TagHelperOutput tagHelperOutput, class Microsoft.AspNetCore.Mvc.Rendering.TagBuilder tagBuilder) cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.AspNetCore.Mvc.TagHelpers.TagHelperOutputExtensions.MergeAttributes(Microsoft.AspNetCore.Razor.TagHelpers.TagHelperOutput,Microsoft.AspNetCore.Mvc.Rendering.TagBuilder)" />
      <MemberSignature Language="VB.NET" Value="&lt;Extension()&gt;&#xA;Public Sub MergeAttributes (tagHelperOutput As TagHelperOutput, tagBuilder As TagBuilder)" />
      <MemberSignature Language="F#" Value="static member MergeAttributes : Microsoft.AspNetCore.Razor.TagHelpers.TagHelperOutput * Microsoft.AspNetCore.Mvc.Rendering.TagBuilder -&gt; unit" Usage="Microsoft.AspNetCore.Mvc.TagHelpers.TagHelperOutputExtensions.MergeAttributes (tagHelperOutput, tagBuilder)" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.AspNetCore.Mvc.TagHelpers</AssemblyName>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
        <AssemblyVersion>1.1.0.0</AssemblyVersion>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
        <AssemblyVersion>2.1.0.0</AssemblyVersion>
        <AssemblyVersion>2.2.0.0</AssemblyVersion>
        <AssemblyVersion>3.0.0.0</AssemblyVersion>
        <AssemblyVersion>3.1.0.0</AssemblyVersion>
        <AssemblyVersion>5.0.0.0</AssemblyVersion>
        <AssemblyVersion>6.0.0.0</AssemblyVersion>
        <AssemblyVersion>7.0.0.0</AssemblyVersion>
        <AssemblyVersion>8.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="tagHelperOutput" Type="Microsoft.AspNetCore.Razor.TagHelpers.TagHelperOutput" RefType="this" />
        <Parameter Name="tagBuilder" Type="Microsoft.AspNetCore.Mvc.Rendering.TagBuilder" />
      </Parameters>
      <Docs>
        <param name="tagHelperOutput">The <see cref="T:Microsoft.AspNetCore.Razor.TagHelpers.TagHelperOutput" /> this method extends.</param>
        <param name="tagBuilder">The <see cref="T:Microsoft.AspNetCore.Mvc.Rendering.TagBuilder" /> to merge attributes from.</param>
        <summary>
            Merges the given <paramref name="tagBuilder" />'s <see cref="P:Microsoft.AspNetCore.Mvc.Rendering.TagBuilder.Attributes" /> into the
            <paramref name="tagHelperOutput" />.
            </summary>
        <remarks>Existing <see cref="P:Microsoft.AspNetCore.Razor.TagHelpers.TagHelperOutput.Attributes" /> on the given <paramref name="tagHelperOutput" />
            are not overridden; "class" attributes are merged with spaces.</remarks>
      </Docs>
    </Member>
    <Member MemberName="RemoveClass">
      <MemberSignature Language="C++ CLI" Value="public:&#xA;[System::Runtime::CompilerServices::Extension]&#xA; static void RemoveClass(Microsoft::AspNetCore::Razor::TagHelpers::TagHelperOutput ^ tagHelperOutput, System::String ^ classValue, System::Text::Encodings::Web::HtmlEncoder ^ htmlEncoder);" />
      <MemberSignature Language="C#" Value="public static void RemoveClass (this Microsoft.AspNetCore.Razor.TagHelpers.TagHelperOutput tagHelperOutput, string classValue, System.Text.Encodings.Web.HtmlEncoder htmlEncoder);" />
      <MemberSignature Language="ILAsm" Value=".method public static hidebysig void RemoveClass(class Microsoft.AspNetCore.Razor.TagHelpers.TagHelperOutput tagHelperOutput, string classValue, class System.Text.Encodings.Web.HtmlEncoder htmlEncoder) cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.AspNetCore.Mvc.TagHelpers.TagHelperOutputExtensions.RemoveClass(Microsoft.AspNetCore.Razor.TagHelpers.TagHelperOutput,System.String,System.Text.Encodings.Web.HtmlEncoder)" />
      <MemberSignature Language="VB.NET" Value="&lt;Extension()&gt;&#xA;Public Sub RemoveClass (tagHelperOutput As TagHelperOutput, classValue As String, htmlEncoder As HtmlEncoder)" />
      <MemberSignature Language="F#" Value="static member RemoveClass : Microsoft.AspNetCore.Razor.TagHelpers.TagHelperOutput * string * System.Text.Encodings.Web.HtmlEncoder -&gt; unit" Usage="Microsoft.AspNetCore.Mvc.TagHelpers.TagHelperOutputExtensions.RemoveClass (tagHelperOutput, classValue, htmlEncoder)" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.AspNetCore.Mvc.TagHelpers</AssemblyName>
        <AssemblyVersion>2.1.0.0</AssemblyVersion>
        <AssemblyVersion>2.2.0.0</AssemblyVersion>
        <AssemblyVersion>3.0.0.0</AssemblyVersion>
        <AssemblyVersion>3.1.0.0</AssemblyVersion>
        <AssemblyVersion>5.0.0.0</AssemblyVersion>
        <AssemblyVersion>6.0.0.0</AssemblyVersion>
        <AssemblyVersion>7.0.0.0</AssemblyVersion>
        <AssemblyVersion>8.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="tagHelperOutput" Type="Microsoft.AspNetCore.Razor.TagHelpers.TagHelperOutput" RefType="this" Index="0" FrameworkAlternate="aspnetcore-2.1;aspnetcore-2.2;aspnetcore-3.0;aspnetcore-3.1;aspnetcore-5.0;aspnetcore-6.0;aspnetcore-7.0;aspnetcore-8.0" />
        <Parameter Name="classValue" Type="System.String" Index="1" FrameworkAlternate="aspnetcore-2.1;aspnetcore-2.2;aspnetcore-3.0;aspnetcore-3.1;aspnetcore-5.0;aspnetcore-6.0;aspnetcore-7.0;aspnetcore-8.0" />
        <Parameter Name="htmlEncoder" Type="System.Text.Encodings.Web.HtmlEncoder" Index="2" FrameworkAlternate="aspnetcore-2.1;aspnetcore-2.2;aspnetcore-3.0;aspnetcore-3.1;aspnetcore-5.0;aspnetcore-6.0;aspnetcore-7.0;aspnetcore-8.0" />
      </Parameters>
      <Docs>
        <param name="tagHelperOutput">The <see cref="T:Microsoft.AspNetCore.Razor.TagHelpers.TagHelperOutput" /> this method extends.</param>
        <param name="classValue">The class value to remove.</param>
        <param name="htmlEncoder">The current HTML encoder.</param>
        <summary>
            Removes the given <paramref name="classValue" /> from the <paramref name="tagHelperOutput" />'s
            <see cref="P:Microsoft.AspNetCore.Razor.TagHelpers.TagHelperOutput.Attributes" />.
            </summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="RemoveRange">
      <MemberSignature Language="C++ CLI" Value="public:&#xA;[System::Runtime::CompilerServices::Extension]&#xA; static void RemoveRange(Microsoft::AspNetCore::Razor::TagHelpers::TagHelperOutput ^ tagHelperOutput, System::Collections::Generic::IEnumerable&lt;Microsoft::AspNetCore::Razor::TagHelpers::TagHelperAttribute ^&gt; ^ attributes);" />
      <MemberSignature Language="C#" Value="public static void RemoveRange (this Microsoft.AspNetCore.Razor.TagHelpers.TagHelperOutput tagHelperOutput, System.Collections.Generic.IEnumerable&lt;Microsoft.AspNetCore.Razor.TagHelpers.TagHelperAttribute&gt; attributes);" />
      <MemberSignature Language="ILAsm" Value=".method public static hidebysig void RemoveRange(class Microsoft.AspNetCore.Razor.TagHelpers.TagHelperOutput tagHelperOutput, class System.Collections.Generic.IEnumerable`1&lt;class Microsoft.AspNetCore.Razor.TagHelpers.TagHelperAttribute&gt; attributes) cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.AspNetCore.Mvc.TagHelpers.TagHelperOutputExtensions.RemoveRange(Microsoft.AspNetCore.Razor.TagHelpers.TagHelperOutput,System.Collections.Generic.IEnumerable{Microsoft.AspNetCore.Razor.TagHelpers.TagHelperAttribute})" />
      <MemberSignature Language="VB.NET" Value="&lt;Extension()&gt;&#xA;Public Sub RemoveRange (tagHelperOutput As TagHelperOutput, attributes As IEnumerable(Of TagHelperAttribute))" />
      <MemberSignature Language="F#" Value="static member RemoveRange : Microsoft.AspNetCore.Razor.TagHelpers.TagHelperOutput * seq&lt;Microsoft.AspNetCore.Razor.TagHelpers.TagHelperAttribute&gt; -&gt; unit" Usage="Microsoft.AspNetCore.Mvc.TagHelpers.TagHelperOutputExtensions.RemoveRange (tagHelperOutput, attributes)" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.AspNetCore.Mvc.TagHelpers</AssemblyName>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
        <AssemblyVersion>1.1.0.0</AssemblyVersion>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
        <AssemblyVersion>2.1.0.0</AssemblyVersion>
        <AssemblyVersion>2.2.0.0</AssemblyVersion>
        <AssemblyVersion>3.0.0.0</AssemblyVersion>
        <AssemblyVersion>3.1.0.0</AssemblyVersion>
        <AssemblyVersion>5.0.0.0</AssemblyVersion>
        <AssemblyVersion>6.0.0.0</AssemblyVersion>
        <AssemblyVersion>7.0.0.0</AssemblyVersion>
        <AssemblyVersion>8.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="tagHelperOutput" Type="Microsoft.AspNetCore.Razor.TagHelpers.TagHelperOutput" RefType="this" />
        <Parameter Name="attributes" Type="System.Collections.Generic.IEnumerable&lt;Microsoft.AspNetCore.Razor.TagHelpers.TagHelperAttribute&gt;" />
      </Parameters>
      <Docs>
        <param name="tagHelperOutput">The <see cref="T:Microsoft.AspNetCore.Razor.TagHelpers.TagHelperOutput" /> this method extends.</param>
        <param name="attributes">Attributes to remove.</param>
        <summary>
            Removes the given <paramref name="attributes" /> from <paramref name="tagHelperOutput" />'s
            <see cref="P:Microsoft.AspNetCore.Razor.TagHelpers.TagHelperOutput.Attributes" />.
            </summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
  </Members>
</Type>