lib/net472/Microsoft.Extensions.WebEncoders.xml
|
<?xml version="1.0"?>
<doc> <assembly> <name>Microsoft.Extensions.WebEncoders</name> </assembly> <members> <member name="T:Microsoft.Extensions.DependencyInjection.EncoderServiceCollectionExtensions"> <summary> Extension methods for setting up web encoding services in an <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection" />. </summary> </member> <member name="M:Microsoft.Extensions.DependencyInjection.EncoderServiceCollectionExtensions.AddWebEncoders(Microsoft.Extensions.DependencyInjection.IServiceCollection)"> <summary> Adds <see cref="T:System.Text.Encodings.Web.HtmlEncoder"/>, <see cref="T:System.Text.Encodings.Web.JavaScriptEncoder"/> and <see cref="T:System.Text.Encodings.Web.UrlEncoder"/> to the specified <paramref name="services" />. </summary> <param name="services">The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/>.</param> <returns>The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/> so that additional calls can be chained.</returns> </member> <member name="M:Microsoft.Extensions.DependencyInjection.EncoderServiceCollectionExtensions.AddWebEncoders(Microsoft.Extensions.DependencyInjection.IServiceCollection,System.Action{Microsoft.Extensions.WebEncoders.WebEncoderOptions})"> <summary> Adds <see cref="T:System.Text.Encodings.Web.HtmlEncoder"/>, <see cref="T:System.Text.Encodings.Web.JavaScriptEncoder"/> and <see cref="T:System.Text.Encodings.Web.UrlEncoder"/> to the specified <paramref name="services" />. </summary> <param name="services">The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/>.</param> <param name="setupAction">An <see cref="T:System.Action`1"/> to configure the provided <see cref="T:Microsoft.Extensions.WebEncoders.WebEncoderOptions"/>.</param> <returns>The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/> so that additional calls can be chained.</returns> </member> <member name="T:Microsoft.Extensions.WebEncoders.Testing.HtmlTestEncoder"> <summary> <see cref="T:System.Text.Encodings.Web.HtmlEncoder"/> used for unit testing. This encoder does not perform any encoding and should not be used in application code. </summary> </member> <member name="P:Microsoft.Extensions.WebEncoders.Testing.HtmlTestEncoder.MaxOutputCharactersPerInputCharacter"> <inheritdoc /> </member> <member name="M:Microsoft.Extensions.WebEncoders.Testing.HtmlTestEncoder.Encode(System.String)"> <inheritdoc /> </member> <member name="M:Microsoft.Extensions.WebEncoders.Testing.HtmlTestEncoder.Encode(System.IO.TextWriter,System.Char[],System.Int32,System.Int32)"> <inheritdoc /> </member> <member name="M:Microsoft.Extensions.WebEncoders.Testing.HtmlTestEncoder.Encode(System.IO.TextWriter,System.String,System.Int32,System.Int32)"> <inheritdoc /> </member> <member name="M:Microsoft.Extensions.WebEncoders.Testing.HtmlTestEncoder.WillEncode(System.Int32)"> <inheritdoc /> </member> <member name="M:Microsoft.Extensions.WebEncoders.Testing.HtmlTestEncoder.FindFirstCharacterToEncode(System.Char*,System.Int32)"> <inheritdoc /> </member> <member name="M:Microsoft.Extensions.WebEncoders.Testing.HtmlTestEncoder.TryEncodeUnicodeScalar(System.Int32,System.Char*,System.Int32,System.Int32@)"> <inheritdoc /> </member> <member name="T:Microsoft.Extensions.WebEncoders.Testing.JavaScriptTestEncoder"> <summary> <see cref="T:System.Text.Encodings.Web.JavaScriptEncoder"/> used for unit testing. This encoder does not perform any encoding and should not be used in application code. </summary> </member> <member name="P:Microsoft.Extensions.WebEncoders.Testing.JavaScriptTestEncoder.MaxOutputCharactersPerInputCharacter"> <inheritdoc /> </member> <member name="M:Microsoft.Extensions.WebEncoders.Testing.JavaScriptTestEncoder.Encode(System.String)"> <inheritdoc /> </member> <member name="M:Microsoft.Extensions.WebEncoders.Testing.JavaScriptTestEncoder.Encode(System.IO.TextWriter,System.Char[],System.Int32,System.Int32)"> <inheritdoc /> </member> <member name="M:Microsoft.Extensions.WebEncoders.Testing.JavaScriptTestEncoder.Encode(System.IO.TextWriter,System.String,System.Int32,System.Int32)"> <inheritdoc /> </member> <member name="M:Microsoft.Extensions.WebEncoders.Testing.JavaScriptTestEncoder.WillEncode(System.Int32)"> <inheritdoc /> </member> <member name="M:Microsoft.Extensions.WebEncoders.Testing.JavaScriptTestEncoder.FindFirstCharacterToEncode(System.Char*,System.Int32)"> <inheritdoc /> </member> <member name="M:Microsoft.Extensions.WebEncoders.Testing.JavaScriptTestEncoder.TryEncodeUnicodeScalar(System.Int32,System.Char*,System.Int32,System.Int32@)"> <inheritdoc /> </member> <member name="T:Microsoft.Extensions.WebEncoders.Testing.UrlTestEncoder"> <summary> <see cref="T:System.Text.Encodings.Web.UrlEncoder"/> used for unit testing. This encoder does not perform any encoding and should not be used in application code. </summary> </member> <member name="P:Microsoft.Extensions.WebEncoders.Testing.UrlTestEncoder.MaxOutputCharactersPerInputCharacter"> <inheritdoc /> </member> <member name="M:Microsoft.Extensions.WebEncoders.Testing.UrlTestEncoder.Encode(System.String)"> <inheritdoc /> </member> <member name="M:Microsoft.Extensions.WebEncoders.Testing.UrlTestEncoder.Encode(System.IO.TextWriter,System.Char[],System.Int32,System.Int32)"> <inheritdoc /> </member> <member name="M:Microsoft.Extensions.WebEncoders.Testing.UrlTestEncoder.Encode(System.IO.TextWriter,System.String,System.Int32,System.Int32)"> <inheritdoc /> </member> <member name="M:Microsoft.Extensions.WebEncoders.Testing.UrlTestEncoder.WillEncode(System.Int32)"> <inheritdoc /> </member> <member name="M:Microsoft.Extensions.WebEncoders.Testing.UrlTestEncoder.FindFirstCharacterToEncode(System.Char*,System.Int32)"> <inheritdoc /> </member> <member name="M:Microsoft.Extensions.WebEncoders.Testing.UrlTestEncoder.TryEncodeUnicodeScalar(System.Int32,System.Char*,System.Int32,System.Int32@)"> <inheritdoc /> </member> <member name="T:Microsoft.Extensions.WebEncoders.WebEncoderOptions"> <summary> Specifies options common to all three encoders (HtmlEncode, JavaScriptEncode, UrlEncode). </summary> </member> <member name="P:Microsoft.Extensions.WebEncoders.WebEncoderOptions.TextEncoderSettings"> <summary> Specifies which code points are allowed to be represented unescaped by the encoders. </summary> <remarks> If this property is null, then the encoders will use their default allow lists. </remarks> </member> <member name="M:Microsoft.AspNetCore.Shared.ArgumentNullThrowHelper.ThrowIfNull(System.Object,System.String)"> <summary>Throws an <see cref="T:System.ArgumentNullException"/> if <paramref name="argument"/> is null.</summary> <param name="argument">The reference type argument to validate as non-null.</param> <param name="paramName">The name of the parameter with which <paramref name="argument"/> corresponds.</param> </member> <member name="T:System.Diagnostics.CodeAnalysis.AllowNullAttribute"> <summary>Specifies that null is allowed as an input even if the corresponding type disallows it.</summary> </member> <member name="T:System.Diagnostics.CodeAnalysis.DisallowNullAttribute"> <summary>Specifies that null is disallowed as an input even if the corresponding type allows it.</summary> </member> <member name="T:System.Diagnostics.CodeAnalysis.MaybeNullAttribute"> <summary>Specifies that an output may be null even if the corresponding type disallows it.</summary> </member> <member name="T:System.Diagnostics.CodeAnalysis.NotNullAttribute"> <summary>Specifies that an output will not be null even if the corresponding type allows it. Specifies that an input argument was not null when the call returns.</summary> </member> <member name="T:System.Diagnostics.CodeAnalysis.MaybeNullWhenAttribute"> <summary>Specifies that when a method returns <see cref="P:System.Diagnostics.CodeAnalysis.MaybeNullWhenAttribute.ReturnValue"/>, the parameter may be null even if the corresponding type disallows it.</summary> </member> <member name="M:System.Diagnostics.CodeAnalysis.MaybeNullWhenAttribute.#ctor(System.Boolean)"> <summary>Initializes the attribute with the specified return value condition.</summary> <param name="returnValue"> The return value condition. If the method returns this value, the associated parameter may be null. </param> </member> <member name="P:System.Diagnostics.CodeAnalysis.MaybeNullWhenAttribute.ReturnValue"> <summary>Gets the return value condition.</summary> </member> <member name="T:System.Diagnostics.CodeAnalysis.NotNullWhenAttribute"> <summary>Specifies that when a method returns <see cref="P:System.Diagnostics.CodeAnalysis.NotNullWhenAttribute.ReturnValue"/>, the parameter will not be null even if the corresponding type allows it.</summary> </member> <member name="M:System.Diagnostics.CodeAnalysis.NotNullWhenAttribute.#ctor(System.Boolean)"> <summary>Initializes the attribute with the specified return value condition.</summary> <param name="returnValue"> The return value condition. If the method returns this value, the associated parameter will not be null. </param> </member> <member name="P:System.Diagnostics.CodeAnalysis.NotNullWhenAttribute.ReturnValue"> <summary>Gets the return value condition.</summary> </member> <member name="T:System.Diagnostics.CodeAnalysis.NotNullIfNotNullAttribute"> <summary>Specifies that the output will be non-null if the named parameter is non-null.</summary> </member> <member name="M:System.Diagnostics.CodeAnalysis.NotNullIfNotNullAttribute.#ctor(System.String)"> <summary>Initializes the attribute with the associated parameter name.</summary> <param name="parameterName"> The associated parameter name. The output will be non-null if the argument to the parameter specified is non-null. </param> </member> <member name="P:System.Diagnostics.CodeAnalysis.NotNullIfNotNullAttribute.ParameterName"> <summary>Gets the associated parameter name.</summary> </member> <member name="T:System.Diagnostics.CodeAnalysis.DoesNotReturnAttribute"> <summary>Applied to a method that will never return under any circumstance.</summary> </member> <member name="T:System.Diagnostics.CodeAnalysis.DoesNotReturnIfAttribute"> <summary>Specifies that the method will not return if the associated Boolean parameter is passed the specified value.</summary> </member> <member name="M:System.Diagnostics.CodeAnalysis.DoesNotReturnIfAttribute.#ctor(System.Boolean)"> <summary>Initializes the attribute with the specified parameter value.</summary> <param name="parameterValue"> The condition parameter value. Code after the method will be considered unreachable by diagnostics if the argument to the associated parameter matches this value. </param> </member> <member name="P:System.Diagnostics.CodeAnalysis.DoesNotReturnIfAttribute.ParameterValue"> <summary>Gets the condition parameter value.</summary> </member> <member name="T:System.Diagnostics.CodeAnalysis.MemberNotNullAttribute"> <summary>Specifies that the method or property will ensure that the listed field and property members have not-null values.</summary> </member> <member name="M:System.Diagnostics.CodeAnalysis.MemberNotNullAttribute.#ctor(System.String)"> <summary>Initializes the attribute with a field or property member.</summary> <param name="member"> The field or property member that is promised to be not-null. </param> </member> <member name="M:System.Diagnostics.CodeAnalysis.MemberNotNullAttribute.#ctor(System.String[])"> <summary>Initializes the attribute with the list of field and property members.</summary> <param name="members"> The list of field and property members that are promised to be not-null. </param> </member> <member name="P:System.Diagnostics.CodeAnalysis.MemberNotNullAttribute.Members"> <summary>Gets field or property member names.</summary> </member> <member name="T:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute"> <summary>Specifies that the method or property will ensure that the listed field and property members have not-null values when returning with the specified return value condition.</summary> </member> <member name="M:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute.#ctor(System.Boolean,System.String)"> <summary>Initializes the attribute with the specified return value condition and a field or property member.</summary> <param name="returnValue"> The return value condition. If the method returns this value, the associated parameter will not be null. </param> <param name="member"> The field or property member that is promised to be not-null. </param> </member> <member name="M:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute.#ctor(System.Boolean,System.String[])"> <summary>Initializes the attribute with the specified return value condition and list of field and property members.</summary> <param name="returnValue"> The return value condition. If the method returns this value, the associated parameter will not be null. </param> <param name="members"> The list of field and property members that are promised to be not-null. </param> </member> <member name="P:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute.ReturnValue"> <summary>Gets the return value condition.</summary> </member> <member name="P:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute.Members"> <summary>Gets field or property member names.</summary> </member> </members> </doc> |