HtmlEncoder Class

Definition

Namespace:

System.Text.Encodings.Web

Assembly:

System.Text.Encodings.Web.dll

Source:

HtmlEncoder.cs

Represents an HTML character encoding.

public ref class HtmlEncoder abstract : System::Text::Encodings::Web::TextEncoder

public abstract class HtmlEncoder : System.Text.Encodings.Web.TextEncoder

type HtmlEncoder = class
    inherit TextEncoder

Public MustInherit Class HtmlEncoder
Inherits TextEncoder

Inheritance

Object

TextEncoder

HtmlEncoder

Derived

Microsoft.Extensions.WebEncoders.Testing.HtmlTestEncoder

Remarks

The source code for this type is available in the System.Text.Encodings.Web project on GitHub. Unit tests that can also serve as code examples are found in the System.Text.Encodings.Web/tests folder on GitHub.

Constructors

HtmlEncoder()

Initializes a new instance of the HtmlEncoder class.

Properties

Default	Gets a built-in instance of the HtmlEncoder class.
MaxOutputCharactersPerInputCharacter	Gets the maximum number of characters that this encoder can generate for each input code point. (Inherited from TextEncoder)

Methods

Create(TextEncoderSettings)	Creates a new instance of the HtmlEncoder class with the specified settings.
Create(UnicodeRange[])	Creates a new instance of the HtmlEncoder class that specifies characters the encoder is allowed to not encode.
Encode(ReadOnlySpan<Char>, Span<Char>, Int32, Int32, Boolean)	Encodes the supplied characters. (Inherited from TextEncoder)
Encode(String)	Encodes the supplied string and returns the encoded text as a new string. (Inherited from TextEncoder)
Encode(TextWriter, Char[], Int32, Int32)	Encodes characters from an array and writes them to a TextWriter object. (Inherited from TextEncoder)
Encode(TextWriter, String)	Encodes the specified string to a TextWriter object. (Inherited from TextEncoder)
Encode(TextWriter, String, Int32, Int32)	Encodes a substring and writes it to a TextWriter object. (Inherited from TextEncoder)
EncodeUtf8(ReadOnlySpan<Byte>, Span<Byte>, Int32, Int32, Boolean)	Encodes the supplied UTF-8 text. (Inherited from TextEncoder)
Equals(Object)	Determines whether the specified object is equal to the current object. (Inherited from Object)
FindFirstCharacterToEncode(Char*, Int32)	Finds the index of the first character to encode. (Inherited from TextEncoder)
FindFirstCharacterToEncodeUtf8(ReadOnlySpan<Byte>)	Finds the first element in a UTF-8 text input buffer that would be escaped by the current encoder instance. (Inherited from TextEncoder)
GetHashCode()	Serves as the default hash function. (Inherited from Object)
GetType()	Gets the Type of the current instance. (Inherited from Object)
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
ToString()	Returns a string that represents the current object. (Inherited from Object)
TryEncodeUnicodeScalar(Int32, Char*, Int32, Int32)	Encodes a Unicode scalar value and writes it to a buffer. (Inherited from TextEncoder)
WillEncode(Int32)	Determines if a given Unicode scalar value will be encoded. (Inherited from TextEncoder)