dotnet-api-docs/xml/System.Text.Encodings.Web/JavaScriptEncoder.xml at c2216a4232a8795bfaa9f612bed26533f264e025 · gewarren/dotnet-api-docs · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
<Type Name="JavaScriptEncoder" FullName="System.Text.Encodings.Web.JavaScriptEncoder">
  <TypeSignature Language="C#" Value="public abstract class JavaScriptEncoder : System.Text.Encodings.Web.TextEncoder" />
  <TypeSignature Language="ILAsm" Value=".class public auto ansi abstract beforefieldinit JavaScriptEncoder extends System.Text.Encodings.Web.TextEncoder" />
  <TypeSignature Language="DocId" Value="T:System.Text.Encodings.Web.JavaScriptEncoder" />
  <TypeSignature Language="VB.NET" Value="Public MustInherit Class JavaScriptEncoder&#xA;Inherits TextEncoder" />
  <TypeSignature Language="F#" Value="type JavaScriptEncoder = class&#xA;    inherit TextEncoder" />
  <TypeSignature Language="C++ CLI" Value="public ref class JavaScriptEncoder abstract : System::Text::Encodings::Web::TextEncoder" />
  <AssemblyInfo>
    <AssemblyName>System.Text.Encodings.Web</AssemblyName>
    <AssemblyVersion>4.0.0.0</AssemblyVersion>
    <AssemblyVersion>4.0.1.0</AssemblyVersion>
    <AssemblyVersion>4.0.3.0</AssemblyVersion>
    <AssemblyVersion>4.0.4.0</AssemblyVersion>
    <AssemblyVersion>4.0.5.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>
    <AssemblyVersion>9.0.0.0</AssemblyVersion>
    <AssemblyVersion>10.0.0.0</AssemblyVersion>
    <AssemblyVersion>10.0.0.1</AssemblyVersion>
    <AssemblyVersion>10.0.0.2</AssemblyVersion>
    <AssemblyVersion>11.0.0.0</AssemblyVersion>
  </AssemblyInfo>
  <Base>
    <BaseTypeName>System.Text.Encodings.Web.TextEncoder</BaseTypeName>
  </Base>
  <Interfaces />
  <Attributes>
    <Attribute FrameworkAlternate="net-10.0;net-10.0-pp;net-11.0;net-11.0-pp;net-8.0;net-9.0">
      <AttributeName Language="C#">[System.Runtime.CompilerServices.Nullable(0)]</AttributeName>
      <AttributeName Language="F#">[&lt;System.Runtime.CompilerServices.Nullable(0)&gt;]</AttributeName>
    </Attribute>
  </Attributes>
  <Docs>
    <summary>Represents a JavaScript character encoding.</summary>
    <remarks>
      <format type="text/markdown"><![CDATA[

## Remarks
 The source code for this type is available in the [System.Text.Encodings.Web project](https://github.com/dotnet/runtime/tree/main/src/libraries/System.Text.Encodings.Web) on GitHub. Unit tests that can also serve as code examples are found in the [System.Text.Encodings.Web/tests](https://github.com/dotnet/runtime/tree/main/src/libraries/System.Text.Encodings.Web/tests) folder on GitHub.
 ]]></format>
    </remarks>
  </Docs>
  <Members>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="protected JavaScriptEncoder ();" />
      <MemberSignature Language="ILAsm" Value=".method familyhidebysig specialname rtspecialname instance void .ctor() cil managed" />
      <MemberSignature Language="DocId" Value="M:System.Text.Encodings.Web.JavaScriptEncoder.#ctor" />
      <MemberSignature Language="VB.NET" Value="Protected Sub New ()" />
      <MemberSignature Language="C++ CLI" Value="protected:&#xA; JavaScriptEncoder();" />
      <MemberType>Constructor</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.Text.Encodings.Web</AssemblyName>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
        <AssemblyVersion>4.0.1.0</AssemblyVersion>
        <AssemblyVersion>4.0.4.0</AssemblyVersion>
        <AssemblyVersion>4.0.5.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>
        <AssemblyVersion>9.0.0.0</AssemblyVersion>
        <AssemblyVersion>10.0.0.0</AssemblyVersion>
        <AssemblyVersion>11.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Parameters />
      <Docs>
        <summary>Initializes a new instance of the <see cref="T:System.Text.Encodings.Web.JavaScriptEncoder" /> class.</summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <MemberGroup MemberName="Create">
      <Docs>
        <summary>Creates a new instance of JavaScriptEncoder class with the specified settings.</summary>
      </Docs>
    </MemberGroup>
    <Member MemberName="Create">
      <MemberSignature Language="C#" Value="public static System.Text.Encodings.Web.JavaScriptEncoder Create (System.Text.Encodings.Web.TextEncoderSettings settings);" />
      <MemberSignature Language="ILAsm" Value=".method public static hidebysig class System.Text.Encodings.Web.JavaScriptEncoder Create(class System.Text.Encodings.Web.TextEncoderSettings settings) cil managed" />
      <MemberSignature Language="DocId" Value="M:System.Text.Encodings.Web.JavaScriptEncoder.Create(System.Text.Encodings.Web.TextEncoderSettings)" />
      <MemberSignature Language="VB.NET" Value="Public Shared Function Create (settings As TextEncoderSettings) As JavaScriptEncoder" />
      <MemberSignature Language="F#" Value="static member Create : System.Text.Encodings.Web.TextEncoderSettings -&gt; System.Text.Encodings.Web.JavaScriptEncoder" Usage="System.Text.Encodings.Web.JavaScriptEncoder.Create settings" />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; static System::Text::Encodings::Web::JavaScriptEncoder ^ Create(System::Text::Encodings::Web::TextEncoderSettings ^ settings);" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.Text.Encodings.Web</AssemblyName>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
        <AssemblyVersion>4.0.1.0</AssemblyVersion>
        <AssemblyVersion>4.0.4.0</AssemblyVersion>
        <AssemblyVersion>4.0.5.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>
        <AssemblyVersion>9.0.0.0</AssemblyVersion>
        <AssemblyVersion>10.0.0.0</AssemblyVersion>
        <AssemblyVersion>11.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Text.Encodings.Web.JavaScriptEncoder</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="settings" Type="System.Text.Encodings.Web.TextEncoderSettings" />
      </Parameters>
      <Docs>
        <param name="settings">Settings that control how the <see cref="T:System.Text.Encodings.Web.JavaScriptEncoder" /> instance encodes, primarily which characters to encode.</param>
        <summary>Creates a new instance of JavaScriptEncoder class with the specified settings.</summary>
        <returns>A new instance of the <see cref="T:System.Text.Encodings.Web.JavaScriptEncoder" /> class.</returns>
        <remarks>To be added.</remarks>
        <exception cref="T:System.ArgumentNullException">
          <paramref name="settings" /> is <see langword="null" />.</exception>
      </Docs>
    </Member>
    <Member MemberName="Create">
      <MemberSignature Language="C#" Value="public static System.Text.Encodings.Web.JavaScriptEncoder Create (params System.Text.Unicode.UnicodeRange[] allowedRanges);" />
      <MemberSignature Language="ILAsm" Value=".method public static hidebysig class System.Text.Encodings.Web.JavaScriptEncoder Create(class System.Text.Unicode.UnicodeRange[] allowedRanges) cil managed" />
      <MemberSignature Language="DocId" Value="M:System.Text.Encodings.Web.JavaScriptEncoder.Create(System.Text.Unicode.UnicodeRange[])" />
      <MemberSignature Language="VB.NET" Value="Public Shared Function Create (ParamArray allowedRanges As UnicodeRange()) As JavaScriptEncoder" />
      <MemberSignature Language="F#" Value="static member Create : System.Text.Unicode.UnicodeRange[] -&gt; System.Text.Encodings.Web.JavaScriptEncoder" Usage="System.Text.Encodings.Web.JavaScriptEncoder.Create allowedRanges" />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; static System::Text::Encodings::Web::JavaScriptEncoder ^ Create(... cli::array &lt;System::Text::Unicode::UnicodeRange ^&gt; ^ allowedRanges);" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.Text.Encodings.Web</AssemblyName>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
        <AssemblyVersion>4.0.1.0</AssemblyVersion>
        <AssemblyVersion>4.0.4.0</AssemblyVersion>
        <AssemblyVersion>4.0.5.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>
        <AssemblyVersion>9.0.0.0</AssemblyVersion>
        <AssemblyVersion>10.0.0.0</AssemblyVersion>
        <AssemblyVersion>11.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Text.Encodings.Web.JavaScriptEncoder</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="allowedRanges" Type="System.Text.Unicode.UnicodeRange[]">
          <Attributes>
            <Attribute>
              <AttributeName Language="C#">[System.ParamArray]</AttributeName>
              <AttributeName Language="F#">[&lt;System.ParamArray&gt;]</AttributeName>
            </Attribute>
          </Attributes>
        </Parameter>
      </Parameters>
      <Docs>
        <param name="allowedRanges">The set of characters that the encoder is allowed to not encode.</param>
        <summary>Creates a new instance of the JavaScriptEncoder class that specifies characters the encoder is allowed to not encode.</summary>
        <returns>A new instance of the <see cref="T:System.Text.Encodings.Web.JavaScriptEncoder" /> class.</returns>
        <remarks>
          <format type="text/markdown"><![CDATA[

## Remarks
 Some characters in `allowedRanges` might still be encoded; that is, this parameter indicates what ranges the encoder is allowed to not encode, not what characters it must not encode.
 ]]></format>
        </remarks>
        <exception cref="T:System.ArgumentNullException">
          <paramref name="allowedRanges" /> is <see langword="null" />.</exception>
      </Docs>
    </Member>
    <Member MemberName="Default">
      <MemberSignature Language="C#" Value="public static System.Text.Encodings.Web.JavaScriptEncoder Default { get; }" />
      <MemberSignature Language="ILAsm" Value=".property class System.Text.Encodings.Web.JavaScriptEncoder Default" />
      <MemberSignature Language="DocId" Value="P:System.Text.Encodings.Web.JavaScriptEncoder.Default" />
      <MemberSignature Language="VB.NET" Value="Public Shared ReadOnly Property Default As JavaScriptEncoder" />
      <MemberSignature Language="F#" Value="static member Default : System.Text.Encodings.Web.JavaScriptEncoder" Usage="System.Text.Encodings.Web.JavaScriptEncoder.Default" />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; static property System::Text::Encodings::Web::JavaScriptEncoder ^ Default { System::Text::Encodings::Web::JavaScriptEncoder ^ get(); };" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.Text.Encodings.Web</AssemblyName>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
        <AssemblyVersion>4.0.1.0</AssemblyVersion>
        <AssemblyVersion>4.0.4.0</AssemblyVersion>
        <AssemblyVersion>4.0.5.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>
        <AssemblyVersion>9.0.0.0</AssemblyVersion>
        <AssemblyVersion>10.0.0.0</AssemblyVersion>
        <AssemblyVersion>11.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Text.Encodings.Web.JavaScriptEncoder</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>Gets a built-in instance of the <see cref="T:System.Text.Encodings.Web.JavaScriptEncoder" /> class.</summary>
        <value>A built-in instance of the <see cref="T:System.Text.Encodings.Web.JavaScriptEncoder" /> class.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="UnsafeRelaxedJsonEscaping">
      <MemberSignature Language="C#" Value="public static System.Text.Encodings.Web.JavaScriptEncoder UnsafeRelaxedJsonEscaping { get; }" />
      <MemberSignature Language="ILAsm" Value=".property class System.Text.Encodings.Web.JavaScriptEncoder UnsafeRelaxedJsonEscaping" />
      <MemberSignature Language="DocId" Value="P:System.Text.Encodings.Web.JavaScriptEncoder.UnsafeRelaxedJsonEscaping" />
      <MemberSignature Language="VB.NET" Value="Public Shared ReadOnly Property UnsafeRelaxedJsonEscaping As JavaScriptEncoder" />
      <MemberSignature Language="F#" Value="static member UnsafeRelaxedJsonEscaping : System.Text.Encodings.Web.JavaScriptEncoder" Usage="System.Text.Encodings.Web.JavaScriptEncoder.UnsafeRelaxedJsonEscaping" />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; static property System::Text::Encodings::Web::JavaScriptEncoder ^ UnsafeRelaxedJsonEscaping { System::Text::Encodings::Web::JavaScriptEncoder ^ get(); };" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.Text.Encodings.Web</AssemblyName>
        <AssemblyVersion>4.0.4.0</AssemblyVersion>
        <AssemblyVersion>4.0.5.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>
        <AssemblyVersion>9.0.0.0</AssemblyVersion>
        <AssemblyVersion>10.0.0.0</AssemblyVersion>
        <AssemblyVersion>11.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Text.Encodings.Web.JavaScriptEncoder</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>Gets a built-in JavaScript encoder instance that is less strict about what is encoded.</summary>
        <value>A JavaScript encoder instance.</value>
        <remarks>
          <format type="text/markdown"><![CDATA[

## Remarks

Unlike the <xref:System.Text.Encodings.Web.JavaScriptEncoder.Default> encoder, this encoder instance does not escape HTML-sensitive characters such as &lt;, &gt;, &amp;. As a result, it must be used cautiously; for example, it can be used if the output data is within a response whose content-type is known with a charset set to UTF-8.

Unlike the <xref:System.Text.Encodings.Web.JavaScriptEncoder.Default> encoding, the quotation mark is encoded as \\" rather than \u0022.

Unlike the <xref:System.Text.Encodings.Web.JavaScriptEncoder.Default> encoding (which only allows <xref:System.Text.Unicode.UnicodeRanges.BasicLatin?displayProperty=nameWithType>), using this encoder instance allows <xref:System.Text.Unicode.UnicodeRanges.All?displayProperty=nameWithType> to go through unescaped.

Unlike the <xref:System.Text.Encodings.Web.JavaScriptEncoder.Default> encoder, this encoder instance allows some other characters (such as '+') to go through unescaped and therefore must be used cautiously.

For more information about why this could be **unsafe**, see [Serialize all characters](/dotnet/standard/serialization/system-text-json/character-encoding#serialize-all-characters).

          ]]></format>
        </remarks>
      </Docs>
    </Member>
  </Members>
</Type>