dotnet-api-docs/xml/Microsoft.Extensions.WebEncoders.Testing/JavaScriptTestEncoder.xml at main · dotnet/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
243
244
245
246
247
248
249
250
<Type Name="JavaScriptTestEncoder" FullName="Microsoft.Extensions.WebEncoders.Testing.JavaScriptTestEncoder">
  <TypeSignature Language="C#" Value="public class JavaScriptTestEncoder : System.Text.Encodings.Web.JavaScriptEncoder" />
  <TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit JavaScriptTestEncoder extends System.Text.Encodings.Web.JavaScriptEncoder" />
  <TypeSignature Language="DocId" Value="T:Microsoft.Extensions.WebEncoders.Testing.JavaScriptTestEncoder" />
  <TypeSignature Language="VB.NET" Value="Public Class JavaScriptTestEncoder&#xA;Inherits JavaScriptEncoder" />
  <TypeSignature Language="F#" Value="type JavaScriptTestEncoder = class&#xA;    inherit JavaScriptEncoder" />
  <TypeSignature Language="C++ CLI" Value="public ref class JavaScriptTestEncoder : System::Text::Encodings::Web::JavaScriptEncoder" />
  <AssemblyInfo>
    <AssemblyName>Microsoft.Extensions.WebEncoders</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>
    <AssemblyVersion>9.0.0.0</AssemblyVersion>
    <AssemblyVersion>10.0.0.0</AssemblyVersion>
    <AssemblyVersion>10.0.1.0</AssemblyVersion>
    <AssemblyVersion>10.0.2.0</AssemblyVersion>
    <AssemblyVersion>11.0.0.0</AssemblyVersion>
  </AssemblyInfo>
  <Base>
    <BaseTypeName>System.Text.Encodings.Web.JavaScriptEncoder</BaseTypeName>
  </Base>
  <Interfaces />
  <Docs>
    <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>
    <remarks>To be added.</remarks>
  </Docs>
  <Members>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public JavaScriptTestEncoder ();" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.Extensions.WebEncoders.Testing.JavaScriptTestEncoder.#ctor" />
      <MemberSignature Language="VB.NET" Value="Public Sub New ()" />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; JavaScriptTestEncoder();" />
      <MemberType>Constructor</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Extensions.WebEncoders</AssemblyName>
        <AssemblyVersion>11.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Parameters />
      <Docs>
        <summary>To be added.</summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Encode">
      <MemberSignature Language="C#" Value="public override string Encode (string value);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance string Encode(string value) cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.Extensions.WebEncoders.Testing.JavaScriptTestEncoder.Encode(System.String)" />
      <MemberSignature Language="VB.NET" Value="Public Overrides Function Encode (value As String) As String" />
      <MemberSignature Language="F#" Value="override this.Encode : string -&gt; string" Usage="javaScriptTestEncoder.Encode value" />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; override System::String ^ Encode(System::String ^ value);" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Extensions.WebEncoders</AssemblyName>
        <AssemblyVersion>11.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="value" Type="System.String" />
      </Parameters>
      <Docs>
        <param name="value">To be added.</param>
        <summary>To be added.</summary>
        <returns>To be added.</returns>
        <remarks>To be added.</remarks>
        <inheritdoc />
      </Docs>
    </Member>
    <Member MemberName="Encode">
      <MemberSignature Language="C#" Value="public override void Encode (System.IO.TextWriter output, char[] value, int startIndex, int characterCount);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance void Encode(class System.IO.TextWriter output, char[] value, int32 startIndex, int32 characterCount) cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.Extensions.WebEncoders.Testing.JavaScriptTestEncoder.Encode(System.IO.TextWriter,System.Char[],System.Int32,System.Int32)" />
      <MemberSignature Language="VB.NET" Value="Public Overrides Sub Encode (output As TextWriter, value As Char(), startIndex As Integer, characterCount As Integer)" />
      <MemberSignature Language="F#" Value="override this.Encode : System.IO.TextWriter * char[] * int * int -&gt; unit" Usage="javaScriptTestEncoder.Encode (output, value, startIndex, characterCount)" />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; override void Encode(System::IO::TextWriter ^ output, cli::array &lt;char&gt; ^ value, int startIndex, int characterCount);" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Extensions.WebEncoders</AssemblyName>
        <AssemblyVersion>11.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="output" Type="System.IO.TextWriter" />
        <Parameter Name="value" Type="System.Char[]" />
        <Parameter Name="startIndex" Type="System.Int32" />
        <Parameter Name="characterCount" Type="System.Int32" />
      </Parameters>
      <Docs>
        <param name="output">To be added.</param>
        <param name="value">To be added.</param>
        <param name="startIndex">To be added.</param>
        <param name="characterCount">To be added.</param>
        <summary>To be added.</summary>
        <remarks>To be added.</remarks>
        <inheritdoc />
      </Docs>
    </Member>
    <Member MemberName="Encode">
      <MemberSignature Language="C#" Value="public override void Encode (System.IO.TextWriter output, string value, int startIndex, int characterCount);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance void Encode(class System.IO.TextWriter output, string value, int32 startIndex, int32 characterCount) cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.Extensions.WebEncoders.Testing.JavaScriptTestEncoder.Encode(System.IO.TextWriter,System.String,System.Int32,System.Int32)" />
      <MemberSignature Language="VB.NET" Value="Public Overrides Sub Encode (output As TextWriter, value As String, startIndex As Integer, characterCount As Integer)" />
      <MemberSignature Language="F#" Value="override this.Encode : System.IO.TextWriter * string * int * int -&gt; unit" Usage="javaScriptTestEncoder.Encode (output, value, startIndex, characterCount)" />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; override void Encode(System::IO::TextWriter ^ output, System::String ^ value, int startIndex, int characterCount);" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Extensions.WebEncoders</AssemblyName>
        <AssemblyVersion>11.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="output" Type="System.IO.TextWriter" />
        <Parameter Name="value" Type="System.String" />
        <Parameter Name="startIndex" Type="System.Int32" />
        <Parameter Name="characterCount" Type="System.Int32" />
      </Parameters>
      <Docs>
        <param name="output">To be added.</param>
        <param name="value">To be added.</param>
        <param name="startIndex">To be added.</param>
        <param name="characterCount">To be added.</param>
        <summary>To be added.</summary>
        <remarks>To be added.</remarks>
        <inheritdoc />
      </Docs>
    </Member>
    <Member MemberName="FindFirstCharacterToEncode">
      <MemberSignature Language="C#" Value="public override int FindFirstCharacterToEncode (char* text, int textLength);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance int32 FindFirstCharacterToEncode(char* text, int32 textLength) cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.Extensions.WebEncoders.Testing.JavaScriptTestEncoder.FindFirstCharacterToEncode(System.Char*,System.Int32)" />
      <MemberSignature Language="F#" Value="override this.FindFirstCharacterToEncode : nativeptr&lt;char&gt; * int -&gt; int" Usage="javaScriptTestEncoder.FindFirstCharacterToEncode (text, textLength)" />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; override int FindFirstCharacterToEncode(char* text, int textLength);" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Extensions.WebEncoders</AssemblyName>
        <AssemblyVersion>11.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Int32</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="text" Type="System.Char*" />
        <Parameter Name="textLength" Type="System.Int32" />
      </Parameters>
      <Docs>
        <param name="text">To be added.</param>
        <param name="textLength">To be added.</param>
        <summary>To be added.</summary>
        <returns>To be added.</returns>
        <remarks>To be added.</remarks>
        <inheritdoc />
      </Docs>
    </Member>
    <Member MemberName="MaxOutputCharactersPerInputCharacter">
      <MemberSignature Language="C#" Value="public override int MaxOutputCharactersPerInputCharacter { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance int32 MaxOutputCharactersPerInputCharacter" />
      <MemberSignature Language="DocId" Value="P:Microsoft.Extensions.WebEncoders.Testing.JavaScriptTestEncoder.MaxOutputCharactersPerInputCharacter" />
      <MemberSignature Language="VB.NET" Value="Public Overrides ReadOnly Property MaxOutputCharactersPerInputCharacter As Integer" />
      <MemberSignature Language="F#" Value="member this.MaxOutputCharactersPerInputCharacter : int" Usage="Microsoft.Extensions.WebEncoders.Testing.JavaScriptTestEncoder.MaxOutputCharactersPerInputCharacter" />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; virtual property int MaxOutputCharactersPerInputCharacter { int get(); };" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Extensions.WebEncoders</AssemblyName>
        <AssemblyVersion>11.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Int32</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>To be added.</summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
        <inheritdoc />
      </Docs>
    </Member>
    <Member MemberName="TryEncodeUnicodeScalar">
      <MemberSignature Language="C#" Value="public override bool TryEncodeUnicodeScalar (int unicodeScalar, char* buffer, int bufferLength, out int numberOfCharactersWritten);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance bool TryEncodeUnicodeScalar(int32 unicodeScalar, char* buffer, int32 bufferLength, [out] int32&amp; numberOfCharactersWritten) cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.Extensions.WebEncoders.Testing.JavaScriptTestEncoder.TryEncodeUnicodeScalar(System.Int32,System.Char*,System.Int32,System.Int32@)" />
      <MemberSignature Language="F#" Value="override this.TryEncodeUnicodeScalar : int * nativeptr&lt;char&gt; * int * int -&gt; bool" Usage="javaScriptTestEncoder.TryEncodeUnicodeScalar (unicodeScalar, buffer, bufferLength, numberOfCharactersWritten)" />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; override bool TryEncodeUnicodeScalar(int unicodeScalar, char* buffer, int bufferLength, [Runtime::InteropServices::Out] int % numberOfCharactersWritten);" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Extensions.WebEncoders</AssemblyName>
        <AssemblyVersion>11.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Boolean</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="unicodeScalar" Type="System.Int32" />
        <Parameter Name="buffer" Type="System.Char*" />
        <Parameter Name="bufferLength" Type="System.Int32" />
        <Parameter Name="numberOfCharactersWritten" Type="System.Int32" RefType="out" />
      </Parameters>
      <Docs>
        <param name="unicodeScalar">To be added.</param>
        <param name="buffer">To be added.</param>
        <param name="bufferLength">To be added.</param>
        <param name="numberOfCharactersWritten">To be added.</param>
        <summary>To be added.</summary>
        <returns>To be added.</returns>
        <remarks>To be added.</remarks>
        <inheritdoc />
      </Docs>
    </Member>
    <Member MemberName="WillEncode">
      <MemberSignature Language="C#" Value="public override bool WillEncode (int unicodeScalar);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance bool WillEncode(int32 unicodeScalar) cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.Extensions.WebEncoders.Testing.JavaScriptTestEncoder.WillEncode(System.Int32)" />
      <MemberSignature Language="VB.NET" Value="Public Overrides Function WillEncode (unicodeScalar As Integer) As Boolean" />
      <MemberSignature Language="F#" Value="override this.WillEncode : int -&gt; bool" Usage="javaScriptTestEncoder.WillEncode unicodeScalar" />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; override bool WillEncode(int unicodeScalar);" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Extensions.WebEncoders</AssemblyName>
        <AssemblyVersion>11.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Boolean</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="unicodeScalar" Type="System.Int32" />
      </Parameters>
      <Docs>
        <param name="unicodeScalar">To be added.</param>
        <summary>To be added.</summary>
        <returns>To be added.</returns>
        <remarks>To be added.</remarks>
        <inheritdoc />
      </Docs>
    </Member>
  </Members>
</Type>