-
Notifications
You must be signed in to change notification settings - Fork 1.6k
/
Copy pathJsonDocumentOptions.xml
166 lines (154 loc) · 9.01 KB
/
JsonDocumentOptions.xml
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
<Type Name="JsonDocumentOptions" FullName="System.Text.Json.JsonDocumentOptions">
<TypeSignature Language="C#" Value="public struct JsonDocumentOptions" />
<TypeSignature Language="ILAsm" Value=".class public sequential ansi sealed beforefieldinit JsonDocumentOptions extends System.ValueType" />
<TypeSignature Language="DocId" Value="T:System.Text.Json.JsonDocumentOptions" />
<TypeSignature Language="VB.NET" Value="Public Structure JsonDocumentOptions" />
<TypeSignature Language="F#" Value="type JsonDocumentOptions = struct" />
<TypeSignature Language="C++ CLI" Value="public value class JsonDocumentOptions" />
<AssemblyInfo>
<AssemblyName>System.Text.Json</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.1.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>
</AssemblyInfo>
<Base>
<BaseTypeName>System.ValueType</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>Provides the ability for the user to define custom behavior when parsing JSON to create a <see cref="T:System.Text.Json.JsonDocument" />.</summary>
<remarks>
<format type="text/markdown"><.
]]></format>
</remarks>
</Docs>
<Members>
<Member MemberName="AllowTrailingCommas">
<MemberSignature Language="C#" Value="public bool AllowTrailingCommas { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool AllowTrailingCommas" />
<MemberSignature Language="DocId" Value="P:System.Text.Json.JsonDocumentOptions.AllowTrailingCommas" />
<MemberSignature Language="VB.NET" Value="Public Property AllowTrailingCommas As Boolean" />
<MemberSignature Language="F#" Value="member this.AllowTrailingCommas : bool with get, set" Usage="System.Text.Json.JsonDocumentOptions.AllowTrailingCommas" />
<MemberSignature Language="C++ CLI" Value="public:
 property bool AllowTrailingCommas { bool get(); void set(bool value); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Text.Json</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.1.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>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="net-10.0;net-10.0-pp;net-5.0;net-6.0;net-7.0;net-8.0;net-8.0-pp;net-9.0;net-9.0-pp;netcore-3.0;netcore-3.1">
<AttributeName Language="C#">[get: System.Runtime.CompilerServices.IsReadOnly]</AttributeName>
<AttributeName Language="F#">[<get: System.Runtime.CompilerServices.IsReadOnly>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets a value that indicates whether an extra comma at the end of a list of JSON values in an object or array is allowed (and ignored) within the JSON payload being read.</summary>
<value>
<see langword="true" /> if an extra comma at the end of a list of JSON values in an object or array is allowed; otherwise, <see langword="false" />. Default is <see langword="false" /></value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
By default, `AllowTrailingCommas` is set to `false`, and a <xref:System.Text.Json.JsonException> is thrown if a trailing comma is encountered.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="CommentHandling">
<MemberSignature Language="C#" Value="public System.Text.Json.JsonCommentHandling CommentHandling { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Text.Json.JsonCommentHandling CommentHandling" />
<MemberSignature Language="DocId" Value="P:System.Text.Json.JsonDocumentOptions.CommentHandling" />
<MemberSignature Language="VB.NET" Value="Public Property CommentHandling As JsonCommentHandling" />
<MemberSignature Language="F#" Value="member this.CommentHandling : System.Text.Json.JsonCommentHandling with get, set" Usage="System.Text.Json.JsonDocumentOptions.CommentHandling" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::Text::Json::JsonCommentHandling CommentHandling { System::Text::Json::JsonCommentHandling get(); void set(System::Text::Json::JsonCommentHandling value); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Text.Json</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.1.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>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="net-10.0;net-10.0-pp;net-5.0;net-6.0;net-7.0;net-8.0;net-8.0-pp;net-9.0;net-9.0-pp;netcore-3.0;netcore-3.1">
<AttributeName Language="C#">[get: System.Runtime.CompilerServices.IsReadOnly]</AttributeName>
<AttributeName Language="F#">[<get: System.Runtime.CompilerServices.IsReadOnly>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Text.Json.JsonCommentHandling</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets a value that determines how the <see cref="T:System.Text.Json.JsonDocument" /> handles comments when reading through the JSON data.</summary>
<value>One of the enumeration values that indicates how comments are handled.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
By default, a <xref:System.Text.Json.JsonException> is thrown if a comment is encountered.
]]></format>
</remarks>
<exception cref="T:System.ArgumentOutOfRangeException">The comment handling enum is set to a value that is not supported (or not within the <see cref="T:System.Text.Json.JsonCommentHandling" /> enum range).</exception>
</Docs>
</Member>
<Member MemberName="MaxDepth">
<MemberSignature Language="C#" Value="public int MaxDepth { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance int32 MaxDepth" />
<MemberSignature Language="DocId" Value="P:System.Text.Json.JsonDocumentOptions.MaxDepth" />
<MemberSignature Language="VB.NET" Value="Public Property MaxDepth As Integer" />
<MemberSignature Language="F#" Value="member this.MaxDepth : int with get, set" Usage="System.Text.Json.JsonDocumentOptions.MaxDepth" />
<MemberSignature Language="C++ CLI" Value="public:
 property int MaxDepth { int get(); void set(int value); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Text.Json</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.1.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>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="net-10.0;net-10.0-pp;net-5.0;net-6.0;net-7.0;net-8.0;net-8.0-pp;net-9.0;net-9.0-pp;netcore-3.0;netcore-3.1">
<AttributeName Language="C#">[get: System.Runtime.CompilerServices.IsReadOnly]</AttributeName>
<AttributeName Language="F#">[<get: System.Runtime.CompilerServices.IsReadOnly>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets the maximum depth allowed when parsing JSON data, with the default (that is, 0) indicating a maximum depth of 64.</summary>
<value>The maximum depth allowed when parsing JSON data.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
Parsing past this depth will throw a <xref:System.Text.Json.JsonException>.
]]></format>
</remarks>
<exception cref="T:System.ArgumentOutOfRangeException">The max depth is set to a negative value.</exception>
</Docs>
</Member>
</Members>
</Type>