diff options
Diffstat (limited to 'bin')
-rwxr-xr-x | bin/Axiom.MathLib.dll | bin | 69632 -> 0 bytes | |||
-rwxr-xr-x | bin/C5.dll | bin | 276992 -> 266752 bytes | |||
-rwxr-xr-x | bin/CSJ2K.dll | bin | 502784 -> 483328 bytes | |||
-rwxr-xr-x | bin/CookComputing.XmlRpcV2.dll | bin | 110592 -> 0 bytes | |||
-rwxr-xr-x | bin/DotNetOpenId.dll | bin | 281088 -> 283648 bytes | |||
-rwxr-xr-x | bin/HttpServer_OpenSim.dll | bin | 117248 -> 120320 bytes | |||
-rw-r--r-- | bin/HttpServer_OpenSim.pdb | bin | 323072 -> 0 bytes | |||
-rw-r--r-- | bin/HttpServer_OpenSim.xml | 5574 | ||||
-rw-r--r-- | bin/ICSharpCode.SharpZipLib.dll | bin | 200704 -> 192512 bytes | |||
-rwxr-xr-x | bin/Ionic.Zip.dll | bin | 491520 -> 455168 bytes | |||
-rwxr-xr-x | bin/LukeSkywalker.IPNetwork.dll | bin | 18432 -> 18432 bytes | |||
-rwxr-xr-x | bin/Mono.Addins.CecilReflector.dll | bin | 225280 -> 17920 bytes | |||
-rwxr-xr-x | bin/Mono.Addins.Setup.dll | bin | 126464 -> 126464 bytes | |||
-rw-r--r-- | bin/Mono.Addins.Setup.xml | 1140 | ||||
-rwxr-xr-x | bin/Mono.Addins.dll | bin | 232960 -> 233984 bytes | |||
-rw-r--r-- | bin/Mono.Addins.xml | 6120 | ||||
-rw-r--r-- | bin/Mono.Cecil.dll | bin | 0 -> 333312 bytes | |||
-rwxr-xr-x | bin/NDesk.Options.dll | bin | 22016 -> 20992 bytes | |||
-rw-r--r-- | bin/Newtonsoft.Json.dll | bin | 498176 -> 59904 bytes | |||
-rw-r--r-- | bin/Newtonsoft.Json.xml | 8626 | ||||
-rwxr-xr-x | bin/Nini.dll | bin | 56320 -> 57856 bytes | |||
-rwxr-xr-x | bin/OpenMetaverse.Rendering.Meshmerizer.dll | bin | 28672 -> 20480 bytes | |||
-rwxr-xr-x | bin/OpenMetaverse.StructuredData.dll | bin | 102400 -> 106496 bytes | |||
-rwxr-xr-x | bin/OpenMetaverse.dll | bin | 2195456 -> 2195456 bytes | |||
-rwxr-xr-x | bin/OpenMetaverseTypes.dll | bin | 110592 -> 106496 bytes | |||
-rw-r--r-- | bin/OpenSim.ini.example | 78 | ||||
-rw-r--r-- | bin/OpenSim32.exe.config | 1 | ||||
-rw-r--r-- | bin/OpenSimDefaults.ini | 38 | ||||
-rwxr-xr-x | bin/Prebuild.exe | bin | 234496 -> 249856 bytes | |||
-rwxr-xr-x | bin/PrimMesher.dll | bin | 46592 -> 43008 bytes | |||
-rw-r--r-- | bin/Robust.HG.ini.example | 10 | ||||
-rw-r--r-- | bin/Robust.ini.example | 8 | ||||
-rw-r--r-- | bin/Robust32.exe.config | 3 | ||||
-rw-r--r-- | bin/Robust32.vshost.exe.config | 3 | ||||
-rwxr-xr-x | bin/Tools.dll | bin | 153088 -> 162304 bytes | |||
-rwxr-xr-x | bin/Warp3D.dll | bin | 68608 -> 68608 bytes | |||
-rwxr-xr-x | bin/XMLRPC.dll | bin | 40960 -> 25600 bytes | |||
-rw-r--r-- | bin/config-include/osslEnable.ini | 172 | ||||
-rwxr-xr-x | bin/lib32/ode.dll | bin | 541696 -> 542208 bytes | |||
-rwxr-xr-x | bin/lib64/ode.dll | bin | 635904 -> 636416 bytes | |||
-rwxr-xr-x | bin/log4net.dll | bin | 270336 -> 266240 bytes | |||
-rwxr-xr-x | bin/mautil.exe | bin | 7680 -> 7680 bytes | |||
-rwxr-xr-x | bin/zlib.net.dll | bin | 65536 -> 65536 bytes |
43 files changed, 197 insertions, 21576 deletions
diff --git a/bin/Axiom.MathLib.dll b/bin/Axiom.MathLib.dll deleted file mode 100755 index b00cf1d..0000000 --- a/bin/Axiom.MathLib.dll +++ /dev/null | |||
Binary files differ | |||
Binary files differ | |||
diff --git a/bin/CSJ2K.dll b/bin/CSJ2K.dll index 238291f..88347fc 100755 --- a/bin/CSJ2K.dll +++ b/bin/CSJ2K.dll | |||
Binary files differ | |||
diff --git a/bin/CookComputing.XmlRpcV2.dll b/bin/CookComputing.XmlRpcV2.dll deleted file mode 100755 index 4dd869c..0000000 --- a/bin/CookComputing.XmlRpcV2.dll +++ /dev/null | |||
Binary files differ | |||
diff --git a/bin/DotNetOpenId.dll b/bin/DotNetOpenId.dll index aa62790..96279dc 100755 --- a/bin/DotNetOpenId.dll +++ b/bin/DotNetOpenId.dll | |||
Binary files differ | |||
diff --git a/bin/HttpServer_OpenSim.dll b/bin/HttpServer_OpenSim.dll index 5db99ef..fc37603 100755 --- a/bin/HttpServer_OpenSim.dll +++ b/bin/HttpServer_OpenSim.dll | |||
Binary files differ | |||
diff --git a/bin/HttpServer_OpenSim.pdb b/bin/HttpServer_OpenSim.pdb deleted file mode 100644 index 25b6760..0000000 --- a/bin/HttpServer_OpenSim.pdb +++ /dev/null | |||
Binary files differ | |||
diff --git a/bin/HttpServer_OpenSim.xml b/bin/HttpServer_OpenSim.xml deleted file mode 100644 index 7b6912e..0000000 --- a/bin/HttpServer_OpenSim.xml +++ /dev/null | |||
@@ -1,5574 +0,0 @@ | |||
1 | <?xml version="1.0"?> | ||
2 | <doc> | ||
3 | <assembly> | ||
4 | <name>HttpServer_OpenSim</name> | ||
5 | </assembly> | ||
6 | <members> | ||
7 | <member name="T:HttpServer.Authentication.AuthenticationHandler"> | ||
8 | <summary> | ||
9 | Delegate used to let authentication modules authenticate the user name and password. | ||
10 | </summary> | ||
11 | <param name="realm">Realm that the user want to authenticate in</param> | ||
12 | <param name="userName">User name specified by client</param> | ||
13 | <param name="token">Can either be user password or implementation specific token.</param> | ||
14 | <param name="login">object that will be stored in a session variable called <see cref="F:HttpServer.Authentication.AuthenticationModule.AuthenticationTag"/> if authentication was successful.</param> | ||
15 | <exception cref="T:HttpServer.Exceptions.ForbiddenException">throw forbidden exception if too many attempts have been made.</exception> | ||
16 | <remarks> | ||
17 | <para> | ||
18 | Use <see cref="P:HttpServer.Authentication.DigestAuthentication.TokenIsHA1"/> to specify that the token is a HA1 token. (MD5 generated | ||
19 | string from realm, user name and password); Md5String(userName + ":" + realm + ":" + password); | ||
20 | </para> | ||
21 | </remarks> | ||
22 | </member> | ||
23 | <member name="T:HttpServer.Authentication.AuthenticationRequiredHandler"> | ||
24 | <summary> | ||
25 | Let's you decide on a system level if authentication is required. | ||
26 | </summary> | ||
27 | <param name="request">HTTP request from client</param> | ||
28 | <returns>true if user should be authenticated.</returns> | ||
29 | <remarks>throw <see cref="T:HttpServer.Exceptions.ForbiddenException"/> if no more attempts are allowed.</remarks> | ||
30 | <exception cref="T:HttpServer.Exceptions.ForbiddenException">If no more attempts are allowed</exception> | ||
31 | </member> | ||
32 | <member name="T:HttpServer.Authentication.AuthenticationModule"> | ||
33 | <summary> | ||
34 | Authentication modules are used to implement different | ||
35 | kind of HTTP authentication. | ||
36 | </summary> | ||
37 | </member> | ||
38 | <member name="M:HttpServer.Authentication.AuthenticationModule.#ctor(HttpServer.Authentication.AuthenticationHandler,HttpServer.Authentication.AuthenticationRequiredHandler)"> | ||
39 | <summary> | ||
40 | Initializes a new instance of the <see cref="T:HttpServer.Authentication.AuthenticationModule"/> class. | ||
41 | </summary> | ||
42 | <param name="authenticator">Delegate used to provide information used during authentication.</param> | ||
43 | <param name="authenticationRequiredHandler">Delegate used to determine if authentication is required (may be null).</param> | ||
44 | </member> | ||
45 | <member name="M:HttpServer.Authentication.AuthenticationModule.#ctor(HttpServer.Authentication.AuthenticationHandler)"> | ||
46 | <summary> | ||
47 | Initializes a new instance of the <see cref="T:HttpServer.Authentication.AuthenticationModule"/> class. | ||
48 | </summary> | ||
49 | <param name="authenticator">Delegate used to provide information used during authentication.</param> | ||
50 | </member> | ||
51 | <member name="P:HttpServer.Authentication.AuthenticationModule.Name"> | ||
52 | <summary> | ||
53 | name used in HTTP request. | ||
54 | </summary> | ||
55 | </member> | ||
56 | <member name="F:HttpServer.Authentication.AuthenticationModule.AuthenticationTag"> | ||
57 | <summary> | ||
58 | Tag used for authentication. | ||
59 | </summary> | ||
60 | </member> | ||
61 | <member name="M:HttpServer.Authentication.AuthenticationModule.CreateResponse(System.String,System.Object[])"> | ||
62 | <summary> | ||
63 | Create a response that can be sent in the WWW-Authenticate header. | ||
64 | </summary> | ||
65 | <param name="realm">Realm that the user should authenticate in</param> | ||
66 | <param name="options">Array with optional options.</param> | ||
67 | <returns>A correct authentication request.</returns> | ||
68 | <exception cref="T:System.ArgumentNullException">If realm is empty or null.</exception> | ||
69 | </member> | ||
70 | <member name="M:HttpServer.Authentication.AuthenticationModule.Authenticate(System.String,System.String,System.String,System.Object[])"> | ||
71 | <summary> | ||
72 | An authentication response have been received from the web browser. | ||
73 | Check if it's correct | ||
74 | </summary> | ||
75 | <param name="authenticationHeader">Contents from the Authorization header</param> | ||
76 | <param name="realm">Realm that should be authenticated</param> | ||
77 | <param name="httpVerb">GET/POST/PUT/DELETE etc.</param> | ||
78 | <param name="options">options to specific implementations</param> | ||
79 | <returns>Authentication object that is stored for the request. A user class or something like that.</returns> | ||
80 | <exception cref="T:System.ArgumentException">if <paramref name="authenticationHeader"/> is invalid</exception> | ||
81 | <exception cref="T:System.ArgumentNullException">If any of the parameters is empty or null.</exception> | ||
82 | </member> | ||
83 | <member name="M:HttpServer.Authentication.AuthenticationModule.CheckAuthentication(System.String,System.String,System.String@,System.Object@)"> | ||
84 | <summary> | ||
85 | Used to invoke the authentication delegate that is used to lookup the user name/realm. | ||
86 | </summary> | ||
87 | <param name="realm">Realm (domain) that user want to authenticate in</param> | ||
88 | <param name="userName">User name</param> | ||
89 | <param name="password">Password used for validation. Some implementations got password in clear text, they are then sent to client.</param> | ||
90 | <param name="login">object that will be stored in the request to help you identify the user if authentication was successful.</param> | ||
91 | <returns>true if authentication was successful</returns> | ||
92 | </member> | ||
93 | <member name="M:HttpServer.Authentication.AuthenticationModule.AuthenticationRequired(HttpServer.IHttpRequest)"> | ||
94 | <summary> | ||
95 | Determines if authentication is required. | ||
96 | </summary> | ||
97 | <param name="request">HTTP request from browser</param> | ||
98 | <returns>true if user should be authenticated.</returns> | ||
99 | <remarks>throw <see cref="T:HttpServer.Exceptions.ForbiddenException"/> from your delegate if no more attempts are allowed.</remarks> | ||
100 | <exception cref="T:HttpServer.Exceptions.ForbiddenException">If no more attempts are allowed</exception> | ||
101 | </member> | ||
102 | <member name="T:HttpServer.Authentication.BasicAuthentication"> | ||
103 | <summary> | ||
104 | The "basic" authentication scheme is based on the model that the | ||
105 | client must authenticate itself with a user-ID and a password for | ||
106 | each realm. The realm value should be considered an opaque string | ||
107 | which can only be compared for equality with other realms on that | ||
108 | server. The server will service the request only if it can validate | ||
109 | the user-ID and password for the protection space of the Request-URI. | ||
110 | There are no optional authentication parameters. | ||
111 | </summary> | ||
112 | </member> | ||
113 | <member name="M:HttpServer.Authentication.BasicAuthentication.#ctor(HttpServer.Authentication.AuthenticationHandler,HttpServer.Authentication.AuthenticationRequiredHandler)"> | ||
114 | <summary> | ||
115 | Initializes a new instance of the <see cref="T:HttpServer.Authentication.BasicAuthentication"/> class. | ||
116 | </summary> | ||
117 | <param name="authenticator">Delegate used to provide information used during authentication.</param> | ||
118 | <param name="authenticationRequiredHandler">Delegate used to determine if authentication is required (may be null).</param> | ||
119 | </member> | ||
120 | <member name="M:HttpServer.Authentication.BasicAuthentication.#ctor(HttpServer.Authentication.AuthenticationHandler)"> | ||
121 | <summary> | ||
122 | Initializes a new instance of the <see cref="T:HttpServer.Authentication.BasicAuthentication"/> class. | ||
123 | </summary> | ||
124 | <param name="authenticator">Delegate used to provide information used during authentication.</param> | ||
125 | </member> | ||
126 | <member name="M:HttpServer.Authentication.BasicAuthentication.CreateResponse(System.String,System.Object[])"> | ||
127 | <summary> | ||
128 | Create a response that can be sent in the WWW-Authenticate header. | ||
129 | </summary> | ||
130 | <param name="realm">Realm that the user should authenticate in</param> | ||
131 | <param name="options">Not used in basic auth</param> | ||
132 | <returns>A correct auth request.</returns> | ||
133 | </member> | ||
134 | <member name="M:HttpServer.Authentication.BasicAuthentication.Authenticate(System.String,System.String,System.String,System.Object[])"> | ||
135 | <summary> | ||
136 | An authentication response have been received from the web browser. | ||
137 | Check if it's correct | ||
138 | </summary> | ||
139 | <param name="authenticationHeader">Contents from the Authorization header</param> | ||
140 | <param name="realm">Realm that should be authenticated</param> | ||
141 | <param name="httpVerb">GET/POST/PUT/DELETE etc.</param> | ||
142 | <param name="options">Not used in basic auth</param> | ||
143 | <returns>Authentication object that is stored for the request. A user class or something like that.</returns> | ||
144 | <exception cref="T:System.ArgumentException">if authenticationHeader is invalid</exception> | ||
145 | <exception cref="T:System.ArgumentNullException">If any of the paramters is empty or null.</exception> | ||
146 | </member> | ||
147 | <member name="P:HttpServer.Authentication.BasicAuthentication.Name"> | ||
148 | <summary> | ||
149 | name used in http request. | ||
150 | </summary> | ||
151 | </member> | ||
152 | <member name="T:HttpServer.Authentication.DigestAuthentication"> | ||
153 | <summary> | ||
154 | Implements HTTP Digest authentication. It's more secure than Basic auth since password is | ||
155 | encrypted with a "key" from the server. | ||
156 | </summary> | ||
157 | <remarks> | ||
158 | Keep in mind that the password is encrypted with MD5. Use a combination of SSL and digest auth to be secure. | ||
159 | </remarks> | ||
160 | </member> | ||
161 | <member name="M:HttpServer.Authentication.DigestAuthentication.#ctor(HttpServer.Authentication.AuthenticationHandler,HttpServer.Authentication.AuthenticationRequiredHandler)"> | ||
162 | <summary> | ||
163 | Initializes a new instance of the <see cref="T:HttpServer.Authentication.DigestAuthentication"/> class. | ||
164 | </summary> | ||
165 | <param name="authenticator">Delegate used to provide information used during authentication.</param> | ||
166 | <param name="authenticationRequiredHandler">Delegate used to determine if authentication is required (may be null).</param> | ||
167 | </member> | ||
168 | <member name="M:HttpServer.Authentication.DigestAuthentication.#ctor(HttpServer.Authentication.AuthenticationHandler)"> | ||
169 | <summary> | ||
170 | Initializes a new instance of the <see cref="T:HttpServer.Authentication.DigestAuthentication"/> class. | ||
171 | </summary> | ||
172 | <param name="authenticator">Delegate used to provide information used during authentication.</param> | ||
173 | </member> | ||
174 | <member name="F:HttpServer.Authentication.DigestAuthentication.DisableNonceCheck"> | ||
175 | <summary> | ||
176 | Used by test classes to be able to use hardcoded values | ||
177 | </summary> | ||
178 | </member> | ||
179 | <member name="P:HttpServer.Authentication.DigestAuthentication.Name"> | ||
180 | <summary> | ||
181 | name used in http request. | ||
182 | </summary> | ||
183 | </member> | ||
184 | <member name="M:HttpServer.Authentication.DigestAuthentication.Authenticate(System.String,System.String,System.String,System.Object[])"> | ||
185 | <summary> | ||
186 | An authentication response have been received from the web browser. | ||
187 | Check if it's correct | ||
188 | </summary> | ||
189 | <param name="authenticationHeader">Contents from the Authorization header</param> | ||
190 | <param name="realm">Realm that should be authenticated</param> | ||
191 | <param name="httpVerb">GET/POST/PUT/DELETE etc.</param> | ||
192 | <param name="options">First option: true if username/password is correct but not cnonce</param> | ||
193 | <returns> | ||
194 | Authentication object that is stored for the request. A user class or something like that. | ||
195 | </returns> | ||
196 | <exception cref="T:System.ArgumentException">if authenticationHeader is invalid</exception> | ||
197 | <exception cref="T:System.ArgumentNullException">If any of the paramters is empty or null.</exception> | ||
198 | </member> | ||
199 | <member name="P:HttpServer.Authentication.DigestAuthentication.TokenIsHA1"> | ||
200 | <summary> | ||
201 | Gets or sets whether the token supplied in <see cref="T:HttpServer.Authentication.AuthenticationHandler"/> is a | ||
202 | HA1 generated string. | ||
203 | </summary> | ||
204 | </member> | ||
205 | <member name="M:HttpServer.Authentication.DigestAuthentication.Encrypt(System.String,System.String,System.String,System.String,System.String,System.String,System.String,System.String,System.String)"> | ||
206 | <summary> | ||
207 | Encrypts parameters into a Digest string | ||
208 | </summary> | ||
209 | <param name="realm">Realm that the user want to log into.</param> | ||
210 | <param name="userName">User logging in</param> | ||
211 | <param name="password">Users password.</param> | ||
212 | <param name="method">HTTP method.</param> | ||
213 | <param name="uri">Uri/domain that generated the login prompt.</param> | ||
214 | <param name="qop">Quality of Protection.</param> | ||
215 | <param name="nonce">"Number used ONCE"</param> | ||
216 | <param name="nc">Hexadecimal request counter.</param> | ||
217 | <param name="cnonce">"Client Number used ONCE"</param> | ||
218 | <returns>Digest encrypted string</returns> | ||
219 | </member> | ||
220 | <member name="M:HttpServer.Authentication.DigestAuthentication.Encrypt(System.String,System.String,System.String,System.String,System.String,System.String)"> | ||
221 | <summary> | ||
222 | |||
223 | </summary> | ||
224 | <param name="ha1">Md5 hex encoded "userName:realm:password", without the quotes.</param> | ||
225 | <param name="ha2">Md5 hex encoded "method:uri", without the quotes</param> | ||
226 | <param name="qop">Quality of Protection</param> | ||
227 | <param name="nonce">"Number used ONCE"</param> | ||
228 | <param name="nc">Hexadecimal request counter.</param> | ||
229 | <param name="cnonce">Client number used once</param> | ||
230 | <returns></returns> | ||
231 | </member> | ||
232 | <member name="M:HttpServer.Authentication.DigestAuthentication.CreateResponse(System.String,System.Object[])"> | ||
233 | <summary> | ||
234 | Create a response that can be sent in the WWW-Authenticate header. | ||
235 | </summary> | ||
236 | <param name="realm">Realm that the user should authenticate in</param> | ||
237 | <param name="options">First options specifies if true if username/password is correct but not cnonce.</param> | ||
238 | <returns>A correct auth request.</returns> | ||
239 | <exception cref="T:System.ArgumentNullException">If realm is empty or null.</exception> | ||
240 | </member> | ||
241 | <member name="M:HttpServer.Authentication.DigestAuthentication.Decode(System.String,System.Text.Encoding)"> | ||
242 | <summary> | ||
243 | Decodes authorization header value | ||
244 | </summary> | ||
245 | <param name="buffer">header value</param> | ||
246 | <param name="encoding">Encoding that the buffer is in</param> | ||
247 | <returns>All headers and their values if successful; otherwise null</returns> | ||
248 | <example> | ||
249 | NameValueCollection header = DigestAuthentication.Decode("response=\"6629fae49393a05397450978507c4ef1\",\r\nc=00001", Encoding.ASCII); | ||
250 | </example> | ||
251 | <remarks>Can handle lots of whitespaces and new lines without failing.</remarks> | ||
252 | </member> | ||
253 | <member name="M:HttpServer.Authentication.DigestAuthentication.GetCurrentNonce"> | ||
254 | <summary> | ||
255 | Gets the current nonce. | ||
256 | </summary> | ||
257 | <returns></returns> | ||
258 | </member> | ||
259 | <member name="M:HttpServer.Authentication.DigestAuthentication.GetMD5HashBinHex2(System.String)"> | ||
260 | <summary> | ||
261 | Gets the Md5 hash bin hex2. | ||
262 | </summary> | ||
263 | <param name="toBeHashed">To be hashed.</param> | ||
264 | <returns></returns> | ||
265 | </member> | ||
266 | <member name="M:HttpServer.Authentication.DigestAuthentication.IsValidNonce(System.String)"> | ||
267 | <summary> | ||
268 | determines if the nonce is valid or has expired. | ||
269 | </summary> | ||
270 | <param name="nonce">nonce value (check wikipedia for info)</param> | ||
271 | <returns>true if the nonce has not expired.</returns> | ||
272 | </member> | ||
273 | <member name="T:HttpServer.Check"> | ||
274 | <summary> | ||
275 | Small design by contract implementation. | ||
276 | </summary> | ||
277 | </member> | ||
278 | <member name="M:HttpServer.Check.NotEmpty(System.String,System.String)"> | ||
279 | <summary> | ||
280 | Check whether a parameter is empty. | ||
281 | </summary> | ||
282 | <param name="value">Parameter value</param> | ||
283 | <param name="parameterOrErrorMessage">Parameter name, or error description.</param> | ||
284 | <exception cref="T:System.ArgumentException">value is empty.</exception> | ||
285 | </member> | ||
286 | <member name="M:HttpServer.Check.Require(System.Object,System.String)"> | ||
287 | <summary> | ||
288 | Checks whether a parameter is null. | ||
289 | </summary> | ||
290 | <param name="value">Parameter value</param> | ||
291 | <param name="parameterOrErrorMessage">Parameter name, or error description.</param> | ||
292 | <exception cref="T:System.ArgumentNullException">value is null.</exception> | ||
293 | </member> | ||
294 | <member name="M:HttpServer.Check.Min(System.Int32,System.Object,System.String)"> | ||
295 | <summary> | ||
296 | Checks whether a parameter is null. | ||
297 | </summary> | ||
298 | <param name="minValue"></param> | ||
299 | <param name="value">Parameter value</param> | ||
300 | <param name="parameterOrErrorMessage">Parameter name, or error description.</param> | ||
301 | <exception cref="T:System.ArgumentException">value is null.</exception> | ||
302 | </member> | ||
303 | <member name="T:HttpServer.ClientAcceptedEventArgs"> | ||
304 | <summary> | ||
305 | Invoked when a client have been accepted by the <see cref="T:HttpServer.HttpListener"/> | ||
306 | </summary> | ||
307 | <remarks> | ||
308 | Can be used to revoke incoming connections | ||
309 | </remarks> | ||
310 | </member> | ||
311 | <member name="M:HttpServer.ClientAcceptedEventArgs.#ctor(System.Net.Sockets.Socket)"> | ||
312 | <summary> | ||
313 | Initializes a new instance of the <see cref="T:HttpServer.ClientAcceptedEventArgs"/> class. | ||
314 | </summary> | ||
315 | <param name="socket">The socket.</param> | ||
316 | </member> | ||
317 | <member name="P:HttpServer.ClientAcceptedEventArgs.Socket"> | ||
318 | <summary> | ||
319 | Accepted socket. | ||
320 | </summary> | ||
321 | </member> | ||
322 | <member name="P:HttpServer.ClientAcceptedEventArgs.Revoked"> | ||
323 | <summary> | ||
324 | Client should be revoked. | ||
325 | </summary> | ||
326 | </member> | ||
327 | <member name="M:HttpServer.ClientAcceptedEventArgs.Revoke"> | ||
328 | <summary> | ||
329 | Client may not be handled. | ||
330 | </summary> | ||
331 | </member> | ||
332 | <member name="M:HttpServer.ComponentProvider.AddInstance``1(System.Object)"> | ||
333 | <summary> | ||
334 | Add a component instance | ||
335 | </summary> | ||
336 | <typeparam name="T">Interface type</typeparam> | ||
337 | <param name="instance">Instance to add</param> | ||
338 | </member> | ||
339 | <member name="M:HttpServer.ComponentProvider.Get``1"> | ||
340 | <summary> | ||
341 | Get a component. | ||
342 | </summary> | ||
343 | <typeparam name="T">Interface type</typeparam> | ||
344 | <returns>Component if registered, otherwise null.</returns> | ||
345 | <remarks> | ||
346 | Component will get created if needed. | ||
347 | </remarks> | ||
348 | </member> | ||
349 | <member name="M:HttpServer.ComponentProvider.Create(HttpServer.ComponentProvider.TypeInformation)"> | ||
350 | <exception cref="T:System.InvalidOperationException">If instance cannot be created.</exception> | ||
351 | </member> | ||
352 | <member name="M:HttpServer.ComponentProvider.Contains(System.Type)"> | ||
353 | <summary> | ||
354 | Checks if the specified component interface have been added. | ||
355 | </summary> | ||
356 | <param name="interfaceType"></param> | ||
357 | <returns>true if found; otherwise false.</returns> | ||
358 | </member> | ||
359 | <member name="M:HttpServer.ComponentProvider.Add``2"> | ||
360 | <summary> | ||
361 | Add a component. | ||
362 | </summary> | ||
363 | <typeparam name="InterfaceType">Type being requested.</typeparam> | ||
364 | <typeparam name="InstanceType">Type being created.</typeparam> | ||
365 | <exception cref="T:System.InvalidOperationException">Type have already been mapped.</exception> | ||
366 | </member> | ||
367 | <member name="T:HttpServer.ContentType"> | ||
368 | <summary> | ||
369 | Lists content type mime types. | ||
370 | </summary> | ||
371 | </member> | ||
372 | <member name="F:HttpServer.ContentType.Text"> | ||
373 | <summary> | ||
374 | text/plain | ||
375 | </summary> | ||
376 | </member> | ||
377 | <member name="F:HttpServer.ContentType.Html"> | ||
378 | <summary> | ||
379 | text/haml | ||
380 | </summary> | ||
381 | </member> | ||
382 | <member name="F:HttpServer.ContentType.Javascript"> | ||
383 | <summary> | ||
384 | content type for javascript documents = application/javascript | ||
385 | </summary> | ||
386 | <remarks> | ||
387 | <para> | ||
388 | RFC 4329 states that text/javascript have been superseeded by | ||
389 | application/javascript. You might still want to check browser versions | ||
390 | since older ones do not support application/javascript. | ||
391 | </para> | ||
392 | <para>Browser support: http://krijnhoetmer.nl/stuff/javascript/mime-types/</para> | ||
393 | </remarks> | ||
394 | </member> | ||
395 | <member name="F:HttpServer.ContentType.Xml"> | ||
396 | <summary> | ||
397 | text/xml | ||
398 | </summary> | ||
399 | </member> | ||
400 | <member name="T:HttpServer.ContentTypes"> | ||
401 | <summary> | ||
402 | A list of content types | ||
403 | </summary> | ||
404 | </member> | ||
405 | <member name="M:HttpServer.ContentTypes.#ctor(System.String)"> | ||
406 | <summary> | ||
407 | |||
408 | </summary> | ||
409 | <param name="types">Semicolon separated content types.</param> | ||
410 | </member> | ||
411 | <member name="P:HttpServer.ContentTypes.First"> | ||
412 | <summary> | ||
413 | Get this first content type. | ||
414 | </summary> | ||
415 | </member> | ||
416 | <member name="P:HttpServer.ContentTypes.Item(System.String)"> | ||
417 | <summary> | ||
418 | Fetch a content type | ||
419 | </summary> | ||
420 | <param name="type">Part of type ("xml" would return "application/xml")</param> | ||
421 | <returns></returns> | ||
422 | <remarks>All content types are in lower case.</remarks> | ||
423 | </member> | ||
424 | <member name="M:HttpServer.ContentTypes.GetEnumerator"> | ||
425 | <summary> | ||
426 | Returns an enumerator that iterates through a collection. | ||
427 | </summary> | ||
428 | <returns> | ||
429 | An <see cref="T:System.Collections.IEnumerator"/> object that can be used to iterate through the collection. | ||
430 | </returns> | ||
431 | </member> | ||
432 | <member name="M:HttpServer.ContentTypes.Contains(System.String)"> | ||
433 | <summary> | ||
434 | Searches for the specified type | ||
435 | </summary> | ||
436 | <param name="type">Can also be a part of a type (searching for "xml" would return true for "application/xml").</param> | ||
437 | <returns>true if type was found.</returns> | ||
438 | </member> | ||
439 | <member name="T:HttpServer.ContextTimeoutManager"> | ||
440 | <summary> | ||
441 | Timeout Manager. Checks for dead clients. Clients with open connections that are not doing anything. Closes sessions opened with keepalive. | ||
442 | </summary> | ||
443 | </member> | ||
444 | <member name="T:HttpServer.ContextTimeoutManager.MonitorType"> | ||
445 | <summary> | ||
446 | Use a Thread or a Timer to monitor the ugly | ||
447 | </summary> | ||
448 | </member> | ||
449 | <member name="M:HttpServer.ContextTimeoutManager.ProcessContextTimeouts"> | ||
450 | <summary> | ||
451 | Causes the watcher to immediately check the connections. | ||
452 | </summary> | ||
453 | </member> | ||
454 | <member name="M:HttpServer.ContextTimeoutManager.EnvironmentTickCount"> | ||
455 | <summary> | ||
456 | Environment.TickCount is an int but it counts all 32 bits so it goes positive | ||
457 | and negative every 24.9 days. This trims down TickCount so it doesn't wrap | ||
458 | for the callers. | ||
459 | This trims it to a 12 day interval so don't let your frame time get too long. | ||
460 | </summary> | ||
461 | <returns></returns> | ||
462 | </member> | ||
463 | <member name="M:HttpServer.ContextTimeoutManager.EnvironmentTickCountSubtract(System.Int32,System.Int32)"> | ||
464 | <summary> | ||
465 | Environment.TickCount is an int but it counts all 32 bits so it goes positive | ||
466 | and negative every 24.9 days. Subtracts the passed value (previously fetched by | ||
467 | 'EnvironmentTickCount()') and accounts for any wrapping. | ||
468 | </summary> | ||
469 | <param name="newValue"></param> | ||
470 | <param name="prevValue"></param> | ||
471 | <returns>subtraction of passed prevValue from current Environment.TickCount</returns> | ||
472 | </member> | ||
473 | <member name="M:HttpServer.ContextTimeoutManager.EnvironmentTickCountAdd(System.Int32,System.Int32)"> | ||
474 | <summary> | ||
475 | Environment.TickCount is an int but it counts all 32 bits so it goes positive | ||
476 | and negative every 24.9 days. Subtracts the passed value (previously fetched by | ||
477 | 'EnvironmentTickCount()') and accounts for any wrapping. | ||
478 | </summary> | ||
479 | <param name="newValue"></param> | ||
480 | <param name="prevValue"></param> | ||
481 | <returns>subtraction of passed prevValue from current Environment.TickCount</returns> | ||
482 | </member> | ||
483 | <member name="M:HttpServer.ContextTimeoutManager.EnvironmentTickCountSubtract(System.Int32)"> | ||
484 | <summary> | ||
485 | Environment.TickCount is an int but it counts all 32 bits so it goes positive | ||
486 | and negative every 24.9 days. Subtracts the passed value (previously fetched by | ||
487 | 'EnvironmentTickCount()') and accounts for any wrapping. | ||
488 | </summary> | ||
489 | <returns>subtraction of passed prevValue from current Environment.TickCount</returns> | ||
490 | </member> | ||
491 | <member name="T:HttpServer.ExceptionHandler"> | ||
492 | <summary> | ||
493 | We dont want to let the server to die due to exceptions thrown in worker threads. | ||
494 | therefore we use this delegate to give you a change to handle uncaught exceptions. | ||
495 | </summary> | ||
496 | <param name="source">Class that the exception was thrown in.</param> | ||
497 | <param name="exception">Exception</param> | ||
498 | <remarks> | ||
499 | Server will throw a InternalServerException in release version if you dont | ||
500 | handle this delegate. | ||
501 | </remarks> | ||
502 | </member> | ||
503 | <member name="T:HttpServer.Exceptions.BadRequestException"> | ||
504 | <summary> | ||
505 | The request could not be understood by the server due to malformed syntax. | ||
506 | The client SHOULD NOT repeat the request without modifications. | ||
507 | |||
508 | Text taken from: http://www.submissionchamber.com/help-guides/error-codes.php | ||
509 | </summary> | ||
510 | </member> | ||
511 | <member name="M:HttpServer.Exceptions.BadRequestException.#ctor(System.String)"> | ||
512 | <summary> | ||
513 | Create a new bad request exception. | ||
514 | </summary> | ||
515 | <param name="errMsg">reason to why the request was bad.</param> | ||
516 | </member> | ||
517 | <member name="M:HttpServer.Exceptions.BadRequestException.#ctor(System.String,System.Exception)"> | ||
518 | <summary> | ||
519 | Create a new bad request exception. | ||
520 | </summary> | ||
521 | <param name="errMsg">reason to why the request was bad.</param> | ||
522 | <param name="inner">inner exception</param> | ||
523 | </member> | ||
524 | <member name="T:HttpServer.Exceptions.ForbiddenException"> | ||
525 | <summary> | ||
526 | The server understood the request, but is refusing to fulfill it. | ||
527 | Authorization will not help and the request SHOULD NOT be repeated. | ||
528 | If the request method was not HEAD and the server wishes to make public why the request has not been fulfilled, | ||
529 | it SHOULD describe the reason for the refusal in the entity. If the server does not wish to make this information | ||
530 | available to the client, the status code 404 (Not Found) can be used instead. | ||
531 | |||
532 | Text taken from: http://www.submissionchamber.com/help-guides/error-codes.php | ||
533 | </summary> | ||
534 | </member> | ||
535 | <member name="M:HttpServer.Exceptions.ForbiddenException.#ctor(System.String)"> | ||
536 | <summary> | ||
537 | Initializes a new instance of the <see cref="T:HttpServer.Exceptions.ForbiddenException"/> class. | ||
538 | </summary> | ||
539 | <param name="errorMsg">error message</param> | ||
540 | </member> | ||
541 | <member name="T:HttpServer.Exceptions.HttpException"> | ||
542 | <summary> | ||
543 | All HTTP based exceptions will derive this class. | ||
544 | </summary> | ||
545 | </member> | ||
546 | <member name="M:HttpServer.Exceptions.HttpException.#ctor(System.Net.HttpStatusCode,System.String)"> | ||
547 | <summary> | ||
548 | Create a new HttpException | ||
549 | </summary> | ||
550 | <param name="code">http status code (sent in the response)</param> | ||
551 | <param name="message">error description</param> | ||
552 | </member> | ||
553 | <member name="M:HttpServer.Exceptions.HttpException.#ctor(System.Net.HttpStatusCode,System.String,System.Exception)"> | ||
554 | <summary> | ||
555 | Create a new HttpException | ||
556 | </summary> | ||
557 | <param name="code">http status code (sent in the response)</param> | ||
558 | <param name="message">error description</param> | ||
559 | <param name="inner">inner exception</param> | ||
560 | </member> | ||
561 | <member name="P:HttpServer.Exceptions.HttpException.HttpStatusCode"> | ||
562 | <summary> | ||
563 | status code to use in the response. | ||
564 | </summary> | ||
565 | </member> | ||
566 | <member name="T:HttpServer.Exceptions.InternalServerException"> | ||
567 | <summary> | ||
568 | The server encountered an unexpected condition which prevented it from fulfilling the request. | ||
569 | </summary> | ||
570 | </member> | ||
571 | <member name="M:HttpServer.Exceptions.InternalServerException.#ctor"> | ||
572 | <summary> | ||
573 | Initializes a new instance of the <see cref="T:HttpServer.Exceptions.InternalServerException"/> class. | ||
574 | </summary> | ||
575 | </member> | ||
576 | <member name="M:HttpServer.Exceptions.InternalServerException.#ctor(System.String)"> | ||
577 | <summary> | ||
578 | Initializes a new instance of the <see cref="T:HttpServer.Exceptions.InternalServerException"/> class. | ||
579 | </summary> | ||
580 | <param name="message">error message.</param> | ||
581 | </member> | ||
582 | <member name="M:HttpServer.Exceptions.InternalServerException.#ctor(System.String,System.Exception)"> | ||
583 | <summary> | ||
584 | Initializes a new instance of the <see cref="T:HttpServer.Exceptions.InternalServerException"/> class. | ||
585 | </summary> | ||
586 | <param name="message">error message.</param> | ||
587 | <param name="inner">inner exception.</param> | ||
588 | </member> | ||
589 | <member name="T:HttpServer.Exceptions.NotFoundException"> | ||
590 | <summary> | ||
591 | The requested resource was not found in the web server. | ||
592 | </summary> | ||
593 | </member> | ||
594 | <member name="M:HttpServer.Exceptions.NotFoundException.#ctor(System.String,System.Exception)"> | ||
595 | <summary> | ||
596 | Create a new exception | ||
597 | </summary> | ||
598 | <param name="message">message describing the error</param> | ||
599 | <param name="inner">inner exception</param> | ||
600 | </member> | ||
601 | <member name="M:HttpServer.Exceptions.NotFoundException.#ctor(System.String)"> | ||
602 | <summary> | ||
603 | Create a new exception | ||
604 | </summary> | ||
605 | <param name="message">message describing the error</param> | ||
606 | </member> | ||
607 | <member name="T:HttpServer.Exceptions.UnauthorizedException"> | ||
608 | <summary> | ||
609 | The request requires user authentication. The response MUST include a | ||
610 | WWW-Authenticate header field (section 14.47) containing a challenge | ||
611 | applicable to the requested resource. | ||
612 | |||
613 | The client MAY repeat the request with a suitable Authorization header | ||
614 | field (section 14.8). If the request already included Authorization | ||
615 | credentials, then the 401 response indicates that authorization has been | ||
616 | refused for those credentials. If the 401 response contains the same challenge | ||
617 | as the prior response, and the user agent has already attempted authentication | ||
618 | at least once, then the user SHOULD be presented the entity that was given in the response, | ||
619 | since that entity might include relevant diagnostic information. | ||
620 | |||
621 | HTTP access authentication is explained in rfc2617: | ||
622 | http://www.ietf.org/rfc/rfc2617.txt | ||
623 | |||
624 | (description is taken from | ||
625 | http://www.submissionchamber.com/help-guides/error-codes.php#sec10.4.2) | ||
626 | </summary> | ||
627 | </member> | ||
628 | <member name="M:HttpServer.Exceptions.UnauthorizedException.#ctor"> | ||
629 | <summary> | ||
630 | Create a new unauhtorized exception. | ||
631 | </summary> | ||
632 | <seealso cref="T:HttpServer.Exceptions.UnauthorizedException"/> | ||
633 | </member> | ||
634 | <member name="M:HttpServer.Exceptions.UnauthorizedException.#ctor(System.String,System.Exception)"> | ||
635 | <summary> | ||
636 | Create a new unauhtorized exception. | ||
637 | </summary> | ||
638 | <param name="message">reason to why the request was unauthorized.</param> | ||
639 | <param name="inner">inner exception</param> | ||
640 | </member> | ||
641 | <member name="M:HttpServer.Exceptions.UnauthorizedException.#ctor(System.String)"> | ||
642 | <summary> | ||
643 | Create a new unauhtorized exception. | ||
644 | </summary> | ||
645 | <param name="message">reason to why the request was unauthorized.</param> | ||
646 | </member> | ||
647 | <member name="T:HttpServer.FormDecoders.FormDecoderProvider"> | ||
648 | <summary> | ||
649 | This provider is used to let us implement any type of form decoding we want without | ||
650 | having to rewrite anything else in the server. | ||
651 | </summary> | ||
652 | </member> | ||
653 | <member name="M:HttpServer.FormDecoders.FormDecoderProvider.Decode(System.String,System.IO.Stream,System.Text.Encoding)"> | ||
654 | <summary> | ||
655 | |||
656 | </summary> | ||
657 | <param name="contentType">Should contain boundary and type, as in: multipart/form-data; boundary=---------------------------230051238959</param> | ||
658 | <param name="stream">Stream containing form data.</param> | ||
659 | <param name="encoding">Encoding used when decoding the stream</param> | ||
660 | <returns><see cref="F:HttpServer.HttpInput.Empty"/> if no parser was found.</returns> | ||
661 | <exception cref="T:System.ArgumentException">If stream is null or not readable.</exception> | ||
662 | <exception cref="T:System.IO.InvalidDataException">If stream contents cannot be decoded properly.</exception> | ||
663 | </member> | ||
664 | <member name="M:HttpServer.FormDecoders.FormDecoderProvider.Add(HttpServer.FormDecoders.IFormDecoder)"> | ||
665 | <summary> | ||
666 | Add a decoder. | ||
667 | </summary> | ||
668 | <param name="decoder"></param> | ||
669 | <exception cref="T:System.ArgumentNullException"></exception> | ||
670 | </member> | ||
671 | <member name="P:HttpServer.FormDecoders.FormDecoderProvider.Count"> | ||
672 | <summary> | ||
673 | Number of added decoders. | ||
674 | </summary> | ||
675 | </member> | ||
676 | <member name="P:HttpServer.FormDecoders.FormDecoderProvider.Decoders"> | ||
677 | <summary> | ||
678 | Use with care. | ||
679 | </summary> | ||
680 | </member> | ||
681 | <member name="P:HttpServer.FormDecoders.FormDecoderProvider.DefaultDecoder"> | ||
682 | <summary> | ||
683 | Decoder used for unknown content types. | ||
684 | </summary> | ||
685 | </member> | ||
686 | <member name="T:HttpServer.FormDecoders.HttpMultipart.Element"> | ||
687 | <summary>Represents a field in a multipart form</summary> | ||
688 | </member> | ||
689 | <member name="M:HttpServer.FormDecoders.HttpMultipart.ReadLine"> | ||
690 | <summary> | ||
691 | |||
692 | </summary> | ||
693 | <returns></returns> | ||
694 | <exception cref="T:System.ArgumentOutOfRangeException"></exception> | ||
695 | <exception cref="T:System.ObjectDisposedException"></exception> | ||
696 | </member> | ||
697 | <member name="T:HttpServer.FormDecoders.IFormDecoder"> | ||
698 | <summary> | ||
699 | Interface for form content decoders. | ||
700 | </summary> | ||
701 | </member> | ||
702 | <member name="M:HttpServer.FormDecoders.IFormDecoder.Decode(System.IO.Stream,System.String,System.Text.Encoding)"> | ||
703 | <summary> | ||
704 | |||
705 | </summary> | ||
706 | <param name="stream">Stream containing the content</param> | ||
707 | <param name="contentType">Content type (with any additional info like boundry). Content type is always supplied in lower case</param> | ||
708 | <param name="encoding">Stream enconding</param> | ||
709 | <returns>A http form, or null if content could not be parsed.</returns> | ||
710 | <exception cref="T:System.IO.InvalidDataException">If contents in the stream is not valid input data.</exception> | ||
711 | </member> | ||
712 | <member name="M:HttpServer.FormDecoders.IFormDecoder.CanParse(System.String)"> | ||
713 | <summary> | ||
714 | Checks if the decoder can handle the mime type | ||
715 | </summary> | ||
716 | <param name="contentType">Content type (with any additional info like boundry). Content type is always supplied in lower case.</param> | ||
717 | <returns>True if the decoder can parse the specified content type</returns> | ||
718 | </member> | ||
719 | <member name="T:HttpServer.FormDecoders.MultipartDecoder"> | ||
720 | <summary> | ||
721 | |||
722 | </summary> | ||
723 | <remarks> | ||
724 | http://www.faqs.org/rfcs/rfc1867.html | ||
725 | </remarks> | ||
726 | </member> | ||
727 | <member name="F:HttpServer.FormDecoders.MultipartDecoder.MimeType"> | ||
728 | <summary> | ||
729 | multipart/form-data | ||
730 | </summary> | ||
731 | </member> | ||
732 | <member name="F:HttpServer.FormDecoders.MultipartDecoder.FormData"> | ||
733 | <summary> | ||
734 | form-data | ||
735 | </summary> | ||
736 | </member> | ||
737 | <member name="M:HttpServer.FormDecoders.MultipartDecoder.Decode(System.IO.Stream,System.String,System.Text.Encoding)"> | ||
738 | <summary> | ||
739 | |||
740 | </summary> | ||
741 | <param name="stream">Stream containing the content</param> | ||
742 | <param name="contentType">Content type (with any additional info like boundry). Content type is always supplied in lower case</param> | ||
743 | <param name="encoding">Stream enconding</param> | ||
744 | <returns>A http form, or null if content could not be parsed.</returns> | ||
745 | <exception cref="T:System.IO.InvalidDataException">If contents in the stream is not valid input data.</exception> | ||
746 | <exception cref="T:System.ArgumentNullException">If any parameter is null</exception> | ||
747 | </member> | ||
748 | <member name="M:HttpServer.FormDecoders.MultipartDecoder.CanParse(System.String)"> | ||
749 | <summary> | ||
750 | Checks if the decoder can handle the mime type | ||
751 | </summary> | ||
752 | <param name="contentType">Content type (with any additional info like boundry). Content type is always supplied in lower case.</param> | ||
753 | <returns>True if the decoder can parse the specified content type</returns> | ||
754 | </member> | ||
755 | <member name="T:HttpServer.FormDecoders.UrlDecoder"> | ||
756 | <summary> | ||
757 | Can handle application/x-www-form-urlencoded | ||
758 | </summary> | ||
759 | </member> | ||
760 | <member name="M:HttpServer.FormDecoders.UrlDecoder.Decode(System.IO.Stream,System.String,System.Text.Encoding)"> | ||
761 | <summary> | ||
762 | </summary> | ||
763 | <param name="stream">Stream containing the content</param> | ||
764 | <param name="contentType">Content type (with any additional info like boundry). Content type is always supplied in lower case</param> | ||
765 | <param name="encoding">Stream encoding</param> | ||
766 | <returns> | ||
767 | A HTTP form, or null if content could not be parsed. | ||
768 | </returns> | ||
769 | <exception cref="T:System.IO.InvalidDataException">If contents in the stream is not valid input data.</exception> | ||
770 | </member> | ||
771 | <member name="M:HttpServer.FormDecoders.UrlDecoder.CanParse(System.String)"> | ||
772 | <summary> | ||
773 | Checks if the decoder can handle the mime type | ||
774 | </summary> | ||
775 | <param name="contentType">Content type (with any additional info like boundry). Content type is always supplied in lower case.</param> | ||
776 | <returns>True if the decoder can parse the specified content type</returns> | ||
777 | </member> | ||
778 | <member name="T:HttpServer.FormDecoders.XmlDecoder"> | ||
779 | <summary> | ||
780 | This decoder converts XML documents to form items. | ||
781 | Each element becomes a subitem in the form, and each attribute becomes an item. | ||
782 | </summary> | ||
783 | <example> | ||
784 | // xml: <hello id="1">something<world id="2">data</world></hello> | ||
785 | // result: | ||
786 | // form["hello"].Value = "something" | ||
787 | // form["hello"]["id"].Value = 1 | ||
788 | // form["hello"]["world]["id"].Value = 1 | ||
789 | // form["hello"]["world"].Value = "data" | ||
790 | </example> | ||
791 | <remarks> | ||
792 | The original xml document is stored in form["__xml__"].Value. | ||
793 | </remarks> | ||
794 | </member> | ||
795 | <member name="M:HttpServer.FormDecoders.XmlDecoder.Decode(System.IO.Stream,System.String,System.Text.Encoding)"> | ||
796 | <summary> | ||
797 | |||
798 | </summary> | ||
799 | <param name="stream">Stream containing the content</param> | ||
800 | <param name="contentType">Content type (with any additional info like boundry). Content type is always supplied in lower case</param> | ||
801 | <param name="encoding">Stream encoding</param> | ||
802 | Note: contentType and encoding are not used? | ||
803 | <returns>A http form, or null if content could not be parsed.</returns> | ||
804 | <exception cref="T:System.IO.InvalidDataException"></exception> | ||
805 | </member> | ||
806 | <member name="M:HttpServer.FormDecoders.XmlDecoder.TraverseNode(HttpServer.IHttpInput,System.Xml.XmlNode)"> | ||
807 | <summary> | ||
808 | Recursive function that will go through an xml element and store it's content | ||
809 | to the form item. | ||
810 | </summary> | ||
811 | <param name="item">(parent) Item in form that content should be added to.</param> | ||
812 | <param name="node">Node that should be parsed.</param> | ||
813 | </member> | ||
814 | <member name="M:HttpServer.FormDecoders.XmlDecoder.CanParse(System.String)"> | ||
815 | <summary> | ||
816 | Checks if the decoder can handle the mime type | ||
817 | </summary> | ||
818 | <param name="contentType">Content type (with any additional info like boundry). Content type is always supplied in lower case.</param> | ||
819 | <returns>True if the decoder can parse the specified content type</returns> | ||
820 | </member> | ||
821 | <member name="T:HttpServer.Helpers.FormHelper"> | ||
822 | <summary> | ||
823 | Helpers making it easier to work with forms. | ||
824 | </summary> | ||
825 | <seealso cref="T:HttpServer.Helpers.ObjectForm"/> | ||
826 | </member> | ||
827 | <member name="F:HttpServer.Helpers.FormHelper.JSImplementation"> | ||
828 | <summary> | ||
829 | Used to let the website use different JavaScript libraries. | ||
830 | Default is <see cref="T:HttpServer.Helpers.Implementations.PrototypeImp"/> | ||
831 | </summary> | ||
832 | </member> | ||
833 | <member name="M:HttpServer.Helpers.FormHelper.Start(System.String,System.String,System.Boolean,System.String[])"> | ||
834 | <summary> | ||
835 | Create a <form> tag. | ||
836 | </summary> | ||
837 | <param name="id">name of form</param> | ||
838 | <param name="action">action to invoke on submit</param> | ||
839 | <param name="isAjax">form should be posted as Ajax</param> | ||
840 | <returns>HTML code</returns> | ||
841 | <example> | ||
842 | <code> | ||
843 | // without options | ||
844 | WebHelper.FormStart("frmLogin", "/user/login", Request.IsAjax); | ||
845 | |||
846 | // with options | ||
847 | WebHelper.FormStart("frmLogin", "/user/login", Request.IsAjax, "style", "display:inline", "class", "greenForm"); | ||
848 | </code> | ||
849 | </example> | ||
850 | <param name="options">HTML attributes or JavaScript options.</param> | ||
851 | <remarks>Method will ALWAYS be POST.</remarks> | ||
852 | <exception cref="T:System.ArgumentException">options must consist of name, value, name, value</exception> | ||
853 | </member> | ||
854 | <member name="M:HttpServer.Helpers.FormHelper.Select(System.String,System.Collections.IEnumerable,HttpServer.Helpers.GetIdTitle,System.Object,System.Boolean)"> | ||
855 | <summary> | ||
856 | Creates a select list with the values in a collection. | ||
857 | </summary> | ||
858 | <param name="name">Name of the SELECT-tag</param> | ||
859 | <param name="collection">collection used to generate options.</param> | ||
860 | <param name="getIdTitle">delegate used to return id and title from objects.</param> | ||
861 | <param name="selectedValue">value that should be marked as selected.</param> | ||
862 | <param name="firstEmpty">First row should contain an empty value.</param> | ||
863 | <returns>string containing a SELECT-tag.</returns> | ||
864 | <seealso cref="T:HttpServer.Helpers.GetIdTitle"/> | ||
865 | </member> | ||
866 | <member name="M:HttpServer.Helpers.FormHelper.Select(System.String,System.String,System.Collections.IEnumerable,HttpServer.Helpers.GetIdTitle,System.Object,System.Boolean)"> | ||
867 | <summary> | ||
868 | Creates a select list with the values in a collection. | ||
869 | </summary> | ||
870 | <param name="name">Name of the SELECT-tag</param> | ||
871 | <param name="id">Id of the SELECT-tag</param> | ||
872 | <param name="collection">collection used to generate options.</param> | ||
873 | <param name="getIdTitle">delegate used to return id and title from objects.</param> | ||
874 | <param name="selectedValue">value that should be marked as selected.</param> | ||
875 | <param name="firstEmpty">First row should contain an empty value.</param> | ||
876 | <returns>string containing a SELECT-tag.</returns> | ||
877 | <seealso cref="T:HttpServer.Helpers.GetIdTitle"/> | ||
878 | <example> | ||
879 | <code> | ||
880 | // Class that is going to be used in a SELECT-tag. | ||
881 | public class User | ||
882 | { | ||
883 | private readonly string _realName; | ||
884 | private readonly int _id; | ||
885 | public User(int id, string realName) | ||
886 | { | ||
887 | _id = id; | ||
888 | _realName = realName; | ||
889 | } | ||
890 | public string RealName | ||
891 | { | ||
892 | get { return _realName; } | ||
893 | } | ||
894 | |||
895 | public int Id | ||
896 | { | ||
897 | get { return _id; } | ||
898 | } | ||
899 | } | ||
900 | |||
901 | // Using an inline delegate to generate the select list | ||
902 | public void UserInlineDelegate() | ||
903 | { | ||
904 | List<User> items = new List<User>(); | ||
905 | items.Add(new User(1, "adam")); | ||
906 | items.Add(new User(2, "bertial")); | ||
907 | items.Add(new User(3, "david")); | ||
908 | string htmlSelect = Select("users", "users", items, delegate(object o, out object id, out object value) | ||
909 | { | ||
910 | User user = (User)o; | ||
911 | id = user.Id; | ||
912 | value = user.RealName; | ||
913 | }, 2, true); | ||
914 | } | ||
915 | |||
916 | // Using an method as delegate to generate the select list. | ||
917 | public void UseExternalDelegate() | ||
918 | { | ||
919 | List<User> items = new List<User>(); | ||
920 | items.Add(new User(1, "adam")); | ||
921 | items.Add(new User(2, "bertial")); | ||
922 | items.Add(new User(3, "david")); | ||
923 | string htmlSelect = Select("users", "users", items, UserOptions, 1, true); | ||
924 | } | ||
925 | |||
926 | // delegate returning id and title | ||
927 | public static void UserOptions(object o, out object id, out object title) | ||
928 | { | ||
929 | User user = (User)o; | ||
930 | id = user.Id; | ||
931 | value = user.RealName; | ||
932 | } | ||
933 | </code> | ||
934 | </example> | ||
935 | <exception cref="T:System.ArgumentNullException"><c>name</c>, <c>id</c>, <c>collection</c> or <c>getIdTitle</c> is null.</exception> | ||
936 | </member> | ||
937 | <member name="M:HttpServer.Helpers.FormHelper.Select(System.String,System.String,System.Collections.IEnumerable,HttpServer.Helpers.GetIdTitle,System.Object,System.Boolean,System.String[])"> | ||
938 | <summary> | ||
939 | Creates a select list with the values in a collection. | ||
940 | </summary> | ||
941 | <param name="name">Name of the SELECT-tag</param> | ||
942 | <param name="id">Id of the SELECT-tag</param> | ||
943 | <param name="collection">collection used to generate options.</param> | ||
944 | <param name="getIdTitle">delegate used to return id and title from objects.</param> | ||
945 | <param name="selectedValue">value that should be marked as selected.</param> | ||
946 | <param name="firstEmpty">First row should contain an empty value.</param> | ||
947 | <param name="htmlAttributes">name, value collection of extra HTML attributes.</param> | ||
948 | <returns>string containing a SELECT-tag.</returns> | ||
949 | <seealso cref="T:HttpServer.Helpers.GetIdTitle"/> | ||
950 | <exception cref="T:System.ArgumentNullException"><c>name</c>, <c>id</c>, <c>collection</c> or <c>getIdTitle</c> is null.</exception> | ||
951 | <exception cref="T:System.ArgumentException">Invalid HTML attribute list.</exception> | ||
952 | </member> | ||
953 | <member name="M:HttpServer.Helpers.FormHelper.Options(System.Collections.IEnumerable,HttpServer.Helpers.GetIdTitle,System.Object,System.Boolean)"> | ||
954 | <summary> | ||
955 | Generate a list of HTML options | ||
956 | </summary> | ||
957 | <param name="collection">collection used to generate options.</param> | ||
958 | <param name="getIdTitle">delegate used to return id and title from objects.</param> | ||
959 | <param name="selectedValue">value that should be marked as selected.</param> | ||
960 | <param name="firstEmpty">First row should contain an empty value.</param> | ||
961 | <returns></returns> | ||
962 | <exception cref="T:System.ArgumentNullException"><c>collection</c> or <c>getIdTitle</c> is null.</exception> | ||
963 | </member> | ||
964 | <member name="M:HttpServer.Helpers.FormHelper.Options(System.Text.StringBuilder,System.Collections.IEnumerable,HttpServer.Helpers.GetIdTitle,System.Object,System.Boolean)"> | ||
965 | <exception cref="T:System.ArgumentNullException"><c>sb</c> is null.</exception> | ||
966 | </member> | ||
967 | <member name="M:HttpServer.Helpers.FormHelper.CheckBox(System.String,System.Object,System.Object,System.String[])"> | ||
968 | <summary> | ||
969 | Creates a check box. | ||
970 | </summary> | ||
971 | <param name="name">element name</param> | ||
972 | <param name="value">element value</param> | ||
973 | <param name="isChecked">determines if the check box is selected or not. This is done differently depending on the | ||
974 | type of variable. A boolean simply triggers checked or not, all other types are compared with "value" to determine if | ||
975 | the box is checked or not. </param> | ||
976 | <param name="htmlAttributes">a list with additional attributes (name, value, name, value).</param> | ||
977 | <returns>a generated radio button</returns> | ||
978 | </member> | ||
979 | <member name="M:HttpServer.Helpers.FormHelper.CheckBox(System.String,System.String,System.Object,System.Object,System.String[])"> | ||
980 | <summary> | ||
981 | Creates a check box. | ||
982 | </summary> | ||
983 | <param name="name">element name</param> | ||
984 | <param name="id">element id</param> | ||
985 | <param name="value">element value</param> | ||
986 | <param name="isChecked">determines if the check box is selected or not. This is done differently depending on the | ||
987 | type of variable. A boolean simply triggers checked or not, all other types are compared with "value" to determine if | ||
988 | the box is checked or not. </param> | ||
989 | <param name="htmlAttributes">a list with additional attributes (name, value, name, value).</param> | ||
990 | <returns>a generated radio button</returns> | ||
991 | <remarks> | ||
992 | value in your business object. (check box will be selected if it matches the element value) | ||
993 | </remarks> | ||
994 | </member> | ||
995 | <member name="M:HttpServer.Helpers.FormHelper.CheckBox(System.String,System.String,System.Object,System.String[])"> | ||
996 | <summary> | ||
997 | Creates a check box. | ||
998 | </summary> | ||
999 | <param name="name">element name</param> | ||
1000 | <param name="id">element id</param> | ||
1001 | <param name="isChecked">determines if the check box is selected or not. This is done differently depending on the | ||
1002 | type of variable. A boolean simply triggers checked or not, all other types are compared with "value" to determine if | ||
1003 | the box is checked or not. </param> | ||
1004 | <param name="htmlAttributes">a list with additional attributes (name, value, name, value).</param> | ||
1005 | <returns>a generated radio button</returns> | ||
1006 | <remarks>will set value to "1".</remarks> | ||
1007 | </member> | ||
1008 | <member name="M:HttpServer.Helpers.FormHelper.RadioButton(System.String,System.Object,System.Object,System.String[])"> | ||
1009 | <summary> | ||
1010 | Creates a RadioButton. | ||
1011 | </summary> | ||
1012 | <param name="name">element name</param> | ||
1013 | <param name="value">element value</param> | ||
1014 | <param name="isSelected">determines if the radio button is selected or not. This is done differently depending on the | ||
1015 | type of variable. A boolean simply triggers checked or not, all other types are compared with "value" to determine if | ||
1016 | the box is checked or not. </param> | ||
1017 | <param name="htmlAttributes">a list with additional attributes (name, value, name, value).</param> | ||
1018 | <returns>a generated radio button</returns> | ||
1019 | </member> | ||
1020 | <member name="M:HttpServer.Helpers.FormHelper.RadioButton(System.String,System.String,System.Object,System.Object,System.String[])"> | ||
1021 | <summary> | ||
1022 | Creates a RadioButton. | ||
1023 | </summary> | ||
1024 | <param name="name">element name</param> | ||
1025 | <param name="id">element id</param> | ||
1026 | <param name="value">element value</param> | ||
1027 | <param name="isSelected">determines if the radio button is selected or not. This is done differently depending on the | ||
1028 | type of variable. A boolean simply triggers checked or not, all other types are compared with "value" to determine if | ||
1029 | the box is checked or not. </param> | ||
1030 | <param name="htmlAttributes">a list with additional attributes (name, value, name, value).</param> | ||
1031 | <returns>a generated radio button</returns> | ||
1032 | </member> | ||
1033 | <member name="M:HttpServer.Helpers.FormHelper.End"> | ||
1034 | <summary> | ||
1035 | form close tag | ||
1036 | </summary> | ||
1037 | <returns></returns> | ||
1038 | </member> | ||
1039 | <member name="T:HttpServer.Helpers.GetIdTitle"> | ||
1040 | <summary> | ||
1041 | Delegate used by <see cref="M:HttpServer.Helpers.FormHelper.Select(System.String,System.Collections.IEnumerable,HttpServer.Helpers.GetIdTitle,System.Object,System.Boolean)"/> to populate select options. | ||
1042 | </summary> | ||
1043 | <param name="obj">current object (for instance a User).</param> | ||
1044 | <param name="id">Text that should be displayed in the value part of a <optiongt;-tag.</param> | ||
1045 | <param name="title">Text shown in the select list.</param> | ||
1046 | <example> | ||
1047 | // Class that is going to be used in a SELECT-tag. | ||
1048 | public class User | ||
1049 | { | ||
1050 | private readonly string _realName; | ||
1051 | private readonly int _id; | ||
1052 | public User(int id, string realName) | ||
1053 | { | ||
1054 | _id = id; | ||
1055 | _realName = realName; | ||
1056 | } | ||
1057 | public string RealName | ||
1058 | { | ||
1059 | get { return _realName; } | ||
1060 | } | ||
1061 | |||
1062 | public int Id | ||
1063 | { | ||
1064 | get { return _id; } | ||
1065 | } | ||
1066 | } | ||
1067 | |||
1068 | // Using an inline delegate to generate the select list | ||
1069 | public void UserInlineDelegate() | ||
1070 | { | ||
1071 | List<User> items = new List<User>(); | ||
1072 | items.Add(new User(1, "adam")); | ||
1073 | items.Add(new User(2, "bertial")); | ||
1074 | items.Add(new User(3, "david")); | ||
1075 | string htmlSelect = Select("users", "users", items, delegate(object o, out object id, out object value) | ||
1076 | { | ||
1077 | User user = (User)o; | ||
1078 | id = user.Id; | ||
1079 | value = user.RealName; | ||
1080 | }, 2, true); | ||
1081 | } | ||
1082 | |||
1083 | // Using an method as delegate to generate the select list. | ||
1084 | public void UseExternalDelegate() | ||
1085 | { | ||
1086 | List<User> items = new List<User>(); | ||
1087 | items.Add(new User(1, "adam")); | ||
1088 | items.Add(new User(2, "bertial")); | ||
1089 | items.Add(new User(3, "david")); | ||
1090 | string htmlSelect = Select("users", "users", items, UserOptions, 1, true); | ||
1091 | } | ||
1092 | |||
1093 | // delegate returning id and title | ||
1094 | public static void UserOptions(object o, out object id, out object title) | ||
1095 | { | ||
1096 | User user = (User)o; | ||
1097 | id = user.Id; | ||
1098 | value = user.RealName; | ||
1099 | } /// </example> | ||
1100 | </member> | ||
1101 | <member name="T:HttpServer.Helpers.Implementations.PrototypeImp"> | ||
1102 | <summary> | ||
1103 | PrototypeJS implementation of the javascript functions. | ||
1104 | </summary> | ||
1105 | </member> | ||
1106 | <member name="M:HttpServer.Helpers.Implementations.PrototypeImp.AjaxRequest(System.String,System.String[])"> | ||
1107 | <summary> | ||
1108 | Requests a url through ajax | ||
1109 | </summary> | ||
1110 | <param name="url">url to fetch. Url is NOT enclosed in quotes by the implementation. You need to do that yourself.</param> | ||
1111 | <param name="options">optional options in format "key, value, key, value", used in JS request object. All keys should end with colon.</param> | ||
1112 | <returns>a link tag</returns> | ||
1113 | <remarks>onclick attribute is used by this method.</remarks> | ||
1114 | <example> | ||
1115 | <code> | ||
1116 | // plain text | ||
1117 | JSHelper.AjaxRequest("'/user/show/1'"); | ||
1118 | |||
1119 | // ajax request using this.href | ||
1120 | string link = "<a href=\"/user/call/1\" onclick=\"" + JSHelper.AjaxRequest("this.href") + "/<call user</a>"; | ||
1121 | </code> | ||
1122 | </example> | ||
1123 | </member> | ||
1124 | <member name="M:HttpServer.Helpers.Implementations.PrototypeImp.Contains(System.Collections.Generic.IEnumerable{System.String},System.String)"> | ||
1125 | <summary> | ||
1126 | Determins if a list of strings contains a specific value | ||
1127 | </summary> | ||
1128 | <param name="options">options to check in</param> | ||
1129 | <param name="value">value to find</param> | ||
1130 | <returns>true if value was found</returns> | ||
1131 | <remarks>case insensitive</remarks> | ||
1132 | </member> | ||
1133 | <member name="M:HttpServer.Helpers.Implementations.PrototypeImp.AjaxUpdater(System.String,System.String,System.String[])"> | ||
1134 | <summary> | ||
1135 | Ajax requests that updates an element with | ||
1136 | the fetched content | ||
1137 | </summary> | ||
1138 | <param name="url">URL to fetch. URL is NOT enclosed in quotes by the implementation. You need to do that yourself.</param> | ||
1139 | <param name="targetId">element to update</param> | ||
1140 | <param name="options">options in format "key, value, key, value". All keys should end with colon.</param> | ||
1141 | <returns>A link tag.</returns> | ||
1142 | <example> | ||
1143 | <code> | ||
1144 | JSHelper.AjaxUpdater("'/user/show/1'", "user", "onsuccess:", "alert('hello');", "asynchronous:", "true"); | ||
1145 | </code> | ||
1146 | </example> | ||
1147 | </member> | ||
1148 | <member name="M:HttpServer.Helpers.Implementations.PrototypeImp.DialogLink(System.String,System.String,System.String[])"> | ||
1149 | <summary> | ||
1150 | A link that pop ups a Dialog (overlay div) | ||
1151 | </summary> | ||
1152 | <param name="url">URL to contents of dialog</param> | ||
1153 | <param name="title">link title</param> | ||
1154 | <param name="htmlAttributes">name, value, name, value</param> | ||
1155 | <returns> | ||
1156 | A "a"-tag that popups a dialog when clicked | ||
1157 | </returns> | ||
1158 | <remarks><para>Requires Control.Modal found here: http://livepipe.net/projects/control_modal/</para> | ||
1159 | And the following JavaScript (load it in application.js): | ||
1160 | <code> | ||
1161 | Event.observe(window, 'load', | ||
1162 | function() { | ||
1163 | document.getElementsByClassName('modal').each(function(link){ new Control.Modal(link); }); | ||
1164 | } | ||
1165 | ); | ||
1166 | </code> | ||
1167 | </remarks> | ||
1168 | <example> | ||
1169 | WebHelper.DialogLink("/user/show/1", "show user", "onmouseover", "alert('booh!');"); | ||
1170 | </example> | ||
1171 | </member> | ||
1172 | <member name="M:HttpServer.Helpers.Implementations.PrototypeImp.CreateDialog(System.String,System.String,System.String[])"> | ||
1173 | <summary> | ||
1174 | create a modal dialog (usually using DIVs) | ||
1175 | </summary> | ||
1176 | <param name="url">url to fetch</param> | ||
1177 | <param name="title">dialog title</param> | ||
1178 | <param name="options">javascript/html attributes. javascript options ends with colon ':'.</param> | ||
1179 | <returns></returns> | ||
1180 | </member> | ||
1181 | <member name="M:HttpServer.Helpers.Implementations.PrototypeImp.CloseDialog"> | ||
1182 | <summary> | ||
1183 | Close a javascript dialog window/div. | ||
1184 | </summary> | ||
1185 | <returns>javascript for closing a dialog.</returns> | ||
1186 | <see cref="M:HttpServer.Helpers.Implementations.PrototypeImp.DialogLink(System.String,System.String,System.String[])" /> | ||
1187 | </member> | ||
1188 | <member name="M:HttpServer.Helpers.Implementations.PrototypeImp.AjaxFormOnSubmit(System.String[])"> | ||
1189 | <summary> | ||
1190 | javascript action that should be added to the "onsubmit" event in the form tag. | ||
1191 | </summary> | ||
1192 | <param name="options">remember to encapsulate strings in ''</param> | ||
1193 | <returns></returns> | ||
1194 | <remarks>All javascript option names should end with colon.</remarks> | ||
1195 | <example> | ||
1196 | <code> | ||
1197 | JSHelper.AjaxRequest("/user/show/1", "onsuccess:", "$('userInfo').update(result);"); | ||
1198 | </code> | ||
1199 | </example> | ||
1200 | </member> | ||
1201 | <member name="T:HttpServer.Helpers.JSHelper"> | ||
1202 | <summary> | ||
1203 | Will contain helper functions for javascript. | ||
1204 | </summary> | ||
1205 | </member> | ||
1206 | <member name="M:HttpServer.Helpers.JSHelper.AjaxRequest(System.String,System.String[])"> | ||
1207 | <summary> | ||
1208 | Requests a url through ajax | ||
1209 | </summary> | ||
1210 | <param name="url">url to fetch. Url is NOT enclosed in quotes by the implementation. You need to do that yourself.</param> | ||
1211 | <param name="options">optional options in format "key, value, key, value", used in JS request object. All keys should end with colon.</param> | ||
1212 | <returns>a link tag</returns> | ||
1213 | <remarks>onclick attribute is used by this method.</remarks> | ||
1214 | <example> | ||
1215 | <code> | ||
1216 | // plain text | ||
1217 | JSHelper.AjaxRequest("'/user/show/1'"); | ||
1218 | |||
1219 | // ajax request using this.href | ||
1220 | string link = "<a href=\"/user/call/1\" onclick=\"" + JSHelper.AjaxRequest("this.href") + "/<call user</a>"; | ||
1221 | </code> | ||
1222 | </example> | ||
1223 | </member> | ||
1224 | <member name="M:HttpServer.Helpers.JSHelper.AjaxUpdater(System.String,System.String,System.String[])"> | ||
1225 | <summary> | ||
1226 | Ajax requests that updates an element with | ||
1227 | the fetched content | ||
1228 | </summary> | ||
1229 | <param name="url">url to fetch. Url is NOT enclosed in quotes by the implementation. You need to do that yourself.</param> | ||
1230 | <param name="targetId">element to update</param> | ||
1231 | <param name="options">options in format "key, value, key, value". All keys should end with colon.</param> | ||
1232 | <returns>A link tag.</returns> | ||
1233 | <example> | ||
1234 | <code> | ||
1235 | JSHelper.AjaxUpdater("'/user/show/1'", "user", "onsuccess:", "alert('hello');", "asynchronous:", "true"); | ||
1236 | </code> | ||
1237 | </example> | ||
1238 | </member> | ||
1239 | <member name="M:HttpServer.Helpers.JSHelper.CreateDialog(System.String,System.String,System.String[])"> | ||
1240 | <summary> | ||
1241 | Opens contents in a dialog window. | ||
1242 | </summary> | ||
1243 | <param name="url">url to contents of dialog</param> | ||
1244 | <param name="title">link title</param> | ||
1245 | <param name="options">name, value, name, value, all parameter names should end with colon.</param> | ||
1246 | </member> | ||
1247 | <member name="M:HttpServer.Helpers.JSHelper.CloseDialog"> | ||
1248 | <summary> | ||
1249 | Close a javascript dialog window/div. | ||
1250 | </summary> | ||
1251 | <returns>javascript for closing a dialog.</returns> | ||
1252 | <see cref="M:HttpServer.Helpers.JSHelper.CreateDialog(System.String,System.String,System.String[])" /> | ||
1253 | </member> | ||
1254 | <member name="T:HttpServer.Helpers.ObjectForm"> | ||
1255 | <summary> | ||
1256 | The object form class takes an object and creates form items for it. | ||
1257 | </summary> | ||
1258 | </member> | ||
1259 | <member name="M:HttpServer.Helpers.ObjectForm.#ctor(System.String,System.String,System.Object,System.String)"> | ||
1260 | <summary> | ||
1261 | Initializes a new instance of the <see cref="T:HttpServer.Helpers.ObjectForm"/> class. | ||
1262 | </summary> | ||
1263 | <param name="method"></param> | ||
1264 | <param name="name">form name *and* id.</param> | ||
1265 | <param name="action">action to do when form is posted.</param> | ||
1266 | <param name="obj"></param> | ||
1267 | </member> | ||
1268 | <member name="M:HttpServer.Helpers.ObjectForm.#ctor(System.String,System.String,System.Object)"> | ||
1269 | <summary> | ||
1270 | Initializes a new instance of the <see cref="T:HttpServer.Helpers.ObjectForm"/> class. | ||
1271 | </summary> | ||
1272 | <param name="name">form name *and* id.</param> | ||
1273 | <param name="action">action to do when form is posted.</param> | ||
1274 | <param name="obj">object to get values from</param> | ||
1275 | </member> | ||
1276 | <member name="M:HttpServer.Helpers.ObjectForm.#ctor(System.String,System.Object)"> | ||
1277 | <summary> | ||
1278 | Initializes a new instance of the <see cref="T:HttpServer.Helpers.ObjectForm"/> class. | ||
1279 | </summary> | ||
1280 | <param name="action">form action.</param> | ||
1281 | <param name="obj">object to get values from.</param> | ||
1282 | </member> | ||
1283 | <member name="M:HttpServer.Helpers.ObjectForm.Begin"> | ||
1284 | <summary> | ||
1285 | write out the FORM-tag. | ||
1286 | </summary> | ||
1287 | <returns>generated html code</returns> | ||
1288 | </member> | ||
1289 | <member name="M:HttpServer.Helpers.ObjectForm.Begin(System.Boolean)"> | ||
1290 | <summary> | ||
1291 | Writeout the form tag | ||
1292 | </summary> | ||
1293 | <param name="isAjax">form should be posted through ajax.</param> | ||
1294 | <returns>generated html code</returns> | ||
1295 | </member> | ||
1296 | <member name="M:HttpServer.Helpers.ObjectForm.Tb(System.String,System.Object[])"> | ||
1297 | <summary> | ||
1298 | Generates a text box. | ||
1299 | </summary> | ||
1300 | <param name="propertyName"></param> | ||
1301 | <param name="options"></param> | ||
1302 | <returns>generated html code</returns> | ||
1303 | </member> | ||
1304 | <member name="M:HttpServer.Helpers.ObjectForm.Pb(System.String,System.Object[])"> | ||
1305 | <summary> | ||
1306 | password box | ||
1307 | </summary> | ||
1308 | <param name="propertyName"></param> | ||
1309 | <param name="options"></param> | ||
1310 | <returns>generated html code</returns> | ||
1311 | </member> | ||
1312 | <member name="M:HttpServer.Helpers.ObjectForm.Hidden(System.String,System.Object[])"> | ||
1313 | <summary> | ||
1314 | Hiddens the specified property name. | ||
1315 | </summary> | ||
1316 | <param name="propertyName">Name of the property.</param> | ||
1317 | <param name="options">The options.</param> | ||
1318 | <returns>generated html code</returns> | ||
1319 | </member> | ||
1320 | <member name="M:HttpServer.Helpers.ObjectForm.Label(System.String,System.String)"> | ||
1321 | <summary> | ||
1322 | Labels the specified property name. | ||
1323 | </summary> | ||
1324 | <param name="propertyName">property in object.</param> | ||
1325 | <param name="label">caption</param> | ||
1326 | <returns>generated html code</returns> | ||
1327 | </member> | ||
1328 | <member name="M:HttpServer.Helpers.ObjectForm.Cb(System.String,System.String,System.Object[])"> | ||
1329 | <summary> | ||
1330 | Generate a checkbox | ||
1331 | </summary> | ||
1332 | <param name="propertyName">property in object</param> | ||
1333 | <param name="value">checkbox value</param> | ||
1334 | <param name="options">additional html attributes.</param> | ||
1335 | <returns>generated html code</returns> | ||
1336 | </member> | ||
1337 | <member name="M:HttpServer.Helpers.ObjectForm.Select(System.String,System.String,System.String,System.Object[])"> | ||
1338 | <summary> | ||
1339 | Write a html select tag | ||
1340 | </summary> | ||
1341 | <param name="propertyName">object property.</param> | ||
1342 | <param name="idColumn">id column</param> | ||
1343 | <param name="titleColumn">The title column.</param> | ||
1344 | <param name="options">The options.</param> | ||
1345 | <returns></returns> | ||
1346 | </member> | ||
1347 | <member name="M:HttpServer.Helpers.ObjectForm.Select(System.String,System.Collections.IEnumerable,System.String,System.String,System.Object[])"> | ||
1348 | <summary> | ||
1349 | Selects the specified property name. | ||
1350 | </summary> | ||
1351 | <param name="propertyName">Name of the property.</param> | ||
1352 | <param name="items">The items.</param> | ||
1353 | <param name="idColumn">The id column.</param> | ||
1354 | <param name="titleColumn">The title column.</param> | ||
1355 | <param name="options">The options.</param> | ||
1356 | <returns></returns> | ||
1357 | </member> | ||
1358 | <member name="M:HttpServer.Helpers.ObjectForm.Submit(System.String)"> | ||
1359 | <summary> | ||
1360 | Write a submit tag. | ||
1361 | </summary> | ||
1362 | <param name="value">button caption</param> | ||
1363 | <returns>html submit tag</returns> | ||
1364 | </member> | ||
1365 | <member name="M:HttpServer.Helpers.ObjectForm.End"> | ||
1366 | <summary> | ||
1367 | html end form tag | ||
1368 | </summary> | ||
1369 | <returns>html</returns> | ||
1370 | </member> | ||
1371 | <member name="T:HttpServer.Helpers.ResourceInfo"> | ||
1372 | <summary> | ||
1373 | Container to bind resource names to assemblies | ||
1374 | </summary> | ||
1375 | </member> | ||
1376 | <member name="M:HttpServer.Helpers.ResourceInfo.#ctor(System.String,System.String,System.Reflection.Assembly)"> | ||
1377 | <summary> | ||
1378 | Instantiates an instance of <see cref="T:HttpServer.Helpers.ResourceInfo"/> | ||
1379 | </summary> | ||
1380 | <param name="uri">The dot seperated uri the resource maps to</param> | ||
1381 | <param name="resourceName">The full resource name</param> | ||
1382 | <param name="assembly">The assembly the resource exists in</param> | ||
1383 | </member> | ||
1384 | <member name="P:HttpServer.Helpers.ResourceInfo.Assembly"> | ||
1385 | <summary> | ||
1386 | Retrieves the assembly the resource resides in | ||
1387 | </summary> | ||
1388 | </member> | ||
1389 | <member name="P:HttpServer.Helpers.ResourceInfo.Uri"> | ||
1390 | <summary> | ||
1391 | Retrieves the full name/path of the assembly | ||
1392 | </summary> | ||
1393 | </member> | ||
1394 | <member name="P:HttpServer.Helpers.ResourceInfo.Extension"> | ||
1395 | <summary> | ||
1396 | Retrieves the extension of the resource | ||
1397 | </summary> | ||
1398 | </member> | ||
1399 | <member name="P:HttpServer.Helpers.ResourceInfo.ExtensionLessUri"> | ||
1400 | <summary>Returns the Uri without extension</summary> | ||
1401 | </member> | ||
1402 | <member name="P:HttpServer.Helpers.ResourceInfo.ResourceName"> | ||
1403 | <summary>Retrieves the full path name to the resource file</summary> | ||
1404 | </member> | ||
1405 | <member name="M:HttpServer.Helpers.ResourceInfo.GetStream"> | ||
1406 | <summary> | ||
1407 | Retrieves a stream to the resource | ||
1408 | </summary> | ||
1409 | <returns>Null if the resource couldn't be located somehow</returns> | ||
1410 | </member> | ||
1411 | <member name="T:HttpServer.Helpers.ResourceManager"> | ||
1412 | <summary>Class to handle loading of resource files</summary> | ||
1413 | </member> | ||
1414 | <member name="M:HttpServer.Helpers.ResourceManager.#ctor"> | ||
1415 | <summary> | ||
1416 | Initializes a new instance of the <see cref="T:HttpServer.Helpers.ResourceManager"/> class. | ||
1417 | </summary> | ||
1418 | </member> | ||
1419 | <member name="M:HttpServer.Helpers.ResourceManager.#ctor(HttpServer.ILogWriter)"> | ||
1420 | <summary> | ||
1421 | Initializes a new instance of the <see cref="T:HttpServer.Helpers.ResourceManager"/> class. | ||
1422 | </summary> | ||
1423 | <param name="writer">logger.</param> | ||
1424 | </member> | ||
1425 | <member name="M:HttpServer.Helpers.ResourceManager.LoadResources(System.String,System.Reflection.Assembly,System.String)"> | ||
1426 | <summary> | ||
1427 | Loads resources from a namespace in the given assembly to an URI | ||
1428 | </summary> | ||
1429 | <param name="toUri">The URI to map the resources to</param> | ||
1430 | <param name="fromAssembly">The assembly in which the resources reside</param> | ||
1431 | <param name="fromNamespace">The namespace from which to load the resources</param> | ||
1432 | <usage> | ||
1433 | <code> | ||
1434 | resourceLoader.LoadResources("/user/", typeof(User).Assembly, "MyLib.Models.User.Views"); | ||
1435 | </code> | ||
1436 | Will make the resource MyLib.Models.User.Views.list.Haml accessible via /user/list.haml or /user/list/ | ||
1437 | </usage> | ||
1438 | <returns>The amount of loaded files, giving you the possibility of making sure the resources needed gets loaded</returns> | ||
1439 | <exception cref="T:System.InvalidOperationException">If a resource has already been mapped to an uri</exception> | ||
1440 | </member> | ||
1441 | <member name="M:HttpServer.Helpers.ResourceManager.GetResourceStream(System.String)"> | ||
1442 | <summary> | ||
1443 | Retrieves a stream for the specified resource path if loaded otherwise null | ||
1444 | </summary> | ||
1445 | <param name="path">Path to the resource to retrieve a stream for</param> | ||
1446 | <returns>A stream or null if the resource couldn't be found</returns> | ||
1447 | </member> | ||
1448 | <member name="M:HttpServer.Helpers.ResourceManager.GetFiles(System.String)"> | ||
1449 | <summary> | ||
1450 | Fetch all files from the resource that matches the specified arguments. | ||
1451 | </summary> | ||
1452 | <param name="path">The path to the resource to extract</param> | ||
1453 | <returns> | ||
1454 | a list of files if found; or an empty array if no files are found. | ||
1455 | </returns> | ||
1456 | <exception cref="T:System.ArgumentException">Search path must end with an asterisk for finding arbitrary files</exception> | ||
1457 | </member> | ||
1458 | <member name="M:HttpServer.Helpers.ResourceManager.GetFiles(System.String,System.String)"> | ||
1459 | <summary> | ||
1460 | Fetch all files from the resource that matches the specified arguments. | ||
1461 | </summary> | ||
1462 | <param name="path">Where the file should reside.</param> | ||
1463 | <param name="filename">Files to check</param> | ||
1464 | <returns> | ||
1465 | a list of files if found; or an empty array if no files are found. | ||
1466 | </returns> | ||
1467 | </member> | ||
1468 | <member name="M:HttpServer.Helpers.ResourceManager.ContainsResource(System.String)"> | ||
1469 | <summary> | ||
1470 | Returns whether or not the loader has an instance of the file requested | ||
1471 | </summary> | ||
1472 | <param name="filename">The name of the template/file</param> | ||
1473 | <returns>True if the loader can provide the file</returns> | ||
1474 | </member> | ||
1475 | <member name="T:HttpServer.Helpers.WebHelper"> | ||
1476 | <summary> | ||
1477 | Webhelper provides helpers for common tasks in HTML. | ||
1478 | </summary> | ||
1479 | </member> | ||
1480 | <member name="F:HttpServer.Helpers.WebHelper.JSImplementation"> | ||
1481 | <summary> | ||
1482 | Used to let the website use different javascript libraries. | ||
1483 | Default is <see cref="T:HttpServer.Helpers.Implementations.PrototypeImp"/> | ||
1484 | </summary> | ||
1485 | </member> | ||
1486 | <member name="M:HttpServer.Helpers.WebHelper.AjaxRequest(System.String,System.String,System.String[])"> | ||
1487 | <summary> | ||
1488 | Creates a link that invokes through ajax. | ||
1489 | </summary> | ||
1490 | <param name="url">url to fetch</param> | ||
1491 | <param name="title">link title</param> | ||
1492 | <param name="options"> | ||
1493 | optional options in format "key, value, key, value". | ||
1494 | Javascript options starts with ':'. | ||
1495 | </param> | ||
1496 | <returns>a link tag</returns> | ||
1497 | <example> | ||
1498 | WebHelper.AjaxRequest("/users/add/", "Add user", "method:", "post", "onclick", "validate('this');"); | ||
1499 | </example> | ||
1500 | </member> | ||
1501 | <member name="M:HttpServer.Helpers.WebHelper.AjaxUpdater(System.String,System.String,System.String,System.String[])"> | ||
1502 | <summary> | ||
1503 | Builds a link that updates an element with the fetched ajax content. | ||
1504 | </summary> | ||
1505 | <param name="url">Url to fetch content from</param> | ||
1506 | <param name="title">link title</param> | ||
1507 | <param name="targetId">html element to update with the results of the ajax request.</param> | ||
1508 | <param name="options">optional options in format "key, value, key, value"</param> | ||
1509 | <returns>A link tag.</returns> | ||
1510 | </member> | ||
1511 | <member name="M:HttpServer.Helpers.WebHelper.DialogLink(System.String,System.String,System.String[])"> | ||
1512 | <summary> | ||
1513 | A link that pop ups a Dialog (overlay div) | ||
1514 | </summary> | ||
1515 | <param name="url">url to contents of dialog</param> | ||
1516 | <param name="title">link title</param> | ||
1517 | <param name="htmlAttributes">name/value of html attributes.</param> | ||
1518 | <returns>A "a"-tag that popups a dialog when clicked</returns> | ||
1519 | <example> | ||
1520 | WebHelper.DialogLink("/user/show/1", "show user", "onmouseover", "alert('booh!');"); | ||
1521 | </example> | ||
1522 | </member> | ||
1523 | <member name="M:HttpServer.Helpers.WebHelper.CreateDialog(System.String,System.String,System.String[])"> | ||
1524 | <summary> | ||
1525 | Create/Open a dialog box using ajax | ||
1526 | </summary> | ||
1527 | <param name="url"></param> | ||
1528 | <param name="title"></param> | ||
1529 | <param name="parameters"></param> | ||
1530 | <returns></returns> | ||
1531 | </member> | ||
1532 | <member name="M:HttpServer.Helpers.WebHelper.CloseDialog"> | ||
1533 | <summary> | ||
1534 | Close a javascript dialog window/div. | ||
1535 | </summary> | ||
1536 | <returns>javascript for closing a dialog.</returns> | ||
1537 | <see cref="M:HttpServer.Helpers.WebHelper.DialogLink(System.String,System.String,System.String[])"/> | ||
1538 | </member> | ||
1539 | <member name="M:HttpServer.Helpers.WebHelper.FormStart(System.String,System.String,System.Boolean)"> | ||
1540 | <summary> | ||
1541 | Create a <form> tag. | ||
1542 | </summary> | ||
1543 | <param name="name">name of form</param> | ||
1544 | <param name="action">action to invoke on submit</param> | ||
1545 | <param name="isAjax">form should be posted as ajax</param> | ||
1546 | <returns>html code</returns> | ||
1547 | <example> | ||
1548 | WebHelper.FormStart("frmLogin", "/user/login", Request.IsAjax); | ||
1549 | </example> | ||
1550 | </member> | ||
1551 | <member name="M:HttpServer.Helpers.WebHelper.Link(System.String,System.String,System.String[])"> | ||
1552 | <summary> | ||
1553 | Create a link tag. | ||
1554 | </summary> | ||
1555 | <param name="url">url to go to</param> | ||
1556 | <param name="title">link title (text that is displayed)</param> | ||
1557 | <param name="htmlAttributes">html attributes, name, value, name, value</param> | ||
1558 | <returns>html code</returns> | ||
1559 | <example> | ||
1560 | WebHelper.Link("/user/show/1", "Show user", "id", "showUser", "onclick", "return confirm('Are you shure?');"); | ||
1561 | </example> | ||
1562 | </member> | ||
1563 | <member name="M:HttpServer.Helpers.WebHelper.BuildLink(System.String,System.String,System.String[])"> | ||
1564 | <summary> | ||
1565 | Build a link | ||
1566 | </summary> | ||
1567 | <param name="url">url to go to.</param> | ||
1568 | <param name="title">title of link (displayed text)</param> | ||
1569 | <param name="htmlAttributes">extra html attributes.</param> | ||
1570 | <returns>a complete link</returns> | ||
1571 | </member> | ||
1572 | <member name="M:HttpServer.Helpers.WebHelper.BuildLink(System.String,System.String,System.String[],System.String[])"> | ||
1573 | <summary> | ||
1574 | Build a link | ||
1575 | </summary> | ||
1576 | <param name="url">url to go to.</param> | ||
1577 | <param name="title">title of link (displayed text)</param> | ||
1578 | <param name="htmlAttributes">extra html attributes.</param> | ||
1579 | <returns>a complete link</returns> | ||
1580 | <param name="options">more options</param> | ||
1581 | </member> | ||
1582 | <member name="M:HttpServer.Helpers.WebHelper.Select(System.String,System.Collections.ICollection,HttpServer.Helpers.GetIdTitle,System.Object,System.Boolean)"> | ||
1583 | <summary> | ||
1584 | Obsolete | ||
1585 | </summary> | ||
1586 | <param name="name">Obsolete</param> | ||
1587 | <param name="collection">Obsolete</param> | ||
1588 | <param name="getIdTitle">Obsolete</param> | ||
1589 | <param name="selectedValue">Obsolete</param> | ||
1590 | <param name="firstEmpty">Obsolete</param> | ||
1591 | <returns>Obsolete</returns> | ||
1592 | </member> | ||
1593 | <member name="M:HttpServer.Helpers.WebHelper.Select(System.String,System.String,System.Collections.ICollection,HttpServer.Helpers.GetIdTitle,System.Object,System.Boolean)"> | ||
1594 | <summary> | ||
1595 | Obsolete | ||
1596 | </summary> | ||
1597 | <param name="name">Obsolete</param> | ||
1598 | <param name="id">Obsolete</param> | ||
1599 | <param name="collection">Obsolete</param> | ||
1600 | <param name="getIdTitle">Obsolete</param> | ||
1601 | <param name="selectedValue">Obsolete</param> | ||
1602 | <param name="firstEmpty">Obsolete</param> | ||
1603 | <returns>Obsolete</returns> | ||
1604 | </member> | ||
1605 | <member name="M:HttpServer.Helpers.WebHelper.List(System.Collections.Generic.IEnumerable{System.Object},System.String)"> | ||
1606 | <summary> | ||
1607 | Render errors into a UL with class "errors" | ||
1608 | </summary> | ||
1609 | <param name="className">class used by UL-tag.</param> | ||
1610 | <param name="theList">items to list</param> | ||
1611 | <returns>an unordered html list.</returns> | ||
1612 | </member> | ||
1613 | <member name="M:HttpServer.Helpers.WebHelper.List(System.Collections.Specialized.NameValueCollection,System.String)"> | ||
1614 | <summary> | ||
1615 | Render errors into a UL with class "errors" | ||
1616 | </summary> | ||
1617 | <param name="className">class used by UL-tag.</param> | ||
1618 | <param name="theList">items to list</param> | ||
1619 | <returns>an unordered html list.</returns> | ||
1620 | </member> | ||
1621 | <member name="M:HttpServer.Helpers.WebHelper.Errors(System.Collections.Specialized.NameValueCollection)"> | ||
1622 | <summary> | ||
1623 | Render errors into a UL with class "errors" | ||
1624 | </summary> | ||
1625 | <param name="errors"></param> | ||
1626 | <returns></returns> | ||
1627 | </member> | ||
1628 | <member name="M:HttpServer.Helpers.WebHelper.GenerateHtmlAttributes(System.Text.StringBuilder,System.String[],System.String[])"> | ||
1629 | <summary> | ||
1630 | Generates a list with html attributes. | ||
1631 | </summary> | ||
1632 | <param name="sb">StringBuilder that the options should be added to.</param> | ||
1633 | <param name="firstOptions">attributes set by user.</param> | ||
1634 | <param name="secondOptions">attributes set by any of the helper classes.</param> | ||
1635 | </member> | ||
1636 | <member name="M:HttpServer.Helpers.WebHelper.GenerateHtmlAttributes(System.Text.StringBuilder,System.String[])"> | ||
1637 | <summary> | ||
1638 | Generates a list with html attributes. | ||
1639 | </summary> | ||
1640 | <param name="sb">StringBuilder that the options should be added to.</param> | ||
1641 | <param name="options"></param> | ||
1642 | </member> | ||
1643 | <member name="T:HttpServer.Helpers.JavascriptHelperImplementation"> | ||
1644 | <summary> | ||
1645 | Purpose of this class is to create a javascript toolkit independent javascript helper. | ||
1646 | </summary> | ||
1647 | </member> | ||
1648 | <member name="M:HttpServer.Helpers.JavascriptHelperImplementation.GenerateOptions(System.Text.StringBuilder,System.String[],System.Boolean)"> | ||
1649 | <summary> | ||
1650 | Generates a list with JS options. | ||
1651 | </summary> | ||
1652 | <param name="sb">StringBuilder that the options should be added to.</param> | ||
1653 | <param name="options">the javascript options. name, value pairs. each string value should be escaped by YOU!</param> | ||
1654 | <param name="startWithComma">true if we should start with a comma.</param> | ||
1655 | </member> | ||
1656 | <member name="M:HttpServer.Helpers.JavascriptHelperImplementation.RemoveJavascriptOptions(System.String[])"> | ||
1657 | <summary> | ||
1658 | Removes any javascript parameters from an array of parameters | ||
1659 | </summary> | ||
1660 | <param name="options">The array of parameters to remove javascript params from</param> | ||
1661 | <returns>An array of html parameters</returns> | ||
1662 | </member> | ||
1663 | <member name="M:HttpServer.Helpers.JavascriptHelperImplementation.AjaxFormOnSubmit(System.String[])"> | ||
1664 | <summary> | ||
1665 | javascript action that should be added to the "onsubmit" event in the form tag. | ||
1666 | </summary> | ||
1667 | <returns></returns> | ||
1668 | <remarks>All javascript option names should end with colon.</remarks> | ||
1669 | <example> | ||
1670 | <code> | ||
1671 | JSHelper.AjaxRequest("/user/show/1", "onsuccess:", "$('userInfo').update(result);"); | ||
1672 | </code> | ||
1673 | </example> | ||
1674 | </member> | ||
1675 | <member name="M:HttpServer.Helpers.JavascriptHelperImplementation.AjaxRequest(System.String,System.String[])"> | ||
1676 | <summary> | ||
1677 | Requests a url through ajax | ||
1678 | </summary> | ||
1679 | <param name="url">url to fetch</param> | ||
1680 | <param name="options">optional options in format "key, value, key, value", used in JS request object.</param> | ||
1681 | <returns>a link tag</returns> | ||
1682 | <remarks>All javascript option names should end with colon.</remarks> | ||
1683 | <example> | ||
1684 | <code> | ||
1685 | JSHelper.AjaxRequest("/user/show/1", "onsuccess:", "$('userInfo').update(result);"); | ||
1686 | </code> | ||
1687 | </example> | ||
1688 | </member> | ||
1689 | <member name="M:HttpServer.Helpers.JavascriptHelperImplementation.AjaxUpdater(System.String,System.String,System.String[])"> | ||
1690 | <summary> | ||
1691 | Ajax requests that updates an element with | ||
1692 | the fetched content | ||
1693 | </summary> | ||
1694 | <param name="url">Url to fetch content from</param> | ||
1695 | <param name="targetId">element to update</param> | ||
1696 | <param name="options">optional options in format "key, value, key, value", used in JS updater object.</param> | ||
1697 | <returns>A link tag.</returns> | ||
1698 | <remarks>All javascript option names should end with colon.</remarks> | ||
1699 | <example> | ||
1700 | <code> | ||
1701 | JSHelper.AjaxUpdater("/user/show/1", "userInfo", "onsuccess:", "alert('Successful!');"); | ||
1702 | </code> | ||
1703 | </example> | ||
1704 | </member> | ||
1705 | <member name="M:HttpServer.Helpers.JavascriptHelperImplementation.DialogLink(System.String,System.String,System.String[])"> | ||
1706 | <summary> | ||
1707 | A link that pop ups a Dialog (overlay div) | ||
1708 | </summary> | ||
1709 | <param name="url">url to contents of dialog</param> | ||
1710 | <param name="title">link title</param> | ||
1711 | <returns>A "a"-tag that popups a dialog when clicked</returns> | ||
1712 | <param name="htmlAttributes">name/value of html attributes</param> | ||
1713 | <example> | ||
1714 | WebHelper.DialogLink("/user/show/1", "show user", "onmouseover", "alert('booh!');"); | ||
1715 | </example> | ||
1716 | </member> | ||
1717 | <member name="M:HttpServer.Helpers.JavascriptHelperImplementation.CloseDialog"> | ||
1718 | <summary> | ||
1719 | Close a javascript dialog window/div. | ||
1720 | </summary> | ||
1721 | <returns>javascript for closing a dialog.</returns> | ||
1722 | <see cref="M:HttpServer.Helpers.JavascriptHelperImplementation.DialogLink(System.String,System.String,System.String[])"/> | ||
1723 | </member> | ||
1724 | <member name="M:HttpServer.Helpers.JavascriptHelperImplementation.CreateDialog(System.String,System.String,System.String[])"> | ||
1725 | <summary> | ||
1726 | Creates a new modal dialog window | ||
1727 | </summary> | ||
1728 | <param name="url">url to open in window.</param> | ||
1729 | <param name="title">window title (may not be supported by all js implementations)</param> | ||
1730 | <param name="options"></param> | ||
1731 | <returns></returns> | ||
1732 | </member> | ||
1733 | <member name="T:HttpServer.Helpers.XmlHelper"> | ||
1734 | <summary> | ||
1735 | Helpers to make XML handling easier | ||
1736 | </summary> | ||
1737 | </member> | ||
1738 | <member name="M:HttpServer.Helpers.XmlHelper.Serialize(System.Object)"> | ||
1739 | <summary> | ||
1740 | Serializes object to XML. | ||
1741 | </summary> | ||
1742 | <param name="value">object to serialize.</param> | ||
1743 | <returns>XML</returns> | ||
1744 | <remarks> | ||
1745 | Removes name spaces and adds indentation | ||
1746 | </remarks> | ||
1747 | </member> | ||
1748 | <member name="M:HttpServer.Helpers.XmlHelper.Deserialize``1(System.String)"> | ||
1749 | <summary> | ||
1750 | Create an object from a XML string | ||
1751 | </summary> | ||
1752 | <typeparam name="T">Type of object</typeparam> | ||
1753 | <param name="xml">XML string</param> | ||
1754 | <returns>object</returns> | ||
1755 | </member> | ||
1756 | <member name="T:HttpServer.HttpClientContext"> | ||
1757 | <summary> | ||
1758 | Contains a connection to a browser/client. | ||
1759 | </summary> | ||
1760 | <remarks> | ||
1761 | Remember to <see cref="M:HttpServer.HttpClientContext.Start"/> after you have hooked the <see cref="E:HttpServer.HttpClientContext.RequestReceived"/> event. | ||
1762 | </remarks> | ||
1763 | TODO: Maybe this class should be broken up into HttpClientChannel and HttpClientContext? | ||
1764 | </member> | ||
1765 | <member name="E:HttpServer.HttpClientContext.Cleaned"> | ||
1766 | <summary> | ||
1767 | This context have been cleaned, which means that it can be reused. | ||
1768 | </summary> | ||
1769 | </member> | ||
1770 | <member name="E:HttpServer.HttpClientContext.Started"> | ||
1771 | <summary> | ||
1772 | Context have been started (a new client have connected) | ||
1773 | </summary> | ||
1774 | </member> | ||
1775 | <member name="M:HttpServer.HttpClientContext.#ctor(System.Boolean,System.Net.IPEndPoint,System.IO.Stream,HttpServer.IRequestParserFactory,System.Int32,System.Net.Sockets.Socket)"> | ||
1776 | <summary> | ||
1777 | Initializes a new instance of the <see cref="T:HttpServer.HttpClientContext"/> class. | ||
1778 | </summary> | ||
1779 | <param name="secured">true if the connection is secured (SSL/TLS)</param> | ||
1780 | <param name="remoteEndPoint">client that connected.</param> | ||
1781 | <param name="stream">Stream used for communication</param> | ||
1782 | <param name="parserFactory">Used to create a <see cref="T:HttpServer.IHttpRequestParser"/>.</param> | ||
1783 | <param name="bufferSize">Size of buffer to use when reading data. Must be at least 4096 bytes.</param> | ||
1784 | <exception cref="T:System.Net.Sockets.SocketException">If <see cref="M:System.Net.Sockets.Socket.BeginReceive(System.Byte[],System.Int32,System.Int32,System.Net.Sockets.SocketFlags,System.AsyncCallback,System.Object)"/> fails</exception> | ||
1785 | <exception cref="T:System.ArgumentException">Stream must be writable and readable.</exception> | ||
1786 | </member> | ||
1787 | <member name="M:HttpServer.HttpClientContext.OnBodyBytesReceived(System.Object,HttpServer.Parser.BodyEventArgs)"> | ||
1788 | <summary> | ||
1789 | Process incoming body bytes. | ||
1790 | </summary> | ||
1791 | <param name="sender"><see cref="T:HttpServer.IHttpRequestParser"/></param> | ||
1792 | <param name="e">Bytes</param> | ||
1793 | </member> | ||
1794 | <member name="M:HttpServer.HttpClientContext.OnHeaderReceived(System.Object,HttpServer.Parser.HeaderEventArgs)"> | ||
1795 | <summary> | ||
1796 | |||
1797 | </summary> | ||
1798 | <param name="sender"></param> | ||
1799 | <param name="e"></param> | ||
1800 | </member> | ||
1801 | <member name="P:HttpServer.HttpClientContext.CurrentRequest"> | ||
1802 | <summary> | ||
1803 | Overload to specify own type. | ||
1804 | </summary> | ||
1805 | <remarks> | ||
1806 | Must be specified before the context is being used. | ||
1807 | </remarks> | ||
1808 | </member> | ||
1809 | <member name="M:HttpServer.HttpClientContext.Start"> | ||
1810 | <summary> | ||
1811 | Start reading content. | ||
1812 | </summary> | ||
1813 | <remarks> | ||
1814 | Make sure to call base.Start() if you override this method. | ||
1815 | </remarks> | ||
1816 | </member> | ||
1817 | <member name="M:HttpServer.HttpClientContext.Cleanup"> | ||
1818 | <summary> | ||
1819 | Clean up context. | ||
1820 | </summary> | ||
1821 | <remarks> | ||
1822 | Make sure to call base.Cleanup() if you override the method. | ||
1823 | </remarks> | ||
1824 | </member> | ||
1825 | <member name="P:HttpServer.HttpClientContext.Secured"> | ||
1826 | <summary> | ||
1827 | Using SSL or other encryption method. | ||
1828 | </summary> | ||
1829 | </member> | ||
1830 | <member name="P:HttpServer.HttpClientContext.IsSecured"> | ||
1831 | <summary> | ||
1832 | Using SSL or other encryption method. | ||
1833 | </summary> | ||
1834 | </member> | ||
1835 | <member name="P:HttpServer.HttpClientContext.LogWriter"> | ||
1836 | <summary> | ||
1837 | Specify which logger to use. | ||
1838 | </summary> | ||
1839 | </member> | ||
1840 | <member name="P:HttpServer.HttpClientContext.Stream"> | ||
1841 | <summary> | ||
1842 | Gets or sets the network stream. | ||
1843 | </summary> | ||
1844 | </member> | ||
1845 | <member name="P:HttpServer.HttpClientContext.RemoteAddress"> | ||
1846 | <summary> | ||
1847 | Gets or sets IP address that the client connected from. | ||
1848 | </summary> | ||
1849 | </member> | ||
1850 | <member name="P:HttpServer.HttpClientContext.RemotePort"> | ||
1851 | <summary> | ||
1852 | Gets or sets port that the client connected from. | ||
1853 | </summary> | ||
1854 | </member> | ||
1855 | <member name="M:HttpServer.HttpClientContext.Disconnect(System.Net.Sockets.SocketError)"> | ||
1856 | <summary> | ||
1857 | Disconnect from client | ||
1858 | </summary> | ||
1859 | <param name="error">error to report in the <see cref="E:HttpServer.HttpClientContext.Disconnected"/> event.</param> | ||
1860 | </member> | ||
1861 | <member name="M:HttpServer.HttpClientContext.Respond(System.String,System.Net.HttpStatusCode,System.String,System.String,System.String)"> | ||
1862 | <summary> | ||
1863 | Send a response. | ||
1864 | </summary> | ||
1865 | <param name="httpVersion">Either <see cref="F:HttpServer.HttpHelper.HTTP10"/> or <see cref="F:HttpServer.HttpHelper.HTTP11"/></param> | ||
1866 | <param name="statusCode">HTTP status code</param> | ||
1867 | <param name="reason">reason for the status code.</param> | ||
1868 | <param name="body">HTML body contents, can be null or empty.</param> | ||
1869 | <param name="contentType">A content type to return the body as, i.e. 'text/html' or 'text/plain', defaults to 'text/html' if null or empty</param> | ||
1870 | <exception cref="T:System.ArgumentException">If <paramref name="httpVersion"/> is invalid.</exception> | ||
1871 | </member> | ||
1872 | <member name="M:HttpServer.HttpClientContext.Respond(System.String,System.Net.HttpStatusCode,System.String)"> | ||
1873 | <summary> | ||
1874 | Send a response. | ||
1875 | </summary> | ||
1876 | <param name="httpVersion">Either <see cref="F:HttpServer.HttpHelper.HTTP10"/> or <see cref="F:HttpServer.HttpHelper.HTTP11"/></param> | ||
1877 | <param name="statusCode">HTTP status code</param> | ||
1878 | <param name="reason">reason for the status code.</param> | ||
1879 | </member> | ||
1880 | <member name="M:HttpServer.HttpClientContext.Respond(System.String)"> | ||
1881 | <summary> | ||
1882 | Send a response. | ||
1883 | </summary> | ||
1884 | <exception cref="T:System.ArgumentNullException"></exception> | ||
1885 | </member> | ||
1886 | <member name="M:HttpServer.HttpClientContext.Send(System.Byte[])"> | ||
1887 | <summary> | ||
1888 | send a whole buffer | ||
1889 | </summary> | ||
1890 | <param name="buffer">buffer to send</param> | ||
1891 | <exception cref="T:System.ArgumentNullException"></exception> | ||
1892 | </member> | ||
1893 | <member name="M:HttpServer.HttpClientContext.Send(System.Byte[],System.Int32,System.Int32)"> | ||
1894 | <summary> | ||
1895 | Send data using the stream | ||
1896 | </summary> | ||
1897 | <param name="buffer">Contains data to send</param> | ||
1898 | <param name="offset">Start position in buffer</param> | ||
1899 | <param name="size">number of bytes to send</param> | ||
1900 | <exception cref="T:System.ArgumentNullException"></exception> | ||
1901 | <exception cref="T:System.ArgumentOutOfRangeException"></exception> | ||
1902 | </member> | ||
1903 | <member name="E:HttpServer.HttpClientContext.Disconnected"> | ||
1904 | <summary> | ||
1905 | The context have been disconnected. | ||
1906 | </summary> | ||
1907 | <remarks> | ||
1908 | Event can be used to clean up a context, or to reuse it. | ||
1909 | </remarks> | ||
1910 | </member> | ||
1911 | <member name="E:HttpServer.HttpClientContext.RequestReceived"> | ||
1912 | <summary> | ||
1913 | A request have been received in the context. | ||
1914 | </summary> | ||
1915 | </member> | ||
1916 | <member name="T:HttpServer.HttpContextFactory"> | ||
1917 | <summary> | ||
1918 | Used to create and reuse contexts. | ||
1919 | </summary> | ||
1920 | </member> | ||
1921 | <member name="M:HttpServer.HttpContextFactory.#ctor(HttpServer.ILogWriter,System.Int32,HttpServer.IRequestParserFactory)"> | ||
1922 | <summary> | ||
1923 | Initializes a new instance of the <see cref="T:HttpServer.HttpContextFactory"/> class. | ||
1924 | </summary> | ||
1925 | <param name="writer">The writer.</param> | ||
1926 | <param name="bufferSize">Amount of bytes to read from the incoming socket stream.</param> | ||
1927 | <param name="factory">Used to create a request parser.</param> | ||
1928 | </member> | ||
1929 | <member name="P:HttpServer.HttpContextFactory.UseTraceLogs"> | ||
1930 | <summary> | ||
1931 | True if detailed trace logs should be written. | ||
1932 | </summary> | ||
1933 | </member> | ||
1934 | <member name="M:HttpServer.HttpContextFactory.CreateContext(System.Boolean,System.Net.IPEndPoint,System.IO.Stream,System.Net.Sockets.Socket)"> | ||
1935 | <summary> | ||
1936 | Create a new context. | ||
1937 | </summary> | ||
1938 | <param name="isSecured">true if socket is running HTTPS.</param> | ||
1939 | <param name="endPoint">Client that connected</param> | ||
1940 | <param name="stream">Network/SSL stream.</param> | ||
1941 | <returns>A context.</returns> | ||
1942 | </member> | ||
1943 | <member name="M:HttpServer.HttpContextFactory.CreateNewContext(System.Boolean,System.Net.IPEndPoint,System.IO.Stream,System.Net.Sockets.Socket)"> | ||
1944 | <summary> | ||
1945 | Create a new context. | ||
1946 | </summary> | ||
1947 | <param name="isSecured">true if HTTPS is used.</param> | ||
1948 | <param name="endPoint">Remote client</param> | ||
1949 | <param name="stream">Network stream, <see cref="T:HttpServer.HttpClientContext"/> uses <see cref="T:HttpServer.ReusableSocketNetworkStream"/>.</param> | ||
1950 | <returns>A new context (always).</returns> | ||
1951 | </member> | ||
1952 | <member name="M:HttpServer.HttpContextFactory.CreateSecureContext(System.Net.Sockets.Socket,System.Security.Cryptography.X509Certificates.X509Certificate,System.Security.Authentication.SslProtocols)"> | ||
1953 | <summary> | ||
1954 | Create a secure <see cref="T:HttpServer.IHttpClientContext"/>. | ||
1955 | </summary> | ||
1956 | <param name="socket">Client socket (accepted by the <see cref="T:HttpServer.HttpListener"/>).</param> | ||
1957 | <param name="certificate">HTTPS certificate to use.</param> | ||
1958 | <param name="protocol">Kind of HTTPS protocol. Usually TLS or SSL.</param> | ||
1959 | <returns> | ||
1960 | A created <see cref="T:HttpServer.IHttpClientContext"/>. | ||
1961 | </returns> | ||
1962 | </member> | ||
1963 | <member name="E:HttpServer.HttpContextFactory.RequestReceived"> | ||
1964 | <summary> | ||
1965 | A request have been received from one of the contexts. | ||
1966 | </summary> | ||
1967 | </member> | ||
1968 | <member name="M:HttpServer.HttpContextFactory.CreateContext(System.Net.Sockets.Socket)"> | ||
1969 | <summary> | ||
1970 | Creates a <see cref="T:HttpServer.IHttpClientContext"/> that handles a connected client. | ||
1971 | </summary> | ||
1972 | <param name="socket">Client socket (accepted by the <see cref="T:HttpServer.HttpListener"/>).</param> | ||
1973 | <returns> | ||
1974 | A creates <see cref="T:HttpServer.IHttpClientContext"/>. | ||
1975 | </returns> | ||
1976 | </member> | ||
1977 | <member name="M:HttpServer.HttpContextFactory.Shutdown"> | ||
1978 | <summary> | ||
1979 | Server is shutting down so shut down the factory | ||
1980 | </summary> | ||
1981 | </member> | ||
1982 | <member name="T:HttpServer.ReusableSocketNetworkStream"> | ||
1983 | <summary> | ||
1984 | Custom network stream to mark sockets as reusable when disposing the stream. | ||
1985 | </summary> | ||
1986 | </member> | ||
1987 | <member name="M:HttpServer.ReusableSocketNetworkStream.#ctor(System.Net.Sockets.Socket)"> | ||
1988 | <summary> | ||
1989 | Creates a new instance of the <see cref="T:System.Net.Sockets.NetworkStream" /> class for the specified <see cref="T:System.Net.Sockets.Socket" />. | ||
1990 | </summary> | ||
1991 | <param name="socket"> | ||
1992 | The <see cref="T:System.Net.Sockets.Socket" /> that the <see cref="T:System.Net.Sockets.NetworkStream" /> will use to send and receive data. | ||
1993 | </param> | ||
1994 | <exception cref="T:System.ArgumentNullException"> | ||
1995 | The <paramref name="socket" /> parameter is null. | ||
1996 | </exception> | ||
1997 | <exception cref="T:System.IO.IOException"> | ||
1998 | The <paramref name="socket" /> parameter is not connected. | ||
1999 | -or- | ||
2000 | The <see cref="P:System.Net.Sockets.Socket.SocketType" /> property of the <paramref name="socket" /> parameter is not <see cref="F:System.Net.Sockets.SocketType.Stream" />. | ||
2001 | -or- | ||
2002 | The <paramref name="socket" /> parameter is in a nonblocking state. | ||
2003 | </exception> | ||
2004 | </member> | ||
2005 | <member name="M:HttpServer.ReusableSocketNetworkStream.#ctor(System.Net.Sockets.Socket,System.Boolean)"> | ||
2006 | <summary> | ||
2007 | Initializes a new instance of the <see cref="T:System.Net.Sockets.NetworkStream" /> class for the specified <see cref="T:System.Net.Sockets.Socket" /> with the specified <see cref="T:System.Net.Sockets.Socket" /> ownership. | ||
2008 | </summary> | ||
2009 | <param name="socket"> | ||
2010 | The <see cref="T:System.Net.Sockets.Socket" /> that the <see cref="T:System.Net.Sockets.NetworkStream" /> will use to send and receive data. | ||
2011 | </param> | ||
2012 | <param name="ownsSocket"> | ||
2013 | Set to true to indicate that the <see cref="T:System.Net.Sockets.NetworkStream" /> will take ownership of the <see cref="T:System.Net.Sockets.Socket" />; otherwise, false. | ||
2014 | </param> | ||
2015 | <exception cref="T:System.ArgumentNullException"> | ||
2016 | The <paramref name="socket" /> parameter is null. | ||
2017 | </exception> | ||
2018 | <exception cref="T:System.IO.IOException"> | ||
2019 | The <paramref name="socket" /> parameter is not connected. | ||
2020 | -or- | ||
2021 | the value of the <see cref="P:System.Net.Sockets.Socket.SocketType" /> property of the <paramref name="socket" /> parameter is not <see cref="F:System.Net.Sockets.SocketType.Stream" />. | ||
2022 | -or- | ||
2023 | the <paramref name="socket" /> parameter is in a nonblocking state. | ||
2024 | </exception> | ||
2025 | </member> | ||
2026 | <member name="M:HttpServer.ReusableSocketNetworkStream.#ctor(System.Net.Sockets.Socket,System.IO.FileAccess)"> | ||
2027 | <summary> | ||
2028 | Creates a new instance of the <see cref="T:System.Net.Sockets.NetworkStream" /> class for the specified <see cref="T:System.Net.Sockets.Socket" /> with the specified access rights. | ||
2029 | </summary> | ||
2030 | <param name="socket"> | ||
2031 | The <see cref="T:System.Net.Sockets.Socket" /> that the <see cref="T:System.Net.Sockets.NetworkStream" /> will use to send and receive data. | ||
2032 | </param> | ||
2033 | <param name="access"> | ||
2034 | A bitwise combination of the <see cref="T:System.IO.FileAccess" /> values that specify the type of access given to the <see cref="T:System.Net.Sockets.NetworkStream" /> over the provided <see cref="T:System.Net.Sockets.Socket" />. | ||
2035 | </param> | ||
2036 | <exception cref="T:System.ArgumentNullException"> | ||
2037 | The <paramref name="socket" /> parameter is null. | ||
2038 | </exception> | ||
2039 | <exception cref="T:System.IO.IOException"> | ||
2040 | The <paramref name="socket" /> parameter is not connected. | ||
2041 | -or- | ||
2042 | the <see cref="P:System.Net.Sockets.Socket.SocketType" /> property of the <paramref name="socket" /> parameter is not <see cref="F:System.Net.Sockets.SocketType.Stream" />. | ||
2043 | -or- | ||
2044 | the <paramref name="socket" /> parameter is in a nonblocking state. | ||
2045 | </exception> | ||
2046 | </member> | ||
2047 | <member name="M:HttpServer.ReusableSocketNetworkStream.#ctor(System.Net.Sockets.Socket,System.IO.FileAccess,System.Boolean)"> | ||
2048 | <summary> | ||
2049 | Creates a new instance of the <see cref="T:System.Net.Sockets.NetworkStream" /> class for the specified <see cref="T:System.Net.Sockets.Socket" /> with the specified access rights and the specified <see cref="T:System.Net.Sockets.Socket" /> ownership. | ||
2050 | </summary> | ||
2051 | <param name="socket"> | ||
2052 | The <see cref="T:System.Net.Sockets.Socket" /> that the <see cref="T:System.Net.Sockets.NetworkStream" /> will use to send and receive data. | ||
2053 | </param> | ||
2054 | <param name="access"> | ||
2055 | A bitwise combination of the <see cref="T:System.IO.FileAccess" /> values that specifies the type of access given to the <see cref="T:System.Net.Sockets.NetworkStream" /> over the provided <see cref="T:System.Net.Sockets.Socket" />. | ||
2056 | </param> | ||
2057 | <param name="ownsSocket"> | ||
2058 | Set to true to indicate that the <see cref="T:System.Net.Sockets.NetworkStream" /> will take ownership of the <see cref="T:System.Net.Sockets.Socket" />; otherwise, false. | ||
2059 | </param> | ||
2060 | <exception cref="T:System.ArgumentNullException"> | ||
2061 | The <paramref name="socket" /> parameter is null. | ||
2062 | </exception> | ||
2063 | <exception cref="T:System.IO.IOException"> | ||
2064 | The <paramref name="socket" /> parameter is not connected. | ||
2065 | -or- | ||
2066 | The <see cref="P:System.Net.Sockets.Socket.SocketType" /> property of the <paramref name="socket" /> parameter is not <see cref="F:System.Net.Sockets.SocketType.Stream" />. | ||
2067 | -or- | ||
2068 | The <paramref name="socket" /> parameter is in a nonblocking state. | ||
2069 | </exception> | ||
2070 | </member> | ||
2071 | <member name="M:HttpServer.ReusableSocketNetworkStream.Close"> | ||
2072 | <summary> | ||
2073 | Closes the current stream and releases any resources (such as sockets and file handles) associated with the current stream. | ||
2074 | </summary> | ||
2075 | </member> | ||
2076 | <member name="M:HttpServer.ReusableSocketNetworkStream.Dispose(System.Boolean)"> | ||
2077 | <summary> | ||
2078 | Releases the unmanaged resources used by the <see cref="T:System.Net.Sockets.NetworkStream"/> and optionally releases the managed resources. | ||
2079 | </summary> | ||
2080 | <param name="disposing">true to release both managed and unmanaged resources; false to release only unmanaged resources.</param> | ||
2081 | </member> | ||
2082 | <member name="T:HttpServer.IHttpContextFactory"> | ||
2083 | <summary> | ||
2084 | Used to create <see cref="T:HttpServer.IHttpClientContext"/>es. | ||
2085 | </summary> | ||
2086 | </member> | ||
2087 | <member name="M:HttpServer.IHttpContextFactory.CreateContext(System.Net.Sockets.Socket)"> | ||
2088 | <summary> | ||
2089 | Creates a <see cref="T:HttpServer.IHttpClientContext"/> that handles a connected client. | ||
2090 | </summary> | ||
2091 | <param name="socket">Client socket (accepted by the <see cref="T:HttpServer.HttpListener"/>).</param> | ||
2092 | <returns>A creates <see cref="T:HttpServer.IHttpClientContext"/>.</returns> | ||
2093 | </member> | ||
2094 | <member name="M:HttpServer.IHttpContextFactory.CreateSecureContext(System.Net.Sockets.Socket,System.Security.Cryptography.X509Certificates.X509Certificate,System.Security.Authentication.SslProtocols)"> | ||
2095 | <summary> | ||
2096 | Create a secure <see cref="T:HttpServer.IHttpClientContext"/>. | ||
2097 | </summary> | ||
2098 | <param name="socket">Client socket (accepted by the <see cref="T:HttpServer.HttpListener"/>).</param> | ||
2099 | <param name="certificate">HTTPS certificate to use.</param> | ||
2100 | <param name="protocol">Kind of HTTPS protocol. Usually TLS or SSL.</param> | ||
2101 | <returns>A created <see cref="T:HttpServer.IHttpClientContext"/>.</returns> | ||
2102 | </member> | ||
2103 | <member name="E:HttpServer.IHttpContextFactory.RequestReceived"> | ||
2104 | <summary> | ||
2105 | A request have been received from one of the contexts. | ||
2106 | </summary> | ||
2107 | </member> | ||
2108 | <member name="M:HttpServer.IHttpContextFactory.Shutdown"> | ||
2109 | <summary> | ||
2110 | Server is shutting down so shut down the factory | ||
2111 | </summary> | ||
2112 | </member> | ||
2113 | <member name="T:HttpServer.HttpFile"> | ||
2114 | <summary> | ||
2115 | Container class for posted files | ||
2116 | </summary> | ||
2117 | </member> | ||
2118 | <member name="M:HttpServer.HttpFile.#ctor(System.String,System.String,System.String,System.String)"> | ||
2119 | <summary> | ||
2120 | Creates a container for a posted file | ||
2121 | </summary> | ||
2122 | <param name="name">The identifier of the post field</param> | ||
2123 | <param name="filename">The file path</param> | ||
2124 | <param name="contentType">The content type of the file</param> | ||
2125 | <param name="uploadFilename">The name of the file uploaded</param> | ||
2126 | <exception cref="T:System.ArgumentNullException">If any parameter is null or empty</exception> | ||
2127 | </member> | ||
2128 | <member name="M:HttpServer.HttpFile.#ctor(System.String,System.String,System.String)"> | ||
2129 | <summary> | ||
2130 | Creates a container for a posted file <see cref="M:HttpServer.HttpFile.#ctor(System.String,System.String,System.String,System.String)"/> | ||
2131 | </summary> | ||
2132 | <exception cref="T:System.ArgumentNullException">If any parameter is null or empty</exception> | ||
2133 | </member> | ||
2134 | <member name="M:HttpServer.HttpFile.Finalize"> | ||
2135 | <summary>Destructor disposing the file</summary> | ||
2136 | </member> | ||
2137 | <member name="P:HttpServer.HttpFile.Name"> | ||
2138 | <summary> | ||
2139 | The name/id of the file | ||
2140 | </summary> | ||
2141 | </member> | ||
2142 | <member name="P:HttpServer.HttpFile.Filename"> | ||
2143 | <summary> | ||
2144 | The full file path | ||
2145 | </summary> | ||
2146 | </member> | ||
2147 | <member name="P:HttpServer.HttpFile.UploadFilename"> | ||
2148 | <summary> | ||
2149 | The name of the uploaded file | ||
2150 | </summary> | ||
2151 | </member> | ||
2152 | <member name="P:HttpServer.HttpFile.ContentType"> | ||
2153 | <summary> | ||
2154 | The type of file | ||
2155 | </summary> | ||
2156 | </member> | ||
2157 | <member name="M:HttpServer.HttpFile.Dispose(System.Boolean)"> | ||
2158 | <summary> | ||
2159 | Deletes the temporary file | ||
2160 | </summary> | ||
2161 | <param name="disposing">True if manual dispose</param> | ||
2162 | </member> | ||
2163 | <member name="M:HttpServer.HttpFile.Dispose"> | ||
2164 | <summary> | ||
2165 | Disposing interface, cleans up managed resources (the temporary file) and suppresses finalization | ||
2166 | </summary> | ||
2167 | </member> | ||
2168 | <member name="T:HttpServer.HttpForm"> | ||
2169 | <summary>Container for posted form data</summary> | ||
2170 | </member> | ||
2171 | <member name="F:HttpServer.HttpForm.EmptyForm"> | ||
2172 | <summary>Instance to help mark a non-initialized form</summary> | ||
2173 | </member> | ||
2174 | <member name="M:HttpServer.HttpForm.#ctor"> | ||
2175 | <summary>Initializes a form container with the specified name</summary> | ||
2176 | </member> | ||
2177 | <member name="M:HttpServer.HttpForm.#ctor(HttpServer.HttpInput)"> | ||
2178 | <summary> | ||
2179 | Makes a deep copy of the input | ||
2180 | </summary> | ||
2181 | <param name="input">The input to copy</param> | ||
2182 | </member> | ||
2183 | <member name="M:HttpServer.HttpForm.AddFile(HttpServer.HttpFile)"> | ||
2184 | <summary> | ||
2185 | Adds a file to the collection of posted files | ||
2186 | </summary> | ||
2187 | <param name="file">The file to add</param> | ||
2188 | <exception cref="T:System.ArgumentException">If the file is already added</exception> | ||
2189 | <exception cref="T:System.ArgumentNullException">If file is null</exception> | ||
2190 | <exception cref="T:System.InvalidOperationException">If the instance is HttpForm.EmptyForm which cannot be modified</exception> | ||
2191 | </member> | ||
2192 | <member name="M:HttpServer.HttpForm.ContainsFile(System.String)"> | ||
2193 | <summary> | ||
2194 | Checks if the form contains a specified file | ||
2195 | </summary> | ||
2196 | <param name="name">Field name of the file parameter</param> | ||
2197 | <returns>True if the file exists</returns> | ||
2198 | <exception cref="T:System.InvalidOperationException">If the instance is HttpForm.EmptyForm which cannot be modified</exception> | ||
2199 | </member> | ||
2200 | <member name="M:HttpServer.HttpForm.GetFile(System.String)"> | ||
2201 | <summary> | ||
2202 | Retrieves a file held by by the form | ||
2203 | </summary> | ||
2204 | <param name="name">The identifier of the file</param> | ||
2205 | <returns>The requested file or null if the file was not found</returns> | ||
2206 | <exception cref="T:System.ArgumentNullException">If name is null or empty</exception> | ||
2207 | <exception cref="T:System.InvalidOperationException">If the instance is HttpForm.EmptyForm which cannot be modified</exception> | ||
2208 | </member> | ||
2209 | <member name="P:HttpServer.HttpForm.Files"> | ||
2210 | <summary> | ||
2211 | Retrieves the number of files added to the <see cref="T:HttpServer.HttpForm"/> | ||
2212 | </summary> | ||
2213 | <returns>0 if no files are added</returns> | ||
2214 | </member> | ||
2215 | <member name="M:HttpServer.HttpForm.Clear"> | ||
2216 | <summary>Disposes all held HttpFile's and resets values</summary> | ||
2217 | </member> | ||
2218 | <member name="T:HttpServer.HttpHelper"> | ||
2219 | <summary> | ||
2220 | Generic helper functions for HTTP | ||
2221 | </summary> | ||
2222 | </member> | ||
2223 | <member name="F:HttpServer.HttpHelper.HTTP10"> | ||
2224 | <summary> | ||
2225 | Version string for HTTP v1.0 | ||
2226 | </summary> | ||
2227 | </member> | ||
2228 | <member name="F:HttpServer.HttpHelper.HTTP11"> | ||
2229 | <summary> | ||
2230 | Version string for HTTP v1.1 | ||
2231 | </summary> | ||
2232 | </member> | ||
2233 | <member name="F:HttpServer.HttpHelper.EmptyUri"> | ||
2234 | <summary> | ||
2235 | An empty URI | ||
2236 | </summary> | ||
2237 | </member> | ||
2238 | <member name="M:HttpServer.HttpHelper.ParseQueryString(System.String)"> | ||
2239 | <summary> | ||
2240 | Parses a query string. | ||
2241 | </summary> | ||
2242 | <param name="queryString">Query string (URI encoded)</param> | ||
2243 | <returns>A <see cref="T:HttpServer.HttpInput"/> object if successful; otherwise <see cref="F:HttpServer.HttpInput.Empty"/></returns> | ||
2244 | <exception cref="T:System.ArgumentNullException"><c>queryString</c> is null.</exception> | ||
2245 | <exception cref="T:System.FormatException">If string cannot be parsed.</exception> | ||
2246 | </member> | ||
2247 | <member name="T:HttpServer.HttpInput"> | ||
2248 | <summary> | ||
2249 | Contains some kind of input from the browser/client. | ||
2250 | can be QueryString, form data or any other request body content. | ||
2251 | </summary> | ||
2252 | </member> | ||
2253 | <member name="F:HttpServer.HttpInput.Empty"> | ||
2254 | <summary> Representation of a non-initialized class instance </summary> | ||
2255 | </member> | ||
2256 | <member name="F:HttpServer.HttpInput._ignoreChanges"> | ||
2257 | <summary> Variable telling the class that it is non-initialized <see cref="F:HttpServer.HttpInput.Empty"/> </summary> | ||
2258 | </member> | ||
2259 | <member name="M:HttpServer.HttpInput.#ctor(System.String)"> | ||
2260 | <summary> | ||
2261 | Initializes a new instance of the <see cref="T:HttpServer.HttpInput"/> class. | ||
2262 | </summary> | ||
2263 | <param name="name">form name.</param> | ||
2264 | </member> | ||
2265 | <member name="M:HttpServer.HttpInput.#ctor(System.String,System.Boolean)"> | ||
2266 | <summary> | ||
2267 | Initializes a new instance of the <see cref="T:HttpServer.HttpInput"/> class. | ||
2268 | </summary> | ||
2269 | <param name="name">form name.</param> | ||
2270 | <param name="ignoreChanges">if set to <c>true</c> all changes will be ignored. </param> | ||
2271 | <remarks>this constructor should only be used by Empty</remarks> | ||
2272 | </member> | ||
2273 | <member name="M:HttpServer.HttpInput.#ctor(HttpServer.HttpInput)"> | ||
2274 | <summary>Creates a deep copy of the HttpInput class</summary> | ||
2275 | <param name="input">The object to copy</param> | ||
2276 | <remarks>The function makes a deep copy of quite a lot which can be slow</remarks> | ||
2277 | </member> | ||
2278 | <member name="P:HttpServer.HttpInput.Name"> | ||
2279 | <summary> | ||
2280 | Form name as lower case | ||
2281 | </summary> | ||
2282 | </member> | ||
2283 | <member name="M:HttpServer.HttpInput.Add(System.String,System.String)"> | ||
2284 | <summary> | ||
2285 | Add a new element. Form array elements are parsed | ||
2286 | and added in a correct hierarchy. | ||
2287 | </summary> | ||
2288 | <param name="name">Name is converted to lower case.</param> | ||
2289 | <param name="value"></param> | ||
2290 | <exception cref="T:System.ArgumentNullException"><c>name</c> is null.</exception> | ||
2291 | <exception cref="T:System.InvalidOperationException">Cannot add stuff to <see cref="F:HttpServer.HttpInput.Empty"/>.</exception> | ||
2292 | </member> | ||
2293 | <member name="P:HttpServer.HttpInput.Item(System.String)"> | ||
2294 | <summary> | ||
2295 | Get a form item. | ||
2296 | </summary> | ||
2297 | <param name="name"></param> | ||
2298 | <returns>Returns <see cref="F:HttpServer.HttpInputItem.Empty"/> if item was not found.</returns> | ||
2299 | </member> | ||
2300 | <member name="M:HttpServer.HttpInput.Contains(System.String)"> | ||
2301 | <summary> | ||
2302 | Returns true if the class contains a <see cref="T:HttpServer.HttpInput"/> with the corresponding name. | ||
2303 | </summary> | ||
2304 | <param name="name">The field/query string name</param> | ||
2305 | <returns>True if the value exists</returns> | ||
2306 | </member> | ||
2307 | <member name="M:HttpServer.HttpInput.ParseItem(System.String,System.String)"> | ||
2308 | <summary> | ||
2309 | Parses an item and returns it. | ||
2310 | This function is primarily used to parse array items as in user[name]. | ||
2311 | </summary> | ||
2312 | <param name="name"></param> | ||
2313 | <param name="value"></param> | ||
2314 | <returns></returns> | ||
2315 | </member> | ||
2316 | <member name="M:HttpServer.HttpInput.ToString"> | ||
2317 | <summary> Outputs the instance representing all its values joined together </summary> | ||
2318 | <returns></returns> | ||
2319 | </member> | ||
2320 | <member name="M:HttpServer.HttpInput.ToString(System.Boolean)"> | ||
2321 | <summary>Returns all items as an unescaped query string.</summary> | ||
2322 | <returns></returns> | ||
2323 | </member> | ||
2324 | <member name="M:HttpServer.HttpInput.ExtractOne(System.String)"> | ||
2325 | <summary> | ||
2326 | Extracts one parameter from an array | ||
2327 | </summary> | ||
2328 | <param name="value">Containing the string array</param> | ||
2329 | <returns>All but the first value</returns> | ||
2330 | <example> | ||
2331 | string test1 = ExtractOne("system[user][extension][id]"); | ||
2332 | string test2 = ExtractOne(test1); | ||
2333 | string test3 = ExtractOne(test2); | ||
2334 | // test1 = user[extension][id] | ||
2335 | // test2 = extension[id] | ||
2336 | // test3 = id | ||
2337 | </example> | ||
2338 | </member> | ||
2339 | <member name="M:HttpServer.HttpInput.Clear"> | ||
2340 | <summary>Resets all data contained by class</summary> | ||
2341 | </member> | ||
2342 | <member name="M:HttpServer.HttpInput.System#Collections#Generic#IEnumerable{HttpServer#HttpInputItem}#GetEnumerator"> | ||
2343 | <summary> | ||
2344 | Returns an enumerator that iterates through the collection. | ||
2345 | </summary> | ||
2346 | |||
2347 | <returns> | ||
2348 | A <see cref="T:System.Collections.Generic.IEnumerator`1"></see> that can be used to iterate through the collection. | ||
2349 | </returns> | ||
2350 | <filterpriority>1</filterpriority> | ||
2351 | </member> | ||
2352 | <member name="M:HttpServer.HttpInput.GetEnumerator"> | ||
2353 | <summary> | ||
2354 | Returns an enumerator that iterates through a collection. | ||
2355 | </summary> | ||
2356 | |||
2357 | <returns> | ||
2358 | An <see cref="T:System.Collections.IEnumerator"></see> object that can be used to iterate through the collection. | ||
2359 | </returns> | ||
2360 | <filterpriority>2</filterpriority> | ||
2361 | </member> | ||
2362 | <member name="T:HttpServer.IHttpInput"> | ||
2363 | <summary> | ||
2364 | Base class for request data containers | ||
2365 | </summary> | ||
2366 | </member> | ||
2367 | <member name="M:HttpServer.IHttpInput.Add(System.String,System.String)"> | ||
2368 | <summary> | ||
2369 | Adds a parameter mapped to the presented name | ||
2370 | </summary> | ||
2371 | <param name="name">The name to map the parameter to</param> | ||
2372 | <param name="value">The parameter value</param> | ||
2373 | </member> | ||
2374 | <member name="P:HttpServer.IHttpInput.Item(System.String)"> | ||
2375 | <summary> | ||
2376 | Returns a request parameter | ||
2377 | </summary> | ||
2378 | <param name="name">The name associated with the parameter</param> | ||
2379 | <returns></returns> | ||
2380 | </member> | ||
2381 | <member name="M:HttpServer.IHttpInput.Contains(System.String)"> | ||
2382 | <summary> | ||
2383 | Returns true if the container contains the requested parameter | ||
2384 | </summary> | ||
2385 | <param name="name">Parameter id</param> | ||
2386 | <returns>True if parameter exists</returns> | ||
2387 | </member> | ||
2388 | <member name="T:HttpServer.HttpInputItem"> | ||
2389 | <summary> | ||
2390 | represents a HTTP input item. Each item can have multiple sub items, a sub item | ||
2391 | is made in a HTML form by using square brackets | ||
2392 | </summary> | ||
2393 | <example> | ||
2394 | // <input type="text" name="user[FirstName]" value="jonas" /> becomes: | ||
2395 | Console.WriteLine("Value: {0}", form["user"]["FirstName"].Value); | ||
2396 | </example> | ||
2397 | <remarks> | ||
2398 | All names in a form SHOULD be in lowercase. | ||
2399 | </remarks> | ||
2400 | </member> | ||
2401 | <member name="F:HttpServer.HttpInputItem.Empty"> | ||
2402 | <summary> Representation of a non-initialized <see cref="T:HttpServer.HttpInputItem"/>.</summary> | ||
2403 | </member> | ||
2404 | <member name="M:HttpServer.HttpInputItem.#ctor(System.String,System.String)"> | ||
2405 | <summary> | ||
2406 | Initializes an input item setting its name/identifier and value | ||
2407 | </summary> | ||
2408 | <param name="name">Parameter name/id</param> | ||
2409 | <param name="value">Parameter value</param> | ||
2410 | </member> | ||
2411 | <member name="M:HttpServer.HttpInputItem.#ctor(HttpServer.HttpInputItem)"> | ||
2412 | <summary>Creates a deep copy of the item specified</summary> | ||
2413 | <param name="item">The item to copy</param> | ||
2414 | <remarks>The function makes a deep copy of quite a lot which can be slow</remarks> | ||
2415 | </member> | ||
2416 | <member name="P:HttpServer.HttpInputItem.Count"> | ||
2417 | <summary> | ||
2418 | Number of values | ||
2419 | </summary> | ||
2420 | </member> | ||
2421 | <member name="P:HttpServer.HttpInputItem.Item(System.String)"> | ||
2422 | <summary> | ||
2423 | Get a sub item | ||
2424 | </summary> | ||
2425 | <param name="name">name in lower case.</param> | ||
2426 | <returns><see cref="F:HttpServer.HttpInputItem.Empty"/> if no item was found.</returns> | ||
2427 | </member> | ||
2428 | <member name="P:HttpServer.HttpInputItem.Name"> | ||
2429 | <summary> | ||
2430 | Name of item (in lower case). | ||
2431 | </summary> | ||
2432 | </member> | ||
2433 | <member name="P:HttpServer.HttpInputItem.Value"> | ||
2434 | <summary> | ||
2435 | Returns the first value, or null if no value exist. | ||
2436 | </summary> | ||
2437 | </member> | ||
2438 | <member name="P:HttpServer.HttpInputItem.LastValue"> | ||
2439 | <summary> | ||
2440 | Returns the last value, or null if no value exist. | ||
2441 | </summary> | ||
2442 | </member> | ||
2443 | <member name="P:HttpServer.HttpInputItem.Values"> | ||
2444 | <summary> | ||
2445 | Returns the list with values. | ||
2446 | </summary> | ||
2447 | </member> | ||
2448 | <member name="M:HttpServer.HttpInputItem.Add(System.String)"> | ||
2449 | <summary> | ||
2450 | Add another value to this item | ||
2451 | </summary> | ||
2452 | <param name="value">Value to add.</param> | ||
2453 | <exception cref="T:System.InvalidOperationException">Cannot add stuff to <see cref="F:HttpServer.HttpInput.Empty"/>.</exception> | ||
2454 | </member> | ||
2455 | <member name="M:HttpServer.HttpInputItem.Contains(System.String)"> | ||
2456 | <summary> | ||
2457 | checks if a sub-item exists (and has a value). | ||
2458 | </summary> | ||
2459 | <param name="name">name in lower case</param> | ||
2460 | <returns>true if the sub-item exists and has a value; otherwise false.</returns> | ||
2461 | </member> | ||
2462 | <member name="M:HttpServer.HttpInputItem.ToString"> | ||
2463 | <summary> Returns a formatted representation of the instance with the values of all contained parameters </summary> | ||
2464 | </member> | ||
2465 | <member name="M:HttpServer.HttpInputItem.ToString(System.String,System.Boolean)"> | ||
2466 | <summary> | ||
2467 | Outputs the string in a formatted manner | ||
2468 | </summary> | ||
2469 | <param name="prefix">A prefix to append, used internally</param> | ||
2470 | <param name="asQuerySting">produce a query string</param> | ||
2471 | </member> | ||
2472 | <member name="P:HttpServer.HttpInputItem.HttpServer#IHttpInput#Item(System.String)"> | ||
2473 | <summary> | ||
2474 | |||
2475 | </summary> | ||
2476 | <param name="name">name in lower case</param> | ||
2477 | <returns></returns> | ||
2478 | </member> | ||
2479 | <member name="M:HttpServer.HttpInputItem.Add(System.String,System.String)"> | ||
2480 | <summary> | ||
2481 | Add a sub item. | ||
2482 | </summary> | ||
2483 | <param name="name">Can contain array formatting, the item is then parsed and added in multiple levels</param> | ||
2484 | <param name="value">Value to add.</param> | ||
2485 | <exception cref="T:System.ArgumentNullException">Argument is null.</exception> | ||
2486 | <exception cref="T:System.InvalidOperationException">Cannot add stuff to <see cref="F:HttpServer.HttpInput.Empty"/>.</exception> | ||
2487 | </member> | ||
2488 | <member name="M:HttpServer.HttpInputItem.System#Collections#Generic#IEnumerable{HttpServer#HttpInputItem}#GetEnumerator"> | ||
2489 | <summary> | ||
2490 | Returns an enumerator that iterates through the collection. | ||
2491 | </summary> | ||
2492 | |||
2493 | <returns> | ||
2494 | A <see cref="T:System.Collections.Generic.IEnumerator`1"></see> that can be used to iterate through the collection. | ||
2495 | </returns> | ||
2496 | <filterpriority>1</filterpriority> | ||
2497 | </member> | ||
2498 | <member name="M:HttpServer.HttpInputItem.GetEnumerator"> | ||
2499 | <summary> | ||
2500 | Returns an enumerator that iterates through a collection. | ||
2501 | </summary> | ||
2502 | |||
2503 | <returns> | ||
2504 | An <see cref="T:System.Collections.IEnumerator"></see> object that can be used to iterate through the collection. | ||
2505 | </returns> | ||
2506 | <filterpriority>2</filterpriority> | ||
2507 | </member> | ||
2508 | <member name="M:HttpServer.HttpInputItem.ToString(System.String)"> | ||
2509 | <summary> | ||
2510 | Outputs the string in a formatted manner | ||
2511 | </summary> | ||
2512 | <param name="prefix">A prefix to append, used internally</param> | ||
2513 | <returns></returns> | ||
2514 | </member> | ||
2515 | <member name="T:HttpServer.HttpListener"> | ||
2516 | <summary> | ||
2517 | New implementation of the HTTP listener. | ||
2518 | </summary> | ||
2519 | <remarks> | ||
2520 | Use the <c>Create</c> methods to create a default listener. | ||
2521 | </remarks> | ||
2522 | </member> | ||
2523 | <member name="E:HttpServer.HttpListener.Accepted"> | ||
2524 | <summary> | ||
2525 | A client have been accepted, but not handled, by the listener. | ||
2526 | </summary> | ||
2527 | </member> | ||
2528 | <member name="M:HttpServer.HttpListener.#ctor(System.Net.IPAddress,System.Int32,HttpServer.IHttpContextFactory)"> | ||
2529 | <summary> | ||
2530 | Initializes a new instance of the <see cref="T:HttpServer.HttpListener"/> class. | ||
2531 | </summary> | ||
2532 | <param name="address">IP Address to accept connections on</param> | ||
2533 | <param name="port">TCP Port to listen on, default HTTP port is 80.</param> | ||
2534 | <param name="factory">Factory used to create <see cref="T:HttpServer.IHttpClientContext"/>es.</param> | ||
2535 | <exception cref="T:System.ArgumentNullException"><c>address</c> is null.</exception> | ||
2536 | <exception cref="T:System.ArgumentException">Port must be a positive number.</exception> | ||
2537 | </member> | ||
2538 | <member name="M:HttpServer.HttpListener.#ctor(System.Net.IPAddress,System.Int32,HttpServer.IHttpContextFactory,System.Security.Cryptography.X509Certificates.X509Certificate)"> | ||
2539 | <summary> | ||
2540 | Initializes a new instance of the <see cref="T:HttpServer.HttpListener"/> class. | ||
2541 | </summary> | ||
2542 | <param name="address">The address.</param> | ||
2543 | <param name="port">The port.</param> | ||
2544 | <param name="factory">The factory.</param> | ||
2545 | <param name="certificate">The certificate.</param> | ||
2546 | </member> | ||
2547 | <member name="M:HttpServer.HttpListener.#ctor(System.Net.IPAddress,System.Int32,HttpServer.IHttpContextFactory,System.Security.Cryptography.X509Certificates.X509Certificate,System.Security.Authentication.SslProtocols)"> | ||
2548 | <summary> | ||
2549 | Initializes a new instance of the <see cref="T:HttpServer.HttpListener"/> class. | ||
2550 | </summary> | ||
2551 | <param name="address">The address.</param> | ||
2552 | <param name="port">The port.</param> | ||
2553 | <param name="factory">The factory.</param> | ||
2554 | <param name="certificate">The certificate.</param> | ||
2555 | <param name="protocol">The protocol.</param> | ||
2556 | </member> | ||
2557 | <member name="M:HttpServer.HttpListener.Create(System.Net.IPAddress,System.Int32)"> | ||
2558 | <summary> | ||
2559 | Creates a new <see cref="T:HttpServer.HttpListener"/> instance with default factories. | ||
2560 | </summary> | ||
2561 | <param name="address">Address that the listener should accept connections on.</param> | ||
2562 | <param name="port">Port that listener should accept connections on.</param> | ||
2563 | <returns>Created HTTP listener.</returns> | ||
2564 | </member> | ||
2565 | <member name="M:HttpServer.HttpListener.Create(System.Net.IPAddress,System.Int32,System.Security.Cryptography.X509Certificates.X509Certificate)"> | ||
2566 | <summary> | ||
2567 | Creates a new <see cref="T:HttpServer.HttpListener"/> instance with default factories. | ||
2568 | </summary> | ||
2569 | <param name="address">Address that the listener should accept connections on.</param> | ||
2570 | <param name="port">Port that listener should accept connections on.</param> | ||
2571 | <param name="certificate">Certificate to use</param> | ||
2572 | <returns>Created HTTP listener.</returns> | ||
2573 | </member> | ||
2574 | <member name="M:HttpServer.HttpListener.Create(System.Net.IPAddress,System.Int32,System.Security.Cryptography.X509Certificates.X509Certificate,System.Security.Authentication.SslProtocols)"> | ||
2575 | <summary> | ||
2576 | Creates a new <see cref="T:HttpServer.HttpListener"/> instance with default factories. | ||
2577 | </summary> | ||
2578 | <param name="address">Address that the listener should accept connections on.</param> | ||
2579 | <param name="port">Port that listener should accept connections on.</param> | ||
2580 | <param name="certificate">Certificate to use</param> | ||
2581 | <param name="protocol">which HTTPS protocol to use, default is TLS.</param> | ||
2582 | <returns>Created HTTP listener.</returns> | ||
2583 | </member> | ||
2584 | <member name="M:HttpServer.HttpListener.OnAcceptingSocket(System.Net.Sockets.Socket)"> | ||
2585 | <summary> | ||
2586 | Can be used to create filtering of new connections. | ||
2587 | </summary> | ||
2588 | <param name="socket">Accepted socket</param> | ||
2589 | <returns> | ||
2590 | true if connection can be accepted; otherwise false. | ||
2591 | </returns> | ||
2592 | </member> | ||
2593 | <member name="T:HttpServer.HttpListenerBase"> | ||
2594 | <summary> | ||
2595 | Contains a listener that doesn't do anything with the connections. | ||
2596 | </summary> | ||
2597 | </member> | ||
2598 | <member name="M:HttpServer.HttpListenerBase.#ctor(System.Net.IPAddress,System.Int32,HttpServer.IHttpContextFactory)"> | ||
2599 | <summary> | ||
2600 | Listen for regular HTTP connections | ||
2601 | </summary> | ||
2602 | <param name="address">IP Address to accept connections on</param> | ||
2603 | <param name="port">TCP Port to listen on, default HTTP port is 80.</param> | ||
2604 | <param name="factory">Factory used to create <see cref="T:HttpServer.IHttpClientContext"/>es.</param> | ||
2605 | <exception cref="T:System.ArgumentNullException"><c>address</c> is null.</exception> | ||
2606 | <exception cref="T:System.ArgumentException">Port must be a positive number.</exception> | ||
2607 | </member> | ||
2608 | <member name="M:HttpServer.HttpListenerBase.#ctor(System.Net.IPAddress,System.Int32,HttpServer.IHttpContextFactory,System.Security.Cryptography.X509Certificates.X509Certificate)"> | ||
2609 | <summary> | ||
2610 | Initializes a new instance of the <see cref="T:HttpServer.HttpListenerBase"/> class. | ||
2611 | </summary> | ||
2612 | <param name="address">IP Address to accept connections on</param> | ||
2613 | <param name="port">TCP Port to listen on, default HTTPS port is 443</param> | ||
2614 | <param name="factory">Factory used to create <see cref="T:HttpServer.IHttpClientContext"/>es.</param> | ||
2615 | <param name="certificate">Certificate to use</param> | ||
2616 | </member> | ||
2617 | <member name="M:HttpServer.HttpListenerBase.#ctor(System.Net.IPAddress,System.Int32,HttpServer.IHttpContextFactory,System.Security.Cryptography.X509Certificates.X509Certificate,System.Security.Authentication.SslProtocols)"> | ||
2618 | <summary> | ||
2619 | Initializes a new instance of the <see cref="T:HttpServer.HttpListenerBase"/> class. | ||
2620 | </summary> | ||
2621 | <param name="address">IP Address to accept connections on</param> | ||
2622 | <param name="port">TCP Port to listen on, default HTTPS port is 443</param> | ||
2623 | <param name="factory">Factory used to create <see cref="T:HttpServer.IHttpClientContext"/>es.</param> | ||
2624 | <param name="certificate">Certificate to use</param> | ||
2625 | <param name="protocol">which HTTPS protocol to use, default is TLS.</param> | ||
2626 | </member> | ||
2627 | <member name="P:HttpServer.HttpListenerBase.LogWriter"> | ||
2628 | <summary> | ||
2629 | Gives you a change to receive log entries for all internals of the HTTP library. | ||
2630 | </summary> | ||
2631 | <remarks> | ||
2632 | You may not switch log writer after starting the listener. | ||
2633 | </remarks> | ||
2634 | </member> | ||
2635 | <member name="P:HttpServer.HttpListenerBase.UseTraceLogs"> | ||
2636 | <summary> | ||
2637 | True if we should turn on trace logs. | ||
2638 | </summary> | ||
2639 | </member> | ||
2640 | <member name="M:HttpServer.HttpListenerBase.OnAccept(System.IAsyncResult)"> | ||
2641 | <exception cref="T:System.Exception"><c>Exception</c>.</exception> | ||
2642 | </member> | ||
2643 | <member name="M:HttpServer.HttpListenerBase.RetryBeginAccept"> | ||
2644 | <summary> | ||
2645 | Will try to accept connections one more time. | ||
2646 | </summary> | ||
2647 | <exception cref="T:System.Exception">If any exceptions is thrown.</exception> | ||
2648 | </member> | ||
2649 | <member name="M:HttpServer.HttpListenerBase.OnAcceptingSocket(System.Net.Sockets.Socket)"> | ||
2650 | <summary> | ||
2651 | Can be used to create filtering of new connections. | ||
2652 | </summary> | ||
2653 | <param name="socket">Accepted socket</param> | ||
2654 | <returns>true if connection can be accepted; otherwise false.</returns> | ||
2655 | </member> | ||
2656 | <member name="M:HttpServer.HttpListenerBase.Start(System.Int32)"> | ||
2657 | <summary> | ||
2658 | Start listen for new connections | ||
2659 | </summary> | ||
2660 | <param name="backlog">Number of connections that can stand in a queue to be accepted.</param> | ||
2661 | <exception cref="T:System.InvalidOperationException">Listener have already been started.</exception> | ||
2662 | </member> | ||
2663 | <member name="M:HttpServer.HttpListenerBase.Stop"> | ||
2664 | <summary> | ||
2665 | Stop the listener | ||
2666 | </summary> | ||
2667 | <exception cref="T:System.Net.Sockets.SocketException"></exception> | ||
2668 | </member> | ||
2669 | <member name="E:HttpServer.HttpListenerBase.ExceptionThrown"> | ||
2670 | <summary> | ||
2671 | Catch exceptions not handled by the listener. | ||
2672 | </summary> | ||
2673 | <remarks> | ||
2674 | Exceptions will be thrown during debug mode if this event is not used, | ||
2675 | exceptions will be printed to console and suppressed during release mode. | ||
2676 | </remarks> | ||
2677 | </member> | ||
2678 | <member name="E:HttpServer.HttpListenerBase.RequestReceived"> | ||
2679 | <summary> | ||
2680 | A request have been received from a <see cref="T:HttpServer.IHttpClientContext"/>. | ||
2681 | </summary> | ||
2682 | </member> | ||
2683 | <member name="T:HttpServer.HttpModules.FileModule"> | ||
2684 | <summary> | ||
2685 | The purpose of this module is to serve files. | ||
2686 | </summary> | ||
2687 | </member> | ||
2688 | <member name="M:HttpServer.HttpModules.FileModule.#ctor(System.String,System.String,System.Boolean)"> | ||
2689 | <summary> | ||
2690 | Initializes a new instance of the <see cref="T:HttpServer.HttpModules.FileModule"/> class. | ||
2691 | </summary> | ||
2692 | <param name="baseUri">Uri to serve, for instance "/files/"</param> | ||
2693 | <param name="basePath">Path on hard drive where we should start looking for files</param> | ||
2694 | <param name="useLastModifiedHeader">If true a Last-Modifed header will be sent upon requests urging web browser to cache files</param> | ||
2695 | </member> | ||
2696 | <member name="M:HttpServer.HttpModules.FileModule.#ctor(System.String,System.String)"> | ||
2697 | <summary> | ||
2698 | Initializes a new instance of the <see cref="T:HttpServer.HttpModules.FileModule"/> class. | ||
2699 | </summary> | ||
2700 | <param name="baseUri">Uri to serve, for instance "/files/"</param> | ||
2701 | <param name="basePath">Path on hard drive where we should start looking for files</param> | ||
2702 | </member> | ||
2703 | <member name="P:HttpServer.HttpModules.FileModule.MimeTypes"> | ||
2704 | <summary> | ||
2705 | List with all mime-type that are allowed. | ||
2706 | </summary> | ||
2707 | <remarks>All other mime types will result in a Forbidden http status code.</remarks> | ||
2708 | </member> | ||
2709 | <member name="P:HttpServer.HttpModules.FileModule.ForbiddenChars"> | ||
2710 | <summary> | ||
2711 | characters that may not exist in a path. | ||
2712 | </summary> | ||
2713 | <example> | ||
2714 | fileMod.ForbiddenChars = new string[]{ "\\", "..", ":" }; | ||
2715 | </example> | ||
2716 | </member> | ||
2717 | <member name="M:HttpServer.HttpModules.FileModule.AddDefaultMimeTypes"> | ||
2718 | <summary> | ||
2719 | Mimtypes that this class can handle per default | ||
2720 | </summary> | ||
2721 | </member> | ||
2722 | <member name="M:HttpServer.HttpModules.FileModule.CanHandle(System.Uri)"> | ||
2723 | <summary> | ||
2724 | Determines if the request should be handled by this module. | ||
2725 | Invoked by the <see cref="T:HttpServer.HttpServer"/> | ||
2726 | </summary> | ||
2727 | <param name="uri"></param> | ||
2728 | <returns>true if this module should handle it.</returns> | ||
2729 | </member> | ||
2730 | <member name="M:HttpServer.HttpModules.FileModule.GetPath(System.Uri)"> | ||
2731 | <exception cref="T:HttpServer.Exceptions.BadRequestException">Illegal path</exception> | ||
2732 | </member> | ||
2733 | <member name="M:HttpServer.HttpModules.FileModule.Contains(System.String,System.Collections.Generic.IEnumerable{System.String})"> | ||
2734 | <summary> | ||
2735 | check if source contains any of the chars. | ||
2736 | </summary> | ||
2737 | <param name="source"></param> | ||
2738 | <param name="chars"></param> | ||
2739 | <returns></returns> | ||
2740 | </member> | ||
2741 | <member name="M:HttpServer.HttpModules.FileModule.Process(HttpServer.IHttpRequest,HttpServer.IHttpResponse,HttpServer.Sessions.IHttpSession)"> | ||
2742 | <summary> | ||
2743 | Method that process the Uri. | ||
2744 | </summary> | ||
2745 | <param name="request">Information sent by the browser about the request</param> | ||
2746 | <param name="response">Information that is being sent back to the client.</param> | ||
2747 | <param name="session">Session used to </param> | ||
2748 | <exception cref="T:HttpServer.Exceptions.InternalServerException">Failed to find file extension</exception> | ||
2749 | <exception cref="T:HttpServer.Exceptions.ForbiddenException">File type is forbidden.</exception> | ||
2750 | </member> | ||
2751 | <member name="M:HttpServer.HttpModules.FileModule.GetFileExtension(System.String)"> | ||
2752 | <summary> | ||
2753 | return a file extension from an absolute Uri path (or plain filename) | ||
2754 | </summary> | ||
2755 | <param name="uri"></param> | ||
2756 | <returns></returns> | ||
2757 | </member> | ||
2758 | <member name="T:HttpServer.HttpModules.HttpModule"> | ||
2759 | <summary> | ||
2760 | A HttpModule can be used to serve Uri's. The module itself | ||
2761 | decides if it should serve a Uri or not. In this way, you can | ||
2762 | get a very flexible http application since you can let multiple modules | ||
2763 | serve almost similar urls. | ||
2764 | </summary> | ||
2765 | <remarks> | ||
2766 | Throw <see cref="T:HttpServer.Exceptions.UnauthorizedException"/> if you are using a <see cref="T:HttpServer.Authentication.AuthenticationModule"/> and want to prompt for user name/password. | ||
2767 | </remarks> | ||
2768 | </member> | ||
2769 | <member name="M:HttpServer.HttpModules.HttpModule.Process(HttpServer.IHttpRequest,HttpServer.IHttpResponse,HttpServer.Sessions.IHttpSession)"> | ||
2770 | <summary> | ||
2771 | Method that process the url | ||
2772 | </summary> | ||
2773 | <param name="request">Information sent by the browser about the request</param> | ||
2774 | <param name="response">Information that is being sent back to the client.</param> | ||
2775 | <param name="session">Session used to </param> | ||
2776 | <returns>true if this module handled the request.</returns> | ||
2777 | </member> | ||
2778 | <member name="M:HttpServer.HttpModules.HttpModule.SetLogWriter(HttpServer.ILogWriter)"> | ||
2779 | <summary> | ||
2780 | Set the log writer to use. | ||
2781 | </summary> | ||
2782 | <param name="writer">logwriter to use.</param> | ||
2783 | </member> | ||
2784 | <member name="M:HttpServer.HttpModules.HttpModule.Write(HttpServer.LogPrio,System.String)"> | ||
2785 | <summary> | ||
2786 | Log something. | ||
2787 | </summary> | ||
2788 | <param name="prio">importance of log message</param> | ||
2789 | <param name="message">message</param> | ||
2790 | </member> | ||
2791 | <member name="P:HttpServer.HttpModules.HttpModule.AllowSecondaryProcessing"> | ||
2792 | <summary> | ||
2793 | If true specifies that the module doesn't consume the processing of a request so that subsequent modules | ||
2794 | can continue processing afterwards. Default is false. | ||
2795 | </summary> | ||
2796 | </member> | ||
2797 | <member name="T:HttpServer.HttpModules.HttpModuleExceptionEventArgs"> | ||
2798 | <summary> | ||
2799 | Used to inform http server that | ||
2800 | </summary> | ||
2801 | </member> | ||
2802 | <member name="M:HttpServer.HttpModules.HttpModuleExceptionEventArgs.#ctor(System.Exception)"> | ||
2803 | <summary> | ||
2804 | Eventarguments used when an exception is thrown by a module | ||
2805 | </summary> | ||
2806 | <param name="e">the exception</param> | ||
2807 | </member> | ||
2808 | <member name="P:HttpServer.HttpModules.HttpModuleExceptionEventArgs.Exception"> | ||
2809 | <summary> | ||
2810 | Exception thrown in a module | ||
2811 | </summary> | ||
2812 | </member> | ||
2813 | <member name="T:HttpServer.HttpModules.ResourceFileModule"> | ||
2814 | <summary> | ||
2815 | Serves files that are stored in embedded resources. | ||
2816 | </summary> | ||
2817 | </member> | ||
2818 | <member name="M:HttpServer.HttpModules.ResourceFileModule.#ctor"> | ||
2819 | <summary> | ||
2820 | Initializes a new instance of the <see cref="T:HttpServer.HttpModules.ResourceFileModule"/> class. | ||
2821 | Runs <see cref="M:HttpServer.HttpModules.ResourceFileModule.AddDefaultMimeTypes"/> to make sure the basic mime types are available, they can be cleared later | ||
2822 | through the use of <see cref="P:HttpServer.HttpModules.ResourceFileModule.MimeTypes"/> if desired. | ||
2823 | </summary> | ||
2824 | </member> | ||
2825 | <member name="M:HttpServer.HttpModules.ResourceFileModule.#ctor(HttpServer.ILogWriter)"> | ||
2826 | <summary> | ||
2827 | Initializes a new instance of the <see cref="T:HttpServer.HttpModules.ResourceFileModule"/> class. | ||
2828 | Runs <see cref="M:HttpServer.HttpModules.ResourceFileModule.AddDefaultMimeTypes"/> to make sure the basic mime types are available, they can be cleared later | ||
2829 | through the use of <see cref="P:HttpServer.HttpModules.ResourceFileModule.MimeTypes"/> if desired. | ||
2830 | </summary> | ||
2831 | <param name="logWriter">The log writer to use when logging events</param> | ||
2832 | </member> | ||
2833 | <member name="P:HttpServer.HttpModules.ResourceFileModule.MimeTypes"> | ||
2834 | <summary> | ||
2835 | List with all mime-type that are allowed. | ||
2836 | </summary> | ||
2837 | <remarks>All other mime types will result in a Forbidden http status code.</remarks> | ||
2838 | </member> | ||
2839 | <member name="M:HttpServer.HttpModules.ResourceFileModule.AddDefaultMimeTypes"> | ||
2840 | <summary> | ||
2841 | Mimtypes that this class can handle per default | ||
2842 | </summary> | ||
2843 | </member> | ||
2844 | <member name="M:HttpServer.HttpModules.ResourceFileModule.AddResources(System.String,System.Reflection.Assembly,System.String)"> | ||
2845 | <summary> | ||
2846 | Loads resources from a namespace in the given assembly to an uri | ||
2847 | </summary> | ||
2848 | <param name="toUri">The uri to map the resources to</param> | ||
2849 | <param name="fromAssembly">The assembly in which the resources reside</param> | ||
2850 | <param name="fromNamespace">The namespace from which to load the resources</param> | ||
2851 | <usage> | ||
2852 | resourceLoader.LoadResources("/user/", typeof(User).Assembly, "MyLib.Models.User.Views"); | ||
2853 | |||
2854 | will make ie the resource MyLib.Models.User.Views.stylesheet.css accessible via /user/stylesheet.css | ||
2855 | </usage> | ||
2856 | <returns>The amount of loaded files, giving you the possibility of making sure the resources needed gets loaded</returns> | ||
2857 | </member> | ||
2858 | <member name="M:HttpServer.HttpModules.ResourceFileModule.CanHandle(HttpServer.IHttpRequest)"> | ||
2859 | <summary> | ||
2860 | Returns true if the module can handle the request | ||
2861 | </summary> | ||
2862 | </member> | ||
2863 | <member name="M:HttpServer.HttpModules.ResourceFileModule.Process(HttpServer.IHttpRequest,HttpServer.IHttpResponse,HttpServer.Sessions.IHttpSession)"> | ||
2864 | <summary> | ||
2865 | Method that process the url | ||
2866 | </summary> | ||
2867 | <param name="request">Information sent by the browser about the request</param> | ||
2868 | <param name="response">Information that is being sent back to the client.</param> | ||
2869 | <param name="session">Session used to </param> | ||
2870 | <returns>true if this module handled the request.</returns> | ||
2871 | </member> | ||
2872 | <member name="T:HttpServer.HttpModules.ReverseProxyModule"> | ||
2873 | <summary> | ||
2874 | A reverse proxy are used to act as a bridge between local (protected/hidden) websites | ||
2875 | and public clients. | ||
2876 | |||
2877 | A typical usage is to allow web servers on non standard ports to still be available | ||
2878 | to the public clients, or allow web servers on private ips to be available. | ||
2879 | </summary> | ||
2880 | </member> | ||
2881 | <member name="M:HttpServer.HttpModules.ReverseProxyModule.#ctor(System.String,System.String)"> | ||
2882 | <summary> | ||
2883 | |||
2884 | </summary> | ||
2885 | <param name="source">Base url requested from browser</param> | ||
2886 | <param name="destination">Base url on private web server</param> | ||
2887 | <example> | ||
2888 | // this will return contents from http://192.168.1.128/view/jonas when client requests http://www.gauffin.com/user/view/jonas | ||
2889 | _server.Add(new ReverseProxyModule("http://www.gauffin.com/user/", "http://192.168.1.128/"); | ||
2890 | </example> | ||
2891 | </member> | ||
2892 | <member name="M:HttpServer.HttpModules.ReverseProxyModule.CanHandle(System.Uri)"> | ||
2893 | <summary> | ||
2894 | Method that determines if an url should be handled or not by the module | ||
2895 | </summary> | ||
2896 | <param name="uri">Url requested by the client.</param> | ||
2897 | <returns>true if module should handle the url.</returns> | ||
2898 | </member> | ||
2899 | <member name="M:HttpServer.HttpModules.ReverseProxyModule.Process(HttpServer.IHttpRequest,HttpServer.IHttpResponse,HttpServer.Sessions.IHttpSession)"> | ||
2900 | <summary> | ||
2901 | Method that process the url | ||
2902 | </summary> | ||
2903 | <param name="request">Information sent by the browser about the request</param> | ||
2904 | <param name="response">Information that is being sent back to the client.</param> | ||
2905 | <param name="session">Session used to </param> | ||
2906 | </member> | ||
2907 | <member name="T:HttpServer.HttpModules.WebSiteModule"> | ||
2908 | <summary> | ||
2909 | The website module let's you handle multiple websites in the same server. | ||
2910 | It uses the "Host" header to check which site you want. | ||
2911 | </summary> | ||
2912 | <remarks>It's recommended that you do not | ||
2913 | add any other modules to HttpServer if you are using the website module. Instead, | ||
2914 | add all wanted modules to each website.</remarks> | ||
2915 | </member> | ||
2916 | <member name="M:HttpServer.HttpModules.WebSiteModule.#ctor(System.String,System.String)"> | ||
2917 | <summary> | ||
2918 | |||
2919 | </summary> | ||
2920 | <param name="host">domain name that should be handled.</param> | ||
2921 | <param name="name"></param> | ||
2922 | </member> | ||
2923 | <member name="P:HttpServer.HttpModules.WebSiteModule.SiteName"> | ||
2924 | <summary> | ||
2925 | Name of site. | ||
2926 | </summary> | ||
2927 | </member> | ||
2928 | <member name="M:HttpServer.HttpModules.WebSiteModule.Process(HttpServer.IHttpRequest,HttpServer.IHttpResponse,HttpServer.Sessions.IHttpSession)"> | ||
2929 | <summary> | ||
2930 | Method that process the url | ||
2931 | </summary> | ||
2932 | <param name="request">Information sent by the browser about the request</param> | ||
2933 | <param name="response">Information that is being sent back to the client.</param> | ||
2934 | <param name="session">Session used to </param> | ||
2935 | </member> | ||
2936 | <member name="T:HttpServer.HttpParam"> | ||
2937 | <summary> | ||
2938 | Returns item either from a form or a query string (checks them in that order) | ||
2939 | </summary> | ||
2940 | </member> | ||
2941 | <member name="F:HttpServer.HttpParam.Empty"> | ||
2942 | <summary> Representation of a non-initialized HttpParam </summary> | ||
2943 | </member> | ||
2944 | <member name="M:HttpServer.HttpParam.#ctor(HttpServer.IHttpInput,HttpServer.IHttpInput)"> | ||
2945 | <summary>Initialises the class to hold a value either from a post request or a querystring request</summary> | ||
2946 | </member> | ||
2947 | <member name="M:HttpServer.HttpParam.Add(System.String,System.String)"> | ||
2948 | <summary> | ||
2949 | The add method is not availible for HttpParam | ||
2950 | since HttpParam checks both Request.Form and Request.QueryString | ||
2951 | </summary> | ||
2952 | <param name="name">name identifying the value</param> | ||
2953 | <param name="value">value to add</param> | ||
2954 | <exception cref="T:System.NotImplementedException"></exception> | ||
2955 | </member> | ||
2956 | <member name="M:HttpServer.HttpParam.Contains(System.String)"> | ||
2957 | <summary> | ||
2958 | Checks whether the form or querystring has the specified value | ||
2959 | </summary> | ||
2960 | <param name="name">Name, case sensitive</param> | ||
2961 | <returns>true if found; otherwise false.</returns> | ||
2962 | </member> | ||
2963 | <member name="P:HttpServer.HttpParam.Item(System.String)"> | ||
2964 | <summary> | ||
2965 | Fetch an item from the form or querystring (in that order). | ||
2966 | </summary> | ||
2967 | <param name="name"></param> | ||
2968 | <returns>Item if found; otherwise HttpInputItem.EmptyLanguageNode</returns> | ||
2969 | </member> | ||
2970 | <member name="M:HttpServer.HttpParam.System#Collections#Generic#IEnumerable{HttpServer#HttpInputItem}#GetEnumerator"> | ||
2971 | <summary> | ||
2972 | Returns an enumerator that iterates through the collection. | ||
2973 | </summary> | ||
2974 | |||
2975 | <returns> | ||
2976 | A <see cref="T:System.Collections.Generic.IEnumerator`1"></see> that can be used to iterate through the collection. | ||
2977 | </returns> | ||
2978 | <filterpriority>1</filterpriority> | ||
2979 | </member> | ||
2980 | <member name="M:HttpServer.HttpParam.GetEnumerator"> | ||
2981 | <summary> | ||
2982 | Returns an enumerator that iterates through a collection. | ||
2983 | </summary> | ||
2984 | |||
2985 | <returns> | ||
2986 | An <see cref="T:System.Collections.IEnumerator"></see> object that can be used to iterate through the collection. | ||
2987 | </returns> | ||
2988 | <filterpriority>2</filterpriority> | ||
2989 | </member> | ||
2990 | <member name="T:HttpServer.HttpRequest"> | ||
2991 | <summary> | ||
2992 | Contains server side HTTP request information. | ||
2993 | </summary> | ||
2994 | </member> | ||
2995 | <member name="F:HttpServer.HttpRequest.UriSplitters"> | ||
2996 | <summary> | ||
2997 | Chars used to split an URL path into multiple parts. | ||
2998 | </summary> | ||
2999 | </member> | ||
3000 | <member name="P:HttpServer.HttpRequest.Secure"> | ||
3001 | <summary> | ||
3002 | Gets or sets a value indicating whether this <see cref="T:HttpServer.HttpRequest"/> is secure. | ||
3003 | </summary> | ||
3004 | </member> | ||
3005 | <member name="P:HttpServer.HttpRequest.UriPath"> | ||
3006 | <summary> | ||
3007 | Path and query (will be merged with the host header) and put in Uri | ||
3008 | </summary> | ||
3009 | <see cref="P:HttpServer.HttpRequest.Uri"/> | ||
3010 | </member> | ||
3011 | <member name="M:HttpServer.HttpRequest.AssignForm(HttpServer.HttpForm)"> | ||
3012 | <summary> | ||
3013 | Assign a form. | ||
3014 | </summary> | ||
3015 | <param name="form"></param> | ||
3016 | </member> | ||
3017 | <member name="P:HttpServer.HttpRequest.BodyIsComplete"> | ||
3018 | <summary> | ||
3019 | Gets whether the body is complete. | ||
3020 | </summary> | ||
3021 | </member> | ||
3022 | <member name="P:HttpServer.HttpRequest.AcceptTypes"> | ||
3023 | <summary> | ||
3024 | Gets kind of types accepted by the client. | ||
3025 | </summary> | ||
3026 | </member> | ||
3027 | <member name="P:HttpServer.HttpRequest.Body"> | ||
3028 | <summary> | ||
3029 | Gets or sets body stream. | ||
3030 | </summary> | ||
3031 | </member> | ||
3032 | <member name="P:HttpServer.HttpRequest.Connection"> | ||
3033 | <summary> | ||
3034 | Gets or sets kind of connection used for the session. | ||
3035 | </summary> | ||
3036 | </member> | ||
3037 | <member name="P:HttpServer.HttpRequest.ContentLength"> | ||
3038 | <summary> | ||
3039 | Gets or sets number of bytes in the body. | ||
3040 | </summary> | ||
3041 | </member> | ||
3042 | <member name="P:HttpServer.HttpRequest.Headers"> | ||
3043 | <summary> | ||
3044 | Gets headers sent by the client. | ||
3045 | </summary> | ||
3046 | </member> | ||
3047 | <member name="P:HttpServer.HttpRequest.HttpVersion"> | ||
3048 | <summary> | ||
3049 | Gets or sets version of HTTP protocol that's used. | ||
3050 | </summary> | ||
3051 | <remarks> | ||
3052 | Probably <see cref="F:HttpServer.HttpHelper.HTTP10"/> or <see cref="F:HttpServer.HttpHelper.HTTP11"/>. | ||
3053 | </remarks> | ||
3054 | <seealso cref="T:HttpServer.HttpHelper"/> | ||
3055 | </member> | ||
3056 | <member name="P:HttpServer.HttpRequest.Method"> | ||
3057 | <summary> | ||
3058 | Gets or sets requested method. | ||
3059 | </summary> | ||
3060 | <value></value> | ||
3061 | <remarks> | ||
3062 | Will always be in upper case. | ||
3063 | </remarks> | ||
3064 | <see cref="!:HttpServer.Method"/> | ||
3065 | </member> | ||
3066 | <member name="P:HttpServer.HttpRequest.QueryString"> | ||
3067 | <summary> | ||
3068 | Gets variables sent in the query string | ||
3069 | </summary> | ||
3070 | </member> | ||
3071 | <member name="P:HttpServer.HttpRequest.Uri"> | ||
3072 | <summary> | ||
3073 | Gets or sets requested URI. | ||
3074 | </summary> | ||
3075 | </member> | ||
3076 | <member name="P:HttpServer.HttpRequest.UriParts"> | ||
3077 | <summary> | ||
3078 | Uri absolute path splitted into parts. | ||
3079 | </summary> | ||
3080 | <example> | ||
3081 | // uri is: http://gauffin.com/code/tiny/ | ||
3082 | Console.WriteLine(request.UriParts[0]); // result: code | ||
3083 | Console.WriteLine(request.UriParts[1]); // result: tiny | ||
3084 | </example> | ||
3085 | <remarks> | ||
3086 | If you're using controllers than the first part is controller name, | ||
3087 | the second part is method name and the third part is Id property. | ||
3088 | </remarks> | ||
3089 | <seealso cref="P:HttpServer.HttpRequest.Uri"/> | ||
3090 | </member> | ||
3091 | <member name="P:HttpServer.HttpRequest.Param"> | ||
3092 | <summary> | ||
3093 | Gets parameter from <see cref="P:HttpServer.HttpRequest.QueryString"/> or <see cref="P:HttpServer.HttpRequest.Form"/>. | ||
3094 | </summary> | ||
3095 | </member> | ||
3096 | <member name="P:HttpServer.HttpRequest.Form"> | ||
3097 | <summary> | ||
3098 | Gets form parameters. | ||
3099 | </summary> | ||
3100 | </member> | ||
3101 | <member name="P:HttpServer.HttpRequest.IsAjax"> | ||
3102 | <summary> | ||
3103 | Gets whether the request was made by Ajax (Asynchronous JavaScript) | ||
3104 | </summary> | ||
3105 | </member> | ||
3106 | <member name="P:HttpServer.HttpRequest.Cookies"> | ||
3107 | <summary> | ||
3108 | Gets cookies that was sent with the request. | ||
3109 | </summary> | ||
3110 | </member> | ||
3111 | <member name="M:HttpServer.HttpRequest.Clone"> | ||
3112 | <summary> | ||
3113 | Creates a new object that is a copy of the current instance. | ||
3114 | </summary> | ||
3115 | |||
3116 | <returns> | ||
3117 | A new object that is a copy of this instance. | ||
3118 | </returns> | ||
3119 | <filterpriority>2</filterpriority> | ||
3120 | </member> | ||
3121 | <member name="M:HttpServer.HttpRequest.DecodeBody(HttpServer.FormDecoders.FormDecoderProvider)"> | ||
3122 | <summary> | ||
3123 | Decode body into a form. | ||
3124 | </summary> | ||
3125 | <param name="providers">A list with form decoders.</param> | ||
3126 | <exception cref="T:System.IO.InvalidDataException">If body contents is not valid for the chosen decoder.</exception> | ||
3127 | <exception cref="T:System.InvalidOperationException">If body is still being transferred.</exception> | ||
3128 | </member> | ||
3129 | <member name="M:HttpServer.HttpRequest.SetCookies(HttpServer.RequestCookies)"> | ||
3130 | <summary> | ||
3131 | Cookies | ||
3132 | </summary> | ||
3133 | <param name="cookies">the cookies</param> | ||
3134 | </member> | ||
3135 | <member name="M:HttpServer.HttpRequest.CreateResponse(HttpServer.IHttpClientContext)"> | ||
3136 | <summary> | ||
3137 | Create a response object. | ||
3138 | </summary> | ||
3139 | <returns>A new <see cref="T:HttpServer.IHttpResponse"/>.</returns> | ||
3140 | </member> | ||
3141 | <member name="M:HttpServer.HttpRequest.AddHeader(System.String,System.String)"> | ||
3142 | <summary> | ||
3143 | Called during parsing of a <see cref="T:HttpServer.IHttpRequest"/>. | ||
3144 | </summary> | ||
3145 | <param name="name">Name of the header, should not be URL encoded</param> | ||
3146 | <param name="value">Value of the header, should not be URL encoded</param> | ||
3147 | <exception cref="T:HttpServer.Exceptions.BadRequestException">If a header is incorrect.</exception> | ||
3148 | </member> | ||
3149 | <member name="M:HttpServer.HttpRequest.AddToBody(System.Byte[],System.Int32,System.Int32)"> | ||
3150 | <summary> | ||
3151 | Add bytes to the body | ||
3152 | </summary> | ||
3153 | <param name="bytes">buffer to read bytes from</param> | ||
3154 | <param name="offset">where to start read</param> | ||
3155 | <param name="length">number of bytes to read</param> | ||
3156 | <returns>Number of bytes actually read (same as length unless we got all body bytes).</returns> | ||
3157 | <exception cref="T:System.InvalidOperationException">If body is not writable</exception> | ||
3158 | <exception cref="T:System.ArgumentNullException"><c>bytes</c> is null.</exception> | ||
3159 | <exception cref="T:System.ArgumentOutOfRangeException"><c>offset</c> is out of range.</exception> | ||
3160 | </member> | ||
3161 | <member name="M:HttpServer.HttpRequest.Clear"> | ||
3162 | <summary> | ||
3163 | Clear everything in the request | ||
3164 | </summary> | ||
3165 | </member> | ||
3166 | <member name="T:HttpServer.HttpResponse"> | ||
3167 | <summary> | ||
3168 | Response that is sent back to the web browser / client. | ||
3169 | </summary> | ||
3170 | <remarks> | ||
3171 | <para> | ||
3172 | A response can be sent if different ways. The easiest one is | ||
3173 | to just fill the Body stream with content, everything else | ||
3174 | will then be taken care of by the framework. The default content-type | ||
3175 | is text/html, you should change it if you send anything else. | ||
3176 | </para><para> | ||
3177 | The second and slightly more complex way is to send the response | ||
3178 | as parts. Start with sending the header using the SendHeaders method and | ||
3179 | then you can send the body using SendBody method, but do not forget | ||
3180 | to set <see cref="P:HttpServer.HttpResponse.ContentType"/> and <see cref="P:HttpServer.HttpResponse.ContentLength"/> before doing so. | ||
3181 | </para> | ||
3182 | </remarks> | ||
3183 | <example> | ||
3184 | <code> | ||
3185 | // Example using response body. | ||
3186 | class MyModule : HttpModule | ||
3187 | { | ||
3188 | public override bool Process(IHttpRequest request, IHttpResponse response, IHttpSession session) | ||
3189 | { | ||
3190 | StreamWriter writer = new StreamWriter(response.Body); | ||
3191 | writer.WriteLine("Hello dear World!"); | ||
3192 | writer.Flush(); | ||
3193 | |||
3194 | // return true to tell webserver that we've handled the url | ||
3195 | return true; | ||
3196 | } | ||
3197 | } | ||
3198 | </code> | ||
3199 | </example> | ||
3200 | todo: add two examples, using SendHeaders/SendBody and just the Body stream. | ||
3201 | </member> | ||
3202 | <member name="M:HttpServer.HttpResponse.#ctor(HttpServer.IHttpClientContext,HttpServer.IHttpRequest)"> | ||
3203 | <summary> | ||
3204 | Initializes a new instance of the <see cref="T:HttpServer.IHttpResponse"/> class. | ||
3205 | </summary> | ||
3206 | <param name="context">Client that send the <see cref="T:HttpServer.IHttpRequest"/>.</param> | ||
3207 | <param name="request">Contains information of what the client want to receive.</param> | ||
3208 | <exception cref="T:System.ArgumentException"><see cref="P:HttpServer.IHttpRequest.HttpVersion"/> cannot be empty.</exception> | ||
3209 | </member> | ||
3210 | <member name="M:HttpServer.HttpResponse.#ctor(HttpServer.IHttpClientContext,System.String,HttpServer.ConnectionType)"> | ||
3211 | <summary> | ||
3212 | Initializes a new instance of the <see cref="T:HttpServer.IHttpResponse"/> class. | ||
3213 | </summary> | ||
3214 | <param name="context">Client that send the <see cref="T:HttpServer.IHttpRequest"/>.</param> | ||
3215 | <param name="httpVersion">Version of HTTP protocol that the client uses.</param> | ||
3216 | <param name="connectionType">Type of HTTP connection used.</param> | ||
3217 | </member> | ||
3218 | <member name="P:HttpServer.HttpResponse.Body"> | ||
3219 | <summary> | ||
3220 | The body stream is used to cache the body contents | ||
3221 | before sending everything to the client. It's the simplest | ||
3222 | way to serve documents. | ||
3223 | </summary> | ||
3224 | </member> | ||
3225 | <member name="P:HttpServer.HttpResponse.Chunked"> | ||
3226 | <summary> | ||
3227 | The chunked encoding modifies the body of a message in order to | ||
3228 | transfer it as a series of chunks, each with its own size indicator, | ||
3229 | followed by an OPTIONAL trailer containing entity-header fields. This | ||
3230 | allows dynamically produced content to be transferred along with the | ||
3231 | information necessary for the recipient to verify that it has | ||
3232 | received the full message. | ||
3233 | </summary> | ||
3234 | </member> | ||
3235 | <member name="P:HttpServer.HttpResponse.ProtocolVersion"> | ||
3236 | <summary> | ||
3237 | Defines the version of the HTTP Response for applications where it's required | ||
3238 | for this to be forced. | ||
3239 | </summary> | ||
3240 | </member> | ||
3241 | <member name="P:HttpServer.HttpResponse.Connection"> | ||
3242 | <summary> | ||
3243 | Kind of connection | ||
3244 | </summary> | ||
3245 | </member> | ||
3246 | <member name="P:HttpServer.HttpResponse.Encoding"> | ||
3247 | <summary> | ||
3248 | Encoding to use when sending stuff to the client. | ||
3249 | </summary> | ||
3250 | <remarks>Default is UTF8</remarks> | ||
3251 | </member> | ||
3252 | <member name="P:HttpServer.HttpResponse.KeepAlive"> | ||
3253 | <summary> | ||
3254 | Number of seconds to keep connection alive | ||
3255 | </summary> | ||
3256 | <remarks>Only used if Connection property is set to <see cref="F:HttpServer.ConnectionType.KeepAlive"/>.</remarks> | ||
3257 | </member> | ||
3258 | <member name="P:HttpServer.HttpResponse.Status"> | ||
3259 | <summary> | ||
3260 | Status code that is sent to the client. | ||
3261 | </summary> | ||
3262 | <remarks>Default is <see cref="F:System.Net.HttpStatusCode.OK"/></remarks> | ||
3263 | </member> | ||
3264 | <member name="P:HttpServer.HttpResponse.Reason"> | ||
3265 | <summary> | ||
3266 | Information about why a specific status code was used. | ||
3267 | </summary> | ||
3268 | </member> | ||
3269 | <member name="P:HttpServer.HttpResponse.ContentLength"> | ||
3270 | <summary> | ||
3271 | Size of the body. MUST be specified before sending the header, | ||
3272 | unless property Chunked is set to true. | ||
3273 | </summary> | ||
3274 | </member> | ||
3275 | <member name="P:HttpServer.HttpResponse.ContentType"> | ||
3276 | <summary> | ||
3277 | Kind of content in the body | ||
3278 | </summary> | ||
3279 | <remarks>Default type is "text/html"</remarks> | ||
3280 | </member> | ||
3281 | <member name="P:HttpServer.HttpResponse.HeadersSent"> | ||
3282 | <summary> | ||
3283 | Headers have been sent to the client- | ||
3284 | </summary> | ||
3285 | <remarks>You can not send any additional headers if they have already been sent.</remarks> | ||
3286 | </member> | ||
3287 | <member name="P:HttpServer.HttpResponse.Sent"> | ||
3288 | <summary> | ||
3289 | The whole response have been sent. | ||
3290 | </summary> | ||
3291 | </member> | ||
3292 | <member name="P:HttpServer.HttpResponse.Cookies"> | ||
3293 | <summary> | ||
3294 | Cookies that should be created/changed. | ||
3295 | </summary> | ||
3296 | </member> | ||
3297 | <member name="M:HttpServer.HttpResponse.AddHeader(System.String,System.String)"> | ||
3298 | <summary> | ||
3299 | Add another header to the document. | ||
3300 | </summary> | ||
3301 | <param name="name">Name of the header, case sensitive, use lower cases.</param> | ||
3302 | <param name="value">Header values can span over multiple lines as long as each line starts with a white space. New line chars should be \r\n</param> | ||
3303 | <exception cref="T:System.InvalidOperationException">If headers already been sent.</exception> | ||
3304 | <exception cref="T:System.ArgumentException">If value conditions have not been met.</exception> | ||
3305 | <remarks>Adding any header will override the default ones and those specified by properties.</remarks> | ||
3306 | </member> | ||
3307 | <member name="M:HttpServer.HttpResponse.Send"> | ||
3308 | <summary> | ||
3309 | Send headers and body to the browser. | ||
3310 | </summary> | ||
3311 | <exception cref="T:System.InvalidOperationException">If content have already been sent.</exception> | ||
3312 | </member> | ||
3313 | <member name="M:HttpServer.HttpResponse.SendBody(System.Byte[],System.Int32,System.Int32)"> | ||
3314 | <summary> | ||
3315 | Make sure that you have specified <see cref="P:HttpServer.HttpResponse.ContentLength"/> and sent the headers first. | ||
3316 | </summary> | ||
3317 | <param name="buffer"></param> | ||
3318 | <exception cref="T:System.InvalidOperationException">If headers have not been sent.</exception> | ||
3319 | <see cref="M:HttpServer.HttpResponse.SendHeaders"/> | ||
3320 | <param name="offset">offset of first byte to send</param> | ||
3321 | <param name="count">number of bytes to send.</param> | ||
3322 | <seealso cref="M:HttpServer.HttpResponse.Send"/> | ||
3323 | <seealso cref="M:HttpServer.HttpResponse.SendHeaders"/> | ||
3324 | <remarks>This method can be used if you want to send body contents without caching them first. This | ||
3325 | is recommended for larger files to keep the memory usage low.</remarks> | ||
3326 | </member> | ||
3327 | <member name="M:HttpServer.HttpResponse.SendBody(System.Byte[])"> | ||
3328 | <summary> | ||
3329 | Make sure that you have specified <see cref="P:HttpServer.HttpResponse.ContentLength"/> and sent the headers first. | ||
3330 | </summary> | ||
3331 | <param name="buffer"></param> | ||
3332 | <exception cref="T:System.InvalidOperationException">If headers have not been sent.</exception> | ||
3333 | <see cref="M:HttpServer.HttpResponse.SendHeaders"/> | ||
3334 | <seealso cref="M:HttpServer.HttpResponse.Send"/> | ||
3335 | <seealso cref="M:HttpServer.HttpResponse.SendHeaders"/> | ||
3336 | <remarks>This method can be used if you want to send body contents without caching them first. This | ||
3337 | is recommended for larger files to keep the memory usage low.</remarks> | ||
3338 | </member> | ||
3339 | <member name="M:HttpServer.HttpResponse.SendHeaders"> | ||
3340 | <summary> | ||
3341 | Send headers to the client. | ||
3342 | </summary> | ||
3343 | <exception cref="T:System.InvalidOperationException">If headers already been sent.</exception> | ||
3344 | <seealso cref="M:HttpServer.HttpResponse.AddHeader(System.String,System.String)"/> | ||
3345 | <seealso cref="M:HttpServer.HttpResponse.Send"/> | ||
3346 | <seealso cref="M:HttpServer.HttpResponse.SendBody(System.Byte[])"/> | ||
3347 | </member> | ||
3348 | <member name="M:HttpServer.HttpResponse.Redirect(System.Uri)"> | ||
3349 | <summary> | ||
3350 | Redirect client to somewhere else using the 302 status code. | ||
3351 | </summary> | ||
3352 | <param name="uri">Destination of the redirect</param> | ||
3353 | <exception cref="T:System.InvalidOperationException">If headers already been sent.</exception> | ||
3354 | <remarks>You can not do anything more with the request when a redirect have been done. This should be your last | ||
3355 | action.</remarks> | ||
3356 | </member> | ||
3357 | <member name="M:HttpServer.HttpResponse.Redirect(System.String)"> | ||
3358 | <summary> | ||
3359 | redirect to somewhere | ||
3360 | </summary> | ||
3361 | <param name="url">where the redirect should go</param> | ||
3362 | <remarks> | ||
3363 | No body are allowed when doing redirects. | ||
3364 | </remarks> | ||
3365 | </member> | ||
3366 | <member name="T:HttpServer.RealmHandler"> | ||
3367 | <summary> | ||
3368 | Delegate used to find a realm/domain. | ||
3369 | </summary> | ||
3370 | <param name="domain"></param> | ||
3371 | <returns></returns> | ||
3372 | <remarks> | ||
3373 | Realms are used during HTTP Authentication | ||
3374 | </remarks> | ||
3375 | <seealso cref="T:HttpServer.Authentication.AuthenticationModule"/> | ||
3376 | <seealso cref="T:HttpServer.Authentication.AuthenticationHandler"/> | ||
3377 | </member> | ||
3378 | <member name="T:HttpServer.HttpServer"> | ||
3379 | <summary> | ||
3380 | A complete HTTP server, you need to add a module to it to be able to handle incoming requests. | ||
3381 | </summary> | ||
3382 | <example> | ||
3383 | <code> | ||
3384 | // this small example will add two web site modules, thus handling | ||
3385 | // two different sites. In reality you should add Controller modules or something | ||
3386 | // two the website modules to be able to handle different requests. | ||
3387 | HttpServer server = new HttpServer(); | ||
3388 | server.Add(new WebSiteModule("www.gauffin.com", "Gauffin Telecom AB")); | ||
3389 | server.Add(new WebSiteModule("www.vapadi.se", "Remote PBX")); | ||
3390 | |||
3391 | // start regular http | ||
3392 | server.Start(IPAddress.Any, 80); | ||
3393 | |||
3394 | // start https | ||
3395 | server.Start(IPAddress.Any, 443, myCertificate); | ||
3396 | </code> | ||
3397 | </example> | ||
3398 | <seealso cref="T:HttpServer.HttpModules.HttpModule"/> | ||
3399 | <seealso cref="T:HttpServer.HttpModules.FileModule"/> | ||
3400 | <seealso cref="T:HttpServer.HttpListener"/> | ||
3401 | </member> | ||
3402 | <member name="P:HttpServer.HttpServer.Current"> | ||
3403 | <summary> | ||
3404 | Server that is handling the current request. | ||
3405 | </summary> | ||
3406 | <remarks> | ||
3407 | Will be set as soon as a request arrives to the <see cref="T:HttpServer.HttpServer"/> object. | ||
3408 | </remarks> | ||
3409 | </member> | ||
3410 | <member name="M:HttpServer.HttpServer.#ctor(HttpServer.IComponentProvider)"> | ||
3411 | <summary> | ||
3412 | Initializes a new instance of the <see cref="T:HttpServer.HttpServer"/> class. | ||
3413 | </summary> | ||
3414 | <param name="provider">Used to get all components used in the server..</param> | ||
3415 | </member> | ||
3416 | <member name="M:HttpServer.HttpServer.#ctor"> | ||
3417 | <summary> | ||
3418 | Initializes a new instance of the <see cref="T:HttpServer.HttpServer"/> class. | ||
3419 | </summary> | ||
3420 | </member> | ||
3421 | <member name="M:HttpServer.HttpServer.#ctor(HttpServer.FormDecoders.FormDecoderProvider)"> | ||
3422 | <summary> | ||
3423 | Initializes a new instance of the <see cref="T:HttpServer.HttpServer"/> class. | ||
3424 | </summary> | ||
3425 | <param name="decoderProvider">Form decoders are used to convert different types of posted data to the <see cref="T:HttpServer.HttpInput"/> object types.</param> | ||
3426 | <seealso cref="T:HttpServer.FormDecoders.IFormDecoder"/> | ||
3427 | <seealso cref="P:HttpServer.HttpServer.FormDecoderProviders"/> | ||
3428 | </member> | ||
3429 | <member name="M:HttpServer.HttpServer.#ctor(HttpServer.Sessions.IHttpSessionStore)"> | ||
3430 | <summary> | ||
3431 | Initializes a new instance of the <see cref="T:HttpServer.HttpServer"/> class. | ||
3432 | </summary> | ||
3433 | <param name="sessionStore">A session store is used to save and retrieve sessions</param> | ||
3434 | <seealso cref="T:HttpServer.Sessions.IHttpSessionStore"/> | ||
3435 | </member> | ||
3436 | <member name="M:HttpServer.HttpServer.#ctor(HttpServer.ILogWriter)"> | ||
3437 | <summary> | ||
3438 | Initializes a new instance of the <see cref="T:HttpServer.HttpServer"/> class. | ||
3439 | </summary> | ||
3440 | <param name="logWriter">The log writer.</param> | ||
3441 | <seealso cref="P:HttpServer.HttpServer.LogWriter"/> | ||
3442 | </member> | ||
3443 | <member name="M:HttpServer.HttpServer.#ctor(HttpServer.FormDecoders.FormDecoderProvider,HttpServer.ILogWriter)"> | ||
3444 | <summary> | ||
3445 | Initializes a new instance of the <see cref="T:HttpServer.HttpServer"/> class. | ||
3446 | </summary> | ||
3447 | <param name="decoderProvider">Form decoders are used to convert different types of posted data to the <see cref="T:HttpServer.HttpInput"/> object types.</param> | ||
3448 | <param name="logWriter">The log writer.</param> | ||
3449 | <seealso cref="T:HttpServer.FormDecoders.IFormDecoder"/> | ||
3450 | <seealso cref="P:HttpServer.HttpServer.FormDecoderProviders"/> | ||
3451 | <seealso cref="P:HttpServer.HttpServer.LogWriter"/> | ||
3452 | </member> | ||
3453 | <member name="M:HttpServer.HttpServer.#ctor(HttpServer.FormDecoders.FormDecoderProvider,HttpServer.Sessions.IHttpSessionStore,HttpServer.ILogWriter)"> | ||
3454 | <summary> | ||
3455 | Initializes a new instance of the <see cref="T:HttpServer.HttpServer"/> class. | ||
3456 | </summary> | ||
3457 | <param name="decoderProvider">Form decoders are used to convert different types of posted data to the <see cref="T:HttpServer.HttpInput"/> object types.</param> | ||
3458 | <param name="sessionStore">A session store is used to save and retrieve sessions</param> | ||
3459 | <param name="logWriter">The log writer.</param> | ||
3460 | <seealso cref="T:HttpServer.FormDecoders.IFormDecoder"/> | ||
3461 | <seealso cref="P:HttpServer.HttpServer.FormDecoderProviders"/> | ||
3462 | <seealso cref="P:HttpServer.HttpServer.LogWriter"/> | ||
3463 | <seealso cref="T:HttpServer.Sessions.IHttpSessionStore"/> | ||
3464 | </member> | ||
3465 | <member name="P:HttpServer.HttpServer.AuthenticationModules"> | ||
3466 | <summary> | ||
3467 | Modules used for authentication. The module that is is added first is used as | ||
3468 | the default authentication module. | ||
3469 | </summary> | ||
3470 | <remarks>Use the corresponding property | ||
3471 | in the <see cref="T:HttpServer.HttpModules.WebSiteModule"/> if you are using multiple websites.</remarks> | ||
3472 | </member> | ||
3473 | <member name="P:HttpServer.HttpServer.FormDecoderProviders"> | ||
3474 | <summary> | ||
3475 | Form decoder providers are used to decode request body (which normally contains form data). | ||
3476 | </summary> | ||
3477 | </member> | ||
3478 | <member name="P:HttpServer.HttpServer.ServerName"> | ||
3479 | <summary> | ||
3480 | Server name sent in HTTP responses. | ||
3481 | </summary> | ||
3482 | <remarks> | ||
3483 | Do NOT include version in name, since it makes it | ||
3484 | easier for hackers. | ||
3485 | </remarks> | ||
3486 | </member> | ||
3487 | <member name="P:HttpServer.HttpServer.SessionCookieName"> | ||
3488 | <summary> | ||
3489 | Name of cookie where session id is stored. | ||
3490 | </summary> | ||
3491 | </member> | ||
3492 | <member name="P:HttpServer.HttpServer.LogWriter"> | ||
3493 | <summary> | ||
3494 | Specified where logging should go. | ||
3495 | </summary> | ||
3496 | <seealso cref="T:HttpServer.NullLogWriter"/> | ||
3497 | <seealso cref="T:HttpServer.ConsoleLogWriter"/> | ||
3498 | <seealso cref="P:HttpServer.HttpServer.LogWriter"/> | ||
3499 | </member> | ||
3500 | <member name="P:HttpServer.HttpServer.BackLog"> | ||
3501 | <summary> | ||
3502 | Number of connections that can wait to be accepted by the server. | ||
3503 | </summary> | ||
3504 | <remarks>Default is 10.</remarks> | ||
3505 | </member> | ||
3506 | <member name="P:HttpServer.HttpServer.MaxRequestCount"> | ||
3507 | <summary> | ||
3508 | Gets or sets maximum number of allowed simultaneous requests. | ||
3509 | </summary> | ||
3510 | <remarks> | ||
3511 | <para> | ||
3512 | This property is useful in busy systems. The HTTP server | ||
3513 | will start queuing new requests if this limit is hit, instead | ||
3514 | of trying to process all incoming requests directly. | ||
3515 | </para> | ||
3516 | <para> | ||
3517 | The default number if allowed simultaneous requests are 10. | ||
3518 | </para> | ||
3519 | </remarks> | ||
3520 | </member> | ||
3521 | <member name="P:HttpServer.HttpServer.MaxQueueSize"> | ||
3522 | <summary> | ||
3523 | Gets or sets maximum number of requests queuing to be handled. | ||
3524 | </summary> | ||
3525 | <remarks> | ||
3526 | <para> | ||
3527 | The WebServer will start turning requests away if response code | ||
3528 | <see cref="F:System.Net.HttpStatusCode.ServiceUnavailable"/> to indicate that the server | ||
3529 | is too busy to be able to handle the request. | ||
3530 | </para> | ||
3531 | </remarks> | ||
3532 | </member> | ||
3533 | <member name="M:HttpServer.HttpServer.Add(HttpServer.Rules.IRule)"> | ||
3534 | <summary> | ||
3535 | Adds the specified rule. | ||
3536 | </summary> | ||
3537 | <param name="rule">The rule.</param> | ||
3538 | </member> | ||
3539 | <member name="M:HttpServer.HttpServer.Add(HttpServer.HttpModules.HttpModule)"> | ||
3540 | <summary> | ||
3541 | Add a <see cref="T:HttpServer.HttpModules.HttpModule"/> to the server. | ||
3542 | </summary> | ||
3543 | <param name="module">mode to add</param> | ||
3544 | </member> | ||
3545 | <member name="M:HttpServer.HttpServer.DecodeBody(HttpServer.IHttpRequest)"> | ||
3546 | <summary> | ||
3547 | Decodes the request body. | ||
3548 | </summary> | ||
3549 | <param name="request">The request.</param> | ||
3550 | <exception cref="T:HttpServer.Exceptions.InternalServerException">Failed to decode form data.</exception> | ||
3551 | </member> | ||
3552 | <member name="M:HttpServer.HttpServer.ErrorPage(HttpServer.IHttpResponse,System.Net.HttpStatusCode,System.String)"> | ||
3553 | <summary> | ||
3554 | Generate a HTTP error page (that will be added to the response body). | ||
3555 | response status code is also set. | ||
3556 | </summary> | ||
3557 | <param name="response">Response that the page will be generated in.</param> | ||
3558 | <param name="error"><see cref="T:System.Net.HttpStatusCode"/>.</param> | ||
3559 | <param name="body">response body contents.</param> | ||
3560 | </member> | ||
3561 | <member name="M:HttpServer.HttpServer.ErrorPage(HttpServer.IHttpResponse,HttpServer.Exceptions.HttpException)"> | ||
3562 | <summary> | ||
3563 | Generate a HTTP error page (that will be added to the response body). | ||
3564 | response status code is also set. | ||
3565 | </summary> | ||
3566 | <param name="response">Response that the page will be generated in.</param> | ||
3567 | <param name="err">exception.</param> | ||
3568 | </member> | ||
3569 | <member name="M:HttpServer.HttpServer.GetRealm(HttpServer.IHttpRequest)"> | ||
3570 | <summary> | ||
3571 | Realms are used by the <see cref="T:HttpServer.Authentication.AuthenticationModule"/>s. | ||
3572 | </summary> | ||
3573 | <param name="request">HTTP request</param> | ||
3574 | <returns>domain/realm.</returns> | ||
3575 | </member> | ||
3576 | <member name="M:HttpServer.HttpServer.HandleRequest(HttpServer.IHttpClientContext,HttpServer.IHttpRequest,HttpServer.IHttpResponse,HttpServer.Sessions.IHttpSession)"> | ||
3577 | <summary> | ||
3578 | Process an incoming request. | ||
3579 | </summary> | ||
3580 | <param name="context">connection to client</param> | ||
3581 | <param name="request">request information</param> | ||
3582 | <param name="response">response that should be filled</param> | ||
3583 | <param name="session">session information</param> | ||
3584 | </member> | ||
3585 | <member name="M:HttpServer.HttpServer.OnClientDisconnected(HttpServer.IHttpClientContext,System.Net.Sockets.SocketError)"> | ||
3586 | <summary> | ||
3587 | Can be overloaded to implement stuff when a client have been connected. | ||
3588 | </summary> | ||
3589 | <remarks> | ||
3590 | Default implementation does nothing. | ||
3591 | </remarks> | ||
3592 | <param name="client">client that disconnected</param> | ||
3593 | <param name="error">disconnect reason</param> | ||
3594 | </member> | ||
3595 | <member name="M:HttpServer.HttpServer.ProcessAuthentication(HttpServer.IHttpRequest,HttpServer.IHttpResponse,HttpServer.Sessions.IHttpSession)"> | ||
3596 | <summary> | ||
3597 | Handle authentication | ||
3598 | </summary> | ||
3599 | <param name="request"></param> | ||
3600 | <param name="response"></param> | ||
3601 | <param name="session"></param> | ||
3602 | <returns>true if request can be handled; false if not.</returns> | ||
3603 | <exception cref="T:HttpServer.Exceptions.BadRequestException">Invalid authorization header</exception> | ||
3604 | </member> | ||
3605 | <member name="M:HttpServer.HttpServer.RequestAuthentication(HttpServer.Authentication.AuthenticationModule,HttpServer.IHttpRequest,HttpServer.IHttpResponse)"> | ||
3606 | <summary> | ||
3607 | Will request authentication. | ||
3608 | </summary> | ||
3609 | <remarks> | ||
3610 | Sends respond to client, nothing else can be done with the response after this. | ||
3611 | </remarks> | ||
3612 | <param name="mod"></param> | ||
3613 | <param name="request"></param> | ||
3614 | <param name="response"></param> | ||
3615 | </member> | ||
3616 | <member name="M:HttpServer.HttpServer.OnRequest(System.Object,HttpServer.RequestEventArgs)"> | ||
3617 | <summary> | ||
3618 | Received from a <see cref="T:HttpServer.IHttpClientContext"/> when a request have been parsed successfully. | ||
3619 | </summary> | ||
3620 | <param name="source"><see cref="T:HttpServer.IHttpClientContext"/> that received the request.</param> | ||
3621 | <param name="args">The request.</param> | ||
3622 | </member> | ||
3623 | <member name="M:HttpServer.HttpServer.ProcessRequestWrapper(HttpServer.IHttpClientContext,HttpServer.IHttpRequest)"> | ||
3624 | <summary> | ||
3625 | To be able to track request count. | ||
3626 | </summary> | ||
3627 | <param name="context"></param> | ||
3628 | <param name="request"></param> | ||
3629 | </member> | ||
3630 | <member name="M:HttpServer.HttpServer.Start(System.Net.IPAddress,System.Int32)"> | ||
3631 | <summary> | ||
3632 | Start the web server using regular HTTP. | ||
3633 | </summary> | ||
3634 | <param name="address">IP Address to listen on, use <c>IpAddress.Any </c>to accept connections on all IP addresses/network cards.</param> | ||
3635 | <param name="port">Port to listen on. 80 can be a good idea =)</param> | ||
3636 | <exception cref="T:System.ArgumentNullException"><c>address</c> is null.</exception> | ||
3637 | <exception cref="T:System.ArgumentException">Port must be a positive number.</exception> | ||
3638 | </member> | ||
3639 | <member name="M:HttpServer.HttpServer.Start(System.Net.IPAddress,System.Int32,System.Security.Cryptography.X509Certificates.X509Certificate)"> | ||
3640 | <summary> | ||
3641 | Accept secure connections. | ||
3642 | </summary> | ||
3643 | <param name="address">IP Address to listen on, use <see cref="F:System.Net.IPAddress.Any"/> to accept connections on all IP Addresses / network cards.</param> | ||
3644 | <param name="port">Port to listen on. 80 can be a good idea =)</param> | ||
3645 | <param name="certificate">Certificate to use</param> | ||
3646 | <exception cref="T:System.ArgumentNullException"><c>address</c> is null.</exception> | ||
3647 | <exception cref="T:System.ArgumentException">Port must be a positive number.</exception> | ||
3648 | </member> | ||
3649 | <member name="M:HttpServer.HttpServer.Stop"> | ||
3650 | <summary> | ||
3651 | shut down the server and listeners | ||
3652 | </summary> | ||
3653 | </member> | ||
3654 | <member name="M:HttpServer.HttpServer.WriteLog(HttpServer.LogPrio,System.String)"> | ||
3655 | <summary> | ||
3656 | write an entry to the log file | ||
3657 | </summary> | ||
3658 | <param name="prio">importance of the message</param> | ||
3659 | <param name="message">log message</param> | ||
3660 | </member> | ||
3661 | <member name="M:HttpServer.HttpServer.WriteLog(System.Object,HttpServer.LogPrio,System.String)"> | ||
3662 | <summary> | ||
3663 | write an entry to the log file | ||
3664 | </summary> | ||
3665 | <param name="source">object that wrote the message</param> | ||
3666 | <param name="prio">importance of the message</param> | ||
3667 | <param name="message">log message</param> | ||
3668 | </member> | ||
3669 | <member name="E:HttpServer.HttpServer.RealmWanted"> | ||
3670 | <summary> | ||
3671 | Realms are used during HTTP authentication. | ||
3672 | Default realm is same as server name. | ||
3673 | </summary> | ||
3674 | </member> | ||
3675 | <member name="E:HttpServer.HttpServer.ExceptionThrown"> | ||
3676 | <summary> | ||
3677 | Let's to receive unhandled exceptions from the threads. | ||
3678 | </summary> | ||
3679 | <remarks> | ||
3680 | Exceptions will be thrown during debug mode if this event is not used, | ||
3681 | exceptions will be printed to console and suppressed during release mode. | ||
3682 | </remarks> | ||
3683 | </member> | ||
3684 | <member name="T:HttpServer.IComponentProvider"> | ||
3685 | <summary> | ||
3686 | Inversion of control interface. | ||
3687 | </summary> | ||
3688 | </member> | ||
3689 | <member name="M:HttpServer.IComponentProvider.AddInstance``1(System.Object)"> | ||
3690 | <summary> | ||
3691 | Add a component instance | ||
3692 | </summary> | ||
3693 | <typeparam name="T">Interface type</typeparam> | ||
3694 | <param name="instance">Instance to add</param> | ||
3695 | </member> | ||
3696 | <member name="M:HttpServer.IComponentProvider.Get``1"> | ||
3697 | <summary> | ||
3698 | Get a component. | ||
3699 | </summary> | ||
3700 | <typeparam name="T">Interface type</typeparam> | ||
3701 | <returns>Component if registered, otherwise null.</returns> | ||
3702 | <remarks> | ||
3703 | Component will get created if needed. | ||
3704 | </remarks> | ||
3705 | </member> | ||
3706 | <member name="M:HttpServer.IComponentProvider.Contains(System.Type)"> | ||
3707 | <summary> | ||
3708 | Checks if the specified component interface have been added. | ||
3709 | </summary> | ||
3710 | <param name="interfaceType"></param> | ||
3711 | <returns>true if found; otherwise false.</returns> | ||
3712 | </member> | ||
3713 | <member name="M:HttpServer.IComponentProvider.Add``2"> | ||
3714 | <summary> | ||
3715 | Add a component. | ||
3716 | </summary> | ||
3717 | <typeparam name="InterfaceType">Type being requested.</typeparam> | ||
3718 | <typeparam name="InstanceType">Type being created.</typeparam> | ||
3719 | </member> | ||
3720 | <member name="T:HttpServer.IHttpClientContext"> | ||
3721 | <summary> | ||
3722 | Contains a connection to a browser/client. | ||
3723 | </summary> | ||
3724 | </member> | ||
3725 | <member name="P:HttpServer.IHttpClientContext.Secured"> | ||
3726 | <summary> | ||
3727 | Using SSL or other encryption method. | ||
3728 | </summary> | ||
3729 | </member> | ||
3730 | <member name="P:HttpServer.IHttpClientContext.IsSecured"> | ||
3731 | <summary> | ||
3732 | Using SSL or other encryption method. | ||
3733 | </summary> | ||
3734 | </member> | ||
3735 | <member name="M:HttpServer.IHttpClientContext.Disconnect(System.Net.Sockets.SocketError)"> | ||
3736 | <summary> | ||
3737 | Disconnect from client | ||
3738 | </summary> | ||
3739 | <param name="error">error to report in the <see cref="E:HttpServer.IHttpClientContext.Disconnected"/> event.</param> | ||
3740 | </member> | ||
3741 | <member name="M:HttpServer.IHttpClientContext.Respond(System.String,System.Net.HttpStatusCode,System.String,System.String,System.String)"> | ||
3742 | <summary> | ||
3743 | Send a response. | ||
3744 | </summary> | ||
3745 | <param name="httpVersion">Either <see cref="F:HttpServer.HttpHelper.HTTP10"/> or <see cref="F:HttpServer.HttpHelper.HTTP11"/></param> | ||
3746 | <param name="statusCode">HTTP status code</param> | ||
3747 | <param name="reason">reason for the status code.</param> | ||
3748 | <param name="body">HTML body contents, can be null or empty.</param> | ||
3749 | <param name="contentType">A content type to return the body as, i.e. 'text/html' or 'text/plain', defaults to 'text/html' if null or empty</param> | ||
3750 | <exception cref="T:System.ArgumentException">If <paramref name="httpVersion"/> is invalid.</exception> | ||
3751 | </member> | ||
3752 | <member name="M:HttpServer.IHttpClientContext.Respond(System.String,System.Net.HttpStatusCode,System.String)"> | ||
3753 | <summary> | ||
3754 | Send a response. | ||
3755 | </summary> | ||
3756 | <param name="httpVersion">Either <see cref="F:HttpServer.HttpHelper.HTTP10"/> or <see cref="F:HttpServer.HttpHelper.HTTP11"/></param> | ||
3757 | <param name="statusCode">HTTP status code</param> | ||
3758 | <param name="reason">reason for the status code.</param> | ||
3759 | </member> | ||
3760 | <member name="M:HttpServer.IHttpClientContext.Respond(System.String)"> | ||
3761 | <summary> | ||
3762 | Send a response. | ||
3763 | </summary> | ||
3764 | <exception cref="T:System.ArgumentNullException"></exception> | ||
3765 | </member> | ||
3766 | <member name="M:HttpServer.IHttpClientContext.Send(System.Byte[])"> | ||
3767 | <summary> | ||
3768 | send a whole buffer | ||
3769 | </summary> | ||
3770 | <param name="buffer">buffer to send</param> | ||
3771 | <exception cref="T:System.ArgumentNullException"></exception> | ||
3772 | </member> | ||
3773 | <member name="M:HttpServer.IHttpClientContext.Send(System.Byte[],System.Int32,System.Int32)"> | ||
3774 | <summary> | ||
3775 | Send data using the stream | ||
3776 | </summary> | ||
3777 | <param name="buffer">Contains data to send</param> | ||
3778 | <param name="offset">Start position in buffer</param> | ||
3779 | <param name="size">number of bytes to send</param> | ||
3780 | <exception cref="T:System.ArgumentNullException"></exception> | ||
3781 | <exception cref="T:System.ArgumentOutOfRangeException"></exception> | ||
3782 | </member> | ||
3783 | <member name="M:HttpServer.IHttpClientContext.Close"> | ||
3784 | <summary> | ||
3785 | Closes the streams and disposes of the unmanaged resources | ||
3786 | </summary> | ||
3787 | </member> | ||
3788 | <member name="E:HttpServer.IHttpClientContext.Disconnected"> | ||
3789 | <summary> | ||
3790 | The context have been disconnected. | ||
3791 | </summary> | ||
3792 | <remarks> | ||
3793 | Event can be used to clean up a context, or to reuse it. | ||
3794 | </remarks> | ||
3795 | </member> | ||
3796 | <member name="E:HttpServer.IHttpClientContext.RequestReceived"> | ||
3797 | <summary> | ||
3798 | A request have been received in the context. | ||
3799 | </summary> | ||
3800 | </member> | ||
3801 | <member name="T:HttpServer.DisconnectedEventArgs"> | ||
3802 | <summary> | ||
3803 | A <see cref="T:HttpServer.IHttpClientContext"/> have been disconnected. | ||
3804 | </summary> | ||
3805 | </member> | ||
3806 | <member name="P:HttpServer.DisconnectedEventArgs.Error"> | ||
3807 | <summary> | ||
3808 | Gets reason to why client disconnected. | ||
3809 | </summary> | ||
3810 | </member> | ||
3811 | <member name="M:HttpServer.DisconnectedEventArgs.#ctor(System.Net.Sockets.SocketError)"> | ||
3812 | <summary> | ||
3813 | Initializes a new instance of the <see cref="T:HttpServer.DisconnectedEventArgs"/> class. | ||
3814 | </summary> | ||
3815 | <param name="error">Reason to disconnection.</param> | ||
3816 | </member> | ||
3817 | <member name="T:HttpServer.RequestEventArgs"> | ||
3818 | <summary> | ||
3819 | |||
3820 | </summary> | ||
3821 | </member> | ||
3822 | <member name="P:HttpServer.RequestEventArgs.Request"> | ||
3823 | <summary> | ||
3824 | Gets received request. | ||
3825 | </summary> | ||
3826 | </member> | ||
3827 | <member name="M:HttpServer.RequestEventArgs.#ctor(HttpServer.IHttpRequest)"> | ||
3828 | <summary> | ||
3829 | Initializes a new instance of the <see cref="T:HttpServer.RequestEventArgs"/> class. | ||
3830 | </summary> | ||
3831 | <param name="request">The request.</param> | ||
3832 | </member> | ||
3833 | <member name="T:HttpServer.IHttpContextHandler"> | ||
3834 | <summary> | ||
3835 | Class that receives Requests from a <see cref="T:HttpServer.IHttpClientContext"/>. | ||
3836 | </summary> | ||
3837 | </member> | ||
3838 | <member name="M:HttpServer.IHttpContextHandler.ClientDisconnected(HttpServer.IHttpClientContext,System.Net.Sockets.SocketError)"> | ||
3839 | <summary> | ||
3840 | Client have been disconnected. | ||
3841 | </summary> | ||
3842 | <param name="client">Client that was disconnected.</param> | ||
3843 | <param name="error">Reason</param> | ||
3844 | <see cref="T:HttpServer.IHttpClientContext"/> | ||
3845 | </member> | ||
3846 | <member name="M:HttpServer.IHttpContextHandler.RequestReceived(HttpServer.IHttpClientContext,HttpServer.IHttpRequest)"> | ||
3847 | <summary> | ||
3848 | Invoked when a client context have received a new HTTP request | ||
3849 | </summary> | ||
3850 | <param name="client">Client that received the request.</param> | ||
3851 | <param name="request">Request that was received.</param> | ||
3852 | <see cref="T:HttpServer.IHttpClientContext"/> | ||
3853 | </member> | ||
3854 | <member name="T:HttpServer.IHttpRequest"> | ||
3855 | <summary> | ||
3856 | Contains server side HTTP request information. | ||
3857 | </summary> | ||
3858 | </member> | ||
3859 | <member name="P:HttpServer.IHttpRequest.AcceptTypes"> | ||
3860 | <summary> | ||
3861 | Gets kind of types accepted by the client. | ||
3862 | </summary> | ||
3863 | </member> | ||
3864 | <member name="P:HttpServer.IHttpRequest.Body"> | ||
3865 | <summary> | ||
3866 | Gets or sets body stream. | ||
3867 | </summary> | ||
3868 | </member> | ||
3869 | <member name="P:HttpServer.IHttpRequest.BodyIsComplete"> | ||
3870 | <summary> | ||
3871 | Gets whether the body is complete. | ||
3872 | </summary> | ||
3873 | </member> | ||
3874 | <member name="P:HttpServer.IHttpRequest.Connection"> | ||
3875 | <summary> | ||
3876 | Gets or sets kind of connection used for the session. | ||
3877 | </summary> | ||
3878 | </member> | ||
3879 | <member name="P:HttpServer.IHttpRequest.ContentLength"> | ||
3880 | <summary> | ||
3881 | Gets or sets number of bytes in the body. | ||
3882 | </summary> | ||
3883 | </member> | ||
3884 | <member name="P:HttpServer.IHttpRequest.Cookies"> | ||
3885 | <summary> | ||
3886 | Gets cookies that was sent with the request. | ||
3887 | </summary> | ||
3888 | </member> | ||
3889 | <member name="P:HttpServer.IHttpRequest.Form"> | ||
3890 | <summary> | ||
3891 | Gets form parameters. | ||
3892 | </summary> | ||
3893 | </member> | ||
3894 | <member name="P:HttpServer.IHttpRequest.Headers"> | ||
3895 | <summary> | ||
3896 | Gets headers sent by the client. | ||
3897 | </summary> | ||
3898 | </member> | ||
3899 | <member name="P:HttpServer.IHttpRequest.HttpVersion"> | ||
3900 | <summary> | ||
3901 | Gets or sets version of HTTP protocol that's used. | ||
3902 | </summary> | ||
3903 | <remarks> | ||
3904 | Probably <see cref="F:HttpServer.HttpHelper.HTTP10"/> or <see cref="F:HttpServer.HttpHelper.HTTP11"/>. | ||
3905 | </remarks> | ||
3906 | <seealso cref="T:HttpServer.HttpHelper"/> | ||
3907 | </member> | ||
3908 | <member name="P:HttpServer.IHttpRequest.IsAjax"> | ||
3909 | <summary> | ||
3910 | Gets whether the request was made by Ajax (Asynchronous JavaScript) | ||
3911 | </summary> | ||
3912 | </member> | ||
3913 | <member name="P:HttpServer.IHttpRequest.Method"> | ||
3914 | <summary> | ||
3915 | Gets or sets requested method. | ||
3916 | </summary> | ||
3917 | <remarks> | ||
3918 | Will always be in upper case. | ||
3919 | </remarks> | ||
3920 | <see cref="P:HttpServer.IHttpRequest.Method"/> | ||
3921 | </member> | ||
3922 | <member name="P:HttpServer.IHttpRequest.Param"> | ||
3923 | <summary> | ||
3924 | Gets parameter from <see cref="P:HttpServer.IHttpRequest.QueryString"/> or <see cref="P:HttpServer.IHttpRequest.Form"/>. | ||
3925 | </summary> | ||
3926 | </member> | ||
3927 | <member name="P:HttpServer.IHttpRequest.QueryString"> | ||
3928 | <summary> | ||
3929 | Gets variables sent in the query string | ||
3930 | </summary> | ||
3931 | </member> | ||
3932 | <member name="P:HttpServer.IHttpRequest.Uri"> | ||
3933 | <summary> | ||
3934 | Gets or sets requested URI. | ||
3935 | </summary> | ||
3936 | </member> | ||
3937 | <member name="P:HttpServer.IHttpRequest.UriParts"> | ||
3938 | <summary> | ||
3939 | Gets URI absolute path divided into parts. | ||
3940 | </summary> | ||
3941 | <example> | ||
3942 | // URI is: http://gauffin.com/code/tiny/ | ||
3943 | Console.WriteLine(request.UriParts[0]); // result: code | ||
3944 | Console.WriteLine(request.UriParts[1]); // result: tiny | ||
3945 | </example> | ||
3946 | <remarks> | ||
3947 | If you're using controllers than the first part is controller name, | ||
3948 | the second part is method name and the third part is Id property. | ||
3949 | </remarks> | ||
3950 | <seealso cref="P:HttpServer.IHttpRequest.Uri"/> | ||
3951 | </member> | ||
3952 | <member name="P:HttpServer.IHttpRequest.UriPath"> | ||
3953 | <summary> | ||
3954 | Gets or sets path and query. | ||
3955 | </summary> | ||
3956 | <see cref="P:HttpServer.IHttpRequest.Uri"/> | ||
3957 | <remarks> | ||
3958 | Are only used during request parsing. Cannot be set after "Host" header have been | ||
3959 | added. | ||
3960 | </remarks> | ||
3961 | </member> | ||
3962 | <member name="M:HttpServer.IHttpRequest.AddHeader(System.String,System.String)"> | ||
3963 | <summary> | ||
3964 | Called during parsing of a <see cref="T:HttpServer.IHttpRequest"/>. | ||
3965 | </summary> | ||
3966 | <param name="name">Name of the header, should not be URL encoded</param> | ||
3967 | <param name="value">Value of the header, should not be URL encoded</param> | ||
3968 | <exception cref="T:HttpServer.Exceptions.BadRequestException">If a header is incorrect.</exception> | ||
3969 | </member> | ||
3970 | <member name="M:HttpServer.IHttpRequest.AddToBody(System.Byte[],System.Int32,System.Int32)"> | ||
3971 | <summary> | ||
3972 | Add bytes to the body | ||
3973 | </summary> | ||
3974 | <param name="bytes">buffer to read bytes from</param> | ||
3975 | <param name="offset">where to start read</param> | ||
3976 | <param name="length">number of bytes to read</param> | ||
3977 | <returns>Number of bytes actually read (same as length unless we got all body bytes).</returns> | ||
3978 | <exception cref="T:System.InvalidOperationException">If body is not writable</exception> | ||
3979 | <exception cref="T:System.ArgumentNullException"><c>bytes</c> is null.</exception> | ||
3980 | <exception cref="T:System.ArgumentOutOfRangeException"><c>offset</c> is out of range.</exception> | ||
3981 | </member> | ||
3982 | <member name="M:HttpServer.IHttpRequest.Clear"> | ||
3983 | <summary> | ||
3984 | Clear everything in the request | ||
3985 | </summary> | ||
3986 | </member> | ||
3987 | <member name="M:HttpServer.IHttpRequest.DecodeBody(HttpServer.FormDecoders.FormDecoderProvider)"> | ||
3988 | <summary> | ||
3989 | Decode body into a form. | ||
3990 | </summary> | ||
3991 | <param name="providers">A list with form decoders.</param> | ||
3992 | <exception cref="T:System.IO.InvalidDataException">If body contents is not valid for the chosen decoder.</exception> | ||
3993 | <exception cref="T:System.InvalidOperationException">If body is still being transferred.</exception> | ||
3994 | </member> | ||
3995 | <member name="M:HttpServer.IHttpRequest.SetCookies(HttpServer.RequestCookies)"> | ||
3996 | <summary> | ||
3997 | Sets the cookies. | ||
3998 | </summary> | ||
3999 | <param name="cookies">The cookies.</param> | ||
4000 | </member> | ||
4001 | <member name="M:HttpServer.IHttpRequest.CreateResponse(HttpServer.IHttpClientContext)"> | ||
4002 | <summary> | ||
4003 | Create a response object. | ||
4004 | </summary> | ||
4005 | <param name="context">Context for the connected client.</param> | ||
4006 | <returns>A new <see cref="T:HttpServer.IHttpResponse"/>.</returns> | ||
4007 | </member> | ||
4008 | <member name="T:HttpServer.IHttpRequestParser"> | ||
4009 | <summary> | ||
4010 | Event driven parser used to parse incoming HTTP requests. | ||
4011 | </summary> | ||
4012 | <remarks> | ||
4013 | The parser supports partial messages and keeps the states between | ||
4014 | each parsed buffer. It's therefore important that the parser gets | ||
4015 | <see cref="M:HttpServer.IHttpRequestParser.Clear"/>ed if a client disconnects. | ||
4016 | </remarks> | ||
4017 | </member> | ||
4018 | <member name="P:HttpServer.IHttpRequestParser.CurrentState"> | ||
4019 | <summary> | ||
4020 | Current state in parser. | ||
4021 | </summary> | ||
4022 | </member> | ||
4023 | <member name="M:HttpServer.IHttpRequestParser.Parse(System.Byte[],System.Int32,System.Int32)"> | ||
4024 | <summary> | ||
4025 | Parse partial or complete message. | ||
4026 | </summary> | ||
4027 | <param name="buffer">buffer containing incoming bytes</param> | ||
4028 | <param name="offset">where in buffer that parsing should start</param> | ||
4029 | <param name="count">number of bytes to parse</param> | ||
4030 | <returns>Unparsed bytes left in buffer.</returns> | ||
4031 | <exception cref="T:HttpServer.Exceptions.BadRequestException"><c>BadRequestException</c>.</exception> | ||
4032 | </member> | ||
4033 | <member name="E:HttpServer.IHttpRequestParser.RequestCompleted"> | ||
4034 | <summary> | ||
4035 | A request have been successfully parsed. | ||
4036 | </summary> | ||
4037 | </member> | ||
4038 | <member name="E:HttpServer.IHttpRequestParser.BodyBytesReceived"> | ||
4039 | <summary> | ||
4040 | More body bytes have been received. | ||
4041 | </summary> | ||
4042 | </member> | ||
4043 | <member name="E:HttpServer.IHttpRequestParser.RequestLineReceived"> | ||
4044 | <summary> | ||
4045 | Request line have been received. | ||
4046 | </summary> | ||
4047 | </member> | ||
4048 | <member name="E:HttpServer.IHttpRequestParser.HeaderReceived"> | ||
4049 | <summary> | ||
4050 | A header have been received. | ||
4051 | </summary> | ||
4052 | </member> | ||
4053 | <member name="M:HttpServer.IHttpRequestParser.Clear"> | ||
4054 | <summary> | ||
4055 | Clear parser state. | ||
4056 | </summary> | ||
4057 | </member> | ||
4058 | <member name="P:HttpServer.IHttpRequestParser.LogWriter"> | ||
4059 | <summary> | ||
4060 | Gets or sets the log writer. | ||
4061 | </summary> | ||
4062 | </member> | ||
4063 | <member name="T:HttpServer.RequestParserState"> | ||
4064 | <summary> | ||
4065 | Current state in the parsing. | ||
4066 | </summary> | ||
4067 | </member> | ||
4068 | <member name="F:HttpServer.RequestParserState.FirstLine"> | ||
4069 | <summary> | ||
4070 | Should parse the request line | ||
4071 | </summary> | ||
4072 | </member> | ||
4073 | <member name="F:HttpServer.RequestParserState.HeaderName"> | ||
4074 | <summary> | ||
4075 | Searching for a complete header name | ||
4076 | </summary> | ||
4077 | </member> | ||
4078 | <member name="F:HttpServer.RequestParserState.AfterName"> | ||
4079 | <summary> | ||
4080 | Searching for colon after header name (ignoring white spaces) | ||
4081 | </summary> | ||
4082 | </member> | ||
4083 | <member name="F:HttpServer.RequestParserState.Between"> | ||
4084 | <summary> | ||
4085 | Searching for start of header value (ignoring white spaces) | ||
4086 | </summary> | ||
4087 | </member> | ||
4088 | <member name="F:HttpServer.RequestParserState.HeaderValue"> | ||
4089 | <summary> | ||
4090 | Searching for a complete header value (can span over multiple lines, as long as they are prefixed with one/more whitespaces) | ||
4091 | </summary> | ||
4092 | </member> | ||
4093 | <member name="F:HttpServer.RequestParserState.Body"> | ||
4094 | <summary> | ||
4095 | Adding bytes to body | ||
4096 | </summary> | ||
4097 | </member> | ||
4098 | <member name="T:HttpServer.IHttpResponse"> | ||
4099 | <summary> | ||
4100 | Response that is sent back to the web browser / client. | ||
4101 | |||
4102 | A response can be sent if different ways. The easiest one is | ||
4103 | to just fill the Body stream with content, everything else | ||
4104 | will then be taken care of by the framework. The default content-type | ||
4105 | is text/html, you should change it if you send anything else. | ||
4106 | |||
4107 | The second and slighty more complex way is to send the response | ||
4108 | as parts. Start with sending the header using the SendHeaders method and | ||
4109 | then you can send the body using SendBody method, but do not forget | ||
4110 | to set ContentType and ContentLength before doing so. | ||
4111 | </summary> | ||
4112 | <example> | ||
4113 | public void MyHandler(IHttpRequest request, IHttpResponse response) | ||
4114 | { | ||
4115 | |||
4116 | } | ||
4117 | </example> | ||
4118 | </member> | ||
4119 | <member name="P:HttpServer.IHttpResponse.Body"> | ||
4120 | <summary> | ||
4121 | The body stream is used to cache the body contents | ||
4122 | before sending everything to the client. It's the simplest | ||
4123 | way to serve documents. | ||
4124 | </summary> | ||
4125 | </member> | ||
4126 | <member name="P:HttpServer.IHttpResponse.ProtocolVersion"> | ||
4127 | <summary> | ||
4128 | Defines the version of the HTTP Response for applications where it's required | ||
4129 | for this to be forced. | ||
4130 | </summary> | ||
4131 | </member> | ||
4132 | <member name="P:HttpServer.IHttpResponse.Chunked"> | ||
4133 | <summary> | ||
4134 | The chunked encoding modifies the body of a message in order to | ||
4135 | transfer it as a series of chunks, each with its own size indicator, | ||
4136 | followed by an OPTIONAL trailer containing entity-header fields. This | ||
4137 | allows dynamically produced content to be transferred along with the | ||
4138 | information necessary for the recipient to verify that it has | ||
4139 | received the full message. | ||
4140 | </summary> | ||
4141 | </member> | ||
4142 | <member name="P:HttpServer.IHttpResponse.Connection"> | ||
4143 | <summary> | ||
4144 | Kind of connection | ||
4145 | </summary> | ||
4146 | </member> | ||
4147 | <member name="P:HttpServer.IHttpResponse.Encoding"> | ||
4148 | <summary> | ||
4149 | Encoding to use when sending stuff to the client. | ||
4150 | </summary> | ||
4151 | <remarks>Default is UTF8</remarks> | ||
4152 | </member> | ||
4153 | <member name="P:HttpServer.IHttpResponse.KeepAlive"> | ||
4154 | <summary> | ||
4155 | Number of seconds to keep connection alive | ||
4156 | </summary> | ||
4157 | <remarks>Only used if Connection property is set to ConnectionType.KeepAlive</remarks> | ||
4158 | </member> | ||
4159 | <member name="P:HttpServer.IHttpResponse.Status"> | ||
4160 | <summary> | ||
4161 | Status code that is sent to the client. | ||
4162 | </summary> | ||
4163 | <remarks>Default is HttpStatusCode.Ok</remarks> | ||
4164 | </member> | ||
4165 | <member name="P:HttpServer.IHttpResponse.Reason"> | ||
4166 | <summary> | ||
4167 | Information about why a specific status code was used. | ||
4168 | </summary> | ||
4169 | </member> | ||
4170 | <member name="P:HttpServer.IHttpResponse.ContentLength"> | ||
4171 | <summary> | ||
4172 | Size of the body. MUST be specified before sending the header, | ||
4173 | unless property Chunked is set to true. | ||
4174 | </summary> | ||
4175 | </member> | ||
4176 | <member name="P:HttpServer.IHttpResponse.ContentType"> | ||
4177 | <summary> | ||
4178 | Kind of content in the body | ||
4179 | </summary> | ||
4180 | <remarks>Default is text/html</remarks> | ||
4181 | </member> | ||
4182 | <member name="P:HttpServer.IHttpResponse.HeadersSent"> | ||
4183 | <summary> | ||
4184 | Headers have been sent to the client- | ||
4185 | </summary> | ||
4186 | <remarks>You can not send any additional headers if they have already been sent.</remarks> | ||
4187 | </member> | ||
4188 | <member name="P:HttpServer.IHttpResponse.Sent"> | ||
4189 | <summary> | ||
4190 | The whole response have been sent. | ||
4191 | </summary> | ||
4192 | </member> | ||
4193 | <member name="P:HttpServer.IHttpResponse.Cookies"> | ||
4194 | <summary> | ||
4195 | Cookies that should be created/changed. | ||
4196 | </summary> | ||
4197 | </member> | ||
4198 | <member name="M:HttpServer.IHttpResponse.AddHeader(System.String,System.String)"> | ||
4199 | <summary> | ||
4200 | Add another header to the document. | ||
4201 | </summary> | ||
4202 | <param name="name">Name of the header, case sensitive, use lower cases.</param> | ||
4203 | <param name="value">Header values can span over multiple lines as long as each line starts with a white space. New line chars should be \r\n</param> | ||
4204 | <exception cref="T:System.InvalidOperationException">If headers already been sent.</exception> | ||
4205 | <exception cref="T:System.ArgumentException">If value conditions have not been met.</exception> | ||
4206 | <remarks>Adding any header will override the default ones and those specified by properties.</remarks> | ||
4207 | </member> | ||
4208 | <member name="M:HttpServer.IHttpResponse.Send"> | ||
4209 | <summary> | ||
4210 | Send headers and body to the browser. | ||
4211 | </summary> | ||
4212 | <exception cref="T:System.InvalidOperationException">If content have already been sent.</exception> | ||
4213 | </member> | ||
4214 | <member name="M:HttpServer.IHttpResponse.SendBody(System.Byte[],System.Int32,System.Int32)"> | ||
4215 | <summary> | ||
4216 | Make sure that you have specified ContentLength and sent the headers first. | ||
4217 | </summary> | ||
4218 | <param name="buffer"></param> | ||
4219 | <exception cref="T:System.InvalidOperationException">If headers have not been sent.</exception> | ||
4220 | <see cref="M:HttpServer.IHttpResponse.SendHeaders"/> | ||
4221 | <param name="offset">offest of first byte to send</param> | ||
4222 | <param name="count">number of bytes to send.</param> | ||
4223 | <seealso cref="M:HttpServer.IHttpResponse.Send"/> | ||
4224 | <seealso cref="M:HttpServer.IHttpResponse.SendHeaders"/> | ||
4225 | <remarks>This method can be used if you want to send body contents without caching them first. This | ||
4226 | is recommended for larger files to keep the memory usage low.</remarks> | ||
4227 | </member> | ||
4228 | <member name="M:HttpServer.IHttpResponse.SendBody(System.Byte[])"> | ||
4229 | <summary> | ||
4230 | Make sure that you have specified ContentLength and sent the headers first. | ||
4231 | </summary> | ||
4232 | <param name="buffer"></param> | ||
4233 | <exception cref="T:System.InvalidOperationException">If headers have not been sent.</exception> | ||
4234 | <see cref="M:HttpServer.IHttpResponse.SendHeaders"/> | ||
4235 | <seealso cref="M:HttpServer.IHttpResponse.Send"/> | ||
4236 | <seealso cref="M:HttpServer.IHttpResponse.SendHeaders"/> | ||
4237 | <remarks>This method can be used if you want to send body contents without caching them first. This | ||
4238 | is recommended for larger files to keep the memory usage low.</remarks> | ||
4239 | </member> | ||
4240 | <member name="M:HttpServer.IHttpResponse.SendHeaders"> | ||
4241 | <summary> | ||
4242 | Send headers to the client. | ||
4243 | </summary> | ||
4244 | <exception cref="T:System.InvalidOperationException">If headers already been sent.</exception> | ||
4245 | <seealso cref="M:HttpServer.IHttpResponse.AddHeader(System.String,System.String)"/> | ||
4246 | <seealso cref="M:HttpServer.IHttpResponse.Send"/> | ||
4247 | <seealso cref="M:HttpServer.IHttpResponse.SendBody(System.Byte[])"/> | ||
4248 | </member> | ||
4249 | <member name="M:HttpServer.IHttpResponse.Redirect(System.Uri)"> | ||
4250 | <summary> | ||
4251 | Redirect client to somewhere else using the 302 status code. | ||
4252 | </summary> | ||
4253 | <param name="uri">Destination of the redirect</param> | ||
4254 | <exception cref="T:System.InvalidOperationException">If headers already been sent.</exception> | ||
4255 | <remarks>You can not do anything more with the request when a redirect have been done. This should be your last | ||
4256 | action.</remarks> | ||
4257 | </member> | ||
4258 | <member name="M:HttpServer.IHttpResponse.Redirect(System.String)"> | ||
4259 | <summary> | ||
4260 | redirect to somewhere | ||
4261 | </summary> | ||
4262 | <param name="url">where the redirect should go</param> | ||
4263 | <remarks> | ||
4264 | No body are allowed when doing redirects. | ||
4265 | </remarks> | ||
4266 | </member> | ||
4267 | <member name="T:HttpServer.ConnectionType"> | ||
4268 | <summary> | ||
4269 | Type of HTTP connection | ||
4270 | </summary> | ||
4271 | </member> | ||
4272 | <member name="F:HttpServer.ConnectionType.Close"> | ||
4273 | <summary> | ||
4274 | Connection is closed after each request-response | ||
4275 | </summary> | ||
4276 | </member> | ||
4277 | <member name="F:HttpServer.ConnectionType.KeepAlive"> | ||
4278 | <summary> | ||
4279 | Connection is kept alive for X seconds (unless another request have been made) | ||
4280 | </summary> | ||
4281 | </member> | ||
4282 | <member name="T:HttpServer.LogPrio"> | ||
4283 | <summary> | ||
4284 | Priority for log entries | ||
4285 | </summary> | ||
4286 | <seealso cref="T:HttpServer.ILogWriter"/> | ||
4287 | </member> | ||
4288 | <member name="F:HttpServer.LogPrio.Trace"> | ||
4289 | <summary> | ||
4290 | Very detailed logs to be able to follow the flow of the program. | ||
4291 | </summary> | ||
4292 | </member> | ||
4293 | <member name="F:HttpServer.LogPrio.Debug"> | ||
4294 | <summary> | ||
4295 | Logs to help debug errors in the application | ||
4296 | </summary> | ||
4297 | </member> | ||
4298 | <member name="F:HttpServer.LogPrio.Info"> | ||
4299 | <summary> | ||
4300 | Information to be able to keep track of state changes etc. | ||
4301 | </summary> | ||
4302 | </member> | ||
4303 | <member name="F:HttpServer.LogPrio.Warning"> | ||
4304 | <summary> | ||
4305 | Something did not go as we expected, but it's no problem. | ||
4306 | </summary> | ||
4307 | </member> | ||
4308 | <member name="F:HttpServer.LogPrio.Error"> | ||
4309 | <summary> | ||
4310 | Something that should not fail failed, but we can still keep | ||
4311 | on going. | ||
4312 | </summary> | ||
4313 | </member> | ||
4314 | <member name="F:HttpServer.LogPrio.Fatal"> | ||
4315 | <summary> | ||
4316 | Something failed, and we cannot handle it properly. | ||
4317 | </summary> | ||
4318 | </member> | ||
4319 | <member name="T:HttpServer.ILogWriter"> | ||
4320 | <summary> | ||
4321 | Interface used to write to log files. | ||
4322 | </summary> | ||
4323 | </member> | ||
4324 | <member name="M:HttpServer.ILogWriter.Write(System.Object,HttpServer.LogPrio,System.String)"> | ||
4325 | <summary> | ||
4326 | Write an entry to the log file. | ||
4327 | </summary> | ||
4328 | <param name="source">object that is writing to the log</param> | ||
4329 | <param name="priority">importance of the log message</param> | ||
4330 | <param name="message">the message</param> | ||
4331 | </member> | ||
4332 | <member name="T:HttpServer.ConsoleLogWriter"> | ||
4333 | <summary> | ||
4334 | This class writes to the console. It colors the output depending on the logprio and includes a 3-level stacktrace (in debug mode) | ||
4335 | </summary> | ||
4336 | <seealso cref="T:HttpServer.ILogWriter"/> | ||
4337 | </member> | ||
4338 | <member name="F:HttpServer.ConsoleLogWriter.Instance"> | ||
4339 | <summary> | ||
4340 | The actual instance of this class. | ||
4341 | </summary> | ||
4342 | </member> | ||
4343 | <member name="M:HttpServer.ConsoleLogWriter.Write(System.Object,HttpServer.LogPrio,System.String)"> | ||
4344 | <summary> | ||
4345 | Logwriters the specified source. | ||
4346 | </summary> | ||
4347 | <param name="source">object that wrote the logentry.</param> | ||
4348 | <param name="prio">Importance of the log message</param> | ||
4349 | <param name="message">The message.</param> | ||
4350 | </member> | ||
4351 | <member name="M:HttpServer.ConsoleLogWriter.GetColor(HttpServer.LogPrio)"> | ||
4352 | <summary> | ||
4353 | Get color for the specified logprio | ||
4354 | </summary> | ||
4355 | <param name="prio">prio for the log entry</param> | ||
4356 | <returns>A <see cref="T:System.ConsoleColor"/> for the prio</returns> | ||
4357 | </member> | ||
4358 | <member name="T:HttpServer.NullLogWriter"> | ||
4359 | <summary> | ||
4360 | Default log writer, writes everything to null (nowhere). | ||
4361 | </summary> | ||
4362 | <seealso cref="T:HttpServer.ILogWriter"/> | ||
4363 | </member> | ||
4364 | <member name="F:HttpServer.NullLogWriter.Instance"> | ||
4365 | <summary> | ||
4366 | The logging instance. | ||
4367 | </summary> | ||
4368 | </member> | ||
4369 | <member name="M:HttpServer.NullLogWriter.Write(System.Object,HttpServer.LogPrio,System.String)"> | ||
4370 | <summary> | ||
4371 | Writes everything to null | ||
4372 | </summary> | ||
4373 | <param name="source">object that wrote the log entry.</param> | ||
4374 | <param name="prio">Importance of the log message</param> | ||
4375 | <param name="message">The message.</param> | ||
4376 | </member> | ||
4377 | <member name="T:HttpServer.LocklessQueue`1"> | ||
4378 | <summary> | ||
4379 | A thread-safe lockless queue that supports multiple readers and | ||
4380 | multiple writers | ||
4381 | </summary> | ||
4382 | </member> | ||
4383 | <member name="T:HttpServer.LocklessQueue`1.SingleLinkNode"> | ||
4384 | <summary> | ||
4385 | Provides a node container for data in a singly linked list | ||
4386 | </summary> | ||
4387 | </member> | ||
4388 | <member name="F:HttpServer.LocklessQueue`1.SingleLinkNode.Next"> | ||
4389 | <summary>Pointer to the next node in list</summary> | ||
4390 | </member> | ||
4391 | <member name="F:HttpServer.LocklessQueue`1.SingleLinkNode.Item"> | ||
4392 | <summary>The data contained by the node</summary> | ||
4393 | </member> | ||
4394 | <member name="M:HttpServer.LocklessQueue`1.SingleLinkNode.#ctor"> | ||
4395 | <summary> | ||
4396 | Constructor | ||
4397 | </summary> | ||
4398 | </member> | ||
4399 | <member name="M:HttpServer.LocklessQueue`1.SingleLinkNode.#ctor(`0)"> | ||
4400 | <summary> | ||
4401 | Constructor | ||
4402 | </summary> | ||
4403 | </member> | ||
4404 | <member name="F:HttpServer.LocklessQueue`1.head"> | ||
4405 | <summary>Queue head</summary> | ||
4406 | </member> | ||
4407 | <member name="F:HttpServer.LocklessQueue`1.tail"> | ||
4408 | <summary>Queue tail</summary> | ||
4409 | </member> | ||
4410 | <member name="F:HttpServer.LocklessQueue`1.count"> | ||
4411 | <summary>Queue item count</summary> | ||
4412 | </member> | ||
4413 | <member name="P:HttpServer.LocklessQueue`1.Count"> | ||
4414 | <summary>Gets the current number of items in the queue. Since this | ||
4415 | is a lockless collection this value should be treated as a close | ||
4416 | estimate</summary> | ||
4417 | </member> | ||
4418 | <member name="M:HttpServer.LocklessQueue`1.#ctor"> | ||
4419 | <summary> | ||
4420 | Constructor | ||
4421 | </summary> | ||
4422 | </member> | ||
4423 | <member name="M:HttpServer.LocklessQueue`1.Enqueue(`0)"> | ||
4424 | <summary> | ||
4425 | Enqueue an item | ||
4426 | </summary> | ||
4427 | <param name="item">Item to enqeue</param> | ||
4428 | </member> | ||
4429 | <member name="M:HttpServer.LocklessQueue`1.TryDequeue(`0@)"> | ||
4430 | <summary> | ||
4431 | Try to dequeue an item | ||
4432 | </summary> | ||
4433 | <param name="item">Dequeued item if the dequeue was successful</param> | ||
4434 | <returns>True if an item was successfully deqeued, otherwise false</returns> | ||
4435 | </member> | ||
4436 | <member name="T:HttpServer.Method"> | ||
4437 | <summary> | ||
4438 | Contains all HTTP Methods (according to the HTTP 1.1 specification) | ||
4439 | <para> | ||
4440 | See: http://www.w3.org/Protocols/rfc2616/rfc2616-sec9.html | ||
4441 | </para> | ||
4442 | </summary> | ||
4443 | </member> | ||
4444 | <member name="F:HttpServer.Method.Delete"> | ||
4445 | <summary> | ||
4446 | The DELETE method requests that the origin server delete the resource identified by the Request-URI. | ||
4447 | </summary> | ||
4448 | <remarks> | ||
4449 | <para> | ||
4450 | This method MAY be overridden by human intervention (or other means) on the origin server. | ||
4451 | The client cannot be guaranteed that the operation has been carried out, even if the status code | ||
4452 | returned from the origin server indicates that the action has been completed successfully. | ||
4453 | </para> | ||
4454 | <para> | ||
4455 | However, the server SHOULD NOT indicate success unless, at the time the response is given, | ||
4456 | it intends to delete the resource or move it to an inaccessible location. | ||
4457 | </para> | ||
4458 | <para> | ||
4459 | A successful response SHOULD be 200 (OK) if the response includes an entity describing the status, | ||
4460 | 202 (Accepted) if the action has not yet been enacted, | ||
4461 | or 204 (No Content) if the action has been enacted but the response does not include an entity. | ||
4462 | </para> | ||
4463 | <para> | ||
4464 | If the request passes through a cache and the Request-URI identifies one or more currently cached entities, | ||
4465 | those entries SHOULD be treated as stale. Responses to this method are not cacheable. | ||
4466 | </para> | ||
4467 | </remarks> | ||
4468 | </member> | ||
4469 | <member name="F:HttpServer.Method.Get"> | ||
4470 | <summary> | ||
4471 | The GET method means retrieve whatever information (in the form of an entity) is identified by the Request-URI. | ||
4472 | </summary> | ||
4473 | <remarks> | ||
4474 | <para> | ||
4475 | If the Request-URI refers to a data-producing process, it is the produced data which shall be returned as the | ||
4476 | entity in the response and not the source text of the process, unless that text happens to be the output of the process. | ||
4477 | </para> | ||
4478 | <para> | ||
4479 | The semantics of the GET method change to a "conditional GET" if the request message includes an | ||
4480 | If-Modified-Since, If-Unmodified-Since, If-Match, If-None-Match, or If-Range header field. | ||
4481 | A conditional GET method requests that the entity be transferred only under the circumstances described | ||
4482 | by the conditional header field(s). The conditional GET method is intended to reduce unnecessary network | ||
4483 | usage by allowing cached entities to be refreshed without requiring multiple requests or transferring | ||
4484 | data already held by the client. | ||
4485 | </para> | ||
4486 | </remarks> | ||
4487 | </member> | ||
4488 | <member name="F:HttpServer.Method.Header"> | ||
4489 | <summary> | ||
4490 | The HEAD method is identical to GET except that the server MUST NOT return a message-body in the response. | ||
4491 | </summary> | ||
4492 | <remarks> | ||
4493 | The meta information contained in the HTTP headers in response to a HEAD request SHOULD be identical to the | ||
4494 | information sent in response to a GET request. This method can be used for obtaining meta information about | ||
4495 | the entity implied by the request without transferring the entity-body itself. | ||
4496 | |||
4497 | This method is often used for testing hypertext links for validity, accessibility, and recent modification. | ||
4498 | </remarks> | ||
4499 | </member> | ||
4500 | <member name="F:HttpServer.Method.Options"> | ||
4501 | <summary> | ||
4502 | <para>The OPTIONS method represents a request for information about the communication options available on the request/response chain identified by the Request-URI.</para> | ||
4503 | </summary> | ||
4504 | <remarks> | ||
4505 | <para>This method allows the client to determine the options and/or requirements associated with a resource, or the capabilities of a server, without implying a resource action or initiating a resource retrieval.</para> | ||
4506 | </remarks> | ||
4507 | </member> | ||
4508 | <member name="F:HttpServer.Method.Post"> | ||
4509 | <summary> | ||
4510 | The POST method is used to request that the origin server accept the entity enclosed | ||
4511 | in the request as a new subordinate of the resource identified by the Request-URI in the Request-Line. | ||
4512 | </summary> | ||
4513 | <remarks> | ||
4514 | POST is designed to allow a uniform method to cover the following functions: | ||
4515 | <list type="bullet"> | ||
4516 | <item> | ||
4517 | Annotation of existing resources; | ||
4518 | </item><item> | ||
4519 | Posting a message to a bulletin board, newsgroup, mailing list, or similar group of articles; | ||
4520 | </item><item> | ||
4521 | Providing a block of data, such as the result of submitting a form, to a data-handling process; | ||
4522 | </item><item> | ||
4523 | Extending a database through an append operation. | ||
4524 | </item> | ||
4525 | </list> | ||
4526 | <para> | ||
4527 | If a resource has been created on the origin server, the response SHOULD be 201 (Created) and | ||
4528 | contain an entity which describes the status of the request and refers to the new resource, and a | ||
4529 | Location header (see section 14.30). | ||
4530 | </para> | ||
4531 | <para> | ||
4532 | The action performed by the POST method might not result in a resource that can be identified by a URI. | ||
4533 | In this case, either 200 (OK) or 204 (No Content) is the appropriate response status, depending on | ||
4534 | whether or not the response includes an entity that describes the result. | ||
4535 | </para><para> | ||
4536 | Responses to this method are not cacheable, unless the response includes appropriate Cache-Control | ||
4537 | or Expires header fields. However, the 303 (See Other) response can be used to direct the user agent | ||
4538 | to retrieve a cacheable resource. | ||
4539 | </para> | ||
4540 | </remarks> | ||
4541 | </member> | ||
4542 | <member name="F:HttpServer.Method.Put"> | ||
4543 | <summary> | ||
4544 | The PUT method requests that the enclosed entity be stored under the supplied Request-URI. | ||
4545 | </summary> | ||
4546 | <remarks> | ||
4547 | <list type="bullet"> | ||
4548 | <item> | ||
4549 | If the Request-URI refers to an already existing resource, the enclosed entity SHOULD be considered as a | ||
4550 | modified version of the one residing on the origin server. | ||
4551 | </item><item> | ||
4552 | If the Request-URI does not point to an existing resource, and that URI is capable of being defined as a new | ||
4553 | resource by the requesting user agent, the origin server can create the resource with that URI. | ||
4554 | </item><item> | ||
4555 | If a new resource is created, the origin server MUST inform the user agent via the 201 (Created) response. | ||
4556 | </item><item> | ||
4557 | If an existing resource is modified, either the 200 (OK) or 204 (No Content) response codes SHOULD be sent to | ||
4558 | indicate successful completion of the request. | ||
4559 | </item><item> | ||
4560 | If the resource could not be created or modified with the Request-URI, an appropriate error response SHOULD be | ||
4561 | given that reflects the nature of the problem. | ||
4562 | </item> | ||
4563 | </list> | ||
4564 | <para> | ||
4565 | The recipient of the entity MUST NOT ignore any Content-* (e.g. Content-Range) headers that it does not | ||
4566 | understand or implement and MUST return a 501 (Not Implemented) response in such cases. | ||
4567 | </para> | ||
4568 | </remarks> | ||
4569 | </member> | ||
4570 | <member name="F:HttpServer.Method.Trace"> | ||
4571 | <summary> | ||
4572 | The TRACE method is used to invoke a remote, application-layer loop- back of the request message. | ||
4573 | </summary> | ||
4574 | </member> | ||
4575 | <member name="T:HttpServer.Methods"> | ||
4576 | <summary> | ||
4577 | Contains all HTTP Methods (according to the HTTP 1.1 specification) | ||
4578 | <para> | ||
4579 | See: http://www.w3.org/Protocols/rfc2616/rfc2616-sec9.html | ||
4580 | </para> | ||
4581 | </summary> | ||
4582 | </member> | ||
4583 | <member name="F:HttpServer.Methods.Delete"> | ||
4584 | <summary> | ||
4585 | The DELETE method requests that the origin server delete the resource identified by the Request-URI. | ||
4586 | </summary> | ||
4587 | <remarks> | ||
4588 | <para> | ||
4589 | This method MAY be overridden by human intervention (or other means) on the origin server. | ||
4590 | The client cannot be guaranteed that the operation has been carried out, even if the status code | ||
4591 | returned from the origin server indicates that the action has been completed successfully. | ||
4592 | </para> | ||
4593 | <para> | ||
4594 | However, the server SHOULD NOT indicate success unless, at the time the response is given, | ||
4595 | it intends to delete the resource or move it to an inaccessible location. | ||
4596 | </para> | ||
4597 | <para> | ||
4598 | A successful response SHOULD be 200 (OK) if the response includes an entity describing the status, | ||
4599 | 202 (Accepted) if the action has not yet been enacted, | ||
4600 | or 204 (No Content) if the action has been enacted but the response does not include an entity. | ||
4601 | </para> | ||
4602 | <para> | ||
4603 | If the request passes through a cache and the Request-URI identifies one or more currently cached entities, | ||
4604 | those entries SHOULD be treated as stale. Responses to this method are not cacheable. | ||
4605 | </para> | ||
4606 | </remarks> | ||
4607 | </member> | ||
4608 | <member name="F:HttpServer.Methods.Get"> | ||
4609 | <summary> | ||
4610 | The GET method means retrieve whatever information (in the form of an entity) is identified by the Request-URI. | ||
4611 | </summary> | ||
4612 | <remarks> | ||
4613 | <para> | ||
4614 | If the Request-URI refers to a data-producing process, it is the produced data which shall be returned as the | ||
4615 | entity in the response and not the source text of the process, unless that text happens to be the output of the process. | ||
4616 | </para> | ||
4617 | <para> | ||
4618 | The semantics of the GET method change to a "conditional GET" if the request message includes an | ||
4619 | If-Modified-Since, If-Unmodified-Since, If-Match, If-None-Match, or If-Range header field. | ||
4620 | A conditional GET method requests that the entity be transferred only under the circumstances described | ||
4621 | by the conditional header field(s). The conditional GET method is intended to reduce unnecessary network | ||
4622 | usage by allowing cached entities to be refreshed without requiring multiple requests or transferring | ||
4623 | data already held by the client. | ||
4624 | </para> | ||
4625 | </remarks> | ||
4626 | </member> | ||
4627 | <member name="F:HttpServer.Methods.Header"> | ||
4628 | <summary> | ||
4629 | The HEAD method is identical to GET except that the server MUST NOT return a message-body in the response. | ||
4630 | </summary> | ||
4631 | <remarks> | ||
4632 | The meta information contained in the HTTP headers in response to a HEAD request SHOULD be identical to the | ||
4633 | information sent in response to a GET request. This method can be used for obtaining meta information about | ||
4634 | the entity implied by the request without transferring the entity-body itself. | ||
4635 | |||
4636 | This method is often used for testing hypertext links for validity, accessibility, and recent modification. | ||
4637 | </remarks> | ||
4638 | </member> | ||
4639 | <member name="F:HttpServer.Methods.Options"> | ||
4640 | <summary> | ||
4641 | <para>The OPTIONS method represents a request for information about the communication options available on the request/response chain identified by the Request-URI.</para> | ||
4642 | </summary> | ||
4643 | <remarks> | ||
4644 | <para>This method allows the client to determine the options and/or requirements associated with a resource, or the capabilities of a server, without implying a resource action or initiating a resource retrieval.</para> | ||
4645 | </remarks> | ||
4646 | </member> | ||
4647 | <member name="F:HttpServer.Methods.Post"> | ||
4648 | <summary> | ||
4649 | The POST method is used to request that the origin server accept the entity enclosed | ||
4650 | in the request as a new subordinate of the resource identified by the Request-URI in the Request-Line. | ||
4651 | </summary> | ||
4652 | <remarks> | ||
4653 | POST is designed to allow a uniform method to cover the following functions: | ||
4654 | <list type="bullet"> | ||
4655 | <item> | ||
4656 | Annotation of existing resources; | ||
4657 | </item><item> | ||
4658 | Posting a message to a bulletin board, newsgroup, mailing list, or similar group of articles; | ||
4659 | </item><item> | ||
4660 | Providing a block of data, such as the result of submitting a form, to a data-handling process; | ||
4661 | </item><item> | ||
4662 | Extending a database through an append operation. | ||
4663 | </item> | ||
4664 | </list> | ||
4665 | <para> | ||
4666 | If a resource has been created on the origin server, the response SHOULD be 201 (Created) and | ||
4667 | contain an entity which describes the status of the request and refers to the new resource, and a | ||
4668 | Location header (see section 14.30). | ||
4669 | </para> | ||
4670 | <para> | ||
4671 | The action performed by the POST method might not result in a resource that can be identified by a URI. | ||
4672 | In this case, either 200 (OK) or 204 (No Content) is the appropriate response status, depending on | ||
4673 | whether or not the response includes an entity that describes the result. | ||
4674 | </para><para> | ||
4675 | Responses to this method are not cacheable, unless the response includes appropriate Cache-Control | ||
4676 | or Expires header fields. However, the 303 (See Other) response can be used to direct the user agent | ||
4677 | to retrieve a cacheable resource. | ||
4678 | </para> | ||
4679 | </remarks> | ||
4680 | </member> | ||
4681 | <member name="F:HttpServer.Methods.Put"> | ||
4682 | <summary> | ||
4683 | The PUT method requests that the enclosed entity be stored under the supplied Request-URI. | ||
4684 | </summary> | ||
4685 | <remarks> | ||
4686 | <list type="bullet"> | ||
4687 | <item> | ||
4688 | If the Request-URI refers to an already existing resource, the enclosed entity SHOULD be considered as a | ||
4689 | modified version of the one residing on the origin server. | ||
4690 | </item><item> | ||
4691 | If the Request-URI does not point to an existing resource, and that URI is capable of being defined as a new | ||
4692 | resource by the requesting user agent, the origin server can create the resource with that URI. | ||
4693 | </item><item> | ||
4694 | If a new resource is created, the origin server MUST inform the user agent via the 201 (Created) response. | ||
4695 | </item><item> | ||
4696 | If an existing resource is modified, either the 200 (OK) or 204 (No Content) response codes SHOULD be sent to | ||
4697 | indicate successful completion of the request. | ||
4698 | </item><item> | ||
4699 | If the resource could not be created or modified with the Request-URI, an appropriate error response SHOULD be | ||
4700 | given that reflects the nature of the problem. | ||
4701 | </item> | ||
4702 | </list> | ||
4703 | <para> | ||
4704 | The recipient of the entity MUST NOT ignore any Content-* (e.g. Content-Range) headers that it does not | ||
4705 | understand or implement and MUST return a 501 (Not Implemented) response in such cases. | ||
4706 | </para> | ||
4707 | </remarks> | ||
4708 | </member> | ||
4709 | <member name="F:HttpServer.Methods.Trace"> | ||
4710 | <summary> | ||
4711 | The TRACE method is used to invoke a remote, application-layer loop- back of the request message. | ||
4712 | </summary> | ||
4713 | </member> | ||
4714 | <member name="T:HttpServer.Parser.BodyEventArgs"> | ||
4715 | <summary> | ||
4716 | Arguments used when more body bytes have come. | ||
4717 | </summary> | ||
4718 | </member> | ||
4719 | <member name="M:HttpServer.Parser.BodyEventArgs.#ctor(System.Byte[],System.Int32,System.Int32)"> | ||
4720 | <summary> | ||
4721 | Initializes a new instance of the <see cref="T:HttpServer.Parser.BodyEventArgs"/> class. | ||
4722 | </summary> | ||
4723 | <param name="buffer">buffer that contains the received bytes.</param> | ||
4724 | <param name="offset">offset in buffer where to start processing.</param> | ||
4725 | <param name="count">number of bytes from <paramref name="offset"/> that should be parsed.</param> | ||
4726 | </member> | ||
4727 | <member name="M:HttpServer.Parser.BodyEventArgs.#ctor"> | ||
4728 | <summary> | ||
4729 | Initializes a new instance of the <see cref="T:HttpServer.Parser.BodyEventArgs"/> class. | ||
4730 | </summary> | ||
4731 | </member> | ||
4732 | <member name="P:HttpServer.Parser.BodyEventArgs.Buffer"> | ||
4733 | <summary> | ||
4734 | Gets or sets buffer that contains the received bytes. | ||
4735 | </summary> | ||
4736 | </member> | ||
4737 | <member name="P:HttpServer.Parser.BodyEventArgs.Count"> | ||
4738 | <summary> | ||
4739 | Gets or sets number of bytes from <see cref="P:HttpServer.Parser.BodyEventArgs.Offset"/> that should be parsed. | ||
4740 | </summary> | ||
4741 | </member> | ||
4742 | <member name="P:HttpServer.Parser.BodyEventArgs.Offset"> | ||
4743 | <summary> | ||
4744 | Gets or sets offset in buffer where to start processing. | ||
4745 | </summary> | ||
4746 | </member> | ||
4747 | <member name="T:HttpServer.Parser.HeaderEventArgs"> | ||
4748 | <summary> | ||
4749 | Event arguments used when a new header have been parsed. | ||
4750 | </summary> | ||
4751 | </member> | ||
4752 | <member name="M:HttpServer.Parser.HeaderEventArgs.#ctor(System.String,System.String)"> | ||
4753 | <summary> | ||
4754 | Initializes a new instance of the <see cref="T:HttpServer.Parser.HeaderEventArgs"/> class. | ||
4755 | </summary> | ||
4756 | <param name="name">Name of header.</param> | ||
4757 | <param name="value">Header value.</param> | ||
4758 | </member> | ||
4759 | <member name="M:HttpServer.Parser.HeaderEventArgs.#ctor"> | ||
4760 | <summary> | ||
4761 | Initializes a new instance of the <see cref="T:HttpServer.Parser.HeaderEventArgs"/> class. | ||
4762 | </summary> | ||
4763 | </member> | ||
4764 | <member name="P:HttpServer.Parser.HeaderEventArgs.Name"> | ||
4765 | <summary> | ||
4766 | Gets or sets header name. | ||
4767 | </summary> | ||
4768 | </member> | ||
4769 | <member name="P:HttpServer.Parser.HeaderEventArgs.Value"> | ||
4770 | <summary> | ||
4771 | Gets or sets header value. | ||
4772 | </summary> | ||
4773 | </member> | ||
4774 | <member name="T:HttpServer.Parser.HttpRequestParser"> | ||
4775 | <summary> | ||
4776 | Parses a HTTP request directly from a stream | ||
4777 | </summary> | ||
4778 | </member> | ||
4779 | <member name="M:HttpServer.Parser.HttpRequestParser.#ctor(HttpServer.ILogWriter)"> | ||
4780 | <summary> | ||
4781 | Create a new request parser | ||
4782 | </summary> | ||
4783 | <param name="logWriter">delegate receiving log entries.</param> | ||
4784 | </member> | ||
4785 | <member name="M:HttpServer.Parser.HttpRequestParser.AddToBody(System.Byte[],System.Int32,System.Int32)"> | ||
4786 | <summary> | ||
4787 | Add a number of bytes to the body | ||
4788 | </summary> | ||
4789 | <param name="buffer">buffer containing more body bytes.</param> | ||
4790 | <param name="offset">starting offset in buffer</param> | ||
4791 | <param name="count">number of bytes, from offset, to read.</param> | ||
4792 | <returns>offset to continue from.</returns> | ||
4793 | </member> | ||
4794 | <member name="M:HttpServer.Parser.HttpRequestParser.Clear"> | ||
4795 | <summary> | ||
4796 | Remove all state information for the request. | ||
4797 | </summary> | ||
4798 | </member> | ||
4799 | <member name="P:HttpServer.Parser.HttpRequestParser.LogWriter"> | ||
4800 | <summary> | ||
4801 | Gets or sets the log writer. | ||
4802 | </summary> | ||
4803 | </member> | ||
4804 | <member name="M:HttpServer.Parser.HttpRequestParser.OnFirstLine(System.String)"> | ||
4805 | <summary> | ||
4806 | Parse request line | ||
4807 | </summary> | ||
4808 | <param name="value"></param> | ||
4809 | <exception cref="T:HttpServer.Exceptions.BadRequestException">If line is incorrect</exception> | ||
4810 | <remarks>Expects the following format: "Method SP Request-URI SP HTTP-Version CRLF"</remarks> | ||
4811 | </member> | ||
4812 | <member name="M:HttpServer.Parser.HttpRequestParser.OnHeader(System.String,System.String)"> | ||
4813 | <summary> | ||
4814 | We've parsed a new header. | ||
4815 | </summary> | ||
4816 | <param name="name">Name in lower case</param> | ||
4817 | <param name="value">Value, unmodified.</param> | ||
4818 | <exception cref="T:HttpServer.Exceptions.BadRequestException">If content length cannot be parsed.</exception> | ||
4819 | </member> | ||
4820 | <member name="P:HttpServer.Parser.HttpRequestParser.CurrentState"> | ||
4821 | <summary> | ||
4822 | Current state in parser. | ||
4823 | </summary> | ||
4824 | </member> | ||
4825 | <member name="M:HttpServer.Parser.HttpRequestParser.Parse(System.Byte[],System.Int32,System.Int32)"> | ||
4826 | <summary> | ||
4827 | Parse a message | ||
4828 | </summary> | ||
4829 | <param name="buffer">bytes to parse.</param> | ||
4830 | <param name="offset">where in buffer that parsing should start</param> | ||
4831 | <param name="count">number of bytes to parse, starting on <paramref name="offset"/>.</param> | ||
4832 | <returns>offset (where to start parsing next).</returns> | ||
4833 | <exception cref="T:HttpServer.Exceptions.BadRequestException"><c>BadRequestException</c>.</exception> | ||
4834 | </member> | ||
4835 | <member name="E:HttpServer.Parser.HttpRequestParser.RequestCompleted"> | ||
4836 | <summary> | ||
4837 | A request have been successfully parsed. | ||
4838 | </summary> | ||
4839 | </member> | ||
4840 | <member name="E:HttpServer.Parser.HttpRequestParser.BodyBytesReceived"> | ||
4841 | <summary> | ||
4842 | More body bytes have been received. | ||
4843 | </summary> | ||
4844 | </member> | ||
4845 | <member name="E:HttpServer.Parser.HttpRequestParser.RequestLineReceived"> | ||
4846 | <summary> | ||
4847 | Request line have been received. | ||
4848 | </summary> | ||
4849 | </member> | ||
4850 | <member name="E:HttpServer.Parser.HttpRequestParser.HeaderReceived"> | ||
4851 | <summary> | ||
4852 | A header have been received. | ||
4853 | </summary> | ||
4854 | </member> | ||
4855 | <member name="T:HttpServer.Parser.RequestLineEventArgs"> | ||
4856 | <summary> | ||
4857 | Used when the request line have been successfully parsed. | ||
4858 | </summary> | ||
4859 | </member> | ||
4860 | <member name="M:HttpServer.Parser.RequestLineEventArgs.#ctor(System.String,System.String,System.String)"> | ||
4861 | <summary> | ||
4862 | Initializes a new instance of the <see cref="T:HttpServer.Parser.RequestLineEventArgs"/> class. | ||
4863 | </summary> | ||
4864 | <param name="httpMethod">The HTTP method.</param> | ||
4865 | <param name="uriPath">The URI path.</param> | ||
4866 | <param name="httpVersion">The HTTP version.</param> | ||
4867 | </member> | ||
4868 | <member name="M:HttpServer.Parser.RequestLineEventArgs.#ctor"> | ||
4869 | <summary> | ||
4870 | Initializes a new instance of the <see cref="T:HttpServer.Parser.RequestLineEventArgs"/> class. | ||
4871 | </summary> | ||
4872 | </member> | ||
4873 | <member name="P:HttpServer.Parser.RequestLineEventArgs.HttpMethod"> | ||
4874 | <summary> | ||
4875 | Gets or sets http method. | ||
4876 | </summary> | ||
4877 | <remarks> | ||
4878 | Should be one of the methods declared in <see cref="T:HttpServer.Method"/>. | ||
4879 | </remarks> | ||
4880 | </member> | ||
4881 | <member name="P:HttpServer.Parser.RequestLineEventArgs.HttpVersion"> | ||
4882 | <summary> | ||
4883 | Gets or sets the version of the HTTP protocol that the client want to use. | ||
4884 | </summary> | ||
4885 | </member> | ||
4886 | <member name="P:HttpServer.Parser.RequestLineEventArgs.UriPath"> | ||
4887 | <summary> | ||
4888 | Gets or sets requested URI path. | ||
4889 | </summary> | ||
4890 | </member> | ||
4891 | <member name="T:HttpServer.RequestParserFactory"> | ||
4892 | <summary> | ||
4893 | Creates request parsers when needed. | ||
4894 | </summary> | ||
4895 | </member> | ||
4896 | <member name="M:HttpServer.RequestParserFactory.CreateParser(HttpServer.ILogWriter)"> | ||
4897 | <summary> | ||
4898 | Create a new request parser. | ||
4899 | </summary> | ||
4900 | <param name="logWriter">Used when logging should be enabled.</param> | ||
4901 | <returns>A new request parser.</returns> | ||
4902 | </member> | ||
4903 | <member name="T:HttpServer.IRequestParserFactory"> | ||
4904 | <summary> | ||
4905 | Creates request parsers when needed. | ||
4906 | </summary> | ||
4907 | </member> | ||
4908 | <member name="M:HttpServer.IRequestParserFactory.CreateParser(HttpServer.ILogWriter)"> | ||
4909 | <summary> | ||
4910 | Create a new request parser. | ||
4911 | </summary> | ||
4912 | <param name="logWriter">Used when logging should be enabled.</param> | ||
4913 | <returns>A new request parser.</returns> | ||
4914 | </member> | ||
4915 | <member name="T:HttpServer.RequestCookie"> | ||
4916 | <summary> | ||
4917 | cookie sent by the client/browser | ||
4918 | </summary> | ||
4919 | <seealso cref="T:HttpServer.ResponseCookie"/> | ||
4920 | </member> | ||
4921 | <member name="M:HttpServer.RequestCookie.#ctor(System.String,System.String)"> | ||
4922 | <summary> | ||
4923 | Constructor. | ||
4924 | </summary> | ||
4925 | <param name="id">cookie identifier</param> | ||
4926 | <param name="content">cookie content</param> | ||
4927 | <exception cref="T:System.ArgumentNullException">id or content is null</exception> | ||
4928 | <exception cref="T:System.ArgumentException">id is empty</exception> | ||
4929 | </member> | ||
4930 | <member name="M:HttpServer.RequestCookie.ToString"> | ||
4931 | <summary> | ||
4932 | Gets the cookie HTML representation. | ||
4933 | </summary> | ||
4934 | <returns>cookie string</returns> | ||
4935 | </member> | ||
4936 | <member name="P:HttpServer.RequestCookie.Name"> | ||
4937 | <summary> | ||
4938 | Gets the cookie identifier. | ||
4939 | </summary> | ||
4940 | </member> | ||
4941 | <member name="P:HttpServer.RequestCookie.Value"> | ||
4942 | <summary> | ||
4943 | Cookie value. Set to null to remove cookie. | ||
4944 | </summary> | ||
4945 | </member> | ||
4946 | <member name="T:HttpServer.RequestCookies"> | ||
4947 | <summary> | ||
4948 | This class is created as a wrapper, since there are two different cookie types in .Net (Cookie and HttpCookie). | ||
4949 | The framework might switch class in the future and we dont want to have to replace all instances | ||
4950 | </summary> | ||
4951 | </member> | ||
4952 | <member name="M:HttpServer.RequestCookies.#ctor(System.String)"> | ||
4953 | <summary> | ||
4954 | Let's copy all the cookies. | ||
4955 | </summary> | ||
4956 | <param name="cookies">value from cookie header.</param> | ||
4957 | </member> | ||
4958 | <member name="M:HttpServer.RequestCookies.Add(HttpServer.RequestCookie)"> | ||
4959 | <summary> | ||
4960 | Adds a cookie in the collection. | ||
4961 | </summary> | ||
4962 | <param name="cookie">cookie to add</param> | ||
4963 | <exception cref="T:System.ArgumentNullException">cookie is null</exception> | ||
4964 | </member> | ||
4965 | <member name="P:HttpServer.RequestCookies.Count"> | ||
4966 | <summary> | ||
4967 | Gets the count of cookies in the collection. | ||
4968 | </summary> | ||
4969 | </member> | ||
4970 | <member name="P:HttpServer.RequestCookies.Item(System.String)"> | ||
4971 | <summary> | ||
4972 | Gets the cookie of a given identifier (null if not existing). | ||
4973 | </summary> | ||
4974 | </member> | ||
4975 | <member name="M:HttpServer.RequestCookies.GetEnumerator"> | ||
4976 | <summary> | ||
4977 | Gets a collection enumerator on the cookie list. | ||
4978 | </summary> | ||
4979 | <returns>collection enumerator</returns> | ||
4980 | </member> | ||
4981 | <member name="M:HttpServer.RequestCookies.Clear"> | ||
4982 | <summary> | ||
4983 | Remove all cookies. | ||
4984 | </summary> | ||
4985 | </member> | ||
4986 | <member name="M:HttpServer.RequestCookies.System#Collections#Generic#IEnumerable{HttpServer#RequestCookie}#GetEnumerator"> | ||
4987 | <summary> | ||
4988 | Returns an enumerator that iterates through the collection. | ||
4989 | </summary> | ||
4990 | |||
4991 | <returns> | ||
4992 | A <see cref="T:System.Collections.Generic.IEnumerator`1"></see> that can be used to iterate through the collection. | ||
4993 | </returns> | ||
4994 | <filterpriority>1</filterpriority> | ||
4995 | </member> | ||
4996 | <member name="M:HttpServer.RequestCookies.Remove(System.String)"> | ||
4997 | <summary> | ||
4998 | Remove a cookie from the collection. | ||
4999 | </summary> | ||
5000 | <param name="cookieName">Name of cookie.</param> | ||
5001 | </member> | ||
5002 | <member name="T:HttpServer.RequestQueue"> | ||
5003 | <summary> | ||
5004 | Used to queue incoming requests. | ||
5005 | </summary> | ||
5006 | </member> | ||
5007 | <member name="M:HttpServer.RequestQueue.#ctor(HttpServer.ProcessRequestHandler)"> | ||
5008 | <summary> | ||
5009 | Initializes a new instance of the <see cref="T:HttpServer.RequestQueue"/> class. | ||
5010 | </summary> | ||
5011 | <param name="handler">Called when a request should be processed.</param> | ||
5012 | </member> | ||
5013 | <member name="T:HttpServer.RequestQueue.QueueItem"> | ||
5014 | <summary> | ||
5015 | Used two queue incoming requests to avoid | ||
5016 | thread starvation. | ||
5017 | </summary> | ||
5018 | </member> | ||
5019 | <member name="P:HttpServer.RequestQueue.MaxRequestCount"> | ||
5020 | <summary> | ||
5021 | Gets or sets maximum number of allowed simultaneous requests. | ||
5022 | </summary> | ||
5023 | </member> | ||
5024 | <member name="P:HttpServer.RequestQueue.MaxQueueSize"> | ||
5025 | <summary> | ||
5026 | Gets or sets maximum number of requests queuing to be handled. | ||
5027 | </summary> | ||
5028 | </member> | ||
5029 | <member name="P:HttpServer.RequestQueue.CurrentRequestCount"> | ||
5030 | <summary> | ||
5031 | Specifies how many requests the HTTP server is currently processing. | ||
5032 | </summary> | ||
5033 | </member> | ||
5034 | <member name="M:HttpServer.RequestQueue.QueueThread"> | ||
5035 | <summary> | ||
5036 | Used to process queued requests. | ||
5037 | </summary> | ||
5038 | </member> | ||
5039 | <member name="T:HttpServer.ProcessRequestHandler"> | ||
5040 | <summary> | ||
5041 | Method used to process a queued request | ||
5042 | </summary> | ||
5043 | <param name="context">Context that the request was received from.</param> | ||
5044 | <param name="request">Request to process.</param> | ||
5045 | </member> | ||
5046 | <member name="T:HttpServer.ResponseCookie"> | ||
5047 | <summary> | ||
5048 | cookie being sent back to the browser. | ||
5049 | </summary> | ||
5050 | <seealso cref="T:HttpServer.ResponseCookie"/> | ||
5051 | </member> | ||
5052 | <member name="M:HttpServer.ResponseCookie.#ctor(System.String,System.String,System.DateTime)"> | ||
5053 | <summary> | ||
5054 | Constructor. | ||
5055 | </summary> | ||
5056 | <param name="id">cookie identifier</param> | ||
5057 | <param name="content">cookie content</param> | ||
5058 | <param name="expiresAt">cookie expiration date. Use DateTime.MinValue for session cookie.</param> | ||
5059 | <exception cref="T:System.ArgumentNullException">id or content is null</exception> | ||
5060 | <exception cref="T:System.ArgumentException">id is empty</exception> | ||
5061 | </member> | ||
5062 | <member name="M:HttpServer.ResponseCookie.#ctor(System.String,System.String,System.DateTime,System.String,System.String)"> | ||
5063 | <summary> | ||
5064 | Create a new cookie | ||
5065 | </summary> | ||
5066 | <param name="name">name identifying the cookie</param> | ||
5067 | <param name="value">cookie value</param> | ||
5068 | <param name="expires">when the cookie expires. Setting DateTime.MinValue will delete the cookie when the session is closed.</param> | ||
5069 | <param name="path">Path to where the cookie is valid</param> | ||
5070 | <param name="domain">Domain that the cookie is valid for.</param> | ||
5071 | </member> | ||
5072 | <member name="M:HttpServer.ResponseCookie.#ctor(HttpServer.RequestCookie,System.DateTime)"> | ||
5073 | <summary> | ||
5074 | Create a new cookie | ||
5075 | </summary> | ||
5076 | <param name="cookie">Name and value will be used</param> | ||
5077 | <param name="expires">when the cookie expires.</param> | ||
5078 | </member> | ||
5079 | <member name="M:HttpServer.ResponseCookie.ToString"> | ||
5080 | <summary> | ||
5081 | Gets the cookie HTML representation. | ||
5082 | </summary> | ||
5083 | <returns>cookie string</returns> | ||
5084 | </member> | ||
5085 | <member name="P:HttpServer.ResponseCookie.Expires"> | ||
5086 | <summary> | ||
5087 | When the cookie expires. | ||
5088 | DateTime.MinValue means that the cookie expires when the session do so. | ||
5089 | </summary> | ||
5090 | </member> | ||
5091 | <member name="P:HttpServer.ResponseCookie.Path"> | ||
5092 | <summary> | ||
5093 | Cookie is only valid under this path. | ||
5094 | </summary> | ||
5095 | </member> | ||
5096 | <member name="T:HttpServer.ResponseCookies"> | ||
5097 | <summary> | ||
5098 | Cookies that should be set. | ||
5099 | </summary> | ||
5100 | </member> | ||
5101 | <member name="M:HttpServer.ResponseCookies.Add(HttpServer.ResponseCookie)"> | ||
5102 | <summary> | ||
5103 | Adds a cookie in the collection. | ||
5104 | </summary> | ||
5105 | <param name="cookie">cookie to add</param> | ||
5106 | <exception cref="T:System.ArgumentNullException">cookie is null</exception> | ||
5107 | </member> | ||
5108 | <member name="M:HttpServer.ResponseCookies.Add(HttpServer.RequestCookie,System.DateTime)"> | ||
5109 | <summary> | ||
5110 | Copy a request cookie | ||
5111 | </summary> | ||
5112 | <param name="cookie"></param> | ||
5113 | <param name="expires">When the cookie should expire</param> | ||
5114 | </member> | ||
5115 | <member name="P:HttpServer.ResponseCookies.Count"> | ||
5116 | <summary> | ||
5117 | Gets the count of cookies in the collection. | ||
5118 | </summary> | ||
5119 | </member> | ||
5120 | <member name="P:HttpServer.ResponseCookies.Item(System.String)"> | ||
5121 | <summary> | ||
5122 | Gets the cookie of a given identifier (null if not existing). | ||
5123 | </summary> | ||
5124 | </member> | ||
5125 | <member name="M:HttpServer.ResponseCookies.GetEnumerator"> | ||
5126 | <summary> | ||
5127 | Gets a collection enumerator on the cookie list. | ||
5128 | </summary> | ||
5129 | <returns>collection enumerator</returns> | ||
5130 | </member> | ||
5131 | <member name="M:HttpServer.ResponseCookies.Clear"> | ||
5132 | <summary> | ||
5133 | Remove all cookies | ||
5134 | </summary> | ||
5135 | </member> | ||
5136 | <member name="M:HttpServer.ResponseCookies.System#Collections#Generic#IEnumerable{HttpServer#ResponseCookie}#GetEnumerator"> | ||
5137 | <summary> | ||
5138 | Returns an enumerator that iterates through the collection. | ||
5139 | </summary> | ||
5140 | |||
5141 | <returns> | ||
5142 | A <see cref="T:System.Collections.Generic.IEnumerator`1"></see> that can be used to iterate through the collection. | ||
5143 | </returns> | ||
5144 | <filterpriority>1</filterpriority> | ||
5145 | </member> | ||
5146 | <member name="T:HttpServer.Rules.IRule"> | ||
5147 | <summary> | ||
5148 | Rules are used to perform operations before a request is being handled. | ||
5149 | Rules can be used to create routing etc. | ||
5150 | </summary> | ||
5151 | </member> | ||
5152 | <member name="M:HttpServer.Rules.IRule.Process(HttpServer.IHttpRequest,HttpServer.IHttpResponse)"> | ||
5153 | <summary> | ||
5154 | Process the incoming request. | ||
5155 | </summary> | ||
5156 | <param name="request">incoming HTTP request</param> | ||
5157 | <param name="response">outgoing HTTP response</param> | ||
5158 | <returns>true if response should be sent to the browser directly (no other rules or modules will be processed).</returns> | ||
5159 | <remarks> | ||
5160 | returning true means that no modules will get the request. Returning true is typically being done | ||
5161 | for redirects. | ||
5162 | </remarks> | ||
5163 | <exception cref="T:System.ArgumentNullException">If request or response is null.</exception> | ||
5164 | </member> | ||
5165 | <member name="T:HttpServer.Rules.RedirectRule"> | ||
5166 | <summary> | ||
5167 | redirects from one URL to another. | ||
5168 | </summary> | ||
5169 | </member> | ||
5170 | <member name="M:HttpServer.Rules.RedirectRule.#ctor(System.String,System.String)"> | ||
5171 | <summary> | ||
5172 | Initializes a new instance of the <see cref="T:HttpServer.Rules.RedirectRule"/> class. | ||
5173 | </summary> | ||
5174 | <param name="fromUrl">Absolute path (no server name)</param> | ||
5175 | <param name="toUrl">Absolute path (no server name)</param> | ||
5176 | <example> | ||
5177 | server.Add(new RedirectRule("/", "/user/index")); | ||
5178 | </example> | ||
5179 | </member> | ||
5180 | <member name="M:HttpServer.Rules.RedirectRule.#ctor(System.String,System.String,System.Boolean)"> | ||
5181 | <summary> | ||
5182 | Initializes a new instance of the <see cref="T:HttpServer.Rules.RedirectRule"/> class. | ||
5183 | </summary> | ||
5184 | <param name="fromUrl">Absolute path (no server name)</param> | ||
5185 | <param name="toUrl">Absolute path (no server name)</param> | ||
5186 | <param name="shouldRedirect">true if request should be redirected, false if the request URI should be replaced.</param> | ||
5187 | <example> | ||
5188 | server.Add(new RedirectRule("/", "/user/index")); | ||
5189 | </example> | ||
5190 | </member> | ||
5191 | <member name="P:HttpServer.Rules.RedirectRule.FromUrl"> | ||
5192 | <summary> | ||
5193 | Gets string to match request URI with. | ||
5194 | </summary> | ||
5195 | <remarks>Is compared to request.Uri.AbsolutePath</remarks> | ||
5196 | </member> | ||
5197 | <member name="P:HttpServer.Rules.RedirectRule.ToUrl"> | ||
5198 | <summary> | ||
5199 | Gets where to redirect. | ||
5200 | </summary> | ||
5201 | </member> | ||
5202 | <member name="P:HttpServer.Rules.RedirectRule.ShouldRedirect"> | ||
5203 | <summary> | ||
5204 | Gets whether server should redirect client. | ||
5205 | </summary> | ||
5206 | <remarks> | ||
5207 | <c>false</c> means that the rule will replace | ||
5208 | the current request URI with the new one from this class. | ||
5209 | <c>true</c> means that a redirect response is sent to the client. | ||
5210 | </remarks> | ||
5211 | </member> | ||
5212 | <member name="M:HttpServer.Rules.RedirectRule.Process(HttpServer.IHttpRequest,HttpServer.IHttpResponse)"> | ||
5213 | <summary> | ||
5214 | Process the incoming request. | ||
5215 | </summary> | ||
5216 | <param name="request">incoming HTTP request</param> | ||
5217 | <param name="response">outgoing HTTP response</param> | ||
5218 | <returns>true if response should be sent to the browser directly (no other rules or modules will be processed).</returns> | ||
5219 | <remarks> | ||
5220 | returning true means that no modules will get the request. Returning true is typically being done | ||
5221 | for redirects. | ||
5222 | </remarks> | ||
5223 | </member> | ||
5224 | <member name="T:HttpServer.Rules.RegexRedirectRule"> | ||
5225 | <summary> | ||
5226 | Class to make dynamic binding of redirects. Instead of having to specify a number of similar redirect rules | ||
5227 | a regular expression can be used to identify redirect URLs and their targets. | ||
5228 | </summary> | ||
5229 | <example> | ||
5230 | <![CDATA[ | ||
5231 | new RegexRedirectRule("/(?<target>[a-z0-9]+)", "/users/${target}?find=true", RegexOptions.IgnoreCase) | ||
5232 | ]]> | ||
5233 | </example> | ||
5234 | </member> | ||
5235 | <member name="M:HttpServer.Rules.RegexRedirectRule.#ctor(System.String,System.String)"> | ||
5236 | <summary> | ||
5237 | Initializes a new instance of the <see cref="T:HttpServer.Rules.RegexRedirectRule"/> class. | ||
5238 | </summary> | ||
5239 | <param name="fromUrlExpression">Expression to match URL</param> | ||
5240 | <param name="toUrlExpression">Expression to generate URL</param> | ||
5241 | <example> | ||
5242 | <![CDATA[ | ||
5243 | server.Add(new RegexRedirectRule("/(?<first>[a-zA-Z0-9]+)", "/user/${first}")); | ||
5244 | Result of ie. /employee1 will then be /user/employee1 | ||
5245 | ]]> | ||
5246 | </example> | ||
5247 | </member> | ||
5248 | <member name="M:HttpServer.Rules.RegexRedirectRule.#ctor(System.String,System.String,System.Text.RegularExpressions.RegexOptions)"> | ||
5249 | <summary> | ||
5250 | Initializes a new instance of the <see cref="T:HttpServer.Rules.RegexRedirectRule"/> class. | ||
5251 | </summary> | ||
5252 | <param name="fromUrlExpression">Expression to match URL</param> | ||
5253 | <param name="toUrlExpression">Expression to generate URL</param> | ||
5254 | <param name="options">Regular expression options to use, can be null</param> | ||
5255 | <example> | ||
5256 | <![CDATA[ | ||
5257 | server.Add(new RegexRedirectRule("/(?<first>[a-zA-Z0-9]+)", "/user/{first}", RegexOptions.IgnoreCase)); | ||
5258 | Result of ie. /employee1 will then be /user/employee1 | ||
5259 | ]]> | ||
5260 | </example> | ||
5261 | </member> | ||
5262 | <member name="M:HttpServer.Rules.RegexRedirectRule.#ctor(System.String,System.String,System.Text.RegularExpressions.RegexOptions,System.Boolean)"> | ||
5263 | <summary> | ||
5264 | Initializes a new instance of the <see cref="T:HttpServer.Rules.RegexRedirectRule"/> class. | ||
5265 | </summary> | ||
5266 | <param name="fromUrlExpression">Expression to match URL</param> | ||
5267 | <param name="toUrlExpression">Expression to generate URL</param> | ||
5268 | <param name="options">Regular expression options to apply</param> | ||
5269 | <param name="shouldRedirect"><c>true</c> if request should be redirected, <c>false</c> if the request URI should be replaced.</param> | ||
5270 | <example> | ||
5271 | <![CDATA[ | ||
5272 | server.Add(new RegexRedirectRule("/(?<first>[a-zA-Z0-9]+)", "/user/${first}", RegexOptions.None)); | ||
5273 | Result of ie. /employee1 will then be /user/employee1 | ||
5274 | ]]> | ||
5275 | </example> | ||
5276 | <exception cref="T:System.ArgumentNullException">Argument is null.</exception> | ||
5277 | <seealso cref="P:HttpServer.Rules.RedirectRule.ShouldRedirect"/> | ||
5278 | </member> | ||
5279 | <member name="M:HttpServer.Rules.RegexRedirectRule.Process(HttpServer.IHttpRequest,HttpServer.IHttpResponse)"> | ||
5280 | <summary> | ||
5281 | Process the incoming request. | ||
5282 | </summary> | ||
5283 | <param name="request">incoming HTTP request</param> | ||
5284 | <param name="response">outgoing HTTP response</param> | ||
5285 | <returns>true if response should be sent to the browser directly (no other rules or modules will be processed).</returns> | ||
5286 | <remarks> | ||
5287 | returning true means that no modules will get the request. Returning true is typically being done | ||
5288 | for redirects. | ||
5289 | </remarks> | ||
5290 | <exception cref="T:System.ArgumentNullException">If request or response is null</exception> | ||
5291 | </member> | ||
5292 | <member name="T:HttpServer.Sessions.IHttpSession"> | ||
5293 | <summary> | ||
5294 | Interface for sessions | ||
5295 | </summary> | ||
5296 | </member> | ||
5297 | <member name="P:HttpServer.Sessions.IHttpSession.Id"> | ||
5298 | <summary> | ||
5299 | Session id | ||
5300 | </summary> | ||
5301 | </member> | ||
5302 | <member name="P:HttpServer.Sessions.IHttpSession.Item(System.String)"> | ||
5303 | <summary> | ||
5304 | Should | ||
5305 | </summary> | ||
5306 | <param name="name">Name of the session variable</param> | ||
5307 | <returns>null if it's not set</returns> | ||
5308 | <exception cref="T:System.Runtime.Serialization.SerializationException">If the object cant be serialized.</exception> | ||
5309 | </member> | ||
5310 | <member name="P:HttpServer.Sessions.IHttpSession.Accessed"> | ||
5311 | <summary> | ||
5312 | When the session was last accessed. | ||
5313 | This property is touched by the http server each time the | ||
5314 | session is requested. | ||
5315 | </summary> | ||
5316 | </member> | ||
5317 | <member name="P:HttpServer.Sessions.IHttpSession.Count"> | ||
5318 | <summary> | ||
5319 | Number of session variables. | ||
5320 | </summary> | ||
5321 | </member> | ||
5322 | <member name="M:HttpServer.Sessions.IHttpSession.Clear"> | ||
5323 | <summary> | ||
5324 | Remove everything from the session | ||
5325 | </summary> | ||
5326 | </member> | ||
5327 | <member name="M:HttpServer.Sessions.IHttpSession.Clear(System.Boolean)"> | ||
5328 | <summary> | ||
5329 | Remove everything from the session | ||
5330 | </summary> | ||
5331 | <param name="expires">True if the session is cleared due to expiration</param> | ||
5332 | </member> | ||
5333 | <member name="E:HttpServer.Sessions.IHttpSession.BeforeClear"> | ||
5334 | <summary> | ||
5335 | Event triggered upon clearing the session | ||
5336 | </summary> | ||
5337 | </member> | ||
5338 | <member name="T:HttpServer.Sessions.HttpSessionClearedArgs"> | ||
5339 | <summary> | ||
5340 | Arguments sent when a <see cref="T:HttpServer.Sessions.IHttpSession" /> is cleared | ||
5341 | </summary> | ||
5342 | </member> | ||
5343 | <member name="M:HttpServer.Sessions.HttpSessionClearedArgs.#ctor(System.Boolean)"> | ||
5344 | <summary> | ||
5345 | Instantiates the arguments for the event | ||
5346 | </summary> | ||
5347 | <param name="expired">True if the session is cleared due to expiration</param> | ||
5348 | </member> | ||
5349 | <member name="P:HttpServer.Sessions.HttpSessionClearedArgs.Expired"> | ||
5350 | <summary> | ||
5351 | Returns true if the session is cleared due to expiration | ||
5352 | </summary> | ||
5353 | </member> | ||
5354 | <member name="T:HttpServer.Sessions.HttpSessionClearedHandler"> | ||
5355 | <summary> | ||
5356 | Delegate for when a IHttpSession is cleared | ||
5357 | </summary> | ||
5358 | <param name="session"><see cref="T:HttpServer.Sessions.IHttpSession"/> this is being cleared.</param> | ||
5359 | <param name="args">Arguments for the clearing</param> | ||
5360 | </member> | ||
5361 | <member name="T:HttpServer.Sessions.IHttpSessionStore"> | ||
5362 | <summary> | ||
5363 | A session store is used to store and load sessions on a media. | ||
5364 | The default implementation (<see cref="T:HttpServer.Sessions.MemorySessionStore"/>) saves/retrieves sessions from memory. | ||
5365 | </summary> | ||
5366 | </member> | ||
5367 | <member name="P:HttpServer.Sessions.IHttpSessionStore.Item(System.String)"> | ||
5368 | <summary> | ||
5369 | Load a session from the store | ||
5370 | </summary> | ||
5371 | <param name="sessionId"></param> | ||
5372 | <returns>null if session is not found.</returns> | ||
5373 | </member> | ||
5374 | <member name="P:HttpServer.Sessions.IHttpSessionStore.ExpireTime"> | ||
5375 | <summary> | ||
5376 | Number of minutes before a session expires. | ||
5377 | </summary> | ||
5378 | <value>Default time is 20 minutes.</value> | ||
5379 | </member> | ||
5380 | <member name="M:HttpServer.Sessions.IHttpSessionStore.Create"> | ||
5381 | <summary> | ||
5382 | Creates a new http session with a generated id. | ||
5383 | </summary> | ||
5384 | <returns>A <see cref="T:HttpServer.Sessions.IHttpSession"/> object</returns> | ||
5385 | </member> | ||
5386 | <member name="M:HttpServer.Sessions.IHttpSessionStore.Create(System.String)"> | ||
5387 | <summary> | ||
5388 | Creates a new http session with a specific id | ||
5389 | </summary> | ||
5390 | <param name="id">Id used to identify the new cookie..</param> | ||
5391 | <returns>A <see cref="T:HttpServer.Sessions.IHttpSession"/> object.</returns> | ||
5392 | <remarks> | ||
5393 | Id should be generated by the store implementation if it's null or <see cref="F:System.String.Empty"/>. | ||
5394 | </remarks> | ||
5395 | </member> | ||
5396 | <member name="M:HttpServer.Sessions.IHttpSessionStore.Load(System.String)"> | ||
5397 | <summary> | ||
5398 | Load an existing session. | ||
5399 | </summary> | ||
5400 | <param name="sessionId">Session id (usually retrieved from a client side cookie).</param> | ||
5401 | <returns>A session if found; otherwise null.</returns> | ||
5402 | </member> | ||
5403 | <member name="M:HttpServer.Sessions.IHttpSessionStore.Save(HttpServer.Sessions.IHttpSession)"> | ||
5404 | <summary> | ||
5405 | Save an updated session to the store. | ||
5406 | </summary> | ||
5407 | <param name="session">Session id (usually retrieved from a client side cookie).</param> | ||
5408 | <exception cref="T:System.ArgumentException">If Id property have not been specified.</exception> | ||
5409 | </member> | ||
5410 | <member name="M:HttpServer.Sessions.IHttpSessionStore.AddUnused(HttpServer.Sessions.IHttpSession)"> | ||
5411 | <summary> | ||
5412 | We use the flyweight pattern which reuses small objects | ||
5413 | instead of creating new each time. | ||
5414 | </summary> | ||
5415 | <param name="session">Unused session that should be reused next time Create is called.</param> | ||
5416 | </member> | ||
5417 | <member name="M:HttpServer.Sessions.IHttpSessionStore.Cleanup"> | ||
5418 | <summary> | ||
5419 | Remove expired sessions | ||
5420 | </summary> | ||
5421 | </member> | ||
5422 | <member name="M:HttpServer.Sessions.IHttpSessionStore.Remove(System.String)"> | ||
5423 | <summary> | ||
5424 | Remove a session | ||
5425 | </summary> | ||
5426 | <param name="sessionId">id of the session.</param> | ||
5427 | </member> | ||
5428 | <member name="T:HttpServer.Sessions.MemorySession"> | ||
5429 | <summary> | ||
5430 | A session stored in memory. | ||
5431 | </summary> | ||
5432 | </member> | ||
5433 | <member name="M:HttpServer.Sessions.MemorySession.#ctor(System.String)"> | ||
5434 | <summary> | ||
5435 | |||
5436 | </summary> | ||
5437 | <param name="id">A unique id used by the sessions store to identify the session</param> | ||
5438 | </member> | ||
5439 | <member name="M:HttpServer.Sessions.MemorySession.SetId(System.String)"> | ||
5440 | <summary> | ||
5441 | Id | ||
5442 | </summary> | ||
5443 | <param name="id"></param> | ||
5444 | </member> | ||
5445 | <member name="P:HttpServer.Sessions.MemorySession.Id"> | ||
5446 | <summary> | ||
5447 | Session id | ||
5448 | </summary> | ||
5449 | </member> | ||
5450 | <member name="P:HttpServer.Sessions.MemorySession.Item(System.String)"> | ||
5451 | <summary> | ||
5452 | Should | ||
5453 | </summary> | ||
5454 | <param name="name">Name of the session variable</param> | ||
5455 | <returns>null if it's not set</returns> | ||
5456 | </member> | ||
5457 | <member name="P:HttpServer.Sessions.MemorySession.Accessed"> | ||
5458 | <summary> | ||
5459 | when the session was last accessed. | ||
5460 | </summary> | ||
5461 | <remarks> | ||
5462 | Used to determine when the session should be removed. | ||
5463 | </remarks> | ||
5464 | </member> | ||
5465 | <member name="P:HttpServer.Sessions.MemorySession.Count"> | ||
5466 | <summary> | ||
5467 | Number of values in the session | ||
5468 | </summary> | ||
5469 | </member> | ||
5470 | <member name="P:HttpServer.Sessions.MemorySession.Changed"> | ||
5471 | <summary> | ||
5472 | Flag to indicate that the session have been changed | ||
5473 | and should be saved into the session store. | ||
5474 | </summary> | ||
5475 | </member> | ||
5476 | <member name="M:HttpServer.Sessions.MemorySession.Clear"> | ||
5477 | <summary> | ||
5478 | Remove everything from the session | ||
5479 | </summary> | ||
5480 | </member> | ||
5481 | <member name="M:HttpServer.Sessions.MemorySession.Clear(System.Boolean)"> | ||
5482 | <summary> | ||
5483 | Clears the specified expire. | ||
5484 | </summary> | ||
5485 | <param name="expires">True if the session is cleared due to expiration</param> | ||
5486 | </member> | ||
5487 | <member name="M:HttpServer.Sessions.MemorySession.Dispose"> | ||
5488 | <summary> | ||
5489 | Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. | ||
5490 | </summary> | ||
5491 | <filterpriority>2</filterpriority> | ||
5492 | </member> | ||
5493 | <member name="E:HttpServer.Sessions.MemorySession.BeforeClear"> | ||
5494 | <summary> | ||
5495 | Event triggered upon clearing the session | ||
5496 | </summary> | ||
5497 | </member> | ||
5498 | <member name="T:HttpServer.Sessions.MemorySessionStore"> | ||
5499 | <summary> | ||
5500 | Session store using memory for each session. | ||
5501 | </summary> | ||
5502 | </member> | ||
5503 | <member name="M:HttpServer.Sessions.MemorySessionStore.#ctor"> | ||
5504 | <summary> | ||
5505 | Initializes the class setting the expirationtimer to clean the session every minute | ||
5506 | </summary> | ||
5507 | </member> | ||
5508 | <member name="M:HttpServer.Sessions.MemorySessionStore.Cleanup(System.Object)"> | ||
5509 | <summary> | ||
5510 | Delegate for the cleanup timer | ||
5511 | </summary> | ||
5512 | </member> | ||
5513 | <member name="P:HttpServer.Sessions.MemorySessionStore.Item(System.String)"> | ||
5514 | <summary> | ||
5515 | Load a session from the store | ||
5516 | </summary> | ||
5517 | <param name="sessionId"></param> | ||
5518 | <returns>null if session is not found.</returns> | ||
5519 | </member> | ||
5520 | <member name="M:HttpServer.Sessions.MemorySessionStore.Create"> | ||
5521 | <summary> | ||
5522 | Creates a new http session | ||
5523 | </summary> | ||
5524 | <returns></returns> | ||
5525 | </member> | ||
5526 | <member name="M:HttpServer.Sessions.MemorySessionStore.Create(System.String)"> | ||
5527 | <summary> | ||
5528 | Creates a new http session with a specific id | ||
5529 | </summary> | ||
5530 | <param name="id">Id used to identify the new cookie..</param> | ||
5531 | <returns>A <see cref="T:HttpServer.Sessions.IHttpSession"/> object.</returns> | ||
5532 | <remarks> | ||
5533 | Id should be generated by the store implementation if it's null or <see cref="F:System.String.Empty"/>. | ||
5534 | </remarks> | ||
5535 | </member> | ||
5536 | <member name="M:HttpServer.Sessions.MemorySessionStore.Load(System.String)"> | ||
5537 | <summary> | ||
5538 | Load an existing session. | ||
5539 | </summary> | ||
5540 | <param name="sessionId"></param> | ||
5541 | <returns></returns> | ||
5542 | </member> | ||
5543 | <member name="M:HttpServer.Sessions.MemorySessionStore.Save(HttpServer.Sessions.IHttpSession)"> | ||
5544 | <summary> | ||
5545 | Save an updated session to the store. | ||
5546 | </summary> | ||
5547 | <param name="session"></param> | ||
5548 | </member> | ||
5549 | <member name="M:HttpServer.Sessions.MemorySessionStore.AddUnused(HttpServer.Sessions.IHttpSession)"> | ||
5550 | <summary> | ||
5551 | We use the flyweight pattern which reuses small objects | ||
5552 | instead of creating new each time. | ||
5553 | </summary> | ||
5554 | <param name="session">EmptyLanguageNode (unused) session that should be reused next time Create is called.</param> | ||
5555 | </member> | ||
5556 | <member name="M:HttpServer.Sessions.MemorySessionStore.Cleanup"> | ||
5557 | <summary> | ||
5558 | Remove expired sessions | ||
5559 | </summary> | ||
5560 | </member> | ||
5561 | <member name="M:HttpServer.Sessions.MemorySessionStore.Remove(System.String)"> | ||
5562 | <summary> | ||
5563 | Remove a session | ||
5564 | </summary> | ||
5565 | <param name="sessionId">id of the session.</param> | ||
5566 | </member> | ||
5567 | <member name="P:HttpServer.Sessions.MemorySessionStore.ExpireTime"> | ||
5568 | <summary> | ||
5569 | Number of minutes before a session expires. | ||
5570 | Default is 20 minutes. | ||
5571 | </summary> | ||
5572 | </member> | ||
5573 | </members> | ||
5574 | </doc> | ||
diff --git a/bin/ICSharpCode.SharpZipLib.dll b/bin/ICSharpCode.SharpZipLib.dll index fe643eb..3b268b7 100644 --- a/bin/ICSharpCode.SharpZipLib.dll +++ b/bin/ICSharpCode.SharpZipLib.dll | |||
Binary files differ | |||
diff --git a/bin/Ionic.Zip.dll b/bin/Ionic.Zip.dll index e37f1bd..ce50258 100755 --- a/bin/Ionic.Zip.dll +++ b/bin/Ionic.Zip.dll | |||
Binary files differ | |||
diff --git a/bin/LukeSkywalker.IPNetwork.dll b/bin/LukeSkywalker.IPNetwork.dll index 25bcc2f..9144939 100755 --- a/bin/LukeSkywalker.IPNetwork.dll +++ b/bin/LukeSkywalker.IPNetwork.dll | |||
Binary files differ | |||
diff --git a/bin/Mono.Addins.CecilReflector.dll b/bin/Mono.Addins.CecilReflector.dll index bbda91d..8fd9ad7 100755 --- a/bin/Mono.Addins.CecilReflector.dll +++ b/bin/Mono.Addins.CecilReflector.dll | |||
Binary files differ | |||
diff --git a/bin/Mono.Addins.Setup.dll b/bin/Mono.Addins.Setup.dll index 68c3121..a2b3598 100755 --- a/bin/Mono.Addins.Setup.dll +++ b/bin/Mono.Addins.Setup.dll | |||
Binary files differ | |||
diff --git a/bin/Mono.Addins.Setup.xml b/bin/Mono.Addins.Setup.xml deleted file mode 100644 index f5ce70a..0000000 --- a/bin/Mono.Addins.Setup.xml +++ /dev/null | |||
@@ -1,1140 +0,0 @@ | |||
1 | <?xml version="1.0"?> | ||
2 | <doc> | ||
3 | <assembly> | ||
4 | <name>Mono.Addins.Setup</name> | ||
5 | </assembly> | ||
6 | <members> | ||
7 | <member name="T:Mono.Addins.Setup.ConsoleAddinInstaller"> | ||
8 | <summary> | ||
9 | An IAddinInstaller implementation which interacts with the user through the console | ||
10 | </summary> | ||
11 | </member> | ||
12 | <member name="M:Mono.Addins.Setup.ConsoleAddinInstaller.#ctor"> | ||
13 | <summary> | ||
14 | Initializes a new instance of the <see cref="T:Mono.Addins.Setup.ConsoleAddinInstaller"/> class. | ||
15 | </summary> | ||
16 | </member> | ||
17 | <member name="P:Mono.Addins.Setup.ConsoleAddinInstaller.UserPrompt"> | ||
18 | <summary> | ||
19 | Gets or sets whether the installer can ask questions to the user | ||
20 | </summary> | ||
21 | </member> | ||
22 | <member name="P:Mono.Addins.Setup.ConsoleAddinInstaller.LogLevel"> | ||
23 | <summary> | ||
24 | Log level (0:normal, 1+:verbose); | ||
25 | </summary> | ||
26 | </member> | ||
27 | <member name="T:Mono.Addins.Setup.Package"> | ||
28 | <summary> | ||
29 | An add-in package | ||
30 | </summary> | ||
31 | </member> | ||
32 | <member name="M:Mono.Addins.Setup.Package.FromRepository(Mono.Addins.Setup.AddinRepositoryEntry)"> | ||
33 | <summary> | ||
34 | Creates a package object for an add-in available in an on-line repository | ||
35 | </summary> | ||
36 | <param name="repAddin"> | ||
37 | An add-in reference | ||
38 | </param> | ||
39 | <returns> | ||
40 | The package | ||
41 | </returns> | ||
42 | </member> | ||
43 | <member name="M:Mono.Addins.Setup.Package.FromFile(System.String)"> | ||
44 | <summary> | ||
45 | Creates a package object for a local package file | ||
46 | </summary> | ||
47 | <param name="file"> | ||
48 | Package file path | ||
49 | </param> | ||
50 | <returns> | ||
51 | The package | ||
52 | </returns> | ||
53 | </member> | ||
54 | <member name="P:Mono.Addins.Setup.Package.Name"> | ||
55 | <summary> | ||
56 | Name of the package | ||
57 | </summary> | ||
58 | </member> | ||
59 | <member name="P:Mono.Addins.Setup.Package.SharedInstall"> | ||
60 | <summary> | ||
61 | Returns true if the package will be installed in the shared directory, | ||
62 | false if it will be installed in the user directory. | ||
63 | </summary> | ||
64 | </member> | ||
65 | <member name="T:Mono.Addins.Setup.AddinRepositoryEntry"> | ||
66 | <summary> | ||
67 | A reference to an add-in available in an on-line repository | ||
68 | </summary> | ||
69 | </member> | ||
70 | <member name="M:Mono.Addins.Setup.AddinRepositoryEntry.BeginDownloadSupportFile(System.String,System.AsyncCallback,System.Object)"> | ||
71 | <summary> | ||
72 | Begins downloading a support file | ||
73 | </summary> | ||
74 | <returns> | ||
75 | Result of the asynchronous operation, to be used when calling EndDownloadSupportFile to | ||
76 | get the download result. | ||
77 | </returns> | ||
78 | <param name='name'> | ||
79 | Name of the file. | ||
80 | </param> | ||
81 | <param name='cb'> | ||
82 | Callback to be called when the download operation ends. | ||
83 | </param> | ||
84 | <param name='state'> | ||
85 | Custom state object provided by the caller. | ||
86 | </param> | ||
87 | <remarks> | ||
88 | This method can be used to get the contents of a support file of an add-in. | ||
89 | A support file is a file referenced in the custom properties of an add-in. | ||
90 | </remarks> | ||
91 | </member> | ||
92 | <member name="M:Mono.Addins.Setup.AddinRepositoryEntry.EndDownloadSupportFile(System.IAsyncResult)"> | ||
93 | <summary> | ||
94 | Gets the result of the asynchronous download of a file | ||
95 | </summary> | ||
96 | <returns> | ||
97 | The downloaded file. | ||
98 | </returns> | ||
99 | <param name='ares'> | ||
100 | The async result object returned by BeginDownloadSupportFile. | ||
101 | </param> | ||
102 | </member> | ||
103 | <member name="P:Mono.Addins.Setup.AddinRepositoryEntry.Addin"> | ||
104 | <summary> | ||
105 | Add-in information | ||
106 | </summary> | ||
107 | </member> | ||
108 | <member name="P:Mono.Addins.Setup.AddinRepositoryEntry.Url"> | ||
109 | <summary> | ||
110 | Url to the add-in package | ||
111 | </summary> | ||
112 | </member> | ||
113 | <member name="P:Mono.Addins.Setup.AddinRepositoryEntry.RepositoryUrl"> | ||
114 | <summary> | ||
115 | The URL of the repository | ||
116 | </summary> | ||
117 | </member> | ||
118 | <member name="P:Mono.Addins.Setup.AddinRepositoryEntry.RepositoryName"> | ||
119 | <summary> | ||
120 | Name of the repository | ||
121 | </summary> | ||
122 | </member> | ||
123 | <member name="T:Mono.Addins.Setup.InstallException"> | ||
124 | <summary> | ||
125 | An installation exception | ||
126 | </summary> | ||
127 | </member> | ||
128 | <member name="M:Mono.Addins.Setup.InstallException.#ctor(System.String)"> | ||
129 | <summary> | ||
130 | Initializes the exception | ||
131 | </summary> | ||
132 | <param name="msg"> | ||
133 | Error message | ||
134 | </param> | ||
135 | </member> | ||
136 | <member name="M:Mono.Addins.Setup.InstallException.#ctor(System.String,System.Exception)"> | ||
137 | <summary> | ||
138 | Initializes the exception | ||
139 | </summary> | ||
140 | <param name="msg"> | ||
141 | Error message | ||
142 | </param> | ||
143 | <param name="ex"> | ||
144 | Inner exception | ||
145 | </param> | ||
146 | </member> | ||
147 | <member name="T:Mono.Addins.Setup.SetupTool"> | ||
148 | <summary> | ||
149 | A command line add-in manager. | ||
150 | </summary> | ||
151 | <remarks> | ||
152 | This class can be used to provide an add-in management command line tool to applications. | ||
153 | </remarks> | ||
154 | </member> | ||
155 | <member name="M:Mono.Addins.Setup.SetupTool.#ctor(Mono.Addins.AddinRegistry)"> | ||
156 | <summary> | ||
157 | Creates a new instance | ||
158 | </summary> | ||
159 | <param name="registry"> | ||
160 | Add-in registry to manage. | ||
161 | </param> | ||
162 | </member> | ||
163 | <member name="M:Mono.Addins.Setup.SetupTool.Run(System.String[],System.Int32)"> | ||
164 | <summary> | ||
165 | Runs the command line tool. | ||
166 | </summary> | ||
167 | <param name="args"> | ||
168 | Array that contains the command line arguments | ||
169 | </param> | ||
170 | <param name="firstArgumentIndex"> | ||
171 | Index of the arguments array that has the first argument for the management tool | ||
172 | </param> | ||
173 | <returns> | ||
174 | 0 if it succeeds. != 0 otherwise | ||
175 | </returns> | ||
176 | </member> | ||
177 | <member name="M:Mono.Addins.Setup.SetupTool.Run(System.String[])"> | ||
178 | <summary> | ||
179 | Runs the command line tool. | ||
180 | </summary> | ||
181 | <param name="args"> | ||
182 | Command line arguments | ||
183 | </param> | ||
184 | <returns> | ||
185 | 0 if it succeeds. != 0 otherwise | ||
186 | </returns> | ||
187 | </member> | ||
188 | <member name="M:Mono.Addins.Setup.SetupTool.AddCommand(System.String,System.String,System.String,System.String,System.String,System.String,Mono.Addins.Setup.SetupCommandHandler)"> | ||
189 | <summary> | ||
190 | Adds a custom command to the add-in manager | ||
191 | </summary> | ||
192 | <param name="category"> | ||
193 | Category under which the command has to be shown in the help text | ||
194 | </param> | ||
195 | <param name="command"> | ||
196 | Name of the command | ||
197 | </param> | ||
198 | <param name="shortName"> | ||
199 | Short name of the command (it's an alias of the normal name) | ||
200 | </param> | ||
201 | <param name="arguments"> | ||
202 | Formal description of the arguments that the command accepts. For example: "[addin-id|addin-file] [--xml] [--all] [--full] [--namespace <namespace>]" | ||
203 | </param> | ||
204 | <param name="description"> | ||
205 | Short description of the command | ||
206 | </param> | ||
207 | <param name="longDescription"> | ||
208 | Long description of the command | ||
209 | </param> | ||
210 | <param name="handler"> | ||
211 | Delegate to be invoked to run the command | ||
212 | </param> | ||
213 | </member> | ||
214 | <member name="M:Mono.Addins.Setup.SetupTool.PrintHelp(System.String[])"> | ||
215 | <summary> | ||
216 | Prints help about the add-in management tool, or about a specific command | ||
217 | </summary> | ||
218 | <param name="parms"> | ||
219 | Optional command name and arguments | ||
220 | </param> | ||
221 | </member> | ||
222 | <member name="P:Mono.Addins.Setup.SetupTool.ApplicationName"> | ||
223 | <summary> | ||
224 | Display name of the host application | ||
225 | </summary> | ||
226 | </member> | ||
227 | <member name="P:Mono.Addins.Setup.SetupTool.ApplicationNamespace"> | ||
228 | <summary> | ||
229 | Default add-in namespace of the application (optional). If set, only add-ins that belong to that namespace | ||
230 | will be shown in add-in lists. | ||
231 | </summary> | ||
232 | </member> | ||
233 | <member name="P:Mono.Addins.Setup.SetupTool.VerboseOutput"> | ||
234 | <summary> | ||
235 | Enables or disables verbose output | ||
236 | </summary> | ||
237 | </member> | ||
238 | <member name="P:Mono.Addins.Setup.SetupTool.VerboseOutputLevel"> | ||
239 | <summary> | ||
240 | Sets or gets the verbose output level (0: normal output, 1:verbose, 2+:extra verbose) | ||
241 | </summary> | ||
242 | </member> | ||
243 | <member name="T:Mono.Addins.Setup.SetupCommandHandler"> | ||
244 | <summary> | ||
245 | A command handler | ||
246 | </summary> | ||
247 | </member> | ||
248 | <member name="T:Mono.Addins.Setup.PackageCollection"> | ||
249 | <summary> | ||
250 | A collection of packages | ||
251 | </summary> | ||
252 | </member> | ||
253 | <member name="M:Mono.Addins.Setup.PackageCollection.#ctor"> | ||
254 | <summary> | ||
255 | Initializes a new instance of the <see cref="T:Mono.Addins.Setup.PackageCollection"/> class. | ||
256 | </summary> | ||
257 | </member> | ||
258 | <member name="M:Mono.Addins.Setup.PackageCollection.#ctor(System.Collections.ICollection)"> | ||
259 | <summary> | ||
260 | Copy constructor | ||
261 | </summary> | ||
262 | <param name="col"> | ||
263 | Collection where to copy from | ||
264 | </param> | ||
265 | </member> | ||
266 | <member name="M:Mono.Addins.Setup.PackageCollection.Add(Mono.Addins.Setup.Package)"> | ||
267 | <summary> | ||
268 | Adds a package | ||
269 | </summary> | ||
270 | <param name="p"> | ||
271 | A package | ||
272 | </param> | ||
273 | </member> | ||
274 | <member name="M:Mono.Addins.Setup.PackageCollection.Contains(Mono.Addins.Setup.Package)"> | ||
275 | <summary> | ||
276 | Checks if a package is present in the collection | ||
277 | </summary> | ||
278 | <param name="p"> | ||
279 | The package | ||
280 | </param> | ||
281 | <returns> | ||
282 | True if the package is preent | ||
283 | </returns> | ||
284 | </member> | ||
285 | <member name="M:Mono.Addins.Setup.PackageCollection.AddRange(System.Collections.ICollection)"> | ||
286 | <summary> | ||
287 | Adds a list of packages to the collection | ||
288 | </summary> | ||
289 | <param name="col"> | ||
290 | The list of packages to add | ||
291 | </param> | ||
292 | </member> | ||
293 | <member name="P:Mono.Addins.Setup.PackageCollection.Item(System.Int32)"> | ||
294 | <summary> | ||
295 | Gets a package | ||
296 | </summary> | ||
297 | <param name="n"> | ||
298 | Package index | ||
299 | </param> | ||
300 | </member> | ||
301 | <member name="T:Mono.Addins.Setup.AddinHeader"> | ||
302 | <summary> | ||
303 | Basic add-in information | ||
304 | </summary> | ||
305 | </member> | ||
306 | <member name="M:Mono.Addins.Setup.AddinHeader.CompareVersionTo(Mono.Addins.Setup.AddinHeader)"> | ||
307 | <summary> | ||
308 | Compares the versions of two add-ins | ||
309 | </summary> | ||
310 | <param name="other"> | ||
311 | Another add-in | ||
312 | </param> | ||
313 | <returns> | ||
314 | Result of comparison | ||
315 | </returns> | ||
316 | </member> | ||
317 | <member name="P:Mono.Addins.Setup.AddinHeader.Id"> | ||
318 | <summary> | ||
319 | Full identifier of the add-in | ||
320 | </summary> | ||
321 | </member> | ||
322 | <member name="P:Mono.Addins.Setup.AddinHeader.Name"> | ||
323 | <summary> | ||
324 | Display name of the add-in | ||
325 | </summary> | ||
326 | </member> | ||
327 | <member name="P:Mono.Addins.Setup.AddinHeader.Namespace"> | ||
328 | <summary> | ||
329 | Namespace of the add-in | ||
330 | </summary> | ||
331 | </member> | ||
332 | <member name="P:Mono.Addins.Setup.AddinHeader.Version"> | ||
333 | <summary> | ||
334 | Version of the add-in | ||
335 | </summary> | ||
336 | </member> | ||
337 | <member name="P:Mono.Addins.Setup.AddinHeader.BaseVersion"> | ||
338 | <summary> | ||
339 | Version with which this add-in is compatible | ||
340 | </summary> | ||
341 | </member> | ||
342 | <member name="P:Mono.Addins.Setup.AddinHeader.Author"> | ||
343 | <summary> | ||
344 | Add-in author | ||
345 | </summary> | ||
346 | </member> | ||
347 | <member name="P:Mono.Addins.Setup.AddinHeader.Copyright"> | ||
348 | <summary> | ||
349 | Add-in copyright | ||
350 | </summary> | ||
351 | </member> | ||
352 | <member name="P:Mono.Addins.Setup.AddinHeader.Url"> | ||
353 | <summary> | ||
354 | Web page URL with more information about the add-in | ||
355 | </summary> | ||
356 | </member> | ||
357 | <member name="P:Mono.Addins.Setup.AddinHeader.Description"> | ||
358 | <summary> | ||
359 | Description of the add-in | ||
360 | </summary> | ||
361 | </member> | ||
362 | <member name="P:Mono.Addins.Setup.AddinHeader.Category"> | ||
363 | <summary> | ||
364 | Category of the add-in | ||
365 | </summary> | ||
366 | </member> | ||
367 | <member name="P:Mono.Addins.Setup.AddinHeader.Dependencies"> | ||
368 | <summary> | ||
369 | Dependencies of the add-in | ||
370 | </summary> | ||
371 | </member> | ||
372 | <member name="P:Mono.Addins.Setup.AddinHeader.OptionalDependencies"> | ||
373 | <summary> | ||
374 | Optional dependencies of the add-in | ||
375 | </summary> | ||
376 | </member> | ||
377 | <member name="P:Mono.Addins.Setup.AddinHeader.Properties"> | ||
378 | <summary> | ||
379 | Custom properties specified in the add-in header | ||
380 | </summary> | ||
381 | </member> | ||
382 | <member name="T:Mono.Addins.Setup.RepositoryRegistry"> | ||
383 | <summary> | ||
384 | A registry of on-line repositories | ||
385 | </summary> | ||
386 | <remarks> | ||
387 | This class can be used to manage on-line repository subscriptions. | ||
388 | </remarks> | ||
389 | </member> | ||
390 | <member name="M:Mono.Addins.Setup.RepositoryRegistry.RegisterRepository(Mono.Addins.IProgressStatus,System.String)"> | ||
391 | <summary> | ||
392 | Subscribes to an on-line repository | ||
393 | </summary> | ||
394 | <param name="monitor"> | ||
395 | Progress monitor where to show progress status and log | ||
396 | </param> | ||
397 | <param name="url"> | ||
398 | URL of the repository | ||
399 | </param> | ||
400 | <returns> | ||
401 | A repository reference | ||
402 | </returns> | ||
403 | <remarks> | ||
404 | The repository index is not downloaded by default. It can be downloaded | ||
405 | by calling UpdateRepository. | ||
406 | </remarks> | ||
407 | </member> | ||
408 | <member name="M:Mono.Addins.Setup.RepositoryRegistry.RegisterRepository(Mono.Addins.IProgressStatus,System.String,System.Boolean)"> | ||
409 | <summary> | ||
410 | Subscribes to an on-line repository | ||
411 | </summary> | ||
412 | <param name="monitor"> | ||
413 | Progress monitor where to show progress status and log | ||
414 | </param> | ||
415 | <param name="url"> | ||
416 | URL of the repository | ||
417 | </param> | ||
418 | <param name="updateNow"> | ||
419 | When set to True, the repository index will be downloaded. | ||
420 | </param> | ||
421 | <returns> | ||
422 | A repository reference | ||
423 | </returns> | ||
424 | </member> | ||
425 | <member name="M:Mono.Addins.Setup.RepositoryRegistry.RemoveRepository(System.String)"> | ||
426 | <summary> | ||
427 | Removes an on-line repository subscription. | ||
428 | </summary> | ||
429 | <param name="url"> | ||
430 | URL of the repository. | ||
431 | </param> | ||
432 | </member> | ||
433 | <member name="M:Mono.Addins.Setup.RepositoryRegistry.SetRepositoryEnabled(System.String,System.Boolean)"> | ||
434 | <summary> | ||
435 | Enables or disables a repository | ||
436 | </summary> | ||
437 | <param name='url'> | ||
438 | URL of the repository | ||
439 | </param> | ||
440 | <param name='enabled'> | ||
441 | 'true' if the repository has to be enabled. | ||
442 | </param> | ||
443 | <remarks> | ||
444 | Disabled repositories are ignored when calling UpdateAllRepositories. | ||
445 | </remarks> | ||
446 | </member> | ||
447 | <member name="M:Mono.Addins.Setup.RepositoryRegistry.ContainsRepository(System.String)"> | ||
448 | <summary> | ||
449 | Checks if a repository is already subscribed. | ||
450 | </summary> | ||
451 | <param name="url"> | ||
452 | URL of the repository | ||
453 | </param> | ||
454 | <returns> | ||
455 | True if the repository is already subscribed. | ||
456 | </returns> | ||
457 | </member> | ||
458 | <member name="M:Mono.Addins.Setup.RepositoryRegistry.GetRepositories"> | ||
459 | <summary> | ||
460 | Gets a list of subscribed repositories | ||
461 | </summary> | ||
462 | <returns> | ||
463 | A list of repositories. | ||
464 | </returns> | ||
465 | </member> | ||
466 | <member name="M:Mono.Addins.Setup.RepositoryRegistry.UpdateAllRepositories(Mono.Addins.IProgressStatus)"> | ||
467 | <summary> | ||
468 | Updates the add-in index of all subscribed repositories. | ||
469 | </summary> | ||
470 | <param name="monitor"> | ||
471 | Progress monitor where to show progress status and log | ||
472 | </param> | ||
473 | </member> | ||
474 | <member name="M:Mono.Addins.Setup.RepositoryRegistry.UpdateRepository(Mono.Addins.IProgressStatus,System.String)"> | ||
475 | <summary> | ||
476 | Updates the add-in index of the provided repository | ||
477 | </summary> | ||
478 | <param name="statusMonitor"> | ||
479 | Progress monitor where to show progress status and log | ||
480 | </param> | ||
481 | <param name="url"> | ||
482 | URL of the repository | ||
483 | </param> | ||
484 | </member> | ||
485 | <member name="M:Mono.Addins.Setup.RepositoryRegistry.GetAvailableUpdates"> | ||
486 | <summary> | ||
487 | Gets a list of available add-in updates. | ||
488 | </summary> | ||
489 | <returns> | ||
490 | A list of add-in references. | ||
491 | </returns> | ||
492 | <remarks> | ||
493 | The list is generated by looking at the add-ins currently installed and checking if there is any | ||
494 | add-in with a newer version number in any of the subscribed repositories. This method uses cached | ||
495 | information from on-line repositories. Make sure you call UpdateRepository or UpdateAllRepositories | ||
496 | before using this method to ensure that the latest information is available. | ||
497 | </remarks> | ||
498 | </member> | ||
499 | <member name="M:Mono.Addins.Setup.RepositoryRegistry.GetAvailableUpdates(Mono.Addins.Setup.RepositorySearchFlags)"> | ||
500 | <summary> | ||
501 | Gets a list of available add-in updates. | ||
502 | </summary> | ||
503 | <param name="flags"> | ||
504 | Search flags | ||
505 | </param> | ||
506 | <returns> | ||
507 | A list of add-in references. | ||
508 | </returns> | ||
509 | <remarks> | ||
510 | The list is generated by looking at the add-ins currently installed and checking if there is any | ||
511 | add-in with a newer version number in any of the subscribed repositories. This method uses cached | ||
512 | information from on-line repositories. Make sure you call UpdateRepository or UpdateAllRepositories | ||
513 | before using this method to ensure that the latest information is available. | ||
514 | </remarks> | ||
515 | </member> | ||
516 | <member name="M:Mono.Addins.Setup.RepositoryRegistry.GetAvailableUpdates(System.String)"> | ||
517 | <summary> | ||
518 | Gets a list of available add-in updates in a specific repository. | ||
519 | </summary> | ||
520 | <param name="repositoryUrl"> | ||
521 | The repository URL | ||
522 | </param> | ||
523 | <returns> | ||
524 | A list of add-in references. | ||
525 | </returns> | ||
526 | <remarks> | ||
527 | The list is generated by looking at the add-ins currently installed and checking if there is any | ||
528 | add-in with a newer version number in the provided repository. This method uses cached | ||
529 | information from on-line repositories. Make sure you call UpdateRepository or UpdateAllRepositories | ||
530 | before using this method to ensure that the latest information is available. | ||
531 | </remarks> | ||
532 | </member> | ||
533 | <member name="M:Mono.Addins.Setup.RepositoryRegistry.GetAvailableAddinUpdates(System.String)"> | ||
534 | <summary> | ||
535 | Gets a list of available updates for an add-in. | ||
536 | </summary> | ||
537 | <param name="id"> | ||
538 | Identifier of the add-in. | ||
539 | </param> | ||
540 | <returns> | ||
541 | List of updates for the specified add-in. | ||
542 | </returns> | ||
543 | <remarks> | ||
544 | The list is generated by checking if there is any | ||
545 | add-in with a newer version number in any of the subscribed repositories. This method uses cached | ||
546 | information from on-line repositories. Make sure you call UpdateRepository or UpdateAllRepositories | ||
547 | before using this method to ensure that the latest information is available. | ||
548 | </remarks> | ||
549 | </member> | ||
550 | <member name="M:Mono.Addins.Setup.RepositoryRegistry.GetAvailableAddinUpdates(System.String,Mono.Addins.Setup.RepositorySearchFlags)"> | ||
551 | <summary> | ||
552 | Gets a list of available updates for an add-in. | ||
553 | </summary> | ||
554 | <param name="id"> | ||
555 | Identifier of the add-in. | ||
556 | </param> | ||
557 | <param name='flags'> | ||
558 | Search flags. | ||
559 | </param> | ||
560 | <returns> | ||
561 | List of updates for the specified add-in. | ||
562 | </returns> | ||
563 | <remarks> | ||
564 | The list is generated by checking if there is any | ||
565 | add-in with a newer version number in any of the subscribed repositories. This method uses cached | ||
566 | information from on-line repositories. Make sure you call UpdateRepository or UpdateAllRepositories | ||
567 | before using this method to ensure that the latest information is available. | ||
568 | </remarks> | ||
569 | </member> | ||
570 | <member name="M:Mono.Addins.Setup.RepositoryRegistry.GetAvailableAddinUpdates(System.String,System.String)"> | ||
571 | <summary> | ||
572 | Gets a list of available updates for an add-in in a specific repository | ||
573 | </summary> | ||
574 | <param name="repositoryUrl"> | ||
575 | Identifier of the add-in. | ||
576 | </param> | ||
577 | <param name="id"> | ||
578 | Identifier of the add-in. | ||
579 | </param> | ||
580 | <returns> | ||
581 | List of updates for the specified add-in. | ||
582 | </returns> | ||
583 | <remarks> | ||
584 | The list is generated by checking if there is any | ||
585 | add-in with a newer version number in the provided repository. This method uses cached | ||
586 | information from on-line repositories. Make sure you call UpdateRepository or UpdateAllRepositories | ||
587 | before using this method to ensure that the latest information is available. | ||
588 | </remarks> | ||
589 | </member> | ||
590 | <member name="M:Mono.Addins.Setup.RepositoryRegistry.GetAvailableAddinUpdates(System.String,System.String,Mono.Addins.Setup.RepositorySearchFlags)"> | ||
591 | <summary> | ||
592 | Gets a list of available updates for an add-in in a specific repository | ||
593 | </summary> | ||
594 | <param name="repositoryUrl"> | ||
595 | Identifier of the add-in. | ||
596 | </param> | ||
597 | <param name="id"> | ||
598 | Identifier of the add-in. | ||
599 | </param> | ||
600 | <param name='flags'> | ||
601 | Search flags. | ||
602 | </param> | ||
603 | <returns> | ||
604 | List of updates for the specified add-in. | ||
605 | </returns> | ||
606 | <remarks> | ||
607 | The list is generated by checking if there is any | ||
608 | add-in with a newer version number in the provided repository. This method uses cached | ||
609 | information from on-line repositories. Make sure you call UpdateRepository or UpdateAllRepositories | ||
610 | before using this method to ensure that the latest information is available. | ||
611 | </remarks> | ||
612 | </member> | ||
613 | <member name="M:Mono.Addins.Setup.RepositoryRegistry.GetAvailableAddins"> | ||
614 | <summary> | ||
615 | Gets a list of all available add-ins | ||
616 | </summary> | ||
617 | <returns> | ||
618 | A list of add-ins | ||
619 | </returns> | ||
620 | <remarks> | ||
621 | This method uses cached | ||
622 | information from on-line repositories. Make sure you call UpdateRepository or UpdateAllRepositories | ||
623 | before using this method to ensure that the latest information is available. | ||
624 | </remarks> | ||
625 | </member> | ||
626 | <member name="M:Mono.Addins.Setup.RepositoryRegistry.GetAvailableAddins(Mono.Addins.Setup.RepositorySearchFlags)"> | ||
627 | <summary> | ||
628 | Gets a list of all available add-ins | ||
629 | </summary> | ||
630 | <returns> | ||
631 | The available addins. | ||
632 | </returns> | ||
633 | <param name='flags'> | ||
634 | Search flags. | ||
635 | </param> | ||
636 | <remarks> | ||
637 | This method uses cached | ||
638 | information from on-line repositories. Make sure you call UpdateRepository or UpdateAllRepositories | ||
639 | before using this method to ensure that the latest information is available. | ||
640 | </remarks> | ||
641 | </member> | ||
642 | <member name="M:Mono.Addins.Setup.RepositoryRegistry.GetAvailableAddins(System.String)"> | ||
643 | <summary> | ||
644 | Gets a list of all available add-ins in a repository | ||
645 | </summary> | ||
646 | <param name="repositoryUrl"> | ||
647 | A repository URL | ||
648 | </param> | ||
649 | <returns> | ||
650 | A list of add-ins | ||
651 | </returns> | ||
652 | <remarks> | ||
653 | This method uses cached | ||
654 | information from on-line repositories. Make sure you call UpdateRepository or UpdateAllRepositories | ||
655 | before using this method to ensure that the latest information is available. | ||
656 | </remarks> | ||
657 | </member> | ||
658 | <member name="M:Mono.Addins.Setup.RepositoryRegistry.GetAvailableAddins(System.String,Mono.Addins.Setup.RepositorySearchFlags)"> | ||
659 | <summary> | ||
660 | Gets a list of all available add-ins in a repository | ||
661 | </summary> | ||
662 | <param name="repositoryUrl"> | ||
663 | A repository URL | ||
664 | </param> | ||
665 | <param name='flags'> | ||
666 | Search flags. | ||
667 | </param> | ||
668 | <returns> | ||
669 | A list of add-ins | ||
670 | </returns> | ||
671 | <remarks> | ||
672 | This method uses cached | ||
673 | information from on-line repositories. Make sure you call UpdateRepository or UpdateAllRepositories | ||
674 | before using this method to ensure that the latest information is available. | ||
675 | </remarks> | ||
676 | </member> | ||
677 | <member name="M:Mono.Addins.Setup.RepositoryRegistry.GetAvailableAddin(System.String,System.String)"> | ||
678 | <summary> | ||
679 | Checks if an add-in is available to be installed | ||
680 | </summary> | ||
681 | <param name="id"> | ||
682 | Identifier of the add-in | ||
683 | </param> | ||
684 | <param name="version"> | ||
685 | Version of the add-in (optional, it can be null) | ||
686 | </param> | ||
687 | <returns> | ||
688 | A list of add-ins | ||
689 | </returns> | ||
690 | <remarks> | ||
691 | List of references to add-ins available in on-line repositories. This method uses cached | ||
692 | information from on-line repositories. Make sure you call UpdateRepository or UpdateAllRepositories | ||
693 | before using this method to ensure that the latest information is available. | ||
694 | </remarks> | ||
695 | </member> | ||
696 | <member name="M:Mono.Addins.Setup.RepositoryRegistry.GetAvailableAddin(System.String,System.String,System.String)"> | ||
697 | <summary> | ||
698 | Checks if an add-in is available to be installed from a repository | ||
699 | </summary> | ||
700 | <param name="repositoryUrl"> | ||
701 | A repository URL | ||
702 | </param> | ||
703 | <param name="id"> | ||
704 | Identifier of the add-in | ||
705 | </param> | ||
706 | <param name="version"> | ||
707 | Version of the add-in (optional, it can be null) | ||
708 | </param> | ||
709 | <returns> | ||
710 | A list of add-ins | ||
711 | </returns> | ||
712 | <remarks> | ||
713 | List of references to add-ins available in the repository. This method uses cached | ||
714 | information from on-line repositories. Make sure you call UpdateRepository or UpdateAllRepositories | ||
715 | before using this method to ensure that the latest information is available. | ||
716 | </remarks> | ||
717 | </member> | ||
718 | <member name="T:Mono.Addins.Setup.RepositorySearchFlags"> | ||
719 | <summary> | ||
720 | Repository search flags. | ||
721 | </summary> | ||
722 | </member> | ||
723 | <member name="F:Mono.Addins.Setup.RepositorySearchFlags.None"> | ||
724 | <summary> | ||
725 | No special search options | ||
726 | </summary> | ||
727 | </member> | ||
728 | <member name="F:Mono.Addins.Setup.RepositorySearchFlags.LatestVersionsOnly"> | ||
729 | <summary> | ||
730 | Only the latest version of every add-in is included in the search | ||
731 | </summary> | ||
732 | </member> | ||
733 | <member name="T:Mono.Addins.Setup.AddinRepository"> | ||
734 | <summary> | ||
735 | An on-line add-in repository | ||
736 | </summary> | ||
737 | </member> | ||
738 | <member name="P:Mono.Addins.Setup.AddinRepository.File"> | ||
739 | <summary> | ||
740 | Path to the cached add-in repository file | ||
741 | </summary> | ||
742 | </member> | ||
743 | <member name="P:Mono.Addins.Setup.AddinRepository.Url"> | ||
744 | <summary> | ||
745 | Url of the repository | ||
746 | </summary> | ||
747 | </member> | ||
748 | <member name="P:Mono.Addins.Setup.AddinRepository.Name"> | ||
749 | <summary> | ||
750 | Do not use. Use Title instead. | ||
751 | </summary> | ||
752 | </member> | ||
753 | <member name="P:Mono.Addins.Setup.AddinRepository.Title"> | ||
754 | <summary> | ||
755 | Title of the repository | ||
756 | </summary> | ||
757 | </member> | ||
758 | <member name="P:Mono.Addins.Setup.AddinRepository.LastModified"> | ||
759 | <summary> | ||
760 | Last change timestamp | ||
761 | </summary> | ||
762 | </member> | ||
763 | <member name="P:Mono.Addins.Setup.AddinRepository.Enabled"> | ||
764 | <summary> | ||
765 | Gets a value indicating whether this <see cref="T:Mono.Addins.Setup.AddinRepository"/> is enabled. | ||
766 | </summary> | ||
767 | <value> | ||
768 | <c>true</c> if enabled; otherwise, <c>false</c>. | ||
769 | </value> | ||
770 | </member> | ||
771 | <member name="T:Mono.Addins.Setup.WebRequestHelper"> | ||
772 | <summary> | ||
773 | Helper for making web requests with support for authenticated proxies. | ||
774 | </summary> | ||
775 | </member> | ||
776 | <member name="M:Mono.Addins.Setup.WebRequestHelper.SetRequestHandler(System.Func{System.Func{System.Net.HttpWebRequest},System.Action{System.Net.HttpWebRequest},System.Threading.CancellationToken,System.Net.HttpWebResponse})"> | ||
777 | <summary> | ||
778 | Sets a custom request handler that can handle requests for authenticated proxy servers. | ||
779 | </summary> | ||
780 | <param name="handler">The custom request handler.</param> | ||
781 | </member> | ||
782 | <member name="M:Mono.Addins.Setup.WebRequestHelper.GetResponseAsync(System.Func{System.Net.HttpWebRequest},System.Action{System.Net.HttpWebRequest},System.Threading.CancellationToken)"> | ||
783 | <summary> | ||
784 | Gets the web response, using the request handler to handle proxy authentication | ||
785 | if necessary. | ||
786 | </summary> | ||
787 | <returns>The response.</returns> | ||
788 | <param name="createRequest">Callback for creating the request.</param> | ||
789 | <param name="prepareRequest">Callback for preparing the request, e.g. writing the request stream.</param> | ||
790 | <param name="token">Cancellation token.</param> | ||
791 | <remarks> | ||
792 | Keeps sending requests until a response code that doesn't require authentication happens or if the request | ||
793 | requires authentication and the user has stopped trying to enter them (i.e. they hit cancel when they are prompted). | ||
794 | </remarks> | ||
795 | </member> | ||
796 | <member name="M:Mono.Addins.Setup.WebRequestHelper.GetResponse(System.Func{System.Net.HttpWebRequest},System.Action{System.Net.HttpWebRequest},System.Threading.CancellationToken)"> | ||
797 | <summary> | ||
798 | Gets the web response, using the request handler to handle proxy authentication | ||
799 | if necessary. | ||
800 | </summary> | ||
801 | <returns>The response.</returns> | ||
802 | <param name="createRequest">Callback for creating the request.</param> | ||
803 | <param name="prepareRequest">Callback for preparing the request, e.g. writing the request stream.</param> | ||
804 | <param name="token">Cancellation token.</param> | ||
805 | <remarks> | ||
806 | Keeps sending requests until a response code that doesn't require authentication happens or if the request | ||
807 | requires authentication and the user has stopped trying to enter them (i.e. they hit cancel when they are prompted). | ||
808 | </remarks> | ||
809 | </member> | ||
810 | <member name="M:Mono.Addins.Setup.WebRequestHelper.IsCannotReachInternetError(System.Net.WebExceptionStatus)"> | ||
811 | <summary> | ||
812 | Determines whether an error code is likely to have been caused by internet reachability problems. | ||
813 | </summary> | ||
814 | </member> | ||
815 | <member name="T:Mono.Addins.Setup.SetupService"> | ||
816 | <summary> | ||
817 | Provides tools for managing add-ins | ||
818 | </summary> | ||
819 | <remarks> | ||
820 | This class can be used to manage the add-ins of an application. It allows installing and uninstalling | ||
821 | add-ins, taking into account add-in dependencies. It provides methods for installing add-ins from on-line | ||
822 | repositories and tools for generating those repositories. | ||
823 | </remarks> | ||
824 | </member> | ||
825 | <member name="M:Mono.Addins.Setup.SetupService.#ctor"> | ||
826 | <summary> | ||
827 | Initializes a new instance | ||
828 | </summary> | ||
829 | <remarks> | ||
830 | If the add-in manager is initialized (AddinManager.Initialize has been called), then this instance | ||
831 | will manage the add-in registry of the initialized engine. | ||
832 | </remarks> | ||
833 | </member> | ||
834 | <member name="M:Mono.Addins.Setup.SetupService.#ctor(Mono.Addins.AddinRegistry)"> | ||
835 | <summary> | ||
836 | Initializes a new instance | ||
837 | </summary> | ||
838 | <param name="registry"> | ||
839 | Add-in registry to manage | ||
840 | </param> | ||
841 | </member> | ||
842 | <member name="M:Mono.Addins.Setup.SetupService.ResolveDependencies(Mono.Addins.IProgressStatus,Mono.Addins.Setup.AddinRepositoryEntry[],Mono.Addins.Setup.PackageCollection@,Mono.Addins.Setup.PackageCollection@,Mono.Addins.Description.DependencyCollection@)"> | ||
843 | <summary> | ||
844 | Resolves add-in dependencies. | ||
845 | </summary> | ||
846 | <param name="statusMonitor"> | ||
847 | Progress monitor where to show progress status | ||
848 | </param> | ||
849 | <param name="addins"> | ||
850 | List of add-ins to check | ||
851 | </param> | ||
852 | <param name="resolved"> | ||
853 | Packages that need to be installed. | ||
854 | </param> | ||
855 | <param name="toUninstall"> | ||
856 | Packages that need to be uninstalled. | ||
857 | </param> | ||
858 | <param name="unresolved"> | ||
859 | Add-in dependencies that could not be resolved. | ||
860 | </param> | ||
861 | <returns> | ||
862 | True if all dependencies could be resolved. | ||
863 | </returns> | ||
864 | <remarks> | ||
865 | This method can be used to get a list of all packages that have to be installed in order to install | ||
866 | an add-in or set of add-ins. The list of packages to install will include the package that provides the | ||
867 | add-in, and all packages that provide the add-in dependencies. In some cases, packages may need to | ||
868 | be installed (for example, when an installed add-in needs to be upgraded). | ||
869 | </remarks> | ||
870 | </member> | ||
871 | <member name="M:Mono.Addins.Setup.SetupService.ResolveDependencies(Mono.Addins.IProgressStatus,Mono.Addins.Setup.PackageCollection,Mono.Addins.Setup.PackageCollection@,Mono.Addins.Description.DependencyCollection@)"> | ||
872 | <summary> | ||
873 | Resolves add-in dependencies. | ||
874 | </summary> | ||
875 | <param name="statusMonitor"> | ||
876 | Progress monitor where to show progress status | ||
877 | </param> | ||
878 | <param name="packages"> | ||
879 | Packages that need to be installed. | ||
880 | </param> | ||
881 | <param name="toUninstall"> | ||
882 | Packages that need to be uninstalled. | ||
883 | </param> | ||
884 | <param name="unresolved"> | ||
885 | Add-in dependencies that could not be resolved. | ||
886 | </param> | ||
887 | <returns> | ||
888 | True if all dependencies could be resolved. | ||
889 | </returns> | ||
890 | <remarks> | ||
891 | This method can be used to get a list of all packages that have to be installed in order to satisfy | ||
892 | the dependencies of a package or set of packages. The 'packages' argument must have the list of packages | ||
893 | to be resolved. When resolving dependencies, if there is any additional package that needs to be installed, | ||
894 | it will be added to the same 'packages' collection. In some cases, packages may need to | ||
895 | be installed (for example, when an installed add-in needs to be upgraded). Those packages will be added | ||
896 | to the 'toUninstall' collection. Packages that could not be resolved are added to the 'unresolved' | ||
897 | collection. | ||
898 | </remarks> | ||
899 | </member> | ||
900 | <member name="M:Mono.Addins.Setup.SetupService.Install(Mono.Addins.IProgressStatus,System.String[])"> | ||
901 | <summary> | ||
902 | Installs add-in packages | ||
903 | </summary> | ||
904 | <param name="statusMonitor"> | ||
905 | Progress monitor where to show progress status | ||
906 | </param> | ||
907 | <param name="files"> | ||
908 | Paths to the packages to install | ||
909 | </param> | ||
910 | <returns> | ||
911 | True if the installation succeeded | ||
912 | </returns> | ||
913 | </member> | ||
914 | <member name="M:Mono.Addins.Setup.SetupService.Install(Mono.Addins.IProgressStatus,Mono.Addins.Setup.AddinRepositoryEntry[])"> | ||
915 | <summary> | ||
916 | Installs add-in packages from on-line repositories | ||
917 | </summary> | ||
918 | <param name="statusMonitor"> | ||
919 | Progress monitor where to show progress status | ||
920 | </param> | ||
921 | <param name="addins"> | ||
922 | References to the add-ins to be installed | ||
923 | </param> | ||
924 | <returns> | ||
925 | True if the installation succeeded | ||
926 | </returns> | ||
927 | </member> | ||
928 | <member name="M:Mono.Addins.Setup.SetupService.Install(Mono.Addins.IProgressStatus,Mono.Addins.Setup.PackageCollection)"> | ||
929 | <summary> | ||
930 | Installs add-in packages | ||
931 | </summary> | ||
932 | <param name="statusMonitor"> | ||
933 | Progress monitor where to show progress status | ||
934 | </param> | ||
935 | <param name="packages"> | ||
936 | Packages to install | ||
937 | </param> | ||
938 | <returns> | ||
939 | True if the installation succeeded | ||
940 | </returns> | ||
941 | </member> | ||
942 | <member name="M:Mono.Addins.Setup.SetupService.Uninstall(Mono.Addins.IProgressStatus,System.String)"> | ||
943 | <summary> | ||
944 | Uninstalls an add-in. | ||
945 | </summary> | ||
946 | <param name="statusMonitor"> | ||
947 | Progress monitor where to show progress status | ||
948 | </param> | ||
949 | <param name="id"> | ||
950 | Full identifier of the add-in to uninstall. | ||
951 | </param> | ||
952 | </member> | ||
953 | <member name="M:Mono.Addins.Setup.SetupService.Uninstall(Mono.Addins.IProgressStatus,System.Collections.Generic.IEnumerable{System.String})"> | ||
954 | <summary> | ||
955 | Uninstalls a set of add-ins | ||
956 | </summary> | ||
957 | <param name='statusMonitor'> | ||
958 | Progress monitor where to show progress status | ||
959 | </param> | ||
960 | <param name='ids'> | ||
961 | Full identifiers of the add-ins to uninstall. | ||
962 | </param> | ||
963 | </member> | ||
964 | <member name="M:Mono.Addins.Setup.SetupService.GetAddinHeader(Mono.Addins.Addin)"> | ||
965 | <summary> | ||
966 | Gets information about an add-in | ||
967 | </summary> | ||
968 | <param name="addin"> | ||
969 | The add-in | ||
970 | </param> | ||
971 | <returns> | ||
972 | Add-in header data | ||
973 | </returns> | ||
974 | </member> | ||
975 | <member name="M:Mono.Addins.Setup.SetupService.GetDependentAddins(System.String,System.Boolean)"> | ||
976 | <summary> | ||
977 | Gets a list of add-ins which depend on an add-in | ||
978 | </summary> | ||
979 | <param name="id"> | ||
980 | Full identifier of an add-in. | ||
981 | </param> | ||
982 | <param name="recursive"> | ||
983 | When set to True, dependencies will be gathered recursivelly | ||
984 | </param> | ||
985 | <returns> | ||
986 | List of dependent add-ins. | ||
987 | </returns> | ||
988 | <remarks> | ||
989 | This methods returns a list of add-ins which have the add-in identified by 'id' as a direct | ||
990 | (or indirect if recursive=True) dependency. | ||
991 | </remarks> | ||
992 | </member> | ||
993 | <member name="M:Mono.Addins.Setup.SetupService.BuildPackage(Mono.Addins.IProgressStatus,System.String,System.String[])"> | ||
994 | <summary> | ||
995 | Packages an add-in | ||
996 | </summary> | ||
997 | <param name="statusMonitor"> | ||
998 | Progress monitor where to show progress status | ||
999 | </param> | ||
1000 | <param name="targetDirectory"> | ||
1001 | Directory where to generate the package | ||
1002 | </param> | ||
1003 | <param name="filePaths"> | ||
1004 | Paths to the add-ins to be packaged. Paths can be either the main assembly of an add-in, or an add-in | ||
1005 | manifest (.addin or .addin.xml). | ||
1006 | </param> | ||
1007 | <remarks> | ||
1008 | This method can be used to create a package for an add-in, which can then be pushed to an on-line | ||
1009 | repository. The package will include the main assembly or manifest of the add-in and any external | ||
1010 | file declared in the add-in metadata. | ||
1011 | </remarks> | ||
1012 | </member> | ||
1013 | <member name="M:Mono.Addins.Setup.SetupService.BuildRepository(Mono.Addins.IProgressStatus,System.String)"> | ||
1014 | <summary> | ||
1015 | Generates an on-line repository | ||
1016 | </summary> | ||
1017 | <param name="statusMonitor"> | ||
1018 | Progress monitor where to show progress status | ||
1019 | </param> | ||
1020 | <param name="path"> | ||
1021 | Path to the directory that contains the add-ins and that is going to be published | ||
1022 | </param> | ||
1023 | <remarks> | ||
1024 | This method generates the index files required to publish a directory as an online repository | ||
1025 | of add-ins. | ||
1026 | </remarks> | ||
1027 | </member> | ||
1028 | <member name="M:Mono.Addins.Setup.SetupService.GetExtensibleApplication(System.String)"> | ||
1029 | <summary> | ||
1030 | Gets a reference to an extensible application | ||
1031 | </summary> | ||
1032 | <param name="name"> | ||
1033 | Name of the application | ||
1034 | </param> | ||
1035 | <returns> | ||
1036 | The Application object. Null if not found. | ||
1037 | </returns> | ||
1038 | </member> | ||
1039 | <member name="M:Mono.Addins.Setup.SetupService.GetExtensibleApplication(System.String,System.Collections.Generic.IEnumerable{System.String})"> | ||
1040 | <summary> | ||
1041 | Gets a reference to an extensible application | ||
1042 | </summary> | ||
1043 | <param name="name"> | ||
1044 | Name of the application | ||
1045 | </param> | ||
1046 | <param name="searchPaths"> | ||
1047 | Custom paths where to look for the application. | ||
1048 | </param> | ||
1049 | <returns> | ||
1050 | The Application object. Null if not found. | ||
1051 | </returns> | ||
1052 | </member> | ||
1053 | <member name="M:Mono.Addins.Setup.SetupService.GetExtensibleApplications"> | ||
1054 | <summary> | ||
1055 | Gets a lis of all known extensible applications | ||
1056 | </summary> | ||
1057 | <returns> | ||
1058 | A list of applications. | ||
1059 | </returns> | ||
1060 | </member> | ||
1061 | <member name="M:Mono.Addins.Setup.SetupService.GetExtensibleApplications(System.Collections.Generic.IEnumerable{System.String})"> | ||
1062 | <summary> | ||
1063 | Gets a lis of all known extensible applications | ||
1064 | </summary> | ||
1065 | <param name="searchPaths"> | ||
1066 | Custom paths where to look for applications. | ||
1067 | </param> | ||
1068 | <returns> | ||
1069 | A list of applications. | ||
1070 | </returns> | ||
1071 | </member> | ||
1072 | <member name="P:Mono.Addins.Setup.SetupService.Registry"> | ||
1073 | <summary> | ||
1074 | The add-in registry being managed | ||
1075 | </summary> | ||
1076 | </member> | ||
1077 | <member name="P:Mono.Addins.Setup.SetupService.ApplicationNamespace"> | ||
1078 | <summary> | ||
1079 | Default add-in namespace of the application (optional). If set, only add-ins that belong to that namespace | ||
1080 | will be shown in add-in lists. | ||
1081 | </summary> | ||
1082 | </member> | ||
1083 | <member name="P:Mono.Addins.Setup.SetupService.InstallDirectory"> | ||
1084 | <summary> | ||
1085 | Directory where to install add-ins. If not specified, the 'addins' subdirectory of the | ||
1086 | registry location is used. | ||
1087 | </summary> | ||
1088 | </member> | ||
1089 | <member name="P:Mono.Addins.Setup.SetupService.Repositories"> | ||
1090 | <summary> | ||
1091 | Returns a RepositoryRegistry which can be used to manage on-line repository references | ||
1092 | </summary> | ||
1093 | </member> | ||
1094 | <member name="T:Mono.Addins.Setup.Application"> | ||
1095 | <summary> | ||
1096 | A registered extensible application | ||
1097 | </summary> | ||
1098 | </member> | ||
1099 | <member name="P:Mono.Addins.Setup.Application.Registry"> | ||
1100 | <summary> | ||
1101 | Add-in registry of the application | ||
1102 | </summary> | ||
1103 | </member> | ||
1104 | <member name="P:Mono.Addins.Setup.Application.Description"> | ||
1105 | <summary> | ||
1106 | Description of the application | ||
1107 | </summary> | ||
1108 | </member> | ||
1109 | <member name="P:Mono.Addins.Setup.Application.Name"> | ||
1110 | <summary> | ||
1111 | Name of the application | ||
1112 | </summary> | ||
1113 | </member> | ||
1114 | <member name="P:Mono.Addins.Setup.Application.RegistryPath"> | ||
1115 | <summary> | ||
1116 | Path to the add-in registry | ||
1117 | </summary> | ||
1118 | </member> | ||
1119 | <member name="P:Mono.Addins.Setup.Application.StartupPath"> | ||
1120 | <summary> | ||
1121 | Path to the directory that contains the main executable assembly of the application | ||
1122 | </summary> | ||
1123 | </member> | ||
1124 | <member name="P:Mono.Addins.Setup.Application.TestCommand"> | ||
1125 | <summary> | ||
1126 | Command to be used to execute the application in add-in development mode. | ||
1127 | </summary> | ||
1128 | </member> | ||
1129 | <member name="P:Mono.Addins.Setup.Application.AddinsPath"> | ||
1130 | <summary> | ||
1131 | Path to the default add-ins directory for the aplpication | ||
1132 | </summary> | ||
1133 | </member> | ||
1134 | <member name="P:Mono.Addins.Setup.Application.AddinCachePath"> | ||
1135 | <summary> | ||
1136 | Path to the add-in cache for the application | ||
1137 | </summary> | ||
1138 | </member> | ||
1139 | </members> | ||
1140 | </doc> | ||
diff --git a/bin/Mono.Addins.dll b/bin/Mono.Addins.dll index 969909e..84ee01e 100755 --- a/bin/Mono.Addins.dll +++ b/bin/Mono.Addins.dll | |||
Binary files differ | |||
diff --git a/bin/Mono.Addins.xml b/bin/Mono.Addins.xml deleted file mode 100644 index b9bdd4c..0000000 --- a/bin/Mono.Addins.xml +++ /dev/null | |||
@@ -1,6120 +0,0 @@ | |||
1 | <?xml version="1.0"?> | ||
2 | <doc> | ||
3 | <assembly> | ||
4 | <name>Mono.Addins</name> | ||
5 | </assembly> | ||
6 | <members> | ||
7 | <member name="T:Mono.Addins.Localization.IAddinLocalizer"> | ||
8 | <summary> | ||
9 | An add-in localizer. | ||
10 | </summary> | ||
11 | <remarks> | ||
12 | Add-in localizers which want to provide support for localization of plural forms | ||
13 | can additionally implement <see cref="T:Mono.Addins.Localization.IPluralAddinLocalizer"/>. | ||
14 | </remarks> | ||
15 | </member> | ||
16 | <member name="M:Mono.Addins.Localization.IAddinLocalizer.GetString(System.String)"> | ||
17 | <summary> | ||
18 | Gets a localized message. | ||
19 | </summary> | ||
20 | <returns> | ||
21 | The localized message. | ||
22 | </returns> | ||
23 | <param name='msgid'> | ||
24 | The message identifier. | ||
25 | </param> | ||
26 | </member> | ||
27 | <member name="T:Mono.Addins.Description.ExtensionNodeDescriptionCollection"> | ||
28 | <summary> | ||
29 | A collection of extension nodes | ||
30 | </summary> | ||
31 | </member> | ||
32 | <member name="T:Mono.Addins.Description.ObjectDescriptionCollection`1"> | ||
33 | <summary> | ||
34 | Base class for add-in description collections. | ||
35 | </summary> | ||
36 | </member> | ||
37 | <member name="T:Mono.Addins.Description.ObjectDescriptionCollection"> | ||
38 | <summary> | ||
39 | Base class for add-in description collections. | ||
40 | </summary> | ||
41 | </member> | ||
42 | <member name="M:Mono.Addins.Description.ObjectDescriptionCollection.#ctor"> | ||
43 | <summary> | ||
44 | Initializes a new instance of the <see cref="T:Mono.Addins.Description.ObjectDescriptionCollection"/> class. | ||
45 | </summary> | ||
46 | </member> | ||
47 | <member name="M:Mono.Addins.Description.ObjectDescriptionCollection.Add(Mono.Addins.Description.ObjectDescription)"> | ||
48 | <summary> | ||
49 | Add an object. | ||
50 | </summary> | ||
51 | <param name='ep'> | ||
52 | The object. | ||
53 | </param> | ||
54 | </member> | ||
55 | <member name="M:Mono.Addins.Description.ObjectDescriptionCollection.AddRange(Mono.Addins.Description.ObjectDescriptionCollection)"> | ||
56 | <summary> | ||
57 | Adds a collection of objects. | ||
58 | </summary> | ||
59 | <param name='collection'> | ||
60 | The objects to add. | ||
61 | </param> | ||
62 | </member> | ||
63 | <member name="M:Mono.Addins.Description.ObjectDescriptionCollection.Insert(System.Int32,Mono.Addins.Description.ObjectDescription)"> | ||
64 | <summary> | ||
65 | Insert an object. | ||
66 | </summary> | ||
67 | <param name='index'> | ||
68 | Insertion index. | ||
69 | </param> | ||
70 | <param name='ep'> | ||
71 | The object. | ||
72 | </param> | ||
73 | </member> | ||
74 | <member name="M:Mono.Addins.Description.ObjectDescriptionCollection.Remove(Mono.Addins.Description.ObjectDescription)"> | ||
75 | <summary> | ||
76 | Removes an object. | ||
77 | </summary> | ||
78 | <param name='ep'> | ||
79 | Object to remove. | ||
80 | </param> | ||
81 | </member> | ||
82 | <member name="M:Mono.Addins.Description.ObjectDescriptionCollection.Contains(Mono.Addins.Description.ObjectDescription)"> | ||
83 | <summary> | ||
84 | Checks if an object is present in the collection. | ||
85 | </summary> | ||
86 | <param name='ob'> | ||
87 | Objecect to check. | ||
88 | </param> | ||
89 | </member> | ||
90 | <member name="T:Mono.Addins.NodeElementCollection"> | ||
91 | <summary> | ||
92 | A collection of NodeElement objects | ||
93 | </summary> | ||
94 | </member> | ||
95 | <member name="P:Mono.Addins.NodeElementCollection.Item(System.Int32)"> | ||
96 | <summary> | ||
97 | Gets the <see cref="T:Mono.Addins.NodeElement"/> at the specified index | ||
98 | </summary> | ||
99 | <param name="n"> | ||
100 | Index | ||
101 | </param> | ||
102 | </member> | ||
103 | <member name="M:Mono.Addins.Description.ExtensionNodeDescriptionCollection.#ctor"> | ||
104 | <summary> | ||
105 | Initializes a new instance of the <see cref="T:Mono.Addins.Description.ExtensionNodeDescriptionCollection"/> class. | ||
106 | </summary> | ||
107 | </member> | ||
108 | <member name="P:Mono.Addins.Description.ExtensionNodeDescriptionCollection.Item(System.Int32)"> | ||
109 | <summary> | ||
110 | Gets the <see cref="T:Mono.Addins.Description.ExtensionNodeDescription"/> at the specified index. | ||
111 | </summary> | ||
112 | <param name="n"> | ||
113 | The index. | ||
114 | </param> | ||
115 | </member> | ||
116 | <member name="P:Mono.Addins.Description.ExtensionNodeDescriptionCollection.Item(System.String)"> | ||
117 | <summary> | ||
118 | Gets the <see cref="T:Mono.Addins.Description.ExtensionNodeDescription"/> with the specified identifier. | ||
119 | </summary> | ||
120 | <param name="id"> | ||
121 | Identifier. | ||
122 | </param> | ||
123 | </member> | ||
124 | <member name="T:Mono.Addins.ExtensionPointAttribute"> | ||
125 | <summary> | ||
126 | Declares an extension point. | ||
127 | </summary> | ||
128 | </member> | ||
129 | <member name="M:Mono.Addins.ExtensionPointAttribute.#ctor"> | ||
130 | <summary> | ||
131 | Initializes a new instance | ||
132 | </summary> | ||
133 | </member> | ||
134 | <member name="M:Mono.Addins.ExtensionPointAttribute.#ctor(System.String)"> | ||
135 | <summary> | ||
136 | Initializes a new instance | ||
137 | </summary> | ||
138 | <param name="path"> | ||
139 | Extension path that identifies the extension point | ||
140 | </param> | ||
141 | </member> | ||
142 | <member name="M:Mono.Addins.ExtensionPointAttribute.#ctor(System.String,System.Type)"> | ||
143 | <summary> | ||
144 | Initializes a new instance | ||
145 | </summary> | ||
146 | <param name="path"> | ||
147 | Extension path that identifies the extension point | ||
148 | </param> | ||
149 | <param name="nodeType"> | ||
150 | Type of the extension node to be created for extensions | ||
151 | </param> | ||
152 | </member> | ||
153 | <member name="M:Mono.Addins.ExtensionPointAttribute.#ctor(System.String,System.String,System.Type)"> | ||
154 | <summary> | ||
155 | Initializes a new instance | ||
156 | </summary> | ||
157 | <param name="path"> | ||
158 | Extension path that identifies the extension point | ||
159 | </param> | ||
160 | <param name="nodeName"> | ||
161 | Element name to be used when defining an extension in an XML manifest. | ||
162 | </param> | ||
163 | <param name="nodeType"> | ||
164 | Type of the extension node to be created for extensions | ||
165 | </param> | ||
166 | </member> | ||
167 | <member name="P:Mono.Addins.ExtensionPointAttribute.Path"> | ||
168 | <summary> | ||
169 | Extension path that identifies the extension point | ||
170 | </summary> | ||
171 | </member> | ||
172 | <member name="P:Mono.Addins.ExtensionPointAttribute.Description"> | ||
173 | <summary> | ||
174 | Long description of the extension point. | ||
175 | </summary> | ||
176 | </member> | ||
177 | <member name="P:Mono.Addins.ExtensionPointAttribute.NodeType"> | ||
178 | <summary> | ||
179 | Type of the extension node to be created for extensions | ||
180 | </summary> | ||
181 | </member> | ||
182 | <member name="P:Mono.Addins.ExtensionPointAttribute.ObjectType"> | ||
183 | <summary> | ||
184 | Expected extension object type (when nodes are of type TypeExtensionNode) | ||
185 | </summary> | ||
186 | </member> | ||
187 | <member name="P:Mono.Addins.ExtensionPointAttribute.NodeName"> | ||
188 | <summary> | ||
189 | Element name to be used when defining an extension in an XML manifest. The default name is "Type". | ||
190 | </summary> | ||
191 | </member> | ||
192 | <member name="P:Mono.Addins.ExtensionPointAttribute.Name"> | ||
193 | <summary> | ||
194 | Display name of the extension point. | ||
195 | </summary> | ||
196 | </member> | ||
197 | <member name="P:Mono.Addins.ExtensionPointAttribute.ExtensionAttributeType"> | ||
198 | <summary> | ||
199 | Type of the custom attribute to be used to specify metadata for the extension point | ||
200 | </summary> | ||
201 | </member> | ||
202 | <member name="T:Mono.Addins.AddinUrlAttribute"> | ||
203 | <summary> | ||
204 | Addin URL attribute. | ||
205 | </summary> | ||
206 | </member> | ||
207 | <member name="M:Mono.Addins.AddinUrlAttribute.#ctor(System.String)"> | ||
208 | <summary> | ||
209 | Initializes the attribute | ||
210 | </summary> | ||
211 | <param name="url"> | ||
212 | Url of the add-in | ||
213 | </param> | ||
214 | </member> | ||
215 | <member name="P:Mono.Addins.AddinUrlAttribute.Url"> | ||
216 | <summary> | ||
217 | Url of the add-in | ||
218 | </summary> | ||
219 | </member> | ||
220 | <member name="T:Mono.Addins.ExtensionNodeChildAttribute"> | ||
221 | <summary> | ||
222 | Declares allowed children of an extension node type. | ||
223 | </summary> | ||
224 | <remarks> | ||
225 | This attribute allows declaring the type of children that an extension node can have. | ||
226 | </remarks> | ||
227 | </member> | ||
228 | <member name="M:Mono.Addins.ExtensionNodeChildAttribute.#ctor(System.String)"> | ||
229 | <summary> | ||
230 | Initializes a new instance | ||
231 | </summary> | ||
232 | <param name="nodeName"> | ||
233 | Name of the allowed child extension node. | ||
234 | </param> | ||
235 | </member> | ||
236 | <member name="M:Mono.Addins.ExtensionNodeChildAttribute.#ctor(System.Type)"> | ||
237 | <summary> | ||
238 | Initializes a new instance | ||
239 | </summary> | ||
240 | <param name="extensionNodeType"> | ||
241 | Type of the allowed child extension node. | ||
242 | </param> | ||
243 | </member> | ||
244 | <member name="M:Mono.Addins.ExtensionNodeChildAttribute.#ctor(System.Type,System.String)"> | ||
245 | <summary> | ||
246 | Initializes a new instance | ||
247 | </summary> | ||
248 | <param name="extensionNodeType"> | ||
249 | Type of the allowed child extension node. | ||
250 | </param> | ||
251 | <param name="nodeName"> | ||
252 | Name of the allowed child extension node. | ||
253 | </param> | ||
254 | </member> | ||
255 | <member name="P:Mono.Addins.ExtensionNodeChildAttribute.NodeName"> | ||
256 | <summary> | ||
257 | Name of the allowed child extension node. | ||
258 | </summary> | ||
259 | </member> | ||
260 | <member name="P:Mono.Addins.ExtensionNodeChildAttribute.ExtensionNodeType"> | ||
261 | <summary> | ||
262 | Type of the allowed child extension node. | ||
263 | </summary> | ||
264 | </member> | ||
265 | <member name="T:Mono.Addins.AddinManager"> | ||
266 | <summary> | ||
267 | Provides access to add-in and extension model management operations. | ||
268 | </summary> | ||
269 | </member> | ||
270 | <member name="M:Mono.Addins.AddinManager.Initialize"> | ||
271 | <summary> | ||
272 | Initializes the add-in engine. | ||
273 | </summary> | ||
274 | <remarks> | ||
275 | The add-in engine needs to be initialized before doing any add-in operation. | ||
276 | When initialized with this method, it will look for add-ins in the global add-in registry. | ||
277 | </remarks> | ||
278 | </member> | ||
279 | <member name="M:Mono.Addins.AddinManager.Initialize(System.String)"> | ||
280 | <summary> | ||
281 | Initializes the add-in engine. | ||
282 | </summary> | ||
283 | <param name="configDir"> | ||
284 | Location of the add-in registry. | ||
285 | </param> | ||
286 | <remarks> | ||
287 | The add-in engine needs to be initialized before doing any add-in operation. | ||
288 | Configuration information about the add-in registry will be stored in the | ||
289 | provided location. The add-in engine will look for add-ins in an 'addins' | ||
290 | subdirectory of the provided directory. | ||
291 | |||
292 | When specifying a path, it is possible to use a special folder name as root. | ||
293 | For example: [Personal]/.config/MyApp. In this case, [Personal] will be replaced | ||
294 | by the location of the Environment.SpecialFolder.Personal folder. Any value | ||
295 | of the Environment.SpecialFolder enumeration can be used (always between square | ||
296 | brackets) | ||
297 | </remarks> | ||
298 | </member> | ||
299 | <member name="M:Mono.Addins.AddinManager.Initialize(System.String,System.String)"> | ||
300 | <summary> | ||
301 | Initializes the add-in engine. | ||
302 | </summary> | ||
303 | <param name='configDir'> | ||
304 | Location of the add-in registry. | ||
305 | </param> | ||
306 | <param name='addinsDir'> | ||
307 | Add-ins directory. If the path is relative, it is considered to be relative | ||
308 | to the configDir directory. | ||
309 | </param> | ||
310 | <remarks> | ||
311 | The add-in engine needs to be initialized before doing any add-in operation. | ||
312 | Configuration information about the add-in registry will be stored in the | ||
313 | provided location. The add-in engine will look for add-ins in the provided | ||
314 | 'addinsDir' directory. | ||
315 | |||
316 | When specifying a path, it is possible to use a special folder name as root. | ||
317 | For example: [Personal]/.config/MyApp. In this case, [Personal] will be replaced | ||
318 | by the location of the Environment.SpecialFolder.Personal folder. Any value | ||
319 | of the Environment.SpecialFolder enumeration can be used (always between square | ||
320 | brackets) | ||
321 | </remarks> | ||
322 | </member> | ||
323 | <member name="M:Mono.Addins.AddinManager.Initialize(System.String,System.String,System.String)"> | ||
324 | <summary> | ||
325 | Initializes the add-in engine. | ||
326 | </summary> | ||
327 | <param name='configDir'> | ||
328 | Location of the add-in registry. | ||
329 | </param> | ||
330 | <param name='addinsDir'> | ||
331 | Add-ins directory. If the path is relative, it is considered to be relative | ||
332 | to the configDir directory. | ||
333 | </param> | ||
334 | <param name='databaseDir'> | ||
335 | Location of the add-in database. If the path is relative, it is considered to be relative | ||
336 | to the configDir directory. | ||
337 | </param> | ||
338 | <remarks> | ||
339 | The add-in engine needs to be initialized before doing any add-in operation. | ||
340 | Configuration information about the add-in registry will be stored in the | ||
341 | provided location. The add-in engine will look for add-ins in the provided | ||
342 | 'addinsDir' directory. Cached information about add-ins will be stored in | ||
343 | the 'databaseDir' directory. | ||
344 | |||
345 | When specifying a path, it is possible to use a special folder name as root. | ||
346 | For example: [Personal]/.config/MyApp. In this case, [Personal] will be replaced | ||
347 | by the location of the Environment.SpecialFolder.Personal folder. Any value | ||
348 | of the Environment.SpecialFolder enumeration can be used (always between square | ||
349 | brackets) | ||
350 | </remarks> | ||
351 | </member> | ||
352 | <member name="M:Mono.Addins.AddinManager.Shutdown"> | ||
353 | <summary> | ||
354 | Finalizes an add-in engine. | ||
355 | </summary> | ||
356 | </member> | ||
357 | <member name="M:Mono.Addins.AddinManager.InitializeDefaultLocalizer(Mono.Addins.Localization.IAddinLocalizer)"> | ||
358 | <summary> | ||
359 | Sets the default localizer to be used for this add-in engine | ||
360 | </summary> | ||
361 | <param name="localizer"> | ||
362 | The add-in localizer | ||
363 | </param> | ||
364 | </member> | ||
365 | <member name="M:Mono.Addins.AddinManager.CheckInstalled(System.String,System.String[])"> | ||
366 | <summary> | ||
367 | Checks if the provided add-ins are installed, and requests the installation of those | ||
368 | which aren't. | ||
369 | </summary> | ||
370 | <param name="message"> | ||
371 | Message to show to the user when new add-ins have to be installed. | ||
372 | </param> | ||
373 | <param name="addinIds"> | ||
374 | List of IDs of the add-ins to be checked. | ||
375 | </param> | ||
376 | <remarks> | ||
377 | This method checks if the specified add-ins are installed. | ||
378 | If some of the add-ins are not installed, it will use | ||
379 | the installer assigned to the DefaultAddinInstaller property | ||
380 | to install them. If the installation fails, or if DefaultAddinInstaller | ||
381 | is not set, an exception will be thrown. | ||
382 | </remarks> | ||
383 | </member> | ||
384 | <member name="M:Mono.Addins.AddinManager.IsAddinLoaded(System.String)"> | ||
385 | <summary> | ||
386 | Checks if an add-in has been loaded. | ||
387 | </summary> | ||
388 | <param name="id"> | ||
389 | Full identifier of the add-in. | ||
390 | </param> | ||
391 | <returns> | ||
392 | True if the add-in is loaded. | ||
393 | </returns> | ||
394 | </member> | ||
395 | <member name="M:Mono.Addins.AddinManager.LoadAddin(Mono.Addins.IProgressStatus,System.String)"> | ||
396 | <summary> | ||
397 | Forces the loading of an add-in. | ||
398 | </summary> | ||
399 | <param name="statusMonitor"> | ||
400 | Status monitor to keep track of the loading process. | ||
401 | </param> | ||
402 | <param name="id"> | ||
403 | Full identifier of the add-in to load. | ||
404 | </param> | ||
405 | <remarks> | ||
406 | This method loads all assemblies that belong to an add-in in memory. | ||
407 | All add-ins on which the specified add-in depends will also be loaded. | ||
408 | Notice that in general add-ins don't need to be explicitely loaded using | ||
409 | this method, since the add-in engine will load them on demand. | ||
410 | </remarks> | ||
411 | </member> | ||
412 | <member name="M:Mono.Addins.AddinManager.CreateExtensionContext"> | ||
413 | <summary> | ||
414 | Creates a new extension context. | ||
415 | </summary> | ||
416 | <returns> | ||
417 | The new extension context. | ||
418 | </returns> | ||
419 | <remarks> | ||
420 | Extension contexts can be used to query the extension model using particular condition values. | ||
421 | </remarks> | ||
422 | </member> | ||
423 | <member name="M:Mono.Addins.AddinManager.GetExtensionNode(System.String)"> | ||
424 | <summary> | ||
425 | Returns the extension node in a path | ||
426 | </summary> | ||
427 | <param name="path"> | ||
428 | Location of the node. | ||
429 | </param> | ||
430 | <returns> | ||
431 | The node, or null if not found. | ||
432 | </returns> | ||
433 | </member> | ||
434 | <member name="M:Mono.Addins.AddinManager.GetExtensionNode``1(System.String)"> | ||
435 | <summary> | ||
436 | Returns the extension node in a path | ||
437 | </summary> | ||
438 | <param name="path"> | ||
439 | Location of the node. | ||
440 | </param> | ||
441 | <returns> | ||
442 | The node, or null if not found. | ||
443 | </returns> | ||
444 | </member> | ||
445 | <member name="M:Mono.Addins.AddinManager.GetExtensionNodes(System.String)"> | ||
446 | <summary> | ||
447 | Gets extension nodes registered in a path. | ||
448 | </summary> | ||
449 | <param name="path"> | ||
450 | An extension path.> | ||
451 | </param> | ||
452 | <returns> | ||
453 | All nodes registered in the provided path. | ||
454 | </returns> | ||
455 | </member> | ||
456 | <member name="M:Mono.Addins.AddinManager.GetExtensionNodes(System.String,System.Type)"> | ||
457 | <summary> | ||
458 | Gets extension nodes registered in a path. | ||
459 | </summary> | ||
460 | <param name="path"> | ||
461 | An extension path. | ||
462 | </param> | ||
463 | <param name="expectedNodeType"> | ||
464 | Expected node type. | ||
465 | </param> | ||
466 | <returns> | ||
467 | A list of nodes | ||
468 | </returns> | ||
469 | <remarks> | ||
470 | This method returns all nodes registered under the provided path. | ||
471 | It will throw a InvalidOperationException if the type of one of | ||
472 | the registered nodes is not assignable to the provided type. | ||
473 | </remarks> | ||
474 | </member> | ||
475 | <member name="M:Mono.Addins.AddinManager.GetExtensionNodes``1(System.String)"> | ||
476 | <summary> | ||
477 | Gets extension nodes registered in a path. | ||
478 | </summary> | ||
479 | <param name="path"> | ||
480 | An extension path. | ||
481 | </param> | ||
482 | <returns> | ||
483 | A list of nodes | ||
484 | </returns> | ||
485 | <remarks> | ||
486 | This method returns all nodes registered under the provided path. | ||
487 | It will throw a InvalidOperationException if the type of one of | ||
488 | the registered nodes is not assignable to the provided type. | ||
489 | </remarks> | ||
490 | </member> | ||
491 | <member name="M:Mono.Addins.AddinManager.GetExtensionNodes(System.Type)"> | ||
492 | <summary> | ||
493 | Gets extension nodes for a type extension point | ||
494 | </summary> | ||
495 | <param name="instanceType"> | ||
496 | Type defining the extension point | ||
497 | </param> | ||
498 | <returns> | ||
499 | A list of nodes | ||
500 | </returns> | ||
501 | <remarks> | ||
502 | This method returns all extension nodes bound to the provided type. | ||
503 | </remarks> | ||
504 | </member> | ||
505 | <member name="M:Mono.Addins.AddinManager.GetExtensionNodes(System.Type,System.Type)"> | ||
506 | <summary> | ||
507 | Gets extension nodes for a type extension point | ||
508 | </summary> | ||
509 | <param name="instanceType"> | ||
510 | Type defining the extension point | ||
511 | </param> | ||
512 | <param name="expectedNodeType"> | ||
513 | Expected extension node type | ||
514 | </param> | ||
515 | <returns> | ||
516 | A list of nodes | ||
517 | </returns> | ||
518 | <remarks> | ||
519 | This method returns all nodes registered for the provided type. | ||
520 | It will throw a InvalidOperationException if the type of one of | ||
521 | the registered nodes is not assignable to the provided node type. | ||
522 | </remarks> | ||
523 | </member> | ||
524 | <member name="M:Mono.Addins.AddinManager.GetExtensionNodes``1(System.Type)"> | ||
525 | <summary> | ||
526 | Gets extension nodes for a type extension point | ||
527 | </summary> | ||
528 | <param name="instanceType"> | ||
529 | Type defining the extension point | ||
530 | </param> | ||
531 | <returns> | ||
532 | A list of nodes | ||
533 | </returns> | ||
534 | <remarks> | ||
535 | This method returns all nodes registered for the provided type. | ||
536 | It will throw a InvalidOperationException if the type of one of | ||
537 | the registered nodes is not assignable to the specified node type argument. | ||
538 | </remarks> | ||
539 | </member> | ||
540 | <member name="M:Mono.Addins.AddinManager.GetExtensionObjects(System.Type)"> | ||
541 | <summary> | ||
542 | Gets extension objects registered for a type extension point. | ||
543 | </summary> | ||
544 | <param name="instanceType"> | ||
545 | Type defining the extension point | ||
546 | </param> | ||
547 | <returns> | ||
548 | A list of objects | ||
549 | </returns> | ||
550 | </member> | ||
551 | <member name="M:Mono.Addins.AddinManager.GetExtensionObjects``1"> | ||
552 | <summary> | ||
553 | Gets extension objects registered for a type extension point. | ||
554 | </summary> | ||
555 | <returns> | ||
556 | A list of objects | ||
557 | </returns> | ||
558 | <remarks> | ||
559 | The type argument of this generic method is the type that defines | ||
560 | the extension point. | ||
561 | </remarks> | ||
562 | </member> | ||
563 | <member name="M:Mono.Addins.AddinManager.GetExtensionObjects(System.Type,System.Boolean)"> | ||
564 | <summary> | ||
565 | Gets extension objects registered for a type extension point. | ||
566 | </summary> | ||
567 | <param name="instanceType"> | ||
568 | Type defining the extension point | ||
569 | </param> | ||
570 | <param name="reuseCachedInstance"> | ||
571 | When set to True, it will return instances created in previous calls. | ||
572 | </param> | ||
573 | <returns> | ||
574 | A list of extension objects. | ||
575 | </returns> | ||
576 | </member> | ||
577 | <member name="M:Mono.Addins.AddinManager.GetExtensionObjects``1(System.Boolean)"> | ||
578 | <summary> | ||
579 | Gets extension objects registered for a type extension point. | ||
580 | </summary> | ||
581 | <param name="reuseCachedInstance"> | ||
582 | When set to True, it will return instances created in previous calls. | ||
583 | </param> | ||
584 | <returns> | ||
585 | A list of extension objects. | ||
586 | </returns> | ||
587 | <remarks> | ||
588 | The type argument of this generic method is the type that defines | ||
589 | the extension point. | ||
590 | </remarks> | ||
591 | </member> | ||
592 | <member name="M:Mono.Addins.AddinManager.GetExtensionObjects(System.String)"> | ||
593 | <summary> | ||
594 | Gets extension objects registered in a path | ||
595 | </summary> | ||
596 | <param name="path"> | ||
597 | An extension path. | ||
598 | </param> | ||
599 | <returns> | ||
600 | An array of objects registered in the path. | ||
601 | </returns> | ||
602 | <remarks> | ||
603 | This method can only be used if all nodes in the provided extension path | ||
604 | are of type Mono.Addins.TypeExtensionNode. The returned array is composed | ||
605 | by all objects created by calling the TypeExtensionNode.CreateInstance() | ||
606 | method for each node. | ||
607 | </remarks> | ||
608 | </member> | ||
609 | <member name="M:Mono.Addins.AddinManager.GetExtensionObjects(System.String,System.Boolean)"> | ||
610 | <summary> | ||
611 | Gets extension objects registered in a path. | ||
612 | </summary> | ||
613 | <param name="path"> | ||
614 | An extension path. | ||
615 | </param> | ||
616 | <param name="reuseCachedInstance"> | ||
617 | When set to True, it will return instances created in previous calls. | ||
618 | </param> | ||
619 | <returns> | ||
620 | An array of objects registered in the path. | ||
621 | </returns> | ||
622 | <remarks> | ||
623 | This method can only be used if all nodes in the provided extension path | ||
624 | are of type Mono.Addins.TypeExtensionNode. The returned array is composed | ||
625 | by all objects created by calling the TypeExtensionNode.CreateInstance() | ||
626 | method for each node (or TypeExtensionNode.GetInstance() if | ||
627 | reuseCachedInstance is set to true) | ||
628 | </remarks> | ||
629 | </member> | ||
630 | <member name="M:Mono.Addins.AddinManager.GetExtensionObjects(System.String,System.Type)"> | ||
631 | <summary> | ||
632 | Gets extension objects registered in a path. | ||
633 | </summary> | ||
634 | <param name="path"> | ||
635 | An extension path. | ||
636 | </param> | ||
637 | <param name="arrayElementType"> | ||
638 | Type of the return array elements. | ||
639 | </param> | ||
640 | <returns> | ||
641 | An array of objects registered in the path. | ||
642 | </returns> | ||
643 | <remarks> | ||
644 | This method can only be used if all nodes in the provided extension path | ||
645 | are of type Mono.Addins.TypeExtensionNode. The returned array is composed | ||
646 | by all objects created by calling the TypeExtensionNode.CreateInstance() | ||
647 | method for each node. | ||
648 | |||
649 | An InvalidOperationException exception is thrown if one of the found | ||
650 | objects is not a subclass of the provided type. | ||
651 | </remarks> | ||
652 | </member> | ||
653 | <member name="M:Mono.Addins.AddinManager.GetExtensionObjects``1(System.String)"> | ||
654 | <summary> | ||
655 | Gets extension objects registered in a path. | ||
656 | </summary> | ||
657 | <param name="path"> | ||
658 | An extension path. | ||
659 | </param> | ||
660 | <returns> | ||
661 | An array of objects registered in the path. | ||
662 | </returns> | ||
663 | <remarks> | ||
664 | This method can only be used if all nodes in the provided extension path | ||
665 | are of type Mono.Addins.TypeExtensionNode. The returned array is composed | ||
666 | by all objects created by calling the TypeExtensionNode.CreateInstance() | ||
667 | method for each node. | ||
668 | |||
669 | An InvalidOperationException exception is thrown if one of the found | ||
670 | objects is not a subclass of the provided type. | ||
671 | </remarks> | ||
672 | </member> | ||
673 | <member name="M:Mono.Addins.AddinManager.GetExtensionObjects(System.String,System.Type,System.Boolean)"> | ||
674 | <summary> | ||
675 | Gets extension objects registered in a path. | ||
676 | </summary> | ||
677 | <param name="path"> | ||
678 | An extension path. | ||
679 | </param> | ||
680 | <param name="arrayElementType"> | ||
681 | Type of the return array elements. | ||
682 | </param> | ||
683 | <param name="reuseCachedInstance"> | ||
684 | When set to True, it will return instances created in previous calls. | ||
685 | </param> | ||
686 | <returns> | ||
687 | An array of objects registered in the path. | ||
688 | </returns> | ||
689 | <remarks> | ||
690 | This method can only be used if all nodes in the provided extension path | ||
691 | are of type Mono.Addins.TypeExtensionNode. The returned array is composed | ||
692 | by all objects created by calling the TypeExtensionNode.CreateInstance() | ||
693 | method for each node (or TypeExtensionNode.GetInstance() if | ||
694 | reuseCachedInstance is set to true). | ||
695 | |||
696 | An InvalidOperationException exception is thrown if one of the found | ||
697 | objects is not a subclass of the provided type. | ||
698 | </remarks> | ||
699 | </member> | ||
700 | <member name="M:Mono.Addins.AddinManager.GetExtensionObjects``1(System.String,System.Boolean)"> | ||
701 | <summary> | ||
702 | Gets extension objects registered in a path. | ||
703 | </summary> | ||
704 | <param name="path"> | ||
705 | An extension path. | ||
706 | </param> | ||
707 | <param name="reuseCachedInstance"> | ||
708 | When set to True, it will return instances created in previous calls. | ||
709 | </param> | ||
710 | <returns> | ||
711 | An array of objects registered in the path. | ||
712 | </returns> | ||
713 | <remarks> | ||
714 | This method can only be used if all nodes in the provided extension path | ||
715 | are of type Mono.Addins.TypeExtensionNode. The returned array is composed | ||
716 | by all objects created by calling the TypeExtensionNode.CreateInstance() | ||
717 | method for each node (or TypeExtensionNode.GetInstance() if | ||
718 | reuseCachedInstance is set to true). | ||
719 | |||
720 | An InvalidOperationException exception is thrown if one of the found | ||
721 | objects is not a subclass of the provided type. | ||
722 | </remarks> | ||
723 | </member> | ||
724 | <member name="M:Mono.Addins.AddinManager.AddExtensionNodeHandler(System.String,Mono.Addins.ExtensionNodeEventHandler)"> | ||
725 | <summary> | ||
726 | Register a listener of extension node changes. | ||
727 | </summary> | ||
728 | <param name="path"> | ||
729 | Path of the node. | ||
730 | </param> | ||
731 | <param name="handler"> | ||
732 | A handler method. | ||
733 | </param> | ||
734 | <remarks> | ||
735 | Hosts can call this method to be subscribed to an extension change | ||
736 | event for a specific path. The event will be fired once for every | ||
737 | individual node change. The event arguments include the change type | ||
738 | (Add or Remove) and the extension node added or removed. | ||
739 | |||
740 | NOTE: The handler will be called for all nodes existing in the path at the moment of registration. | ||
741 | </remarks> | ||
742 | </member> | ||
743 | <member name="M:Mono.Addins.AddinManager.RemoveExtensionNodeHandler(System.String,Mono.Addins.ExtensionNodeEventHandler)"> | ||
744 | <summary> | ||
745 | Unregister a listener of extension node changes. | ||
746 | </summary> | ||
747 | <param name="path"> | ||
748 | Path of the node. | ||
749 | </param> | ||
750 | <param name="handler"> | ||
751 | A handler method. | ||
752 | </param> | ||
753 | <remarks> | ||
754 | This method unregisters a delegate from the node change event of a path. | ||
755 | </remarks> | ||
756 | </member> | ||
757 | <member name="M:Mono.Addins.AddinManager.AddExtensionNodeHandler(System.Type,Mono.Addins.ExtensionNodeEventHandler)"> | ||
758 | <summary> | ||
759 | Register a listener of extension node changes. | ||
760 | </summary> | ||
761 | <param name="instanceType"> | ||
762 | Type defining the extension point | ||
763 | </param> | ||
764 | <param name="handler"> | ||
765 | A handler method. | ||
766 | </param> | ||
767 | <remarks> | ||
768 | Hosts can call this method to be subscribed to an extension change | ||
769 | event for a specific type extension point. The event will be fired once for every | ||
770 | individual node change. The event arguments include the change type | ||
771 | (Add or Remove) and the extension node added or removed. | ||
772 | |||
773 | NOTE: The handler will be called for all nodes existing in the path at the moment of registration. | ||
774 | </remarks> | ||
775 | </member> | ||
776 | <member name="M:Mono.Addins.AddinManager.RemoveExtensionNodeHandler(System.Type,Mono.Addins.ExtensionNodeEventHandler)"> | ||
777 | <summary> | ||
778 | Unregister a listener of extension node changes. | ||
779 | </summary> | ||
780 | <param name="instanceType"> | ||
781 | Type defining the extension point | ||
782 | </param> | ||
783 | <param name="handler"> | ||
784 | A handler method. | ||
785 | </param> | ||
786 | </member> | ||
787 | <member name="P:Mono.Addins.AddinManager.IsInitialized"> | ||
788 | <summary> | ||
789 | Gets whether the add-in engine has been initialized. | ||
790 | </summary> | ||
791 | </member> | ||
792 | <member name="P:Mono.Addins.AddinManager.DefaultInstaller"> | ||
793 | <summary> | ||
794 | Gets the default add-in installer | ||
795 | </summary> | ||
796 | <remarks> | ||
797 | The default installer is used by the CheckInstalled method to request | ||
798 | the installation of missing add-ins. | ||
799 | </remarks> | ||
800 | </member> | ||
801 | <member name="P:Mono.Addins.AddinManager.DefaultLocalizer"> | ||
802 | <summary> | ||
803 | Gets the default localizer for this add-in engine | ||
804 | </summary> | ||
805 | </member> | ||
806 | <member name="P:Mono.Addins.AddinManager.CurrentLocalizer"> | ||
807 | <summary> | ||
808 | Gets the localizer for the add-in that is invoking this property | ||
809 | </summary> | ||
810 | </member> | ||
811 | <member name="P:Mono.Addins.AddinManager.CurrentAddin"> | ||
812 | <summary> | ||
813 | Gets a reference to the RuntimeAddin object for the add-in that is invoking this property | ||
814 | </summary> | ||
815 | </member> | ||
816 | <member name="P:Mono.Addins.AddinManager.AddinEngine"> | ||
817 | <summary> | ||
818 | Gets the default add-in engine | ||
819 | </summary> | ||
820 | </member> | ||
821 | <member name="P:Mono.Addins.AddinManager.Registry"> | ||
822 | <summary> | ||
823 | Gets the add-in registry bound to the default add-in engine | ||
824 | </summary> | ||
825 | </member> | ||
826 | <member name="E:Mono.Addins.AddinManager.ExtensionChanged"> | ||
827 | <summary> | ||
828 | Extension change event. | ||
829 | </summary> | ||
830 | <remarks> | ||
831 | This event is fired when any extension point in the add-in system changes. | ||
832 | The event args object provides the path of the changed extension, although | ||
833 | it does not provide information about what changed. Hosts subscribing to | ||
834 | this event should get the new list of nodes using a query method such as | ||
835 | AddinManager.GetExtensionNodes() and then update whatever needs to be updated. | ||
836 | </remarks> | ||
837 | </member> | ||
838 | <member name="E:Mono.Addins.AddinManager.AddinLoadError"> | ||
839 | <summary> | ||
840 | Add-in loading error event. | ||
841 | </summary> | ||
842 | <remarks> | ||
843 | This event is fired when there is an error when loading the extension | ||
844 | of an add-in, or any other kind of error that may happen when querying extension points. | ||
845 | </remarks> | ||
846 | </member> | ||
847 | <member name="E:Mono.Addins.AddinManager.AddinLoaded"> | ||
848 | <summary> | ||
849 | Add-in loaded event. | ||
850 | </summary> | ||
851 | <remarks> | ||
852 | Fired after loading an add-in in memory. | ||
853 | </remarks> | ||
854 | </member> | ||
855 | <member name="E:Mono.Addins.AddinManager.AddinUnloaded"> | ||
856 | <summary> | ||
857 | Add-in unload event. | ||
858 | </summary> | ||
859 | <remarks> | ||
860 | Fired when an add-in is unloaded from memory. It may happen an add-in is disabled or uninstalled. | ||
861 | </remarks> | ||
862 | </member> | ||
863 | <member name="T:Mono.Addins.Description.ExtensionNodeDescription"> | ||
864 | <summary> | ||
865 | An extension node definition. | ||
866 | </summary> | ||
867 | </member> | ||
868 | <member name="T:Mono.Addins.Description.ObjectDescription"> | ||
869 | <summary> | ||
870 | Base class for add-in description definitions. | ||
871 | </summary> | ||
872 | </member> | ||
873 | <member name="P:Mono.Addins.Description.ObjectDescription.Parent"> | ||
874 | <summary> | ||
875 | Gets the parent object. | ||
876 | </summary> | ||
877 | <value> | ||
878 | The parent object. | ||
879 | </value> | ||
880 | </member> | ||
881 | <member name="P:Mono.Addins.Description.ObjectDescription.ParentAddinDescription"> | ||
882 | <summary> | ||
883 | Gets the parent add-in description. | ||
884 | </summary> | ||
885 | <value> | ||
886 | The parent add-in description. | ||
887 | </value> | ||
888 | </member> | ||
889 | <member name="T:Mono.Addins.NodeElement"> | ||
890 | <summary> | ||
891 | An extension node element. | ||
892 | </summary> | ||
893 | <remarks> | ||
894 | A raw representation of an extension node. Contains the basic information | ||
895 | needed to create ExtensionNode instances. | ||
896 | </remarks> | ||
897 | </member> | ||
898 | <member name="M:Mono.Addins.NodeElement.GetAttribute(System.String)"> | ||
899 | <summary> | ||
900 | Gets element attributes. | ||
901 | </summary> | ||
902 | <param name="key"> | ||
903 | Name of the attribute | ||
904 | </param> | ||
905 | <returns> | ||
906 | The value of the attribute | ||
907 | </returns> | ||
908 | </member> | ||
909 | <member name="P:Mono.Addins.NodeElement.NodeName"> | ||
910 | <summary> | ||
911 | Name of the node element. | ||
912 | </summary> | ||
913 | </member> | ||
914 | <member name="P:Mono.Addins.NodeElement.Attributes"> | ||
915 | <summary> | ||
916 | Gets all attributes defined in the element. | ||
917 | </summary> | ||
918 | </member> | ||
919 | <member name="P:Mono.Addins.NodeElement.ChildNodes"> | ||
920 | <summary> | ||
921 | Gets child nodes of this node | ||
922 | </summary> | ||
923 | </member> | ||
924 | <member name="M:Mono.Addins.Description.ExtensionNodeDescription.#ctor(System.String)"> | ||
925 | <summary> | ||
926 | Initializes a new instance of the <see cref="T:Mono.Addins.Description.ExtensionNodeDescription"/> class. | ||
927 | </summary> | ||
928 | <param name="nodeName"> | ||
929 | Node name. | ||
930 | </param> | ||
931 | </member> | ||
932 | <member name="M:Mono.Addins.Description.ExtensionNodeDescription.GetNodeType"> | ||
933 | <summary> | ||
934 | Gets the type of the node. | ||
935 | </summary> | ||
936 | <returns> | ||
937 | The node type. | ||
938 | </returns> | ||
939 | <remarks> | ||
940 | This method only works when the add-in description to which the node belongs has been | ||
941 | loaded from an add-in registry. | ||
942 | </remarks> | ||
943 | </member> | ||
944 | <member name="M:Mono.Addins.Description.ExtensionNodeDescription.GetParentPath"> | ||
945 | <summary> | ||
946 | Gets the extension path under which this node is registered | ||
947 | </summary> | ||
948 | <returns> | ||
949 | The parent path. | ||
950 | </returns> | ||
951 | <remarks> | ||
952 | For example, if the id of the node is 'ThisNode', and the node is a child of another node with id 'ParentNode', and | ||
953 | that parent node is defined in an extension with the path '/Core/MainExtension', then the parent path is 'Core/MainExtension/ParentNode'. | ||
954 | </remarks> | ||
955 | </member> | ||
956 | <member name="M:Mono.Addins.Description.ExtensionNodeDescription.GetAttribute(System.String)"> | ||
957 | <summary> | ||
958 | Gets the value of an attribute. | ||
959 | </summary> | ||
960 | <returns> | ||
961 | The value of the attribute, or an empty string if the attribute is not defined. | ||
962 | </returns> | ||
963 | <param name='key'> | ||
964 | Name of the attribute. | ||
965 | </param> | ||
966 | </member> | ||
967 | <member name="M:Mono.Addins.Description.ExtensionNodeDescription.SetAttribute(System.String,System.String)"> | ||
968 | <summary> | ||
969 | Sets the value of an attribute. | ||
970 | </summary> | ||
971 | <param name='key'> | ||
972 | Name of the attribute | ||
973 | </param> | ||
974 | <param name='value'> | ||
975 | The value. | ||
976 | </param> | ||
977 | </member> | ||
978 | <member name="M:Mono.Addins.Description.ExtensionNodeDescription.RemoveAttribute(System.String)"> | ||
979 | <summary> | ||
980 | Removes an attribute. | ||
981 | </summary> | ||
982 | <param name='name'> | ||
983 | Name of the attribute to remove. | ||
984 | </param> | ||
985 | </member> | ||
986 | <member name="P:Mono.Addins.Description.ExtensionNodeDescription.NodeName"> | ||
987 | <summary> | ||
988 | Gets or sets the name of the node. | ||
989 | </summary> | ||
990 | <value> | ||
991 | The name of the node. | ||
992 | </value> | ||
993 | </member> | ||
994 | <member name="P:Mono.Addins.Description.ExtensionNodeDescription.Id"> | ||
995 | <summary> | ||
996 | Gets or sets the identifier of the node. | ||
997 | </summary> | ||
998 | <value> | ||
999 | The identifier. | ||
1000 | </value> | ||
1001 | </member> | ||
1002 | <member name="P:Mono.Addins.Description.ExtensionNodeDescription.InsertAfter"> | ||
1003 | <summary> | ||
1004 | Gets or sets the identifier of the node after which this node has to be inserted | ||
1005 | </summary> | ||
1006 | <value> | ||
1007 | The identifier of the reference node | ||
1008 | </value> | ||
1009 | </member> | ||
1010 | <member name="P:Mono.Addins.Description.ExtensionNodeDescription.InsertBefore"> | ||
1011 | <summary> | ||
1012 | Gets or sets the identifier of the node before which this node has to be inserted | ||
1013 | </summary> | ||
1014 | <value> | ||
1015 | The identifier of the reference node | ||
1016 | </value> | ||
1017 | </member> | ||
1018 | <member name="P:Mono.Addins.Description.ExtensionNodeDescription.IsCondition"> | ||
1019 | <summary> | ||
1020 | Gets a value indicating whether this node is a condition. | ||
1021 | </summary> | ||
1022 | <value> | ||
1023 | <c>true</c> if this node is a condition; otherwise, <c>false</c>. | ||
1024 | </value> | ||
1025 | </member> | ||
1026 | <member name="P:Mono.Addins.Description.ExtensionNodeDescription.Attributes"> | ||
1027 | <summary> | ||
1028 | Gets the attributes of the node. | ||
1029 | </summary> | ||
1030 | <value> | ||
1031 | The attributes. | ||
1032 | </value> | ||
1033 | </member> | ||
1034 | <member name="P:Mono.Addins.Description.ExtensionNodeDescription.ChildNodes"> | ||
1035 | <summary> | ||
1036 | Gets the child nodes. | ||
1037 | </summary> | ||
1038 | <value> | ||
1039 | The child nodes. | ||
1040 | </value> | ||
1041 | </member> | ||
1042 | <member name="T:Mono.Addins.Description.ExtensionNodeType"> | ||
1043 | <summary> | ||
1044 | An extension node type definition. | ||
1045 | </summary> | ||
1046 | </member> | ||
1047 | <member name="T:Mono.Addins.Description.ExtensionNodeSet"> | ||
1048 | <summary> | ||
1049 | An extension node set definition. | ||
1050 | </summary> | ||
1051 | <remarks> | ||
1052 | Node sets allow grouping a set of extension node declarations and give an identifier to that group | ||
1053 | (the node set). Once a node set is declared, it can be referenced from several extension points | ||
1054 | which use the same extension node structure. Extension node sets also allow declaring recursive | ||
1055 | extension nodes, that is, extension nodes with a tree structure. | ||
1056 | </remarks> | ||
1057 | </member> | ||
1058 | <member name="M:Mono.Addins.Description.ExtensionNodeSet.CopyFrom(Mono.Addins.Description.ExtensionNodeSet)"> | ||
1059 | <summary> | ||
1060 | Copies data from another node set | ||
1061 | </summary> | ||
1062 | <param name='nset'> | ||
1063 | Node set from which to copy | ||
1064 | </param> | ||
1065 | </member> | ||
1066 | <member name="M:Mono.Addins.Description.ExtensionNodeSet.#ctor"> | ||
1067 | <summary> | ||
1068 | Initializes a new instance of the <see cref="T:Mono.Addins.Description.ExtensionNodeSet"/> class. | ||
1069 | </summary> | ||
1070 | </member> | ||
1071 | <member name="M:Mono.Addins.Description.ExtensionNodeSet.GetAllowedNodeTypes"> | ||
1072 | <summary> | ||
1073 | Gets all the allowed node types. | ||
1074 | </summary> | ||
1075 | <returns> | ||
1076 | The allowed node types. | ||
1077 | </returns> | ||
1078 | <remarks> | ||
1079 | Gets all allowed node types, including those defined in included node sets. | ||
1080 | This method only works for descriptions loaded from a registry. | ||
1081 | </remarks> | ||
1082 | </member> | ||
1083 | <member name="P:Mono.Addins.Description.ExtensionNodeSet.Id"> | ||
1084 | <summary> | ||
1085 | Gets or sets the identifier of the node set. | ||
1086 | </summary> | ||
1087 | <value> | ||
1088 | The identifier. | ||
1089 | </value> | ||
1090 | </member> | ||
1091 | <member name="P:Mono.Addins.Description.ExtensionNodeSet.NodeTypes"> | ||
1092 | <summary> | ||
1093 | Gets the node types allowed in this node set. | ||
1094 | </summary> | ||
1095 | <value> | ||
1096 | The node types. | ||
1097 | </value> | ||
1098 | </member> | ||
1099 | <member name="P:Mono.Addins.Description.ExtensionNodeSet.NodeSets"> | ||
1100 | <summary> | ||
1101 | Gets a list of other node sets included in this node set. | ||
1102 | </summary> | ||
1103 | <value> | ||
1104 | The node sets. | ||
1105 | </value> | ||
1106 | </member> | ||
1107 | <member name="M:Mono.Addins.Description.ExtensionNodeType.#ctor"> | ||
1108 | <summary> | ||
1109 | Initializes a new instance of the <see cref="T:Mono.Addins.Description.ExtensionNodeType"/> class. | ||
1110 | </summary> | ||
1111 | </member> | ||
1112 | <member name="M:Mono.Addins.Description.ExtensionNodeType.CopyFrom(Mono.Addins.Description.ExtensionNodeType)"> | ||
1113 | <summary> | ||
1114 | Copies data from another node set | ||
1115 | </summary> | ||
1116 | </member> | ||
1117 | <member name="P:Mono.Addins.Description.ExtensionNodeType.TypeName"> | ||
1118 | <summary> | ||
1119 | Type that implements the extension node. | ||
1120 | </summary> | ||
1121 | <value> | ||
1122 | The full name of the type. | ||
1123 | </value> | ||
1124 | </member> | ||
1125 | <member name="P:Mono.Addins.Description.ExtensionNodeType.NodeName"> | ||
1126 | <summary> | ||
1127 | Element name to be used when defining an extension in an XML manifest. The default name is "Type". | ||
1128 | </summary> | ||
1129 | <value> | ||
1130 | The name of the node. | ||
1131 | </value> | ||
1132 | </member> | ||
1133 | <member name="P:Mono.Addins.Description.ExtensionNodeType.ObjectTypeName"> | ||
1134 | <summary> | ||
1135 | Type of the object that the extension creates (only valid for TypeNodeExtension). | ||
1136 | </summary> | ||
1137 | </member> | ||
1138 | <member name="P:Mono.Addins.Description.ExtensionNodeType.ExtensionAttributeTypeName"> | ||
1139 | <summary> | ||
1140 | Name of the custom attribute that can be used to declare nodes of this type | ||
1141 | </summary> | ||
1142 | </member> | ||
1143 | <member name="P:Mono.Addins.Description.ExtensionNodeType.Description"> | ||
1144 | <summary> | ||
1145 | Long description of the node type | ||
1146 | </summary> | ||
1147 | </member> | ||
1148 | <member name="P:Mono.Addins.Description.ExtensionNodeType.Attributes"> | ||
1149 | <summary> | ||
1150 | Attributes supported by the extension node type. | ||
1151 | </summary> | ||
1152 | </member> | ||
1153 | <member name="T:Mono.Addins.Description.AddinDescription"> | ||
1154 | <summary> | ||
1155 | An add-in description | ||
1156 | </summary> | ||
1157 | <remarks> | ||
1158 | This class represent an add-in manifest. It has properties for getting | ||
1159 | all information, and methods for loading and saving files. | ||
1160 | </remarks> | ||
1161 | </member> | ||
1162 | <member name="M:Mono.Addins.Description.AddinDescription.AddExtensionPoint(System.String)"> | ||
1163 | <summary> | ||
1164 | Adds an extension point. | ||
1165 | </summary> | ||
1166 | <returns> | ||
1167 | The extension point. | ||
1168 | </returns> | ||
1169 | <param name='path'> | ||
1170 | Path that identifies the new extension point. | ||
1171 | </param> | ||
1172 | </member> | ||
1173 | <member name="M:Mono.Addins.Description.AddinDescription.Save(System.String)"> | ||
1174 | <summary> | ||
1175 | Saves the add-in description. | ||
1176 | </summary> | ||
1177 | <param name='fileName'> | ||
1178 | File name where to save this instance | ||
1179 | </param> | ||
1180 | <remarks> | ||
1181 | Saves the add-in description to the specified file and sets the FileName property. | ||
1182 | </remarks> | ||
1183 | </member> | ||
1184 | <member name="M:Mono.Addins.Description.AddinDescription.Save"> | ||
1185 | <summary> | ||
1186 | Saves the add-in description. | ||
1187 | </summary> | ||
1188 | <exception cref="T:System.InvalidOperationException"> | ||
1189 | It is thrown if FileName is not set | ||
1190 | </exception> | ||
1191 | <remarks> | ||
1192 | The description is saved to the file specified in the FileName property. | ||
1193 | </remarks> | ||
1194 | </member> | ||
1195 | <member name="M:Mono.Addins.Description.AddinDescription.SaveToXml"> | ||
1196 | <summary> | ||
1197 | Generates an XML representation of the add-in description | ||
1198 | </summary> | ||
1199 | <returns> | ||
1200 | An XML manifest. | ||
1201 | </returns> | ||
1202 | </member> | ||
1203 | <member name="M:Mono.Addins.Description.AddinDescription.Read(System.String)"> | ||
1204 | <summary> | ||
1205 | Load an add-in description from a file | ||
1206 | </summary> | ||
1207 | <param name='configFile'> | ||
1208 | The file. | ||
1209 | </param> | ||
1210 | </member> | ||
1211 | <member name="M:Mono.Addins.Description.AddinDescription.Read(System.IO.Stream,System.String)"> | ||
1212 | <summary> | ||
1213 | Load an add-in description from a stream | ||
1214 | </summary> | ||
1215 | <param name='stream'> | ||
1216 | The stream | ||
1217 | </param> | ||
1218 | <param name='basePath'> | ||
1219 | The path to be used to resolve relative file paths. | ||
1220 | </param> | ||
1221 | </member> | ||
1222 | <member name="M:Mono.Addins.Description.AddinDescription.Read(System.IO.TextReader,System.String)"> | ||
1223 | <summary> | ||
1224 | Load an add-in description from a text reader | ||
1225 | </summary> | ||
1226 | <param name='reader'> | ||
1227 | The text reader | ||
1228 | </param> | ||
1229 | <param name='basePath'> | ||
1230 | The path to be used to resolve relative file paths. | ||
1231 | </param> | ||
1232 | </member> | ||
1233 | <member name="M:Mono.Addins.Description.AddinDescription.Verify"> | ||
1234 | <summary> | ||
1235 | Verify this instance. | ||
1236 | </summary> | ||
1237 | <remarks> | ||
1238 | This method checks all the definitions in the description and returns a list of errors. | ||
1239 | If the returned list is empty, it means that the description is valid. | ||
1240 | </remarks> | ||
1241 | </member> | ||
1242 | <member name="P:Mono.Addins.Description.AddinDescription.AddinFile"> | ||
1243 | <summary> | ||
1244 | Gets or sets the path to the main addin file. | ||
1245 | </summary> | ||
1246 | <value> | ||
1247 | The addin file. | ||
1248 | </value> | ||
1249 | <remarks> | ||
1250 | The add-in file can be either the main assembly of an add-in or an xml manifest. | ||
1251 | </remarks> | ||
1252 | </member> | ||
1253 | <member name="P:Mono.Addins.Description.AddinDescription.AddinId"> | ||
1254 | <summary> | ||
1255 | Gets the addin identifier. | ||
1256 | </summary> | ||
1257 | <value> | ||
1258 | The addin identifier. | ||
1259 | </value> | ||
1260 | </member> | ||
1261 | <member name="P:Mono.Addins.Description.AddinDescription.LocalId"> | ||
1262 | <summary> | ||
1263 | Gets or sets the local identifier. | ||
1264 | </summary> | ||
1265 | <value> | ||
1266 | The local identifier. | ||
1267 | </value> | ||
1268 | </member> | ||
1269 | <member name="P:Mono.Addins.Description.AddinDescription.Namespace"> | ||
1270 | <summary> | ||
1271 | Gets or sets the namespace. | ||
1272 | </summary> | ||
1273 | <value> | ||
1274 | The namespace. | ||
1275 | </value> | ||
1276 | </member> | ||
1277 | <member name="P:Mono.Addins.Description.AddinDescription.Name"> | ||
1278 | <summary> | ||
1279 | Gets or sets the display name of the add-in. | ||
1280 | </summary> | ||
1281 | <value> | ||
1282 | The name. | ||
1283 | </value> | ||
1284 | </member> | ||
1285 | <member name="P:Mono.Addins.Description.AddinDescription.Version"> | ||
1286 | <summary> | ||
1287 | Gets or sets the version. | ||
1288 | </summary> | ||
1289 | <value> | ||
1290 | The version. | ||
1291 | </value> | ||
1292 | </member> | ||
1293 | <member name="P:Mono.Addins.Description.AddinDescription.CompatVersion"> | ||
1294 | <summary> | ||
1295 | Gets or sets the version of the add-in with which this add-in is backwards compatible. | ||
1296 | </summary> | ||
1297 | <value> | ||
1298 | The compat version. | ||
1299 | </value> | ||
1300 | </member> | ||
1301 | <member name="P:Mono.Addins.Description.AddinDescription.Author"> | ||
1302 | <summary> | ||
1303 | Gets or sets the author. | ||
1304 | </summary> | ||
1305 | <value> | ||
1306 | The author. | ||
1307 | </value> | ||
1308 | </member> | ||
1309 | <member name="P:Mono.Addins.Description.AddinDescription.Url"> | ||
1310 | <summary> | ||
1311 | Gets or sets the Url where more information about the add-in can be found. | ||
1312 | </summary> | ||
1313 | <value> | ||
1314 | The URL. | ||
1315 | </value> | ||
1316 | </member> | ||
1317 | <member name="P:Mono.Addins.Description.AddinDescription.Copyright"> | ||
1318 | <summary> | ||
1319 | Gets or sets the copyright. | ||
1320 | </summary> | ||
1321 | <value> | ||
1322 | The copyright. | ||
1323 | </value> | ||
1324 | </member> | ||
1325 | <member name="P:Mono.Addins.Description.AddinDescription.Description"> | ||
1326 | <summary> | ||
1327 | Gets or sets the description of the add-in. | ||
1328 | </summary> | ||
1329 | <value> | ||
1330 | The description. | ||
1331 | </value> | ||
1332 | </member> | ||
1333 | <member name="P:Mono.Addins.Description.AddinDescription.Category"> | ||
1334 | <summary> | ||
1335 | Gets or sets the category of the add-in. | ||
1336 | </summary> | ||
1337 | <value> | ||
1338 | The category. | ||
1339 | </value> | ||
1340 | </member> | ||
1341 | <member name="P:Mono.Addins.Description.AddinDescription.BasePath"> | ||
1342 | <summary> | ||
1343 | Gets the base path for locating external files relative to the add-in. | ||
1344 | </summary> | ||
1345 | <value> | ||
1346 | The base path. | ||
1347 | </value> | ||
1348 | </member> | ||
1349 | <member name="P:Mono.Addins.Description.AddinDescription.IsRoot"> | ||
1350 | <summary> | ||
1351 | Gets or sets a value indicating whether this instance is an add-in root. | ||
1352 | </summary> | ||
1353 | <value> | ||
1354 | <c>true</c> if this instance is an add-in root; otherwise, <c>false</c>. | ||
1355 | </value> | ||
1356 | </member> | ||
1357 | <member name="P:Mono.Addins.Description.AddinDescription.EnabledByDefault"> | ||
1358 | <summary> | ||
1359 | Gets or sets a value indicating whether this add-in is enabled by default. | ||
1360 | </summary> | ||
1361 | <value> | ||
1362 | <c>true</c> if enabled by default; otherwise, <c>false</c>. | ||
1363 | </value> | ||
1364 | </member> | ||
1365 | <member name="P:Mono.Addins.Description.AddinDescription.Flags"> | ||
1366 | <summary> | ||
1367 | Gets or sets the add-in flags. | ||
1368 | </summary> | ||
1369 | <value> | ||
1370 | The flags. | ||
1371 | </value> | ||
1372 | </member> | ||
1373 | <member name="P:Mono.Addins.Description.AddinDescription.CanDisable"> | ||
1374 | <summary> | ||
1375 | Gets a value indicating whether this add-in can be disabled. | ||
1376 | </summary> | ||
1377 | <value> | ||
1378 | <c>true</c> if this add-in can be disabled; otherwise, <c>false</c>. | ||
1379 | </value> | ||
1380 | </member> | ||
1381 | <member name="P:Mono.Addins.Description.AddinDescription.CanUninstall"> | ||
1382 | <summary> | ||
1383 | Gets a value indicating whether this add-in can be uninstalled. | ||
1384 | </summary> | ||
1385 | <value> | ||
1386 | <c>true</c> if this instance can be uninstalled; otherwise, <c>false</c>. | ||
1387 | </value> | ||
1388 | </member> | ||
1389 | <member name="P:Mono.Addins.Description.AddinDescription.IsHidden"> | ||
1390 | <summary> | ||
1391 | Gets a value indicating whether this add-in is hidden. | ||
1392 | </summary> | ||
1393 | <value> | ||
1394 | <c>true</c> if this add-in is hidden; otherwise, <c>false</c>. | ||
1395 | </value> | ||
1396 | </member> | ||
1397 | <member name="P:Mono.Addins.Description.AddinDescription.AllFiles"> | ||
1398 | <summary> | ||
1399 | Gets all external files | ||
1400 | </summary> | ||
1401 | <value> | ||
1402 | All files. | ||
1403 | </value> | ||
1404 | <remarks> | ||
1405 | External files are data files and assemblies explicitly referenced in the Runtime section of the add-in manifest. | ||
1406 | </remarks> | ||
1407 | </member> | ||
1408 | <member name="P:Mono.Addins.Description.AddinDescription.AllIgnorePaths"> | ||
1409 | <summary> | ||
1410 | Gets all paths to be ignored by the add-in scanner. | ||
1411 | </summary> | ||
1412 | <value> | ||
1413 | All paths to be ignored. | ||
1414 | </value> | ||
1415 | </member> | ||
1416 | <member name="P:Mono.Addins.Description.AddinDescription.MainModule"> | ||
1417 | <summary> | ||
1418 | Gets the main module. | ||
1419 | </summary> | ||
1420 | <value> | ||
1421 | The main module. | ||
1422 | </value> | ||
1423 | </member> | ||
1424 | <member name="P:Mono.Addins.Description.AddinDescription.OptionalModules"> | ||
1425 | <summary> | ||
1426 | Gets the optional modules. | ||
1427 | </summary> | ||
1428 | <value> | ||
1429 | The optional modules. | ||
1430 | </value> | ||
1431 | <remarks> | ||
1432 | Optional modules can be used to declare extensions which will be registered only if some specified | ||
1433 | add-in dependencies can be satisfied. Dependencies specified in optional modules are 'soft dependencies', | ||
1434 | which means that they don't need to be satisfied in order to load the add-in. | ||
1435 | </remarks> | ||
1436 | </member> | ||
1437 | <member name="P:Mono.Addins.Description.AddinDescription.AllModules"> | ||
1438 | <summary> | ||
1439 | Gets all modules (including the main module and all optional modules) | ||
1440 | </summary> | ||
1441 | <value> | ||
1442 | All modules. | ||
1443 | </value> | ||
1444 | </member> | ||
1445 | <member name="P:Mono.Addins.Description.AddinDescription.ExtensionNodeSets"> | ||
1446 | <summary> | ||
1447 | Gets the extension node sets. | ||
1448 | </summary> | ||
1449 | <value> | ||
1450 | The extension node sets. | ||
1451 | </value> | ||
1452 | </member> | ||
1453 | <member name="P:Mono.Addins.Description.AddinDescription.ExtensionPoints"> | ||
1454 | <summary> | ||
1455 | Gets the extension points. | ||
1456 | </summary> | ||
1457 | <value> | ||
1458 | The extension points. | ||
1459 | </value> | ||
1460 | </member> | ||
1461 | <member name="P:Mono.Addins.Description.AddinDescription.ConditionTypes"> | ||
1462 | <summary> | ||
1463 | Gets the condition types. | ||
1464 | </summary> | ||
1465 | <value> | ||
1466 | The condition types. | ||
1467 | </value> | ||
1468 | </member> | ||
1469 | <member name="P:Mono.Addins.Description.AddinDescription.Localizer"> | ||
1470 | <summary> | ||
1471 | Gets or sets the add-in localizer. | ||
1472 | </summary> | ||
1473 | <value> | ||
1474 | The description of the add-in localizer for this add-in. | ||
1475 | </value> | ||
1476 | </member> | ||
1477 | <member name="P:Mono.Addins.Description.AddinDescription.Properties"> | ||
1478 | <summary> | ||
1479 | Custom properties specified in the add-in header | ||
1480 | </summary> | ||
1481 | </member> | ||
1482 | <member name="P:Mono.Addins.Description.AddinDescription.FileName"> | ||
1483 | <summary> | ||
1484 | Gets or sets file where this description is stored | ||
1485 | </summary> | ||
1486 | <value> | ||
1487 | The file path. | ||
1488 | </value> | ||
1489 | </member> | ||
1490 | <member name="T:Mono.Addins.AddinFlagsAttribute"> | ||
1491 | <summary> | ||
1492 | Addin flags attribute. | ||
1493 | </summary> | ||
1494 | </member> | ||
1495 | <member name="M:Mono.Addins.AddinFlagsAttribute.#ctor(Mono.Addins.Description.AddinFlags)"> | ||
1496 | <summary> | ||
1497 | Initializes the attribute | ||
1498 | </summary> | ||
1499 | <param name="flags"> | ||
1500 | Add-in flags | ||
1501 | </param> | ||
1502 | </member> | ||
1503 | <member name="P:Mono.Addins.AddinFlagsAttribute.Flags"> | ||
1504 | <summary> | ||
1505 | Add-in flags | ||
1506 | </summary> | ||
1507 | </member> | ||
1508 | <member name="T:Mono.Addins.AddinEventHandler"> | ||
1509 | <summary> | ||
1510 | Delegate to be used in add-in engine events | ||
1511 | </summary> | ||
1512 | </member> | ||
1513 | <member name="T:Mono.Addins.AddinEventArgs"> | ||
1514 | <summary> | ||
1515 | Provides information about an add-in engine event. | ||
1516 | </summary> | ||
1517 | </member> | ||
1518 | <member name="M:Mono.Addins.AddinEventArgs.#ctor(System.String)"> | ||
1519 | <summary> | ||
1520 | Initializes a new instance of the <see cref="T:Mono.Addins.AddinEventArgs"/> class. | ||
1521 | </summary> | ||
1522 | <param name="addinId"> | ||
1523 | Add-in identifier. | ||
1524 | </param> | ||
1525 | </member> | ||
1526 | <member name="P:Mono.Addins.AddinEventArgs.AddinId"> | ||
1527 | <summary> | ||
1528 | Identifier of the add-in that generated the event. | ||
1529 | </summary> | ||
1530 | </member> | ||
1531 | <member name="T:Mono.Addins.NodeAttribute"> | ||
1532 | <summary> | ||
1533 | Attribute of a NodeElement. | ||
1534 | </summary> | ||
1535 | </member> | ||
1536 | <member name="P:Mono.Addins.NodeAttribute.Name"> | ||
1537 | <summary> | ||
1538 | Name of the attribute. | ||
1539 | </summary> | ||
1540 | </member> | ||
1541 | <member name="P:Mono.Addins.NodeAttribute.Value"> | ||
1542 | <summary> | ||
1543 | Value of the attribute. | ||
1544 | </summary> | ||
1545 | </member> | ||
1546 | <member name="T:Mono.Addins.Database.IAssemblyLocator"> | ||
1547 | <summary> | ||
1548 | Allows finding assemblies in the file system | ||
1549 | </summary> | ||
1550 | </member> | ||
1551 | <member name="M:Mono.Addins.Database.IAssemblyLocator.GetAssemblyLocation(System.String)"> | ||
1552 | <summary> | ||
1553 | Locates an assembly | ||
1554 | </summary> | ||
1555 | <returns> | ||
1556 | The full path to the assembly, or null if not found | ||
1557 | </returns> | ||
1558 | <param name='fullName'> | ||
1559 | Full name of the assembly | ||
1560 | </param> | ||
1561 | </member> | ||
1562 | <member name="T:Mono.Addins.Description.AddinProperty"> | ||
1563 | <summary> | ||
1564 | An add-in property. | ||
1565 | </summary> | ||
1566 | </member> | ||
1567 | <member name="P:Mono.Addins.Description.AddinProperty.Name"> | ||
1568 | <summary> | ||
1569 | Name of the property | ||
1570 | </summary> | ||
1571 | </member> | ||
1572 | <member name="P:Mono.Addins.Description.AddinProperty.Locale"> | ||
1573 | <summary> | ||
1574 | Locale of the property. It is null if the property is not localized. | ||
1575 | </summary> | ||
1576 | </member> | ||
1577 | <member name="P:Mono.Addins.Description.AddinProperty.Value"> | ||
1578 | <summary> | ||
1579 | Value of the property. | ||
1580 | </summary> | ||
1581 | </member> | ||
1582 | <member name="T:Mono.Addins.Localization.IAddinLocalizerFactory"> | ||
1583 | <summary> | ||
1584 | A localizer factory. | ||
1585 | </summary> | ||
1586 | </member> | ||
1587 | <member name="M:Mono.Addins.Localization.IAddinLocalizerFactory.CreateLocalizer(Mono.Addins.RuntimeAddin,Mono.Addins.NodeElement)"> | ||
1588 | <summary> | ||
1589 | Creates a localizer for an add-in. | ||
1590 | </summary> | ||
1591 | <returns> | ||
1592 | The localizer. | ||
1593 | </returns> | ||
1594 | <param name='addin'> | ||
1595 | The add-in for which to create the localizer. | ||
1596 | </param> | ||
1597 | <param name='element'> | ||
1598 | Localizer parameters. | ||
1599 | </param> | ||
1600 | </member> | ||
1601 | <member name="T:Mono.Addins.Description.Dependency"> | ||
1602 | <summary> | ||
1603 | Definition of an add-in dependency. | ||
1604 | </summary> | ||
1605 | </member> | ||
1606 | <member name="P:Mono.Addins.Description.Dependency.Name"> | ||
1607 | <summary> | ||
1608 | Gets the display name of the dependency. | ||
1609 | </summary> | ||
1610 | <value> | ||
1611 | The name. | ||
1612 | </value> | ||
1613 | </member> | ||
1614 | <member name="T:Mono.Addins.Description.ExtensionNodeSetCollection"> | ||
1615 | <summary> | ||
1616 | A collection of node sets. | ||
1617 | </summary> | ||
1618 | </member> | ||
1619 | <member name="M:Mono.Addins.Description.ExtensionNodeSetCollection.#ctor"> | ||
1620 | <summary> | ||
1621 | Initializes a new instance of the <see cref="T:Mono.Addins.Description.ExtensionNodeSetCollection"/> class. | ||
1622 | </summary> | ||
1623 | </member> | ||
1624 | <member name="P:Mono.Addins.Description.ExtensionNodeSetCollection.Item(System.Int32)"> | ||
1625 | <summary> | ||
1626 | Gets the <see cref="T:Mono.Addins.Description.ExtensionNodeSet"/> at the specified index. | ||
1627 | </summary> | ||
1628 | <param name="n"> | ||
1629 | The index. | ||
1630 | </param> | ||
1631 | </member> | ||
1632 | <member name="P:Mono.Addins.Description.ExtensionNodeSetCollection.Item(System.String)"> | ||
1633 | <summary> | ||
1634 | Gets the <see cref="T:Mono.Addins.Description.ExtensionNodeSet"/> with the specified id. | ||
1635 | </summary> | ||
1636 | <param name="id"> | ||
1637 | Identifier. | ||
1638 | </param> | ||
1639 | </member> | ||
1640 | <member name="T:Mono.Addins.AddinEngine"> | ||
1641 | <summary> | ||
1642 | An add-in engine. | ||
1643 | </summary> | ||
1644 | <remarks> | ||
1645 | This class allows hosting several independent add-in engines in a single application domain. | ||
1646 | In general, applications use the AddinManager class to query and manage extensions. This class is static, | ||
1647 | so the API is easily accessible. However, some kind applications may need to use several isolated | ||
1648 | add-in engines, and in this case the AddinManager class can't be used, because it is bound to a single | ||
1649 | add-in engine. Those applications can instead create several instances of the AddinEngine class. Each | ||
1650 | add-in engine can be independently initialized with different add-in registries and extension models. | ||
1651 | </remarks> | ||
1652 | </member> | ||
1653 | <member name="T:Mono.Addins.ExtensionContext"> | ||
1654 | <summary> | ||
1655 | An extension context. | ||
1656 | </summary> | ||
1657 | <remarks> | ||
1658 | Extension contexts can be used to query the extension tree | ||
1659 | using particular condition values. Extension points which | ||
1660 | declare the availability of a condition type can only be | ||
1661 | queryed using an extension context which provides an | ||
1662 | evaluator for that condition. | ||
1663 | </remarks> | ||
1664 | </member> | ||
1665 | <member name="M:Mono.Addins.ExtensionContext.RegisterCondition(System.String,Mono.Addins.ConditionType)"> | ||
1666 | <summary> | ||
1667 | Registers a new condition in the extension context. | ||
1668 | </summary> | ||
1669 | <param name="id"> | ||
1670 | Identifier of the condition. | ||
1671 | </param> | ||
1672 | <param name="type"> | ||
1673 | Condition evaluator. | ||
1674 | </param> | ||
1675 | <remarks> | ||
1676 | The registered condition will be particular to this extension context. | ||
1677 | Any event that might be fired as a result of changes in the condition will | ||
1678 | only be fired in this context. | ||
1679 | </remarks> | ||
1680 | </member> | ||
1681 | <member name="M:Mono.Addins.ExtensionContext.RegisterCondition(System.String,System.Type)"> | ||
1682 | <summary> | ||
1683 | Registers a new condition in the extension context. | ||
1684 | </summary> | ||
1685 | <param name="id"> | ||
1686 | Identifier of the condition. | ||
1687 | </param> | ||
1688 | <param name="type"> | ||
1689 | Type of the condition evaluator. Must be a subclass of Mono.Addins.ConditionType. | ||
1690 | </param> | ||
1691 | <remarks> | ||
1692 | The registered condition will be particular to this extension context. Any event | ||
1693 | that might be fired as a result of changes in the condition will only be fired in this context. | ||
1694 | </remarks> | ||
1695 | </member> | ||
1696 | <member name="M:Mono.Addins.ExtensionContext.GetExtensionNode(System.String)"> | ||
1697 | <summary> | ||
1698 | Returns the extension node in a path | ||
1699 | </summary> | ||
1700 | <param name="path"> | ||
1701 | Location of the node. | ||
1702 | </param> | ||
1703 | <returns> | ||
1704 | The node, or null if not found. | ||
1705 | </returns> | ||
1706 | </member> | ||
1707 | <member name="M:Mono.Addins.ExtensionContext.GetExtensionNode``1(System.String)"> | ||
1708 | <summary> | ||
1709 | Returns the extension node in a path | ||
1710 | </summary> | ||
1711 | <param name="path"> | ||
1712 | Location of the node. | ||
1713 | </param> | ||
1714 | <returns> | ||
1715 | The node, or null if not found. | ||
1716 | </returns> | ||
1717 | </member> | ||
1718 | <member name="M:Mono.Addins.ExtensionContext.GetExtensionNodes(System.String)"> | ||
1719 | <summary> | ||
1720 | Gets extension nodes registered in a path. | ||
1721 | </summary> | ||
1722 | <param name="path"> | ||
1723 | An extension path.> | ||
1724 | </param> | ||
1725 | <returns> | ||
1726 | All nodes registered in the provided path. | ||
1727 | </returns> | ||
1728 | </member> | ||
1729 | <member name="M:Mono.Addins.ExtensionContext.GetExtensionNodes``1(System.String)"> | ||
1730 | <summary> | ||
1731 | Gets extension nodes registered in a path. | ||
1732 | </summary> | ||
1733 | <param name="path"> | ||
1734 | An extension path. | ||
1735 | </param> | ||
1736 | <returns> | ||
1737 | A list of nodes | ||
1738 | </returns> | ||
1739 | <remarks> | ||
1740 | This method returns all nodes registered under the provided path. | ||
1741 | It will throw a InvalidOperationException if the type of one of | ||
1742 | the registered nodes is not assignable to the provided type. | ||
1743 | </remarks> | ||
1744 | </member> | ||
1745 | <member name="M:Mono.Addins.ExtensionContext.GetExtensionNodes(System.Type)"> | ||
1746 | <summary> | ||
1747 | Gets extension nodes for a type extension point | ||
1748 | </summary> | ||
1749 | <param name="instanceType"> | ||
1750 | Type defining the extension point | ||
1751 | </param> | ||
1752 | <returns> | ||
1753 | A list of nodes | ||
1754 | </returns> | ||
1755 | <remarks> | ||
1756 | This method returns all extension nodes bound to the provided type. | ||
1757 | </remarks> | ||
1758 | </member> | ||
1759 | <member name="M:Mono.Addins.ExtensionContext.GetExtensionNodes(System.Type,System.Type)"> | ||
1760 | <summary> | ||
1761 | Gets extension nodes for a type extension point | ||
1762 | </summary> | ||
1763 | <param name="instanceType"> | ||
1764 | Type defining the extension point | ||
1765 | </param> | ||
1766 | <param name="expectedNodeType"> | ||
1767 | Expected extension node type | ||
1768 | </param> | ||
1769 | <returns> | ||
1770 | A list of nodes | ||
1771 | </returns> | ||
1772 | <remarks> | ||
1773 | This method returns all nodes registered for the provided type. | ||
1774 | It will throw a InvalidOperationException if the type of one of | ||
1775 | the registered nodes is not assignable to the provided node type. | ||
1776 | </remarks> | ||
1777 | </member> | ||
1778 | <member name="M:Mono.Addins.ExtensionContext.GetExtensionNodes``1(System.Type)"> | ||
1779 | <summary> | ||
1780 | Gets extension nodes for a type extension point | ||
1781 | </summary> | ||
1782 | <param name="instanceType"> | ||
1783 | Type defining the extension point | ||
1784 | </param> | ||
1785 | <returns> | ||
1786 | A list of nodes | ||
1787 | </returns> | ||
1788 | <remarks> | ||
1789 | This method returns all nodes registered for the provided type. | ||
1790 | It will throw a InvalidOperationException if the type of one of | ||
1791 | the registered nodes is not assignable to the specified node type argument. | ||
1792 | </remarks> | ||
1793 | </member> | ||
1794 | <member name="M:Mono.Addins.ExtensionContext.GetExtensionNodes(System.String,System.Type)"> | ||
1795 | <summary> | ||
1796 | Gets extension nodes registered in a path. | ||
1797 | </summary> | ||
1798 | <param name="path"> | ||
1799 | An extension path. | ||
1800 | </param> | ||
1801 | <param name="expectedNodeType"> | ||
1802 | Expected node type. | ||
1803 | </param> | ||
1804 | <returns> | ||
1805 | A list of nodes | ||
1806 | </returns> | ||
1807 | <remarks> | ||
1808 | This method returns all nodes registered under the provided path. | ||
1809 | It will throw a InvalidOperationException if the type of one of | ||
1810 | the registered nodes is not assignable to the provided type. | ||
1811 | </remarks> | ||
1812 | </member> | ||
1813 | <member name="M:Mono.Addins.ExtensionContext.GetExtensionObjects(System.Type)"> | ||
1814 | <summary> | ||
1815 | Gets extension objects registered for a type extension point. | ||
1816 | </summary> | ||
1817 | <param name="instanceType"> | ||
1818 | Type defining the extension point | ||
1819 | </param> | ||
1820 | <returns> | ||
1821 | A list of objects | ||
1822 | </returns> | ||
1823 | </member> | ||
1824 | <member name="M:Mono.Addins.ExtensionContext.GetExtensionObjects``1"> | ||
1825 | <summary> | ||
1826 | Gets extension objects registered for a type extension point. | ||
1827 | </summary> | ||
1828 | <returns> | ||
1829 | A list of objects | ||
1830 | </returns> | ||
1831 | <remarks> | ||
1832 | The type argument of this generic method is the type that defines | ||
1833 | the extension point. | ||
1834 | </remarks> | ||
1835 | </member> | ||
1836 | <member name="M:Mono.Addins.ExtensionContext.GetExtensionObjects(System.Type,System.Boolean)"> | ||
1837 | <summary> | ||
1838 | Gets extension objects registered for a type extension point. | ||
1839 | </summary> | ||
1840 | <param name="instanceType"> | ||
1841 | Type defining the extension point | ||
1842 | </param> | ||
1843 | <param name="reuseCachedInstance"> | ||
1844 | When set to True, it will return instances created in previous calls. | ||
1845 | </param> | ||
1846 | <returns> | ||
1847 | A list of extension objects. | ||
1848 | </returns> | ||
1849 | </member> | ||
1850 | <member name="M:Mono.Addins.ExtensionContext.GetExtensionObjects``1(System.Boolean)"> | ||
1851 | <summary> | ||
1852 | Gets extension objects registered for a type extension point. | ||
1853 | </summary> | ||
1854 | <param name="reuseCachedInstance"> | ||
1855 | When set to True, it will return instances created in previous calls. | ||
1856 | </param> | ||
1857 | <returns> | ||
1858 | A list of extension objects. | ||
1859 | </returns> | ||
1860 | <remarks> | ||
1861 | The type argument of this generic method is the type that defines | ||
1862 | the extension point. | ||
1863 | </remarks> | ||
1864 | </member> | ||
1865 | <member name="M:Mono.Addins.ExtensionContext.GetExtensionObjects(System.String)"> | ||
1866 | <summary> | ||
1867 | Gets extension objects registered in a path | ||
1868 | </summary> | ||
1869 | <param name="path"> | ||
1870 | An extension path. | ||
1871 | </param> | ||
1872 | <returns> | ||
1873 | An array of objects registered in the path. | ||
1874 | </returns> | ||
1875 | <remarks> | ||
1876 | This method can only be used if all nodes in the provided extension path | ||
1877 | are of type Mono.Addins.TypeExtensionNode. The returned array is composed | ||
1878 | by all objects created by calling the TypeExtensionNode.CreateInstance() | ||
1879 | method for each node. | ||
1880 | </remarks> | ||
1881 | </member> | ||
1882 | <member name="M:Mono.Addins.ExtensionContext.GetExtensionObjects(System.String,System.Boolean)"> | ||
1883 | <summary> | ||
1884 | Gets extension objects registered in a path. | ||
1885 | </summary> | ||
1886 | <param name="path"> | ||
1887 | An extension path. | ||
1888 | </param> | ||
1889 | <param name="reuseCachedInstance"> | ||
1890 | When set to True, it will return instances created in previous calls. | ||
1891 | </param> | ||
1892 | <returns> | ||
1893 | An array of objects registered in the path. | ||
1894 | </returns> | ||
1895 | <remarks> | ||
1896 | This method can only be used if all nodes in the provided extension path | ||
1897 | are of type Mono.Addins.TypeExtensionNode. The returned array is composed | ||
1898 | by all objects created by calling the TypeExtensionNode.CreateInstance() | ||
1899 | method for each node (or TypeExtensionNode.GetInstance() if | ||
1900 | reuseCachedInstance is set to true) | ||
1901 | </remarks> | ||
1902 | </member> | ||
1903 | <member name="M:Mono.Addins.ExtensionContext.GetExtensionObjects(System.String,System.Type)"> | ||
1904 | <summary> | ||
1905 | Gets extension objects registered in a path. | ||
1906 | </summary> | ||
1907 | <param name="path"> | ||
1908 | An extension path. | ||
1909 | </param> | ||
1910 | <param name="arrayElementType"> | ||
1911 | Type of the return array elements. | ||
1912 | </param> | ||
1913 | <returns> | ||
1914 | An array of objects registered in the path. | ||
1915 | </returns> | ||
1916 | <remarks> | ||
1917 | This method can only be used if all nodes in the provided extension path | ||
1918 | are of type Mono.Addins.TypeExtensionNode. The returned array is composed | ||
1919 | by all objects created by calling the TypeExtensionNode.CreateInstance() | ||
1920 | method for each node. | ||
1921 | |||
1922 | An InvalidOperationException exception is thrown if one of the found | ||
1923 | objects is not a subclass of the provided type. | ||
1924 | </remarks> | ||
1925 | </member> | ||
1926 | <member name="M:Mono.Addins.ExtensionContext.GetExtensionObjects``1(System.String)"> | ||
1927 | <summary> | ||
1928 | Gets extension objects registered in a path. | ||
1929 | </summary> | ||
1930 | <param name="path"> | ||
1931 | An extension path. | ||
1932 | </param> | ||
1933 | <returns> | ||
1934 | An array of objects registered in the path. | ||
1935 | </returns> | ||
1936 | <remarks> | ||
1937 | This method can only be used if all nodes in the provided extension path | ||
1938 | are of type Mono.Addins.TypeExtensionNode. The returned array is composed | ||
1939 | by all objects created by calling the TypeExtensionNode.CreateInstance() | ||
1940 | method for each node. | ||
1941 | |||
1942 | An InvalidOperationException exception is thrown if one of the found | ||
1943 | objects is not a subclass of the provided type. | ||
1944 | </remarks> | ||
1945 | </member> | ||
1946 | <member name="M:Mono.Addins.ExtensionContext.GetExtensionObjects``1(System.String,System.Boolean)"> | ||
1947 | <summary> | ||
1948 | Gets extension objects registered in a path. | ||
1949 | </summary> | ||
1950 | <param name="path"> | ||
1951 | An extension path. | ||
1952 | </param> | ||
1953 | <param name="reuseCachedInstance"> | ||
1954 | When set to True, it will return instances created in previous calls. | ||
1955 | </param> | ||
1956 | <returns> | ||
1957 | An array of objects registered in the path. | ||
1958 | </returns> | ||
1959 | <remarks> | ||
1960 | This method can only be used if all nodes in the provided extension path | ||
1961 | are of type Mono.Addins.TypeExtensionNode. The returned array is composed | ||
1962 | by all objects created by calling the TypeExtensionNode.CreateInstance() | ||
1963 | method for each node (or TypeExtensionNode.GetInstance() if | ||
1964 | reuseCachedInstance is set to true). | ||
1965 | |||
1966 | An InvalidOperationException exception is thrown if one of the found | ||
1967 | objects is not a subclass of the provided type. | ||
1968 | </remarks> | ||
1969 | </member> | ||
1970 | <member name="M:Mono.Addins.ExtensionContext.GetExtensionObjects(System.String,System.Type,System.Boolean)"> | ||
1971 | <summary> | ||
1972 | Gets extension objects registered in a path. | ||
1973 | </summary> | ||
1974 | <param name="path"> | ||
1975 | An extension path. | ||
1976 | </param> | ||
1977 | <param name="arrayElementType"> | ||
1978 | Type of the return array elements. | ||
1979 | </param> | ||
1980 | <param name="reuseCachedInstance"> | ||
1981 | When set to True, it will return instances created in previous calls. | ||
1982 | </param> | ||
1983 | <returns> | ||
1984 | An array of objects registered in the path. | ||
1985 | </returns> | ||
1986 | <remarks> | ||
1987 | This method can only be used if all nodes in the provided extension path | ||
1988 | are of type Mono.Addins.TypeExtensionNode. The returned array is composed | ||
1989 | by all objects created by calling the TypeExtensionNode.CreateInstance() | ||
1990 | method for each node (or TypeExtensionNode.GetInstance() if | ||
1991 | reuseCachedInstance is set to true). | ||
1992 | |||
1993 | An InvalidOperationException exception is thrown if one of the found | ||
1994 | objects is not a subclass of the provided type. | ||
1995 | </remarks> | ||
1996 | </member> | ||
1997 | <member name="M:Mono.Addins.ExtensionContext.AddExtensionNodeHandler(System.String,Mono.Addins.ExtensionNodeEventHandler)"> | ||
1998 | <summary> | ||
1999 | Register a listener of extension node changes. | ||
2000 | </summary> | ||
2001 | <param name="path"> | ||
2002 | Path of the node. | ||
2003 | </param> | ||
2004 | <param name="handler"> | ||
2005 | A handler method. | ||
2006 | </param> | ||
2007 | <remarks> | ||
2008 | Hosts can call this method to be subscribed to an extension change | ||
2009 | event for a specific path. The event will be fired once for every | ||
2010 | individual node change. The event arguments include the change type | ||
2011 | (Add or Remove) and the extension node added or removed. | ||
2012 | |||
2013 | NOTE: The handler will be called for all nodes existing in the path at the moment of registration. | ||
2014 | </remarks> | ||
2015 | </member> | ||
2016 | <member name="M:Mono.Addins.ExtensionContext.RemoveExtensionNodeHandler(System.String,Mono.Addins.ExtensionNodeEventHandler)"> | ||
2017 | <summary> | ||
2018 | Unregister a listener of extension node changes. | ||
2019 | </summary> | ||
2020 | <param name="path"> | ||
2021 | Path of the node. | ||
2022 | </param> | ||
2023 | <param name="handler"> | ||
2024 | A handler method. | ||
2025 | </param> | ||
2026 | <remarks> | ||
2027 | This method unregisters a delegate from the node change event of a path. | ||
2028 | </remarks> | ||
2029 | </member> | ||
2030 | <member name="M:Mono.Addins.ExtensionContext.AddExtensionNodeHandler(System.Type,Mono.Addins.ExtensionNodeEventHandler)"> | ||
2031 | <summary> | ||
2032 | Register a listener of extension node changes. | ||
2033 | </summary> | ||
2034 | <param name="instanceType"> | ||
2035 | Type defining the extension point | ||
2036 | </param> | ||
2037 | <param name="handler"> | ||
2038 | A handler method. | ||
2039 | </param> | ||
2040 | <remarks> | ||
2041 | Hosts can call this method to be subscribed to an extension change | ||
2042 | event for a specific type extension point. The event will be fired once for every | ||
2043 | individual node change. The event arguments include the change type | ||
2044 | (Add or Remove) and the extension node added or removed. | ||
2045 | |||
2046 | NOTE: The handler will be called for all nodes existing in the path at the moment of registration. | ||
2047 | </remarks> | ||
2048 | </member> | ||
2049 | <member name="M:Mono.Addins.ExtensionContext.RemoveExtensionNodeHandler(System.Type,Mono.Addins.ExtensionNodeEventHandler)"> | ||
2050 | <summary> | ||
2051 | Unregister a listener of extension node changes. | ||
2052 | </summary> | ||
2053 | <param name="instanceType"> | ||
2054 | Type defining the extension point | ||
2055 | </param> | ||
2056 | <param name="handler"> | ||
2057 | A handler method. | ||
2058 | </param> | ||
2059 | </member> | ||
2060 | <member name="E:Mono.Addins.ExtensionContext.ExtensionChanged"> | ||
2061 | <summary> | ||
2062 | Extension change event. | ||
2063 | </summary> | ||
2064 | <remarks> | ||
2065 | This event is fired when any extension point in the add-in system changes. | ||
2066 | The event args object provides the path of the changed extension, although | ||
2067 | it does not provide information about what changed. Hosts subscribing to | ||
2068 | this event should get the new list of nodes using a query method such as | ||
2069 | AddinManager.GetExtensionNodes() and then update whatever needs to be updated. | ||
2070 | </remarks> | ||
2071 | </member> | ||
2072 | <member name="M:Mono.Addins.AddinEngine.#ctor"> | ||
2073 | <summary> | ||
2074 | Initializes a new instance of the <see cref="T:Mono.Addins.AddinEngine"/> class. | ||
2075 | </summary> | ||
2076 | </member> | ||
2077 | <member name="M:Mono.Addins.AddinEngine.Initialize(System.String)"> | ||
2078 | <summary> | ||
2079 | Initializes the add-in engine | ||
2080 | </summary> | ||
2081 | <param name="configDir"> | ||
2082 | Location of the add-in registry. | ||
2083 | </param> | ||
2084 | <remarks>The add-in engine needs to be initialized before doing any add-in operation. | ||
2085 | When initialized with this method, it will look for add-in in the add-in registry | ||
2086 | located in the specified path. | ||
2087 | </remarks> | ||
2088 | </member> | ||
2089 | <member name="M:Mono.Addins.AddinEngine.Initialize(System.String,System.String)"> | ||
2090 | <summary> | ||
2091 | Initializes the add-in engine. | ||
2092 | </summary> | ||
2093 | <param name='configDir'> | ||
2094 | Location of the add-in registry. | ||
2095 | </param> | ||
2096 | <param name='addinsDir'> | ||
2097 | Add-ins directory. If the path is relative, it is considered to be relative | ||
2098 | to the configDir directory. | ||
2099 | </param> | ||
2100 | <remarks> | ||
2101 | The add-in engine needs to be initialized before doing any add-in operation. | ||
2102 | Configuration information about the add-in registry will be stored in the | ||
2103 | provided location. The add-in engine will look for add-ins in the provided | ||
2104 | 'addinsDir' directory. | ||
2105 | |||
2106 | When specifying a path, it is possible to use a special folder name as root. | ||
2107 | For example: [Personal]/.config/MyApp. In this case, [Personal] will be replaced | ||
2108 | by the location of the Environment.SpecialFolder.Personal folder. Any value | ||
2109 | of the Environment.SpecialFolder enumeration can be used (always between square | ||
2110 | brackets) | ||
2111 | </remarks> | ||
2112 | </member> | ||
2113 | <member name="M:Mono.Addins.AddinEngine.Initialize(System.String,System.String,System.String)"> | ||
2114 | <summary> | ||
2115 | Initializes the add-in engine. | ||
2116 | </summary> | ||
2117 | <param name='configDir'> | ||
2118 | Location of the add-in registry. | ||
2119 | </param> | ||
2120 | <param name='addinsDir'> | ||
2121 | Add-ins directory. If the path is relative, it is considered to be relative | ||
2122 | to the configDir directory. | ||
2123 | </param> | ||
2124 | <param name='databaseDir'> | ||
2125 | Location of the add-in database. If the path is relative, it is considered to be relative | ||
2126 | to the configDir directory. | ||
2127 | </param> | ||
2128 | <remarks> | ||
2129 | The add-in engine needs to be initialized before doing any add-in operation. | ||
2130 | Configuration information about the add-in registry will be stored in the | ||
2131 | provided location. The add-in engine will look for add-ins in the provided | ||
2132 | 'addinsDir' directory. Cached information about add-ins will be stored in | ||
2133 | the 'databaseDir' directory. | ||
2134 | |||
2135 | When specifying a path, it is possible to use a special folder name as root. | ||
2136 | For example: [Personal]/.config/MyApp. In this case, [Personal] will be replaced | ||
2137 | by the location of the Environment.SpecialFolder.Personal folder. Any value | ||
2138 | of the Environment.SpecialFolder enumeration can be used (always between square | ||
2139 | brackets) | ||
2140 | </remarks> | ||
2141 | </member> | ||
2142 | <member name="M:Mono.Addins.AddinEngine.Shutdown"> | ||
2143 | <summary> | ||
2144 | Finalizes the add-in engine. | ||
2145 | </summary> | ||
2146 | </member> | ||
2147 | <member name="M:Mono.Addins.AddinEngine.InitializeDefaultLocalizer(Mono.Addins.Localization.IAddinLocalizer)"> | ||
2148 | <summary> | ||
2149 | Sets the default localizer to be used for this add-in engine | ||
2150 | </summary> | ||
2151 | <param name="localizer"> | ||
2152 | The add-in localizer | ||
2153 | </param> | ||
2154 | </member> | ||
2155 | <member name="M:Mono.Addins.AddinEngine.CheckInstalled(System.String,System.String[])"> | ||
2156 | <summary> | ||
2157 | Checks if the provided add-ins are installed, and requests the installation of those | ||
2158 | which aren't. | ||
2159 | </summary> | ||
2160 | <param name="message"> | ||
2161 | Message to show to the user when new add-ins have to be installed. | ||
2162 | </param> | ||
2163 | <param name="addinIds"> | ||
2164 | List of IDs of the add-ins to be checked. | ||
2165 | </param> | ||
2166 | <remarks> | ||
2167 | This method checks if the specified add-ins are installed. | ||
2168 | If some of the add-ins are not installed, it will use | ||
2169 | the installer assigned to the DefaultAddinInstaller property | ||
2170 | to install them. If the installation fails, or if DefaultAddinInstaller | ||
2171 | is not set, an exception will be thrown. | ||
2172 | </remarks> | ||
2173 | </member> | ||
2174 | <member name="M:Mono.Addins.AddinEngine.IsAddinLoaded(System.String)"> | ||
2175 | <summary> | ||
2176 | Checks if an add-in has been loaded. | ||
2177 | </summary> | ||
2178 | <param name="id"> | ||
2179 | Full identifier of the add-in. | ||
2180 | </param> | ||
2181 | <returns> | ||
2182 | True if the add-in is loaded. | ||
2183 | </returns> | ||
2184 | </member> | ||
2185 | <member name="M:Mono.Addins.AddinEngine.LoadAddin(Mono.Addins.IProgressStatus,System.String)"> | ||
2186 | <summary> | ||
2187 | Forces the loading of an add-in. | ||
2188 | </summary> | ||
2189 | <param name="statusMonitor"> | ||
2190 | Status monitor to keep track of the loading process. | ||
2191 | </param> | ||
2192 | <param name="id"> | ||
2193 | Full identifier of the add-in to load. | ||
2194 | </param> | ||
2195 | <remarks> | ||
2196 | This method loads all assemblies that belong to an add-in in memory. | ||
2197 | All add-ins on which the specified add-in depends will also be loaded. | ||
2198 | Notice that in general add-ins don't need to be explicitely loaded using | ||
2199 | this method, since the add-in engine will load them on demand. | ||
2200 | </remarks> | ||
2201 | </member> | ||
2202 | <member name="M:Mono.Addins.AddinEngine.CreateExtensionContext"> | ||
2203 | <summary> | ||
2204 | Creates a new extension context. | ||
2205 | </summary> | ||
2206 | <returns> | ||
2207 | The new extension context. | ||
2208 | </returns> | ||
2209 | <remarks> | ||
2210 | Extension contexts can be used to query the extension model using particular condition values. | ||
2211 | </remarks> | ||
2212 | </member> | ||
2213 | <member name="E:Mono.Addins.AddinEngine.AddinLoadError"> | ||
2214 | <summary> | ||
2215 | Raised when there is an error while loading an add-in | ||
2216 | </summary> | ||
2217 | </member> | ||
2218 | <member name="E:Mono.Addins.AddinEngine.AddinLoaded"> | ||
2219 | <summary> | ||
2220 | Raised when an add-in is loaded | ||
2221 | </summary> | ||
2222 | </member> | ||
2223 | <member name="E:Mono.Addins.AddinEngine.AddinUnloaded"> | ||
2224 | <summary> | ||
2225 | Raised when an add-in is unloaded | ||
2226 | </summary> | ||
2227 | </member> | ||
2228 | <member name="P:Mono.Addins.AddinEngine.IsInitialized"> | ||
2229 | <summary> | ||
2230 | Gets whether the add-in engine has been initialized. | ||
2231 | </summary> | ||
2232 | </member> | ||
2233 | <member name="P:Mono.Addins.AddinEngine.DefaultInstaller"> | ||
2234 | <summary> | ||
2235 | Gets the default add-in installer | ||
2236 | </summary> | ||
2237 | <remarks> | ||
2238 | The default installer is used by the CheckInstalled method to request | ||
2239 | the installation of missing add-ins. | ||
2240 | </remarks> | ||
2241 | </member> | ||
2242 | <member name="P:Mono.Addins.AddinEngine.DefaultLocalizer"> | ||
2243 | <summary> | ||
2244 | Gets the default localizer for this add-in engine | ||
2245 | </summary> | ||
2246 | </member> | ||
2247 | <member name="P:Mono.Addins.AddinEngine.CurrentLocalizer"> | ||
2248 | <summary> | ||
2249 | Gets the localizer for the add-in that is invoking this property | ||
2250 | </summary> | ||
2251 | </member> | ||
2252 | <member name="P:Mono.Addins.AddinEngine.CurrentAddin"> | ||
2253 | <summary> | ||
2254 | Gets a reference to the RuntimeAddin object for the add-in that is invoking this property | ||
2255 | </summary> | ||
2256 | </member> | ||
2257 | <member name="P:Mono.Addins.AddinEngine.Registry"> | ||
2258 | <summary> | ||
2259 | Gets the add-in registry bound to this add-in engine | ||
2260 | </summary> | ||
2261 | </member> | ||
2262 | <member name="T:Mono.Addins.Database.IAssemblyReflector"> | ||
2263 | <summary> | ||
2264 | An assembly reflector | ||
2265 | </summary> | ||
2266 | <remarks> | ||
2267 | This interface can be implemented to provide a custom method for getting information about assemblies. | ||
2268 | </remarks> | ||
2269 | </member> | ||
2270 | <member name="M:Mono.Addins.Database.IAssemblyReflector.Initialize(Mono.Addins.Database.IAssemblyLocator)"> | ||
2271 | <summary> | ||
2272 | Called to initialize the assembly reflector | ||
2273 | </summary> | ||
2274 | <param name='locator'> | ||
2275 | IAssemblyLocator instance which can be used to locate referenced assemblies. | ||
2276 | </param> | ||
2277 | </member> | ||
2278 | <member name="M:Mono.Addins.Database.IAssemblyReflector.GetCustomAttributes(System.Object,System.Type,System.Boolean)"> | ||
2279 | <summary> | ||
2280 | Gets a list of custom attributes | ||
2281 | </summary> | ||
2282 | <returns> | ||
2283 | The custom attributes. | ||
2284 | </returns> | ||
2285 | <param name='obj'> | ||
2286 | An assembly, class or class member | ||
2287 | </param> | ||
2288 | <param name='type'> | ||
2289 | Type of the attribute to be returned. It will always be one of the attribute types | ||
2290 | defined in Mono.Addins. | ||
2291 | </param> | ||
2292 | <param name='inherit'> | ||
2293 | 'true' if inherited attributes must be returned | ||
2294 | </param> | ||
2295 | </member> | ||
2296 | <member name="M:Mono.Addins.Database.IAssemblyReflector.GetRawCustomAttributes(System.Object,System.Type,System.Boolean)"> | ||
2297 | <summary> | ||
2298 | Gets a list of custom attributes | ||
2299 | </summary> | ||
2300 | <returns> | ||
2301 | The attributes. | ||
2302 | </returns> | ||
2303 | <param name='obj'> | ||
2304 | An assembly, class or class member | ||
2305 | </param> | ||
2306 | <param name='type'> | ||
2307 | Base type of the attribute to be returned | ||
2308 | </param> | ||
2309 | <param name='inherit'> | ||
2310 | 'true' if inherited attributes must be returned | ||
2311 | </param> | ||
2312 | </member> | ||
2313 | <member name="M:Mono.Addins.Database.IAssemblyReflector.LoadAssembly(System.String)"> | ||
2314 | <summary> | ||
2315 | Loads an assembly. | ||
2316 | </summary> | ||
2317 | <returns> | ||
2318 | The loaded assembly | ||
2319 | </returns> | ||
2320 | <param name='file'> | ||
2321 | Path of the assembly. | ||
2322 | </param> | ||
2323 | </member> | ||
2324 | <member name="M:Mono.Addins.Database.IAssemblyReflector.LoadAssemblyFromReference(System.Object)"> | ||
2325 | <summary> | ||
2326 | Loads the assembly specified in an assembly reference | ||
2327 | </summary> | ||
2328 | <returns> | ||
2329 | The assembly | ||
2330 | </returns> | ||
2331 | <param name='asmReference'> | ||
2332 | An assembly reference | ||
2333 | </param> | ||
2334 | </member> | ||
2335 | <member name="M:Mono.Addins.Database.IAssemblyReflector.GetResourceNames(System.Object)"> | ||
2336 | <summary> | ||
2337 | Gets the names of all resources embedded in an assembly | ||
2338 | </summary> | ||
2339 | <returns> | ||
2340 | The names of the resources | ||
2341 | </returns> | ||
2342 | <param name='asm'> | ||
2343 | An assembly | ||
2344 | </param> | ||
2345 | </member> | ||
2346 | <member name="M:Mono.Addins.Database.IAssemblyReflector.GetResourceStream(System.Object,System.String)"> | ||
2347 | <summary> | ||
2348 | Gets the data stream of a resource | ||
2349 | </summary> | ||
2350 | <returns> | ||
2351 | The stream. | ||
2352 | </returns> | ||
2353 | <param name='asm'> | ||
2354 | An assembly | ||
2355 | </param> | ||
2356 | <param name='resourceName'> | ||
2357 | The name of a resource | ||
2358 | </param> | ||
2359 | </member> | ||
2360 | <member name="M:Mono.Addins.Database.IAssemblyReflector.GetAssemblyTypes(System.Object)"> | ||
2361 | <summary> | ||
2362 | Gets all types defined in an assembly | ||
2363 | </summary> | ||
2364 | <returns> | ||
2365 | The types | ||
2366 | </returns> | ||
2367 | <param name='asm'> | ||
2368 | An assembly | ||
2369 | </param> | ||
2370 | </member> | ||
2371 | <member name="M:Mono.Addins.Database.IAssemblyReflector.GetAssemblyReferences(System.Object)"> | ||
2372 | <summary> | ||
2373 | Gets all assembly references of an assembly | ||
2374 | </summary> | ||
2375 | <returns> | ||
2376 | A list of assembly references | ||
2377 | </returns> | ||
2378 | <param name='asm'> | ||
2379 | An assembly | ||
2380 | </param> | ||
2381 | </member> | ||
2382 | <member name="M:Mono.Addins.Database.IAssemblyReflector.GetType(System.Object,System.String)"> | ||
2383 | <summary> | ||
2384 | Looks for a type in an assembly | ||
2385 | </summary> | ||
2386 | <returns> | ||
2387 | The type. | ||
2388 | </returns> | ||
2389 | <param name='asm'> | ||
2390 | An assembly | ||
2391 | </param> | ||
2392 | <param name='typeName'> | ||
2393 | Name of the type | ||
2394 | </param> | ||
2395 | </member> | ||
2396 | <member name="M:Mono.Addins.Database.IAssemblyReflector.GetCustomAttribute(System.Object,System.Type,System.Boolean)"> | ||
2397 | <summary> | ||
2398 | Gets a custom attribute | ||
2399 | </summary> | ||
2400 | <returns> | ||
2401 | The custom attribute. | ||
2402 | </returns> | ||
2403 | <param name='obj'> | ||
2404 | An assembly, class or class member | ||
2405 | </param> | ||
2406 | <param name='type'> | ||
2407 | Base type of the attribute to be returned. It will always be one of the attribute types | ||
2408 | defined in Mono.Addins. | ||
2409 | </param> | ||
2410 | <param name='inherit'> | ||
2411 | 'true' if inherited attributes must be returned | ||
2412 | </param> | ||
2413 | </member> | ||
2414 | <member name="M:Mono.Addins.Database.IAssemblyReflector.GetTypeName(System.Object)"> | ||
2415 | <summary> | ||
2416 | Gets the name of a type (not including namespace) | ||
2417 | </summary> | ||
2418 | <returns> | ||
2419 | The type name. | ||
2420 | </returns> | ||
2421 | <param name='type'> | ||
2422 | A type | ||
2423 | </param> | ||
2424 | </member> | ||
2425 | <member name="M:Mono.Addins.Database.IAssemblyReflector.GetTypeFullName(System.Object)"> | ||
2426 | <summary> | ||
2427 | Gets the full name of a type (including namespace) | ||
2428 | </summary> | ||
2429 | <returns> | ||
2430 | The full name of the type | ||
2431 | </returns> | ||
2432 | <param name='type'> | ||
2433 | A type | ||
2434 | </param> | ||
2435 | </member> | ||
2436 | <member name="M:Mono.Addins.Database.IAssemblyReflector.GetTypeAssemblyQualifiedName(System.Object)"> | ||
2437 | <summary> | ||
2438 | Gets the assembly qualified name of a type | ||
2439 | </summary> | ||
2440 | <returns> | ||
2441 | The assembly qualified type name | ||
2442 | </returns> | ||
2443 | <param name='type'> | ||
2444 | A type | ||
2445 | </param> | ||
2446 | </member> | ||
2447 | <member name="M:Mono.Addins.Database.IAssemblyReflector.GetBaseTypeFullNameList(System.Object)"> | ||
2448 | <summary> | ||
2449 | Gets a list of all base types (including interfaces) of a type | ||
2450 | </summary> | ||
2451 | <returns> | ||
2452 | An enumeration of the full name of all base types of the type | ||
2453 | </returns> | ||
2454 | <param name='type'> | ||
2455 | A type | ||
2456 | </param> | ||
2457 | </member> | ||
2458 | <member name="M:Mono.Addins.Database.IAssemblyReflector.TypeIsAssignableFrom(System.Object,System.Object)"> | ||
2459 | <summary> | ||
2460 | Checks if a type is assignable to another type | ||
2461 | </summary> | ||
2462 | <returns> | ||
2463 | 'true' if the type is assignable | ||
2464 | </returns> | ||
2465 | <param name='baseType'> | ||
2466 | Expected base type. | ||
2467 | </param> | ||
2468 | <param name='type'> | ||
2469 | A type. | ||
2470 | </param> | ||
2471 | </member> | ||
2472 | <member name="M:Mono.Addins.Database.IAssemblyReflector.GetFields(System.Object)"> | ||
2473 | <summary> | ||
2474 | Gets the fields of a type | ||
2475 | </summary> | ||
2476 | <returns> | ||
2477 | The fields. | ||
2478 | </returns> | ||
2479 | <param name='type'> | ||
2480 | A type | ||
2481 | </param> | ||
2482 | </member> | ||
2483 | <member name="M:Mono.Addins.Database.IAssemblyReflector.GetFieldName(System.Object)"> | ||
2484 | <summary> | ||
2485 | Gets the name of a field. | ||
2486 | </summary> | ||
2487 | <returns> | ||
2488 | The field name. | ||
2489 | </returns> | ||
2490 | <param name='field'> | ||
2491 | A field. | ||
2492 | </param> | ||
2493 | </member> | ||
2494 | <member name="M:Mono.Addins.Database.IAssemblyReflector.GetFieldTypeFullName(System.Object)"> | ||
2495 | <summary> | ||
2496 | Gets the full name of the type of a field | ||
2497 | </summary> | ||
2498 | <returns> | ||
2499 | The full type name | ||
2500 | </returns> | ||
2501 | <param name='field'> | ||
2502 | A field. | ||
2503 | </param> | ||
2504 | </member> | ||
2505 | <member name="T:Mono.Addins.Database.CustomAttribute"> | ||
2506 | <summary> | ||
2507 | A custom attribute | ||
2508 | </summary> | ||
2509 | </member> | ||
2510 | <member name="P:Mono.Addins.Database.CustomAttribute.TypeName"> | ||
2511 | <summary> | ||
2512 | Full name of the type of the custom attribute | ||
2513 | </summary> | ||
2514 | </member> | ||
2515 | <member name="T:Mono.Addins.TypeExtensionPointAttribute"> | ||
2516 | <summary> | ||
2517 | Declares an extension point bound to a type | ||
2518 | </summary> | ||
2519 | </member> | ||
2520 | <member name="M:Mono.Addins.TypeExtensionPointAttribute.#ctor"> | ||
2521 | <summary> | ||
2522 | Initializes a new instance | ||
2523 | </summary> | ||
2524 | </member> | ||
2525 | <member name="M:Mono.Addins.TypeExtensionPointAttribute.#ctor(System.String)"> | ||
2526 | <summary> | ||
2527 | Initializes a new instance | ||
2528 | </summary> | ||
2529 | <param name="path"> | ||
2530 | Path that identifies the extension point | ||
2531 | </param> | ||
2532 | </member> | ||
2533 | <member name="P:Mono.Addins.TypeExtensionPointAttribute.Path"> | ||
2534 | <summary> | ||
2535 | Path that identifies the extension point | ||
2536 | </summary> | ||
2537 | </member> | ||
2538 | <member name="P:Mono.Addins.TypeExtensionPointAttribute.Description"> | ||
2539 | <summary> | ||
2540 | Description of the extension point. | ||
2541 | </summary> | ||
2542 | </member> | ||
2543 | <member name="P:Mono.Addins.TypeExtensionPointAttribute.NodeName"> | ||
2544 | <summary> | ||
2545 | Element name to be used when defining an extension in an XML manifest. The default name is "Type". | ||
2546 | </summary> | ||
2547 | </member> | ||
2548 | <member name="P:Mono.Addins.TypeExtensionPointAttribute.Name"> | ||
2549 | <summary> | ||
2550 | Display name of the extension point. | ||
2551 | </summary> | ||
2552 | </member> | ||
2553 | <member name="P:Mono.Addins.TypeExtensionPointAttribute.NodeType"> | ||
2554 | <summary> | ||
2555 | Type of the extension node to be created for extensions | ||
2556 | </summary> | ||
2557 | </member> | ||
2558 | <member name="P:Mono.Addins.TypeExtensionPointAttribute.ExtensionAttributeType"> | ||
2559 | <summary> | ||
2560 | Type of the custom attribute to be used to specify metadata for the extension point | ||
2561 | </summary> | ||
2562 | </member> | ||
2563 | <member name="T:Mono.Addins.Description.AddinFlags"> | ||
2564 | <summary> | ||
2565 | Add-in flags | ||
2566 | </summary> | ||
2567 | </member> | ||
2568 | <member name="F:Mono.Addins.Description.AddinFlags.None"> | ||
2569 | <summary> | ||
2570 | No flags | ||
2571 | </summary> | ||
2572 | </member> | ||
2573 | <member name="F:Mono.Addins.Description.AddinFlags.CantUninstall"> | ||
2574 | <summary> | ||
2575 | The add-in can't be uninstalled | ||
2576 | </summary> | ||
2577 | </member> | ||
2578 | <member name="F:Mono.Addins.Description.AddinFlags.CantDisable"> | ||
2579 | <summary> | ||
2580 | The add-in can't be disabled | ||
2581 | </summary> | ||
2582 | </member> | ||
2583 | <member name="F:Mono.Addins.Description.AddinFlags.Hidden"> | ||
2584 | <summary> | ||
2585 | The add-in is not visible to end users | ||
2586 | </summary> | ||
2587 | </member> | ||
2588 | <member name="T:Mono.Addins.Description.ExtensionCollection"> | ||
2589 | <summary> | ||
2590 | A collection of extensions | ||
2591 | </summary> | ||
2592 | </member> | ||
2593 | <member name="M:Mono.Addins.Description.ExtensionCollection.#ctor"> | ||
2594 | <summary> | ||
2595 | Initializes a new instance of the <see cref="T:Mono.Addins.Description.ExtensionCollection"/> class. | ||
2596 | </summary> | ||
2597 | </member> | ||
2598 | <member name="P:Mono.Addins.Description.ExtensionCollection.Item(System.Int32)"> | ||
2599 | <summary> | ||
2600 | Gets the <see cref="T:Mono.Addins.Description.Extension"/> at the specified index. | ||
2601 | </summary> | ||
2602 | <param name="n"> | ||
2603 | The index. | ||
2604 | </param> | ||
2605 | </member> | ||
2606 | <member name="T:Mono.Addins.InstanceExtensionNode"> | ||
2607 | <summary> | ||
2608 | Base class for extension nodes which create extension objects | ||
2609 | </summary> | ||
2610 | </member> | ||
2611 | <member name="T:Mono.Addins.ExtensionNode"> | ||
2612 | <summary> | ||
2613 | A node of the extension model. | ||
2614 | </summary> | ||
2615 | <remarks> | ||
2616 | An extension node is an element registered by an add-in in an extension point. | ||
2617 | A host can get nodes registered in an extension point using methods such as | ||
2618 | AddinManager.GetExtensionNodes(string), which returns a collection of ExtensionNode objects. | ||
2619 | |||
2620 | ExtensionNode will normally be used as a base class of more complex extension point types. | ||
2621 | The most common subclass is Mono.Addins.TypeExtensionNode, which allows registering a class | ||
2622 | implemented in an add-in. | ||
2623 | </remarks> | ||
2624 | </member> | ||
2625 | <member name="M:Mono.Addins.ExtensionNode.GetChildObjects"> | ||
2626 | <summary> | ||
2627 | Returns the child objects of a node. | ||
2628 | </summary> | ||
2629 | <returns> | ||
2630 | An array of child objects. | ||
2631 | </returns> | ||
2632 | <remarks> | ||
2633 | This method only works if all children of this node are of type Mono.Addins.TypeExtensionNode. | ||
2634 | The returned array is composed by all objects created by calling the | ||
2635 | TypeExtensionNode.GetInstance() method for each node. | ||
2636 | </remarks> | ||
2637 | </member> | ||
2638 | <member name="M:Mono.Addins.ExtensionNode.GetChildObjects(System.Boolean)"> | ||
2639 | <summary> | ||
2640 | Returns the child objects of a node. | ||
2641 | </summary> | ||
2642 | <param name="reuseCachedInstance"> | ||
2643 | True if the method can reuse instances created in previous calls. | ||
2644 | </param> | ||
2645 | <returns> | ||
2646 | An array of child objects. | ||
2647 | </returns> | ||
2648 | <remarks> | ||
2649 | This method only works if all children of this node are of type Mono.Addins.TypeExtensionNode. | ||
2650 | The returned array is composed by all objects created by calling the TypeExtensionNode.CreateInstance() | ||
2651 | method for each node (or TypeExtensionNode.GetInstance() if reuseCachedInstance is set to true). | ||
2652 | </remarks> | ||
2653 | </member> | ||
2654 | <member name="M:Mono.Addins.ExtensionNode.GetChildObjects(System.Type)"> | ||
2655 | <summary> | ||
2656 | Returns the child objects of a node (with type check). | ||
2657 | </summary> | ||
2658 | <param name="arrayElementType"> | ||
2659 | Type of the return array elements. | ||
2660 | </param> | ||
2661 | <returns> | ||
2662 | An array of child objects. | ||
2663 | </returns> | ||
2664 | <remarks> | ||
2665 | This method only works if all children of this node are of type Mono.Addins.TypeExtensionNode. | ||
2666 | The returned array is composed by all objects created by calling the | ||
2667 | TypeExtensionNode.GetInstance(Type) method for each node. | ||
2668 | |||
2669 | An InvalidOperationException exception is thrown if one of the found child objects is not a | ||
2670 | subclass of the provided type. | ||
2671 | </remarks> | ||
2672 | </member> | ||
2673 | <member name="M:Mono.Addins.ExtensionNode.GetChildObjects``1"> | ||
2674 | <summary> | ||
2675 | Returns the child objects of a node (casting to the specified type) | ||
2676 | </summary> | ||
2677 | <returns> | ||
2678 | An array of child objects. | ||
2679 | </returns> | ||
2680 | <remarks> | ||
2681 | This method only works if all children of this node are of type Mono.Addins.TypeExtensionNode. | ||
2682 | The returned array is composed by all objects created by calling the | ||
2683 | TypeExtensionNode.GetInstance() method for each node. | ||
2684 | </remarks> | ||
2685 | </member> | ||
2686 | <member name="M:Mono.Addins.ExtensionNode.GetChildObjects(System.Type,System.Boolean)"> | ||
2687 | <summary> | ||
2688 | Returns the child objects of a node (with type check). | ||
2689 | </summary> | ||
2690 | <param name="arrayElementType"> | ||
2691 | Type of the return array elements. | ||
2692 | </param> | ||
2693 | <param name="reuseCachedInstance"> | ||
2694 | True if the method can reuse instances created in previous calls. | ||
2695 | </param> | ||
2696 | <returns> | ||
2697 | An array of child objects. | ||
2698 | </returns> | ||
2699 | <remarks> | ||
2700 | This method only works if all children of this node are of type Mono.Addins.TypeExtensionNode. | ||
2701 | The returned array is composed by all objects created by calling the TypeExtensionNode.CreateInstance(Type) | ||
2702 | method for each node (or TypeExtensionNode.GetInstance(Type) if reuseCachedInstance is set to true). | ||
2703 | |||
2704 | An InvalidOperationException exception will be thrown if one of the found child objects is not a subclass | ||
2705 | of the provided type. | ||
2706 | </remarks> | ||
2707 | </member> | ||
2708 | <member name="M:Mono.Addins.ExtensionNode.GetChildObjects``1(System.Boolean)"> | ||
2709 | <summary> | ||
2710 | Returns the child objects of a node (casting to the specified type). | ||
2711 | </summary> | ||
2712 | <param name="reuseCachedInstance"> | ||
2713 | True if the method can reuse instances created in previous calls. | ||
2714 | </param> | ||
2715 | <returns> | ||
2716 | An array of child objects. | ||
2717 | </returns> | ||
2718 | <remarks> | ||
2719 | This method only works if all children of this node are of type Mono.Addins.TypeExtensionNode. | ||
2720 | The returned array is composed by all objects created by calling the TypeExtensionNode.CreateInstance() | ||
2721 | method for each node (or TypeExtensionNode.GetInstance() if reuseCachedInstance is set to true). | ||
2722 | </remarks> | ||
2723 | </member> | ||
2724 | <member name="M:Mono.Addins.ExtensionNode.Read(Mono.Addins.NodeElement)"> | ||
2725 | <summary> | ||
2726 | Reads the extension node data | ||
2727 | </summary> | ||
2728 | <param name='elem'> | ||
2729 | The element containing the extension data | ||
2730 | </param> | ||
2731 | <remarks> | ||
2732 | This method can be overriden to provide a custom method for reading extension node data from an element. | ||
2733 | The default implementation reads the attributes if the element and assigns the values to the fields | ||
2734 | and properties of the extension node that have the corresponding [NodeAttribute] decoration. | ||
2735 | </remarks> | ||
2736 | </member> | ||
2737 | <member name="M:Mono.Addins.ExtensionNode.OnAddinLoaded"> | ||
2738 | <summary> | ||
2739 | Called when the add-in that defined this extension node is actually loaded in memory. | ||
2740 | </summary> | ||
2741 | </member> | ||
2742 | <member name="M:Mono.Addins.ExtensionNode.OnAddinUnloaded"> | ||
2743 | <summary> | ||
2744 | Called when the add-in that defined this extension node is being | ||
2745 | unloaded from memory. | ||
2746 | </summary> | ||
2747 | </member> | ||
2748 | <member name="M:Mono.Addins.ExtensionNode.OnChildrenChanged"> | ||
2749 | <summary> | ||
2750 | Called when the children list of this node has changed. It may be due to add-ins | ||
2751 | being loaded/unloaded, or to conditions being changed. | ||
2752 | </summary> | ||
2753 | </member> | ||
2754 | <member name="M:Mono.Addins.ExtensionNode.OnChildNodeAdded(Mono.Addins.ExtensionNode)"> | ||
2755 | <summary> | ||
2756 | Called when a child node is added | ||
2757 | </summary> | ||
2758 | <param name="node"> | ||
2759 | Added node. | ||
2760 | </param> | ||
2761 | </member> | ||
2762 | <member name="M:Mono.Addins.ExtensionNode.OnChildNodeRemoved(Mono.Addins.ExtensionNode)"> | ||
2763 | <summary> | ||
2764 | Called when a child node is removed | ||
2765 | </summary> | ||
2766 | <param name="node"> | ||
2767 | Removed node. | ||
2768 | </param> | ||
2769 | </member> | ||
2770 | <member name="P:Mono.Addins.ExtensionNode.Id"> | ||
2771 | <summary> | ||
2772 | Identifier of the node. | ||
2773 | </summary> | ||
2774 | <remarks> | ||
2775 | It is not mandatory to specify an 'id' for a node. When none is provided, | ||
2776 | the add-in manager will automatically generate an unique id for the node. | ||
2777 | The ExtensionNode.HasId property can be used to know if the 'id' has been | ||
2778 | specified by the developer or not. | ||
2779 | </remarks> | ||
2780 | </member> | ||
2781 | <member name="P:Mono.Addins.ExtensionNode.Path"> | ||
2782 | <summary> | ||
2783 | Location of this node in the extension tree. | ||
2784 | </summary> | ||
2785 | <remarks> | ||
2786 | The node path is composed by the path of the extension point where it is defined, | ||
2787 | the identifiers of its parent nodes, and its own identifier. | ||
2788 | </remarks> | ||
2789 | </member> | ||
2790 | <member name="P:Mono.Addins.ExtensionNode.Parent"> | ||
2791 | <summary> | ||
2792 | Parent node of this node. | ||
2793 | </summary> | ||
2794 | </member> | ||
2795 | <member name="P:Mono.Addins.ExtensionNode.ExtensionContext"> | ||
2796 | <summary> | ||
2797 | Extension context to which this node belongs | ||
2798 | </summary> | ||
2799 | </member> | ||
2800 | <member name="P:Mono.Addins.ExtensionNode.HasId"> | ||
2801 | <summary> | ||
2802 | Specifies whether the extension node has as an Id or not. | ||
2803 | </summary> | ||
2804 | <remarks> | ||
2805 | It is not mandatory to specify an 'id' for a node. When none is provided, | ||
2806 | the add-in manager will automatically generate an unique id for the node. | ||
2807 | This property will return true if an 'id' was provided for the node, and | ||
2808 | false if the id was assigned by the add-in manager. | ||
2809 | </remarks> | ||
2810 | </member> | ||
2811 | <member name="P:Mono.Addins.ExtensionNode.Addin"> | ||
2812 | <summary> | ||
2813 | The add-in that registered this extension node. | ||
2814 | </summary> | ||
2815 | <remarks> | ||
2816 | This property provides access to the resources and types of the add-in that created this extension node. | ||
2817 | </remarks> | ||
2818 | </member> | ||
2819 | <member name="E:Mono.Addins.ExtensionNode.ExtensionNodeChanged"> | ||
2820 | <summary> | ||
2821 | Notifies that a child node of this node has been added or removed. | ||
2822 | </summary> | ||
2823 | <remarks> | ||
2824 | The first time the event is subscribed, the handler will be called for each existing node. | ||
2825 | </remarks> | ||
2826 | </member> | ||
2827 | <member name="P:Mono.Addins.ExtensionNode.ChildNodes"> | ||
2828 | <summary> | ||
2829 | Child nodes of this extension node. | ||
2830 | </summary> | ||
2831 | </member> | ||
2832 | <member name="M:Mono.Addins.InstanceExtensionNode.GetInstance(System.Type)"> | ||
2833 | <summary> | ||
2834 | Gets the extension object declared by this node | ||
2835 | </summary> | ||
2836 | <param name="expectedType"> | ||
2837 | Expected object type. An exception will be thrown if the object is not an instance of the specified type. | ||
2838 | </param> | ||
2839 | <returns> | ||
2840 | The extension object | ||
2841 | </returns> | ||
2842 | <remarks> | ||
2843 | The extension object is cached and the same instance will be returned at every call. | ||
2844 | </remarks> | ||
2845 | </member> | ||
2846 | <member name="M:Mono.Addins.InstanceExtensionNode.GetInstance"> | ||
2847 | <summary> | ||
2848 | Gets the extension object declared by this node | ||
2849 | </summary> | ||
2850 | <returns> | ||
2851 | The extension object | ||
2852 | </returns> | ||
2853 | <remarks> | ||
2854 | The extension object is cached and the same instance will be returned at every call. | ||
2855 | </remarks> | ||
2856 | </member> | ||
2857 | <member name="M:Mono.Addins.InstanceExtensionNode.CreateInstance(System.Type)"> | ||
2858 | <summary> | ||
2859 | Creates a new extension object | ||
2860 | </summary> | ||
2861 | <param name="expectedType"> | ||
2862 | Expected object type. An exception will be thrown if the object is not an instance of the specified type. | ||
2863 | </param> | ||
2864 | <returns> | ||
2865 | The extension object | ||
2866 | </returns> | ||
2867 | </member> | ||
2868 | <member name="M:Mono.Addins.InstanceExtensionNode.CreateInstance"> | ||
2869 | <summary> | ||
2870 | Creates a new extension object | ||
2871 | </summary> | ||
2872 | <returns> | ||
2873 | The extension object | ||
2874 | </returns> | ||
2875 | </member> | ||
2876 | <member name="T:Mono.Addins.AddinDependencyAttribute"> | ||
2877 | <summary> | ||
2878 | Declares a dependency on an add-in or add-in host | ||
2879 | </summary> | ||
2880 | </member> | ||
2881 | <member name="M:Mono.Addins.AddinDependencyAttribute.#ctor(System.String,System.String)"> | ||
2882 | <summary> | ||
2883 | Initializes the attribute | ||
2884 | </summary> | ||
2885 | <param name="id"> | ||
2886 | Identifier of the add-in | ||
2887 | </param> | ||
2888 | <param name="version"> | ||
2889 | Version of the add-in | ||
2890 | </param> | ||
2891 | </member> | ||
2892 | <member name="P:Mono.Addins.AddinDependencyAttribute.Id"> | ||
2893 | <summary> | ||
2894 | Identifier of the add-in | ||
2895 | </summary> | ||
2896 | </member> | ||
2897 | <member name="P:Mono.Addins.AddinDependencyAttribute.Version"> | ||
2898 | <summary> | ||
2899 | Version of the add-in | ||
2900 | </summary> | ||
2901 | </member> | ||
2902 | <member name="T:Mono.Addins.ExtensionNode`1"> | ||
2903 | <summary> | ||
2904 | An extension node with custom metadata | ||
2905 | </summary> | ||
2906 | <remarks> | ||
2907 | This is the default type for extension nodes bound to a custom extension attribute. | ||
2908 | </remarks> | ||
2909 | </member> | ||
2910 | <member name="T:Mono.Addins.IAttributedExtensionNode"> | ||
2911 | <summary> | ||
2912 | An extension node with custom metadata provided by an attribute | ||
2913 | </summary> | ||
2914 | <remarks> | ||
2915 | This interface is implemented by ExtensionNode<T> to provide non-generic access to the attribute instance. | ||
2916 | </remarks> | ||
2917 | </member> | ||
2918 | <member name="P:Mono.Addins.IAttributedExtensionNode.Attribute"> | ||
2919 | <summary> | ||
2920 | The custom attribute containing the extension metadata | ||
2921 | </summary> | ||
2922 | </member> | ||
2923 | <member name="P:Mono.Addins.ExtensionNode`1.Data"> | ||
2924 | <summary> | ||
2925 | The custom attribute containing the extension metadata | ||
2926 | </summary> | ||
2927 | </member> | ||
2928 | <member name="T:Mono.Addins.AddinPropertyAttribute"> | ||
2929 | <summary> | ||
2930 | Defines an add-in property | ||
2931 | </summary> | ||
2932 | </member> | ||
2933 | <member name="M:Mono.Addins.AddinPropertyAttribute.#ctor(System.String,System.String)"> | ||
2934 | <summary> | ||
2935 | Initializes a new instance of the <see cref="T:Mono.Addins.AddinPropertyAttribute"/> class. | ||
2936 | </summary> | ||
2937 | <param name="name"> | ||
2938 | Name of the property | ||
2939 | </param> | ||
2940 | <param name="value"> | ||
2941 | Value of the property | ||
2942 | </param> | ||
2943 | </member> | ||
2944 | <member name="M:Mono.Addins.AddinPropertyAttribute.#ctor(System.String,System.String,System.String)"> | ||
2945 | <summary> | ||
2946 | Initializes a new instance of the <see cref="T:Mono.Addins.AddinPropertyAttribute"/> class. | ||
2947 | </summary> | ||
2948 | <param name="name"> | ||
2949 | Name of the property | ||
2950 | </param> | ||
2951 | <param name="locale"> | ||
2952 | Locale of the property. It can be null if the property is not bound to a locale. | ||
2953 | </param> | ||
2954 | <param name="value"> | ||
2955 | Value of the property | ||
2956 | </param> | ||
2957 | </member> | ||
2958 | <member name="P:Mono.Addins.AddinPropertyAttribute.Name"> | ||
2959 | <summary> | ||
2960 | Name of the property | ||
2961 | </summary> | ||
2962 | </member> | ||
2963 | <member name="P:Mono.Addins.AddinPropertyAttribute.Locale"> | ||
2964 | <summary> | ||
2965 | Locale of the property. It can be null if the property is not bound to a locale. | ||
2966 | </summary> | ||
2967 | </member> | ||
2968 | <member name="P:Mono.Addins.AddinPropertyAttribute.Value"> | ||
2969 | <summary> | ||
2970 | Value of the property | ||
2971 | </summary> | ||
2972 | </member> | ||
2973 | <member name="T:Mono.Addins.CustomExtensionAttribute"> | ||
2974 | <summary> | ||
2975 | Base class for custon extension attributes. | ||
2976 | </summary> | ||
2977 | <remarks> | ||
2978 | Custom extension attributes can be used to declare extensions with custom metadata. | ||
2979 | All custom extension attributes must subclass CustomExtensionAttribute. | ||
2980 | </remarks> | ||
2981 | </member> | ||
2982 | <member name="P:Mono.Addins.CustomExtensionAttribute.Id"> | ||
2983 | <summary> | ||
2984 | Identifier of the node | ||
2985 | </summary> | ||
2986 | </member> | ||
2987 | <member name="P:Mono.Addins.CustomExtensionAttribute.InsertBefore"> | ||
2988 | <summary> | ||
2989 | Identifier of the node before which this node has to be placed | ||
2990 | </summary> | ||
2991 | </member> | ||
2992 | <member name="P:Mono.Addins.CustomExtensionAttribute.InsertAfter"> | ||
2993 | <summary> | ||
2994 | Identifier of the node after which this node has to be placed | ||
2995 | </summary> | ||
2996 | </member> | ||
2997 | <member name="P:Mono.Addins.CustomExtensionAttribute.Path"> | ||
2998 | <summary> | ||
2999 | Path of the extension point being extended. | ||
3000 | </summary> | ||
3001 | <remarks> | ||
3002 | This property is optional and useful only when there are several extension points which allow | ||
3003 | using this custom attribute to define extensions. | ||
3004 | </remarks> | ||
3005 | </member> | ||
3006 | <member name="P:Mono.Addins.CustomExtensionAttribute.ExtensionNode"> | ||
3007 | <summary> | ||
3008 | The extension node bound to this attribute | ||
3009 | </summary> | ||
3010 | </member> | ||
3011 | <member name="P:Mono.Addins.CustomExtensionAttribute.Addin"> | ||
3012 | <summary> | ||
3013 | The add-in that registered this extension node. | ||
3014 | </summary> | ||
3015 | <remarks> | ||
3016 | This property provides access to the resources and types of the add-in that created this extension node. | ||
3017 | </remarks> | ||
3018 | </member> | ||
3019 | <member name="T:Mono.Addins.Localization.IPluralAddinLocalizer"> | ||
3020 | <summary> | ||
3021 | A localizer that supports localization of plural forms. | ||
3022 | </summary> | ||
3023 | <remarks> | ||
3024 | This interface can be implemented by add-in localizers which want to provide | ||
3025 | support plural forms. | ||
3026 | </remarks> | ||
3027 | </member> | ||
3028 | <member name="M:Mono.Addins.Localization.IPluralAddinLocalizer.GetPluralString(System.String,System.String,System.Int32)"> | ||
3029 | <summary> | ||
3030 | Gets a localized message which may contain plural forms. | ||
3031 | </summary> | ||
3032 | <returns> | ||
3033 | The localized message. | ||
3034 | </returns> | ||
3035 | <param name='singular'> | ||
3036 | Message identifier to use when the specified count is 1. | ||
3037 | </param> | ||
3038 | <param name='defaultPlural'> | ||
3039 | Default message identifier to use when the specified count is not 1. | ||
3040 | </param> | ||
3041 | <param name='n'> | ||
3042 | The count that determines which plural form to use. | ||
3043 | </param> | ||
3044 | </member> | ||
3045 | <member name="T:Mono.Addins.AddinLocalizer"> | ||
3046 | <summary> | ||
3047 | Converts message identifiers to localized messages. | ||
3048 | </summary> | ||
3049 | </member> | ||
3050 | <member name="M:Mono.Addins.AddinLocalizer.GetString(System.String)"> | ||
3051 | <summary> | ||
3052 | Gets a localized message | ||
3053 | </summary> | ||
3054 | <param name="msgid"> | ||
3055 | Message identifier | ||
3056 | </param> | ||
3057 | <returns> | ||
3058 | The localized message | ||
3059 | </returns> | ||
3060 | </member> | ||
3061 | <member name="M:Mono.Addins.AddinLocalizer.GetString(System.String,System.String[])"> | ||
3062 | <summary> | ||
3063 | Gets a formatted and localized message | ||
3064 | </summary> | ||
3065 | <param name="msgid"> | ||
3066 | Message identifier (can contain string format placeholders) | ||
3067 | </param> | ||
3068 | <param name="args"> | ||
3069 | Arguments for the string format operation | ||
3070 | </param> | ||
3071 | <returns> | ||
3072 | The formatted and localized string | ||
3073 | </returns> | ||
3074 | </member> | ||
3075 | <member name="M:Mono.Addins.AddinLocalizer.GetString(System.String,System.Object[])"> | ||
3076 | <summary> | ||
3077 | Gets a formatted and localized message | ||
3078 | </summary> | ||
3079 | <param name="msgid"> | ||
3080 | Message identifier (can contain string format placeholders) | ||
3081 | </param> | ||
3082 | <param name="args"> | ||
3083 | Arguments for the string format operation | ||
3084 | </param> | ||
3085 | <returns> | ||
3086 | The formatted and localized string | ||
3087 | </returns> | ||
3088 | </member> | ||
3089 | <member name="M:Mono.Addins.AddinLocalizer.GetPluralString(System.String,System.String,System.Int32)"> | ||
3090 | <summary> | ||
3091 | Gets a localized plural form for a message identifier | ||
3092 | </summary> | ||
3093 | <param name="msgid"> | ||
3094 | Message identifier for the singular form | ||
3095 | </param> | ||
3096 | <param name="defaultPlural"> | ||
3097 | Default result message for the plural form | ||
3098 | </param> | ||
3099 | <param name="n"> | ||
3100 | Value count. Determines wether to use singular or plural form. | ||
3101 | </param> | ||
3102 | <returns> | ||
3103 | The localized message | ||
3104 | </returns> | ||
3105 | </member> | ||
3106 | <member name="M:Mono.Addins.AddinLocalizer.GetPluralString(System.String,System.String,System.Int32,System.String[])"> | ||
3107 | <summary> | ||
3108 | Gets a localized and formatted plural form for a message identifier | ||
3109 | </summary> | ||
3110 | <param name="singular"> | ||
3111 | Message identifier for the singular form (can contain string format placeholders) | ||
3112 | </param> | ||
3113 | <param name="defaultPlural"> | ||
3114 | Default result message for the plural form (can contain string format placeholders) | ||
3115 | </param> | ||
3116 | <param name="n"> | ||
3117 | Value count. Determines whether to use singular or plural form. | ||
3118 | </param> | ||
3119 | <param name="args"> | ||
3120 | Arguments for the string format operation | ||
3121 | </param> | ||
3122 | <returns> | ||
3123 | The localized message | ||
3124 | </returns> | ||
3125 | </member> | ||
3126 | <member name="M:Mono.Addins.AddinLocalizer.GetPluralString(System.String,System.String,System.Int32,System.Object[])"> | ||
3127 | <summary> | ||
3128 | Gets a localized and formatted plural form for a message identifier | ||
3129 | </summary> | ||
3130 | <param name="singular"> | ||
3131 | Message identifier for the singular form (can contain string format placeholders) | ||
3132 | </param> | ||
3133 | <param name="defaultPlural"> | ||
3134 | Default result message for the plural form (can contain string format placeholders) | ||
3135 | </param> | ||
3136 | <param name="n"> | ||
3137 | Value count. Determines whether to use singular or plural form. | ||
3138 | </param> | ||
3139 | <param name="args"> | ||
3140 | Arguments for the string format operation | ||
3141 | </param> | ||
3142 | <returns> | ||
3143 | The localized message | ||
3144 | </returns> | ||
3145 | </member> | ||
3146 | <member name="T:Mono.Addins.Description.ExtensionPointCollection"> | ||
3147 | <summary> | ||
3148 | A collection of extension point definitions. | ||
3149 | </summary> | ||
3150 | </member> | ||
3151 | <member name="M:Mono.Addins.Description.ExtensionPointCollection.#ctor"> | ||
3152 | <summary> | ||
3153 | Initializes a new instance of the <see cref="T:Mono.Addins.Description.ExtensionPointCollection"/> class. | ||
3154 | </summary> | ||
3155 | </member> | ||
3156 | <member name="P:Mono.Addins.Description.ExtensionPointCollection.Item(System.Int32)"> | ||
3157 | <summary> | ||
3158 | Gets the <see cref="T:Mono.Addins.Description.ExtensionPoint"/> at the specified index. | ||
3159 | </summary> | ||
3160 | <param name="n"> | ||
3161 | The index. | ||
3162 | </param> | ||
3163 | </member> | ||
3164 | <member name="P:Mono.Addins.Description.ExtensionPointCollection.Item(System.String)"> | ||
3165 | <summary> | ||
3166 | Gets the <see cref="T:Mono.Addins.Description.ExtensionPoint"/> with the specified path. | ||
3167 | </summary> | ||
3168 | <param name="path"> | ||
3169 | Path. | ||
3170 | </param> | ||
3171 | </member> | ||
3172 | <member name="T:Mono.Addins.AddinLocalizerGettextAttribute"> | ||
3173 | <summary> | ||
3174 | Declares a Gettext-based localizer for an add-in | ||
3175 | </summary> | ||
3176 | </member> | ||
3177 | <member name="M:Mono.Addins.AddinLocalizerGettextAttribute.#ctor"> | ||
3178 | <summary> | ||
3179 | Initializes a new instance of the <see cref="T:Mono.Addins.AddinLocalizerGettextAttribute"/> class. | ||
3180 | </summary> | ||
3181 | </member> | ||
3182 | <member name="M:Mono.Addins.AddinLocalizerGettextAttribute.#ctor(System.String)"> | ||
3183 | <summary> | ||
3184 | Initializes a new instance of the <see cref="T:Mono.Addins.AddinLocalizerGettextAttribute"/> class. | ||
3185 | </summary> | ||
3186 | <param name="catalog"> | ||
3187 | Name of the catalog which contains the strings. | ||
3188 | </param> | ||
3189 | </member> | ||
3190 | <member name="M:Mono.Addins.AddinLocalizerGettextAttribute.#ctor(System.String,System.String)"> | ||
3191 | <summary> | ||
3192 | Initializes a new instance of the <see cref="T:Mono.Addins.AddinLocalizerGettextAttribute"/> class. | ||
3193 | </summary> | ||
3194 | <param name="catalog"> | ||
3195 | Name of the catalog which contains the strings. | ||
3196 | </param> | ||
3197 | <param name="location"> | ||
3198 | Relative path to the location of the catalog. This path must be relative to the add-in location. | ||
3199 | </param> | ||
3200 | <remarks> | ||
3201 | The location path must contain a directory structure like this: | ||
3202 | |||
3203 | {language-id}/LC_MESSAGES/{Catalog}.mo | ||
3204 | |||
3205 | For example, the catalog for spanish strings would be located at: | ||
3206 | |||
3207 | locale/es/LC_MESSAGES/some-addin.mo | ||
3208 | </remarks> | ||
3209 | </member> | ||
3210 | <member name="P:Mono.Addins.AddinLocalizerGettextAttribute.Catalog"> | ||
3211 | <summary> | ||
3212 | Name of the catalog which contains the strings. | ||
3213 | </summary> | ||
3214 | </member> | ||
3215 | <member name="P:Mono.Addins.AddinLocalizerGettextAttribute.Location"> | ||
3216 | <summary> | ||
3217 | Relative path to the location of the catalog. This path must be relative to the add-in location. | ||
3218 | </summary> | ||
3219 | <remarks> | ||
3220 | When not specified, the default value of this property is 'locale'. | ||
3221 | The location path must contain a directory structure like this: | ||
3222 | |||
3223 | {language-id}/LC_MESSAGES/{Catalog}.mo | ||
3224 | |||
3225 | For example, the catalog for spanish strings would be located at: | ||
3226 | |||
3227 | locale/es/LC_MESSAGES/some-addin.mo | ||
3228 | </remarks> | ||
3229 | </member> | ||
3230 | <member name="T:Mono.Addins.AddinAuthorAttribute"> | ||
3231 | <summary> | ||
3232 | Declares an author of the add-in | ||
3233 | </summary> | ||
3234 | </member> | ||
3235 | <member name="M:Mono.Addins.AddinAuthorAttribute.#ctor(System.String)"> | ||
3236 | <summary> | ||
3237 | Initializes the attribute | ||
3238 | </summary> | ||
3239 | <param name="name"> | ||
3240 | Name of the author | ||
3241 | </param> | ||
3242 | </member> | ||
3243 | <member name="P:Mono.Addins.AddinAuthorAttribute.Name"> | ||
3244 | <summary> | ||
3245 | Author name | ||
3246 | </summary> | ||
3247 | </member> | ||
3248 | <member name="T:Mono.Addins.Description.ConditionTypeDescription"> | ||
3249 | <summary> | ||
3250 | A condition type definition. | ||
3251 | </summary> | ||
3252 | </member> | ||
3253 | <member name="M:Mono.Addins.Description.ConditionTypeDescription.#ctor"> | ||
3254 | <summary> | ||
3255 | Initializes a new instance of the <see cref="T:Mono.Addins.Description.ConditionTypeDescription"/> class. | ||
3256 | </summary> | ||
3257 | </member> | ||
3258 | <member name="M:Mono.Addins.Description.ConditionTypeDescription.CopyFrom(Mono.Addins.Description.ConditionTypeDescription)"> | ||
3259 | <summary> | ||
3260 | Copies data from another condition type definition | ||
3261 | </summary> | ||
3262 | <param name='cond'> | ||
3263 | Condition from which to copy | ||
3264 | </param> | ||
3265 | </member> | ||
3266 | <member name="P:Mono.Addins.Description.ConditionTypeDescription.Id"> | ||
3267 | <summary> | ||
3268 | Gets or sets the identifier of the condition type | ||
3269 | </summary> | ||
3270 | <value> | ||
3271 | The identifier. | ||
3272 | </value> | ||
3273 | </member> | ||
3274 | <member name="P:Mono.Addins.Description.ConditionTypeDescription.TypeName"> | ||
3275 | <summary> | ||
3276 | Gets or sets the name of the type that implements the condition | ||
3277 | </summary> | ||
3278 | <value> | ||
3279 | The name of the type. | ||
3280 | </value> | ||
3281 | </member> | ||
3282 | <member name="P:Mono.Addins.Description.ConditionTypeDescription.Description"> | ||
3283 | <summary> | ||
3284 | Gets or sets the description of the condition. | ||
3285 | </summary> | ||
3286 | <value> | ||
3287 | The description. | ||
3288 | </value> | ||
3289 | </member> | ||
3290 | <member name="T:Mono.Addins.Description.ExtensionPoint"> | ||
3291 | <summary> | ||
3292 | An extension point definition. | ||
3293 | </summary> | ||
3294 | </member> | ||
3295 | <member name="M:Mono.Addins.Description.ExtensionPoint.#ctor"> | ||
3296 | <summary> | ||
3297 | Initializes a new instance of the <see cref="T:Mono.Addins.Description.ExtensionPoint"/> class. | ||
3298 | </summary> | ||
3299 | </member> | ||
3300 | <member name="M:Mono.Addins.Description.ExtensionPoint.CopyFrom(Mono.Addins.Description.ExtensionPoint)"> | ||
3301 | <summary> | ||
3302 | Copies another extension point. | ||
3303 | </summary> | ||
3304 | <param name='ep'> | ||
3305 | Extension point from which to copy. | ||
3306 | </param> | ||
3307 | </member> | ||
3308 | <member name="M:Mono.Addins.Description.ExtensionPoint.AddExtensionNode(System.String,System.String)"> | ||
3309 | <summary> | ||
3310 | Adds an extension node type. | ||
3311 | </summary> | ||
3312 | <returns> | ||
3313 | The extension node type. | ||
3314 | </returns> | ||
3315 | <param name='name'> | ||
3316 | Name of the node | ||
3317 | </param> | ||
3318 | <param name='typeName'> | ||
3319 | Name of the type that implements the extension node. | ||
3320 | </param> | ||
3321 | <remarks> | ||
3322 | This method can be used to register a new allowed node type for the extension point. | ||
3323 | </remarks> | ||
3324 | </member> | ||
3325 | <member name="P:Mono.Addins.Description.ExtensionPoint.Path"> | ||
3326 | <summary> | ||
3327 | Gets or sets the path that identifies the extension point. | ||
3328 | </summary> | ||
3329 | <value> | ||
3330 | The path. | ||
3331 | </value> | ||
3332 | </member> | ||
3333 | <member name="P:Mono.Addins.Description.ExtensionPoint.Name"> | ||
3334 | <summary> | ||
3335 | Gets or sets the display name of the extension point. | ||
3336 | </summary> | ||
3337 | <value> | ||
3338 | The name. | ||
3339 | </value> | ||
3340 | </member> | ||
3341 | <member name="P:Mono.Addins.Description.ExtensionPoint.Description"> | ||
3342 | <summary> | ||
3343 | Gets or sets the description of the extension point. | ||
3344 | </summary> | ||
3345 | <value> | ||
3346 | The description. | ||
3347 | </value> | ||
3348 | </member> | ||
3349 | <member name="P:Mono.Addins.Description.ExtensionPoint.ExtenderAddins"> | ||
3350 | <summary> | ||
3351 | Gets a list of add-ins that extend this extension point. | ||
3352 | </summary> | ||
3353 | <remarks> | ||
3354 | This value is only available when the add-in description is loaded from an add-in registry. | ||
3355 | </remarks> | ||
3356 | </member> | ||
3357 | <member name="P:Mono.Addins.Description.ExtensionPoint.NodeSet"> | ||
3358 | <summary> | ||
3359 | A node set which specifies the node types allowed in this extension point. | ||
3360 | </summary> | ||
3361 | <value> | ||
3362 | The node set. | ||
3363 | </value> | ||
3364 | </member> | ||
3365 | <member name="P:Mono.Addins.Description.ExtensionPoint.Conditions"> | ||
3366 | <summary> | ||
3367 | Gets the conditions available in this node set. | ||
3368 | </summary> | ||
3369 | <value> | ||
3370 | The conditions. | ||
3371 | </value> | ||
3372 | </member> | ||
3373 | <member name="T:Mono.Addins.ConditionType"> | ||
3374 | <summary> | ||
3375 | A condition evaluator. | ||
3376 | </summary> | ||
3377 | <remarks> | ||
3378 | Add-ins may use conditions to register nodes in an extension point which | ||
3379 | are only visible under some contexts. For example, an add-in registering | ||
3380 | a custom menu option to the main menu of a sample text editor might want | ||
3381 | to make that option visible only for some kind of files. To allow add-ins | ||
3382 | to do this kind of check, the host application needs to define a new condition. | ||
3383 | </remarks> | ||
3384 | </member> | ||
3385 | <member name="M:Mono.Addins.ConditionType.Evaluate(Mono.Addins.NodeElement)"> | ||
3386 | <summary> | ||
3387 | Evaluates the condition. | ||
3388 | </summary> | ||
3389 | <param name="conditionNode"> | ||
3390 | Condition node information. | ||
3391 | </param> | ||
3392 | <returns> | ||
3393 | 'true' if the condition is satisfied. | ||
3394 | </returns> | ||
3395 | </member> | ||
3396 | <member name="M:Mono.Addins.ConditionType.NotifyChanged"> | ||
3397 | <summary> | ||
3398 | Notifies that the condition has changed, and that it has to be re-evaluated. | ||
3399 | </summary> | ||
3400 | This method must be called when there is a change in the state that determines | ||
3401 | the result of the evaluation. When this method is called, all node conditions | ||
3402 | depending on it are reevaluated and the corresponding events for adding or | ||
3403 | removing extension nodes are fired. | ||
3404 | <remarks> | ||
3405 | </remarks> | ||
3406 | </member> | ||
3407 | <member name="T:Mono.Addins.ExtensionNodeList"> | ||
3408 | <summary> | ||
3409 | A list of extension nodes. | ||
3410 | </summary> | ||
3411 | </member> | ||
3412 | <member name="M:Mono.Addins.ExtensionNodeList.GetEnumerator"> | ||
3413 | <summary> | ||
3414 | Gets an enumerator which enumerates all nodes in the list | ||
3415 | </summary> | ||
3416 | </member> | ||
3417 | <member name="M:Mono.Addins.ExtensionNodeList.CopyTo(Mono.Addins.ExtensionNode[],System.Int32)"> | ||
3418 | <summary> | ||
3419 | Copies all nodes to an array | ||
3420 | </summary> | ||
3421 | <param name='array'> | ||
3422 | The target array | ||
3423 | </param> | ||
3424 | <param name='index'> | ||
3425 | Initial index where to copy to | ||
3426 | </param> | ||
3427 | </member> | ||
3428 | <member name="P:Mono.Addins.ExtensionNodeList.Item(System.Int32)"> | ||
3429 | <summary> | ||
3430 | Returns the node in the specified index. | ||
3431 | </summary> | ||
3432 | <param name="n"> | ||
3433 | The index. | ||
3434 | </param> | ||
3435 | </member> | ||
3436 | <member name="P:Mono.Addins.ExtensionNodeList.Item(System.String)"> | ||
3437 | <summary> | ||
3438 | Returns the node with the specified ID. | ||
3439 | </summary> | ||
3440 | <param name="id"> | ||
3441 | An id. | ||
3442 | </param> | ||
3443 | </member> | ||
3444 | <member name="P:Mono.Addins.ExtensionNodeList.Count"> | ||
3445 | <summary> | ||
3446 | Number of nodes of the collection. | ||
3447 | </summary> | ||
3448 | </member> | ||
3449 | <member name="T:Mono.Addins.ExtensionNodeList`1"> | ||
3450 | <summary> | ||
3451 | A list of extension nodes. | ||
3452 | </summary> | ||
3453 | </member> | ||
3454 | <member name="M:Mono.Addins.ExtensionNodeList`1.GetEnumerator"> | ||
3455 | <summary> | ||
3456 | Gets an enumerator which enumerates all nodes in the list | ||
3457 | </summary> | ||
3458 | </member> | ||
3459 | <member name="M:Mono.Addins.ExtensionNodeList`1.CopyTo(`0[],System.Int32)"> | ||
3460 | <summary> | ||
3461 | Copies all nodes to an array | ||
3462 | </summary> | ||
3463 | <param name='array'> | ||
3464 | The target array | ||
3465 | </param> | ||
3466 | <param name='index'> | ||
3467 | Initial index where to copy to | ||
3468 | </param> | ||
3469 | </member> | ||
3470 | <member name="P:Mono.Addins.ExtensionNodeList`1.Item(System.Int32)"> | ||
3471 | <summary> | ||
3472 | Returns the node in the specified index. | ||
3473 | </summary> | ||
3474 | <param name="n"> | ||
3475 | The index. | ||
3476 | </param> | ||
3477 | </member> | ||
3478 | <member name="P:Mono.Addins.ExtensionNodeList`1.Item(System.String)"> | ||
3479 | <summary> | ||
3480 | Returns the node with the specified ID. | ||
3481 | </summary> | ||
3482 | <param name="id"> | ||
3483 | An id. | ||
3484 | </param> | ||
3485 | </member> | ||
3486 | <member name="P:Mono.Addins.ExtensionNodeList`1.Count"> | ||
3487 | <summary> | ||
3488 | Number of nodes of the collection. | ||
3489 | </summary> | ||
3490 | </member> | ||
3491 | <member name="T:Mono.Addins.MissingDependencyException"> | ||
3492 | <summary> | ||
3493 | Exception thrown when the add-in engine can't find a required add-in dependency | ||
3494 | </summary> | ||
3495 | </member> | ||
3496 | <member name="T:Mono.Addins.TypeExtensionNode"> | ||
3497 | <summary> | ||
3498 | An extension node which specifies a type. | ||
3499 | </summary> | ||
3500 | <remarks> | ||
3501 | This class is a kind of Mono.Addins.ExtensionNode which can be used to register | ||
3502 | types in an extension point. This is a very common case: a host application | ||
3503 | defines an interface, and add-ins create classes that implement that interface. | ||
3504 | The host will define an extension point which will use TypeExtensionNode as nodetext | ||
3505 | type. Add-ins will register the classes they implement in that extension point. | ||
3506 | |||
3507 | When the nodes of an extension point are of type TypeExtensionNode it is then | ||
3508 | possible to use query methods such as AddinManager.GetExtensionObjects(string), | ||
3509 | which will get all nodes in the provided extension path and will create an object | ||
3510 | for each node. | ||
3511 | |||
3512 | When declaring extension nodes in an add-in manifest, the class names can be | ||
3513 | specified using the 'class' or 'type' attribute. If none of those attributes is | ||
3514 | provided, the class name will be taken from the 'id' attribute. | ||
3515 | |||
3516 | TypeExtensionNode is the default extension type used when no type is provided | ||
3517 | in the definition of an extension point. | ||
3518 | </remarks> | ||
3519 | </member> | ||
3520 | <member name="M:Mono.Addins.TypeExtensionNode.Read(Mono.Addins.NodeElement)"> | ||
3521 | <summary> | ||
3522 | Reads the extension node data | ||
3523 | </summary> | ||
3524 | <param name='elem'> | ||
3525 | The element containing the extension data | ||
3526 | </param> | ||
3527 | <remarks> | ||
3528 | This method can be overriden to provide a custom method for reading extension node data from an element. | ||
3529 | The default implementation reads the attributes if the element and assigns the values to the fields | ||
3530 | and properties of the extension node that have the corresponding [NodeAttribute] decoration. | ||
3531 | </remarks> | ||
3532 | </member> | ||
3533 | <member name="M:Mono.Addins.TypeExtensionNode.CreateInstance"> | ||
3534 | <summary> | ||
3535 | Creates a new extension object | ||
3536 | </summary> | ||
3537 | <returns> | ||
3538 | The extension object | ||
3539 | </returns> | ||
3540 | </member> | ||
3541 | <member name="P:Mono.Addins.TypeExtensionNode.Type"> | ||
3542 | <summary> | ||
3543 | Type of the object that this node creates | ||
3544 | </summary> | ||
3545 | </member> | ||
3546 | <member name="P:Mono.Addins.TypeExtensionNode.TypeName"> | ||
3547 | <summary> | ||
3548 | Name of the type of the object that this node creates | ||
3549 | </summary> | ||
3550 | <value>The name of the type.</value> | ||
3551 | </member> | ||
3552 | <member name="T:Mono.Addins.TypeExtensionNode`1"> | ||
3553 | <summary> | ||
3554 | An extension node which specifies a type with custom extension metadata | ||
3555 | </summary> | ||
3556 | <remarks> | ||
3557 | This is the default type for type extension nodes bound to a custom extension attribute. | ||
3558 | </remarks> | ||
3559 | </member> | ||
3560 | <member name="P:Mono.Addins.TypeExtensionNode`1.Data"> | ||
3561 | <summary> | ||
3562 | The custom attribute containing the extension metadata | ||
3563 | </summary> | ||
3564 | </member> | ||
3565 | <member name="T:Mono.Addins.AddinDescriptionAttribute"> | ||
3566 | <summary> | ||
3567 | Describes the purpose of an add-in or add-in root | ||
3568 | </summary> | ||
3569 | </member> | ||
3570 | <member name="M:Mono.Addins.AddinDescriptionAttribute.#ctor(System.String)"> | ||
3571 | <summary> | ||
3572 | Initializes a new instance of the <see cref="T:Mono.Addins.AddinDescriptionAttribute"/> class. | ||
3573 | </summary> | ||
3574 | <param name="description"> | ||
3575 | Description of the add-in | ||
3576 | </param> | ||
3577 | </member> | ||
3578 | <member name="M:Mono.Addins.AddinDescriptionAttribute.#ctor(System.String,System.String)"> | ||
3579 | <summary> | ||
3580 | Initializes a new instance of the <see cref="T:Mono.Addins.AddinDescriptionAttribute"/> class. | ||
3581 | </summary> | ||
3582 | <param name="description"> | ||
3583 | Description of the add-in | ||
3584 | </param> | ||
3585 | <param name="locale"> | ||
3586 | Locale of the description (for example, 'en-US', or 'en') | ||
3587 | </param> | ||
3588 | </member> | ||
3589 | <member name="P:Mono.Addins.AddinDescriptionAttribute.Description"> | ||
3590 | <value> | ||
3591 | Description of the add-in | ||
3592 | </value> | ||
3593 | </member> | ||
3594 | <member name="P:Mono.Addins.AddinDescriptionAttribute.Locale"> | ||
3595 | <summary> | ||
3596 | Locale of the description (for example, 'en-US', or 'en') | ||
3597 | </summary> | ||
3598 | </member> | ||
3599 | <member name="T:Mono.Addins.AddinRootAttribute"> | ||
3600 | <summary> | ||
3601 | Marks an assembly as being an add-in root. | ||
3602 | </summary> | ||
3603 | <remarks> | ||
3604 | An add-in root is an assemly which can be extended by add-ins. | ||
3605 | </remarks> | ||
3606 | </member> | ||
3607 | <member name="T:Mono.Addins.AddinAttribute"> | ||
3608 | <summary> | ||
3609 | Marks an assembly as being an add-in. | ||
3610 | </summary> | ||
3611 | </member> | ||
3612 | <member name="M:Mono.Addins.AddinAttribute.#ctor"> | ||
3613 | <summary> | ||
3614 | Initializes an add-in marker attribute | ||
3615 | </summary> | ||
3616 | </member> | ||
3617 | <member name="M:Mono.Addins.AddinAttribute.#ctor(System.String)"> | ||
3618 | <summary> | ||
3619 | Initializes an add-in marker attribute | ||
3620 | </summary> | ||
3621 | <param name="id"> | ||
3622 | Identifier of the add-in | ||
3623 | </param> | ||
3624 | </member> | ||
3625 | <member name="M:Mono.Addins.AddinAttribute.#ctor(System.String,System.String)"> | ||
3626 | <summary> | ||
3627 | Initializes an add-in marker attribute | ||
3628 | </summary> | ||
3629 | <param name="id"> | ||
3630 | Identifier of the add-in | ||
3631 | </param> | ||
3632 | <param name="version"> | ||
3633 | Version of the add-in | ||
3634 | </param> | ||
3635 | </member> | ||
3636 | <member name="P:Mono.Addins.AddinAttribute.Id"> | ||
3637 | <summary> | ||
3638 | Identifier of the add-in. | ||
3639 | </summary> | ||
3640 | </member> | ||
3641 | <member name="P:Mono.Addins.AddinAttribute.Version"> | ||
3642 | <summary> | ||
3643 | Version of the add-in. | ||
3644 | </summary> | ||
3645 | </member> | ||
3646 | <member name="P:Mono.Addins.AddinAttribute.CompatVersion"> | ||
3647 | <summary> | ||
3648 | Version of the add-in with which this add-in is backwards compatible. | ||
3649 | </summary> | ||
3650 | </member> | ||
3651 | <member name="P:Mono.Addins.AddinAttribute.Namespace"> | ||
3652 | <summary> | ||
3653 | Namespace of the add-in | ||
3654 | </summary> | ||
3655 | </member> | ||
3656 | <member name="P:Mono.Addins.AddinAttribute.Category"> | ||
3657 | <summary> | ||
3658 | Category of the add-in | ||
3659 | </summary> | ||
3660 | </member> | ||
3661 | <member name="P:Mono.Addins.AddinAttribute.Url"> | ||
3662 | <summary> | ||
3663 | Url to a web page with more information about the add-in | ||
3664 | </summary> | ||
3665 | </member> | ||
3666 | <member name="P:Mono.Addins.AddinAttribute.EnabledByDefault"> | ||
3667 | <summary> | ||
3668 | When set to True, the add-in will be automatically enabled after installing. | ||
3669 | It's True by default. | ||
3670 | </summary> | ||
3671 | </member> | ||
3672 | <member name="P:Mono.Addins.AddinAttribute.Flags"> | ||
3673 | <summary> | ||
3674 | Add-in flags | ||
3675 | </summary> | ||
3676 | </member> | ||
3677 | <member name="M:Mono.Addins.AddinRootAttribute.#ctor"> | ||
3678 | <summary> | ||
3679 | Initializes a new instance | ||
3680 | </summary> | ||
3681 | </member> | ||
3682 | <member name="M:Mono.Addins.AddinRootAttribute.#ctor(System.String)"> | ||
3683 | <summary> | ||
3684 | Initializes a new instance | ||
3685 | </summary> | ||
3686 | <param name="id"> | ||
3687 | Identifier of the add-in root | ||
3688 | </param> | ||
3689 | </member> | ||
3690 | <member name="M:Mono.Addins.AddinRootAttribute.#ctor(System.String,System.String)"> | ||
3691 | <summary> | ||
3692 | Initializes a new instance | ||
3693 | </summary> | ||
3694 | <param name="id"> | ||
3695 | Identifier of the add-in root | ||
3696 | </param> | ||
3697 | <param name="version"> | ||
3698 | Version of the add-in root | ||
3699 | </param> | ||
3700 | </member> | ||
3701 | <member name="T:Mono.Addins.Description.Extension"> | ||
3702 | <summary> | ||
3703 | An extension definition. | ||
3704 | </summary> | ||
3705 | <remarks> | ||
3706 | An Extension is a collection of nodes which have to be registered in an extension point. | ||
3707 | The target extension point is specified in the <see cref="T:Mono.Addins.Description.Extension"/>.Path property. | ||
3708 | </remarks> | ||
3709 | </member> | ||
3710 | <member name="M:Mono.Addins.Description.Extension.#ctor"> | ||
3711 | <summary> | ||
3712 | Initializes a new instance of the <see cref="T:Mono.Addins.Description.Extension"/> class. | ||
3713 | </summary> | ||
3714 | </member> | ||
3715 | <member name="M:Mono.Addins.Description.Extension.#ctor(System.String)"> | ||
3716 | <summary> | ||
3717 | Initializes a new instance of the <see cref="T:Mono.Addins.Description.Extension"/> class. | ||
3718 | </summary> | ||
3719 | <param name="path"> | ||
3720 | Path that identifies the extension point being extended | ||
3721 | </param> | ||
3722 | </member> | ||
3723 | <member name="M:Mono.Addins.Description.Extension.GetExtendedObject"> | ||
3724 | <summary> | ||
3725 | Gets the object extended by this extension | ||
3726 | </summary> | ||
3727 | <returns> | ||
3728 | The extended object can be an <see cref="T:Mono.Addins.Description.ExtensionPoint"/> or | ||
3729 | an <see cref="T:Mono.Addins.Description.ExtensionNodeDescription"/>. | ||
3730 | </returns> | ||
3731 | <remarks> | ||
3732 | This method only works when the add-in description to which the extension belongs has been | ||
3733 | loaded from an add-in registry. | ||
3734 | </remarks> | ||
3735 | </member> | ||
3736 | <member name="M:Mono.Addins.Description.Extension.GetAllowedNodeTypes"> | ||
3737 | <summary> | ||
3738 | Gets the node types allowed in this extension. | ||
3739 | </summary> | ||
3740 | <returns> | ||
3741 | The allowed node types. | ||
3742 | </returns> | ||
3743 | <remarks> | ||
3744 | This method only works when the add-in description to which the extension belongs has been | ||
3745 | loaded from an add-in registry. | ||
3746 | </remarks> | ||
3747 | </member> | ||
3748 | <member name="M:Mono.Addins.Description.Extension.#ctor(System.Xml.XmlElement)"> | ||
3749 | <summary> | ||
3750 | Initializes a new instance of the <see cref="T:Mono.Addins.Description.Extension"/> class. | ||
3751 | </summary> | ||
3752 | <param name="element"> | ||
3753 | XML that describes the extension. | ||
3754 | </param> | ||
3755 | </member> | ||
3756 | <member name="P:Mono.Addins.Description.Extension.Path"> | ||
3757 | <summary> | ||
3758 | Gets or sets the path that identifies the extension point being extended. | ||
3759 | </summary> | ||
3760 | <value> | ||
3761 | The path. | ||
3762 | </value> | ||
3763 | </member> | ||
3764 | <member name="P:Mono.Addins.Description.Extension.ExtensionNodes"> | ||
3765 | <summary> | ||
3766 | Gets the extension nodes. | ||
3767 | </summary> | ||
3768 | <value> | ||
3769 | The extension nodes. | ||
3770 | </value> | ||
3771 | </member> | ||
3772 | <member name="T:Mono.Addins.ExtensionEventHandler"> | ||
3773 | <summary> | ||
3774 | Delegate to be used in extension point subscriptions | ||
3775 | </summary> | ||
3776 | </member> | ||
3777 | <member name="T:Mono.Addins.ExtensionNodeEventHandler"> | ||
3778 | <summary> | ||
3779 | Delegate to be used in extension point subscriptions | ||
3780 | </summary> | ||
3781 | </member> | ||
3782 | <member name="T:Mono.Addins.ExtensionEventArgs"> | ||
3783 | <summary> | ||
3784 | Arguments for extension events. | ||
3785 | </summary> | ||
3786 | </member> | ||
3787 | <member name="M:Mono.Addins.ExtensionEventArgs.#ctor(System.String)"> | ||
3788 | <summary> | ||
3789 | Creates a new instance. | ||
3790 | </summary> | ||
3791 | <param name="path"> | ||
3792 | Path of the extension node that has changed. | ||
3793 | </param> | ||
3794 | </member> | ||
3795 | <member name="M:Mono.Addins.ExtensionEventArgs.PathChanged(System.String)"> | ||
3796 | <summary> | ||
3797 | Checks if a path has changed. | ||
3798 | </summary> | ||
3799 | <param name="pathToCheck"> | ||
3800 | An extension path. | ||
3801 | </param> | ||
3802 | <returns> | ||
3803 | 'true' if the path is affected by the extension change event. | ||
3804 | </returns> | ||
3805 | <remarks> | ||
3806 | Checks if the specified path or any of its children paths is affected by the extension change event. | ||
3807 | </remarks> | ||
3808 | </member> | ||
3809 | <member name="P:Mono.Addins.ExtensionEventArgs.Path"> | ||
3810 | <summary> | ||
3811 | Path of the extension node that has changed. | ||
3812 | </summary> | ||
3813 | </member> | ||
3814 | <member name="T:Mono.Addins.ExtensionNodeEventArgs"> | ||
3815 | <summary> | ||
3816 | Arguments for extension node events. | ||
3817 | </summary> | ||
3818 | </member> | ||
3819 | <member name="M:Mono.Addins.ExtensionNodeEventArgs.#ctor(Mono.Addins.ExtensionChange,Mono.Addins.ExtensionNode)"> | ||
3820 | <summary> | ||
3821 | Creates a new instance | ||
3822 | </summary> | ||
3823 | <param name="change"> | ||
3824 | Type of change. | ||
3825 | </param> | ||
3826 | <param name="node"> | ||
3827 | Node that has been added or removed. | ||
3828 | </param> | ||
3829 | </member> | ||
3830 | <member name="P:Mono.Addins.ExtensionNodeEventArgs.Path"> | ||
3831 | <summary> | ||
3832 | Path of the extension that changed. | ||
3833 | </summary> | ||
3834 | </member> | ||
3835 | <member name="P:Mono.Addins.ExtensionNodeEventArgs.Change"> | ||
3836 | <summary> | ||
3837 | Type of change. | ||
3838 | </summary> | ||
3839 | </member> | ||
3840 | <member name="P:Mono.Addins.ExtensionNodeEventArgs.ExtensionNode"> | ||
3841 | <summary> | ||
3842 | Node that has been added or removed. | ||
3843 | </summary> | ||
3844 | </member> | ||
3845 | <member name="P:Mono.Addins.ExtensionNodeEventArgs.ExtensionObject"> | ||
3846 | <summary> | ||
3847 | Extension object that has been added or removed. | ||
3848 | </summary> | ||
3849 | </member> | ||
3850 | <member name="T:Mono.Addins.ExtensionChange"> | ||
3851 | <summary> | ||
3852 | Type of change in an extension change event. | ||
3853 | </summary> | ||
3854 | </member> | ||
3855 | <member name="F:Mono.Addins.ExtensionChange.Add"> | ||
3856 | <summary> | ||
3857 | An extension node has been added. | ||
3858 | </summary> | ||
3859 | </member> | ||
3860 | <member name="F:Mono.Addins.ExtensionChange.Remove"> | ||
3861 | <summary> | ||
3862 | An extension node has been removed. | ||
3863 | </summary> | ||
3864 | </member> | ||
3865 | <member name="T:Mono.Addins.AddinNameAttribute"> | ||
3866 | <summary> | ||
3867 | Sets the display name of an add-in | ||
3868 | </summary> | ||
3869 | </member> | ||
3870 | <member name="M:Mono.Addins.AddinNameAttribute.#ctor(System.String)"> | ||
3871 | <summary> | ||
3872 | Initializes a new instance of the <see cref="T:Mono.Addins.AddinNameAttribute"/> class. | ||
3873 | </summary> | ||
3874 | <param name="name"> | ||
3875 | Name of the add-in | ||
3876 | </param> | ||
3877 | </member> | ||
3878 | <member name="M:Mono.Addins.AddinNameAttribute.#ctor(System.String,System.String)"> | ||
3879 | <summary> | ||
3880 | Initializes a new instance of the <see cref="T:Mono.Addins.AddinNameAttribute"/> class. | ||
3881 | </summary> | ||
3882 | <param name="name"> | ||
3883 | Name of the add-in | ||
3884 | </param> | ||
3885 | <param name="locale"> | ||
3886 | Locale of the name (for example, 'en-US', or 'en') | ||
3887 | </param> | ||
3888 | </member> | ||
3889 | <member name="P:Mono.Addins.AddinNameAttribute.Name"> | ||
3890 | <value> | ||
3891 | Name of the add-in | ||
3892 | </value> | ||
3893 | </member> | ||
3894 | <member name="P:Mono.Addins.AddinNameAttribute.Locale"> | ||
3895 | <summary> | ||
3896 | Locale of the name (for example, 'en-US', or 'en') | ||
3897 | </summary> | ||
3898 | </member> | ||
3899 | <member name="T:Mono.Addins.ContentType"> | ||
3900 | <summary> | ||
3901 | Type of the content of a string extension node attribute | ||
3902 | </summary> | ||
3903 | </member> | ||
3904 | <member name="F:Mono.Addins.ContentType.Text"> | ||
3905 | <summary> | ||
3906 | Plain text | ||
3907 | </summary> | ||
3908 | </member> | ||
3909 | <member name="F:Mono.Addins.ContentType.Class"> | ||
3910 | <summary> | ||
3911 | A class name | ||
3912 | </summary> | ||
3913 | </member> | ||
3914 | <member name="F:Mono.Addins.ContentType.Resource"> | ||
3915 | <summary> | ||
3916 | A resource name | ||
3917 | </summary> | ||
3918 | </member> | ||
3919 | <member name="F:Mono.Addins.ContentType.File"> | ||
3920 | <summary> | ||
3921 | A file name | ||
3922 | </summary> | ||
3923 | </member> | ||
3924 | <member name="T:Mono.Addins.Database.AddinFileSystemExtension"> | ||
3925 | <summary> | ||
3926 | An add-in file system extension. | ||
3927 | </summary> | ||
3928 | <remarks> | ||
3929 | File system extensions can override the behavior of the add-in scanner and provide custom rules for | ||
3930 | locating and scanning assemblies. | ||
3931 | </remarks> | ||
3932 | </member> | ||
3933 | <member name="M:Mono.Addins.Database.AddinFileSystemExtension.ScanStarted"> | ||
3934 | <summary> | ||
3935 | Called when the add-in scan is about to start | ||
3936 | </summary> | ||
3937 | </member> | ||
3938 | <member name="M:Mono.Addins.Database.AddinFileSystemExtension.ScanFinished"> | ||
3939 | <summary> | ||
3940 | Called when the add-in scan has finished | ||
3941 | </summary> | ||
3942 | </member> | ||
3943 | <member name="M:Mono.Addins.Database.AddinFileSystemExtension.DirectoryExists(System.String)"> | ||
3944 | <summary> | ||
3945 | Checks if a directory exists | ||
3946 | </summary> | ||
3947 | <returns> | ||
3948 | 'true' if the directory exists | ||
3949 | </returns> | ||
3950 | <param name='path'> | ||
3951 | Directory path | ||
3952 | </param> | ||
3953 | </member> | ||
3954 | <member name="M:Mono.Addins.Database.AddinFileSystemExtension.FileExists(System.String)"> | ||
3955 | <summary> | ||
3956 | Checks if a file exists | ||
3957 | </summary> | ||
3958 | <returns> | ||
3959 | 'true' if the file exists | ||
3960 | </returns> | ||
3961 | <param name='path'> | ||
3962 | Path to the file | ||
3963 | </param> | ||
3964 | </member> | ||
3965 | <member name="M:Mono.Addins.Database.AddinFileSystemExtension.GetFiles(System.String)"> | ||
3966 | <summary> | ||
3967 | Gets the files in a directory | ||
3968 | </summary> | ||
3969 | <returns> | ||
3970 | The full path of the files in the directory | ||
3971 | </returns> | ||
3972 | <param name='path'> | ||
3973 | Directory path | ||
3974 | </param> | ||
3975 | </member> | ||
3976 | <member name="M:Mono.Addins.Database.AddinFileSystemExtension.GetDirectories(System.String)"> | ||
3977 | <summary> | ||
3978 | Gets the subdirectories of a directory | ||
3979 | </summary> | ||
3980 | <returns> | ||
3981 | The subdirectories. | ||
3982 | </returns> | ||
3983 | <param name='path'> | ||
3984 | The directory | ||
3985 | </param> | ||
3986 | </member> | ||
3987 | <member name="M:Mono.Addins.Database.AddinFileSystemExtension.GetLastWriteTime(System.String)"> | ||
3988 | <summary> | ||
3989 | Gets the last write time of a file | ||
3990 | </summary> | ||
3991 | <returns> | ||
3992 | The last write time. | ||
3993 | </returns> | ||
3994 | <param name='filePath'> | ||
3995 | File path. | ||
3996 | </param> | ||
3997 | </member> | ||
3998 | <member name="M:Mono.Addins.Database.AddinFileSystemExtension.OpenTextFile(System.String)"> | ||
3999 | <summary> | ||
4000 | Opens a text file | ||
4001 | </summary> | ||
4002 | <returns> | ||
4003 | The text file stream | ||
4004 | </returns> | ||
4005 | <param name='path'> | ||
4006 | File path. | ||
4007 | </param> | ||
4008 | </member> | ||
4009 | <member name="M:Mono.Addins.Database.AddinFileSystemExtension.OpenFile(System.String)"> | ||
4010 | <summary> | ||
4011 | Opens a file. | ||
4012 | </summary> | ||
4013 | <returns> | ||
4014 | The file stream. | ||
4015 | </returns> | ||
4016 | <param name='path'> | ||
4017 | The file path. | ||
4018 | </param> | ||
4019 | </member> | ||
4020 | <member name="M:Mono.Addins.Database.AddinFileSystemExtension.GetReflectorForFile(Mono.Addins.Database.IAssemblyLocator,System.String)"> | ||
4021 | <summary> | ||
4022 | Gets an assembly reflector for a file. | ||
4023 | </summary> | ||
4024 | <returns> | ||
4025 | The reflector for the file. | ||
4026 | </returns> | ||
4027 | <param name='locator'> | ||
4028 | An assembly locator | ||
4029 | </param> | ||
4030 | <param name='path'> | ||
4031 | A file path | ||
4032 | </param> | ||
4033 | </member> | ||
4034 | <member name="P:Mono.Addins.Database.AddinFileSystemExtension.RequiresIsolation"> | ||
4035 | <summary> | ||
4036 | Gets a value indicating whether this <see cref="T:Mono.Addins.Database.AddinFileSystemExtension"/> needs to be isolated from the main execution process | ||
4037 | </summary> | ||
4038 | <value> | ||
4039 | <c>true</c> if requires isolation; otherwise, <c>false</c>. | ||
4040 | </value> | ||
4041 | </member> | ||
4042 | <member name="T:Mono.Addins.ExtensionAttributeAttribute"> | ||
4043 | <summary> | ||
4044 | Assigns an attribute value to an extension | ||
4045 | </summary> | ||
4046 | <remarks> | ||
4047 | This attribute can be used together with the [Extenion] attribute to specify | ||
4048 | a value for an attribute of the extension. | ||
4049 | </remarks> | ||
4050 | </member> | ||
4051 | <member name="M:Mono.Addins.ExtensionAttributeAttribute.#ctor(System.String,System.String)"> | ||
4052 | <summary> | ||
4053 | Initializes a new instance of the <see cref="T:Mono.Addins.ExtensionAttributeAttribute"/> class. | ||
4054 | </summary> | ||
4055 | <param name="name"> | ||
4056 | Name of the attribute | ||
4057 | </param> | ||
4058 | <param name="value"> | ||
4059 | Value of the attribute | ||
4060 | </param> | ||
4061 | </member> | ||
4062 | <member name="M:Mono.Addins.ExtensionAttributeAttribute.#ctor(System.Type,System.String,System.String)"> | ||
4063 | <summary> | ||
4064 | Initializes a new instance of the <see cref="T:Mono.Addins.ExtensionAttributeAttribute"/> class. | ||
4065 | </summary> | ||
4066 | <param name="type"> | ||
4067 | Type of the extension for which the attribute value is being set | ||
4068 | </param> | ||
4069 | <param name="name"> | ||
4070 | Name of the attribute | ||
4071 | </param> | ||
4072 | <param name="value"> | ||
4073 | Value of the attribute | ||
4074 | </param> | ||
4075 | </member> | ||
4076 | <member name="M:Mono.Addins.ExtensionAttributeAttribute.#ctor(System.String,System.String,System.String)"> | ||
4077 | <summary> | ||
4078 | Initializes a new instance of the <see cref="T:Mono.Addins.ExtensionAttributeAttribute"/> class. | ||
4079 | </summary> | ||
4080 | <param name="path"> | ||
4081 | Path of the extension for which the attribute value is being set | ||
4082 | </param> | ||
4083 | <param name="name"> | ||
4084 | Name of the attribute | ||
4085 | </param> | ||
4086 | <param name="value"> | ||
4087 | Value of the attribute | ||
4088 | </param> | ||
4089 | </member> | ||
4090 | <member name="P:Mono.Addins.ExtensionAttributeAttribute.Name"> | ||
4091 | <summary> | ||
4092 | Name of the attribute | ||
4093 | </summary> | ||
4094 | </member> | ||
4095 | <member name="P:Mono.Addins.ExtensionAttributeAttribute.Value"> | ||
4096 | <summary> | ||
4097 | Value of the attribute | ||
4098 | </summary> | ||
4099 | </member> | ||
4100 | <member name="P:Mono.Addins.ExtensionAttributeAttribute.Path"> | ||
4101 | <summary> | ||
4102 | Path of the extension for which the attribute value is being set | ||
4103 | </summary> | ||
4104 | </member> | ||
4105 | <member name="P:Mono.Addins.ExtensionAttributeAttribute.Type"> | ||
4106 | <summary> | ||
4107 | Type of the extension for which the attribute value is being set | ||
4108 | </summary> | ||
4109 | </member> | ||
4110 | <member name="T:Mono.Addins.IAddinInstaller"> | ||
4111 | <summary> | ||
4112 | An add-in installation handler | ||
4113 | </summary> | ||
4114 | </member> | ||
4115 | <member name="M:Mono.Addins.IAddinInstaller.InstallAddins(Mono.Addins.AddinRegistry,System.String,System.String[])"> | ||
4116 | <summary> | ||
4117 | Installs a set of add-ins | ||
4118 | </summary> | ||
4119 | <param name="reg"> | ||
4120 | Registry where to install | ||
4121 | </param> | ||
4122 | <param name="message"> | ||
4123 | Message to show to the user when new add-ins have to be installed. | ||
4124 | </param> | ||
4125 | <param name="addinIds"> | ||
4126 | List of IDs of the add-ins to be installed. | ||
4127 | </param> | ||
4128 | </member> | ||
4129 | <member name="T:Mono.Addins.ExtensionNodeAttribute"> | ||
4130 | <summary> | ||
4131 | This attribute can be applied to an ExtensionNode subclass to specify the default name and description. | ||
4132 | </summary> | ||
4133 | <remarks> | ||
4134 | This information will be used when an extension point does not define a name or description for a node type. | ||
4135 | </remarks> | ||
4136 | </member> | ||
4137 | <member name="M:Mono.Addins.ExtensionNodeAttribute.#ctor"> | ||
4138 | <summary> | ||
4139 | Initializes the attribute | ||
4140 | </summary> | ||
4141 | </member> | ||
4142 | <member name="M:Mono.Addins.ExtensionNodeAttribute.#ctor(System.String)"> | ||
4143 | <summary> | ||
4144 | Initializes the attribute | ||
4145 | </summary> | ||
4146 | <param name="nodeName"> | ||
4147 | Name of the node | ||
4148 | </param> | ||
4149 | </member> | ||
4150 | <member name="M:Mono.Addins.ExtensionNodeAttribute.#ctor(System.String,System.String)"> | ||
4151 | <summary> | ||
4152 | Initializes the attribute | ||
4153 | </summary> | ||
4154 | <param name="nodeName"> | ||
4155 | Name of the node | ||
4156 | </param> | ||
4157 | <param name="description"> | ||
4158 | Description of the node | ||
4159 | </param> | ||
4160 | </member> | ||
4161 | <member name="P:Mono.Addins.ExtensionNodeAttribute.NodeName"> | ||
4162 | <summary> | ||
4163 | Default name of the extension node | ||
4164 | </summary> | ||
4165 | </member> | ||
4166 | <member name="P:Mono.Addins.ExtensionNodeAttribute.Description"> | ||
4167 | <summary> | ||
4168 | Default description of the extension node type | ||
4169 | </summary> | ||
4170 | </member> | ||
4171 | <member name="P:Mono.Addins.ExtensionNodeAttribute.ExtensionAttributeType"> | ||
4172 | <summary> | ||
4173 | Type of a custom attribute which can be used to specify metadata for this extension node type | ||
4174 | </summary> | ||
4175 | </member> | ||
4176 | <member name="T:Mono.Addins.Description.DependencyCollection"> | ||
4177 | <summary> | ||
4178 | A collection of dependency definitions. | ||
4179 | </summary> | ||
4180 | </member> | ||
4181 | <member name="M:Mono.Addins.Description.DependencyCollection.#ctor"> | ||
4182 | <summary> | ||
4183 | Initializes a new instance of the <see cref="T:Mono.Addins.Description.DependencyCollection"/> class. | ||
4184 | </summary> | ||
4185 | </member> | ||
4186 | <member name="M:Mono.Addins.Description.DependencyCollection.Add(Mono.Addins.Description.Dependency)"> | ||
4187 | <summary> | ||
4188 | Adds a dependency to the collection | ||
4189 | </summary> | ||
4190 | <param name='dep'> | ||
4191 | The dependency to add. | ||
4192 | </param> | ||
4193 | </member> | ||
4194 | <member name="M:Mono.Addins.Description.DependencyCollection.Remove(Mono.Addins.Description.Dependency)"> | ||
4195 | <summary> | ||
4196 | Remove the specified dependency. | ||
4197 | </summary> | ||
4198 | <param name='dep'> | ||
4199 | Dependency to remove. | ||
4200 | </param> | ||
4201 | </member> | ||
4202 | <member name="P:Mono.Addins.Description.DependencyCollection.Item(System.Int32)"> | ||
4203 | <summary> | ||
4204 | Gets the <see cref="T:Mono.Addins.Description.Dependency"/> at the specified index. | ||
4205 | </summary> | ||
4206 | <param name="n"> | ||
4207 | The idnex. | ||
4208 | </param> | ||
4209 | </member> | ||
4210 | <member name="T:Mono.Addins.ExtensionAttribute"> | ||
4211 | <summary> | ||
4212 | Declares a type extension. | ||
4213 | </summary> | ||
4214 | <remarks> | ||
4215 | When applied to a class, specifies that the class is an extension | ||
4216 | class to be registered in a matching extension point. | ||
4217 | </remarks> | ||
4218 | </member> | ||
4219 | <member name="M:Mono.Addins.ExtensionAttribute.#ctor"> | ||
4220 | <summary> | ||
4221 | Initializes a new instance of the ExtensionAttribute class. | ||
4222 | </summary> | ||
4223 | </member> | ||
4224 | <member name="M:Mono.Addins.ExtensionAttribute.#ctor(System.String)"> | ||
4225 | <summary> | ||
4226 | Initializes a new instance | ||
4227 | </summary> | ||
4228 | <param name="path"> | ||
4229 | Path of the extension point. | ||
4230 | </param> | ||
4231 | <remarks>The path is only required if there are several extension points defined for the same type.</remarks> | ||
4232 | </member> | ||
4233 | <member name="M:Mono.Addins.ExtensionAttribute.#ctor(System.Type)"> | ||
4234 | <summary> | ||
4235 | Initializes a new instance | ||
4236 | </summary> | ||
4237 | <param name="type"> | ||
4238 | Type defining the extension point being extended | ||
4239 | </param> | ||
4240 | <remarks> | ||
4241 | This constructor can be used to explicitly specify the type that defines the extension point | ||
4242 | to be extended. By default, Mono.Addins will try to find any extension point defined in any | ||
4243 | of the base classes or interfaces. The type parameter can be used when there is more than one | ||
4244 | base type providing an extension point. | ||
4245 | </remarks> | ||
4246 | </member> | ||
4247 | <member name="P:Mono.Addins.ExtensionAttribute.Path"> | ||
4248 | <summary> | ||
4249 | Path of the extension point being extended | ||
4250 | </summary> | ||
4251 | <remarks> | ||
4252 | The path is only required if there are several extension points defined for the same type. | ||
4253 | </remarks> | ||
4254 | </member> | ||
4255 | <member name="P:Mono.Addins.ExtensionAttribute.NodeName"> | ||
4256 | <summary> | ||
4257 | Name of the extension node | ||
4258 | </summary> | ||
4259 | <remarks> | ||
4260 | Extension points may require extensions to use a specific node name. | ||
4261 | This is needed when an extension point may contain several different types of nodes. | ||
4262 | </remarks> | ||
4263 | </member> | ||
4264 | <member name="P:Mono.Addins.ExtensionAttribute.Id"> | ||
4265 | <summary> | ||
4266 | Identifier of the extension node. | ||
4267 | </summary> | ||
4268 | <remarks> | ||
4269 | The ExtensionAttribute.InsertAfter and ExtensionAttribute.InsertBefore | ||
4270 | properties can be used to specify the relative location of a node. The nodes | ||
4271 | referenced in those properties must be defined either in the add-in host | ||
4272 | being extended, or in any add-in on which this add-in depends. | ||
4273 | </remarks> | ||
4274 | </member> | ||
4275 | <member name="P:Mono.Addins.ExtensionAttribute.InsertBefore"> | ||
4276 | <summary> | ||
4277 | Identifier of the extension node before which this node has to be added in the extension point. | ||
4278 | </summary> | ||
4279 | <remarks> | ||
4280 | The ExtensionAttribute.InsertAfter and ExtensionAttribute.InsertBefore | ||
4281 | properties can be used to specify the relative location of a node. The nodes | ||
4282 | referenced in those properties must be defined either in the add-in host | ||
4283 | being extended, or in any add-in on which this add-in depends. | ||
4284 | </remarks> | ||
4285 | </member> | ||
4286 | <member name="P:Mono.Addins.ExtensionAttribute.InsertAfter"> | ||
4287 | <summary> | ||
4288 | Identifier of the extension node after which this node has to be added in the extension point. | ||
4289 | </summary> | ||
4290 | </member> | ||
4291 | <member name="P:Mono.Addins.ExtensionAttribute.Type"> | ||
4292 | <summary> | ||
4293 | Type defining the extension point being extended | ||
4294 | </summary> | ||
4295 | <remarks> | ||
4296 | This property can be used to explicitly specify the type that defines the extension point | ||
4297 | to be extended. By default, Mono.Addins will try to find any extension point defined in any | ||
4298 | of the base classes or interfaces. This property can be used when there is more than one | ||
4299 | base type providing an extension point. | ||
4300 | </remarks> | ||
4301 | </member> | ||
4302 | <member name="T:Mono.Addins.RuntimeAddin"> | ||
4303 | <summary> | ||
4304 | Run-time representation of an add-in. | ||
4305 | </summary> | ||
4306 | </member> | ||
4307 | <member name="M:Mono.Addins.RuntimeAddin.ToString"> | ||
4308 | <summary> | ||
4309 | Returns a string that represents the current RuntimeAddin. | ||
4310 | </summary> | ||
4311 | <returns> | ||
4312 | A string that represents the current RuntimeAddin. | ||
4313 | </returns> | ||
4314 | </member> | ||
4315 | <member name="M:Mono.Addins.RuntimeAddin.GetResourceString(System.String)"> | ||
4316 | <summary> | ||
4317 | Gets a resource string | ||
4318 | </summary> | ||
4319 | <param name="name"> | ||
4320 | Name of the resource | ||
4321 | </param> | ||
4322 | <returns> | ||
4323 | The value of the resource string, or null if the resource can't be found. | ||
4324 | </returns> | ||
4325 | <remarks> | ||
4326 | The add-in engine will look for resources in the main add-in assembly and in all included add-in assemblies. | ||
4327 | </remarks> | ||
4328 | </member> | ||
4329 | <member name="M:Mono.Addins.RuntimeAddin.GetResourceString(System.String,System.Boolean)"> | ||
4330 | <summary> | ||
4331 | Gets a resource string | ||
4332 | </summary> | ||
4333 | <param name="name"> | ||
4334 | Name of the resource | ||
4335 | </param> | ||
4336 | <param name="throwIfNotFound"> | ||
4337 | When set to true, an exception will be thrown if the resource is not found. | ||
4338 | </param> | ||
4339 | <returns> | ||
4340 | The value of the resource string | ||
4341 | </returns> | ||
4342 | <remarks> | ||
4343 | The add-in engine will look for resources in the main add-in assembly and in all included add-in assemblies. | ||
4344 | </remarks> | ||
4345 | </member> | ||
4346 | <member name="M:Mono.Addins.RuntimeAddin.GetResourceString(System.String,System.Boolean,System.Globalization.CultureInfo)"> | ||
4347 | <summary> | ||
4348 | Gets a resource string | ||
4349 | </summary> | ||
4350 | <param name="name"> | ||
4351 | Name of the resource | ||
4352 | </param> | ||
4353 | <param name="throwIfNotFound"> | ||
4354 | When set to true, an exception will be thrown if the resource is not found. | ||
4355 | </param> | ||
4356 | <param name="culture"> | ||
4357 | Culture of the resource | ||
4358 | </param> | ||
4359 | <returns> | ||
4360 | The value of the resource string | ||
4361 | </returns> | ||
4362 | <remarks> | ||
4363 | The add-in engine will look for resources in the main add-in assembly and in all included add-in assemblies. | ||
4364 | </remarks> | ||
4365 | </member> | ||
4366 | <member name="M:Mono.Addins.RuntimeAddin.GetResourceObject(System.String)"> | ||
4367 | <summary> | ||
4368 | Gets a resource object | ||
4369 | </summary> | ||
4370 | <param name="name"> | ||
4371 | Name of the resource | ||
4372 | </param> | ||
4373 | <returns> | ||
4374 | Value of the resource | ||
4375 | </returns> | ||
4376 | <remarks> | ||
4377 | The add-in engine will look for resources in the main add-in assembly and in all included add-in assemblies. | ||
4378 | </remarks> | ||
4379 | </member> | ||
4380 | <member name="M:Mono.Addins.RuntimeAddin.GetResourceObject(System.String,System.Boolean)"> | ||
4381 | <summary> | ||
4382 | Gets a resource object | ||
4383 | </summary> | ||
4384 | <param name="name"> | ||
4385 | Name of the resource | ||
4386 | </param> | ||
4387 | <param name="throwIfNotFound"> | ||
4388 | When set to true, an exception will be thrown if the resource is not found. | ||
4389 | </param> | ||
4390 | <returns> | ||
4391 | Value of the resource | ||
4392 | </returns> | ||
4393 | <remarks> | ||
4394 | The add-in engine will look for resources in the main add-in assembly and in all included add-in assemblies. | ||
4395 | </remarks> | ||
4396 | </member> | ||
4397 | <member name="M:Mono.Addins.RuntimeAddin.GetResourceObject(System.String,System.Boolean,System.Globalization.CultureInfo)"> | ||
4398 | <summary> | ||
4399 | Gets a resource object | ||
4400 | </summary> | ||
4401 | <param name="name"> | ||
4402 | Name of the resource | ||
4403 | </param> | ||
4404 | <param name="throwIfNotFound"> | ||
4405 | When set to true, an exception will be thrown if the resource is not found. | ||
4406 | </param> | ||
4407 | <param name="culture"> | ||
4408 | Culture of the resource | ||
4409 | </param> | ||
4410 | <returns> | ||
4411 | Value of the resource | ||
4412 | </returns> | ||
4413 | <remarks> | ||
4414 | The add-in engine will look for resources in the main add-in assembly and in all included add-in assemblies. | ||
4415 | </remarks> | ||
4416 | </member> | ||
4417 | <member name="M:Mono.Addins.RuntimeAddin.GetType(System.String)"> | ||
4418 | <summary> | ||
4419 | Gets a type defined in the add-in | ||
4420 | </summary> | ||
4421 | <param name="typeName"> | ||
4422 | Full name of the type | ||
4423 | </param> | ||
4424 | <returns> | ||
4425 | A type. | ||
4426 | </returns> | ||
4427 | <remarks> | ||
4428 | The type will be looked up in the assemblies that implement the add-in, | ||
4429 | and recursivelly in all add-ins on which it depends. | ||
4430 | |||
4431 | This method throws an InvalidOperationException if the type can't be found. | ||
4432 | </remarks> | ||
4433 | </member> | ||
4434 | <member name="M:Mono.Addins.RuntimeAddin.GetType(System.String,System.Boolean)"> | ||
4435 | <summary> | ||
4436 | Gets a type defined in the add-in | ||
4437 | </summary> | ||
4438 | <param name="typeName"> | ||
4439 | Full name of the type | ||
4440 | </param> | ||
4441 | <param name="throwIfNotFound"> | ||
4442 | Indicates whether the method should throw an exception if the type can't be found. | ||
4443 | </param> | ||
4444 | <returns> | ||
4445 | A <see cref="T:System.Type"/> | ||
4446 | </returns> | ||
4447 | <remarks> | ||
4448 | The type will be looked up in the assemblies that implement the add-in, | ||
4449 | and recursivelly in all add-ins on which it depends. | ||
4450 | |||
4451 | If the type can't be found, this method throw a InvalidOperationException if | ||
4452 | 'throwIfNotFound' is 'true', or 'null' otherwise. | ||
4453 | </remarks> | ||
4454 | </member> | ||
4455 | <member name="M:Mono.Addins.RuntimeAddin.CreateInstance(System.String)"> | ||
4456 | <summary> | ||
4457 | Creates an instance of a type defined in the add-in | ||
4458 | </summary> | ||
4459 | <param name="typeName"> | ||
4460 | Name of the type. | ||
4461 | </param> | ||
4462 | <returns> | ||
4463 | A new instance of the type | ||
4464 | </returns> | ||
4465 | <remarks> | ||
4466 | The type will be looked up in the assemblies that implement the add-in, | ||
4467 | and recursivelly in all add-ins on which it depends. | ||
4468 | |||
4469 | This method throws an InvalidOperationException if the type can't be found. | ||
4470 | |||
4471 | The specified type must have a default constructor. | ||
4472 | </remarks> | ||
4473 | </member> | ||
4474 | <member name="M:Mono.Addins.RuntimeAddin.CreateInstance(System.String,System.Boolean)"> | ||
4475 | <summary> | ||
4476 | Creates an instance of a type defined in the add-in | ||
4477 | </summary> | ||
4478 | <param name="typeName"> | ||
4479 | Name of the type. | ||
4480 | </param> | ||
4481 | <param name="throwIfNotFound"> | ||
4482 | Indicates whether the method should throw an exception if the type can't be found. | ||
4483 | </param> | ||
4484 | <returns> | ||
4485 | A new instance of the type | ||
4486 | </returns> | ||
4487 | <remarks> | ||
4488 | The type will be looked up in the assemblies that implement the add-in, | ||
4489 | and recursivelly in all add-ins on which it depends. | ||
4490 | |||
4491 | If the type can't be found, this method throw a InvalidOperationException if | ||
4492 | 'throwIfNotFound' is 'true', or 'null' otherwise. | ||
4493 | |||
4494 | The specified type must have a default constructor. | ||
4495 | </remarks> | ||
4496 | </member> | ||
4497 | <member name="M:Mono.Addins.RuntimeAddin.GetFilePath(System.String)"> | ||
4498 | <summary> | ||
4499 | Gets the path of an add-in file | ||
4500 | </summary> | ||
4501 | <param name="fileName"> | ||
4502 | Relative path of the file | ||
4503 | </param> | ||
4504 | <returns> | ||
4505 | Full path of the file | ||
4506 | </returns> | ||
4507 | <remarks> | ||
4508 | This method can be used to get the full path of a data file deployed together with the add-in. | ||
4509 | </remarks> | ||
4510 | </member> | ||
4511 | <member name="M:Mono.Addins.RuntimeAddin.GetFilePath(System.String[])"> | ||
4512 | <summary> | ||
4513 | Gets the path of an add-in file | ||
4514 | </summary> | ||
4515 | <param name="filePath"> | ||
4516 | Components of the file path | ||
4517 | </param> | ||
4518 | <returns> | ||
4519 | Full path of the file | ||
4520 | </returns> | ||
4521 | <remarks> | ||
4522 | This method can be used to get the full path of a data file deployed together with the add-in. | ||
4523 | </remarks> | ||
4524 | </member> | ||
4525 | <member name="M:Mono.Addins.RuntimeAddin.GetResource(System.String)"> | ||
4526 | <summary> | ||
4527 | Gets the content of a resource | ||
4528 | </summary> | ||
4529 | <param name="resourceName"> | ||
4530 | Name of the resource | ||
4531 | </param> | ||
4532 | <returns> | ||
4533 | Content of the resource, or null if not found | ||
4534 | </returns> | ||
4535 | <remarks> | ||
4536 | The add-in engine will look for resources in the main add-in assembly and in all included add-in assemblies. | ||
4537 | </remarks> | ||
4538 | </member> | ||
4539 | <member name="M:Mono.Addins.RuntimeAddin.GetResource(System.String,System.Boolean)"> | ||
4540 | <summary> | ||
4541 | Gets the content of a resource | ||
4542 | </summary> | ||
4543 | <param name="resourceName"> | ||
4544 | Name of the resource | ||
4545 | </param> | ||
4546 | <param name="throwIfNotFound"> | ||
4547 | When set to true, an exception will be thrown if the resource is not found. | ||
4548 | </param> | ||
4549 | <returns> | ||
4550 | Content of the resource. | ||
4551 | </returns> | ||
4552 | <remarks> | ||
4553 | The add-in engine will look for resources in the main add-in assembly and in all included add-in assemblies. | ||
4554 | </remarks> | ||
4555 | </member> | ||
4556 | <member name="P:Mono.Addins.RuntimeAddin.Id"> | ||
4557 | <summary> | ||
4558 | Identifier of the add-in. | ||
4559 | </summary> | ||
4560 | </member> | ||
4561 | <member name="P:Mono.Addins.RuntimeAddin.Version"> | ||
4562 | <summary> | ||
4563 | Version of the add-in. | ||
4564 | </summary> | ||
4565 | </member> | ||
4566 | <member name="P:Mono.Addins.RuntimeAddin.PrivateDataPath"> | ||
4567 | <summary> | ||
4568 | Path to a directory where add-ins can store private configuration or status data | ||
4569 | </summary> | ||
4570 | </member> | ||
4571 | <member name="P:Mono.Addins.RuntimeAddin.Localizer"> | ||
4572 | <summary> | ||
4573 | Localizer which can be used to localize strings defined in this add-in | ||
4574 | </summary> | ||
4575 | </member> | ||
4576 | <member name="T:Mono.Addins.ImportAddinAssemblyAttribute"> | ||
4577 | <summary> | ||
4578 | Declares an add-in assembly import | ||
4579 | </summary> | ||
4580 | <remarks> | ||
4581 | An add-in may be composed by several assemblies and data files. | ||
4582 | Assemblies must be declared in the main assembly using this attribute, or in the XML manifest. | ||
4583 | |||
4584 | It is important to properly declare all files used by an add-in. | ||
4585 | For example, when a type from the add-in is required (e.g. an ICommand implementation), | ||
4586 | only properly declared assemblies will be checked. | ||
4587 | This information is also used by setup tools to know exactly what needs to be packaged when creating | ||
4588 | an add-in package, or to know what needs to be deleted when removing an add-in. | ||
4589 | </remarks> | ||
4590 | </member> | ||
4591 | <member name="M:Mono.Addins.ImportAddinAssemblyAttribute.#ctor(System.String)"> | ||
4592 | <summary> | ||
4593 | Initializes a new instance | ||
4594 | </summary> | ||
4595 | <param name="filePath"> | ||
4596 | Path to the assembly. Must be relative to the assembly declaring this attribute. | ||
4597 | </param> | ||
4598 | </member> | ||
4599 | <member name="P:Mono.Addins.ImportAddinAssemblyAttribute.FilePath"> | ||
4600 | <summary> | ||
4601 | Path to the assembly. Must be relative to the assembly declaring this attribute. | ||
4602 | </summary> | ||
4603 | </member> | ||
4604 | <member name="P:Mono.Addins.ImportAddinAssemblyAttribute.Scan"> | ||
4605 | <summary> | ||
4606 | When set to true (the default), the included assembly will be scanned | ||
4607 | looking for extension point declarations. | ||
4608 | </summary> | ||
4609 | </member> | ||
4610 | <member name="T:Mono.Addins.AddinErrorEventHandler"> | ||
4611 | <summary> | ||
4612 | Delegate to be used in add-in error subscriptions | ||
4613 | </summary> | ||
4614 | </member> | ||
4615 | <member name="T:Mono.Addins.AddinErrorEventArgs"> | ||
4616 | <summary> | ||
4617 | Provides information about an add-in loading error. | ||
4618 | </summary> | ||
4619 | </member> | ||
4620 | <member name="M:Mono.Addins.AddinErrorEventArgs.#ctor(System.String,System.String,System.Exception)"> | ||
4621 | <summary> | ||
4622 | Initializes a new instance of the <see cref="T:Mono.Addins.AddinErrorEventArgs"/> class. | ||
4623 | </summary> | ||
4624 | <param name="message"> | ||
4625 | Error message | ||
4626 | </param> | ||
4627 | <param name="addinId"> | ||
4628 | Add-in identifier. | ||
4629 | </param> | ||
4630 | <param name="exception"> | ||
4631 | Exception that caused the error. | ||
4632 | </param> | ||
4633 | </member> | ||
4634 | <member name="P:Mono.Addins.AddinErrorEventArgs.Exception"> | ||
4635 | <summary> | ||
4636 | Exception that caused the error. | ||
4637 | </summary> | ||
4638 | </member> | ||
4639 | <member name="P:Mono.Addins.AddinErrorEventArgs.Message"> | ||
4640 | <summary> | ||
4641 | Error message | ||
4642 | </summary> | ||
4643 | </member> | ||
4644 | <member name="T:Mono.Addins.Addin"> | ||
4645 | <summary> | ||
4646 | An add-in. | ||
4647 | </summary> | ||
4648 | </member> | ||
4649 | <member name="M:Mono.Addins.Addin.SupportsVersion(System.String)"> | ||
4650 | <summary> | ||
4651 | Checks version compatibility. | ||
4652 | </summary> | ||
4653 | <param name="version"> | ||
4654 | An add-in version. | ||
4655 | </param> | ||
4656 | <returns> | ||
4657 | True if the provided version is compatible with this add-in. | ||
4658 | </returns> | ||
4659 | <remarks> | ||
4660 | This method checks the CompatVersion property to know if the provided version is compatible with the version of this add-in. | ||
4661 | </remarks> | ||
4662 | </member> | ||
4663 | <member name="M:Mono.Addins.Addin.ToString"> | ||
4664 | <summary> | ||
4665 | Returns a <see cref="T:System.String"/> that represents the current <see cref="T:Mono.Addins.Addin"/>. | ||
4666 | </summary> | ||
4667 | <returns> | ||
4668 | A <see cref="T:System.String"/> that represents the current <see cref="T:Mono.Addins.Addin"/>. | ||
4669 | </returns> | ||
4670 | </member> | ||
4671 | <member name="M:Mono.Addins.Addin.CompareVersions(System.String,System.String)"> | ||
4672 | <summary> | ||
4673 | Compares two add-in versions | ||
4674 | </summary> | ||
4675 | <returns> | ||
4676 | -1 if v1 is greater than v2, 0 if v1 == v2, 1 if v1 less than v2 | ||
4677 | </returns> | ||
4678 | <param name='v1'> | ||
4679 | A version | ||
4680 | </param> | ||
4681 | <param name='v2'> | ||
4682 | A version | ||
4683 | </param> | ||
4684 | </member> | ||
4685 | <member name="M:Mono.Addins.Addin.GetFullId(System.String,System.String,System.String)"> | ||
4686 | <summary> | ||
4687 | Returns the identifier of an add-in | ||
4688 | </summary> | ||
4689 | <returns> | ||
4690 | The full identifier. | ||
4691 | </returns> | ||
4692 | <param name='ns'> | ||
4693 | Namespace of the add-in | ||
4694 | </param> | ||
4695 | <param name='id'> | ||
4696 | Name of the add-in | ||
4697 | </param> | ||
4698 | <param name='version'> | ||
4699 | Version of the add-in | ||
4700 | </param> | ||
4701 | </member> | ||
4702 | <member name="M:Mono.Addins.Addin.GetIdName(System.String)"> | ||
4703 | <summary> | ||
4704 | Given a full add-in identifier, returns the namespace and name of the add-in (it removes the version number) | ||
4705 | </summary> | ||
4706 | <param name='addinId'> | ||
4707 | Add-in identifier. | ||
4708 | </param> | ||
4709 | </member> | ||
4710 | <member name="M:Mono.Addins.Addin.GetIdVersion(System.String)"> | ||
4711 | <summary> | ||
4712 | Given a full add-in identifier, returns the version the add-in | ||
4713 | </summary> | ||
4714 | <returns> | ||
4715 | The version. | ||
4716 | </returns> | ||
4717 | </member> | ||
4718 | <member name="M:Mono.Addins.Addin.GetIdParts(System.String,System.String@,System.String@)"> | ||
4719 | <summary> | ||
4720 | Splits a full add-in identifier in name and version | ||
4721 | </summary> | ||
4722 | <param name='addinId'> | ||
4723 | Add-in identifier. | ||
4724 | </param> | ||
4725 | <param name='name'> | ||
4726 | The resulting name | ||
4727 | </param> | ||
4728 | <param name='version'> | ||
4729 | The resulting version | ||
4730 | </param> | ||
4731 | </member> | ||
4732 | <member name="P:Mono.Addins.Addin.Id"> | ||
4733 | <summary> | ||
4734 | Full identifier of the add-in, including namespace and version. | ||
4735 | </summary> | ||
4736 | </member> | ||
4737 | <member name="P:Mono.Addins.Addin.Namespace"> | ||
4738 | <summary> | ||
4739 | Namespace of the add-in. | ||
4740 | </summary> | ||
4741 | </member> | ||
4742 | <member name="P:Mono.Addins.Addin.LocalId"> | ||
4743 | <summary> | ||
4744 | Identifier of the add-in (without namespace) | ||
4745 | </summary> | ||
4746 | </member> | ||
4747 | <member name="P:Mono.Addins.Addin.Version"> | ||
4748 | <summary> | ||
4749 | Version of the add-in | ||
4750 | </summary> | ||
4751 | </member> | ||
4752 | <member name="P:Mono.Addins.Addin.Name"> | ||
4753 | <summary> | ||
4754 | Display name of the add-in | ||
4755 | </summary> | ||
4756 | </member> | ||
4757 | <member name="P:Mono.Addins.Addin.Properties"> | ||
4758 | <summary> | ||
4759 | Custom properties specified in the add-in header | ||
4760 | </summary> | ||
4761 | </member> | ||
4762 | <member name="P:Mono.Addins.Addin.Enabled"> | ||
4763 | <summary> | ||
4764 | Gets or sets the enabled status of the add-in. | ||
4765 | </summary> | ||
4766 | <remarks> | ||
4767 | This property can be used to enable or disable an add-in. | ||
4768 | The enabled status of an add-in is stored in the add-in registry, | ||
4769 | so when an add-in is disabled, it will be disabled for all applications | ||
4770 | sharing the same registry. | ||
4771 | When an add-in is enabled or disabled, the extension points currently loaded | ||
4772 | in memory will be properly updated to include or exclude extensions from the add-in. | ||
4773 | </remarks> | ||
4774 | </member> | ||
4775 | <member name="P:Mono.Addins.Addin.IsUserAddin"> | ||
4776 | <summary> | ||
4777 | Returns 'true' if the add-in is installed in the user's personal folder | ||
4778 | </summary> | ||
4779 | </member> | ||
4780 | <member name="P:Mono.Addins.Addin.AddinFile"> | ||
4781 | <summary> | ||
4782 | Path to the add-in file (it can be an assembly or a standalone XML manifest) | ||
4783 | </summary> | ||
4784 | </member> | ||
4785 | <member name="P:Mono.Addins.Addin.Description"> | ||
4786 | <summary> | ||
4787 | Description of the add-in | ||
4788 | </summary> | ||
4789 | </member> | ||
4790 | <member name="T:Mono.Addins.Description.ConditionTypeDescriptionCollection"> | ||
4791 | <summary> | ||
4792 | A collection of condition types | ||
4793 | </summary> | ||
4794 | </member> | ||
4795 | <member name="M:Mono.Addins.Description.ConditionTypeDescriptionCollection.#ctor"> | ||
4796 | <summary> | ||
4797 | Initializes a new instance of the <see cref="T:Mono.Addins.Description.ConditionTypeDescriptionCollection"/> class. | ||
4798 | </summary> | ||
4799 | </member> | ||
4800 | <member name="P:Mono.Addins.Description.ConditionTypeDescriptionCollection.Item(System.Int32)"> | ||
4801 | <summary> | ||
4802 | Gets the <see cref="T:Mono.Addins.Description.ConditionTypeDescription"/> at the specified index. | ||
4803 | </summary> | ||
4804 | <param name="n"> | ||
4805 | Index. | ||
4806 | </param> | ||
4807 | <returns> | ||
4808 | The condition. | ||
4809 | </returns> | ||
4810 | </member> | ||
4811 | <member name="T:Mono.Addins.Description.ModuleCollection"> | ||
4812 | <summary> | ||
4813 | A collection of module descriptions | ||
4814 | </summary> | ||
4815 | </member> | ||
4816 | <member name="M:Mono.Addins.Description.ModuleCollection.#ctor"> | ||
4817 | <summary> | ||
4818 | Initializes a new instance of the <see cref="T:Mono.Addins.Description.ModuleCollection"/> class. | ||
4819 | </summary> | ||
4820 | </member> | ||
4821 | <member name="P:Mono.Addins.Description.ModuleCollection.Item(System.Int32)"> | ||
4822 | <summary> | ||
4823 | Gets the <see cref="T:Mono.Addins.Description.ModuleDescription"/> at the specified index. | ||
4824 | </summary> | ||
4825 | <param name="n"> | ||
4826 | The index. | ||
4827 | </param> | ||
4828 | </member> | ||
4829 | <member name="T:Mono.Addins.Description.NodeTypeAttributeCollection"> | ||
4830 | <summary> | ||
4831 | A collection of node attributes | ||
4832 | </summary> | ||
4833 | </member> | ||
4834 | <member name="M:Mono.Addins.Description.NodeTypeAttributeCollection.#ctor"> | ||
4835 | <summary> | ||
4836 | Initializes a new instance of the <see cref="T:Mono.Addins.Description.NodeTypeAttributeCollection"/> class. | ||
4837 | </summary> | ||
4838 | </member> | ||
4839 | <member name="P:Mono.Addins.Description.NodeTypeAttributeCollection.Item(System.Int32)"> | ||
4840 | <summary> | ||
4841 | Gets the <see cref="T:Mono.Addins.Description.NodeTypeAttribute"/> at the specified index. | ||
4842 | </summary> | ||
4843 | <param name="n"> | ||
4844 | The index. | ||
4845 | </param> | ||
4846 | </member> | ||
4847 | <member name="T:Mono.Addins.Description.AssemblyDependency"> | ||
4848 | <summary> | ||
4849 | Definition of a dependency of an add-in on an assembly. | ||
4850 | </summary> | ||
4851 | </member> | ||
4852 | <member name="M:Mono.Addins.Description.AssemblyDependency.#ctor"> | ||
4853 | <summary> | ||
4854 | Initializes a new instance of the <see cref="T:Mono.Addins.Description.AssemblyDependency"/> class. | ||
4855 | </summary> | ||
4856 | </member> | ||
4857 | <member name="P:Mono.Addins.Description.AssemblyDependency.FullName"> | ||
4858 | <summary> | ||
4859 | Gets or sets the full name of the assembly | ||
4860 | </summary> | ||
4861 | <value> | ||
4862 | The full name of the assembly. | ||
4863 | </value> | ||
4864 | </member> | ||
4865 | <member name="P:Mono.Addins.Description.AssemblyDependency.Package"> | ||
4866 | <summary> | ||
4867 | Gets or sets the name of the package that provides the assembly. | ||
4868 | </summary> | ||
4869 | <value> | ||
4870 | The name of the package that provides the assembly. | ||
4871 | </value> | ||
4872 | </member> | ||
4873 | <member name="P:Mono.Addins.Description.AssemblyDependency.Name"> | ||
4874 | <summary> | ||
4875 | Display name of the dependency | ||
4876 | </summary> | ||
4877 | <value> | ||
4878 | The name. | ||
4879 | </value> | ||
4880 | </member> | ||
4881 | <member name="T:Mono.Addins.AddinModuleAttribute"> | ||
4882 | <summary> | ||
4883 | Declares an optional add-in module | ||
4884 | </summary> | ||
4885 | </member> | ||
4886 | <member name="M:Mono.Addins.AddinModuleAttribute.#ctor(System.String)"> | ||
4887 | <summary> | ||
4888 | Initializes the instance. | ||
4889 | </summary> | ||
4890 | <param name="assemblyFile"> | ||
4891 | Relative path to the assembly that implements the optional module | ||
4892 | </param> | ||
4893 | </member> | ||
4894 | <member name="P:Mono.Addins.AddinModuleAttribute.AssemblyFile"> | ||
4895 | <summary> | ||
4896 | Relative path to the assembly that implements the optional module | ||
4897 | </summary> | ||
4898 | </member> | ||
4899 | <member name="T:Mono.Addins.AddinRegistry"> | ||
4900 | <summary> | ||
4901 | An add-in registry. | ||
4902 | </summary> | ||
4903 | <remarks> | ||
4904 | An add-in registry is a data structure used by the add-in engine to locate add-ins to load. | ||
4905 | |||
4906 | A registry can be configured to look for add-ins in several directories. However, add-ins | ||
4907 | copied to those directories won't be detected until an explicit add-in scan is requested. | ||
4908 | The registry can be updated by an application by calling Registry.Update(), or by a user by | ||
4909 | running the 'mautil' add-in setup tool. | ||
4910 | |||
4911 | The registry has information about the location of every add-in and a timestamp of the last | ||
4912 | check, so the Update method will only scan new or modified add-ins. An application can | ||
4913 | add a call to Registry.Update() in the Main method to detect all new add-ins every time the | ||
4914 | app is started. | ||
4915 | |||
4916 | Every add-in added to the registry is parsed and validated, and if there is any error it | ||
4917 | will be rejected. The registry is also in charge of scanning the add-in assemblies and look | ||
4918 | for extensions and other information declared using custom attributes. That information is | ||
4919 | merged with the manifest information (if there is one) to create a complete add-in | ||
4920 | description ready to be used at run-time. | ||
4921 | |||
4922 | Mono.Addins allows sharing an add-in registry among several applications. In this context, | ||
4923 | all applications sharing the registry share the same extension point model, and it is | ||
4924 | possible to implement add-ins which extend several hosts. | ||
4925 | </remarks> | ||
4926 | </member> | ||
4927 | <member name="M:Mono.Addins.AddinRegistry.#ctor(System.String)"> | ||
4928 | <summary> | ||
4929 | Initializes a new instance. | ||
4930 | </summary> | ||
4931 | <param name="registryPath"> | ||
4932 | Location of the add-in registry. | ||
4933 | </param> | ||
4934 | <remarks> | ||
4935 | Creates a new add-in registry located in the provided path. | ||
4936 | The add-in registry will look for add-ins in an 'addins' | ||
4937 | subdirectory of the provided registryPath. | ||
4938 | |||
4939 | When specifying a path, it is possible to use a special folder name as root. | ||
4940 | For example: [Personal]/.config/MyApp. In this case, [Personal] will be replaced | ||
4941 | by the location of the Environment.SpecialFolder.Personal folder. Any value | ||
4942 | of the Environment.SpecialFolder enumeration can be used (always between square | ||
4943 | brackets) | ||
4944 | </remarks> | ||
4945 | </member> | ||
4946 | <member name="M:Mono.Addins.AddinRegistry.#ctor(System.String,System.String)"> | ||
4947 | <summary> | ||
4948 | Initializes a new instance. | ||
4949 | </summary> | ||
4950 | <param name="registryPath"> | ||
4951 | Location of the add-in registry. | ||
4952 | </param> | ||
4953 | <param name="startupDirectory"> | ||
4954 | Location of the application. | ||
4955 | </param> | ||
4956 | <remarks> | ||
4957 | Creates a new add-in registry located in the provided path. | ||
4958 | The add-in registry will look for add-ins in an 'addins' | ||
4959 | subdirectory of the provided registryPath. | ||
4960 | |||
4961 | When specifying a path, it is possible to use a special folder name as root. | ||
4962 | For example: [Personal]/.config/MyApp. In this case, [Personal] will be replaced | ||
4963 | by the location of the Environment.SpecialFolder.Personal folder. Any value | ||
4964 | of the Environment.SpecialFolder enumeration can be used (always between square | ||
4965 | brackets) | ||
4966 | </remarks> | ||
4967 | </member> | ||
4968 | <member name="M:Mono.Addins.AddinRegistry.#ctor(System.String,System.String,System.String)"> | ||
4969 | <summary> | ||
4970 | Initializes a new instance of the <see cref="T:Mono.Addins.AddinRegistry"/> class. | ||
4971 | </summary> | ||
4972 | <param name="registryPath"> | ||
4973 | Location of the add-in registry. | ||
4974 | </param> | ||
4975 | <param name="startupDirectory"> | ||
4976 | Location of the application. | ||
4977 | </param> | ||
4978 | <param name="addinsDir"> | ||
4979 | Add-ins directory. If the path is relative, it is considered to be relative | ||
4980 | to the configDir directory. | ||
4981 | </param> | ||
4982 | <remarks> | ||
4983 | Creates a new add-in registry located in the provided path. | ||
4984 | Configuration information about the add-in registry will be stored in | ||
4985 | 'registryPath'. The add-in registry will look for add-ins in the provided | ||
4986 | 'addinsDir' directory. | ||
4987 | |||
4988 | When specifying a path, it is possible to use a special folder name as root. | ||
4989 | For example: [Personal]/.config/MyApp. In this case, [Personal] will be replaced | ||
4990 | by the location of the Environment.SpecialFolder.Personal folder. Any value | ||
4991 | of the Environment.SpecialFolder enumeration can be used (always between square | ||
4992 | brackets) | ||
4993 | </remarks> | ||
4994 | </member> | ||
4995 | <member name="M:Mono.Addins.AddinRegistry.#ctor(System.String,System.String,System.String,System.String)"> | ||
4996 | <summary> | ||
4997 | Initializes a new instance of the <see cref="T:Mono.Addins.AddinRegistry"/> class. | ||
4998 | </summary> | ||
4999 | <param name="registryPath"> | ||
5000 | Location of the add-in registry. | ||
5001 | </param> | ||
5002 | <param name="startupDirectory"> | ||
5003 | Location of the application. | ||
5004 | </param> | ||
5005 | <param name="addinsDir"> | ||
5006 | Add-ins directory. If the path is relative, it is considered to be relative | ||
5007 | to the configDir directory. | ||
5008 | </param> | ||
5009 | <param name="databaseDir"> | ||
5010 | Location of the add-in database. If the path is relative, it is considered to be relative | ||
5011 | to the configDir directory. | ||
5012 | </param> | ||
5013 | <remarks> | ||
5014 | Creates a new add-in registry located in the provided path. | ||
5015 | Configuration information about the add-in registry will be stored in | ||
5016 | 'registryPath'. The add-in registry will look for add-ins in the provided | ||
5017 | 'addinsDir' directory. Cached information about add-ins will be stored in | ||
5018 | the 'databaseDir' directory. | ||
5019 | |||
5020 | When specifying a path, it is possible to use a special folder name as root. | ||
5021 | For example: [Personal]/.config/MyApp. In this case, [Personal] will be replaced | ||
5022 | by the location of the Environment.SpecialFolder.Personal folder. Any value | ||
5023 | of the Environment.SpecialFolder enumeration can be used (always between square | ||
5024 | brackets) | ||
5025 | </remarks> | ||
5026 | </member> | ||
5027 | <member name="M:Mono.Addins.AddinRegistry.GetGlobalRegistry"> | ||
5028 | <summary> | ||
5029 | Gets the global registry. | ||
5030 | </summary> | ||
5031 | <returns> | ||
5032 | The global registry | ||
5033 | </returns> | ||
5034 | <remarks> | ||
5035 | The global add-in registry is created in "~/.config/mono.addins", | ||
5036 | and it is the default registry used when none is specified. | ||
5037 | </remarks> | ||
5038 | </member> | ||
5039 | <member name="M:Mono.Addins.AddinRegistry.Dispose"> | ||
5040 | <summary> | ||
5041 | Disposes the add-in engine. | ||
5042 | </summary> | ||
5043 | </member> | ||
5044 | <member name="M:Mono.Addins.AddinRegistry.GetAddin(System.String)"> | ||
5045 | <summary> | ||
5046 | Returns an add-in from the registry. | ||
5047 | </summary> | ||
5048 | <param name="id"> | ||
5049 | Identifier of the add-in. | ||
5050 | </param> | ||
5051 | <returns> | ||
5052 | The add-in, or 'null' if not found. | ||
5053 | </returns> | ||
5054 | <remarks> | ||
5055 | The add-in identifier may optionally include a version number, for example: "TextEditor.Xml,1.2" | ||
5056 | </remarks> | ||
5057 | </member> | ||
5058 | <member name="M:Mono.Addins.AddinRegistry.GetAddin(System.String,System.Boolean)"> | ||
5059 | <summary> | ||
5060 | Returns an add-in from the registry. | ||
5061 | </summary> | ||
5062 | <param name="id"> | ||
5063 | Identifier of the add-in. | ||
5064 | </param> | ||
5065 | <param name="exactVersionMatch"> | ||
5066 | 'true' if the exact add-in version must be found. | ||
5067 | </param> | ||
5068 | <returns> | ||
5069 | The add-in, or 'null' if not found. | ||
5070 | </returns> | ||
5071 | <remarks> | ||
5072 | The add-in identifier may optionally include a version number, for example: "TextEditor.Xml,1.2". | ||
5073 | In this case, if the exact version is not found and exactVersionMatch is 'false', it will | ||
5074 | return one than is compatible with the required version. | ||
5075 | </remarks> | ||
5076 | </member> | ||
5077 | <member name="M:Mono.Addins.AddinRegistry.GetModules(Mono.Addins.AddinSearchFlags)"> | ||
5078 | <summary> | ||
5079 | Gets all add-ins or add-in roots registered in the registry. | ||
5080 | </summary> | ||
5081 | <returns> | ||
5082 | The addins. | ||
5083 | </returns> | ||
5084 | <param name='flags'> | ||
5085 | Flags. | ||
5086 | </param> | ||
5087 | </member> | ||
5088 | <member name="M:Mono.Addins.AddinRegistry.GetAddins"> | ||
5089 | <summary> | ||
5090 | Gets all add-ins registered in the registry. | ||
5091 | </summary> | ||
5092 | <returns> | ||
5093 | Add-ins registered in the registry. | ||
5094 | </returns> | ||
5095 | </member> | ||
5096 | <member name="M:Mono.Addins.AddinRegistry.GetAddinRoots"> | ||
5097 | <summary> | ||
5098 | Gets all add-in roots registered in the registry. | ||
5099 | </summary> | ||
5100 | <returns> | ||
5101 | Descriptions of all add-in roots. | ||
5102 | </returns> | ||
5103 | </member> | ||
5104 | <member name="M:Mono.Addins.AddinRegistry.GetAddinDescription(Mono.Addins.IProgressStatus,System.String)"> | ||
5105 | <summary> | ||
5106 | Loads an add-in description | ||
5107 | </summary> | ||
5108 | <param name="progressStatus"> | ||
5109 | Progress tracker. | ||
5110 | </param> | ||
5111 | <param name="file"> | ||
5112 | Name of the file to load | ||
5113 | </param> | ||
5114 | <returns> | ||
5115 | An add-in description | ||
5116 | </returns> | ||
5117 | <remarks> | ||
5118 | This method loads an add-in description from a file. The file can be an XML manifest or an | ||
5119 | assembly that implements an add-in. | ||
5120 | </remarks> | ||
5121 | </member> | ||
5122 | <member name="M:Mono.Addins.AddinRegistry.ReadAddinManifestFile(System.String)"> | ||
5123 | <summary> | ||
5124 | Reads an XML add-in manifest | ||
5125 | </summary> | ||
5126 | <param name="file"> | ||
5127 | Path to the XML file | ||
5128 | </param> | ||
5129 | <returns> | ||
5130 | An add-in description | ||
5131 | </returns> | ||
5132 | </member> | ||
5133 | <member name="M:Mono.Addins.AddinRegistry.ReadAddinManifestFile(System.IO.TextReader,System.String)"> | ||
5134 | <summary> | ||
5135 | Reads an XML add-in manifest | ||
5136 | </summary> | ||
5137 | <param name="reader"> | ||
5138 | Reader that contains the XML | ||
5139 | </param> | ||
5140 | <param name="baseFile"> | ||
5141 | Base path to use to discover add-in files | ||
5142 | </param> | ||
5143 | <returns> | ||
5144 | An add-in description | ||
5145 | </returns> | ||
5146 | </member> | ||
5147 | <member name="M:Mono.Addins.AddinRegistry.IsAddinEnabled(System.String)"> | ||
5148 | <summary> | ||
5149 | Checks whether an add-in is enabled. | ||
5150 | </summary> | ||
5151 | <param name="id"> | ||
5152 | Identifier of the add-in. | ||
5153 | </param> | ||
5154 | <returns> | ||
5155 | 'true' if the add-in is enabled. | ||
5156 | </returns> | ||
5157 | </member> | ||
5158 | <member name="M:Mono.Addins.AddinRegistry.EnableAddin(System.String)"> | ||
5159 | <summary> | ||
5160 | Enables an add-in. | ||
5161 | </summary> | ||
5162 | <param name="id"> | ||
5163 | Identifier of the add-in | ||
5164 | </param> | ||
5165 | <remarks> | ||
5166 | If the enabled add-in depends on other add-ins which are disabled, | ||
5167 | those will automatically be enabled too. | ||
5168 | </remarks> | ||
5169 | </member> | ||
5170 | <member name="M:Mono.Addins.AddinRegistry.DisableAddin(System.String)"> | ||
5171 | <summary> | ||
5172 | Disables an add-in. | ||
5173 | </summary> | ||
5174 | <param name="id"> | ||
5175 | Identifier of the add-in. | ||
5176 | </param> | ||
5177 | <remarks> | ||
5178 | When an add-in is disabled, all extension points it defines will be ignored | ||
5179 | by the add-in engine. Other add-ins which depend on the disabled add-in will | ||
5180 | also automatically be disabled. | ||
5181 | </remarks> | ||
5182 | </member> | ||
5183 | <member name="M:Mono.Addins.AddinRegistry.RegisterForUninstall(System.String,System.Collections.Generic.IEnumerable{System.String})"> | ||
5184 | <summary> | ||
5185 | Registers a set of add-ins for uninstallation. | ||
5186 | </summary> | ||
5187 | <param name='id'> | ||
5188 | Identifier of the add-in | ||
5189 | </param> | ||
5190 | <param name='files'> | ||
5191 | Files to be uninstalled | ||
5192 | </param> | ||
5193 | <remarks> | ||
5194 | This method can be used to instruct the add-in manager to uninstall | ||
5195 | an add-in the next time the registry is updated. This is useful | ||
5196 | when an add-in manager can't delete an add-in because if it is | ||
5197 | loaded. | ||
5198 | </remarks> | ||
5199 | </member> | ||
5200 | <member name="M:Mono.Addins.AddinRegistry.IsRegisteredForUninstall(System.String)"> | ||
5201 | <summary> | ||
5202 | Determines whether an add-in is registered for uninstallation | ||
5203 | </summary> | ||
5204 | <returns> | ||
5205 | <c>true</c> if the add-in is registered for uninstallation | ||
5206 | </returns> | ||
5207 | <param name='addinId'> | ||
5208 | Identifier of the add-in | ||
5209 | </param> | ||
5210 | </member> | ||
5211 | <member name="M:Mono.Addins.AddinRegistry.DumpFile(System.String)"> | ||
5212 | <summary> | ||
5213 | Internal use only | ||
5214 | </summary> | ||
5215 | </member> | ||
5216 | <member name="M:Mono.Addins.AddinRegistry.ResetConfiguration"> | ||
5217 | <summary> | ||
5218 | Resets the configuration files of the registry | ||
5219 | </summary> | ||
5220 | </member> | ||
5221 | <member name="M:Mono.Addins.AddinRegistry.Update"> | ||
5222 | <summary> | ||
5223 | Updates the add-in registry. | ||
5224 | </summary> | ||
5225 | <remarks> | ||
5226 | This method must be called after modifying, installing or uninstalling add-ins. | ||
5227 | |||
5228 | When calling Update, every add-in added to the registry is parsed and validated, | ||
5229 | and if there is any error it will be rejected. It will also cache add-in information | ||
5230 | needed at run-time. | ||
5231 | |||
5232 | If during the update operation the registry finds new add-ins or detects that some | ||
5233 | add-ins have been deleted, the loaded extension points will be updated to include | ||
5234 | or exclude extension nodes from those add-ins. | ||
5235 | </remarks> | ||
5236 | </member> | ||
5237 | <member name="M:Mono.Addins.AddinRegistry.Update(Mono.Addins.IProgressStatus)"> | ||
5238 | <summary> | ||
5239 | Updates the add-in registry. | ||
5240 | </summary> | ||
5241 | <param name="monitor"> | ||
5242 | Progress monitor to keep track of the update operation. | ||
5243 | </param> | ||
5244 | <remarks> | ||
5245 | This method must be called after modifying, installing or uninstalling add-ins. | ||
5246 | |||
5247 | When calling Update, every add-in added to the registry is parsed and validated, | ||
5248 | and if there is any error it will be rejected. It will also cache add-in information | ||
5249 | needed at run-time. | ||
5250 | |||
5251 | If during the update operation the registry finds new add-ins or detects that some | ||
5252 | add-ins have been deleted, the loaded extension points will be updated to include | ||
5253 | or exclude extension nodes from those add-ins. | ||
5254 | </remarks> | ||
5255 | </member> | ||
5256 | <member name="M:Mono.Addins.AddinRegistry.Rebuild(Mono.Addins.IProgressStatus)"> | ||
5257 | <summary> | ||
5258 | Regenerates the cached data of the add-in registry. | ||
5259 | </summary> | ||
5260 | <param name="monitor"> | ||
5261 | Progress monitor to keep track of the rebuild operation. | ||
5262 | </param> | ||
5263 | </member> | ||
5264 | <member name="M:Mono.Addins.AddinRegistry.RegisterExtension(System.Object)"> | ||
5265 | <summary> | ||
5266 | Registers an extension. Only AddinFileSystemExtension extensions are supported right now. | ||
5267 | </summary> | ||
5268 | <param name='extension'> | ||
5269 | The extension to register | ||
5270 | </param> | ||
5271 | </member> | ||
5272 | <member name="M:Mono.Addins.AddinRegistry.UnregisterExtension(System.Object)"> | ||
5273 | <summary> | ||
5274 | Unregisters an extension. | ||
5275 | </summary> | ||
5276 | <param name='extension'> | ||
5277 | The extension to unregister | ||
5278 | </param> | ||
5279 | </member> | ||
5280 | <member name="P:Mono.Addins.AddinRegistry.RegistryPath"> | ||
5281 | <summary> | ||
5282 | Location of the add-in registry. | ||
5283 | </summary> | ||
5284 | </member> | ||
5285 | <member name="P:Mono.Addins.AddinRegistry.HasPendingUninstalls"> | ||
5286 | <summary> | ||
5287 | Gets a value indicating whether there are pending add-ins to be uninstalled installed | ||
5288 | </summary> | ||
5289 | </member> | ||
5290 | <member name="P:Mono.Addins.AddinRegistry.DefaultAddinsFolder"> | ||
5291 | <summary> | ||
5292 | Gets the default add-ins folder of the registry. | ||
5293 | </summary> | ||
5294 | <remarks> | ||
5295 | For every add-in registry there is an add-in folder where the registry will look for add-ins by default. | ||
5296 | This folder is an "addins" subdirectory of the directory where the repository is located. In most cases, | ||
5297 | this folder will only contain .addins files referencing other more convenient locations for add-ins. | ||
5298 | </remarks> | ||
5299 | </member> | ||
5300 | <member name="T:Mono.Addins.AddinSearchFlags"> | ||
5301 | <summary> | ||
5302 | Addin search flags. | ||
5303 | </summary> | ||
5304 | </member> | ||
5305 | <member name="F:Mono.Addins.AddinSearchFlags.IncludeAddins"> | ||
5306 | <summary> | ||
5307 | Add-ins are included in the search | ||
5308 | </summary> | ||
5309 | </member> | ||
5310 | <member name="F:Mono.Addins.AddinSearchFlags.IncludeRoots"> | ||
5311 | <summary> | ||
5312 | Add-in roots are included in the search | ||
5313 | </summary> | ||
5314 | </member> | ||
5315 | <member name="F:Mono.Addins.AddinSearchFlags.IncludeAll"> | ||
5316 | <summary> | ||
5317 | Both add-in and add-in roots are included in the search | ||
5318 | </summary> | ||
5319 | </member> | ||
5320 | <member name="F:Mono.Addins.AddinSearchFlags.LatestVersionsOnly"> | ||
5321 | <summary> | ||
5322 | Only the latest version of every add-in or add-in root is included in the search | ||
5323 | </summary> | ||
5324 | </member> | ||
5325 | <member name="T:Mono.Addins.ConsoleProgressStatus"> | ||
5326 | <summary> | ||
5327 | An IProgressStatus class which writes output to the console. | ||
5328 | </summary> | ||
5329 | </member> | ||
5330 | <member name="T:Mono.Addins.IProgressStatus"> | ||
5331 | <summary> | ||
5332 | Progress status listener. | ||
5333 | </summary> | ||
5334 | </member> | ||
5335 | <member name="M:Mono.Addins.IProgressStatus.SetMessage(System.String)"> | ||
5336 | <summary> | ||
5337 | Sets the description of the current operation. | ||
5338 | </summary> | ||
5339 | <param name="msg"> | ||
5340 | A message | ||
5341 | </param> | ||
5342 | <remarks> | ||
5343 | This method is called by the add-in engine to show a description of the operation being monitorized. | ||
5344 | </remarks> | ||
5345 | </member> | ||
5346 | <member name="M:Mono.Addins.IProgressStatus.SetProgress(System.Double)"> | ||
5347 | <summary> | ||
5348 | Sets the progress of the operation. | ||
5349 | </summary> | ||
5350 | <param name="progress"> | ||
5351 | A number between 0 and 1. 0 means no progress, 1 means operation completed. | ||
5352 | </param> | ||
5353 | <remarks> | ||
5354 | This method is called by the add-in engine to show the progress of the operation being monitorized. | ||
5355 | </remarks> | ||
5356 | </member> | ||
5357 | <member name="M:Mono.Addins.IProgressStatus.Log(System.String)"> | ||
5358 | <summary> | ||
5359 | Writes text to the log. | ||
5360 | </summary> | ||
5361 | <param name="msg"> | ||
5362 | Message to write | ||
5363 | </param> | ||
5364 | </member> | ||
5365 | <member name="M:Mono.Addins.IProgressStatus.ReportWarning(System.String)"> | ||
5366 | <summary> | ||
5367 | Reports a warning. | ||
5368 | </summary> | ||
5369 | <param name="message"> | ||
5370 | Warning message | ||
5371 | </param> | ||
5372 | <remarks> | ||
5373 | This method is called by the add-in engine to report a warning in the operation being monitorized. | ||
5374 | </remarks> | ||
5375 | </member> | ||
5376 | <member name="M:Mono.Addins.IProgressStatus.ReportError(System.String,System.Exception)"> | ||
5377 | <summary> | ||
5378 | Reports an error. | ||
5379 | </summary> | ||
5380 | <param name="message"> | ||
5381 | Error message | ||
5382 | </param> | ||
5383 | <param name="exception"> | ||
5384 | Exception that caused the error. It can be null. | ||
5385 | </param> | ||
5386 | <remarks> | ||
5387 | This method is called by the add-in engine to report an error occurred while executing the operation being monitorized. | ||
5388 | </remarks> | ||
5389 | </member> | ||
5390 | <member name="M:Mono.Addins.IProgressStatus.Cancel"> | ||
5391 | <summary> | ||
5392 | Cancels the operation being montorized. | ||
5393 | </summary> | ||
5394 | </member> | ||
5395 | <member name="P:Mono.Addins.IProgressStatus.LogLevel"> | ||
5396 | <summary> | ||
5397 | Log level requested by the user: 0: no log, 1: normal log, >1 verbose log | ||
5398 | </summary> | ||
5399 | </member> | ||
5400 | <member name="P:Mono.Addins.IProgressStatus.IsCanceled"> | ||
5401 | <summary> | ||
5402 | Returns True when the user requested to cancel this operation | ||
5403 | </summary> | ||
5404 | </member> | ||
5405 | <member name="M:Mono.Addins.ConsoleProgressStatus.#ctor(System.Boolean)"> | ||
5406 | <summary> | ||
5407 | Initializes a new instance | ||
5408 | </summary> | ||
5409 | <param name="verboseLog"> | ||
5410 | Set to true to enabled verbose log | ||
5411 | </param> | ||
5412 | </member> | ||
5413 | <member name="M:Mono.Addins.ConsoleProgressStatus.#ctor(System.Int32)"> | ||
5414 | <summary> | ||
5415 | Initializes a new instance | ||
5416 | </summary> | ||
5417 | <param name="logLevel"> | ||
5418 | Verbosity level. 0: not verbose, 1: normal, >1 extra verbose | ||
5419 | </param> | ||
5420 | </member> | ||
5421 | <member name="M:Mono.Addins.ConsoleProgressStatus.SetMessage(System.String)"> | ||
5422 | <summary> | ||
5423 | Sets the description of the current operation. | ||
5424 | </summary> | ||
5425 | <param name="msg"> | ||
5426 | A message | ||
5427 | </param> | ||
5428 | <remarks> | ||
5429 | This method is called by the add-in engine to show a description of the operation being monitorized. | ||
5430 | </remarks> | ||
5431 | </member> | ||
5432 | <member name="M:Mono.Addins.ConsoleProgressStatus.SetProgress(System.Double)"> | ||
5433 | <summary> | ||
5434 | Sets the progress of the operation. | ||
5435 | </summary> | ||
5436 | <param name="progress"> | ||
5437 | A number between 0 and 1. 0 means no progress, 1 means operation completed. | ||
5438 | </param> | ||
5439 | <remarks> | ||
5440 | This method is called by the add-in engine to show the progress of the operation being monitorized. | ||
5441 | </remarks> | ||
5442 | </member> | ||
5443 | <member name="M:Mono.Addins.ConsoleProgressStatus.Log(System.String)"> | ||
5444 | <summary> | ||
5445 | Writes text to the log. | ||
5446 | </summary> | ||
5447 | <param name="msg"> | ||
5448 | Message to write | ||
5449 | </param> | ||
5450 | </member> | ||
5451 | <member name="M:Mono.Addins.ConsoleProgressStatus.ReportWarning(System.String)"> | ||
5452 | <summary> | ||
5453 | Reports a warning. | ||
5454 | </summary> | ||
5455 | <param name="message"> | ||
5456 | Warning message | ||
5457 | </param> | ||
5458 | <remarks> | ||
5459 | This method is called by the add-in engine to report a warning in the operation being monitorized. | ||
5460 | </remarks> | ||
5461 | </member> | ||
5462 | <member name="M:Mono.Addins.ConsoleProgressStatus.ReportError(System.String,System.Exception)"> | ||
5463 | <summary> | ||
5464 | Reports an error. | ||
5465 | </summary> | ||
5466 | <param name="message"> | ||
5467 | Error message | ||
5468 | </param> | ||
5469 | <param name="exception"> | ||
5470 | Exception that caused the error. It can be null. | ||
5471 | </param> | ||
5472 | <remarks> | ||
5473 | This method is called by the add-in engine to report an error occurred while executing the operation being monitorized. | ||
5474 | </remarks> | ||
5475 | </member> | ||
5476 | <member name="M:Mono.Addins.ConsoleProgressStatus.Cancel"> | ||
5477 | <summary> | ||
5478 | Cancels the operation being montorized. | ||
5479 | </summary> | ||
5480 | </member> | ||
5481 | <member name="P:Mono.Addins.ConsoleProgressStatus.IsCanceled"> | ||
5482 | <summary> | ||
5483 | Returns True when the user requested to cancel this operation | ||
5484 | </summary> | ||
5485 | </member> | ||
5486 | <member name="P:Mono.Addins.ConsoleProgressStatus.LogLevel"> | ||
5487 | <summary> | ||
5488 | Log level requested by the user: 0: no log, 1: normal log, >1 verbose log | ||
5489 | </summary> | ||
5490 | </member> | ||
5491 | <member name="T:Mono.Addins.Description.AddinDependency"> | ||
5492 | <summary> | ||
5493 | Definition of a dependency of an add-in on another add-in. | ||
5494 | </summary> | ||
5495 | </member> | ||
5496 | <member name="M:Mono.Addins.Description.AddinDependency.#ctor"> | ||
5497 | <summary> | ||
5498 | Initializes a new instance of the <see cref="T:Mono.Addins.Description.AddinDependency"/> class. | ||
5499 | </summary> | ||
5500 | </member> | ||
5501 | <member name="M:Mono.Addins.Description.AddinDependency.#ctor(System.String)"> | ||
5502 | <summary> | ||
5503 | Initializes a new instance of the <see cref="T:Mono.Addins.Description.AddinDependency"/> class. | ||
5504 | </summary> | ||
5505 | <param name="fullId"> | ||
5506 | Full identifier of the add-in (includes version) | ||
5507 | </param> | ||
5508 | </member> | ||
5509 | <member name="M:Mono.Addins.Description.AddinDependency.#ctor(System.String,System.String)"> | ||
5510 | <summary> | ||
5511 | Initializes a new instance of the <see cref="T:Mono.Addins.Description.AddinDependency"/> class. | ||
5512 | </summary> | ||
5513 | <param name="id"> | ||
5514 | Identifier of the add-in. | ||
5515 | </param> | ||
5516 | <param name="version"> | ||
5517 | Version of the add-in. | ||
5518 | </param> | ||
5519 | </member> | ||
5520 | <member name="P:Mono.Addins.Description.AddinDependency.FullAddinId"> | ||
5521 | <summary> | ||
5522 | Gets the full addin identifier. | ||
5523 | </summary> | ||
5524 | <value> | ||
5525 | The full addin identifier. | ||
5526 | </value> | ||
5527 | <remarks> | ||
5528 | Includes namespace and version number. For example: MonoDevelop.TextEditor,1.0 | ||
5529 | </remarks> | ||
5530 | </member> | ||
5531 | <member name="P:Mono.Addins.Description.AddinDependency.AddinId"> | ||
5532 | <summary> | ||
5533 | Gets or sets the addin identifier. | ||
5534 | </summary> | ||
5535 | <value> | ||
5536 | The addin identifier. | ||
5537 | </value> | ||
5538 | </member> | ||
5539 | <member name="P:Mono.Addins.Description.AddinDependency.Version"> | ||
5540 | <summary> | ||
5541 | Gets or sets the version. | ||
5542 | </summary> | ||
5543 | <value> | ||
5544 | The version. | ||
5545 | </value> | ||
5546 | </member> | ||
5547 | <member name="P:Mono.Addins.Description.AddinDependency.Name"> | ||
5548 | <summary> | ||
5549 | Display name of the dependency. | ||
5550 | </summary> | ||
5551 | <value> | ||
5552 | The name. | ||
5553 | </value> | ||
5554 | </member> | ||
5555 | <member name="T:Mono.Addins.NodeAttributeAttribute"> | ||
5556 | <summary> | ||
5557 | Indicates that a field or property is bound to a node attribute | ||
5558 | </summary> | ||
5559 | </member> | ||
5560 | <member name="M:Mono.Addins.NodeAttributeAttribute.#ctor"> | ||
5561 | <summary> | ||
5562 | Initializes a new instance | ||
5563 | </summary> | ||
5564 | </member> | ||
5565 | <member name="M:Mono.Addins.NodeAttributeAttribute.#ctor(System.String)"> | ||
5566 | <summary> | ||
5567 | Initializes a new instance | ||
5568 | </summary> | ||
5569 | <param name="name"> | ||
5570 | XML name of the attribute. | ||
5571 | </param> | ||
5572 | </member> | ||
5573 | <member name="M:Mono.Addins.NodeAttributeAttribute.#ctor(System.String,System.String)"> | ||
5574 | <summary> | ||
5575 | Initializes a new instance | ||
5576 | </summary> | ||
5577 | <param name="name"> | ||
5578 | XML name of the attribute. | ||
5579 | </param> | ||
5580 | <param name="description"> | ||
5581 | Description of the attribute. | ||
5582 | </param> | ||
5583 | </member> | ||
5584 | <member name="M:Mono.Addins.NodeAttributeAttribute.#ctor(System.String,System.Boolean)"> | ||
5585 | <summary> | ||
5586 | Initializes a new instance | ||
5587 | </summary> | ||
5588 | <param name="name"> | ||
5589 | XML name of the attribute. | ||
5590 | </param> | ||
5591 | <param name="required"> | ||
5592 | Indicates whether the attribute is required or not. | ||
5593 | </param> | ||
5594 | </member> | ||
5595 | <member name="M:Mono.Addins.NodeAttributeAttribute.#ctor(System.String,System.Boolean,System.String)"> | ||
5596 | <summary> | ||
5597 | Initializes a new instance | ||
5598 | </summary> | ||
5599 | <param name="name"> | ||
5600 | XML name of the attribute. | ||
5601 | </param> | ||
5602 | <param name="required"> | ||
5603 | Indicates whether the attribute is required or not. | ||
5604 | </param> | ||
5605 | <param name="description"> | ||
5606 | Description of the attribute. | ||
5607 | </param> | ||
5608 | </member> | ||
5609 | <member name="M:Mono.Addins.NodeAttributeAttribute.#ctor(System.String,System.Type)"> | ||
5610 | <summary> | ||
5611 | Initializes a new instance | ||
5612 | </summary> | ||
5613 | <param name="name"> | ||
5614 | XML name of the attribute. | ||
5615 | </param> | ||
5616 | <param name="type"> | ||
5617 | Type of the extension node attribute. | ||
5618 | </param> | ||
5619 | <remarks> | ||
5620 | The type of the attribute is only required when applying this attribute at class level. | ||
5621 | It is not required when it is applied to a field, since the attribute type will be the type of the field. | ||
5622 | </remarks> | ||
5623 | </member> | ||
5624 | <member name="M:Mono.Addins.NodeAttributeAttribute.#ctor(System.String,System.Type,System.String)"> | ||
5625 | <summary> | ||
5626 | Initializes a new instance | ||
5627 | </summary> | ||
5628 | <param name="name"> | ||
5629 | XML name of the attribute. | ||
5630 | </param> | ||
5631 | <param name="type"> | ||
5632 | Type of the extension node attribute. | ||
5633 | </param> | ||
5634 | <param name="description"> | ||
5635 | Description of the attribute. | ||
5636 | </param> | ||
5637 | <remarks> | ||
5638 | The type of the attribute is only required when applying this attribute at class level. | ||
5639 | It is not required when it is applied to a field, since the attribute type will be the type of the field. | ||
5640 | </remarks> | ||
5641 | </member> | ||
5642 | <member name="M:Mono.Addins.NodeAttributeAttribute.#ctor(System.String,System.Type,System.Boolean)"> | ||
5643 | <summary> | ||
5644 | Initializes a new instance | ||
5645 | </summary> | ||
5646 | <param name="name"> | ||
5647 | XML name of the attribute. | ||
5648 | </param> | ||
5649 | <param name="type"> | ||
5650 | Type of the extension node attribute. | ||
5651 | </param> | ||
5652 | <param name="required"> | ||
5653 | Indicates whether the attribute is required or not. | ||
5654 | </param> | ||
5655 | <remarks> | ||
5656 | The type of the attribute is only required when applying this attribute at class level. | ||
5657 | It is not required when it is applied to a field, since the attribute type will be the type of the field. | ||
5658 | </remarks> | ||
5659 | </member> | ||
5660 | <member name="M:Mono.Addins.NodeAttributeAttribute.#ctor(System.String,System.Type,System.Boolean,System.String)"> | ||
5661 | <summary> | ||
5662 | Initializes a new instance | ||
5663 | </summary> | ||
5664 | <param name="name"> | ||
5665 | XML name of the attribute. | ||
5666 | </param> | ||
5667 | <param name="type"> | ||
5668 | Type of the extension node attribute. | ||
5669 | </param> | ||
5670 | <param name="required"> | ||
5671 | Indicates whether the attribute is required or not. | ||
5672 | </param> | ||
5673 | <param name="description"> | ||
5674 | Description of the attribute. | ||
5675 | </param> | ||
5676 | <remarks> | ||
5677 | The type of the attribute is only required when applying this attribute at class level. | ||
5678 | It is not required when it is applied to a field, since the attribute type will be the type of the field. | ||
5679 | </remarks> | ||
5680 | </member> | ||
5681 | <member name="P:Mono.Addins.NodeAttributeAttribute.Name"> | ||
5682 | <summary> | ||
5683 | XML name of the attribute. | ||
5684 | </summary> | ||
5685 | <remarks> | ||
5686 | If the name is not specified, the field name to which the [NodeAttribute] | ||
5687 | is applied will be used as name. Providing a name is mandatory when applying | ||
5688 | [NodeAttribute] at class level. | ||
5689 | </remarks> | ||
5690 | </member> | ||
5691 | <member name="P:Mono.Addins.NodeAttributeAttribute.Required"> | ||
5692 | <summary> | ||
5693 | Indicates whether the attribute is required or not. | ||
5694 | </summary> | ||
5695 | </member> | ||
5696 | <member name="P:Mono.Addins.NodeAttributeAttribute.Type"> | ||
5697 | <summary> | ||
5698 | Type of the extension node attribute. | ||
5699 | </summary> | ||
5700 | <remarks> | ||
5701 | To be used only when applying [NodeAttribute] at class level. It is not required when it | ||
5702 | is applied to a field, since the attribute type will be the type of the field. | ||
5703 | </remarks> | ||
5704 | </member> | ||
5705 | <member name="P:Mono.Addins.NodeAttributeAttribute.Description"> | ||
5706 | <summary> | ||
5707 | Description of the attribute. | ||
5708 | </summary> | ||
5709 | <remarks> | ||
5710 | To be used in the extension point documentation. | ||
5711 | </remarks> | ||
5712 | </member> | ||
5713 | <member name="P:Mono.Addins.NodeAttributeAttribute.Localizable"> | ||
5714 | <summary> | ||
5715 | When set to True, the value of the field or property is expected to be a string id which | ||
5716 | will be localized by the add-in engine | ||
5717 | </summary> | ||
5718 | </member> | ||
5719 | <member name="P:Mono.Addins.NodeAttributeAttribute.ContentType"> | ||
5720 | <summary> | ||
5721 | Gets or sets the type of the content. | ||
5722 | </summary> | ||
5723 | <remarks> | ||
5724 | Allows specifying the type of the content of a string attribute. | ||
5725 | This value is for documentation purposes only. | ||
5726 | </remarks> | ||
5727 | </member> | ||
5728 | <member name="T:Mono.Addins.Description.AddinPropertyCollection"> | ||
5729 | <summary> | ||
5730 | A collection of add-in properties | ||
5731 | </summary> | ||
5732 | </member> | ||
5733 | <member name="M:Mono.Addins.Description.AddinPropertyCollection.GetPropertyValue(System.String)"> | ||
5734 | <summary> | ||
5735 | Gets the value of a property | ||
5736 | </summary> | ||
5737 | <returns> | ||
5738 | The property value. | ||
5739 | </returns> | ||
5740 | <param name='name'> | ||
5741 | Name of the property. | ||
5742 | </param> | ||
5743 | <remarks> | ||
5744 | If the property is localized, it will return the value for the current language if exists, or the | ||
5745 | default value if it doesn't. | ||
5746 | </remarks> | ||
5747 | </member> | ||
5748 | <member name="M:Mono.Addins.Description.AddinPropertyCollection.GetPropertyValue(System.String,System.String)"> | ||
5749 | <summary> | ||
5750 | Gets the value of a property | ||
5751 | </summary> | ||
5752 | <returns> | ||
5753 | The property value. | ||
5754 | </returns> | ||
5755 | <param name='name'> | ||
5756 | Name of the property. | ||
5757 | </param> | ||
5758 | <param name='locale'> | ||
5759 | Locale for which the value must be returned. | ||
5760 | </param> | ||
5761 | </member> | ||
5762 | <member name="M:Mono.Addins.Description.AddinPropertyCollection.SetPropertyValue(System.String,System.String)"> | ||
5763 | <summary> | ||
5764 | Sets the value of a property | ||
5765 | </summary> | ||
5766 | <param name='name'> | ||
5767 | Name of the property | ||
5768 | </param> | ||
5769 | <param name='value'> | ||
5770 | New value. | ||
5771 | </param> | ||
5772 | </member> | ||
5773 | <member name="M:Mono.Addins.Description.AddinPropertyCollection.SetPropertyValue(System.String,System.String,System.String)"> | ||
5774 | <summary> | ||
5775 | Sets the value of a property for a specific locale | ||
5776 | </summary> | ||
5777 | <param name='name'> | ||
5778 | Name of the property. | ||
5779 | </param> | ||
5780 | <param name='value'> | ||
5781 | New value. | ||
5782 | </param> | ||
5783 | <param name='locale'> | ||
5784 | Locale of the property to be set. | ||
5785 | </param> | ||
5786 | </member> | ||
5787 | <member name="M:Mono.Addins.Description.AddinPropertyCollection.RemoveProperty(System.String)"> | ||
5788 | <summary> | ||
5789 | Removes a property. | ||
5790 | </summary> | ||
5791 | <param name='name'> | ||
5792 | Name of the property. | ||
5793 | </param> | ||
5794 | <remarks> | ||
5795 | This method only removes properties which have no locale set. | ||
5796 | </remarks> | ||
5797 | </member> | ||
5798 | <member name="M:Mono.Addins.Description.AddinPropertyCollection.RemoveProperty(System.String,System.String)"> | ||
5799 | <summary> | ||
5800 | Removes a property with a specified locale | ||
5801 | </summary> | ||
5802 | <param name='name'> | ||
5803 | Name of the property | ||
5804 | </param> | ||
5805 | <param name='locale'> | ||
5806 | Locale of the property | ||
5807 | </param> | ||
5808 | </member> | ||
5809 | <member name="T:Mono.Addins.ImportAddinFileAttribute"> | ||
5810 | <summary> | ||
5811 | Declares an add-in file import | ||
5812 | </summary> | ||
5813 | <remarks> | ||
5814 | An add-in may be composed by several assemblies and data files. | ||
5815 | Data files must be declared in the main assembly using this attribute, or in the XML manifest. | ||
5816 | |||
5817 | It is important to properly declare all files used by an add-in. | ||
5818 | This information is used by setup tools to know exactly what needs to be packaged when creating | ||
5819 | an add-in package, or to know what needs to be deleted when removing an add-in. | ||
5820 | </remarks> | ||
5821 | </member> | ||
5822 | <member name="M:Mono.Addins.ImportAddinFileAttribute.#ctor(System.String)"> | ||
5823 | <summary> | ||
5824 | Initializes a new instance | ||
5825 | </summary> | ||
5826 | <param name="filePath"> | ||
5827 | Path to the file. Must be relative to the assembly declaring this attribute. | ||
5828 | </param> | ||
5829 | </member> | ||
5830 | <member name="P:Mono.Addins.ImportAddinFileAttribute.FilePath"> | ||
5831 | <summary> | ||
5832 | Path to the file. Must be relative to the assembly declaring this attribute. | ||
5833 | </summary> | ||
5834 | </member> | ||
5835 | <member name="T:Mono.Addins.Description.NodeSetIdCollection"> | ||
5836 | <summary> | ||
5837 | A collection of node set identifiers | ||
5838 | </summary> | ||
5839 | </member> | ||
5840 | <member name="M:Mono.Addins.Description.NodeSetIdCollection.GetEnumerator"> | ||
5841 | <summary> | ||
5842 | Gets the collection enumerator. | ||
5843 | </summary> | ||
5844 | <returns> | ||
5845 | The enumerator. | ||
5846 | </returns> | ||
5847 | </member> | ||
5848 | <member name="M:Mono.Addins.Description.NodeSetIdCollection.Add(System.String)"> | ||
5849 | <summary> | ||
5850 | Add the specified node set identifier. | ||
5851 | </summary> | ||
5852 | <param name='nodeSetId'> | ||
5853 | Node set identifier. | ||
5854 | </param> | ||
5855 | </member> | ||
5856 | <member name="M:Mono.Addins.Description.NodeSetIdCollection.Remove(System.String)"> | ||
5857 | <summary> | ||
5858 | Remove a node set identifier | ||
5859 | </summary> | ||
5860 | <param name='nodeSetId'> | ||
5861 | Node set identifier. | ||
5862 | </param> | ||
5863 | </member> | ||
5864 | <member name="M:Mono.Addins.Description.NodeSetIdCollection.Clear"> | ||
5865 | <summary> | ||
5866 | Clears the collection | ||
5867 | </summary> | ||
5868 | </member> | ||
5869 | <member name="M:Mono.Addins.Description.NodeSetIdCollection.Contains(System.String)"> | ||
5870 | <summary> | ||
5871 | Checks if the specified identifier is present in the collection | ||
5872 | </summary> | ||
5873 | <param name='nodeSetId'> | ||
5874 | <c>true</c> if the node set identifier is present. | ||
5875 | </param> | ||
5876 | </member> | ||
5877 | <member name="M:Mono.Addins.Description.NodeSetIdCollection.IndexOf(System.String)"> | ||
5878 | <summary> | ||
5879 | Returns the index of the specified node set identifier | ||
5880 | </summary> | ||
5881 | <returns> | ||
5882 | The index. | ||
5883 | </returns> | ||
5884 | <param name='nodeSetId'> | ||
5885 | A node set identifier. | ||
5886 | </param> | ||
5887 | </member> | ||
5888 | <member name="P:Mono.Addins.Description.NodeSetIdCollection.Item(System.Int32)"> | ||
5889 | <summary> | ||
5890 | Gets the node set identifier at the specified index. | ||
5891 | </summary> | ||
5892 | <param name='n'> | ||
5893 | An index. | ||
5894 | </param> | ||
5895 | </member> | ||
5896 | <member name="P:Mono.Addins.Description.NodeSetIdCollection.Count"> | ||
5897 | <summary> | ||
5898 | Gets the item count. | ||
5899 | </summary> | ||
5900 | <value> | ||
5901 | The count. | ||
5902 | </value> | ||
5903 | </member> | ||
5904 | <member name="T:Mono.Addins.Description.ModuleDescription"> | ||
5905 | <summary> | ||
5906 | A module definition. | ||
5907 | </summary> | ||
5908 | <remarks> | ||
5909 | Optional modules can be used to declare extensions which will be registered only if some | ||
5910 | specified add-in dependencies can be satisfied. | ||
5911 | </remarks> | ||
5912 | </member> | ||
5913 | <member name="M:Mono.Addins.Description.ModuleDescription.#ctor"> | ||
5914 | <summary> | ||
5915 | Initializes a new instance of the <see cref="T:Mono.Addins.Description.ModuleDescription"/> class. | ||
5916 | </summary> | ||
5917 | </member> | ||
5918 | <member name="M:Mono.Addins.Description.ModuleDescription.DependsOnAddin(System.String)"> | ||
5919 | <summary> | ||
5920 | Checks if this module depends on the specified add-in. | ||
5921 | </summary> | ||
5922 | <returns> | ||
5923 | <c>true</c> if there is a dependency. | ||
5924 | </returns> | ||
5925 | <param name='addinId'> | ||
5926 | Identifier of the add-in | ||
5927 | </param> | ||
5928 | </member> | ||
5929 | <member name="M:Mono.Addins.Description.ModuleDescription.AddExtensionNode(System.String,System.String)"> | ||
5930 | <summary> | ||
5931 | Adds an extension node to the module. | ||
5932 | </summary> | ||
5933 | <returns> | ||
5934 | The extension node. | ||
5935 | </returns> | ||
5936 | <param name='path'> | ||
5937 | Path that identifies the extension point. | ||
5938 | </param> | ||
5939 | <param name='nodeName'> | ||
5940 | Node name. | ||
5941 | </param> | ||
5942 | <remarks> | ||
5943 | This method creates a new Extension object for the provided path if none exist. | ||
5944 | </remarks> | ||
5945 | </member> | ||
5946 | <member name="M:Mono.Addins.Description.ModuleDescription.GetExtension(System.String)"> | ||
5947 | <summary> | ||
5948 | Gets an extension instance. | ||
5949 | </summary> | ||
5950 | <returns> | ||
5951 | The extension instance. | ||
5952 | </returns> | ||
5953 | <param name='path'> | ||
5954 | Path that identifies the extension point that the extension extends. | ||
5955 | </param> | ||
5956 | <remarks> | ||
5957 | This method creates a new Extension object for the provided path if none exist. | ||
5958 | </remarks> | ||
5959 | </member> | ||
5960 | <member name="M:Mono.Addins.Description.ModuleDescription.AddAssemblyReference(System.String,System.String)"> | ||
5961 | <summary> | ||
5962 | Adds an add-in reference (there is a typo in the method name) | ||
5963 | </summary> | ||
5964 | <param name='id'> | ||
5965 | Identifier of the add-in. | ||
5966 | </param> | ||
5967 | <param name='version'> | ||
5968 | Version of the add-in. | ||
5969 | </param> | ||
5970 | </member> | ||
5971 | <member name="P:Mono.Addins.Description.ModuleDescription.IgnorePaths"> | ||
5972 | <summary> | ||
5973 | Gets the list of paths to be ignored by the add-in scanner. | ||
5974 | </summary> | ||
5975 | </member> | ||
5976 | <member name="P:Mono.Addins.Description.ModuleDescription.AllFiles"> | ||
5977 | <summary> | ||
5978 | Gets all external files | ||
5979 | </summary> | ||
5980 | <value> | ||
5981 | All files. | ||
5982 | </value> | ||
5983 | <remarks> | ||
5984 | External files are data files and assemblies explicitly referenced in the Runtime section of the add-in manifest. | ||
5985 | </remarks> | ||
5986 | </member> | ||
5987 | <member name="P:Mono.Addins.Description.ModuleDescription.Assemblies"> | ||
5988 | <summary> | ||
5989 | Gets the list of external assemblies used by this module. | ||
5990 | </summary> | ||
5991 | </member> | ||
5992 | <member name="P:Mono.Addins.Description.ModuleDescription.DataFiles"> | ||
5993 | <summary> | ||
5994 | Gets the list of external data files used by this module | ||
5995 | </summary> | ||
5996 | </member> | ||
5997 | <member name="P:Mono.Addins.Description.ModuleDescription.Dependencies"> | ||
5998 | <summary> | ||
5999 | Gets the dependencies of this module | ||
6000 | </summary> | ||
6001 | </member> | ||
6002 | <member name="P:Mono.Addins.Description.ModuleDescription.Extensions"> | ||
6003 | <summary> | ||
6004 | Gets the extensions of this module | ||
6005 | </summary> | ||
6006 | </member> | ||
6007 | <member name="T:Mono.Addins.AddinCategoryAttribute"> | ||
6008 | <summary> | ||
6009 | Addin category attribute. | ||
6010 | </summary> | ||
6011 | </member> | ||
6012 | <member name="M:Mono.Addins.AddinCategoryAttribute.#ctor(System.String)"> | ||
6013 | <summary> | ||
6014 | Initializes the attribute | ||
6015 | </summary> | ||
6016 | <param name="category"> | ||
6017 | The category to which the add-in belongs | ||
6018 | </param> | ||
6019 | </member> | ||
6020 | <member name="P:Mono.Addins.AddinCategoryAttribute.Category"> | ||
6021 | <summary> | ||
6022 | The category to which the add-in belongs | ||
6023 | </summary> | ||
6024 | </member> | ||
6025 | <member name="T:Mono.Addins.Description.ExtensionNodeTypeCollection"> | ||
6026 | <summary> | ||
6027 | A collection of node types. | ||
6028 | </summary> | ||
6029 | </member> | ||
6030 | <member name="M:Mono.Addins.Description.ExtensionNodeTypeCollection.#ctor"> | ||
6031 | <summary> | ||
6032 | Initializes a new instance of the <see cref="T:Mono.Addins.Description.ExtensionNodeTypeCollection"/> class. | ||
6033 | </summary> | ||
6034 | </member> | ||
6035 | <member name="P:Mono.Addins.Description.ExtensionNodeTypeCollection.Item(System.Int32)"> | ||
6036 | <summary> | ||
6037 | Gets the <see cref="T:Mono.Addins.Description.ExtensionNodeType"/> at the specified index. | ||
6038 | </summary> | ||
6039 | <param name="n"> | ||
6040 | The index. | ||
6041 | </param> | ||
6042 | </member> | ||
6043 | <member name="P:Mono.Addins.Description.ExtensionNodeTypeCollection.Item(System.String)"> | ||
6044 | <summary> | ||
6045 | Gets the <see cref="T:Mono.Addins.Description.ExtensionNodeType"/> with the specified id. | ||
6046 | </summary> | ||
6047 | <param name="id"> | ||
6048 | Identifier. | ||
6049 | </param> | ||
6050 | </member> | ||
6051 | <member name="T:Mono.Addins.Description.NodeTypeAttribute"> | ||
6052 | <summary> | ||
6053 | Description of the attribute of a node type. | ||
6054 | </summary> | ||
6055 | </member> | ||
6056 | <member name="M:Mono.Addins.Description.NodeTypeAttribute.#ctor"> | ||
6057 | <summary> | ||
6058 | Initializes a new instance of the <see cref="T:Mono.Addins.Description.NodeTypeAttribute"/> class. | ||
6059 | </summary> | ||
6060 | </member> | ||
6061 | <member name="M:Mono.Addins.Description.NodeTypeAttribute.CopyFrom(Mono.Addins.Description.NodeTypeAttribute)"> | ||
6062 | <summary> | ||
6063 | Copies data from another node attribute. | ||
6064 | </summary> | ||
6065 | <param name='att'> | ||
6066 | The attribute from which to copy. | ||
6067 | </param> | ||
6068 | </member> | ||
6069 | <member name="P:Mono.Addins.Description.NodeTypeAttribute.Name"> | ||
6070 | <summary> | ||
6071 | Gets or sets the name of the attribute. | ||
6072 | </summary> | ||
6073 | <value> | ||
6074 | The name. | ||
6075 | </value> | ||
6076 | </member> | ||
6077 | <member name="P:Mono.Addins.Description.NodeTypeAttribute.Required"> | ||
6078 | <summary> | ||
6079 | Gets or sets a value indicating whether this <see cref="T:Mono.Addins.Description.NodeTypeAttribute"/> is required. | ||
6080 | </summary> | ||
6081 | <value> | ||
6082 | <c>true</c> if required; otherwise, <c>false</c>. | ||
6083 | </value> | ||
6084 | </member> | ||
6085 | <member name="P:Mono.Addins.Description.NodeTypeAttribute.Localizable"> | ||
6086 | <summary> | ||
6087 | Gets or sets a value indicating whether this <see cref="T:Mono.Addins.Description.NodeTypeAttribute"/> is localizable. | ||
6088 | </summary> | ||
6089 | <value> | ||
6090 | <c>true</c> if localizable; otherwise, <c>false</c>. | ||
6091 | </value> | ||
6092 | </member> | ||
6093 | <member name="P:Mono.Addins.Description.NodeTypeAttribute.Type"> | ||
6094 | <summary> | ||
6095 | Gets or sets the type of the attribute. | ||
6096 | </summary> | ||
6097 | <value> | ||
6098 | The type. | ||
6099 | </value> | ||
6100 | </member> | ||
6101 | <member name="P:Mono.Addins.Description.NodeTypeAttribute.Description"> | ||
6102 | <summary> | ||
6103 | Gets or sets the description of the attribute. | ||
6104 | </summary> | ||
6105 | <value> | ||
6106 | The description. | ||
6107 | </value> | ||
6108 | </member> | ||
6109 | <member name="P:Mono.Addins.Description.NodeTypeAttribute.ContentType"> | ||
6110 | <summary> | ||
6111 | Gets or sets the type of the content. | ||
6112 | </summary> | ||
6113 | <remarks> | ||
6114 | Allows specifying the type of the content of a string attribute. | ||
6115 | The value of this property is only informative, and it doesn't | ||
6116 | have any effect on how add-ins are packaged or loaded. | ||
6117 | </remarks> | ||
6118 | </member> | ||
6119 | </members> | ||
6120 | </doc> | ||
diff --git a/bin/Mono.Cecil.dll b/bin/Mono.Cecil.dll new file mode 100644 index 0000000..122b0ec --- /dev/null +++ b/bin/Mono.Cecil.dll | |||
Binary files differ | |||
diff --git a/bin/NDesk.Options.dll b/bin/NDesk.Options.dll index df45878..23912c2 100755 --- a/bin/NDesk.Options.dll +++ b/bin/NDesk.Options.dll | |||
Binary files differ | |||
diff --git a/bin/Newtonsoft.Json.dll b/bin/Newtonsoft.Json.dll index 5931de1..2f28437 100644 --- a/bin/Newtonsoft.Json.dll +++ b/bin/Newtonsoft.Json.dll | |||
Binary files differ | |||
diff --git a/bin/Newtonsoft.Json.xml b/bin/Newtonsoft.Json.xml deleted file mode 100644 index 2a75b44..0000000 --- a/bin/Newtonsoft.Json.xml +++ /dev/null | |||
@@ -1,8626 +0,0 @@ | |||
1 | <?xml version="1.0"?> | ||
2 | <doc> | ||
3 | <assembly> | ||
4 | <name>Newtonsoft.Json</name> | ||
5 | </assembly> | ||
6 | <members> | ||
7 | <member name="T:Newtonsoft.Json.Bson.BsonReader"> | ||
8 | <summary> | ||
9 | Represents a reader that provides fast, non-cached, forward-only access to serialized Json data. | ||
10 | </summary> | ||
11 | </member> | ||
12 | <member name="T:Newtonsoft.Json.JsonReader"> | ||
13 | <summary> | ||
14 | Represents a reader that provides fast, non-cached, forward-only access to serialized Json data. | ||
15 | </summary> | ||
16 | </member> | ||
17 | <member name="M:Newtonsoft.Json.JsonReader.#ctor"> | ||
18 | <summary> | ||
19 | Initializes a new instance of the <see cref="T:Newtonsoft.Json.JsonReader"/> class with the specified <see cref="T:System.IO.TextReader"/>. | ||
20 | </summary> | ||
21 | </member> | ||
22 | <member name="M:Newtonsoft.Json.JsonReader.Read"> | ||
23 | <summary> | ||
24 | Reads the next JSON token from the stream. | ||
25 | </summary> | ||
26 | <returns>true if the next token was read successfully; false if there are no more tokens to read.</returns> | ||
27 | </member> | ||
28 | <member name="M:Newtonsoft.Json.JsonReader.ReadAsInt32"> | ||
29 | <summary> | ||
30 | Reads the next JSON token from the stream as a <see cref="T:System.Nullable`1"/>. | ||
31 | </summary> | ||
32 | <returns>A <see cref="T:System.Nullable`1"/>. This method will return <c>null</c> at the end of an array.</returns> | ||
33 | </member> | ||
34 | <member name="M:Newtonsoft.Json.JsonReader.ReadAsString"> | ||
35 | <summary> | ||
36 | Reads the next JSON token from the stream as a <see cref="T:System.String"/>. | ||
37 | </summary> | ||
38 | <returns>A <see cref="T:System.String"/>. This method will return <c>null</c> at the end of an array.</returns> | ||
39 | </member> | ||
40 | <member name="M:Newtonsoft.Json.JsonReader.ReadAsBytes"> | ||
41 | <summary> | ||
42 | Reads the next JSON token from the stream as a <see cref="T:Byte[]"/>. | ||
43 | </summary> | ||
44 | <returns>A <see cref="T:Byte[]"/> or a null reference if the next JSON token is null. This method will return <c>null</c> at the end of an array.</returns> | ||
45 | </member> | ||
46 | <member name="M:Newtonsoft.Json.JsonReader.ReadAsDecimal"> | ||
47 | <summary> | ||
48 | Reads the next JSON token from the stream as a <see cref="T:System.Nullable`1"/>. | ||
49 | </summary> | ||
50 | <returns>A <see cref="T:System.Nullable`1"/>. This method will return <c>null</c> at the end of an array.</returns> | ||
51 | </member> | ||
52 | <member name="M:Newtonsoft.Json.JsonReader.ReadAsDateTime"> | ||
53 | <summary> | ||
54 | Reads the next JSON token from the stream as a <see cref="T:System.Nullable`1"/>. | ||
55 | </summary> | ||
56 | <returns>A <see cref="T:System.String"/>. This method will return <c>null</c> at the end of an array.</returns> | ||
57 | </member> | ||
58 | <member name="M:Newtonsoft.Json.JsonReader.ReadAsDateTimeOffset"> | ||
59 | <summary> | ||
60 | Reads the next JSON token from the stream as a <see cref="T:System.Nullable`1"/>. | ||
61 | </summary> | ||
62 | <returns>A <see cref="T:System.Nullable`1"/>. This method will return <c>null</c> at the end of an array.</returns> | ||
63 | </member> | ||
64 | <member name="M:Newtonsoft.Json.JsonReader.Skip"> | ||
65 | <summary> | ||
66 | Skips the children of the current token. | ||
67 | </summary> | ||
68 | </member> | ||
69 | <member name="M:Newtonsoft.Json.JsonReader.SetToken(Newtonsoft.Json.JsonToken)"> | ||
70 | <summary> | ||
71 | Sets the current token. | ||
72 | </summary> | ||
73 | <param name="newToken">The new token.</param> | ||
74 | </member> | ||
75 | <member name="M:Newtonsoft.Json.JsonReader.SetToken(Newtonsoft.Json.JsonToken,System.Object)"> | ||
76 | <summary> | ||
77 | Sets the current token and value. | ||
78 | </summary> | ||
79 | <param name="newToken">The new token.</param> | ||
80 | <param name="value">The value.</param> | ||
81 | </member> | ||
82 | <member name="M:Newtonsoft.Json.JsonReader.SetStateBasedOnCurrent"> | ||
83 | <summary> | ||
84 | Sets the state based on current token type. | ||
85 | </summary> | ||
86 | </member> | ||
87 | <member name="M:Newtonsoft.Json.JsonReader.System#IDisposable#Dispose"> | ||
88 | <summary> | ||
89 | Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. | ||
90 | </summary> | ||
91 | </member> | ||
92 | <member name="M:Newtonsoft.Json.JsonReader.Dispose(System.Boolean)"> | ||
93 | <summary> | ||
94 | Releases unmanaged and - optionally - managed resources | ||
95 | </summary> | ||
96 | <param name="disposing"><c>true</c> to release both managed and unmanaged resources; <c>false</c> to release only unmanaged resources.</param> | ||
97 | </member> | ||
98 | <member name="M:Newtonsoft.Json.JsonReader.Close"> | ||
99 | <summary> | ||
100 | Changes the <see cref="T:Newtonsoft.Json.JsonReader.State"/> to Closed. | ||
101 | </summary> | ||
102 | </member> | ||
103 | <member name="P:Newtonsoft.Json.JsonReader.CurrentState"> | ||
104 | <summary> | ||
105 | Gets the current reader state. | ||
106 | </summary> | ||
107 | <value>The current reader state.</value> | ||
108 | </member> | ||
109 | <member name="P:Newtonsoft.Json.JsonReader.CloseInput"> | ||
110 | <summary> | ||
111 | Gets or sets a value indicating whether the underlying stream or | ||
112 | <see cref="T:System.IO.TextReader"/> should be closed when the reader is closed. | ||
113 | </summary> | ||
114 | <value> | ||
115 | true to close the underlying stream or <see cref="T:System.IO.TextReader"/> when | ||
116 | the reader is closed; otherwise false. The default is true. | ||
117 | </value> | ||
118 | </member> | ||
119 | <member name="P:Newtonsoft.Json.JsonReader.SupportMultipleContent"> | ||
120 | <summary> | ||
121 | Gets or sets a value indicating whether multiple pieces of JSON content can | ||
122 | be read from a continuous stream without erroring. | ||
123 | </summary> | ||
124 | <value> | ||
125 | true to support reading multiple pieces of JSON content; otherwise false. The default is false. | ||
126 | </value> | ||
127 | </member> | ||
128 | <member name="P:Newtonsoft.Json.JsonReader.QuoteChar"> | ||
129 | <summary> | ||
130 | Gets the quotation mark character used to enclose the value of a string. | ||
131 | </summary> | ||
132 | </member> | ||
133 | <member name="P:Newtonsoft.Json.JsonReader.DateTimeZoneHandling"> | ||
134 | <summary> | ||
135 | Get or set how <see cref="T:System.DateTime"/> time zones are handling when reading JSON. | ||
136 | </summary> | ||
137 | </member> | ||
138 | <member name="P:Newtonsoft.Json.JsonReader.DateParseHandling"> | ||
139 | <summary> | ||
140 | Get or set how date formatted strings, e.g. "\/Date(1198908717056)\/" and "2012-03-21T05:40Z", are parsed when reading JSON. | ||
141 | </summary> | ||
142 | </member> | ||
143 | <member name="P:Newtonsoft.Json.JsonReader.FloatParseHandling"> | ||
144 | <summary> | ||
145 | Get or set how floating point numbers, e.g. 1.0 and 9.9, are parsed when reading JSON text. | ||
146 | </summary> | ||
147 | </member> | ||
148 | <member name="P:Newtonsoft.Json.JsonReader.DateFormatString"> | ||
149 | <summary> | ||
150 | Get or set how custom date formatted strings are parsed when reading JSON. | ||
151 | </summary> | ||
152 | </member> | ||
153 | <member name="P:Newtonsoft.Json.JsonReader.MaxDepth"> | ||
154 | <summary> | ||
155 | Gets or sets the maximum depth allowed when reading JSON. Reading past this depth will throw a <see cref="T:Newtonsoft.Json.JsonReaderException"/>. | ||
156 | </summary> | ||
157 | </member> | ||
158 | <member name="P:Newtonsoft.Json.JsonReader.TokenType"> | ||
159 | <summary> | ||
160 | Gets the type of the current JSON token. | ||
161 | </summary> | ||
162 | </member> | ||
163 | <member name="P:Newtonsoft.Json.JsonReader.Value"> | ||
164 | <summary> | ||
165 | Gets the text value of the current JSON token. | ||
166 | </summary> | ||
167 | </member> | ||
168 | <member name="P:Newtonsoft.Json.JsonReader.ValueType"> | ||
169 | <summary> | ||
170 | Gets The Common Language Runtime (CLR) type for the current JSON token. | ||
171 | </summary> | ||
172 | </member> | ||
173 | <member name="P:Newtonsoft.Json.JsonReader.Depth"> | ||
174 | <summary> | ||
175 | Gets the depth of the current token in the JSON document. | ||
176 | </summary> | ||
177 | <value>The depth of the current token in the JSON document.</value> | ||
178 | </member> | ||
179 | <member name="P:Newtonsoft.Json.JsonReader.Path"> | ||
180 | <summary> | ||
181 | Gets the path of the current JSON token. | ||
182 | </summary> | ||
183 | </member> | ||
184 | <member name="P:Newtonsoft.Json.JsonReader.Culture"> | ||
185 | <summary> | ||
186 | Gets or sets the culture used when reading JSON. Defaults to <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>. | ||
187 | </summary> | ||
188 | </member> | ||
189 | <member name="T:Newtonsoft.Json.JsonReader.State"> | ||
190 | <summary> | ||
191 | Specifies the state of the reader. | ||
192 | </summary> | ||
193 | </member> | ||
194 | <member name="F:Newtonsoft.Json.JsonReader.State.Start"> | ||
195 | <summary> | ||
196 | The Read method has not been called. | ||
197 | </summary> | ||
198 | </member> | ||
199 | <member name="F:Newtonsoft.Json.JsonReader.State.Complete"> | ||
200 | <summary> | ||
201 | The end of the file has been reached successfully. | ||
202 | </summary> | ||
203 | </member> | ||
204 | <member name="F:Newtonsoft.Json.JsonReader.State.Property"> | ||
205 | <summary> | ||
206 | Reader is at a property. | ||
207 | </summary> | ||
208 | </member> | ||
209 | <member name="F:Newtonsoft.Json.JsonReader.State.ObjectStart"> | ||
210 | <summary> | ||
211 | Reader is at the start of an object. | ||
212 | </summary> | ||
213 | </member> | ||
214 | <member name="F:Newtonsoft.Json.JsonReader.State.Object"> | ||
215 | <summary> | ||
216 | Reader is in an object. | ||
217 | </summary> | ||
218 | </member> | ||
219 | <member name="F:Newtonsoft.Json.JsonReader.State.ArrayStart"> | ||
220 | <summary> | ||
221 | Reader is at the start of an array. | ||
222 | </summary> | ||
223 | </member> | ||
224 | <member name="F:Newtonsoft.Json.JsonReader.State.Array"> | ||
225 | <summary> | ||
226 | Reader is in an array. | ||
227 | </summary> | ||
228 | </member> | ||
229 | <member name="F:Newtonsoft.Json.JsonReader.State.Closed"> | ||
230 | <summary> | ||
231 | The Close method has been called. | ||
232 | </summary> | ||
233 | </member> | ||
234 | <member name="F:Newtonsoft.Json.JsonReader.State.PostValue"> | ||
235 | <summary> | ||
236 | Reader has just read a value. | ||
237 | </summary> | ||
238 | </member> | ||
239 | <member name="F:Newtonsoft.Json.JsonReader.State.ConstructorStart"> | ||
240 | <summary> | ||
241 | Reader is at the start of a constructor. | ||
242 | </summary> | ||
243 | </member> | ||
244 | <member name="F:Newtonsoft.Json.JsonReader.State.Constructor"> | ||
245 | <summary> | ||
246 | Reader in a constructor. | ||
247 | </summary> | ||
248 | </member> | ||
249 | <member name="F:Newtonsoft.Json.JsonReader.State.Error"> | ||
250 | <summary> | ||
251 | An error occurred that prevents the read operation from continuing. | ||
252 | </summary> | ||
253 | </member> | ||
254 | <member name="F:Newtonsoft.Json.JsonReader.State.Finished"> | ||
255 | <summary> | ||
256 | The end of the file has been reached successfully. | ||
257 | </summary> | ||
258 | </member> | ||
259 | <member name="M:Newtonsoft.Json.Bson.BsonReader.#ctor(System.IO.Stream)"> | ||
260 | <summary> | ||
261 | Initializes a new instance of the <see cref="T:Newtonsoft.Json.Bson.BsonReader"/> class. | ||
262 | </summary> | ||
263 | <param name="stream">The stream.</param> | ||
264 | </member> | ||
265 | <member name="M:Newtonsoft.Json.Bson.BsonReader.#ctor(System.IO.BinaryReader)"> | ||
266 | <summary> | ||
267 | Initializes a new instance of the <see cref="T:Newtonsoft.Json.Bson.BsonReader"/> class. | ||
268 | </summary> | ||
269 | <param name="reader">The reader.</param> | ||
270 | </member> | ||
271 | <member name="M:Newtonsoft.Json.Bson.BsonReader.#ctor(System.IO.Stream,System.Boolean,System.DateTimeKind)"> | ||
272 | <summary> | ||
273 | Initializes a new instance of the <see cref="T:Newtonsoft.Json.Bson.BsonReader"/> class. | ||
274 | </summary> | ||
275 | <param name="stream">The stream.</param> | ||
276 | <param name="readRootValueAsArray">if set to <c>true</c> the root object will be read as a JSON array.</param> | ||
277 | <param name="dateTimeKindHandling">The <see cref="T:System.DateTimeKind"/> used when reading <see cref="T:System.DateTime"/> values from BSON.</param> | ||
278 | </member> | ||
279 | <member name="M:Newtonsoft.Json.Bson.BsonReader.#ctor(System.IO.BinaryReader,System.Boolean,System.DateTimeKind)"> | ||
280 | <summary> | ||
281 | Initializes a new instance of the <see cref="T:Newtonsoft.Json.Bson.BsonReader"/> class. | ||
282 | </summary> | ||
283 | <param name="reader">The reader.</param> | ||
284 | <param name="readRootValueAsArray">if set to <c>true</c> the root object will be read as a JSON array.</param> | ||
285 | <param name="dateTimeKindHandling">The <see cref="T:System.DateTimeKind"/> used when reading <see cref="T:System.DateTime"/> values from BSON.</param> | ||
286 | </member> | ||
287 | <member name="M:Newtonsoft.Json.Bson.BsonReader.ReadAsBytes"> | ||
288 | <summary> | ||
289 | Reads the next JSON token from the stream as a <see cref="T:Byte[]"/>. | ||
290 | </summary> | ||
291 | <returns> | ||
292 | A <see cref="T:Byte[]"/> or a null reference if the next JSON token is null. This method will return <c>null</c> at the end of an array. | ||
293 | </returns> | ||
294 | </member> | ||
295 | <member name="M:Newtonsoft.Json.Bson.BsonReader.ReadAsDecimal"> | ||
296 | <summary> | ||
297 | Reads the next JSON token from the stream as a <see cref="T:System.Nullable`1"/>. | ||
298 | </summary> | ||
299 | <returns>A <see cref="T:System.Nullable`1"/>. This method will return <c>null</c> at the end of an array.</returns> | ||
300 | </member> | ||
301 | <member name="M:Newtonsoft.Json.Bson.BsonReader.ReadAsInt32"> | ||
302 | <summary> | ||
303 | Reads the next JSON token from the stream as a <see cref="T:System.Nullable`1"/>. | ||
304 | </summary> | ||
305 | <returns>A <see cref="T:System.Nullable`1"/>. This method will return <c>null</c> at the end of an array.</returns> | ||
306 | </member> | ||
307 | <member name="M:Newtonsoft.Json.Bson.BsonReader.ReadAsString"> | ||
308 | <summary> | ||
309 | Reads the next JSON token from the stream as a <see cref="T:System.String"/>. | ||
310 | </summary> | ||
311 | <returns>A <see cref="T:System.String"/>. This method will return <c>null</c> at the end of an array.</returns> | ||
312 | </member> | ||
313 | <member name="M:Newtonsoft.Json.Bson.BsonReader.ReadAsDateTime"> | ||
314 | <summary> | ||
315 | Reads the next JSON token from the stream as a <see cref="T:System.Nullable`1"/>. | ||
316 | </summary> | ||
317 | <returns>A <see cref="T:System.String"/>. This method will return <c>null</c> at the end of an array.</returns> | ||
318 | </member> | ||
319 | <member name="M:Newtonsoft.Json.Bson.BsonReader.ReadAsDateTimeOffset"> | ||
320 | <summary> | ||
321 | Reads the next JSON token from the stream as a <see cref="T:System.Nullable`1"/>. | ||
322 | </summary> | ||
323 | <returns> | ||
324 | A <see cref="T:System.Nullable`1"/>. This method will return <c>null</c> at the end of an array. | ||
325 | </returns> | ||
326 | </member> | ||
327 | <member name="M:Newtonsoft.Json.Bson.BsonReader.Read"> | ||
328 | <summary> | ||
329 | Reads the next JSON token from the stream. | ||
330 | </summary> | ||
331 | <returns> | ||
332 | true if the next token was read successfully; false if there are no more tokens to read. | ||
333 | </returns> | ||
334 | </member> | ||
335 | <member name="M:Newtonsoft.Json.Bson.BsonReader.Close"> | ||
336 | <summary> | ||
337 | Changes the <see cref="T:Newtonsoft.Json.JsonReader.State"/> to Closed. | ||
338 | </summary> | ||
339 | </member> | ||
340 | <member name="P:Newtonsoft.Json.Bson.BsonReader.JsonNet35BinaryCompatibility"> | ||
341 | <summary> | ||
342 | Gets or sets a value indicating whether binary data reading should compatible with incorrect Json.NET 3.5 written binary. | ||
343 | </summary> | ||
344 | <value> | ||
345 | <c>true</c> if binary data reading will be compatible with incorrect Json.NET 3.5 written binary; otherwise, <c>false</c>. | ||
346 | </value> | ||
347 | </member> | ||
348 | <member name="P:Newtonsoft.Json.Bson.BsonReader.ReadRootValueAsArray"> | ||
349 | <summary> | ||
350 | Gets or sets a value indicating whether the root object will be read as a JSON array. | ||
351 | </summary> | ||
352 | <value> | ||
353 | <c>true</c> if the root object will be read as a JSON array; otherwise, <c>false</c>. | ||
354 | </value> | ||
355 | </member> | ||
356 | <member name="P:Newtonsoft.Json.Bson.BsonReader.DateTimeKindHandling"> | ||
357 | <summary> | ||
358 | Gets or sets the <see cref="T:System.DateTimeKind"/> used when reading <see cref="T:System.DateTime"/> values from BSON. | ||
359 | </summary> | ||
360 | <value>The <see cref="T:System.DateTimeKind"/> used when reading <see cref="T:System.DateTime"/> values from BSON.</value> | ||
361 | </member> | ||
362 | <member name="T:Newtonsoft.Json.Bson.BsonWriter"> | ||
363 | <summary> | ||
364 | Represents a writer that provides a fast, non-cached, forward-only way of generating JSON data. | ||
365 | </summary> | ||
366 | </member> | ||
367 | <member name="T:Newtonsoft.Json.JsonWriter"> | ||
368 | <summary> | ||
369 | Represents a writer that provides a fast, non-cached, forward-only way of generating Json data. | ||
370 | </summary> | ||
371 | </member> | ||
372 | <member name="M:Newtonsoft.Json.JsonWriter.#ctor"> | ||
373 | <summary> | ||
374 | Creates an instance of the <c>JsonWriter</c> class. | ||
375 | </summary> | ||
376 | </member> | ||
377 | <member name="M:Newtonsoft.Json.JsonWriter.Flush"> | ||
378 | <summary> | ||
379 | Flushes whatever is in the buffer to the underlying streams and also flushes the underlying stream. | ||
380 | </summary> | ||
381 | </member> | ||
382 | <member name="M:Newtonsoft.Json.JsonWriter.Close"> | ||
383 | <summary> | ||
384 | Closes this stream and the underlying stream. | ||
385 | </summary> | ||
386 | </member> | ||
387 | <member name="M:Newtonsoft.Json.JsonWriter.WriteStartObject"> | ||
388 | <summary> | ||
389 | Writes the beginning of a Json object. | ||
390 | </summary> | ||
391 | </member> | ||
392 | <member name="M:Newtonsoft.Json.JsonWriter.WriteEndObject"> | ||
393 | <summary> | ||
394 | Writes the end of a Json object. | ||
395 | </summary> | ||
396 | </member> | ||
397 | <member name="M:Newtonsoft.Json.JsonWriter.WriteStartArray"> | ||
398 | <summary> | ||
399 | Writes the beginning of a Json array. | ||
400 | </summary> | ||
401 | </member> | ||
402 | <member name="M:Newtonsoft.Json.JsonWriter.WriteEndArray"> | ||
403 | <summary> | ||
404 | Writes the end of an array. | ||
405 | </summary> | ||
406 | </member> | ||
407 | <member name="M:Newtonsoft.Json.JsonWriter.WriteStartConstructor(System.String)"> | ||
408 | <summary> | ||
409 | Writes the start of a constructor with the given name. | ||
410 | </summary> | ||
411 | <param name="name">The name of the constructor.</param> | ||
412 | </member> | ||
413 | <member name="M:Newtonsoft.Json.JsonWriter.WriteEndConstructor"> | ||
414 | <summary> | ||
415 | Writes the end constructor. | ||
416 | </summary> | ||
417 | </member> | ||
418 | <member name="M:Newtonsoft.Json.JsonWriter.WritePropertyName(System.String)"> | ||
419 | <summary> | ||
420 | Writes the property name of a name/value pair on a JSON object. | ||
421 | </summary> | ||
422 | <param name="name">The name of the property.</param> | ||
423 | </member> | ||
424 | <member name="M:Newtonsoft.Json.JsonWriter.WritePropertyName(System.String,System.Boolean)"> | ||
425 | <summary> | ||
426 | Writes the property name of a name/value pair on a JSON object. | ||
427 | </summary> | ||
428 | <param name="name">The name of the property.</param> | ||
429 | <param name="escape">A flag to indicate whether the text should be escaped when it is written as a JSON property name.</param> | ||
430 | </member> | ||
431 | <member name="M:Newtonsoft.Json.JsonWriter.WriteEnd"> | ||
432 | <summary> | ||
433 | Writes the end of the current Json object or array. | ||
434 | </summary> | ||
435 | </member> | ||
436 | <member name="M:Newtonsoft.Json.JsonWriter.WriteToken(Newtonsoft.Json.JsonReader)"> | ||
437 | <summary> | ||
438 | Writes the current <see cref="T:Newtonsoft.Json.JsonReader"/> token and its children. | ||
439 | </summary> | ||
440 | <param name="reader">The <see cref="T:Newtonsoft.Json.JsonReader"/> to read the token from.</param> | ||
441 | </member> | ||
442 | <member name="M:Newtonsoft.Json.JsonWriter.WriteToken(Newtonsoft.Json.JsonReader,System.Boolean)"> | ||
443 | <summary> | ||
444 | Writes the current <see cref="T:Newtonsoft.Json.JsonReader"/> token. | ||
445 | </summary> | ||
446 | <param name="reader">The <see cref="T:Newtonsoft.Json.JsonReader"/> to read the token from.</param> | ||
447 | <param name="writeChildren">A flag indicating whether the current token's children should be written.</param> | ||
448 | </member> | ||
449 | <member name="M:Newtonsoft.Json.JsonWriter.WriteEnd(Newtonsoft.Json.JsonToken)"> | ||
450 | <summary> | ||
451 | Writes the specified end token. | ||
452 | </summary> | ||
453 | <param name="token">The end token to write.</param> | ||
454 | </member> | ||
455 | <member name="M:Newtonsoft.Json.JsonWriter.WriteIndent"> | ||
456 | <summary> | ||
457 | Writes indent characters. | ||
458 | </summary> | ||
459 | </member> | ||
460 | <member name="M:Newtonsoft.Json.JsonWriter.WriteValueDelimiter"> | ||
461 | <summary> | ||
462 | Writes the JSON value delimiter. | ||
463 | </summary> | ||
464 | </member> | ||
465 | <member name="M:Newtonsoft.Json.JsonWriter.WriteIndentSpace"> | ||
466 | <summary> | ||
467 | Writes an indent space. | ||
468 | </summary> | ||
469 | </member> | ||
470 | <member name="M:Newtonsoft.Json.JsonWriter.WriteNull"> | ||
471 | <summary> | ||
472 | Writes a null value. | ||
473 | </summary> | ||
474 | </member> | ||
475 | <member name="M:Newtonsoft.Json.JsonWriter.WriteUndefined"> | ||
476 | <summary> | ||
477 | Writes an undefined value. | ||
478 | </summary> | ||
479 | </member> | ||
480 | <member name="M:Newtonsoft.Json.JsonWriter.WriteRaw(System.String)"> | ||
481 | <summary> | ||
482 | Writes raw JSON without changing the writer's state. | ||
483 | </summary> | ||
484 | <param name="json">The raw JSON to write.</param> | ||
485 | </member> | ||
486 | <member name="M:Newtonsoft.Json.JsonWriter.WriteRawValue(System.String)"> | ||
487 | <summary> | ||
488 | Writes raw JSON where a value is expected and updates the writer's state. | ||
489 | </summary> | ||
490 | <param name="json">The raw JSON to write.</param> | ||
491 | </member> | ||
492 | <member name="M:Newtonsoft.Json.JsonWriter.WriteValue(System.String)"> | ||
493 | <summary> | ||
494 | Writes a <see cref="T:System.String"/> value. | ||
495 | </summary> | ||
496 | <param name="value">The <see cref="T:System.String"/> value to write.</param> | ||
497 | </member> | ||
498 | <member name="M:Newtonsoft.Json.JsonWriter.WriteValue(System.Int32)"> | ||
499 | <summary> | ||
500 | Writes a <see cref="T:System.Int32"/> value. | ||
501 | </summary> | ||
502 | <param name="value">The <see cref="T:System.Int32"/> value to write.</param> | ||
503 | </member> | ||
504 | <member name="M:Newtonsoft.Json.JsonWriter.WriteValue(System.UInt32)"> | ||
505 | <summary> | ||
506 | Writes a <see cref="T:System.UInt32"/> value. | ||
507 | </summary> | ||
508 | <param name="value">The <see cref="T:System.UInt32"/> value to write.</param> | ||
509 | </member> | ||
510 | <member name="M:Newtonsoft.Json.JsonWriter.WriteValue(System.Int64)"> | ||
511 | <summary> | ||
512 | Writes a <see cref="T:System.Int64"/> value. | ||
513 | </summary> | ||
514 | <param name="value">The <see cref="T:System.Int64"/> value to write.</param> | ||
515 | </member> | ||
516 | <member name="M:Newtonsoft.Json.JsonWriter.WriteValue(System.UInt64)"> | ||
517 | <summary> | ||
518 | Writes a <see cref="T:System.UInt64"/> value. | ||
519 | </summary> | ||
520 | <param name="value">The <see cref="T:System.UInt64"/> value to write.</param> | ||
521 | </member> | ||
522 | <member name="M:Newtonsoft.Json.JsonWriter.WriteValue(System.Single)"> | ||
523 | <summary> | ||
524 | Writes a <see cref="T:System.Single"/> value. | ||
525 | </summary> | ||
526 | <param name="value">The <see cref="T:System.Single"/> value to write.</param> | ||
527 | </member> | ||
528 | <member name="M:Newtonsoft.Json.JsonWriter.WriteValue(System.Double)"> | ||
529 | <summary> | ||
530 | Writes a <see cref="T:System.Double"/> value. | ||
531 | </summary> | ||
532 | <param name="value">The <see cref="T:System.Double"/> value to write.</param> | ||
533 | </member> | ||
534 | <member name="M:Newtonsoft.Json.JsonWriter.WriteValue(System.Boolean)"> | ||
535 | <summary> | ||
536 | Writes a <see cref="T:System.Boolean"/> value. | ||
537 | </summary> | ||
538 | <param name="value">The <see cref="T:System.Boolean"/> value to write.</param> | ||
539 | </member> | ||
540 | <member name="M:Newtonsoft.Json.JsonWriter.WriteValue(System.Int16)"> | ||
541 | <summary> | ||
542 | Writes a <see cref="T:System.Int16"/> value. | ||
543 | </summary> | ||
544 | <param name="value">The <see cref="T:System.Int16"/> value to write.</param> | ||
545 | </member> | ||
546 | <member name="M:Newtonsoft.Json.JsonWriter.WriteValue(System.UInt16)"> | ||
547 | <summary> | ||
548 | Writes a <see cref="T:System.UInt16"/> value. | ||
549 | </summary> | ||
550 | <param name="value">The <see cref="T:System.UInt16"/> value to write.</param> | ||
551 | </member> | ||
552 | <member name="M:Newtonsoft.Json.JsonWriter.WriteValue(System.Char)"> | ||
553 | <summary> | ||
554 | Writes a <see cref="T:System.Char"/> value. | ||
555 | </summary> | ||
556 | <param name="value">The <see cref="T:System.Char"/> value to write.</param> | ||
557 | </member> | ||
558 | <member name="M:Newtonsoft.Json.JsonWriter.WriteValue(System.Byte)"> | ||
559 | <summary> | ||
560 | Writes a <see cref="T:System.Byte"/> value. | ||
561 | </summary> | ||
562 | <param name="value">The <see cref="T:System.Byte"/> value to write.</param> | ||
563 | </member> | ||
564 | <member name="M:Newtonsoft.Json.JsonWriter.WriteValue(System.SByte)"> | ||
565 | <summary> | ||
566 | Writes a <see cref="T:System.SByte"/> value. | ||
567 | </summary> | ||
568 | <param name="value">The <see cref="T:System.SByte"/> value to write.</param> | ||
569 | </member> | ||
570 | <member name="M:Newtonsoft.Json.JsonWriter.WriteValue(System.Decimal)"> | ||
571 | <summary> | ||
572 | Writes a <see cref="T:System.Decimal"/> value. | ||
573 | </summary> | ||
574 | <param name="value">The <see cref="T:System.Decimal"/> value to write.</param> | ||
575 | </member> | ||
576 | <member name="M:Newtonsoft.Json.JsonWriter.WriteValue(System.DateTime)"> | ||
577 | <summary> | ||
578 | Writes a <see cref="T:System.DateTime"/> value. | ||
579 | </summary> | ||
580 | <param name="value">The <see cref="T:System.DateTime"/> value to write.</param> | ||
581 | </member> | ||
582 | <member name="M:Newtonsoft.Json.JsonWriter.WriteValue(System.DateTimeOffset)"> | ||
583 | <summary> | ||
584 | Writes a <see cref="T:System.DateTimeOffset"/> value. | ||
585 | </summary> | ||
586 | <param name="value">The <see cref="T:System.DateTimeOffset"/> value to write.</param> | ||
587 | </member> | ||
588 | <member name="M:Newtonsoft.Json.JsonWriter.WriteValue(System.Guid)"> | ||
589 | <summary> | ||
590 | Writes a <see cref="T:System.Guid"/> value. | ||
591 | </summary> | ||
592 | <param name="value">The <see cref="T:System.Guid"/> value to write.</param> | ||
593 | </member> | ||
594 | <member name="M:Newtonsoft.Json.JsonWriter.WriteValue(System.TimeSpan)"> | ||
595 | <summary> | ||
596 | Writes a <see cref="T:System.TimeSpan"/> value. | ||
597 | </summary> | ||
598 | <param name="value">The <see cref="T:System.TimeSpan"/> value to write.</param> | ||
599 | </member> | ||
600 | <member name="M:Newtonsoft.Json.JsonWriter.WriteValue(System.Nullable{System.Int32})"> | ||
601 | <summary> | ||
602 | Writes a <see cref="T:System.Nullable`1"/> value. | ||
603 | </summary> | ||
604 | <param name="value">The <see cref="T:System.Nullable`1"/> value to write.</param> | ||
605 | </member> | ||
606 | <member name="M:Newtonsoft.Json.JsonWriter.WriteValue(System.Nullable{System.UInt32})"> | ||
607 | <summary> | ||
608 | Writes a <see cref="T:System.Nullable`1"/> value. | ||
609 | </summary> | ||
610 | <param name="value">The <see cref="T:System.Nullable`1"/> value to write.</param> | ||
611 | </member> | ||
612 | <member name="M:Newtonsoft.Json.JsonWriter.WriteValue(System.Nullable{System.Int64})"> | ||
613 | <summary> | ||
614 | Writes a <see cref="T:System.Nullable`1"/> value. | ||
615 | </summary> | ||
616 | <param name="value">The <see cref="T:System.Nullable`1"/> value to write.</param> | ||
617 | </member> | ||
618 | <member name="M:Newtonsoft.Json.JsonWriter.WriteValue(System.Nullable{System.UInt64})"> | ||
619 | <summary> | ||
620 | Writes a <see cref="T:System.Nullable`1"/> value. | ||
621 | </summary> | ||
622 | <param name="value">The <see cref="T:System.Nullable`1"/> value to write.</param> | ||
623 | </member> | ||
624 | <member name="M:Newtonsoft.Json.JsonWriter.WriteValue(System.Nullable{System.Single})"> | ||
625 | <summary> | ||
626 | Writes a <see cref="T:System.Nullable`1"/> value. | ||
627 | </summary> | ||
628 | <param name="value">The <see cref="T:System.Nullable`1"/> value to write.</param> | ||
629 | </member> | ||
630 | <member name="M:Newtonsoft.Json.JsonWriter.WriteValue(System.Nullable{System.Double})"> | ||
631 | <summary> | ||
632 | Writes a <see cref="T:System.Nullable`1"/> value. | ||
633 | </summary> | ||
634 | <param name="value">The <see cref="T:System.Nullable`1"/> value to write.</param> | ||
635 | </member> | ||
636 | <member name="M:Newtonsoft.Json.JsonWriter.WriteValue(System.Nullable{System.Boolean})"> | ||
637 | <summary> | ||
638 | Writes a <see cref="T:System.Nullable`1"/> value. | ||
639 | </summary> | ||
640 | <param name="value">The <see cref="T:System.Nullable`1"/> value to write.</param> | ||
641 | </member> | ||
642 | <member name="M:Newtonsoft.Json.JsonWriter.WriteValue(System.Nullable{System.Int16})"> | ||
643 | <summary> | ||
644 | Writes a <see cref="T:System.Nullable`1"/> value. | ||
645 | </summary> | ||
646 | <param name="value">The <see cref="T:System.Nullable`1"/> value to write.</param> | ||
647 | </member> | ||
648 | <member name="M:Newtonsoft.Json.JsonWriter.WriteValue(System.Nullable{System.UInt16})"> | ||
649 | <summary> | ||
650 | Writes a <see cref="T:System.Nullable`1"/> value. | ||
651 | </summary> | ||
652 | <param name="value">The <see cref="T:System.Nullable`1"/> value to write.</param> | ||
653 | </member> | ||
654 | <member name="M:Newtonsoft.Json.JsonWriter.WriteValue(System.Nullable{System.Char})"> | ||
655 | <summary> | ||
656 | Writes a <see cref="T:System.Nullable`1"/> value. | ||
657 | </summary> | ||
658 | <param name="value">The <see cref="T:System.Nullable`1"/> value to write.</param> | ||
659 | </member> | ||
660 | <member name="M:Newtonsoft.Json.JsonWriter.WriteValue(System.Nullable{System.Byte})"> | ||
661 | <summary> | ||
662 | Writes a <see cref="T:System.Nullable`1"/> value. | ||
663 | </summary> | ||
664 | <param name="value">The <see cref="T:System.Nullable`1"/> value to write.</param> | ||
665 | </member> | ||
666 | <member name="M:Newtonsoft.Json.JsonWriter.WriteValue(System.Nullable{System.SByte})"> | ||
667 | <summary> | ||
668 | Writes a <see cref="T:System.Nullable`1"/> value. | ||
669 | </summary> | ||
670 | <param name="value">The <see cref="T:System.Nullable`1"/> value to write.</param> | ||
671 | </member> | ||
672 | <member name="M:Newtonsoft.Json.JsonWriter.WriteValue(System.Nullable{System.Decimal})"> | ||
673 | <summary> | ||
674 | Writes a <see cref="T:System.Nullable`1"/> value. | ||
675 | </summary> | ||
676 | <param name="value">The <see cref="T:System.Nullable`1"/> value to write.</param> | ||
677 | </member> | ||
678 | <member name="M:Newtonsoft.Json.JsonWriter.WriteValue(System.Nullable{System.DateTime})"> | ||
679 | <summary> | ||
680 | Writes a <see cref="T:System.Nullable`1"/> value. | ||
681 | </summary> | ||
682 | <param name="value">The <see cref="T:System.Nullable`1"/> value to write.</param> | ||
683 | </member> | ||
684 | <member name="M:Newtonsoft.Json.JsonWriter.WriteValue(System.Nullable{System.DateTimeOffset})"> | ||
685 | <summary> | ||
686 | Writes a <see cref="T:System.Nullable`1"/> value. | ||
687 | </summary> | ||
688 | <param name="value">The <see cref="T:System.Nullable`1"/> value to write.</param> | ||
689 | </member> | ||
690 | <member name="M:Newtonsoft.Json.JsonWriter.WriteValue(System.Nullable{System.Guid})"> | ||
691 | <summary> | ||
692 | Writes a <see cref="T:System.Nullable`1"/> value. | ||
693 | </summary> | ||
694 | <param name="value">The <see cref="T:System.Nullable`1"/> value to write.</param> | ||
695 | </member> | ||
696 | <member name="M:Newtonsoft.Json.JsonWriter.WriteValue(System.Nullable{System.TimeSpan})"> | ||
697 | <summary> | ||
698 | Writes a <see cref="T:System.Nullable`1"/> value. | ||
699 | </summary> | ||
700 | <param name="value">The <see cref="T:System.Nullable`1"/> value to write.</param> | ||
701 | </member> | ||
702 | <member name="M:Newtonsoft.Json.JsonWriter.WriteValue(System.Byte[])"> | ||
703 | <summary> | ||
704 | Writes a <see cref="T:Byte[]"/> value. | ||
705 | </summary> | ||
706 | <param name="value">The <see cref="T:Byte[]"/> value to write.</param> | ||
707 | </member> | ||
708 | <member name="M:Newtonsoft.Json.JsonWriter.WriteValue(System.Uri)"> | ||
709 | <summary> | ||
710 | Writes a <see cref="T:System.Uri"/> value. | ||
711 | </summary> | ||
712 | <param name="value">The <see cref="T:System.Uri"/> value to write.</param> | ||
713 | </member> | ||
714 | <member name="M:Newtonsoft.Json.JsonWriter.WriteValue(System.Object)"> | ||
715 | <summary> | ||
716 | Writes a <see cref="T:System.Object"/> value. | ||
717 | An error will raised if the value cannot be written as a single JSON token. | ||
718 | </summary> | ||
719 | <param name="value">The <see cref="T:System.Object"/> value to write.</param> | ||
720 | </member> | ||
721 | <member name="M:Newtonsoft.Json.JsonWriter.WriteComment(System.String)"> | ||
722 | <summary> | ||
723 | Writes out a comment <code>/*...*/</code> containing the specified text. | ||
724 | </summary> | ||
725 | <param name="text">Text to place inside the comment.</param> | ||
726 | </member> | ||
727 | <member name="M:Newtonsoft.Json.JsonWriter.WriteWhitespace(System.String)"> | ||
728 | <summary> | ||
729 | Writes out the given white space. | ||
730 | </summary> | ||
731 | <param name="ws">The string of white space characters.</param> | ||
732 | </member> | ||
733 | <member name="M:Newtonsoft.Json.JsonWriter.SetWriteState(Newtonsoft.Json.JsonToken,System.Object)"> | ||
734 | <summary> | ||
735 | Sets the state of the JsonWriter, | ||
736 | </summary> | ||
737 | <param name="token">The JsonToken being written.</param> | ||
738 | <param name="value">The value being written.</param> | ||
739 | </member> | ||
740 | <member name="P:Newtonsoft.Json.JsonWriter.CloseOutput"> | ||
741 | <summary> | ||
742 | Gets or sets a value indicating whether the underlying stream or | ||
743 | <see cref="T:System.IO.TextReader"/> should be closed when the writer is closed. | ||
744 | </summary> | ||
745 | <value> | ||
746 | true to close the underlying stream or <see cref="T:System.IO.TextReader"/> when | ||
747 | the writer is closed; otherwise false. The default is true. | ||
748 | </value> | ||
749 | </member> | ||
750 | <member name="P:Newtonsoft.Json.JsonWriter.Top"> | ||
751 | <summary> | ||
752 | Gets the top. | ||
753 | </summary> | ||
754 | <value>The top.</value> | ||
755 | </member> | ||
756 | <member name="P:Newtonsoft.Json.JsonWriter.WriteState"> | ||
757 | <summary> | ||
758 | Gets the state of the writer. | ||
759 | </summary> | ||
760 | </member> | ||
761 | <member name="P:Newtonsoft.Json.JsonWriter.Path"> | ||
762 | <summary> | ||
763 | Gets the path of the writer. | ||
764 | </summary> | ||
765 | </member> | ||
766 | <member name="P:Newtonsoft.Json.JsonWriter.Formatting"> | ||
767 | <summary> | ||
768 | Indicates how JSON text output is formatted. | ||
769 | </summary> | ||
770 | </member> | ||
771 | <member name="P:Newtonsoft.Json.JsonWriter.DateFormatHandling"> | ||
772 | <summary> | ||
773 | Get or set how dates are written to JSON text. | ||
774 | </summary> | ||
775 | </member> | ||
776 | <member name="P:Newtonsoft.Json.JsonWriter.DateTimeZoneHandling"> | ||
777 | <summary> | ||
778 | Get or set how <see cref="T:System.DateTime"/> time zones are handling when writing JSON text. | ||
779 | </summary> | ||
780 | </member> | ||
781 | <member name="P:Newtonsoft.Json.JsonWriter.StringEscapeHandling"> | ||
782 | <summary> | ||
783 | Get or set how strings are escaped when writing JSON text. | ||
784 | </summary> | ||
785 | </member> | ||
786 | <member name="P:Newtonsoft.Json.JsonWriter.FloatFormatHandling"> | ||
787 | <summary> | ||
788 | Get or set how special floating point numbers, e.g. <see cref="F:System.Double.NaN"/>, | ||
789 | <see cref="F:System.Double.PositiveInfinity"/> and <see cref="F:System.Double.NegativeInfinity"/>, | ||
790 | are written to JSON text. | ||
791 | </summary> | ||
792 | </member> | ||
793 | <member name="P:Newtonsoft.Json.JsonWriter.DateFormatString"> | ||
794 | <summary> | ||
795 | Get or set how <see cref="T:System.DateTime"/> and <see cref="T:System.DateTimeOffset"/> values are formatting when writing JSON text. | ||
796 | </summary> | ||
797 | </member> | ||
798 | <member name="P:Newtonsoft.Json.JsonWriter.Culture"> | ||
799 | <summary> | ||
800 | Gets or sets the culture used when writing JSON. Defaults to <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>. | ||
801 | </summary> | ||
802 | </member> | ||
803 | <member name="M:Newtonsoft.Json.Bson.BsonWriter.#ctor(System.IO.Stream)"> | ||
804 | <summary> | ||
805 | Initializes a new instance of the <see cref="T:Newtonsoft.Json.Bson.BsonWriter"/> class. | ||
806 | </summary> | ||
807 | <param name="stream">The stream.</param> | ||
808 | </member> | ||
809 | <member name="M:Newtonsoft.Json.Bson.BsonWriter.#ctor(System.IO.BinaryWriter)"> | ||
810 | <summary> | ||
811 | Initializes a new instance of the <see cref="T:Newtonsoft.Json.Bson.BsonWriter"/> class. | ||
812 | </summary> | ||
813 | <param name="writer">The writer.</param> | ||
814 | </member> | ||
815 | <member name="M:Newtonsoft.Json.Bson.BsonWriter.Flush"> | ||
816 | <summary> | ||
817 | Flushes whatever is in the buffer to the underlying streams and also flushes the underlying stream. | ||
818 | </summary> | ||
819 | </member> | ||
820 | <member name="M:Newtonsoft.Json.Bson.BsonWriter.WriteEnd(Newtonsoft.Json.JsonToken)"> | ||
821 | <summary> | ||
822 | Writes the end. | ||
823 | </summary> | ||
824 | <param name="token">The token.</param> | ||
825 | </member> | ||
826 | <member name="M:Newtonsoft.Json.Bson.BsonWriter.WriteComment(System.String)"> | ||
827 | <summary> | ||
828 | Writes out a comment <code>/*...*/</code> containing the specified text. | ||
829 | </summary> | ||
830 | <param name="text">Text to place inside the comment.</param> | ||
831 | </member> | ||
832 | <member name="M:Newtonsoft.Json.Bson.BsonWriter.WriteStartConstructor(System.String)"> | ||
833 | <summary> | ||
834 | Writes the start of a constructor with the given name. | ||
835 | </summary> | ||
836 | <param name="name">The name of the constructor.</param> | ||
837 | </member> | ||
838 | <member name="M:Newtonsoft.Json.Bson.BsonWriter.WriteRaw(System.String)"> | ||
839 | <summary> | ||
840 | Writes raw JSON. | ||
841 | </summary> | ||
842 | <param name="json">The raw JSON to write.</param> | ||
843 | </member> | ||
844 | <member name="M:Newtonsoft.Json.Bson.BsonWriter.WriteRawValue(System.String)"> | ||
845 | <summary> | ||
846 | Writes raw JSON where a value is expected and updates the writer's state. | ||
847 | </summary> | ||
848 | <param name="json">The raw JSON to write.</param> | ||
849 | </member> | ||
850 | <member name="M:Newtonsoft.Json.Bson.BsonWriter.WriteStartArray"> | ||
851 | <summary> | ||
852 | Writes the beginning of a Json array. | ||
853 | </summary> | ||
854 | </member> | ||
855 | <member name="M:Newtonsoft.Json.Bson.BsonWriter.WriteStartObject"> | ||
856 | <summary> | ||
857 | Writes the beginning of a Json object. | ||
858 | </summary> | ||
859 | </member> | ||
860 | <member name="M:Newtonsoft.Json.Bson.BsonWriter.WritePropertyName(System.String)"> | ||
861 | <summary> | ||
862 | Writes the property name of a name/value pair on a Json object. | ||
863 | </summary> | ||
864 | <param name="name">The name of the property.</param> | ||
865 | </member> | ||
866 | <member name="M:Newtonsoft.Json.Bson.BsonWriter.Close"> | ||
867 | <summary> | ||
868 | Closes this stream and the underlying stream. | ||
869 | </summary> | ||
870 | </member> | ||
871 | <member name="M:Newtonsoft.Json.Bson.BsonWriter.WriteValue(System.Object)"> | ||
872 | <summary> | ||
873 | Writes a <see cref="T:System.Object"/> value. | ||
874 | An error will raised if the value cannot be written as a single JSON token. | ||
875 | </summary> | ||
876 | <param name="value">The <see cref="T:System.Object"/> value to write.</param> | ||
877 | </member> | ||
878 | <member name="M:Newtonsoft.Json.Bson.BsonWriter.WriteNull"> | ||
879 | <summary> | ||
880 | Writes a null value. | ||
881 | </summary> | ||
882 | </member> | ||
883 | <member name="M:Newtonsoft.Json.Bson.BsonWriter.WriteUndefined"> | ||
884 | <summary> | ||
885 | Writes an undefined value. | ||
886 | </summary> | ||
887 | </member> | ||
888 | <member name="M:Newtonsoft.Json.Bson.BsonWriter.WriteValue(System.String)"> | ||
889 | <summary> | ||
890 | Writes a <see cref="T:System.String"/> value. | ||
891 | </summary> | ||
892 | <param name="value">The <see cref="T:System.String"/> value to write.</param> | ||
893 | </member> | ||
894 | <member name="M:Newtonsoft.Json.Bson.BsonWriter.WriteValue(System.Int32)"> | ||
895 | <summary> | ||
896 | Writes a <see cref="T:System.Int32"/> value. | ||
897 | </summary> | ||
898 | <param name="value">The <see cref="T:System.Int32"/> value to write.</param> | ||
899 | </member> | ||
900 | <member name="M:Newtonsoft.Json.Bson.BsonWriter.WriteValue(System.UInt32)"> | ||
901 | <summary> | ||
902 | Writes a <see cref="T:System.UInt32"/> value. | ||
903 | </summary> | ||
904 | <param name="value">The <see cref="T:System.UInt32"/> value to write.</param> | ||
905 | </member> | ||
906 | <member name="M:Newtonsoft.Json.Bson.BsonWriter.WriteValue(System.Int64)"> | ||
907 | <summary> | ||
908 | Writes a <see cref="T:System.Int64"/> value. | ||
909 | </summary> | ||
910 | <param name="value">The <see cref="T:System.Int64"/> value to write.</param> | ||
911 | </member> | ||
912 | <member name="M:Newtonsoft.Json.Bson.BsonWriter.WriteValue(System.UInt64)"> | ||
913 | <summary> | ||
914 | Writes a <see cref="T:System.UInt64"/> value. | ||
915 | </summary> | ||
916 | <param name="value">The <see cref="T:System.UInt64"/> value to write.</param> | ||
917 | </member> | ||
918 | <member name="M:Newtonsoft.Json.Bson.BsonWriter.WriteValue(System.Single)"> | ||
919 | <summary> | ||
920 | Writes a <see cref="T:System.Single"/> value. | ||
921 | </summary> | ||
922 | <param name="value">The <see cref="T:System.Single"/> value to write.</param> | ||
923 | </member> | ||
924 | <member name="M:Newtonsoft.Json.Bson.BsonWriter.WriteValue(System.Double)"> | ||
925 | <summary> | ||
926 | Writes a <see cref="T:System.Double"/> value. | ||
927 | </summary> | ||
928 | <param name="value">The <see cref="T:System.Double"/> value to write.</param> | ||
929 | </member> | ||
930 | <member name="M:Newtonsoft.Json.Bson.BsonWriter.WriteValue(System.Boolean)"> | ||
931 | <summary> | ||
932 | Writes a <see cref="T:System.Boolean"/> value. | ||
933 | </summary> | ||
934 | <param name="value">The <see cref="T:System.Boolean"/> value to write.</param> | ||
935 | </member> | ||
936 | <member name="M:Newtonsoft.Json.Bson.BsonWriter.WriteValue(System.Int16)"> | ||
937 | <summary> | ||
938 | Writes a <see cref="T:System.Int16"/> value. | ||
939 | </summary> | ||
940 | <param name="value">The <see cref="T:System.Int16"/> value to write.</param> | ||
941 | </member> | ||
942 | <member name="M:Newtonsoft.Json.Bson.BsonWriter.WriteValue(System.UInt16)"> | ||
943 | <summary> | ||
944 | Writes a <see cref="T:System.UInt16"/> value. | ||
945 | </summary> | ||
946 | <param name="value">The <see cref="T:System.UInt16"/> value to write.</param> | ||
947 | </member> | ||
948 | <member name="M:Newtonsoft.Json.Bson.BsonWriter.WriteValue(System.Char)"> | ||
949 | <summary> | ||
950 | Writes a <see cref="T:System.Char"/> value. | ||
951 | </summary> | ||
952 | <param name="value">The <see cref="T:System.Char"/> value to write.</param> | ||
953 | </member> | ||
954 | <member name="M:Newtonsoft.Json.Bson.BsonWriter.WriteValue(System.Byte)"> | ||
955 | <summary> | ||
956 | Writes a <see cref="T:System.Byte"/> value. | ||
957 | </summary> | ||
958 | <param name="value">The <see cref="T:System.Byte"/> value to write.</param> | ||
959 | </member> | ||
960 | <member name="M:Newtonsoft.Json.Bson.BsonWriter.WriteValue(System.SByte)"> | ||
961 | <summary> | ||
962 | Writes a <see cref="T:System.SByte"/> value. | ||
963 | </summary> | ||
964 | <param name="value">The <see cref="T:System.SByte"/> value to write.</param> | ||
965 | </member> | ||
966 | <member name="M:Newtonsoft.Json.Bson.BsonWriter.WriteValue(System.Decimal)"> | ||
967 | <summary> | ||
968 | Writes a <see cref="T:System.Decimal"/> value. | ||
969 | </summary> | ||
970 | <param name="value">The <see cref="T:System.Decimal"/> value to write.</param> | ||
971 | </member> | ||
972 | <member name="M:Newtonsoft.Json.Bson.BsonWriter.WriteValue(System.DateTime)"> | ||
973 | <summary> | ||
974 | Writes a <see cref="T:System.DateTime"/> value. | ||
975 | </summary> | ||
976 | <param name="value">The <see cref="T:System.DateTime"/> value to write.</param> | ||
977 | </member> | ||
978 | <member name="M:Newtonsoft.Json.Bson.BsonWriter.WriteValue(System.DateTimeOffset)"> | ||
979 | <summary> | ||
980 | Writes a <see cref="T:System.DateTimeOffset"/> value. | ||
981 | </summary> | ||
982 | <param name="value">The <see cref="T:System.DateTimeOffset"/> value to write.</param> | ||
983 | </member> | ||
984 | <member name="M:Newtonsoft.Json.Bson.BsonWriter.WriteValue(System.Byte[])"> | ||
985 | <summary> | ||
986 | Writes a <see cref="T:Byte[]"/> value. | ||
987 | </summary> | ||
988 | <param name="value">The <see cref="T:Byte[]"/> value to write.</param> | ||
989 | </member> | ||
990 | <member name="M:Newtonsoft.Json.Bson.BsonWriter.WriteValue(System.Guid)"> | ||
991 | <summary> | ||
992 | Writes a <see cref="T:System.Guid"/> value. | ||
993 | </summary> | ||
994 | <param name="value">The <see cref="T:System.Guid"/> value to write.</param> | ||
995 | </member> | ||
996 | <member name="M:Newtonsoft.Json.Bson.BsonWriter.WriteValue(System.TimeSpan)"> | ||
997 | <summary> | ||
998 | Writes a <see cref="T:System.TimeSpan"/> value. | ||
999 | </summary> | ||
1000 | <param name="value">The <see cref="T:System.TimeSpan"/> value to write.</param> | ||
1001 | </member> | ||
1002 | <member name="M:Newtonsoft.Json.Bson.BsonWriter.WriteValue(System.Uri)"> | ||
1003 | <summary> | ||
1004 | Writes a <see cref="T:System.Uri"/> value. | ||
1005 | </summary> | ||
1006 | <param name="value">The <see cref="T:System.Uri"/> value to write.</param> | ||
1007 | </member> | ||
1008 | <member name="M:Newtonsoft.Json.Bson.BsonWriter.WriteObjectId(System.Byte[])"> | ||
1009 | <summary> | ||
1010 | Writes a <see cref="T:Byte[]"/> value that represents a BSON object id. | ||
1011 | </summary> | ||
1012 | <param name="value">The Object ID value to write.</param> | ||
1013 | </member> | ||
1014 | <member name="M:Newtonsoft.Json.Bson.BsonWriter.WriteRegex(System.String,System.String)"> | ||
1015 | <summary> | ||
1016 | Writes a BSON regex. | ||
1017 | </summary> | ||
1018 | <param name="pattern">The regex pattern.</param> | ||
1019 | <param name="options">The regex options.</param> | ||
1020 | </member> | ||
1021 | <member name="P:Newtonsoft.Json.Bson.BsonWriter.DateTimeKindHandling"> | ||
1022 | <summary> | ||
1023 | Gets or sets the <see cref="T:System.DateTimeKind"/> used when writing <see cref="T:System.DateTime"/> values to BSON. | ||
1024 | When set to <see cref="F:System.DateTimeKind.Unspecified"/> no conversion will occur. | ||
1025 | </summary> | ||
1026 | <value>The <see cref="T:System.DateTimeKind"/> used when writing <see cref="T:System.DateTime"/> values to BSON.</value> | ||
1027 | </member> | ||
1028 | <member name="T:Newtonsoft.Json.Bson.BsonObjectId"> | ||
1029 | <summary> | ||
1030 | Represents a BSON Oid (object id). | ||
1031 | </summary> | ||
1032 | </member> | ||
1033 | <member name="M:Newtonsoft.Json.Bson.BsonObjectId.#ctor(System.Byte[])"> | ||
1034 | <summary> | ||
1035 | Initializes a new instance of the <see cref="T:Newtonsoft.Json.Bson.BsonObjectId"/> class. | ||
1036 | </summary> | ||
1037 | <param name="value">The Oid value.</param> | ||
1038 | </member> | ||
1039 | <member name="P:Newtonsoft.Json.Bson.BsonObjectId.Value"> | ||
1040 | <summary> | ||
1041 | Gets or sets the value of the Oid. | ||
1042 | </summary> | ||
1043 | <value>The value of the Oid.</value> | ||
1044 | </member> | ||
1045 | <member name="T:Newtonsoft.Json.Converters.BinaryConverter"> | ||
1046 | <summary> | ||
1047 | Converts a binary value to and from a base 64 string value. | ||
1048 | </summary> | ||
1049 | </member> | ||
1050 | <member name="T:Newtonsoft.Json.JsonConverter"> | ||
1051 | <summary> | ||
1052 | Converts an object to and from JSON. | ||
1053 | </summary> | ||
1054 | </member> | ||
1055 | <member name="M:Newtonsoft.Json.JsonConverter.WriteJson(Newtonsoft.Json.JsonWriter,System.Object,Newtonsoft.Json.JsonSerializer)"> | ||
1056 | <summary> | ||
1057 | Writes the JSON representation of the object. | ||
1058 | </summary> | ||
1059 | <param name="writer">The <see cref="T:Newtonsoft.Json.JsonWriter"/> to write to.</param> | ||
1060 | <param name="value">The value.</param> | ||
1061 | <param name="serializer">The calling serializer.</param> | ||
1062 | </member> | ||
1063 | <member name="M:Newtonsoft.Json.JsonConverter.ReadJson(Newtonsoft.Json.JsonReader,System.Type,System.Object,Newtonsoft.Json.JsonSerializer)"> | ||
1064 | <summary> | ||
1065 | Reads the JSON representation of the object. | ||
1066 | </summary> | ||
1067 | <param name="reader">The <see cref="T:Newtonsoft.Json.JsonReader"/> to read from.</param> | ||
1068 | <param name="objectType">Type of the object.</param> | ||
1069 | <param name="existingValue">The existing value of object being read.</param> | ||
1070 | <param name="serializer">The calling serializer.</param> | ||
1071 | <returns>The object value.</returns> | ||
1072 | </member> | ||
1073 | <member name="M:Newtonsoft.Json.JsonConverter.CanConvert(System.Type)"> | ||
1074 | <summary> | ||
1075 | Determines whether this instance can convert the specified object type. | ||
1076 | </summary> | ||
1077 | <param name="objectType">Type of the object.</param> | ||
1078 | <returns> | ||
1079 | <c>true</c> if this instance can convert the specified object type; otherwise, <c>false</c>. | ||
1080 | </returns> | ||
1081 | </member> | ||
1082 | <member name="M:Newtonsoft.Json.JsonConverter.GetSchema"> | ||
1083 | <summary> | ||
1084 | Gets the <see cref="T:Newtonsoft.Json.Schema.JsonSchema"/> of the JSON produced by the JsonConverter. | ||
1085 | </summary> | ||
1086 | <returns>The <see cref="T:Newtonsoft.Json.Schema.JsonSchema"/> of the JSON produced by the JsonConverter.</returns> | ||
1087 | </member> | ||
1088 | <member name="P:Newtonsoft.Json.JsonConverter.CanRead"> | ||
1089 | <summary> | ||
1090 | Gets a value indicating whether this <see cref="T:Newtonsoft.Json.JsonConverter"/> can read JSON. | ||
1091 | </summary> | ||
1092 | <value><c>true</c> if this <see cref="T:Newtonsoft.Json.JsonConverter"/> can read JSON; otherwise, <c>false</c>.</value> | ||
1093 | </member> | ||
1094 | <member name="P:Newtonsoft.Json.JsonConverter.CanWrite"> | ||
1095 | <summary> | ||
1096 | Gets a value indicating whether this <see cref="T:Newtonsoft.Json.JsonConverter"/> can write JSON. | ||
1097 | </summary> | ||
1098 | <value><c>true</c> if this <see cref="T:Newtonsoft.Json.JsonConverter"/> can write JSON; otherwise, <c>false</c>.</value> | ||
1099 | </member> | ||
1100 | <member name="M:Newtonsoft.Json.Converters.BinaryConverter.WriteJson(Newtonsoft.Json.JsonWriter,System.Object,Newtonsoft.Json.JsonSerializer)"> | ||
1101 | <summary> | ||
1102 | Writes the JSON representation of the object. | ||
1103 | </summary> | ||
1104 | <param name="writer">The <see cref="T:Newtonsoft.Json.JsonWriter"/> to write to.</param> | ||
1105 | <param name="value">The value.</param> | ||
1106 | <param name="serializer">The calling serializer.</param> | ||
1107 | </member> | ||
1108 | <member name="M:Newtonsoft.Json.Converters.BinaryConverter.ReadJson(Newtonsoft.Json.JsonReader,System.Type,System.Object,Newtonsoft.Json.JsonSerializer)"> | ||
1109 | <summary> | ||
1110 | Reads the JSON representation of the object. | ||
1111 | </summary> | ||
1112 | <param name="reader">The <see cref="T:Newtonsoft.Json.JsonReader"/> to read from.</param> | ||
1113 | <param name="objectType">Type of the object.</param> | ||
1114 | <param name="existingValue">The existing value of object being read.</param> | ||
1115 | <param name="serializer">The calling serializer.</param> | ||
1116 | <returns>The object value.</returns> | ||
1117 | </member> | ||
1118 | <member name="M:Newtonsoft.Json.Converters.BinaryConverter.CanConvert(System.Type)"> | ||
1119 | <summary> | ||
1120 | Determines whether this instance can convert the specified object type. | ||
1121 | </summary> | ||
1122 | <param name="objectType">Type of the object.</param> | ||
1123 | <returns> | ||
1124 | <c>true</c> if this instance can convert the specified object type; otherwise, <c>false</c>. | ||
1125 | </returns> | ||
1126 | </member> | ||
1127 | <member name="T:Newtonsoft.Json.Converters.DataSetConverter"> | ||
1128 | <summary> | ||
1129 | Converts a <see cref="T:System.Data.DataSet"/> to and from JSON. | ||
1130 | </summary> | ||
1131 | </member> | ||
1132 | <member name="M:Newtonsoft.Json.Converters.DataSetConverter.WriteJson(Newtonsoft.Json.JsonWriter,System.Object,Newtonsoft.Json.JsonSerializer)"> | ||
1133 | <summary> | ||
1134 | Writes the JSON representation of the object. | ||
1135 | </summary> | ||
1136 | <param name="writer">The <see cref="T:Newtonsoft.Json.JsonWriter"/> to write to.</param> | ||
1137 | <param name="value">The value.</param> | ||
1138 | <param name="serializer">The calling serializer.</param> | ||
1139 | </member> | ||
1140 | <member name="M:Newtonsoft.Json.Converters.DataSetConverter.ReadJson(Newtonsoft.Json.JsonReader,System.Type,System.Object,Newtonsoft.Json.JsonSerializer)"> | ||
1141 | <summary> | ||
1142 | Reads the JSON representation of the object. | ||
1143 | </summary> | ||
1144 | <param name="reader">The <see cref="T:Newtonsoft.Json.JsonReader"/> to read from.</param> | ||
1145 | <param name="objectType">Type of the object.</param> | ||
1146 | <param name="existingValue">The existing value of object being read.</param> | ||
1147 | <param name="serializer">The calling serializer.</param> | ||
1148 | <returns>The object value.</returns> | ||
1149 | </member> | ||
1150 | <member name="M:Newtonsoft.Json.Converters.DataSetConverter.CanConvert(System.Type)"> | ||
1151 | <summary> | ||
1152 | Determines whether this instance can convert the specified value type. | ||
1153 | </summary> | ||
1154 | <param name="valueType">Type of the value.</param> | ||
1155 | <returns> | ||
1156 | <c>true</c> if this instance can convert the specified value type; otherwise, <c>false</c>. | ||
1157 | </returns> | ||
1158 | </member> | ||
1159 | <member name="T:Newtonsoft.Json.Converters.DataTableConverter"> | ||
1160 | <summary> | ||
1161 | Converts a <see cref="T:System.Data.DataTable"/> to and from JSON. | ||
1162 | </summary> | ||
1163 | </member> | ||
1164 | <member name="M:Newtonsoft.Json.Converters.DataTableConverter.WriteJson(Newtonsoft.Json.JsonWriter,System.Object,Newtonsoft.Json.JsonSerializer)"> | ||
1165 | <summary> | ||
1166 | Writes the JSON representation of the object. | ||
1167 | </summary> | ||
1168 | <param name="writer">The <see cref="T:Newtonsoft.Json.JsonWriter"/> to write to.</param> | ||
1169 | <param name="value">The value.</param> | ||
1170 | <param name="serializer">The calling serializer.</param> | ||
1171 | </member> | ||
1172 | <member name="M:Newtonsoft.Json.Converters.DataTableConverter.ReadJson(Newtonsoft.Json.JsonReader,System.Type,System.Object,Newtonsoft.Json.JsonSerializer)"> | ||
1173 | <summary> | ||
1174 | Reads the JSON representation of the object. | ||
1175 | </summary> | ||
1176 | <param name="reader">The <see cref="T:Newtonsoft.Json.JsonReader"/> to read from.</param> | ||
1177 | <param name="objectType">Type of the object.</param> | ||
1178 | <param name="existingValue">The existing value of object being read.</param> | ||
1179 | <param name="serializer">The calling serializer.</param> | ||
1180 | <returns>The object value.</returns> | ||
1181 | </member> | ||
1182 | <member name="M:Newtonsoft.Json.Converters.DataTableConverter.CanConvert(System.Type)"> | ||
1183 | <summary> | ||
1184 | Determines whether this instance can convert the specified value type. | ||
1185 | </summary> | ||
1186 | <param name="valueType">Type of the value.</param> | ||
1187 | <returns> | ||
1188 | <c>true</c> if this instance can convert the specified value type; otherwise, <c>false</c>. | ||
1189 | </returns> | ||
1190 | </member> | ||
1191 | <member name="T:Newtonsoft.Json.Converters.CustomCreationConverter`1"> | ||
1192 | <summary> | ||
1193 | Create a custom object | ||
1194 | </summary> | ||
1195 | <typeparam name="T">The object type to convert.</typeparam> | ||
1196 | </member> | ||
1197 | <member name="M:Newtonsoft.Json.Converters.CustomCreationConverter`1.WriteJson(Newtonsoft.Json.JsonWriter,System.Object,Newtonsoft.Json.JsonSerializer)"> | ||
1198 | <summary> | ||
1199 | Writes the JSON representation of the object. | ||
1200 | </summary> | ||
1201 | <param name="writer">The <see cref="T:Newtonsoft.Json.JsonWriter"/> to write to.</param> | ||
1202 | <param name="value">The value.</param> | ||
1203 | <param name="serializer">The calling serializer.</param> | ||
1204 | </member> | ||
1205 | <member name="M:Newtonsoft.Json.Converters.CustomCreationConverter`1.ReadJson(Newtonsoft.Json.JsonReader,System.Type,System.Object,Newtonsoft.Json.JsonSerializer)"> | ||
1206 | <summary> | ||
1207 | Reads the JSON representation of the object. | ||
1208 | </summary> | ||
1209 | <param name="reader">The <see cref="T:Newtonsoft.Json.JsonReader"/> to read from.</param> | ||
1210 | <param name="objectType">Type of the object.</param> | ||
1211 | <param name="existingValue">The existing value of object being read.</param> | ||
1212 | <param name="serializer">The calling serializer.</param> | ||
1213 | <returns>The object value.</returns> | ||
1214 | </member> | ||
1215 | <member name="M:Newtonsoft.Json.Converters.CustomCreationConverter`1.Create(System.Type)"> | ||
1216 | <summary> | ||
1217 | Creates an object which will then be populated by the serializer. | ||
1218 | </summary> | ||
1219 | <param name="objectType">Type of the object.</param> | ||
1220 | <returns>The created object.</returns> | ||
1221 | </member> | ||
1222 | <member name="M:Newtonsoft.Json.Converters.CustomCreationConverter`1.CanConvert(System.Type)"> | ||
1223 | <summary> | ||
1224 | Determines whether this instance can convert the specified object type. | ||
1225 | </summary> | ||
1226 | <param name="objectType">Type of the object.</param> | ||
1227 | <returns> | ||
1228 | <c>true</c> if this instance can convert the specified object type; otherwise, <c>false</c>. | ||
1229 | </returns> | ||
1230 | </member> | ||
1231 | <member name="P:Newtonsoft.Json.Converters.CustomCreationConverter`1.CanWrite"> | ||
1232 | <summary> | ||
1233 | Gets a value indicating whether this <see cref="T:Newtonsoft.Json.JsonConverter"/> can write JSON. | ||
1234 | </summary> | ||
1235 | <value> | ||
1236 | <c>true</c> if this <see cref="T:Newtonsoft.Json.JsonConverter"/> can write JSON; otherwise, <c>false</c>. | ||
1237 | </value> | ||
1238 | </member> | ||
1239 | <member name="T:Newtonsoft.Json.Converters.DateTimeConverterBase"> | ||
1240 | <summary> | ||
1241 | Provides a base class for converting a <see cref="T:System.DateTime"/> to and from JSON. | ||
1242 | </summary> | ||
1243 | </member> | ||
1244 | <member name="M:Newtonsoft.Json.Converters.DateTimeConverterBase.CanConvert(System.Type)"> | ||
1245 | <summary> | ||
1246 | Determines whether this instance can convert the specified object type. | ||
1247 | </summary> | ||
1248 | <param name="objectType">Type of the object.</param> | ||
1249 | <returns> | ||
1250 | <c>true</c> if this instance can convert the specified object type; otherwise, <c>false</c>. | ||
1251 | </returns> | ||
1252 | </member> | ||
1253 | <member name="T:Newtonsoft.Json.Converters.DiscriminatedUnionConverter"> | ||
1254 | <summary> | ||
1255 | Converts a F# discriminated union type to and from JSON. | ||
1256 | </summary> | ||
1257 | </member> | ||
1258 | <member name="M:Newtonsoft.Json.Converters.DiscriminatedUnionConverter.WriteJson(Newtonsoft.Json.JsonWriter,System.Object,Newtonsoft.Json.JsonSerializer)"> | ||
1259 | <summary> | ||
1260 | Writes the JSON representation of the object. | ||
1261 | </summary> | ||
1262 | <param name="writer">The <see cref="T:Newtonsoft.Json.JsonWriter"/> to write to.</param> | ||
1263 | <param name="value">The value.</param> | ||
1264 | <param name="serializer">The calling serializer.</param> | ||
1265 | </member> | ||
1266 | <member name="M:Newtonsoft.Json.Converters.DiscriminatedUnionConverter.ReadJson(Newtonsoft.Json.JsonReader,System.Type,System.Object,Newtonsoft.Json.JsonSerializer)"> | ||
1267 | <summary> | ||
1268 | Reads the JSON representation of the object. | ||
1269 | </summary> | ||
1270 | <param name="reader">The <see cref="T:Newtonsoft.Json.JsonReader"/> to read from.</param> | ||
1271 | <param name="objectType">Type of the object.</param> | ||
1272 | <param name="existingValue">The existing value of object being read.</param> | ||
1273 | <param name="serializer">The calling serializer.</param> | ||
1274 | <returns>The object value.</returns> | ||
1275 | </member> | ||
1276 | <member name="M:Newtonsoft.Json.Converters.DiscriminatedUnionConverter.CanConvert(System.Type)"> | ||
1277 | <summary> | ||
1278 | Determines whether this instance can convert the specified object type. | ||
1279 | </summary> | ||
1280 | <param name="objectType">Type of the object.</param> | ||
1281 | <returns> | ||
1282 | <c>true</c> if this instance can convert the specified object type; otherwise, <c>false</c>. | ||
1283 | </returns> | ||
1284 | </member> | ||
1285 | <member name="T:Newtonsoft.Json.Converters.EntityKeyMemberConverter"> | ||
1286 | <summary> | ||
1287 | Converts an Entity Framework EntityKey to and from JSON. | ||
1288 | </summary> | ||
1289 | </member> | ||
1290 | <member name="M:Newtonsoft.Json.Converters.EntityKeyMemberConverter.WriteJson(Newtonsoft.Json.JsonWriter,System.Object,Newtonsoft.Json.JsonSerializer)"> | ||
1291 | <summary> | ||
1292 | Writes the JSON representation of the object. | ||
1293 | </summary> | ||
1294 | <param name="writer">The <see cref="T:Newtonsoft.Json.JsonWriter"/> to write to.</param> | ||
1295 | <param name="value">The value.</param> | ||
1296 | <param name="serializer">The calling serializer.</param> | ||
1297 | </member> | ||
1298 | <member name="M:Newtonsoft.Json.Converters.EntityKeyMemberConverter.ReadJson(Newtonsoft.Json.JsonReader,System.Type,System.Object,Newtonsoft.Json.JsonSerializer)"> | ||
1299 | <summary> | ||
1300 | Reads the JSON representation of the object. | ||
1301 | </summary> | ||
1302 | <param name="reader">The <see cref="T:Newtonsoft.Json.JsonReader"/> to read from.</param> | ||
1303 | <param name="objectType">Type of the object.</param> | ||
1304 | <param name="existingValue">The existing value of object being read.</param> | ||
1305 | <param name="serializer">The calling serializer.</param> | ||
1306 | <returns>The object value.</returns> | ||
1307 | </member> | ||
1308 | <member name="M:Newtonsoft.Json.Converters.EntityKeyMemberConverter.CanConvert(System.Type)"> | ||
1309 | <summary> | ||
1310 | Determines whether this instance can convert the specified object type. | ||
1311 | </summary> | ||
1312 | <param name="objectType">Type of the object.</param> | ||
1313 | <returns> | ||
1314 | <c>true</c> if this instance can convert the specified object type; otherwise, <c>false</c>. | ||
1315 | </returns> | ||
1316 | </member> | ||
1317 | <member name="T:Newtonsoft.Json.Converters.ExpandoObjectConverter"> | ||
1318 | <summary> | ||
1319 | Converts an ExpandoObject to and from JSON. | ||
1320 | </summary> | ||
1321 | </member> | ||
1322 | <member name="M:Newtonsoft.Json.Converters.ExpandoObjectConverter.WriteJson(Newtonsoft.Json.JsonWriter,System.Object,Newtonsoft.Json.JsonSerializer)"> | ||
1323 | <summary> | ||
1324 | Writes the JSON representation of the object. | ||
1325 | </summary> | ||
1326 | <param name="writer">The <see cref="T:Newtonsoft.Json.JsonWriter"/> to write to.</param> | ||
1327 | <param name="value">The value.</param> | ||
1328 | <param name="serializer">The calling serializer.</param> | ||
1329 | </member> | ||
1330 | <member name="M:Newtonsoft.Json.Converters.ExpandoObjectConverter.ReadJson(Newtonsoft.Json.JsonReader,System.Type,System.Object,Newtonsoft.Json.JsonSerializer)"> | ||
1331 | <summary> | ||
1332 | Reads the JSON representation of the object. | ||
1333 | </summary> | ||
1334 | <param name="reader">The <see cref="T:Newtonsoft.Json.JsonReader"/> to read from.</param> | ||
1335 | <param name="objectType">Type of the object.</param> | ||
1336 | <param name="existingValue">The existing value of object being read.</param> | ||
1337 | <param name="serializer">The calling serializer.</param> | ||
1338 | <returns>The object value.</returns> | ||
1339 | </member> | ||
1340 | <member name="M:Newtonsoft.Json.Converters.ExpandoObjectConverter.CanConvert(System.Type)"> | ||
1341 | <summary> | ||
1342 | Determines whether this instance can convert the specified object type. | ||
1343 | </summary> | ||
1344 | <param name="objectType">Type of the object.</param> | ||
1345 | <returns> | ||
1346 | <c>true</c> if this instance can convert the specified object type; otherwise, <c>false</c>. | ||
1347 | </returns> | ||
1348 | </member> | ||
1349 | <member name="P:Newtonsoft.Json.Converters.ExpandoObjectConverter.CanWrite"> | ||
1350 | <summary> | ||
1351 | Gets a value indicating whether this <see cref="T:Newtonsoft.Json.JsonConverter"/> can write JSON. | ||
1352 | </summary> | ||
1353 | <value> | ||
1354 | <c>true</c> if this <see cref="T:Newtonsoft.Json.JsonConverter"/> can write JSON; otherwise, <c>false</c>. | ||
1355 | </value> | ||
1356 | </member> | ||
1357 | <member name="T:Newtonsoft.Json.Converters.KeyValuePairConverter"> | ||
1358 | <summary> | ||
1359 | Converts a <see cref="T:System.Collections.Generic.KeyValuePair`2"/> to and from JSON. | ||
1360 | </summary> | ||
1361 | </member> | ||
1362 | <member name="M:Newtonsoft.Json.Converters.KeyValuePairConverter.WriteJson(Newtonsoft.Json.JsonWriter,System.Object,Newtonsoft.Json.JsonSerializer)"> | ||
1363 | <summary> | ||
1364 | Writes the JSON representation of the object. | ||
1365 | </summary> | ||
1366 | <param name="writer">The <see cref="T:Newtonsoft.Json.JsonWriter"/> to write to.</param> | ||
1367 | <param name="value">The value.</param> | ||
1368 | <param name="serializer">The calling serializer.</param> | ||
1369 | </member> | ||
1370 | <member name="M:Newtonsoft.Json.Converters.KeyValuePairConverter.ReadJson(Newtonsoft.Json.JsonReader,System.Type,System.Object,Newtonsoft.Json.JsonSerializer)"> | ||
1371 | <summary> | ||
1372 | Reads the JSON representation of the object. | ||
1373 | </summary> | ||
1374 | <param name="reader">The <see cref="T:Newtonsoft.Json.JsonReader"/> to read from.</param> | ||
1375 | <param name="objectType">Type of the object.</param> | ||
1376 | <param name="existingValue">The existing value of object being read.</param> | ||
1377 | <param name="serializer">The calling serializer.</param> | ||
1378 | <returns>The object value.</returns> | ||
1379 | </member> | ||
1380 | <member name="M:Newtonsoft.Json.Converters.KeyValuePairConverter.CanConvert(System.Type)"> | ||
1381 | <summary> | ||
1382 | Determines whether this instance can convert the specified object type. | ||
1383 | </summary> | ||
1384 | <param name="objectType">Type of the object.</param> | ||
1385 | <returns> | ||
1386 | <c>true</c> if this instance can convert the specified object type; otherwise, <c>false</c>. | ||
1387 | </returns> | ||
1388 | </member> | ||
1389 | <member name="T:Newtonsoft.Json.Converters.BsonObjectIdConverter"> | ||
1390 | <summary> | ||
1391 | Converts a <see cref="T:Newtonsoft.Json.Bson.BsonObjectId"/> to and from JSON and BSON. | ||
1392 | </summary> | ||
1393 | </member> | ||
1394 | <member name="M:Newtonsoft.Json.Converters.BsonObjectIdConverter.WriteJson(Newtonsoft.Json.JsonWriter,System.Object,Newtonsoft.Json.JsonSerializer)"> | ||
1395 | <summary> | ||
1396 | Writes the JSON representation of the object. | ||
1397 | </summary> | ||
1398 | <param name="writer">The <see cref="T:Newtonsoft.Json.JsonWriter"/> to write to.</param> | ||
1399 | <param name="value">The value.</param> | ||
1400 | <param name="serializer">The calling serializer.</param> | ||
1401 | </member> | ||
1402 | <member name="M:Newtonsoft.Json.Converters.BsonObjectIdConverter.ReadJson(Newtonsoft.Json.JsonReader,System.Type,System.Object,Newtonsoft.Json.JsonSerializer)"> | ||
1403 | <summary> | ||
1404 | Reads the JSON representation of the object. | ||
1405 | </summary> | ||
1406 | <param name="reader">The <see cref="T:Newtonsoft.Json.JsonReader"/> to read from.</param> | ||
1407 | <param name="objectType">Type of the object.</param> | ||
1408 | <param name="existingValue">The existing value of object being read.</param> | ||
1409 | <param name="serializer">The calling serializer.</param> | ||
1410 | <returns>The object value.</returns> | ||
1411 | </member> | ||
1412 | <member name="M:Newtonsoft.Json.Converters.BsonObjectIdConverter.CanConvert(System.Type)"> | ||
1413 | <summary> | ||
1414 | Determines whether this instance can convert the specified object type. | ||
1415 | </summary> | ||
1416 | <param name="objectType">Type of the object.</param> | ||
1417 | <returns> | ||
1418 | <c>true</c> if this instance can convert the specified object type; otherwise, <c>false</c>. | ||
1419 | </returns> | ||
1420 | </member> | ||
1421 | <member name="T:Newtonsoft.Json.Converters.RegexConverter"> | ||
1422 | <summary> | ||
1423 | Converts a <see cref="T:System.Text.RegularExpressions.Regex"/> to and from JSON and BSON. | ||
1424 | </summary> | ||
1425 | </member> | ||
1426 | <member name="M:Newtonsoft.Json.Converters.RegexConverter.WriteJson(Newtonsoft.Json.JsonWriter,System.Object,Newtonsoft.Json.JsonSerializer)"> | ||
1427 | <summary> | ||
1428 | Writes the JSON representation of the object. | ||
1429 | </summary> | ||
1430 | <param name="writer">The <see cref="T:Newtonsoft.Json.JsonWriter"/> to write to.</param> | ||
1431 | <param name="value">The value.</param> | ||
1432 | <param name="serializer">The calling serializer.</param> | ||
1433 | </member> | ||
1434 | <member name="M:Newtonsoft.Json.Converters.RegexConverter.ReadJson(Newtonsoft.Json.JsonReader,System.Type,System.Object,Newtonsoft.Json.JsonSerializer)"> | ||
1435 | <summary> | ||
1436 | Reads the JSON representation of the object. | ||
1437 | </summary> | ||
1438 | <param name="reader">The <see cref="T:Newtonsoft.Json.JsonReader"/> to read from.</param> | ||
1439 | <param name="objectType">Type of the object.</param> | ||
1440 | <param name="existingValue">The existing value of object being read.</param> | ||
1441 | <param name="serializer">The calling serializer.</param> | ||
1442 | <returns>The object value.</returns> | ||
1443 | </member> | ||
1444 | <member name="M:Newtonsoft.Json.Converters.RegexConverter.CanConvert(System.Type)"> | ||
1445 | <summary> | ||
1446 | Determines whether this instance can convert the specified object type. | ||
1447 | </summary> | ||
1448 | <param name="objectType">Type of the object.</param> | ||
1449 | <returns> | ||
1450 | <c>true</c> if this instance can convert the specified object type; otherwise, <c>false</c>. | ||
1451 | </returns> | ||
1452 | </member> | ||
1453 | <member name="T:Newtonsoft.Json.Converters.StringEnumConverter"> | ||
1454 | <summary> | ||
1455 | Converts an <see cref="T:System.Enum"/> to and from its name string value. | ||
1456 | </summary> | ||
1457 | </member> | ||
1458 | <member name="M:Newtonsoft.Json.Converters.StringEnumConverter.#ctor"> | ||
1459 | <summary> | ||
1460 | Initializes a new instance of the <see cref="T:Newtonsoft.Json.Converters.StringEnumConverter"/> class. | ||
1461 | </summary> | ||
1462 | </member> | ||
1463 | <member name="M:Newtonsoft.Json.Converters.StringEnumConverter.WriteJson(Newtonsoft.Json.JsonWriter,System.Object,Newtonsoft.Json.JsonSerializer)"> | ||
1464 | <summary> | ||
1465 | Writes the JSON representation of the object. | ||
1466 | </summary> | ||
1467 | <param name="writer">The <see cref="T:Newtonsoft.Json.JsonWriter"/> to write to.</param> | ||
1468 | <param name="value">The value.</param> | ||
1469 | <param name="serializer">The calling serializer.</param> | ||
1470 | </member> | ||
1471 | <member name="M:Newtonsoft.Json.Converters.StringEnumConverter.ReadJson(Newtonsoft.Json.JsonReader,System.Type,System.Object,Newtonsoft.Json.JsonSerializer)"> | ||
1472 | <summary> | ||
1473 | Reads the JSON representation of the object. | ||
1474 | </summary> | ||
1475 | <param name="reader">The <see cref="T:Newtonsoft.Json.JsonReader"/> to read from.</param> | ||
1476 | <param name="objectType">Type of the object.</param> | ||
1477 | <param name="existingValue">The existing value of object being read.</param> | ||
1478 | <param name="serializer">The calling serializer.</param> | ||
1479 | <returns>The object value.</returns> | ||
1480 | </member> | ||
1481 | <member name="M:Newtonsoft.Json.Converters.StringEnumConverter.CanConvert(System.Type)"> | ||
1482 | <summary> | ||
1483 | Determines whether this instance can convert the specified object type. | ||
1484 | </summary> | ||
1485 | <param name="objectType">Type of the object.</param> | ||
1486 | <returns> | ||
1487 | <c>true</c> if this instance can convert the specified object type; otherwise, <c>false</c>. | ||
1488 | </returns> | ||
1489 | </member> | ||
1490 | <member name="P:Newtonsoft.Json.Converters.StringEnumConverter.CamelCaseText"> | ||
1491 | <summary> | ||
1492 | Gets or sets a value indicating whether the written enum text should be camel case. | ||
1493 | </summary> | ||
1494 | <value><c>true</c> if the written enum text will be camel case; otherwise, <c>false</c>.</value> | ||
1495 | </member> | ||
1496 | <member name="P:Newtonsoft.Json.Converters.StringEnumConverter.AllowIntegerValues"> | ||
1497 | <summary> | ||
1498 | Gets or sets a value indicating whether integer values are allowed. | ||
1499 | </summary> | ||
1500 | <value><c>true</c> if integers are allowed; otherwise, <c>false</c>.</value> | ||
1501 | </member> | ||
1502 | <member name="T:Newtonsoft.Json.ConstructorHandling"> | ||
1503 | <summary> | ||
1504 | Specifies how constructors are used when initializing objects during deserialization by the <see cref="T:Newtonsoft.Json.JsonSerializer"/>. | ||
1505 | </summary> | ||
1506 | </member> | ||
1507 | <member name="F:Newtonsoft.Json.ConstructorHandling.Default"> | ||
1508 | <summary> | ||
1509 | First attempt to use the public default constructor, then fall back to single paramatized constructor, then the non-public default constructor. | ||
1510 | </summary> | ||
1511 | </member> | ||
1512 | <member name="F:Newtonsoft.Json.ConstructorHandling.AllowNonPublicDefaultConstructor"> | ||
1513 | <summary> | ||
1514 | Json.NET will use a non-public default constructor before falling back to a paramatized constructor. | ||
1515 | </summary> | ||
1516 | </member> | ||
1517 | <member name="T:Newtonsoft.Json.Converters.VersionConverter"> | ||
1518 | <summary> | ||
1519 | Converts a <see cref="T:System.Version"/> to and from a string (e.g. "1.2.3.4"). | ||
1520 | </summary> | ||
1521 | </member> | ||
1522 | <member name="M:Newtonsoft.Json.Converters.VersionConverter.WriteJson(Newtonsoft.Json.JsonWriter,System.Object,Newtonsoft.Json.JsonSerializer)"> | ||
1523 | <summary> | ||
1524 | Writes the JSON representation of the object. | ||
1525 | </summary> | ||
1526 | <param name="writer">The <see cref="T:Newtonsoft.Json.JsonWriter"/> to write to.</param> | ||
1527 | <param name="value">The value.</param> | ||
1528 | <param name="serializer">The calling serializer.</param> | ||
1529 | </member> | ||
1530 | <member name="M:Newtonsoft.Json.Converters.VersionConverter.ReadJson(Newtonsoft.Json.JsonReader,System.Type,System.Object,Newtonsoft.Json.JsonSerializer)"> | ||
1531 | <summary> | ||
1532 | Reads the JSON representation of the object. | ||
1533 | </summary> | ||
1534 | <param name="reader">The <see cref="T:Newtonsoft.Json.JsonReader"/> to read from.</param> | ||
1535 | <param name="objectType">Type of the object.</param> | ||
1536 | <param name="existingValue">The existing property value of the JSON that is being converted.</param> | ||
1537 | <param name="serializer">The calling serializer.</param> | ||
1538 | <returns>The object value.</returns> | ||
1539 | </member> | ||
1540 | <member name="M:Newtonsoft.Json.Converters.VersionConverter.CanConvert(System.Type)"> | ||
1541 | <summary> | ||
1542 | Determines whether this instance can convert the specified object type. | ||
1543 | </summary> | ||
1544 | <param name="objectType">Type of the object.</param> | ||
1545 | <returns> | ||
1546 | <c>true</c> if this instance can convert the specified object type; otherwise, <c>false</c>. | ||
1547 | </returns> | ||
1548 | </member> | ||
1549 | <member name="T:Newtonsoft.Json.FloatFormatHandling"> | ||
1550 | <summary> | ||
1551 | Specifies float format handling options when writing special floating point numbers, e.g. <see cref="F:System.Double.NaN"/>, | ||
1552 | <see cref="F:System.Double.PositiveInfinity"/> and <see cref="F:System.Double.NegativeInfinity"/> with <see cref="T:Newtonsoft.Json.JsonWriter"/>. | ||
1553 | </summary> | ||
1554 | </member> | ||
1555 | <member name="F:Newtonsoft.Json.FloatFormatHandling.String"> | ||
1556 | <summary> | ||
1557 | Write special floating point values as strings in JSON, e.g. "NaN", "Infinity", "-Infinity". | ||
1558 | </summary> | ||
1559 | </member> | ||
1560 | <member name="F:Newtonsoft.Json.FloatFormatHandling.Symbol"> | ||
1561 | <summary> | ||
1562 | Write special floating point values as symbols in JSON, e.g. NaN, Infinity, -Infinity. | ||
1563 | Note that this will produce non-valid JSON. | ||
1564 | </summary> | ||
1565 | </member> | ||
1566 | <member name="F:Newtonsoft.Json.FloatFormatHandling.DefaultValue"> | ||
1567 | <summary> | ||
1568 | Write special floating point values as the property's default value in JSON, e.g. 0.0 for a <see cref="T:System.Double"/> property, null for a <see cref="T:System.Nullable`1"/> property. | ||
1569 | </summary> | ||
1570 | </member> | ||
1571 | <member name="T:Newtonsoft.Json.FloatParseHandling"> | ||
1572 | <summary> | ||
1573 | Specifies how floating point numbers, e.g. 1.0 and 9.9, are parsed when reading JSON text. | ||
1574 | </summary> | ||
1575 | </member> | ||
1576 | <member name="F:Newtonsoft.Json.FloatParseHandling.Double"> | ||
1577 | <summary> | ||
1578 | Floating point numbers are parsed to <see cref="F:Newtonsoft.Json.FloatParseHandling.Double"/>. | ||
1579 | </summary> | ||
1580 | </member> | ||
1581 | <member name="F:Newtonsoft.Json.FloatParseHandling.Decimal"> | ||
1582 | <summary> | ||
1583 | Floating point numbers are parsed to <see cref="F:Newtonsoft.Json.FloatParseHandling.Decimal"/>. | ||
1584 | </summary> | ||
1585 | </member> | ||
1586 | <member name="T:Newtonsoft.Json.JsonDictionaryAttribute"> | ||
1587 | <summary> | ||
1588 | Instructs the <see cref="T:Newtonsoft.Json.JsonSerializer"/> how to serialize the collection. | ||
1589 | </summary> | ||
1590 | </member> | ||
1591 | <member name="T:Newtonsoft.Json.JsonContainerAttribute"> | ||
1592 | <summary> | ||
1593 | Instructs the <see cref="T:Newtonsoft.Json.JsonSerializer"/> how to serialize the object. | ||
1594 | </summary> | ||
1595 | </member> | ||
1596 | <member name="M:Newtonsoft.Json.JsonContainerAttribute.#ctor"> | ||
1597 | <summary> | ||
1598 | Initializes a new instance of the <see cref="T:Newtonsoft.Json.JsonContainerAttribute"/> class. | ||
1599 | </summary> | ||
1600 | </member> | ||
1601 | <member name="M:Newtonsoft.Json.JsonContainerAttribute.#ctor(System.String)"> | ||
1602 | <summary> | ||
1603 | Initializes a new instance of the <see cref="T:Newtonsoft.Json.JsonContainerAttribute"/> class with the specified container Id. | ||
1604 | </summary> | ||
1605 | <param name="id">The container Id.</param> | ||
1606 | </member> | ||
1607 | <member name="P:Newtonsoft.Json.JsonContainerAttribute.Id"> | ||
1608 | <summary> | ||
1609 | Gets or sets the id. | ||
1610 | </summary> | ||
1611 | <value>The id.</value> | ||
1612 | </member> | ||
1613 | <member name="P:Newtonsoft.Json.JsonContainerAttribute.Title"> | ||
1614 | <summary> | ||
1615 | Gets or sets the title. | ||
1616 | </summary> | ||
1617 | <value>The title.</value> | ||
1618 | </member> | ||
1619 | <member name="P:Newtonsoft.Json.JsonContainerAttribute.Description"> | ||
1620 | <summary> | ||
1621 | Gets or sets the description. | ||
1622 | </summary> | ||
1623 | <value>The description.</value> | ||
1624 | </member> | ||
1625 | <member name="P:Newtonsoft.Json.JsonContainerAttribute.ItemConverterType"> | ||
1626 | <summary> | ||
1627 | Gets the collection's items converter. | ||
1628 | </summary> | ||
1629 | <value>The collection's items converter.</value> | ||
1630 | </member> | ||
1631 | <member name="P:Newtonsoft.Json.JsonContainerAttribute.ItemConverterParameters"> | ||
1632 | <summary> | ||
1633 | The parameter list to use when constructing the JsonConverter described by ItemConverterType. | ||
1634 | If null, the default constructor is used. | ||
1635 | When non-null, there must be a constructor defined in the JsonConverter that exactly matches the number, | ||
1636 | order, and type of these parameters. | ||
1637 | </summary> | ||
1638 | <example> | ||
1639 | [JsonContainer(ItemConverterType = typeof(MyContainerConverter), ItemConverterParameters = new object[] { 123, "Four" })] | ||
1640 | </example> | ||
1641 | </member> | ||
1642 | <member name="P:Newtonsoft.Json.JsonContainerAttribute.IsReference"> | ||
1643 | <summary> | ||
1644 | Gets or sets a value that indicates whether to preserve object references. | ||
1645 | </summary> | ||
1646 | <value> | ||
1647 | <c>true</c> to keep object reference; otherwise, <c>false</c>. The default is <c>false</c>. | ||
1648 | </value> | ||
1649 | </member> | ||
1650 | <member name="P:Newtonsoft.Json.JsonContainerAttribute.ItemIsReference"> | ||
1651 | <summary> | ||
1652 | Gets or sets a value that indicates whether to preserve collection's items references. | ||
1653 | </summary> | ||
1654 | <value> | ||
1655 | <c>true</c> to keep collection's items object references; otherwise, <c>false</c>. The default is <c>false</c>. | ||
1656 | </value> | ||
1657 | </member> | ||
1658 | <member name="P:Newtonsoft.Json.JsonContainerAttribute.ItemReferenceLoopHandling"> | ||
1659 | <summary> | ||
1660 | Gets or sets the reference loop handling used when serializing the collection's items. | ||
1661 | </summary> | ||
1662 | <value>The reference loop handling.</value> | ||
1663 | </member> | ||
1664 | <member name="P:Newtonsoft.Json.JsonContainerAttribute.ItemTypeNameHandling"> | ||
1665 | <summary> | ||
1666 | Gets or sets the type name handling used when serializing the collection's items. | ||
1667 | </summary> | ||
1668 | <value>The type name handling.</value> | ||
1669 | </member> | ||
1670 | <member name="M:Newtonsoft.Json.JsonDictionaryAttribute.#ctor"> | ||
1671 | <summary> | ||
1672 | Initializes a new instance of the <see cref="T:Newtonsoft.Json.JsonDictionaryAttribute"/> class. | ||
1673 | </summary> | ||
1674 | </member> | ||
1675 | <member name="M:Newtonsoft.Json.JsonDictionaryAttribute.#ctor(System.String)"> | ||
1676 | <summary> | ||
1677 | Initializes a new instance of the <see cref="T:Newtonsoft.Json.JsonDictionaryAttribute"/> class with the specified container Id. | ||
1678 | </summary> | ||
1679 | <param name="id">The container Id.</param> | ||
1680 | </member> | ||
1681 | <member name="T:Newtonsoft.Json.JsonException"> | ||
1682 | <summary> | ||
1683 | The exception thrown when an error occurs during Json serialization or deserialization. | ||
1684 | </summary> | ||
1685 | </member> | ||
1686 | <member name="M:Newtonsoft.Json.JsonException.#ctor"> | ||
1687 | <summary> | ||
1688 | Initializes a new instance of the <see cref="T:Newtonsoft.Json.JsonException"/> class. | ||
1689 | </summary> | ||
1690 | </member> | ||
1691 | <member name="M:Newtonsoft.Json.JsonException.#ctor(System.String)"> | ||
1692 | <summary> | ||
1693 | Initializes a new instance of the <see cref="T:Newtonsoft.Json.JsonException"/> class | ||
1694 | with a specified error message. | ||
1695 | </summary> | ||
1696 | <param name="message">The error message that explains the reason for the exception.</param> | ||
1697 | </member> | ||
1698 | <member name="M:Newtonsoft.Json.JsonException.#ctor(System.String,System.Exception)"> | ||
1699 | <summary> | ||
1700 | Initializes a new instance of the <see cref="T:Newtonsoft.Json.JsonException"/> class | ||
1701 | with a specified error message and a reference to the inner exception that is the cause of this exception. | ||
1702 | </summary> | ||
1703 | <param name="message">The error message that explains the reason for the exception.</param> | ||
1704 | <param name="innerException">The exception that is the cause of the current exception, or a null reference (Nothing in Visual Basic) if no inner exception is specified.</param> | ||
1705 | </member> | ||
1706 | <member name="M:Newtonsoft.Json.JsonException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> | ||
1707 | <summary> | ||
1708 | Initializes a new instance of the <see cref="T:Newtonsoft.Json.JsonException"/> class. | ||
1709 | </summary> | ||
1710 | <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param> | ||
1711 | <param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param> | ||
1712 | <exception cref="T:System.ArgumentNullException">The <paramref name="info"/> parameter is null. </exception> | ||
1713 | <exception cref="T:System.Runtime.Serialization.SerializationException">The class name is null or <see cref="P:System.Exception.HResult"/> is zero (0). </exception> | ||
1714 | </member> | ||
1715 | <member name="T:Newtonsoft.Json.DateFormatHandling"> | ||
1716 | <summary> | ||
1717 | Specifies how dates are formatted when writing JSON text. | ||
1718 | </summary> | ||
1719 | </member> | ||
1720 | <member name="F:Newtonsoft.Json.DateFormatHandling.IsoDateFormat"> | ||
1721 | <summary> | ||
1722 | Dates are written in the ISO 8601 format, e.g. "2012-03-21T05:40Z". | ||
1723 | </summary> | ||
1724 | </member> | ||
1725 | <member name="F:Newtonsoft.Json.DateFormatHandling.MicrosoftDateFormat"> | ||
1726 | <summary> | ||
1727 | Dates are written in the Microsoft JSON format, e.g. "\/Date(1198908717056)\/". | ||
1728 | </summary> | ||
1729 | </member> | ||
1730 | <member name="T:Newtonsoft.Json.DateParseHandling"> | ||
1731 | <summary> | ||
1732 | Specifies how date formatted strings, e.g. "\/Date(1198908717056)\/" and "2012-03-21T05:40Z", are parsed when reading JSON text. | ||
1733 | </summary> | ||
1734 | </member> | ||
1735 | <member name="F:Newtonsoft.Json.DateParseHandling.None"> | ||
1736 | <summary> | ||
1737 | Date formatted strings are not parsed to a date type and are read as strings. | ||
1738 | </summary> | ||
1739 | </member> | ||
1740 | <member name="F:Newtonsoft.Json.DateParseHandling.DateTime"> | ||
1741 | <summary> | ||
1742 | Date formatted strings, e.g. "\/Date(1198908717056)\/" and "2012-03-21T05:40Z", are parsed to <see cref="F:Newtonsoft.Json.DateParseHandling.DateTime"/>. | ||
1743 | </summary> | ||
1744 | </member> | ||
1745 | <member name="F:Newtonsoft.Json.DateParseHandling.DateTimeOffset"> | ||
1746 | <summary> | ||
1747 | Date formatted strings, e.g. "\/Date(1198908717056)\/" and "2012-03-21T05:40Z", are parsed to <see cref="F:Newtonsoft.Json.DateParseHandling.DateTimeOffset"/>. | ||
1748 | </summary> | ||
1749 | </member> | ||
1750 | <member name="T:Newtonsoft.Json.DateTimeZoneHandling"> | ||
1751 | <summary> | ||
1752 | Specifies how to treat the time value when converting between string and <see cref="T:System.DateTime"/>. | ||
1753 | </summary> | ||
1754 | </member> | ||
1755 | <member name="F:Newtonsoft.Json.DateTimeZoneHandling.Local"> | ||
1756 | <summary> | ||
1757 | Treat as local time. If the <see cref="T:System.DateTime"/> object represents a Coordinated Universal Time (UTC), it is converted to the local time. | ||
1758 | </summary> | ||
1759 | </member> | ||
1760 | <member name="F:Newtonsoft.Json.DateTimeZoneHandling.Utc"> | ||
1761 | <summary> | ||
1762 | Treat as a UTC. If the <see cref="T:System.DateTime"/> object represents a local time, it is converted to a UTC. | ||
1763 | </summary> | ||
1764 | </member> | ||
1765 | <member name="F:Newtonsoft.Json.DateTimeZoneHandling.Unspecified"> | ||
1766 | <summary> | ||
1767 | Treat as a local time if a <see cref="T:System.DateTime"/> is being converted to a string. | ||
1768 | If a string is being converted to <see cref="T:System.DateTime"/>, convert to a local time if a time zone is specified. | ||
1769 | </summary> | ||
1770 | </member> | ||
1771 | <member name="F:Newtonsoft.Json.DateTimeZoneHandling.RoundtripKind"> | ||
1772 | <summary> | ||
1773 | Time zone information should be preserved when converting. | ||
1774 | </summary> | ||
1775 | </member> | ||
1776 | <member name="T:Newtonsoft.Json.Formatting"> | ||
1777 | <summary> | ||
1778 | Specifies formatting options for the <see cref="T:Newtonsoft.Json.JsonTextWriter"/>. | ||
1779 | </summary> | ||
1780 | </member> | ||
1781 | <member name="F:Newtonsoft.Json.Formatting.None"> | ||
1782 | <summary> | ||
1783 | No special formatting is applied. This is the default. | ||
1784 | </summary> | ||
1785 | </member> | ||
1786 | <member name="F:Newtonsoft.Json.Formatting.Indented"> | ||
1787 | <summary> | ||
1788 | Causes child objects to be indented according to the <see cref="P:Newtonsoft.Json.JsonTextWriter.Indentation"/> and <see cref="P:Newtonsoft.Json.JsonTextWriter.IndentChar"/> settings. | ||
1789 | </summary> | ||
1790 | </member> | ||
1791 | <member name="T:Newtonsoft.Json.JsonConstructorAttribute"> | ||
1792 | <summary> | ||
1793 | Instructs the <see cref="T:Newtonsoft.Json.JsonSerializer"/> to use the specified constructor when deserializing that object. | ||
1794 | </summary> | ||
1795 | </member> | ||
1796 | <member name="T:Newtonsoft.Json.JsonExtensionDataAttribute"> | ||
1797 | <summary> | ||
1798 | Instructs the <see cref="T:Newtonsoft.Json.JsonSerializer"/> to deserialize properties with no matching class member into the specified collection | ||
1799 | and write values during serialization. | ||
1800 | </summary> | ||
1801 | </member> | ||
1802 | <member name="M:Newtonsoft.Json.JsonExtensionDataAttribute.#ctor"> | ||
1803 | <summary> | ||
1804 | Initializes a new instance of the <see cref="T:Newtonsoft.Json.JsonExtensionDataAttribute"/> class. | ||
1805 | </summary> | ||
1806 | </member> | ||
1807 | <member name="P:Newtonsoft.Json.JsonExtensionDataAttribute.WriteData"> | ||
1808 | <summary> | ||
1809 | Gets or sets a value that indicates whether to write extension data when serializing the object. | ||
1810 | </summary> | ||
1811 | <value> | ||
1812 | <c>true</c> to write extension data when serializing the object; otherwise, <c>false</c>. The default is <c>true</c>. | ||
1813 | </value> | ||
1814 | </member> | ||
1815 | <member name="P:Newtonsoft.Json.JsonExtensionDataAttribute.ReadData"> | ||
1816 | <summary> | ||
1817 | Gets or sets a value that indicates whether to read extension data when deserializing the object. | ||
1818 | </summary> | ||
1819 | <value> | ||
1820 | <c>true</c> to read extension data when deserializing the object; otherwise, <c>false</c>. The default is <c>true</c>. | ||
1821 | </value> | ||
1822 | </member> | ||
1823 | <member name="T:Newtonsoft.Json.Linq.JsonMergeSettings"> | ||
1824 | <summary> | ||
1825 | Specifies the settings used when merging JSON. | ||
1826 | </summary> | ||
1827 | </member> | ||
1828 | <member name="P:Newtonsoft.Json.Linq.JsonMergeSettings.MergeArrayHandling"> | ||
1829 | <summary> | ||
1830 | Gets or sets the method used when merging JSON arrays. | ||
1831 | </summary> | ||
1832 | <value>The method used when merging JSON arrays.</value> | ||
1833 | </member> | ||
1834 | <member name="T:Newtonsoft.Json.Linq.MergeArrayHandling"> | ||
1835 | <summary> | ||
1836 | Specifies how JSON arrays are merged together. | ||
1837 | </summary> | ||
1838 | </member> | ||
1839 | <member name="F:Newtonsoft.Json.Linq.MergeArrayHandling.Concat"> | ||
1840 | <summary>Concatenate arrays.</summary> | ||
1841 | </member> | ||
1842 | <member name="F:Newtonsoft.Json.Linq.MergeArrayHandling.Union"> | ||
1843 | <summary>Union arrays, skipping items that already exist.</summary> | ||
1844 | </member> | ||
1845 | <member name="F:Newtonsoft.Json.Linq.MergeArrayHandling.Replace"> | ||
1846 | <summary>Replace all array items.</summary> | ||
1847 | </member> | ||
1848 | <member name="F:Newtonsoft.Json.Linq.MergeArrayHandling.Merge"> | ||
1849 | <summary>Merge array items together, matched by index.</summary> | ||
1850 | </member> | ||
1851 | <member name="T:Newtonsoft.Json.MetadataPropertyHandling"> | ||
1852 | <summary> | ||
1853 | Specifies metadata property handling options for the <see cref="T:Newtonsoft.Json.JsonSerializer"/>. | ||
1854 | </summary> | ||
1855 | </member> | ||
1856 | <member name="F:Newtonsoft.Json.MetadataPropertyHandling.Default"> | ||
1857 | <summary> | ||
1858 | Read metadata properties located at the start of a JSON object. | ||
1859 | </summary> | ||
1860 | </member> | ||
1861 | <member name="F:Newtonsoft.Json.MetadataPropertyHandling.ReadAhead"> | ||
1862 | <summary> | ||
1863 | Read metadata properties located anywhere in a JSON object. Note that this setting will impact performance. | ||
1864 | </summary> | ||
1865 | </member> | ||
1866 | <member name="F:Newtonsoft.Json.MetadataPropertyHandling.Ignore"> | ||
1867 | <summary> | ||
1868 | Do not try to read metadata properties. | ||
1869 | </summary> | ||
1870 | </member> | ||
1871 | <member name="T:Newtonsoft.Json.Serialization.DiagnosticsTraceWriter"> | ||
1872 | <summary> | ||
1873 | Represents a trace writer that writes to the application's <see cref="T:System.Diagnostics.TraceListener"/> instances. | ||
1874 | </summary> | ||
1875 | </member> | ||
1876 | <member name="T:Newtonsoft.Json.Serialization.ITraceWriter"> | ||
1877 | <summary> | ||
1878 | Represents a trace writer. | ||
1879 | </summary> | ||
1880 | </member> | ||
1881 | <member name="M:Newtonsoft.Json.Serialization.ITraceWriter.Trace(System.Diagnostics.TraceLevel,System.String,System.Exception)"> | ||
1882 | <summary> | ||
1883 | Writes the specified trace level, message and optional exception. | ||
1884 | </summary> | ||
1885 | <param name="level">The <see cref="T:System.Diagnostics.TraceLevel"/> at which to write this trace.</param> | ||
1886 | <param name="message">The trace message.</param> | ||
1887 | <param name="ex">The trace exception. This parameter is optional.</param> | ||
1888 | </member> | ||
1889 | <member name="P:Newtonsoft.Json.Serialization.ITraceWriter.LevelFilter"> | ||
1890 | <summary> | ||
1891 | Gets the <see cref="T:System.Diagnostics.TraceLevel"/> that will be used to filter the trace messages passed to the writer. | ||
1892 | For example a filter level of <code>Info</code> will exclude <code>Verbose</code> messages and include <code>Info</code>, | ||
1893 | <code>Warning</code> and <code>Error</code> messages. | ||
1894 | </summary> | ||
1895 | <value>The <see cref="T:System.Diagnostics.TraceLevel"/> that will be used to filter the trace messages passed to the writer.</value> | ||
1896 | </member> | ||
1897 | <member name="M:Newtonsoft.Json.Serialization.DiagnosticsTraceWriter.Trace(System.Diagnostics.TraceLevel,System.String,System.Exception)"> | ||
1898 | <summary> | ||
1899 | Writes the specified trace level, message and optional exception. | ||
1900 | </summary> | ||
1901 | <param name="level">The <see cref="T:System.Diagnostics.TraceLevel"/> at which to write this trace.</param> | ||
1902 | <param name="message">The trace message.</param> | ||
1903 | <param name="ex">The trace exception. This parameter is optional.</param> | ||
1904 | </member> | ||
1905 | <member name="P:Newtonsoft.Json.Serialization.DiagnosticsTraceWriter.LevelFilter"> | ||
1906 | <summary> | ||
1907 | Gets the <see cref="T:System.Diagnostics.TraceLevel"/> that will be used to filter the trace messages passed to the writer. | ||
1908 | For example a filter level of <code>Info</code> will exclude <code>Verbose</code> messages and include <code>Info</code>, | ||
1909 | <code>Warning</code> and <code>Error</code> messages. | ||
1910 | </summary> | ||
1911 | <value> | ||
1912 | The <see cref="T:System.Diagnostics.TraceLevel"/> that will be used to filter the trace messages passed to the writer. | ||
1913 | </value> | ||
1914 | </member> | ||
1915 | <member name="T:Newtonsoft.Json.Serialization.ExpressionValueProvider"> | ||
1916 | <summary> | ||
1917 | Get and set values for a <see cref="T:System.Reflection.MemberInfo"/> using dynamic methods. | ||
1918 | </summary> | ||
1919 | </member> | ||
1920 | <member name="T:Newtonsoft.Json.Serialization.IValueProvider"> | ||
1921 | <summary> | ||
1922 | Provides methods to get and set values. | ||
1923 | </summary> | ||
1924 | </member> | ||
1925 | <member name="M:Newtonsoft.Json.Serialization.IValueProvider.SetValue(System.Object,System.Object)"> | ||
1926 | <summary> | ||
1927 | Sets the value. | ||
1928 | </summary> | ||
1929 | <param name="target">The target to set the value on.</param> | ||
1930 | <param name="value">The value to set on the target.</param> | ||
1931 | </member> | ||
1932 | <member name="M:Newtonsoft.Json.Serialization.IValueProvider.GetValue(System.Object)"> | ||
1933 | <summary> | ||
1934 | Gets the value. | ||
1935 | </summary> | ||
1936 | <param name="target">The target to get the value from.</param> | ||
1937 | <returns>The value.</returns> | ||
1938 | </member> | ||
1939 | <member name="M:Newtonsoft.Json.Serialization.ExpressionValueProvider.#ctor(System.Reflection.MemberInfo)"> | ||
1940 | <summary> | ||
1941 | Initializes a new instance of the <see cref="T:Newtonsoft.Json.Serialization.ExpressionValueProvider"/> class. | ||
1942 | </summary> | ||
1943 | <param name="memberInfo">The member info.</param> | ||
1944 | </member> | ||
1945 | <member name="M:Newtonsoft.Json.Serialization.ExpressionValueProvider.SetValue(System.Object,System.Object)"> | ||
1946 | <summary> | ||
1947 | Sets the value. | ||
1948 | </summary> | ||
1949 | <param name="target">The target to set the value on.</param> | ||
1950 | <param name="value">The value to set on the target.</param> | ||
1951 | </member> | ||
1952 | <member name="M:Newtonsoft.Json.Serialization.ExpressionValueProvider.GetValue(System.Object)"> | ||
1953 | <summary> | ||
1954 | Gets the value. | ||
1955 | </summary> | ||
1956 | <param name="target">The target to get the value from.</param> | ||
1957 | <returns>The value.</returns> | ||
1958 | </member> | ||
1959 | <member name="T:Newtonsoft.Json.Serialization.JsonContainerContract"> | ||
1960 | <summary> | ||
1961 | Contract details for a <see cref="T:System.Type"/> used by the <see cref="T:Newtonsoft.Json.JsonSerializer"/>. | ||
1962 | </summary> | ||
1963 | </member> | ||
1964 | <member name="T:Newtonsoft.Json.Serialization.JsonContract"> | ||
1965 | <summary> | ||
1966 | Contract details for a <see cref="T:System.Type"/> used by the <see cref="T:Newtonsoft.Json.JsonSerializer"/>. | ||
1967 | </summary> | ||
1968 | </member> | ||
1969 | <member name="P:Newtonsoft.Json.Serialization.JsonContract.UnderlyingType"> | ||
1970 | <summary> | ||
1971 | Gets the underlying type for the contract. | ||
1972 | </summary> | ||
1973 | <value>The underlying type for the contract.</value> | ||
1974 | </member> | ||
1975 | <member name="P:Newtonsoft.Json.Serialization.JsonContract.CreatedType"> | ||
1976 | <summary> | ||
1977 | Gets or sets the type created during deserialization. | ||
1978 | </summary> | ||
1979 | <value>The type created during deserialization.</value> | ||
1980 | </member> | ||
1981 | <member name="P:Newtonsoft.Json.Serialization.JsonContract.IsReference"> | ||
1982 | <summary> | ||
1983 | Gets or sets whether this type contract is serialized as a reference. | ||
1984 | </summary> | ||
1985 | <value>Whether this type contract is serialized as a reference.</value> | ||
1986 | </member> | ||
1987 | <member name="P:Newtonsoft.Json.Serialization.JsonContract.Converter"> | ||
1988 | <summary> | ||
1989 | Gets or sets the default <see cref="T:Newtonsoft.Json.JsonConverter"/> for this contract. | ||
1990 | </summary> | ||
1991 | <value>The converter.</value> | ||
1992 | </member> | ||
1993 | <member name="P:Newtonsoft.Json.Serialization.JsonContract.OnDeserializedCallbacks"> | ||
1994 | <summary> | ||
1995 | Gets or sets all methods called immediately after deserialization of the object. | ||
1996 | </summary> | ||
1997 | <value>The methods called immediately after deserialization of the object.</value> | ||
1998 | </member> | ||
1999 | <member name="P:Newtonsoft.Json.Serialization.JsonContract.OnDeserializingCallbacks"> | ||
2000 | <summary> | ||
2001 | Gets or sets all methods called during deserialization of the object. | ||
2002 | </summary> | ||
2003 | <value>The methods called during deserialization of the object.</value> | ||
2004 | </member> | ||
2005 | <member name="P:Newtonsoft.Json.Serialization.JsonContract.OnSerializedCallbacks"> | ||
2006 | <summary> | ||
2007 | Gets or sets all methods called after serialization of the object graph. | ||
2008 | </summary> | ||
2009 | <value>The methods called after serialization of the object graph.</value> | ||
2010 | </member> | ||
2011 | <member name="P:Newtonsoft.Json.Serialization.JsonContract.OnSerializingCallbacks"> | ||
2012 | <summary> | ||
2013 | Gets or sets all methods called before serialization of the object. | ||
2014 | </summary> | ||
2015 | <value>The methods called before serialization of the object.</value> | ||
2016 | </member> | ||
2017 | <member name="P:Newtonsoft.Json.Serialization.JsonContract.OnErrorCallbacks"> | ||
2018 | <summary> | ||
2019 | Gets or sets all method called when an error is thrown during the serialization of the object. | ||
2020 | </summary> | ||
2021 | <value>The methods called when an error is thrown during the serialization of the object.</value> | ||
2022 | </member> | ||
2023 | <member name="P:Newtonsoft.Json.Serialization.JsonContract.OnDeserialized"> | ||
2024 | <summary> | ||
2025 | Gets or sets the method called immediately after deserialization of the object. | ||
2026 | </summary> | ||
2027 | <value>The method called immediately after deserialization of the object.</value> | ||
2028 | </member> | ||
2029 | <member name="P:Newtonsoft.Json.Serialization.JsonContract.OnDeserializing"> | ||
2030 | <summary> | ||
2031 | Gets or sets the method called during deserialization of the object. | ||
2032 | </summary> | ||
2033 | <value>The method called during deserialization of the object.</value> | ||
2034 | </member> | ||
2035 | <member name="P:Newtonsoft.Json.Serialization.JsonContract.OnSerialized"> | ||
2036 | <summary> | ||
2037 | Gets or sets the method called after serialization of the object graph. | ||
2038 | </summary> | ||
2039 | <value>The method called after serialization of the object graph.</value> | ||
2040 | </member> | ||
2041 | <member name="P:Newtonsoft.Json.Serialization.JsonContract.OnSerializing"> | ||
2042 | <summary> | ||
2043 | Gets or sets the method called before serialization of the object. | ||
2044 | </summary> | ||
2045 | <value>The method called before serialization of the object.</value> | ||
2046 | </member> | ||
2047 | <member name="P:Newtonsoft.Json.Serialization.JsonContract.OnError"> | ||
2048 | <summary> | ||
2049 | Gets or sets the method called when an error is thrown during the serialization of the object. | ||
2050 | </summary> | ||
2051 | <value>The method called when an error is thrown during the serialization of the object.</value> | ||
2052 | </member> | ||
2053 | <member name="P:Newtonsoft.Json.Serialization.JsonContract.DefaultCreator"> | ||
2054 | <summary> | ||
2055 | Gets or sets the default creator method used to create the object. | ||
2056 | </summary> | ||
2057 | <value>The default creator method used to create the object.</value> | ||
2058 | </member> | ||
2059 | <member name="P:Newtonsoft.Json.Serialization.JsonContract.DefaultCreatorNonPublic"> | ||
2060 | <summary> | ||
2061 | Gets or sets a value indicating whether the default creator is non public. | ||
2062 | </summary> | ||
2063 | <value><c>true</c> if the default object creator is non-public; otherwise, <c>false</c>.</value> | ||
2064 | </member> | ||
2065 | <member name="M:Newtonsoft.Json.Serialization.JsonContainerContract.#ctor(System.Type)"> | ||
2066 | <summary> | ||
2067 | Initializes a new instance of the <see cref="T:Newtonsoft.Json.Serialization.JsonContainerContract"/> class. | ||
2068 | </summary> | ||
2069 | <param name="underlyingType">The underlying type for the contract.</param> | ||
2070 | </member> | ||
2071 | <member name="P:Newtonsoft.Json.Serialization.JsonContainerContract.ItemConverter"> | ||
2072 | <summary> | ||
2073 | Gets or sets the default collection items <see cref="T:Newtonsoft.Json.JsonConverter"/>. | ||
2074 | </summary> | ||
2075 | <value>The converter.</value> | ||
2076 | </member> | ||
2077 | <member name="P:Newtonsoft.Json.Serialization.JsonContainerContract.ItemIsReference"> | ||
2078 | <summary> | ||
2079 | Gets or sets a value indicating whether the collection items preserve object references. | ||
2080 | </summary> | ||
2081 | <value><c>true</c> if collection items preserve object references; otherwise, <c>false</c>.</value> | ||
2082 | </member> | ||
2083 | <member name="P:Newtonsoft.Json.Serialization.JsonContainerContract.ItemReferenceLoopHandling"> | ||
2084 | <summary> | ||
2085 | Gets or sets the collection item reference loop handling. | ||
2086 | </summary> | ||
2087 | <value>The reference loop handling.</value> | ||
2088 | </member> | ||
2089 | <member name="P:Newtonsoft.Json.Serialization.JsonContainerContract.ItemTypeNameHandling"> | ||
2090 | <summary> | ||
2091 | Gets or sets the collection item type name handling. | ||
2092 | </summary> | ||
2093 | <value>The type name handling.</value> | ||
2094 | </member> | ||
2095 | <member name="T:Newtonsoft.Json.Serialization.MemoryTraceWriter"> | ||
2096 | <summary> | ||
2097 | Represents a trace writer that writes to memory. When the trace message limit is | ||
2098 | reached then old trace messages will be removed as new messages are added. | ||
2099 | </summary> | ||
2100 | </member> | ||
2101 | <member name="M:Newtonsoft.Json.Serialization.MemoryTraceWriter.#ctor"> | ||
2102 | <summary> | ||
2103 | Initializes a new instance of the <see cref="T:Newtonsoft.Json.Serialization.MemoryTraceWriter"/> class. | ||
2104 | </summary> | ||
2105 | </member> | ||
2106 | <member name="M:Newtonsoft.Json.Serialization.MemoryTraceWriter.Trace(System.Diagnostics.TraceLevel,System.String,System.Exception)"> | ||
2107 | <summary> | ||
2108 | Writes the specified trace level, message and optional exception. | ||
2109 | </summary> | ||
2110 | <param name="level">The <see cref="T:System.Diagnostics.TraceLevel"/> at which to write this trace.</param> | ||
2111 | <param name="message">The trace message.</param> | ||
2112 | <param name="ex">The trace exception. This parameter is optional.</param> | ||
2113 | </member> | ||
2114 | <member name="M:Newtonsoft.Json.Serialization.MemoryTraceWriter.GetTraceMessages"> | ||
2115 | <summary> | ||
2116 | Returns an enumeration of the most recent trace messages. | ||
2117 | </summary> | ||
2118 | <returns>An enumeration of the most recent trace messages.</returns> | ||
2119 | </member> | ||
2120 | <member name="M:Newtonsoft.Json.Serialization.MemoryTraceWriter.ToString"> | ||
2121 | <summary> | ||
2122 | Returns a <see cref="T:System.String"/> of the most recent trace messages. | ||
2123 | </summary> | ||
2124 | <returns> | ||
2125 | A <see cref="T:System.String"/> of the most recent trace messages. | ||
2126 | </returns> | ||
2127 | </member> | ||
2128 | <member name="P:Newtonsoft.Json.Serialization.MemoryTraceWriter.LevelFilter"> | ||
2129 | <summary> | ||
2130 | Gets the <see cref="T:System.Diagnostics.TraceLevel"/> that will be used to filter the trace messages passed to the writer. | ||
2131 | For example a filter level of <code>Info</code> will exclude <code>Verbose</code> messages and include <code>Info</code>, | ||
2132 | <code>Warning</code> and <code>Error</code> messages. | ||
2133 | </summary> | ||
2134 | <value> | ||
2135 | The <see cref="T:System.Diagnostics.TraceLevel"/> that will be used to filter the trace messages passed to the writer. | ||
2136 | </value> | ||
2137 | </member> | ||
2138 | <member name="T:Newtonsoft.Json.IJsonLineInfo"> | ||
2139 | <summary> | ||
2140 | Provides an interface to enable a class to return line and position information. | ||
2141 | </summary> | ||
2142 | </member> | ||
2143 | <member name="M:Newtonsoft.Json.IJsonLineInfo.HasLineInfo"> | ||
2144 | <summary> | ||
2145 | Gets a value indicating whether the class can return line information. | ||
2146 | </summary> | ||
2147 | <returns> | ||
2148 | <c>true</c> if LineNumber and LinePosition can be provided; otherwise, <c>false</c>. | ||
2149 | </returns> | ||
2150 | </member> | ||
2151 | <member name="P:Newtonsoft.Json.IJsonLineInfo.LineNumber"> | ||
2152 | <summary> | ||
2153 | Gets the current line number. | ||
2154 | </summary> | ||
2155 | <value>The current line number or 0 if no line information is available (for example, HasLineInfo returns false).</value> | ||
2156 | </member> | ||
2157 | <member name="P:Newtonsoft.Json.IJsonLineInfo.LinePosition"> | ||
2158 | <summary> | ||
2159 | Gets the current line position. | ||
2160 | </summary> | ||
2161 | <value>The current line position or 0 if no line information is available (for example, HasLineInfo returns false).</value> | ||
2162 | </member> | ||
2163 | <member name="T:Newtonsoft.Json.StringEscapeHandling"> | ||
2164 | <summary> | ||
2165 | Specifies how strings are escaped when writing JSON text. | ||
2166 | </summary> | ||
2167 | </member> | ||
2168 | <member name="F:Newtonsoft.Json.StringEscapeHandling.Default"> | ||
2169 | <summary> | ||
2170 | Only control characters (e.g. newline) are escaped. | ||
2171 | </summary> | ||
2172 | </member> | ||
2173 | <member name="F:Newtonsoft.Json.StringEscapeHandling.EscapeNonAscii"> | ||
2174 | <summary> | ||
2175 | All non-ASCII and control characters (e.g. newline) are escaped. | ||
2176 | </summary> | ||
2177 | </member> | ||
2178 | <member name="F:Newtonsoft.Json.StringEscapeHandling.EscapeHtml"> | ||
2179 | <summary> | ||
2180 | HTML (<, >, &, ', ") and control characters (e.g. newline) are escaped. | ||
2181 | </summary> | ||
2182 | </member> | ||
2183 | <member name="T:Newtonsoft.Json.Linq.JRaw"> | ||
2184 | <summary> | ||
2185 | Represents a raw JSON string. | ||
2186 | </summary> | ||
2187 | </member> | ||
2188 | <member name="T:Newtonsoft.Json.Linq.JValue"> | ||
2189 | <summary> | ||
2190 | Represents a value in JSON (string, integer, date, etc). | ||
2191 | </summary> | ||
2192 | </member> | ||
2193 | <member name="T:Newtonsoft.Json.Linq.JToken"> | ||
2194 | <summary> | ||
2195 | Represents an abstract JSON token. | ||
2196 | </summary> | ||
2197 | </member> | ||
2198 | <member name="T:Newtonsoft.Json.Linq.IJEnumerable`1"> | ||
2199 | <summary> | ||
2200 | Represents a collection of <see cref="T:Newtonsoft.Json.Linq.JToken"/> objects. | ||
2201 | </summary> | ||
2202 | <typeparam name="T">The type of token</typeparam> | ||
2203 | </member> | ||
2204 | <member name="P:Newtonsoft.Json.Linq.IJEnumerable`1.Item(System.Object)"> | ||
2205 | <summary> | ||
2206 | Gets the <see cref="T:Newtonsoft.Json.Linq.IJEnumerable`1"/> with the specified key. | ||
2207 | </summary> | ||
2208 | <value></value> | ||
2209 | </member> | ||
2210 | <member name="M:Newtonsoft.Json.Linq.JToken.DeepEquals(Newtonsoft.Json.Linq.JToken,Newtonsoft.Json.Linq.JToken)"> | ||
2211 | <summary> | ||
2212 | Compares the values of two tokens, including the values of all descendant tokens. | ||
2213 | </summary> | ||
2214 | <param name="t1">The first <see cref="T:Newtonsoft.Json.Linq.JToken"/> to compare.</param> | ||
2215 | <param name="t2">The second <see cref="T:Newtonsoft.Json.Linq.JToken"/> to compare.</param> | ||
2216 | <returns>true if the tokens are equal; otherwise false.</returns> | ||
2217 | </member> | ||
2218 | <member name="M:Newtonsoft.Json.Linq.JToken.AddAfterSelf(System.Object)"> | ||
2219 | <summary> | ||
2220 | Adds the specified content immediately after this token. | ||
2221 | </summary> | ||
2222 | <param name="content">A content object that contains simple content or a collection of content objects to be added after this token.</param> | ||
2223 | </member> | ||
2224 | <member name="M:Newtonsoft.Json.Linq.JToken.AddBeforeSelf(System.Object)"> | ||
2225 | <summary> | ||
2226 | Adds the specified content immediately before this token. | ||
2227 | </summary> | ||
2228 | <param name="content">A content object that contains simple content or a collection of content objects to be added before this token.</param> | ||
2229 | </member> | ||
2230 | <member name="M:Newtonsoft.Json.Linq.JToken.Ancestors"> | ||
2231 | <summary> | ||
2232 | Returns a collection of the ancestor tokens of this token. | ||
2233 | </summary> | ||
2234 | <returns>A collection of the ancestor tokens of this token.</returns> | ||
2235 | </member> | ||
2236 | <member name="M:Newtonsoft.Json.Linq.JToken.AfterSelf"> | ||
2237 | <summary> | ||
2238 | Returns a collection of the sibling tokens after this token, in document order. | ||
2239 | </summary> | ||
2240 | <returns>A collection of the sibling tokens after this tokens, in document order.</returns> | ||
2241 | </member> | ||
2242 | <member name="M:Newtonsoft.Json.Linq.JToken.BeforeSelf"> | ||
2243 | <summary> | ||
2244 | Returns a collection of the sibling tokens before this token, in document order. | ||
2245 | </summary> | ||
2246 | <returns>A collection of the sibling tokens before this token, in document order.</returns> | ||
2247 | </member> | ||
2248 | <member name="M:Newtonsoft.Json.Linq.JToken.Value``1(System.Object)"> | ||
2249 | <summary> | ||
2250 | Gets the <see cref="T:Newtonsoft.Json.Linq.JToken"/> with the specified key converted to the specified type. | ||
2251 | </summary> | ||
2252 | <typeparam name="T">The type to convert the token to.</typeparam> | ||
2253 | <param name="key">The token key.</param> | ||
2254 | <returns>The converted token value.</returns> | ||
2255 | </member> | ||
2256 | <member name="M:Newtonsoft.Json.Linq.JToken.Children"> | ||
2257 | <summary> | ||
2258 | Returns a collection of the child tokens of this token, in document order. | ||
2259 | </summary> | ||
2260 | <returns>An <see cref="T:System.Collections.Generic.IEnumerable`1"/> of <see cref="T:Newtonsoft.Json.Linq.JToken"/> containing the child tokens of this <see cref="T:Newtonsoft.Json.Linq.JToken"/>, in document order.</returns> | ||
2261 | </member> | ||
2262 | <member name="M:Newtonsoft.Json.Linq.JToken.Children``1"> | ||
2263 | <summary> | ||
2264 | Returns a collection of the child tokens of this token, in document order, filtered by the specified type. | ||
2265 | </summary> | ||
2266 | <typeparam name="T">The type to filter the child tokens on.</typeparam> | ||
2267 | <returns>A <see cref="T:Newtonsoft.Json.Linq.JEnumerable`1"/> containing the child tokens of this <see cref="T:Newtonsoft.Json.Linq.JToken"/>, in document order.</returns> | ||
2268 | </member> | ||
2269 | <member name="M:Newtonsoft.Json.Linq.JToken.Values``1"> | ||
2270 | <summary> | ||
2271 | Returns a collection of the child values of this token, in document order. | ||
2272 | </summary> | ||
2273 | <typeparam name="T">The type to convert the values to.</typeparam> | ||
2274 | <returns>A <see cref="T:System.Collections.Generic.IEnumerable`1"/> containing the child values of this <see cref="T:Newtonsoft.Json.Linq.JToken"/>, in document order.</returns> | ||
2275 | </member> | ||
2276 | <member name="M:Newtonsoft.Json.Linq.JToken.Remove"> | ||
2277 | <summary> | ||
2278 | Removes this token from its parent. | ||
2279 | </summary> | ||
2280 | </member> | ||
2281 | <member name="M:Newtonsoft.Json.Linq.JToken.Replace(Newtonsoft.Json.Linq.JToken)"> | ||
2282 | <summary> | ||
2283 | Replaces this token with the specified token. | ||
2284 | </summary> | ||
2285 | <param name="value">The value.</param> | ||
2286 | </member> | ||
2287 | <member name="M:Newtonsoft.Json.Linq.JToken.WriteTo(Newtonsoft.Json.JsonWriter,Newtonsoft.Json.JsonConverter[])"> | ||
2288 | <summary> | ||
2289 | Writes this token to a <see cref="T:Newtonsoft.Json.JsonWriter"/>. | ||
2290 | </summary> | ||
2291 | <param name="writer">A <see cref="T:Newtonsoft.Json.JsonWriter"/> into which this method will write.</param> | ||
2292 | <param name="converters">A collection of <see cref="T:Newtonsoft.Json.JsonConverter"/> which will be used when writing the token.</param> | ||
2293 | </member> | ||
2294 | <member name="M:Newtonsoft.Json.Linq.JToken.ToString"> | ||
2295 | <summary> | ||
2296 | Returns the indented JSON for this token. | ||
2297 | </summary> | ||
2298 | <returns> | ||
2299 | The indented JSON for this token. | ||
2300 | </returns> | ||
2301 | </member> | ||
2302 | <member name="M:Newtonsoft.Json.Linq.JToken.ToString(Newtonsoft.Json.Formatting,Newtonsoft.Json.JsonConverter[])"> | ||
2303 | <summary> | ||
2304 | Returns the JSON for this token using the given formatting and converters. | ||
2305 | </summary> | ||
2306 | <param name="formatting">Indicates how the output is formatted.</param> | ||
2307 | <param name="converters">A collection of <see cref="T:Newtonsoft.Json.JsonConverter"/> which will be used when writing the token.</param> | ||
2308 | <returns>The JSON for this token using the given formatting and converters.</returns> | ||
2309 | </member> | ||
2310 | <member name="M:Newtonsoft.Json.Linq.JToken.op_Explicit(Newtonsoft.Json.Linq.JToken)~System.Boolean"> | ||
2311 | <summary> | ||
2312 | Performs an explicit conversion from <see cref="T:Newtonsoft.Json.Linq.JToken"/> to <see cref="T:System.Boolean"/>. | ||
2313 | </summary> | ||
2314 | <param name="value">The value.</param> | ||
2315 | <returns>The result of the conversion.</returns> | ||
2316 | </member> | ||
2317 | <member name="M:Newtonsoft.Json.Linq.JToken.op_Explicit(Newtonsoft.Json.Linq.JToken)~System.DateTimeOffset"> | ||
2318 | <summary> | ||
2319 | Performs an explicit conversion from <see cref="T:Newtonsoft.Json.Linq.JToken"/> to <see cref="T:System.DateTimeOffset"/>. | ||
2320 | </summary> | ||
2321 | <param name="value">The value.</param> | ||
2322 | <returns>The result of the conversion.</returns> | ||
2323 | </member> | ||
2324 | <member name="M:Newtonsoft.Json.Linq.JToken.op_Explicit(Newtonsoft.Json.Linq.JToken)~System.Nullable{System.Boolean}"> | ||
2325 | <summary> | ||
2326 | Performs an explicit conversion from <see cref="T:Newtonsoft.Json.Linq.JToken"/> to <see cref="T:System.Nullable`1"/>. | ||
2327 | </summary> | ||
2328 | <param name="value">The value.</param> | ||
2329 | <returns>The result of the conversion.</returns> | ||
2330 | </member> | ||
2331 | <member name="M:Newtonsoft.Json.Linq.JToken.op_Explicit(Newtonsoft.Json.Linq.JToken)~System.Int64"> | ||
2332 | <summary> | ||
2333 | Performs an explicit conversion from <see cref="T:Newtonsoft.Json.Linq.JToken"/> to <see cref="T:System.Int64"/>. | ||
2334 | </summary> | ||
2335 | <param name="value">The value.</param> | ||
2336 | <returns>The result of the conversion.</returns> | ||
2337 | </member> | ||
2338 | <member name="M:Newtonsoft.Json.Linq.JToken.op_Explicit(Newtonsoft.Json.Linq.JToken)~System.Nullable{System.DateTime}"> | ||
2339 | <summary> | ||
2340 | Performs an explicit conversion from <see cref="T:Newtonsoft.Json.Linq.JToken"/> to <see cref="T:System.Nullable`1"/>. | ||
2341 | </summary> | ||
2342 | <param name="value">The value.</param> | ||
2343 | <returns>The result of the conversion.</returns> | ||
2344 | </member> | ||
2345 | <member name="M:Newtonsoft.Json.Linq.JToken.op_Explicit(Newtonsoft.Json.Linq.JToken)~System.Nullable{System.DateTimeOffset}"> | ||
2346 | <summary> | ||
2347 | Performs an explicit conversion from <see cref="T:Newtonsoft.Json.Linq.JToken"/> to <see cref="T:System.Nullable`1"/>. | ||
2348 | </summary> | ||
2349 | <param name="value">The value.</param> | ||
2350 | <returns>The result of the conversion.</returns> | ||
2351 | </member> | ||
2352 | <member name="M:Newtonsoft.Json.Linq.JToken.op_Explicit(Newtonsoft.Json.Linq.JToken)~System.Nullable{System.Decimal}"> | ||
2353 | <summary> | ||
2354 | Performs an explicit conversion from <see cref="T:Newtonsoft.Json.Linq.JToken"/> to <see cref="T:System.Nullable`1"/>. | ||
2355 | </summary> | ||
2356 | <param name="value">The value.</param> | ||
2357 | <returns>The result of the conversion.</returns> | ||
2358 | </member> | ||
2359 | <member name="M:Newtonsoft.Json.Linq.JToken.op_Explicit(Newtonsoft.Json.Linq.JToken)~System.Nullable{System.Double}"> | ||
2360 | <summary> | ||
2361 | Performs an explicit conversion from <see cref="T:Newtonsoft.Json.Linq.JToken"/> to <see cref="T:System.Nullable`1"/>. | ||
2362 | </summary> | ||
2363 | <param name="value">The value.</param> | ||
2364 | <returns>The result of the conversion.</returns> | ||
2365 | </member> | ||
2366 | <member name="M:Newtonsoft.Json.Linq.JToken.op_Explicit(Newtonsoft.Json.Linq.JToken)~System.Nullable{System.Char}"> | ||
2367 | <summary> | ||
2368 | Performs an explicit conversion from <see cref="T:Newtonsoft.Json.Linq.JToken"/> to <see cref="T:System.Nullable`1"/>. | ||
2369 | </summary> | ||
2370 | <param name="value">The value.</param> | ||
2371 | <returns>The result of the conversion.</returns> | ||
2372 | </member> | ||
2373 | <member name="M:Newtonsoft.Json.Linq.JToken.op_Explicit(Newtonsoft.Json.Linq.JToken)~System.Int32"> | ||
2374 | <summary> | ||
2375 | Performs an explicit conversion from <see cref="T:Newtonsoft.Json.Linq.JToken"/> to <see cref="T:System.Int32"/>. | ||
2376 | </summary> | ||
2377 | <param name="value">The value.</param> | ||
2378 | <returns>The result of the conversion.</returns> | ||
2379 | </member> | ||
2380 | <member name="M:Newtonsoft.Json.Linq.JToken.op_Explicit(Newtonsoft.Json.Linq.JToken)~System.Int16"> | ||
2381 | <summary> | ||
2382 | Performs an explicit conversion from <see cref="T:Newtonsoft.Json.Linq.JToken"/> to <see cref="T:System.Int16"/>. | ||
2383 | </summary> | ||
2384 | <param name="value">The value.</param> | ||
2385 | <returns>The result of the conversion.</returns> | ||
2386 | </member> | ||
2387 | <member name="M:Newtonsoft.Json.Linq.JToken.op_Explicit(Newtonsoft.Json.Linq.JToken)~System.UInt16"> | ||
2388 | <summary> | ||
2389 | Performs an explicit conversion from <see cref="T:Newtonsoft.Json.Linq.JToken"/> to <see cref="T:System.UInt16"/>. | ||
2390 | </summary> | ||
2391 | <param name="value">The value.</param> | ||
2392 | <returns>The result of the conversion.</returns> | ||
2393 | </member> | ||
2394 | <member name="M:Newtonsoft.Json.Linq.JToken.op_Explicit(Newtonsoft.Json.Linq.JToken)~System.Char"> | ||
2395 | <summary> | ||
2396 | Performs an explicit conversion from <see cref="T:Newtonsoft.Json.Linq.JToken"/> to <see cref="T:System.Char"/>. | ||
2397 | </summary> | ||
2398 | <param name="value">The value.</param> | ||
2399 | <returns>The result of the conversion.</returns> | ||
2400 | </member> | ||
2401 | <member name="M:Newtonsoft.Json.Linq.JToken.op_Explicit(Newtonsoft.Json.Linq.JToken)~System.Byte"> | ||
2402 | <summary> | ||
2403 | Performs an explicit conversion from <see cref="T:Newtonsoft.Json.Linq.JToken"/> to <see cref="T:System.Byte"/>. | ||
2404 | </summary> | ||
2405 | <param name="value">The value.</param> | ||
2406 | <returns>The result of the conversion.</returns> | ||
2407 | </member> | ||
2408 | <member name="M:Newtonsoft.Json.Linq.JToken.op_Explicit(Newtonsoft.Json.Linq.JToken)~System.SByte"> | ||
2409 | <summary> | ||
2410 | Performs an explicit conversion from <see cref="T:Newtonsoft.Json.Linq.JToken"/> to <see cref="T:System.SByte"/>. | ||
2411 | </summary> | ||
2412 | <param name="value">The value.</param> | ||
2413 | <returns>The result of the conversion.</returns> | ||
2414 | </member> | ||
2415 | <member name="M:Newtonsoft.Json.Linq.JToken.op_Explicit(Newtonsoft.Json.Linq.JToken)~System.Nullable{System.Int32}"> | ||
2416 | <summary> | ||
2417 | Performs an explicit conversion from <see cref="T:Newtonsoft.Json.Linq.JToken"/> to <see cref="T:System.Nullable`1"/>. | ||
2418 | </summary> | ||
2419 | <param name="value">The value.</param> | ||
2420 | <returns>The result of the conversion.</returns> | ||
2421 | </member> | ||
2422 | <member name="M:Newtonsoft.Json.Linq.JToken.op_Explicit(Newtonsoft.Json.Linq.JToken)~System.Nullable{System.Int16}"> | ||
2423 | <summary> | ||
2424 | Performs an explicit conversion from <see cref="T:Newtonsoft.Json.Linq.JToken"/> to <see cref="T:System.Nullable`1"/>. | ||
2425 | </summary> | ||
2426 | <param name="value">The value.</param> | ||
2427 | <returns>The result of the conversion.</returns> | ||
2428 | </member> | ||
2429 | <member name="M:Newtonsoft.Json.Linq.JToken.op_Explicit(Newtonsoft.Json.Linq.JToken)~System.Nullable{System.UInt16}"> | ||
2430 | <summary> | ||
2431 | Performs an explicit conversion from <see cref="T:Newtonsoft.Json.Linq.JToken"/> to <see cref="T:System.Nullable`1"/>. | ||
2432 | </summary> | ||
2433 | <param name="value">The value.</param> | ||
2434 | <returns>The result of the conversion.</returns> | ||
2435 | </member> | ||
2436 | <member name="M:Newtonsoft.Json.Linq.JToken.op_Explicit(Newtonsoft.Json.Linq.JToken)~System.Nullable{System.Byte}"> | ||
2437 | <summary> | ||
2438 | Performs an explicit conversion from <see cref="T:Newtonsoft.Json.Linq.JToken"/> to <see cref="T:System.Nullable`1"/>. | ||
2439 | </summary> | ||
2440 | <param name="value">The value.</param> | ||
2441 | <returns>The result of the conversion.</returns> | ||
2442 | </member> | ||
2443 | <member name="M:Newtonsoft.Json.Linq.JToken.op_Explicit(Newtonsoft.Json.Linq.JToken)~System.Nullable{System.SByte}"> | ||
2444 | <summary> | ||
2445 | Performs an explicit conversion from <see cref="T:Newtonsoft.Json.Linq.JToken"/> to <see cref="T:System.Nullable`1"/>. | ||
2446 | </summary> | ||
2447 | <param name="value">The value.</param> | ||
2448 | <returns>The result of the conversion.</returns> | ||
2449 | </member> | ||
2450 | <member name="M:Newtonsoft.Json.Linq.JToken.op_Explicit(Newtonsoft.Json.Linq.JToken)~System.DateTime"> | ||
2451 | <summary> | ||
2452 | Performs an explicit conversion from <see cref="T:Newtonsoft.Json.Linq.JToken"/> to <see cref="T:System.DateTime"/>. | ||
2453 | </summary> | ||
2454 | <param name="value">The value.</param> | ||
2455 | <returns>The result of the conversion.</returns> | ||
2456 | </member> | ||
2457 | <member name="M:Newtonsoft.Json.Linq.JToken.op_Explicit(Newtonsoft.Json.Linq.JToken)~System.Nullable{System.Int64}"> | ||
2458 | <summary> | ||
2459 | Performs an explicit conversion from <see cref="T:Newtonsoft.Json.Linq.JToken"/> to <see cref="T:System.Nullable`1"/>. | ||
2460 | </summary> | ||
2461 | <param name="value">The value.</param> | ||
2462 | <returns>The result of the conversion.</returns> | ||
2463 | </member> | ||
2464 | <member name="M:Newtonsoft.Json.Linq.JToken.op_Explicit(Newtonsoft.Json.Linq.JToken)~System.Nullable{System.Single}"> | ||
2465 | <summary> | ||
2466 | Performs an explicit conversion from <see cref="T:Newtonsoft.Json.Linq.JToken"/> to <see cref="T:System.Nullable`1"/>. | ||
2467 | </summary> | ||
2468 | <param name="value">The value.</param> | ||
2469 | <returns>The result of the conversion.</returns> | ||
2470 | </member> | ||
2471 | <member name="M:Newtonsoft.Json.Linq.JToken.op_Explicit(Newtonsoft.Json.Linq.JToken)~System.Decimal"> | ||
2472 | <summary> | ||
2473 | Performs an explicit conversion from <see cref="T:Newtonsoft.Json.Linq.JToken"/> to <see cref="T:System.Decimal"/>. | ||
2474 | </summary> | ||
2475 | <param name="value">The value.</param> | ||
2476 | <returns>The result of the conversion.</returns> | ||
2477 | </member> | ||
2478 | <member name="M:Newtonsoft.Json.Linq.JToken.op_Explicit(Newtonsoft.Json.Linq.JToken)~System.Nullable{System.UInt32}"> | ||
2479 | <summary> | ||
2480 | Performs an explicit conversion from <see cref="T:Newtonsoft.Json.Linq.JToken"/> to <see cref="T:System.Nullable`1"/>. | ||
2481 | </summary> | ||
2482 | <param name="value">The value.</param> | ||
2483 | <returns>The result of the conversion.</returns> | ||
2484 | </member> | ||
2485 | <member name="M:Newtonsoft.Json.Linq.JToken.op_Explicit(Newtonsoft.Json.Linq.JToken)~System.Nullable{System.UInt64}"> | ||
2486 | <summary> | ||
2487 | Performs an explicit conversion from <see cref="T:Newtonsoft.Json.Linq.JToken"/> to <see cref="T:System.Nullable`1"/>. | ||
2488 | </summary> | ||
2489 | <param name="value">The value.</param> | ||
2490 | <returns>The result of the conversion.</returns> | ||
2491 | </member> | ||
2492 | <member name="M:Newtonsoft.Json.Linq.JToken.op_Explicit(Newtonsoft.Json.Linq.JToken)~System.Double"> | ||
2493 | <summary> | ||
2494 | Performs an explicit conversion from <see cref="T:Newtonsoft.Json.Linq.JToken"/> to <see cref="T:System.Double"/>. | ||
2495 | </summary> | ||
2496 | <param name="value">The value.</param> | ||
2497 | <returns>The result of the conversion.</returns> | ||
2498 | </member> | ||
2499 | <member name="M:Newtonsoft.Json.Linq.JToken.op_Explicit(Newtonsoft.Json.Linq.JToken)~System.Single"> | ||
2500 | <summary> | ||
2501 | Performs an explicit conversion from <see cref="T:Newtonsoft.Json.Linq.JToken"/> to <see cref="T:System.Single"/>. | ||
2502 | </summary> | ||
2503 | <param name="value">The value.</param> | ||
2504 | <returns>The result of the conversion.</returns> | ||
2505 | </member> | ||
2506 | <member name="M:Newtonsoft.Json.Linq.JToken.op_Explicit(Newtonsoft.Json.Linq.JToken)~System.String"> | ||
2507 | <summary> | ||
2508 | Performs an explicit conversion from <see cref="T:Newtonsoft.Json.Linq.JToken"/> to <see cref="T:System.String"/>. | ||
2509 | </summary> | ||
2510 | <param name="value">The value.</param> | ||
2511 | <returns>The result of the conversion.</returns> | ||
2512 | </member> | ||
2513 | <member name="M:Newtonsoft.Json.Linq.JToken.op_Explicit(Newtonsoft.Json.Linq.JToken)~System.UInt32"> | ||
2514 | <summary> | ||
2515 | Performs an explicit conversion from <see cref="T:Newtonsoft.Json.Linq.JToken"/> to <see cref="T:System.UInt32"/>. | ||
2516 | </summary> | ||
2517 | <param name="value">The value.</param> | ||
2518 | <returns>The result of the conversion.</returns> | ||
2519 | </member> | ||
2520 | <member name="M:Newtonsoft.Json.Linq.JToken.op_Explicit(Newtonsoft.Json.Linq.JToken)~System.UInt64"> | ||
2521 | <summary> | ||
2522 | Performs an explicit conversion from <see cref="T:Newtonsoft.Json.Linq.JToken"/> to <see cref="T:System.UInt64"/>. | ||
2523 | </summary> | ||
2524 | <param name="value">The value.</param> | ||
2525 | <returns>The result of the conversion.</returns> | ||
2526 | </member> | ||
2527 | <member name="M:Newtonsoft.Json.Linq.JToken.op_Explicit(Newtonsoft.Json.Linq.JToken)~System.Byte[]"> | ||
2528 | <summary> | ||
2529 | Performs an explicit conversion from <see cref="T:Newtonsoft.Json.Linq.JToken"/> to <see cref="T:System.Byte[]"/>. | ||
2530 | </summary> | ||
2531 | <param name="value">The value.</param> | ||
2532 | <returns>The result of the conversion.</returns> | ||
2533 | </member> | ||
2534 | <member name="M:Newtonsoft.Json.Linq.JToken.op_Explicit(Newtonsoft.Json.Linq.JToken)~System.Guid"> | ||
2535 | <summary> | ||
2536 | Performs an explicit conversion from <see cref="T:Newtonsoft.Json.Linq.JToken"/> to <see cref="T:System.Guid"/>. | ||
2537 | </summary> | ||
2538 | <param name="value">The value.</param> | ||
2539 | <returns>The result of the conversion.</returns> | ||
2540 | </member> | ||
2541 | <member name="M:Newtonsoft.Json.Linq.JToken.op_Explicit(Newtonsoft.Json.Linq.JToken)~System.Nullable{System.Guid}"> | ||
2542 | <summary> | ||
2543 | Performs an explicit conversion from <see cref="T:Newtonsoft.Json.Linq.JToken"/> to <see cref="T:System.Guid"/>. | ||
2544 | </summary> | ||
2545 | <param name="value">The value.</param> | ||
2546 | <returns>The result of the conversion.</returns> | ||
2547 | </member> | ||
2548 | <member name="M:Newtonsoft.Json.Linq.JToken.op_Explicit(Newtonsoft.Json.Linq.JToken)~System.TimeSpan"> | ||
2549 | <summary> | ||
2550 | Performs an explicit conversion from <see cref="T:Newtonsoft.Json.Linq.JToken"/> to <see cref="T:System.TimeSpan"/>. | ||
2551 | </summary> | ||
2552 | <param name="value">The value.</param> | ||
2553 | <returns>The result of the conversion.</returns> | ||
2554 | </member> | ||
2555 | <member name="M:Newtonsoft.Json.Linq.JToken.op_Explicit(Newtonsoft.Json.Linq.JToken)~System.Nullable{System.TimeSpan}"> | ||
2556 | <summary> | ||
2557 | Performs an explicit conversion from <see cref="T:Newtonsoft.Json.Linq.JToken"/> to <see cref="T:System.TimeSpan"/>. | ||
2558 | </summary> | ||
2559 | <param name="value">The value.</param> | ||
2560 | <returns>The result of the conversion.</returns> | ||
2561 | </member> | ||
2562 | <member name="M:Newtonsoft.Json.Linq.JToken.op_Explicit(Newtonsoft.Json.Linq.JToken)~System.Uri"> | ||
2563 | <summary> | ||
2564 | Performs an explicit conversion from <see cref="T:Newtonsoft.Json.Linq.JToken"/> to <see cref="T:System.Uri"/>. | ||
2565 | </summary> | ||
2566 | <param name="value">The value.</param> | ||
2567 | <returns>The result of the conversion.</returns> | ||
2568 | </member> | ||
2569 | <member name="M:Newtonsoft.Json.Linq.JToken.op_Implicit(System.Boolean)~Newtonsoft.Json.Linq.JToken"> | ||
2570 | <summary> | ||
2571 | Performs an implicit conversion from <see cref="T:System.Boolean"/> to <see cref="T:Newtonsoft.Json.Linq.JToken"/>. | ||
2572 | </summary> | ||
2573 | <param name="value">The value to create a <see cref="T:Newtonsoft.Json.Linq.JValue"/> from.</param> | ||
2574 | <returns>The <see cref="T:Newtonsoft.Json.Linq.JValue"/> initialized with the specified value.</returns> | ||
2575 | </member> | ||
2576 | <member name="M:Newtonsoft.Json.Linq.JToken.op_Implicit(System.DateTimeOffset)~Newtonsoft.Json.Linq.JToken"> | ||
2577 | <summary> | ||
2578 | Performs an implicit conversion from <see cref="T:System.DateTimeOffset"/> to <see cref="T:Newtonsoft.Json.Linq.JToken"/>. | ||
2579 | </summary> | ||
2580 | <param name="value">The value to create a <see cref="T:Newtonsoft.Json.Linq.JValue"/> from.</param> | ||
2581 | <returns>The <see cref="T:Newtonsoft.Json.Linq.JValue"/> initialized with the specified value.</returns> | ||
2582 | </member> | ||
2583 | <member name="M:Newtonsoft.Json.Linq.JToken.op_Implicit(System.Byte)~Newtonsoft.Json.Linq.JToken"> | ||
2584 | <summary> | ||
2585 | Performs an implicit conversion from <see cref="T:System.Byte"/> to <see cref="T:Newtonsoft.Json.Linq.JToken"/>. | ||
2586 | </summary> | ||
2587 | <param name="value">The value to create a <see cref="T:Newtonsoft.Json.Linq.JValue"/> from.</param> | ||
2588 | <returns>The <see cref="T:Newtonsoft.Json.Linq.JValue"/> initialized with the specified value.</returns> | ||
2589 | </member> | ||
2590 | <member name="M:Newtonsoft.Json.Linq.JToken.op_Implicit(System.Nullable{System.Byte})~Newtonsoft.Json.Linq.JToken"> | ||
2591 | <summary> | ||
2592 | Performs an implicit conversion from <see cref="T:System.Nullable`1"/> to <see cref="T:Newtonsoft.Json.Linq.JToken"/>. | ||
2593 | </summary> | ||
2594 | <param name="value">The value to create a <see cref="T:Newtonsoft.Json.Linq.JValue"/> from.</param> | ||
2595 | <returns>The <see cref="T:Newtonsoft.Json.Linq.JValue"/> initialized with the specified value.</returns> | ||
2596 | </member> | ||
2597 | <member name="M:Newtonsoft.Json.Linq.JToken.op_Implicit(System.SByte)~Newtonsoft.Json.Linq.JToken"> | ||
2598 | <summary> | ||
2599 | Performs an implicit conversion from <see cref="T:System.SByte"/> to <see cref="T:Newtonsoft.Json.Linq.JToken"/>. | ||
2600 | </summary> | ||
2601 | <param name="value">The value to create a <see cref="T:Newtonsoft.Json.Linq.JValue"/> from.</param> | ||
2602 | <returns>The <see cref="T:Newtonsoft.Json.Linq.JValue"/> initialized with the specified value.</returns> | ||
2603 | </member> | ||
2604 | <member name="M:Newtonsoft.Json.Linq.JToken.op_Implicit(System.Nullable{System.SByte})~Newtonsoft.Json.Linq.JToken"> | ||
2605 | <summary> | ||
2606 | Performs an implicit conversion from <see cref="T:System.Nullable`1"/> to <see cref="T:Newtonsoft.Json.Linq.JToken"/>. | ||
2607 | </summary> | ||
2608 | <param name="value">The value to create a <see cref="T:Newtonsoft.Json.Linq.JValue"/> from.</param> | ||
2609 | <returns>The <see cref="T:Newtonsoft.Json.Linq.JValue"/> initialized with the specified value.</returns> | ||
2610 | </member> | ||
2611 | <member name="M:Newtonsoft.Json.Linq.JToken.op_Implicit(System.Nullable{System.Boolean})~Newtonsoft.Json.Linq.JToken"> | ||
2612 | <summary> | ||
2613 | Performs an implicit conversion from <see cref="T:System.Nullable`1"/> to <see cref="T:Newtonsoft.Json.Linq.JToken"/>. | ||
2614 | </summary> | ||
2615 | <param name="value">The value to create a <see cref="T:Newtonsoft.Json.Linq.JValue"/> from.</param> | ||
2616 | <returns>The <see cref="T:Newtonsoft.Json.Linq.JValue"/> initialized with the specified value.</returns> | ||
2617 | </member> | ||
2618 | <member name="M:Newtonsoft.Json.Linq.JToken.op_Implicit(System.Int64)~Newtonsoft.Json.Linq.JToken"> | ||
2619 | <summary> | ||
2620 | Performs an implicit conversion from <see cref="T:System.Nullable`1"/> to <see cref="T:Newtonsoft.Json.Linq.JToken"/>. | ||
2621 | </summary> | ||
2622 | <param name="value">The value to create a <see cref="T:Newtonsoft.Json.Linq.JValue"/> from.</param> | ||
2623 | <returns>The <see cref="T:Newtonsoft.Json.Linq.JValue"/> initialized with the specified value.</returns> | ||
2624 | </member> | ||
2625 | <member name="M:Newtonsoft.Json.Linq.JToken.op_Implicit(System.Nullable{System.DateTime})~Newtonsoft.Json.Linq.JToken"> | ||
2626 | <summary> | ||
2627 | Performs an implicit conversion from <see cref="T:System.Nullable`1"/> to <see cref="T:Newtonsoft.Json.Linq.JToken"/>. | ||
2628 | </summary> | ||
2629 | <param name="value">The value to create a <see cref="T:Newtonsoft.Json.Linq.JValue"/> from.</param> | ||
2630 | <returns>The <see cref="T:Newtonsoft.Json.Linq.JValue"/> initialized with the specified value.</returns> | ||
2631 | </member> | ||
2632 | <member name="M:Newtonsoft.Json.Linq.JToken.op_Implicit(System.Nullable{System.DateTimeOffset})~Newtonsoft.Json.Linq.JToken"> | ||
2633 | <summary> | ||
2634 | Performs an implicit conversion from <see cref="T:System.Nullable`1"/> to <see cref="T:Newtonsoft.Json.Linq.JToken"/>. | ||
2635 | </summary> | ||
2636 | <param name="value">The value to create a <see cref="T:Newtonsoft.Json.Linq.JValue"/> from.</param> | ||
2637 | <returns>The <see cref="T:Newtonsoft.Json.Linq.JValue"/> initialized with the specified value.</returns> | ||
2638 | </member> | ||
2639 | <member name="M:Newtonsoft.Json.Linq.JToken.op_Implicit(System.Nullable{System.Decimal})~Newtonsoft.Json.Linq.JToken"> | ||
2640 | <summary> | ||
2641 | Performs an implicit conversion from <see cref="T:System.Nullable`1"/> to <see cref="T:Newtonsoft.Json.Linq.JToken"/>. | ||
2642 | </summary> | ||
2643 | <param name="value">The value to create a <see cref="T:Newtonsoft.Json.Linq.JValue"/> from.</param> | ||
2644 | <returns>The <see cref="T:Newtonsoft.Json.Linq.JValue"/> initialized with the specified value.</returns> | ||
2645 | </member> | ||
2646 | <member name="M:Newtonsoft.Json.Linq.JToken.op_Implicit(System.Nullable{System.Double})~Newtonsoft.Json.Linq.JToken"> | ||
2647 | <summary> | ||
2648 | Performs an implicit conversion from <see cref="T:System.Nullable`1"/> to <see cref="T:Newtonsoft.Json.Linq.JToken"/>. | ||
2649 | </summary> | ||
2650 | <param name="value">The value to create a <see cref="T:Newtonsoft.Json.Linq.JValue"/> from.</param> | ||
2651 | <returns>The <see cref="T:Newtonsoft.Json.Linq.JValue"/> initialized with the specified value.</returns> | ||
2652 | </member> | ||
2653 | <member name="M:Newtonsoft.Json.Linq.JToken.op_Implicit(System.Int16)~Newtonsoft.Json.Linq.JToken"> | ||
2654 | <summary> | ||
2655 | Performs an implicit conversion from <see cref="T:System.Int16"/> to <see cref="T:Newtonsoft.Json.Linq.JToken"/>. | ||
2656 | </summary> | ||
2657 | <param name="value">The value to create a <see cref="T:Newtonsoft.Json.Linq.JValue"/> from.</param> | ||
2658 | <returns>The <see cref="T:Newtonsoft.Json.Linq.JValue"/> initialized with the specified value.</returns> | ||
2659 | </member> | ||
2660 | <member name="M:Newtonsoft.Json.Linq.JToken.op_Implicit(System.UInt16)~Newtonsoft.Json.Linq.JToken"> | ||
2661 | <summary> | ||
2662 | Performs an implicit conversion from <see cref="T:System.UInt16"/> to <see cref="T:Newtonsoft.Json.Linq.JToken"/>. | ||
2663 | </summary> | ||
2664 | <param name="value">The value to create a <see cref="T:Newtonsoft.Json.Linq.JValue"/> from.</param> | ||
2665 | <returns>The <see cref="T:Newtonsoft.Json.Linq.JValue"/> initialized with the specified value.</returns> | ||
2666 | </member> | ||
2667 | <member name="M:Newtonsoft.Json.Linq.JToken.op_Implicit(System.Int32)~Newtonsoft.Json.Linq.JToken"> | ||
2668 | <summary> | ||
2669 | Performs an implicit conversion from <see cref="T:System.Int32"/> to <see cref="T:Newtonsoft.Json.Linq.JToken"/>. | ||
2670 | </summary> | ||
2671 | <param name="value">The value to create a <see cref="T:Newtonsoft.Json.Linq.JValue"/> from.</param> | ||
2672 | <returns>The <see cref="T:Newtonsoft.Json.Linq.JValue"/> initialized with the specified value.</returns> | ||
2673 | </member> | ||
2674 | <member name="M:Newtonsoft.Json.Linq.JToken.op_Implicit(System.Nullable{System.Int32})~Newtonsoft.Json.Linq.JToken"> | ||
2675 | <summary> | ||
2676 | Performs an implicit conversion from <see cref="T:System.Nullable`1"/> to <see cref="T:Newtonsoft.Json.Linq.JToken"/>. | ||
2677 | </summary> | ||
2678 | <param name="value">The value to create a <see cref="T:Newtonsoft.Json.Linq.JValue"/> from.</param> | ||
2679 | <returns>The <see cref="T:Newtonsoft.Json.Linq.JValue"/> initialized with the specified value.</returns> | ||
2680 | </member> | ||
2681 | <member name="M:Newtonsoft.Json.Linq.JToken.op_Implicit(System.DateTime)~Newtonsoft.Json.Linq.JToken"> | ||
2682 | <summary> | ||
2683 | Performs an implicit conversion from <see cref="T:System.DateTime"/> to <see cref="T:Newtonsoft.Json.Linq.JToken"/>. | ||
2684 | </summary> | ||
2685 | <param name="value">The value to create a <see cref="T:Newtonsoft.Json.Linq.JValue"/> from.</param> | ||
2686 | <returns>The <see cref="T:Newtonsoft.Json.Linq.JValue"/> initialized with the specified value.</returns> | ||
2687 | </member> | ||
2688 | <member name="M:Newtonsoft.Json.Linq.JToken.op_Implicit(System.Nullable{System.Int64})~Newtonsoft.Json.Linq.JToken"> | ||
2689 | <summary> | ||
2690 | Performs an implicit conversion from <see cref="T:System.Nullable`1"/> to <see cref="T:Newtonsoft.Json.Linq.JToken"/>. | ||
2691 | </summary> | ||
2692 | <param name="value">The value to create a <see cref="T:Newtonsoft.Json.Linq.JValue"/> from.</param> | ||
2693 | <returns>The <see cref="T:Newtonsoft.Json.Linq.JValue"/> initialized with the specified value.</returns> | ||
2694 | </member> | ||
2695 | <member name="M:Newtonsoft.Json.Linq.JToken.op_Implicit(System.Nullable{System.Single})~Newtonsoft.Json.Linq.JToken"> | ||
2696 | <summary> | ||
2697 | Performs an implicit conversion from <see cref="T:System.Nullable`1"/> to <see cref="T:Newtonsoft.Json.Linq.JToken"/>. | ||
2698 | </summary> | ||
2699 | <param name="value">The value to create a <see cref="T:Newtonsoft.Json.Linq.JValue"/> from.</param> | ||
2700 | <returns>The <see cref="T:Newtonsoft.Json.Linq.JValue"/> initialized with the specified value.</returns> | ||
2701 | </member> | ||
2702 | <member name="M:Newtonsoft.Json.Linq.JToken.op_Implicit(System.Decimal)~Newtonsoft.Json.Linq.JToken"> | ||
2703 | <summary> | ||
2704 | Performs an implicit conversion from <see cref="T:System.Decimal"/> to <see cref="T:Newtonsoft.Json.Linq.JToken"/>. | ||
2705 | </summary> | ||
2706 | <param name="value">The value to create a <see cref="T:Newtonsoft.Json.Linq.JValue"/> from.</param> | ||
2707 | <returns>The <see cref="T:Newtonsoft.Json.Linq.JValue"/> initialized with the specified value.</returns> | ||
2708 | </member> | ||
2709 | <member name="M:Newtonsoft.Json.Linq.JToken.op_Implicit(System.Nullable{System.Int16})~Newtonsoft.Json.Linq.JToken"> | ||
2710 | <summary> | ||
2711 | Performs an implicit conversion from <see cref="T:System.Nullable`1"/> to <see cref="T:Newtonsoft.Json.Linq.JToken"/>. | ||
2712 | </summary> | ||
2713 | <param name="value">The value to create a <see cref="T:Newtonsoft.Json.Linq.JValue"/> from.</param> | ||
2714 | <returns>The <see cref="T:Newtonsoft.Json.Linq.JValue"/> initialized with the specified value.</returns> | ||
2715 | </member> | ||
2716 | <member name="M:Newtonsoft.Json.Linq.JToken.op_Implicit(System.Nullable{System.UInt16})~Newtonsoft.Json.Linq.JToken"> | ||
2717 | <summary> | ||
2718 | Performs an implicit conversion from <see cref="T:System.Nullable`1"/> to <see cref="T:Newtonsoft.Json.Linq.JToken"/>. | ||
2719 | </summary> | ||
2720 | <param name="value">The value to create a <see cref="T:Newtonsoft.Json.Linq.JValue"/> from.</param> | ||
2721 | <returns>The <see cref="T:Newtonsoft.Json.Linq.JValue"/> initialized with the specified value.</returns> | ||
2722 | </member> | ||
2723 | <member name="M:Newtonsoft.Json.Linq.JToken.op_Implicit(System.Nullable{System.UInt32})~Newtonsoft.Json.Linq.JToken"> | ||
2724 | <summary> | ||
2725 | Performs an implicit conversion from <see cref="T:System.Nullable`1"/> to <see cref="T:Newtonsoft.Json.Linq.JToken"/>. | ||
2726 | </summary> | ||
2727 | <param name="value">The value to create a <see cref="T:Newtonsoft.Json.Linq.JValue"/> from.</param> | ||
2728 | <returns>The <see cref="T:Newtonsoft.Json.Linq.JValue"/> initialized with the specified value.</returns> | ||
2729 | </member> | ||
2730 | <member name="M:Newtonsoft.Json.Linq.JToken.op_Implicit(System.Nullable{System.UInt64})~Newtonsoft.Json.Linq.JToken"> | ||
2731 | <summary> | ||
2732 | Performs an implicit conversion from <see cref="T:System.Nullable`1"/> to <see cref="T:Newtonsoft.Json.Linq.JToken"/>. | ||
2733 | </summary> | ||
2734 | <param name="value">The value to create a <see cref="T:Newtonsoft.Json.Linq.JValue"/> from.</param> | ||
2735 | <returns>The <see cref="T:Newtonsoft.Json.Linq.JValue"/> initialized with the specified value.</returns> | ||
2736 | </member> | ||
2737 | <member name="M:Newtonsoft.Json.Linq.JToken.op_Implicit(System.Double)~Newtonsoft.Json.Linq.JToken"> | ||
2738 | <summary> | ||
2739 | Performs an implicit conversion from <see cref="T:System.Double"/> to <see cref="T:Newtonsoft.Json.Linq.JToken"/>. | ||
2740 | </summary> | ||
2741 | <param name="value">The value to create a <see cref="T:Newtonsoft.Json.Linq.JValue"/> from.</param> | ||
2742 | <returns>The <see cref="T:Newtonsoft.Json.Linq.JValue"/> initialized with the specified value.</returns> | ||
2743 | </member> | ||
2744 | <member name="M:Newtonsoft.Json.Linq.JToken.op_Implicit(System.Single)~Newtonsoft.Json.Linq.JToken"> | ||
2745 | <summary> | ||
2746 | Performs an implicit conversion from <see cref="T:System.Single"/> to <see cref="T:Newtonsoft.Json.Linq.JToken"/>. | ||
2747 | </summary> | ||
2748 | <param name="value">The value to create a <see cref="T:Newtonsoft.Json.Linq.JValue"/> from.</param> | ||
2749 | <returns>The <see cref="T:Newtonsoft.Json.Linq.JValue"/> initialized with the specified value.</returns> | ||
2750 | </member> | ||
2751 | <member name="M:Newtonsoft.Json.Linq.JToken.op_Implicit(System.String)~Newtonsoft.Json.Linq.JToken"> | ||
2752 | <summary> | ||
2753 | Performs an implicit conversion from <see cref="T:System.String"/> to <see cref="T:Newtonsoft.Json.Linq.JToken"/>. | ||
2754 | </summary> | ||
2755 | <param name="value">The value to create a <see cref="T:Newtonsoft.Json.Linq.JValue"/> from.</param> | ||
2756 | <returns>The <see cref="T:Newtonsoft.Json.Linq.JValue"/> initialized with the specified value.</returns> | ||
2757 | </member> | ||
2758 | <member name="M:Newtonsoft.Json.Linq.JToken.op_Implicit(System.UInt32)~Newtonsoft.Json.Linq.JToken"> | ||
2759 | <summary> | ||
2760 | Performs an implicit conversion from <see cref="T:System.UInt32"/> to <see cref="T:Newtonsoft.Json.Linq.JToken"/>. | ||
2761 | </summary> | ||
2762 | <param name="value">The value to create a <see cref="T:Newtonsoft.Json.Linq.JValue"/> from.</param> | ||
2763 | <returns>The <see cref="T:Newtonsoft.Json.Linq.JValue"/> initialized with the specified value.</returns> | ||
2764 | </member> | ||
2765 | <member name="M:Newtonsoft.Json.Linq.JToken.op_Implicit(System.UInt64)~Newtonsoft.Json.Linq.JToken"> | ||
2766 | <summary> | ||
2767 | Performs an implicit conversion from <see cref="T:System.UInt64"/> to <see cref="T:Newtonsoft.Json.Linq.JToken"/>. | ||
2768 | </summary> | ||
2769 | <param name="value">The value to create a <see cref="T:Newtonsoft.Json.Linq.JValue"/> from.</param> | ||
2770 | <returns>The <see cref="T:Newtonsoft.Json.Linq.JValue"/> initialized with the specified value.</returns> | ||
2771 | </member> | ||
2772 | <member name="M:Newtonsoft.Json.Linq.JToken.op_Implicit(System.Byte[])~Newtonsoft.Json.Linq.JToken"> | ||
2773 | <summary> | ||
2774 | Performs an implicit conversion from <see cref="T:System.Byte[]"/> to <see cref="T:Newtonsoft.Json.Linq.JToken"/>. | ||
2775 | </summary> | ||
2776 | <param name="value">The value to create a <see cref="T:Newtonsoft.Json.Linq.JValue"/> from.</param> | ||
2777 | <returns>The <see cref="T:Newtonsoft.Json.Linq.JValue"/> initialized with the specified value.</returns> | ||
2778 | </member> | ||
2779 | <member name="M:Newtonsoft.Json.Linq.JToken.op_Implicit(System.Uri)~Newtonsoft.Json.Linq.JToken"> | ||
2780 | <summary> | ||
2781 | Performs an implicit conversion from <see cref="T:System.Uri"/> to <see cref="T:Newtonsoft.Json.Linq.JToken"/>. | ||
2782 | </summary> | ||
2783 | <param name="value">The value to create a <see cref="T:Newtonsoft.Json.Linq.JValue"/> from.</param> | ||
2784 | <returns>The <see cref="T:Newtonsoft.Json.Linq.JValue"/> initialized with the specified value.</returns> | ||
2785 | </member> | ||
2786 | <member name="M:Newtonsoft.Json.Linq.JToken.op_Implicit(System.TimeSpan)~Newtonsoft.Json.Linq.JToken"> | ||
2787 | <summary> | ||
2788 | Performs an implicit conversion from <see cref="T:System.TimeSpan"/> to <see cref="T:Newtonsoft.Json.Linq.JToken"/>. | ||
2789 | </summary> | ||
2790 | <param name="value">The value to create a <see cref="T:Newtonsoft.Json.Linq.JValue"/> from.</param> | ||
2791 | <returns>The <see cref="T:Newtonsoft.Json.Linq.JValue"/> initialized with the specified value.</returns> | ||
2792 | </member> | ||
2793 | <member name="M:Newtonsoft.Json.Linq.JToken.op_Implicit(System.Nullable{System.TimeSpan})~Newtonsoft.Json.Linq.JToken"> | ||
2794 | <summary> | ||
2795 | Performs an implicit conversion from <see cref="T:System.Nullable`1"/> to <see cref="T:Newtonsoft.Json.Linq.JToken"/>. | ||
2796 | </summary> | ||
2797 | <param name="value">The value to create a <see cref="T:Newtonsoft.Json.Linq.JValue"/> from.</param> | ||
2798 | <returns>The <see cref="T:Newtonsoft.Json.Linq.JValue"/> initialized with the specified value.</returns> | ||
2799 | </member> | ||
2800 | <member name="M:Newtonsoft.Json.Linq.JToken.op_Implicit(System.Guid)~Newtonsoft.Json.Linq.JToken"> | ||
2801 | <summary> | ||
2802 | Performs an implicit conversion from <see cref="T:System.Guid"/> to <see cref="T:Newtonsoft.Json.Linq.JToken"/>. | ||
2803 | </summary> | ||
2804 | <param name="value">The value to create a <see cref="T:Newtonsoft.Json.Linq.JValue"/> from.</param> | ||
2805 | <returns>The <see cref="T:Newtonsoft.Json.Linq.JValue"/> initialized with the specified value.</returns> | ||
2806 | </member> | ||
2807 | <member name="M:Newtonsoft.Json.Linq.JToken.op_Implicit(System.Nullable{System.Guid})~Newtonsoft.Json.Linq.JToken"> | ||
2808 | <summary> | ||
2809 | Performs an implicit conversion from <see cref="T:System.Nullable`1"/> to <see cref="T:Newtonsoft.Json.Linq.JToken"/>. | ||
2810 | </summary> | ||
2811 | <param name="value">The value to create a <see cref="T:Newtonsoft.Json.Linq.JValue"/> from.</param> | ||
2812 | <returns>The <see cref="T:Newtonsoft.Json.Linq.JValue"/> initialized with the specified value.</returns> | ||
2813 | </member> | ||
2814 | <member name="M:Newtonsoft.Json.Linq.JToken.CreateReader"> | ||
2815 | <summary> | ||
2816 | Creates an <see cref="T:Newtonsoft.Json.JsonReader"/> for this token. | ||
2817 | </summary> | ||
2818 | <returns>An <see cref="T:Newtonsoft.Json.JsonReader"/> that can be used to read this token and its descendants.</returns> | ||
2819 | </member> | ||
2820 | <member name="M:Newtonsoft.Json.Linq.JToken.FromObject(System.Object)"> | ||
2821 | <summary> | ||
2822 | Creates a <see cref="T:Newtonsoft.Json.Linq.JToken"/> from an object. | ||
2823 | </summary> | ||
2824 | <param name="o">The object that will be used to create <see cref="T:Newtonsoft.Json.Linq.JToken"/>.</param> | ||
2825 | <returns>A <see cref="T:Newtonsoft.Json.Linq.JToken"/> with the value of the specified object</returns> | ||
2826 | </member> | ||
2827 | <member name="M:Newtonsoft.Json.Linq.JToken.FromObject(System.Object,Newtonsoft.Json.JsonSerializer)"> | ||
2828 | <summary> | ||
2829 | Creates a <see cref="T:Newtonsoft.Json.Linq.JToken"/> from an object using the specified <see cref="T:Newtonsoft.Json.JsonSerializer"/>. | ||
2830 | </summary> | ||
2831 | <param name="o">The object that will be used to create <see cref="T:Newtonsoft.Json.Linq.JToken"/>.</param> | ||
2832 | <param name="jsonSerializer">The <see cref="T:Newtonsoft.Json.JsonSerializer"/> that will be used when reading the object.</param> | ||
2833 | <returns>A <see cref="T:Newtonsoft.Json.Linq.JToken"/> with the value of the specified object</returns> | ||
2834 | </member> | ||
2835 | <member name="M:Newtonsoft.Json.Linq.JToken.ToObject``1"> | ||
2836 | <summary> | ||
2837 | Creates the specified .NET type from the <see cref="T:Newtonsoft.Json.Linq.JToken"/>. | ||
2838 | </summary> | ||
2839 | <typeparam name="T">The object type that the token will be deserialized to.</typeparam> | ||
2840 | <returns>The new object created from the JSON value.</returns> | ||
2841 | </member> | ||
2842 | <member name="M:Newtonsoft.Json.Linq.JToken.ToObject(System.Type)"> | ||
2843 | <summary> | ||
2844 | Creates the specified .NET type from the <see cref="T:Newtonsoft.Json.Linq.JToken"/>. | ||
2845 | </summary> | ||
2846 | <param name="objectType">The object type that the token will be deserialized to.</param> | ||
2847 | <returns>The new object created from the JSON value.</returns> | ||
2848 | </member> | ||
2849 | <member name="M:Newtonsoft.Json.Linq.JToken.ToObject``1(Newtonsoft.Json.JsonSerializer)"> | ||
2850 | <summary> | ||
2851 | Creates the specified .NET type from the <see cref="T:Newtonsoft.Json.Linq.JToken"/> using the specified <see cref="T:Newtonsoft.Json.JsonSerializer"/>. | ||
2852 | </summary> | ||
2853 | <typeparam name="T">The object type that the token will be deserialized to.</typeparam> | ||
2854 | <param name="jsonSerializer">The <see cref="T:Newtonsoft.Json.JsonSerializer"/> that will be used when creating the object.</param> | ||
2855 | <returns>The new object created from the JSON value.</returns> | ||
2856 | </member> | ||
2857 | <member name="M:Newtonsoft.Json.Linq.JToken.ToObject(System.Type,Newtonsoft.Json.JsonSerializer)"> | ||
2858 | <summary> | ||
2859 | Creates the specified .NET type from the <see cref="T:Newtonsoft.Json.Linq.JToken"/> using the specified <see cref="T:Newtonsoft.Json.JsonSerializer"/>. | ||
2860 | </summary> | ||
2861 | <param name="objectType">The object type that the token will be deserialized to.</param> | ||
2862 | <param name="jsonSerializer">The <see cref="T:Newtonsoft.Json.JsonSerializer"/> that will be used when creating the object.</param> | ||
2863 | <returns>The new object created from the JSON value.</returns> | ||
2864 | </member> | ||
2865 | <member name="M:Newtonsoft.Json.Linq.JToken.ReadFrom(Newtonsoft.Json.JsonReader)"> | ||
2866 | <summary> | ||
2867 | Creates a <see cref="T:Newtonsoft.Json.Linq.JToken"/> from a <see cref="T:Newtonsoft.Json.JsonReader"/>. | ||
2868 | </summary> | ||
2869 | <param name="reader">An <see cref="T:Newtonsoft.Json.JsonReader"/> positioned at the token to read into this <see cref="T:Newtonsoft.Json.Linq.JToken"/>.</param> | ||
2870 | <returns> | ||
2871 | An <see cref="T:Newtonsoft.Json.Linq.JToken"/> that contains the token and its descendant tokens | ||
2872 | that were read from the reader. The runtime type of the token is determined | ||
2873 | by the token type of the first token encountered in the reader. | ||
2874 | </returns> | ||
2875 | </member> | ||
2876 | <member name="M:Newtonsoft.Json.Linq.JToken.Parse(System.String)"> | ||
2877 | <summary> | ||
2878 | Load a <see cref="T:Newtonsoft.Json.Linq.JToken"/> from a string that contains JSON. | ||
2879 | </summary> | ||
2880 | <param name="json">A <see cref="T:System.String"/> that contains JSON.</param> | ||
2881 | <returns>A <see cref="T:Newtonsoft.Json.Linq.JToken"/> populated from the string that contains JSON.</returns> | ||
2882 | </member> | ||
2883 | <member name="M:Newtonsoft.Json.Linq.JToken.Load(Newtonsoft.Json.JsonReader)"> | ||
2884 | <summary> | ||
2885 | Creates a <see cref="T:Newtonsoft.Json.Linq.JToken"/> from a <see cref="T:Newtonsoft.Json.JsonReader"/>. | ||
2886 | </summary> | ||
2887 | <param name="reader">An <see cref="T:Newtonsoft.Json.JsonReader"/> positioned at the token to read into this <see cref="T:Newtonsoft.Json.Linq.JToken"/>.</param> | ||
2888 | <returns> | ||
2889 | An <see cref="T:Newtonsoft.Json.Linq.JToken"/> that contains the token and its descendant tokens | ||
2890 | that were read from the reader. The runtime type of the token is determined | ||
2891 | by the token type of the first token encountered in the reader. | ||
2892 | </returns> | ||
2893 | </member> | ||
2894 | <member name="M:Newtonsoft.Json.Linq.JToken.SelectToken(System.String)"> | ||
2895 | <summary> | ||
2896 | Selects a <see cref="T:Newtonsoft.Json.Linq.JToken"/> using a JPath expression. Selects the token that matches the object path. | ||
2897 | </summary> | ||
2898 | <param name="path"> | ||
2899 | A <see cref="T:System.String"/> that contains a JPath expression. | ||
2900 | </param> | ||
2901 | <returns>A <see cref="T:Newtonsoft.Json.Linq.JToken"/>, or null.</returns> | ||
2902 | </member> | ||
2903 | <member name="M:Newtonsoft.Json.Linq.JToken.SelectToken(System.String,System.Boolean)"> | ||
2904 | <summary> | ||
2905 | Selects a <see cref="T:Newtonsoft.Json.Linq.JToken"/> using a JPath expression. Selects the token that matches the object path. | ||
2906 | </summary> | ||
2907 | <param name="path"> | ||
2908 | A <see cref="T:System.String"/> that contains a JPath expression. | ||
2909 | </param> | ||
2910 | <param name="errorWhenNoMatch">A flag to indicate whether an error should be thrown if no tokens are found when evaluating part of the expression.</param> | ||
2911 | <returns>A <see cref="T:Newtonsoft.Json.Linq.JToken"/>.</returns> | ||
2912 | </member> | ||
2913 | <member name="M:Newtonsoft.Json.Linq.JToken.SelectTokens(System.String)"> | ||
2914 | <summary> | ||
2915 | Selects a collection of elements using a JPath expression. | ||
2916 | </summary> | ||
2917 | <param name="path"> | ||
2918 | A <see cref="T:System.String"/> that contains a JPath expression. | ||
2919 | </param> | ||
2920 | <returns>An <see cref="T:System.Collections.Generic.IEnumerable`1"/> that contains the selected elements.</returns> | ||
2921 | </member> | ||
2922 | <member name="M:Newtonsoft.Json.Linq.JToken.SelectTokens(System.String,System.Boolean)"> | ||
2923 | <summary> | ||
2924 | Selects a collection of elements using a JPath expression. | ||
2925 | </summary> | ||
2926 | <param name="path"> | ||
2927 | A <see cref="T:System.String"/> that contains a JPath expression. | ||
2928 | </param> | ||
2929 | <param name="errorWhenNoMatch">A flag to indicate whether an error should be thrown if no tokens are found when evaluating part of the expression.</param> | ||
2930 | <returns>An <see cref="T:System.Collections.Generic.IEnumerable`1"/> that contains the selected elements.</returns> | ||
2931 | </member> | ||
2932 | <member name="M:Newtonsoft.Json.Linq.JToken.GetMetaObject(System.Linq.Expressions.Expression)"> | ||
2933 | <summary> | ||
2934 | Returns the <see cref="T:System.Dynamic.DynamicMetaObject"/> responsible for binding operations performed on this object. | ||
2935 | </summary> | ||
2936 | <param name="parameter">The expression tree representation of the runtime value.</param> | ||
2937 | <returns> | ||
2938 | The <see cref="T:System.Dynamic.DynamicMetaObject"/> to bind this object. | ||
2939 | </returns> | ||
2940 | </member> | ||
2941 | <member name="M:Newtonsoft.Json.Linq.JToken.System#Dynamic#IDynamicMetaObjectProvider#GetMetaObject(System.Linq.Expressions.Expression)"> | ||
2942 | <summary> | ||
2943 | Returns the <see cref="T:System.Dynamic.DynamicMetaObject"/> responsible for binding operations performed on this object. | ||
2944 | </summary> | ||
2945 | <param name="parameter">The expression tree representation of the runtime value.</param> | ||
2946 | <returns> | ||
2947 | The <see cref="T:System.Dynamic.DynamicMetaObject"/> to bind this object. | ||
2948 | </returns> | ||
2949 | </member> | ||
2950 | <member name="M:Newtonsoft.Json.Linq.JToken.DeepClone"> | ||
2951 | <summary> | ||
2952 | Creates a new instance of the <see cref="T:Newtonsoft.Json.Linq.JToken"/>. All child tokens are recursively cloned. | ||
2953 | </summary> | ||
2954 | <returns>A new instance of the <see cref="T:Newtonsoft.Json.Linq.JToken"/>.</returns> | ||
2955 | </member> | ||
2956 | <member name="P:Newtonsoft.Json.Linq.JToken.EqualityComparer"> | ||
2957 | <summary> | ||
2958 | Gets a comparer that can compare two tokens for value equality. | ||
2959 | </summary> | ||
2960 | <value>A <see cref="T:Newtonsoft.Json.Linq.JTokenEqualityComparer"/> that can compare two nodes for value equality.</value> | ||
2961 | </member> | ||
2962 | <member name="P:Newtonsoft.Json.Linq.JToken.Parent"> | ||
2963 | <summary> | ||
2964 | Gets or sets the parent. | ||
2965 | </summary> | ||
2966 | <value>The parent.</value> | ||
2967 | </member> | ||
2968 | <member name="P:Newtonsoft.Json.Linq.JToken.Root"> | ||
2969 | <summary> | ||
2970 | Gets the root <see cref="T:Newtonsoft.Json.Linq.JToken"/> of this <see cref="T:Newtonsoft.Json.Linq.JToken"/>. | ||
2971 | </summary> | ||
2972 | <value>The root <see cref="T:Newtonsoft.Json.Linq.JToken"/> of this <see cref="T:Newtonsoft.Json.Linq.JToken"/>.</value> | ||
2973 | </member> | ||
2974 | <member name="P:Newtonsoft.Json.Linq.JToken.Type"> | ||
2975 | <summary> | ||
2976 | Gets the node type for this <see cref="T:Newtonsoft.Json.Linq.JToken"/>. | ||
2977 | </summary> | ||
2978 | <value>The type.</value> | ||
2979 | </member> | ||
2980 | <member name="P:Newtonsoft.Json.Linq.JToken.HasValues"> | ||
2981 | <summary> | ||
2982 | Gets a value indicating whether this token has child tokens. | ||
2983 | </summary> | ||
2984 | <value> | ||
2985 | <c>true</c> if this token has child values; otherwise, <c>false</c>. | ||
2986 | </value> | ||
2987 | </member> | ||
2988 | <member name="P:Newtonsoft.Json.Linq.JToken.Next"> | ||
2989 | <summary> | ||
2990 | Gets the next sibling token of this node. | ||
2991 | </summary> | ||
2992 | <value>The <see cref="T:Newtonsoft.Json.Linq.JToken"/> that contains the next sibling token.</value> | ||
2993 | </member> | ||
2994 | <member name="P:Newtonsoft.Json.Linq.JToken.Previous"> | ||
2995 | <summary> | ||
2996 | Gets the previous sibling token of this node. | ||
2997 | </summary> | ||
2998 | <value>The <see cref="T:Newtonsoft.Json.Linq.JToken"/> that contains the previous sibling token.</value> | ||
2999 | </member> | ||
3000 | <member name="P:Newtonsoft.Json.Linq.JToken.Path"> | ||
3001 | <summary> | ||
3002 | Gets the path of the JSON token. | ||
3003 | </summary> | ||
3004 | </member> | ||
3005 | <member name="P:Newtonsoft.Json.Linq.JToken.Item(System.Object)"> | ||
3006 | <summary> | ||
3007 | Gets the <see cref="T:Newtonsoft.Json.Linq.JToken"/> with the specified key. | ||
3008 | </summary> | ||
3009 | <value>The <see cref="T:Newtonsoft.Json.Linq.JToken"/> with the specified key.</value> | ||
3010 | </member> | ||
3011 | <member name="P:Newtonsoft.Json.Linq.JToken.First"> | ||
3012 | <summary> | ||
3013 | Get the first child token of this token. | ||
3014 | </summary> | ||
3015 | <value>A <see cref="T:Newtonsoft.Json.Linq.JToken"/> containing the first child token of the <see cref="T:Newtonsoft.Json.Linq.JToken"/>.</value> | ||
3016 | </member> | ||
3017 | <member name="P:Newtonsoft.Json.Linq.JToken.Last"> | ||
3018 | <summary> | ||
3019 | Get the last child token of this token. | ||
3020 | </summary> | ||
3021 | <value>A <see cref="T:Newtonsoft.Json.Linq.JToken"/> containing the last child token of the <see cref="T:Newtonsoft.Json.Linq.JToken"/>.</value> | ||
3022 | </member> | ||
3023 | <member name="M:Newtonsoft.Json.Linq.JValue.#ctor(Newtonsoft.Json.Linq.JValue)"> | ||
3024 | <summary> | ||
3025 | Initializes a new instance of the <see cref="T:Newtonsoft.Json.Linq.JValue"/> class from another <see cref="T:Newtonsoft.Json.Linq.JValue"/> object. | ||
3026 | </summary> | ||
3027 | <param name="other">A <see cref="T:Newtonsoft.Json.Linq.JValue"/> object to copy from.</param> | ||
3028 | </member> | ||
3029 | <member name="M:Newtonsoft.Json.Linq.JValue.#ctor(System.Int64)"> | ||
3030 | <summary> | ||
3031 | Initializes a new instance of the <see cref="T:Newtonsoft.Json.Linq.JValue"/> class with the given value. | ||
3032 | </summary> | ||
3033 | <param name="value">The value.</param> | ||
3034 | </member> | ||
3035 | <member name="M:Newtonsoft.Json.Linq.JValue.#ctor(System.Decimal)"> | ||
3036 | <summary> | ||
3037 | Initializes a new instance of the <see cref="T:Newtonsoft.Json.Linq.JValue"/> class with the given value. | ||
3038 | </summary> | ||
3039 | <param name="value">The value.</param> | ||
3040 | </member> | ||
3041 | <member name="M:Newtonsoft.Json.Linq.JValue.#ctor(System.Char)"> | ||
3042 | <summary> | ||
3043 | Initializes a new instance of the <see cref="T:Newtonsoft.Json.Linq.JValue"/> class with the given value. | ||
3044 | </summary> | ||
3045 | <param name="value">The value.</param> | ||
3046 | </member> | ||
3047 | <member name="M:Newtonsoft.Json.Linq.JValue.#ctor(System.UInt64)"> | ||
3048 | <summary> | ||
3049 | Initializes a new instance of the <see cref="T:Newtonsoft.Json.Linq.JValue"/> class with the given value. | ||
3050 | </summary> | ||
3051 | <param name="value">The value.</param> | ||
3052 | </member> | ||
3053 | <member name="M:Newtonsoft.Json.Linq.JValue.#ctor(System.Double)"> | ||
3054 | <summary> | ||
3055 | Initializes a new instance of the <see cref="T:Newtonsoft.Json.Linq.JValue"/> class with the given value. | ||
3056 | </summary> | ||
3057 | <param name="value">The value.</param> | ||
3058 | </member> | ||
3059 | <member name="M:Newtonsoft.Json.Linq.JValue.#ctor(System.Single)"> | ||
3060 | <summary> | ||
3061 | Initializes a new instance of the <see cref="T:Newtonsoft.Json.Linq.JValue"/> class with the given value. | ||
3062 | </summary> | ||
3063 | <param name="value">The value.</param> | ||
3064 | </member> | ||
3065 | <member name="M:Newtonsoft.Json.Linq.JValue.#ctor(System.DateTime)"> | ||
3066 | <summary> | ||
3067 | Initializes a new instance of the <see cref="T:Newtonsoft.Json.Linq.JValue"/> class with the given value. | ||
3068 | </summary> | ||
3069 | <param name="value">The value.</param> | ||
3070 | </member> | ||
3071 | <member name="M:Newtonsoft.Json.Linq.JValue.#ctor(System.DateTimeOffset)"> | ||
3072 | <summary> | ||
3073 | Initializes a new instance of the <see cref="T:Newtonsoft.Json.Linq.JValue"/> class with the given value. | ||
3074 | </summary> | ||
3075 | <param name="value">The value.</param> | ||
3076 | </member> | ||
3077 | <member name="M:Newtonsoft.Json.Linq.JValue.#ctor(System.Boolean)"> | ||
3078 | <summary> | ||
3079 | Initializes a new instance of the <see cref="T:Newtonsoft.Json.Linq.JValue"/> class with the given value. | ||
3080 | </summary> | ||
3081 | <param name="value">The value.</param> | ||
3082 | </member> | ||
3083 | <member name="M:Newtonsoft.Json.Linq.JValue.#ctor(System.String)"> | ||
3084 | <summary> | ||
3085 | Initializes a new instance of the <see cref="T:Newtonsoft.Json.Linq.JValue"/> class with the given value. | ||
3086 | </summary> | ||
3087 | <param name="value">The value.</param> | ||
3088 | </member> | ||
3089 | <member name="M:Newtonsoft.Json.Linq.JValue.#ctor(System.Guid)"> | ||
3090 | <summary> | ||
3091 | Initializes a new instance of the <see cref="T:Newtonsoft.Json.Linq.JValue"/> class with the given value. | ||
3092 | </summary> | ||
3093 | <param name="value">The value.</param> | ||
3094 | </member> | ||
3095 | <member name="M:Newtonsoft.Json.Linq.JValue.#ctor(System.Uri)"> | ||
3096 | <summary> | ||
3097 | Initializes a new instance of the <see cref="T:Newtonsoft.Json.Linq.JValue"/> class with the given value. | ||
3098 | </summary> | ||
3099 | <param name="value">The value.</param> | ||
3100 | </member> | ||
3101 | <member name="M:Newtonsoft.Json.Linq.JValue.#ctor(System.TimeSpan)"> | ||
3102 | <summary> | ||
3103 | Initializes a new instance of the <see cref="T:Newtonsoft.Json.Linq.JValue"/> class with the given value. | ||
3104 | </summary> | ||
3105 | <param name="value">The value.</param> | ||
3106 | </member> | ||
3107 | <member name="M:Newtonsoft.Json.Linq.JValue.#ctor(System.Object)"> | ||
3108 | <summary> | ||
3109 | Initializes a new instance of the <see cref="T:Newtonsoft.Json.Linq.JValue"/> class with the given value. | ||
3110 | </summary> | ||
3111 | <param name="value">The value.</param> | ||
3112 | </member> | ||
3113 | <member name="M:Newtonsoft.Json.Linq.JValue.CreateComment(System.String)"> | ||
3114 | <summary> | ||
3115 | Creates a <see cref="T:Newtonsoft.Json.Linq.JValue"/> comment with the given value. | ||
3116 | </summary> | ||
3117 | <param name="value">The value.</param> | ||
3118 | <returns>A <see cref="T:Newtonsoft.Json.Linq.JValue"/> comment with the given value.</returns> | ||
3119 | </member> | ||
3120 | <member name="M:Newtonsoft.Json.Linq.JValue.CreateString(System.String)"> | ||
3121 | <summary> | ||
3122 | Creates a <see cref="T:Newtonsoft.Json.Linq.JValue"/> string with the given value. | ||
3123 | </summary> | ||
3124 | <param name="value">The value.</param> | ||
3125 | <returns>A <see cref="T:Newtonsoft.Json.Linq.JValue"/> string with the given value.</returns> | ||
3126 | </member> | ||
3127 | <member name="M:Newtonsoft.Json.Linq.JValue.CreateNull"> | ||
3128 | <summary> | ||
3129 | Creates a <see cref="T:Newtonsoft.Json.Linq.JValue"/> null value. | ||
3130 | </summary> | ||
3131 | <returns>A <see cref="T:Newtonsoft.Json.Linq.JValue"/> null value.</returns> | ||
3132 | </member> | ||
3133 | <member name="M:Newtonsoft.Json.Linq.JValue.CreateUndefined"> | ||
3134 | <summary> | ||
3135 | Creates a <see cref="T:Newtonsoft.Json.Linq.JValue"/> null value. | ||
3136 | </summary> | ||
3137 | <returns>A <see cref="T:Newtonsoft.Json.Linq.JValue"/> null value.</returns> | ||
3138 | </member> | ||
3139 | <member name="M:Newtonsoft.Json.Linq.JValue.WriteTo(Newtonsoft.Json.JsonWriter,Newtonsoft.Json.JsonConverter[])"> | ||
3140 | <summary> | ||
3141 | Writes this token to a <see cref="T:Newtonsoft.Json.JsonWriter"/>. | ||
3142 | </summary> | ||
3143 | <param name="writer">A <see cref="T:Newtonsoft.Json.JsonWriter"/> into which this method will write.</param> | ||
3144 | <param name="converters">A collection of <see cref="T:Newtonsoft.Json.JsonConverter"/> which will be used when writing the token.</param> | ||
3145 | </member> | ||
3146 | <member name="M:Newtonsoft.Json.Linq.JValue.Equals(Newtonsoft.Json.Linq.JValue)"> | ||
3147 | <summary> | ||
3148 | Indicates whether the current object is equal to another object of the same type. | ||
3149 | </summary> | ||
3150 | <returns> | ||
3151 | true if the current object is equal to the <paramref name="other"/> parameter; otherwise, false. | ||
3152 | </returns> | ||
3153 | <param name="other">An object to compare with this object.</param> | ||
3154 | </member> | ||
3155 | <member name="M:Newtonsoft.Json.Linq.JValue.Equals(System.Object)"> | ||
3156 | <summary> | ||
3157 | Determines whether the specified <see cref="T:System.Object"/> is equal to the current <see cref="T:System.Object"/>. | ||
3158 | </summary> | ||
3159 | <param name="obj">The <see cref="T:System.Object"/> to compare with the current <see cref="T:System.Object"/>.</param> | ||
3160 | <returns> | ||
3161 | true if the specified <see cref="T:System.Object"/> is equal to the current <see cref="T:System.Object"/>; otherwise, false. | ||
3162 | </returns> | ||
3163 | <exception cref="T:System.NullReferenceException"> | ||
3164 | The <paramref name="obj"/> parameter is null. | ||
3165 | </exception> | ||
3166 | </member> | ||
3167 | <member name="M:Newtonsoft.Json.Linq.JValue.GetHashCode"> | ||
3168 | <summary> | ||
3169 | Serves as a hash function for a particular type. | ||
3170 | </summary> | ||
3171 | <returns> | ||
3172 | A hash code for the current <see cref="T:System.Object"/>. | ||
3173 | </returns> | ||
3174 | </member> | ||
3175 | <member name="M:Newtonsoft.Json.Linq.JValue.ToString"> | ||
3176 | <summary> | ||
3177 | Returns a <see cref="T:System.String"/> that represents this instance. | ||
3178 | </summary> | ||
3179 | <returns> | ||
3180 | A <see cref="T:System.String"/> that represents this instance. | ||
3181 | </returns> | ||
3182 | </member> | ||
3183 | <member name="M:Newtonsoft.Json.Linq.JValue.ToString(System.String)"> | ||
3184 | <summary> | ||
3185 | Returns a <see cref="T:System.String"/> that represents this instance. | ||
3186 | </summary> | ||
3187 | <param name="format">The format.</param> | ||
3188 | <returns> | ||
3189 | A <see cref="T:System.String"/> that represents this instance. | ||
3190 | </returns> | ||
3191 | </member> | ||
3192 | <member name="M:Newtonsoft.Json.Linq.JValue.ToString(System.IFormatProvider)"> | ||
3193 | <summary> | ||
3194 | Returns a <see cref="T:System.String"/> that represents this instance. | ||
3195 | </summary> | ||
3196 | <param name="formatProvider">The format provider.</param> | ||
3197 | <returns> | ||
3198 | A <see cref="T:System.String"/> that represents this instance. | ||
3199 | </returns> | ||
3200 | </member> | ||
3201 | <member name="M:Newtonsoft.Json.Linq.JValue.ToString(System.String,System.IFormatProvider)"> | ||
3202 | <summary> | ||
3203 | Returns a <see cref="T:System.String"/> that represents this instance. | ||
3204 | </summary> | ||
3205 | <param name="format">The format.</param> | ||
3206 | <param name="formatProvider">The format provider.</param> | ||
3207 | <returns> | ||
3208 | A <see cref="T:System.String"/> that represents this instance. | ||
3209 | </returns> | ||
3210 | </member> | ||
3211 | <member name="M:Newtonsoft.Json.Linq.JValue.GetMetaObject(System.Linq.Expressions.Expression)"> | ||
3212 | <summary> | ||
3213 | Returns the <see cref="T:System.Dynamic.DynamicMetaObject"/> responsible for binding operations performed on this object. | ||
3214 | </summary> | ||
3215 | <param name="parameter">The expression tree representation of the runtime value.</param> | ||
3216 | <returns> | ||
3217 | The <see cref="T:System.Dynamic.DynamicMetaObject"/> to bind this object. | ||
3218 | </returns> | ||
3219 | </member> | ||
3220 | <member name="M:Newtonsoft.Json.Linq.JValue.CompareTo(Newtonsoft.Json.Linq.JValue)"> | ||
3221 | <summary> | ||
3222 | Compares the current instance with another object of the same type and returns an integer that indicates whether the current instance precedes, follows, or occurs in the same position in the sort order as the other object. | ||
3223 | </summary> | ||
3224 | <param name="obj">An object to compare with this instance.</param> | ||
3225 | <returns> | ||
3226 | A 32-bit signed integer that indicates the relative order of the objects being compared. The return value has these meanings: | ||
3227 | Value | ||
3228 | Meaning | ||
3229 | Less than zero | ||
3230 | This instance is less than <paramref name="obj"/>. | ||
3231 | Zero | ||
3232 | This instance is equal to <paramref name="obj"/>. | ||
3233 | Greater than zero | ||
3234 | This instance is greater than <paramref name="obj"/>. | ||
3235 | </returns> | ||
3236 | <exception cref="T:System.ArgumentException"> | ||
3237 | <paramref name="obj"/> is not the same type as this instance. | ||
3238 | </exception> | ||
3239 | </member> | ||
3240 | <member name="P:Newtonsoft.Json.Linq.JValue.HasValues"> | ||
3241 | <summary> | ||
3242 | Gets a value indicating whether this token has child tokens. | ||
3243 | </summary> | ||
3244 | <value> | ||
3245 | <c>true</c> if this token has child values; otherwise, <c>false</c>. | ||
3246 | </value> | ||
3247 | </member> | ||
3248 | <member name="P:Newtonsoft.Json.Linq.JValue.Type"> | ||
3249 | <summary> | ||
3250 | Gets the node type for this <see cref="T:Newtonsoft.Json.Linq.JToken"/>. | ||
3251 | </summary> | ||
3252 | <value>The type.</value> | ||
3253 | </member> | ||
3254 | <member name="P:Newtonsoft.Json.Linq.JValue.Value"> | ||
3255 | <summary> | ||
3256 | Gets or sets the underlying token value. | ||
3257 | </summary> | ||
3258 | <value>The underlying token value.</value> | ||
3259 | </member> | ||
3260 | <member name="M:Newtonsoft.Json.Linq.JRaw.#ctor(Newtonsoft.Json.Linq.JRaw)"> | ||
3261 | <summary> | ||
3262 | Initializes a new instance of the <see cref="T:Newtonsoft.Json.Linq.JRaw"/> class from another <see cref="T:Newtonsoft.Json.Linq.JRaw"/> object. | ||
3263 | </summary> | ||
3264 | <param name="other">A <see cref="T:Newtonsoft.Json.Linq.JRaw"/> object to copy from.</param> | ||
3265 | </member> | ||
3266 | <member name="M:Newtonsoft.Json.Linq.JRaw.#ctor(System.Object)"> | ||
3267 | <summary> | ||
3268 | Initializes a new instance of the <see cref="T:Newtonsoft.Json.Linq.JRaw"/> class. | ||
3269 | </summary> | ||
3270 | <param name="rawJson">The raw json.</param> | ||
3271 | </member> | ||
3272 | <member name="M:Newtonsoft.Json.Linq.JRaw.Create(Newtonsoft.Json.JsonReader)"> | ||
3273 | <summary> | ||
3274 | Creates an instance of <see cref="T:Newtonsoft.Json.Linq.JRaw"/> with the content of the reader's current token. | ||
3275 | </summary> | ||
3276 | <param name="reader">The reader.</param> | ||
3277 | <returns>An instance of <see cref="T:Newtonsoft.Json.Linq.JRaw"/> with the content of the reader's current token.</returns> | ||
3278 | </member> | ||
3279 | <member name="T:Newtonsoft.Json.Required"> | ||
3280 | <summary> | ||
3281 | Indicating whether a property is required. | ||
3282 | </summary> | ||
3283 | </member> | ||
3284 | <member name="F:Newtonsoft.Json.Required.Default"> | ||
3285 | <summary> | ||
3286 | The property is not required. The default state. | ||
3287 | </summary> | ||
3288 | </member> | ||
3289 | <member name="F:Newtonsoft.Json.Required.AllowNull"> | ||
3290 | <summary> | ||
3291 | The property must be defined in JSON but can be a null value. | ||
3292 | </summary> | ||
3293 | </member> | ||
3294 | <member name="F:Newtonsoft.Json.Required.Always"> | ||
3295 | <summary> | ||
3296 | The property must be defined in JSON and cannot be a null value. | ||
3297 | </summary> | ||
3298 | </member> | ||
3299 | <member name="T:Newtonsoft.Json.Serialization.JsonDynamicContract"> | ||
3300 | <summary> | ||
3301 | Contract details for a <see cref="T:System.Type"/> used by the <see cref="T:Newtonsoft.Json.JsonSerializer"/>. | ||
3302 | </summary> | ||
3303 | </member> | ||
3304 | <member name="M:Newtonsoft.Json.Serialization.JsonDynamicContract.#ctor(System.Type)"> | ||
3305 | <summary> | ||
3306 | Initializes a new instance of the <see cref="T:Newtonsoft.Json.Serialization.JsonDynamicContract"/> class. | ||
3307 | </summary> | ||
3308 | <param name="underlyingType">The underlying type for the contract.</param> | ||
3309 | </member> | ||
3310 | <member name="P:Newtonsoft.Json.Serialization.JsonDynamicContract.Properties"> | ||
3311 | <summary> | ||
3312 | Gets the object's properties. | ||
3313 | </summary> | ||
3314 | <value>The object's properties.</value> | ||
3315 | </member> | ||
3316 | <member name="P:Newtonsoft.Json.Serialization.JsonDynamicContract.PropertyNameResolver"> | ||
3317 | <summary> | ||
3318 | Gets or sets the property name resolver. | ||
3319 | </summary> | ||
3320 | <value>The property name resolver.</value> | ||
3321 | </member> | ||
3322 | <member name="T:Newtonsoft.Json.Serialization.JsonISerializableContract"> | ||
3323 | <summary> | ||
3324 | Contract details for a <see cref="T:System.Type"/> used by the <see cref="T:Newtonsoft.Json.JsonSerializer"/>. | ||
3325 | </summary> | ||
3326 | </member> | ||
3327 | <member name="M:Newtonsoft.Json.Serialization.JsonISerializableContract.#ctor(System.Type)"> | ||
3328 | <summary> | ||
3329 | Initializes a new instance of the <see cref="T:Newtonsoft.Json.Serialization.JsonISerializableContract"/> class. | ||
3330 | </summary> | ||
3331 | <param name="underlyingType">The underlying type for the contract.</param> | ||
3332 | </member> | ||
3333 | <member name="P:Newtonsoft.Json.Serialization.JsonISerializableContract.ISerializableCreator"> | ||
3334 | <summary> | ||
3335 | Gets or sets the ISerializable object constructor. | ||
3336 | </summary> | ||
3337 | <value>The ISerializable object constructor.</value> | ||
3338 | </member> | ||
3339 | <member name="T:Newtonsoft.Json.Serialization.JsonLinqContract"> | ||
3340 | <summary> | ||
3341 | Contract details for a <see cref="T:System.Type"/> used by the <see cref="T:Newtonsoft.Json.JsonSerializer"/>. | ||
3342 | </summary> | ||
3343 | </member> | ||
3344 | <member name="M:Newtonsoft.Json.Serialization.JsonLinqContract.#ctor(System.Type)"> | ||
3345 | <summary> | ||
3346 | Initializes a new instance of the <see cref="T:Newtonsoft.Json.Serialization.JsonLinqContract"/> class. | ||
3347 | </summary> | ||
3348 | <param name="underlyingType">The underlying type for the contract.</param> | ||
3349 | </member> | ||
3350 | <member name="T:Newtonsoft.Json.Serialization.JsonPrimitiveContract"> | ||
3351 | <summary> | ||
3352 | Contract details for a <see cref="T:System.Type"/> used by the <see cref="T:Newtonsoft.Json.JsonSerializer"/>. | ||
3353 | </summary> | ||
3354 | </member> | ||
3355 | <member name="M:Newtonsoft.Json.Serialization.JsonPrimitiveContract.#ctor(System.Type)"> | ||
3356 | <summary> | ||
3357 | Initializes a new instance of the <see cref="T:Newtonsoft.Json.Serialization.JsonPrimitiveContract"/> class. | ||
3358 | </summary> | ||
3359 | <param name="underlyingType">The underlying type for the contract.</param> | ||
3360 | </member> | ||
3361 | <member name="T:Newtonsoft.Json.Serialization.DynamicValueProvider"> | ||
3362 | <summary> | ||
3363 | Get and set values for a <see cref="T:System.Reflection.MemberInfo"/> using dynamic methods. | ||
3364 | </summary> | ||
3365 | </member> | ||
3366 | <member name="M:Newtonsoft.Json.Serialization.DynamicValueProvider.#ctor(System.Reflection.MemberInfo)"> | ||
3367 | <summary> | ||
3368 | Initializes a new instance of the <see cref="T:Newtonsoft.Json.Serialization.DynamicValueProvider"/> class. | ||
3369 | </summary> | ||
3370 | <param name="memberInfo">The member info.</param> | ||
3371 | </member> | ||
3372 | <member name="M:Newtonsoft.Json.Serialization.DynamicValueProvider.SetValue(System.Object,System.Object)"> | ||
3373 | <summary> | ||
3374 | Sets the value. | ||
3375 | </summary> | ||
3376 | <param name="target">The target to set the value on.</param> | ||
3377 | <param name="value">The value to set on the target.</param> | ||
3378 | </member> | ||
3379 | <member name="M:Newtonsoft.Json.Serialization.DynamicValueProvider.GetValue(System.Object)"> | ||
3380 | <summary> | ||
3381 | Gets the value. | ||
3382 | </summary> | ||
3383 | <param name="target">The target to get the value from.</param> | ||
3384 | <returns>The value.</returns> | ||
3385 | </member> | ||
3386 | <member name="T:Newtonsoft.Json.Serialization.ErrorEventArgs"> | ||
3387 | <summary> | ||
3388 | Provides data for the Error event. | ||
3389 | </summary> | ||
3390 | </member> | ||
3391 | <member name="M:Newtonsoft.Json.Serialization.ErrorEventArgs.#ctor(System.Object,Newtonsoft.Json.Serialization.ErrorContext)"> | ||
3392 | <summary> | ||
3393 | Initializes a new instance of the <see cref="T:Newtonsoft.Json.Serialization.ErrorEventArgs"/> class. | ||
3394 | </summary> | ||
3395 | <param name="currentObject">The current object.</param> | ||
3396 | <param name="errorContext">The error context.</param> | ||
3397 | </member> | ||
3398 | <member name="P:Newtonsoft.Json.Serialization.ErrorEventArgs.CurrentObject"> | ||
3399 | <summary> | ||
3400 | Gets the current object the error event is being raised against. | ||
3401 | </summary> | ||
3402 | <value>The current object the error event is being raised against.</value> | ||
3403 | </member> | ||
3404 | <member name="P:Newtonsoft.Json.Serialization.ErrorEventArgs.ErrorContext"> | ||
3405 | <summary> | ||
3406 | Gets the error context. | ||
3407 | </summary> | ||
3408 | <value>The error context.</value> | ||
3409 | </member> | ||
3410 | <member name="T:Newtonsoft.Json.Linq.JPropertyDescriptor"> | ||
3411 | <summary> | ||
3412 | Represents a view of a <see cref="T:Newtonsoft.Json.Linq.JProperty"/>. | ||
3413 | </summary> | ||
3414 | </member> | ||
3415 | <member name="M:Newtonsoft.Json.Linq.JPropertyDescriptor.#ctor(System.String)"> | ||
3416 | <summary> | ||
3417 | Initializes a new instance of the <see cref="T:Newtonsoft.Json.Linq.JPropertyDescriptor"/> class. | ||
3418 | </summary> | ||
3419 | <param name="name">The name.</param> | ||
3420 | </member> | ||
3421 | <member name="M:Newtonsoft.Json.Linq.JPropertyDescriptor.CanResetValue(System.Object)"> | ||
3422 | <summary> | ||
3423 | When overridden in a derived class, returns whether resetting an object changes its value. | ||
3424 | </summary> | ||
3425 | <returns> | ||
3426 | true if resetting the component changes its value; otherwise, false. | ||
3427 | </returns> | ||
3428 | <param name="component">The component to test for reset capability. | ||
3429 | </param> | ||
3430 | </member> | ||
3431 | <member name="M:Newtonsoft.Json.Linq.JPropertyDescriptor.GetValue(System.Object)"> | ||
3432 | <summary> | ||
3433 | When overridden in a derived class, gets the current value of the property on a component. | ||
3434 | </summary> | ||
3435 | <returns> | ||
3436 | The value of a property for a given component. | ||
3437 | </returns> | ||
3438 | <param name="component">The component with the property for which to retrieve the value. | ||
3439 | </param> | ||
3440 | </member> | ||
3441 | <member name="M:Newtonsoft.Json.Linq.JPropertyDescriptor.ResetValue(System.Object)"> | ||
3442 | <summary> | ||
3443 | When overridden in a derived class, resets the value for this property of the component to the default value. | ||
3444 | </summary> | ||
3445 | <param name="component">The component with the property value that is to be reset to the default value. | ||
3446 | </param> | ||
3447 | </member> | ||
3448 | <member name="M:Newtonsoft.Json.Linq.JPropertyDescriptor.SetValue(System.Object,System.Object)"> | ||
3449 | <summary> | ||
3450 | When overridden in a derived class, sets the value of the component to a different value. | ||
3451 | </summary> | ||
3452 | <param name="component">The component with the property value that is to be set. | ||
3453 | </param><param name="value">The new value. | ||
3454 | </param> | ||
3455 | </member> | ||
3456 | <member name="M:Newtonsoft.Json.Linq.JPropertyDescriptor.ShouldSerializeValue(System.Object)"> | ||
3457 | <summary> | ||
3458 | When overridden in a derived class, determines a value indicating whether the value of this property needs to be persisted. | ||
3459 | </summary> | ||
3460 | <returns> | ||
3461 | true if the property should be persisted; otherwise, false. | ||
3462 | </returns> | ||
3463 | <param name="component">The component with the property to be examined for persistence. | ||
3464 | </param> | ||
3465 | </member> | ||
3466 | <member name="P:Newtonsoft.Json.Linq.JPropertyDescriptor.ComponentType"> | ||
3467 | <summary> | ||
3468 | When overridden in a derived class, gets the type of the component this property is bound to. | ||
3469 | </summary> | ||
3470 | <returns> | ||
3471 | A <see cref="T:System.Type"/> that represents the type of component this property is bound to. When the <see cref="M:System.ComponentModel.PropertyDescriptor.GetValue(System.Object)"/> or <see cref="M:System.ComponentModel.PropertyDescriptor.SetValue(System.Object,System.Object)"/> methods are invoked, the object specified might be an instance of this type. | ||
3472 | </returns> | ||
3473 | </member> | ||
3474 | <member name="P:Newtonsoft.Json.Linq.JPropertyDescriptor.IsReadOnly"> | ||
3475 | <summary> | ||
3476 | When overridden in a derived class, gets a value indicating whether this property is read-only. | ||
3477 | </summary> | ||
3478 | <returns> | ||
3479 | true if the property is read-only; otherwise, false. | ||
3480 | </returns> | ||
3481 | </member> | ||
3482 | <member name="P:Newtonsoft.Json.Linq.JPropertyDescriptor.PropertyType"> | ||
3483 | <summary> | ||
3484 | When overridden in a derived class, gets the type of the property. | ||
3485 | </summary> | ||
3486 | <returns> | ||
3487 | A <see cref="T:System.Type"/> that represents the type of the property. | ||
3488 | </returns> | ||
3489 | </member> | ||
3490 | <member name="P:Newtonsoft.Json.Linq.JPropertyDescriptor.NameHashCode"> | ||
3491 | <summary> | ||
3492 | Gets the hash code for the name of the member. | ||
3493 | </summary> | ||
3494 | <value></value> | ||
3495 | <returns> | ||
3496 | The hash code for the name of the member. | ||
3497 | </returns> | ||
3498 | </member> | ||
3499 | <member name="T:Newtonsoft.Json.Serialization.IReferenceResolver"> | ||
3500 | <summary> | ||
3501 | Used to resolve references when serializing and deserializing JSON by the <see cref="T:Newtonsoft.Json.JsonSerializer"/>. | ||
3502 | </summary> | ||
3503 | </member> | ||
3504 | <member name="M:Newtonsoft.Json.Serialization.IReferenceResolver.ResolveReference(System.Object,System.String)"> | ||
3505 | <summary> | ||
3506 | Resolves a reference to its object. | ||
3507 | </summary> | ||
3508 | <param name="context">The serialization context.</param> | ||
3509 | <param name="reference">The reference to resolve.</param> | ||
3510 | <returns>The object that</returns> | ||
3511 | </member> | ||
3512 | <member name="M:Newtonsoft.Json.Serialization.IReferenceResolver.GetReference(System.Object,System.Object)"> | ||
3513 | <summary> | ||
3514 | Gets the reference for the sepecified object. | ||
3515 | </summary> | ||
3516 | <param name="context">The serialization context.</param> | ||
3517 | <param name="value">The object to get a reference for.</param> | ||
3518 | <returns>The reference to the object.</returns> | ||
3519 | </member> | ||
3520 | <member name="M:Newtonsoft.Json.Serialization.IReferenceResolver.IsReferenced(System.Object,System.Object)"> | ||
3521 | <summary> | ||
3522 | Determines whether the specified object is referenced. | ||
3523 | </summary> | ||
3524 | <param name="context">The serialization context.</param> | ||
3525 | <param name="value">The object to test for a reference.</param> | ||
3526 | <returns> | ||
3527 | <c>true</c> if the specified object is referenced; otherwise, <c>false</c>. | ||
3528 | </returns> | ||
3529 | </member> | ||
3530 | <member name="M:Newtonsoft.Json.Serialization.IReferenceResolver.AddReference(System.Object,System.String,System.Object)"> | ||
3531 | <summary> | ||
3532 | Adds a reference to the specified object. | ||
3533 | </summary> | ||
3534 | <param name="context">The serialization context.</param> | ||
3535 | <param name="reference">The reference.</param> | ||
3536 | <param name="value">The object to reference.</param> | ||
3537 | </member> | ||
3538 | <member name="T:Newtonsoft.Json.PreserveReferencesHandling"> | ||
3539 | <summary> | ||
3540 | Specifies reference handling options for the <see cref="T:Newtonsoft.Json.JsonSerializer"/>. | ||
3541 | Note that references cannot be preserved when a value is set via a non-default constructor such as types that implement ISerializable. | ||
3542 | </summary> | ||
3543 | <example> | ||
3544 | <code lang="cs" source="..\Src\Newtonsoft.Json.Tests\Documentation\SerializationTests.cs" region="PreservingObjectReferencesOn" title="Preserve Object References"/> | ||
3545 | </example> | ||
3546 | </member> | ||
3547 | <member name="F:Newtonsoft.Json.PreserveReferencesHandling.None"> | ||
3548 | <summary> | ||
3549 | Do not preserve references when serializing types. | ||
3550 | </summary> | ||
3551 | </member> | ||
3552 | <member name="F:Newtonsoft.Json.PreserveReferencesHandling.Objects"> | ||
3553 | <summary> | ||
3554 | Preserve references when serializing into a JSON object structure. | ||
3555 | </summary> | ||
3556 | </member> | ||
3557 | <member name="F:Newtonsoft.Json.PreserveReferencesHandling.Arrays"> | ||
3558 | <summary> | ||
3559 | Preserve references when serializing into a JSON array structure. | ||
3560 | </summary> | ||
3561 | </member> | ||
3562 | <member name="F:Newtonsoft.Json.PreserveReferencesHandling.All"> | ||
3563 | <summary> | ||
3564 | Preserve references when serializing. | ||
3565 | </summary> | ||
3566 | </member> | ||
3567 | <member name="T:Newtonsoft.Json.JsonArrayAttribute"> | ||
3568 | <summary> | ||
3569 | Instructs the <see cref="T:Newtonsoft.Json.JsonSerializer"/> how to serialize the collection. | ||
3570 | </summary> | ||
3571 | </member> | ||
3572 | <member name="M:Newtonsoft.Json.JsonArrayAttribute.#ctor"> | ||
3573 | <summary> | ||
3574 | Initializes a new instance of the <see cref="T:Newtonsoft.Json.JsonArrayAttribute"/> class. | ||
3575 | </summary> | ||
3576 | </member> | ||
3577 | <member name="M:Newtonsoft.Json.JsonArrayAttribute.#ctor(System.Boolean)"> | ||
3578 | <summary> | ||
3579 | Initializes a new instance of the <see cref="T:Newtonsoft.Json.JsonObjectAttribute"/> class with a flag indicating whether the array can contain null items | ||
3580 | </summary> | ||
3581 | <param name="allowNullItems">A flag indicating whether the array can contain null items.</param> | ||
3582 | </member> | ||
3583 | <member name="M:Newtonsoft.Json.JsonArrayAttribute.#ctor(System.String)"> | ||
3584 | <summary> | ||
3585 | Initializes a new instance of the <see cref="T:Newtonsoft.Json.JsonArrayAttribute"/> class with the specified container Id. | ||
3586 | </summary> | ||
3587 | <param name="id">The container Id.</param> | ||
3588 | </member> | ||
3589 | <member name="P:Newtonsoft.Json.JsonArrayAttribute.AllowNullItems"> | ||
3590 | <summary> | ||
3591 | Gets or sets a value indicating whether null items are allowed in the collection. | ||
3592 | </summary> | ||
3593 | <value><c>true</c> if null items are allowed in the collection; otherwise, <c>false</c>.</value> | ||
3594 | </member> | ||
3595 | <member name="T:Newtonsoft.Json.DefaultValueHandling"> | ||
3596 | <summary> | ||
3597 | Specifies default value handling options for the <see cref="T:Newtonsoft.Json.JsonSerializer"/>. | ||
3598 | </summary> | ||
3599 | <example> | ||
3600 | <code lang="cs" source="..\Src\Newtonsoft.Json.Tests\Documentation\SerializationTests.cs" region="ReducingSerializedJsonSizeDefaultValueHandlingObject" title="DefaultValueHandling Class"/> | ||
3601 | <code lang="cs" source="..\Src\Newtonsoft.Json.Tests\Documentation\SerializationTests.cs" region="ReducingSerializedJsonSizeDefaultValueHandlingExample" title="DefaultValueHandling Ignore Example"/> | ||
3602 | </example> | ||
3603 | </member> | ||
3604 | <member name="F:Newtonsoft.Json.DefaultValueHandling.Include"> | ||
3605 | <summary> | ||
3606 | Include members where the member value is the same as the member's default value when serializing objects. | ||
3607 | Included members are written to JSON. Has no effect when deserializing. | ||
3608 | </summary> | ||
3609 | </member> | ||
3610 | <member name="F:Newtonsoft.Json.DefaultValueHandling.Ignore"> | ||
3611 | <summary> | ||
3612 | Ignore members where the member value is the same as the member's default value when serializing objects | ||
3613 | so that is is not written to JSON. | ||
3614 | This option will ignore all default values (e.g. <c>null</c> for objects and nullable types; <c>0</c> for integers, | ||
3615 | decimals and floating point numbers; and <c>false</c> for booleans). The default value ignored can be changed by | ||
3616 | placing the <see cref="T:System.ComponentModel.DefaultValueAttribute"/> on the property. | ||
3617 | </summary> | ||
3618 | </member> | ||
3619 | <member name="F:Newtonsoft.Json.DefaultValueHandling.Populate"> | ||
3620 | <summary> | ||
3621 | Members with a default value but no JSON will be set to their default value when deserializing. | ||
3622 | </summary> | ||
3623 | </member> | ||
3624 | <member name="F:Newtonsoft.Json.DefaultValueHandling.IgnoreAndPopulate"> | ||
3625 | <summary> | ||
3626 | Ignore members where the member value is the same as the member's default value when serializing objects | ||
3627 | and sets members to their default value when deserializing. | ||
3628 | </summary> | ||
3629 | </member> | ||
3630 | <member name="T:Newtonsoft.Json.JsonConverterAttribute"> | ||
3631 | <summary> | ||
3632 | Instructs the <see cref="T:Newtonsoft.Json.JsonSerializer"/> to use the specified <see cref="T:Newtonsoft.Json.JsonConverter"/> when serializing the member or class. | ||
3633 | </summary> | ||
3634 | </member> | ||
3635 | <member name="M:Newtonsoft.Json.JsonConverterAttribute.#ctor(System.Type)"> | ||
3636 | <summary> | ||
3637 | Initializes a new instance of the <see cref="T:Newtonsoft.Json.JsonConverterAttribute"/> class. | ||
3638 | </summary> | ||
3639 | <param name="converterType">Type of the converter.</param> | ||
3640 | </member> | ||
3641 | <member name="M:Newtonsoft.Json.JsonConverterAttribute.#ctor(System.Type,System.Object[])"> | ||
3642 | <summary> | ||
3643 | Initializes a new instance of the <see cref="T:Newtonsoft.Json.JsonConverterAttribute"/> class. | ||
3644 | </summary> | ||
3645 | <param name="converterType">Type of the converter.</param> | ||
3646 | <param name="converterParameters">Parameter list to use when constructing the JsonConverter. Can be null.</param> | ||
3647 | </member> | ||
3648 | <member name="P:Newtonsoft.Json.JsonConverterAttribute.ConverterType"> | ||
3649 | <summary> | ||
3650 | Gets the type of the converter. | ||
3651 | </summary> | ||
3652 | <value>The type of the converter.</value> | ||
3653 | </member> | ||
3654 | <member name="P:Newtonsoft.Json.JsonConverterAttribute.ConverterParameters"> | ||
3655 | <summary> | ||
3656 | The parameter list to use when constructing the JsonConverter described by ConverterType. | ||
3657 | If null, the default constructor is used. | ||
3658 | </summary> | ||
3659 | </member> | ||
3660 | <member name="T:Newtonsoft.Json.JsonObjectAttribute"> | ||
3661 | <summary> | ||
3662 | Instructs the <see cref="T:Newtonsoft.Json.JsonSerializer"/> how to serialize the object. | ||
3663 | </summary> | ||
3664 | </member> | ||
3665 | <member name="M:Newtonsoft.Json.JsonObjectAttribute.#ctor"> | ||
3666 | <summary> | ||
3667 | Initializes a new instance of the <see cref="T:Newtonsoft.Json.JsonObjectAttribute"/> class. | ||
3668 | </summary> | ||
3669 | </member> | ||
3670 | <member name="M:Newtonsoft.Json.JsonObjectAttribute.#ctor(Newtonsoft.Json.MemberSerialization)"> | ||
3671 | <summary> | ||
3672 | Initializes a new instance of the <see cref="T:Newtonsoft.Json.JsonObjectAttribute"/> class with the specified member serialization. | ||
3673 | </summary> | ||
3674 | <param name="memberSerialization">The member serialization.</param> | ||
3675 | </member> | ||
3676 | <member name="M:Newtonsoft.Json.JsonObjectAttribute.#ctor(System.String)"> | ||
3677 | <summary> | ||
3678 | Initializes a new instance of the <see cref="T:Newtonsoft.Json.JsonObjectAttribute"/> class with the specified container Id. | ||
3679 | </summary> | ||
3680 | <param name="id">The container Id.</param> | ||
3681 | </member> | ||
3682 | <member name="P:Newtonsoft.Json.JsonObjectAttribute.MemberSerialization"> | ||
3683 | <summary> | ||
3684 | Gets or sets the member serialization. | ||
3685 | </summary> | ||
3686 | <value>The member serialization.</value> | ||
3687 | </member> | ||
3688 | <member name="P:Newtonsoft.Json.JsonObjectAttribute.ItemRequired"> | ||
3689 | <summary> | ||
3690 | Gets or sets a value that indicates whether the object's properties are required. | ||
3691 | </summary> | ||
3692 | <value> | ||
3693 | A value indicating whether the object's properties are required. | ||
3694 | </value> | ||
3695 | </member> | ||
3696 | <member name="T:Newtonsoft.Json.JsonSerializerSettings"> | ||
3697 | <summary> | ||
3698 | Specifies the settings on a <see cref="T:Newtonsoft.Json.JsonSerializer"/> object. | ||
3699 | </summary> | ||
3700 | </member> | ||
3701 | <member name="M:Newtonsoft.Json.JsonSerializerSettings.#ctor"> | ||
3702 | <summary> | ||
3703 | Initializes a new instance of the <see cref="T:Newtonsoft.Json.JsonSerializerSettings"/> class. | ||
3704 | </summary> | ||
3705 | </member> | ||
3706 | <member name="P:Newtonsoft.Json.JsonSerializerSettings.ReferenceLoopHandling"> | ||
3707 | <summary> | ||
3708 | Gets or sets how reference loops (e.g. a class referencing itself) is handled. | ||
3709 | </summary> | ||
3710 | <value>Reference loop handling.</value> | ||
3711 | </member> | ||
3712 | <member name="P:Newtonsoft.Json.JsonSerializerSettings.MissingMemberHandling"> | ||
3713 | <summary> | ||
3714 | Gets or sets how missing members (e.g. JSON contains a property that isn't a member on the object) are handled during deserialization. | ||
3715 | </summary> | ||
3716 | <value>Missing member handling.</value> | ||
3717 | </member> | ||
3718 | <member name="P:Newtonsoft.Json.JsonSerializerSettings.ObjectCreationHandling"> | ||
3719 | <summary> | ||
3720 | Gets or sets how objects are created during deserialization. | ||
3721 | </summary> | ||
3722 | <value>The object creation handling.</value> | ||
3723 | </member> | ||
3724 | <member name="P:Newtonsoft.Json.JsonSerializerSettings.NullValueHandling"> | ||
3725 | <summary> | ||
3726 | Gets or sets how null values are handled during serialization and deserialization. | ||
3727 | </summary> | ||
3728 | <value>Null value handling.</value> | ||
3729 | </member> | ||
3730 | <member name="P:Newtonsoft.Json.JsonSerializerSettings.DefaultValueHandling"> | ||
3731 | <summary> | ||
3732 | Gets or sets how null default are handled during serialization and deserialization. | ||
3733 | </summary> | ||
3734 | <value>The default value handling.</value> | ||
3735 | </member> | ||
3736 | <member name="P:Newtonsoft.Json.JsonSerializerSettings.Converters"> | ||
3737 | <summary> | ||
3738 | Gets or sets a collection <see cref="T:Newtonsoft.Json.JsonConverter"/> that will be used during serialization. | ||
3739 | </summary> | ||
3740 | <value>The converters.</value> | ||
3741 | </member> | ||
3742 | <member name="P:Newtonsoft.Json.JsonSerializerSettings.PreserveReferencesHandling"> | ||
3743 | <summary> | ||
3744 | Gets or sets how object references are preserved by the serializer. | ||
3745 | </summary> | ||
3746 | <value>The preserve references handling.</value> | ||
3747 | </member> | ||
3748 | <member name="P:Newtonsoft.Json.JsonSerializerSettings.TypeNameHandling"> | ||
3749 | <summary> | ||
3750 | Gets or sets how type name writing and reading is handled by the serializer. | ||
3751 | </summary> | ||
3752 | <value>The type name handling.</value> | ||
3753 | </member> | ||
3754 | <member name="P:Newtonsoft.Json.JsonSerializerSettings.MetadataPropertyHandling"> | ||
3755 | <summary> | ||
3756 | Gets or sets how metadata properties are used during deserialization. | ||
3757 | </summary> | ||
3758 | <value>The metadata properties handling.</value> | ||
3759 | </member> | ||
3760 | <member name="P:Newtonsoft.Json.JsonSerializerSettings.TypeNameAssemblyFormat"> | ||
3761 | <summary> | ||
3762 | Gets or sets how a type name assembly is written and resolved by the serializer. | ||
3763 | </summary> | ||
3764 | <value>The type name assembly format.</value> | ||
3765 | </member> | ||
3766 | <member name="P:Newtonsoft.Json.JsonSerializerSettings.ConstructorHandling"> | ||
3767 | <summary> | ||
3768 | Gets or sets how constructors are used during deserialization. | ||
3769 | </summary> | ||
3770 | <value>The constructor handling.</value> | ||
3771 | </member> | ||
3772 | <member name="P:Newtonsoft.Json.JsonSerializerSettings.ContractResolver"> | ||
3773 | <summary> | ||
3774 | Gets or sets the contract resolver used by the serializer when | ||
3775 | serializing .NET objects to JSON and vice versa. | ||
3776 | </summary> | ||
3777 | <value>The contract resolver.</value> | ||
3778 | </member> | ||
3779 | <member name="P:Newtonsoft.Json.JsonSerializerSettings.ReferenceResolver"> | ||
3780 | <summary> | ||
3781 | Gets or sets the <see cref="T:Newtonsoft.Json.Serialization.IReferenceResolver"/> used by the serializer when resolving references. | ||
3782 | </summary> | ||
3783 | <value>The reference resolver.</value> | ||
3784 | </member> | ||
3785 | <member name="P:Newtonsoft.Json.JsonSerializerSettings.TraceWriter"> | ||
3786 | <summary> | ||
3787 | Gets or sets the <see cref="T:Newtonsoft.Json.Serialization.ITraceWriter"/> used by the serializer when writing trace messages. | ||
3788 | </summary> | ||
3789 | <value>The trace writer.</value> | ||
3790 | </member> | ||
3791 | <member name="P:Newtonsoft.Json.JsonSerializerSettings.Binder"> | ||
3792 | <summary> | ||
3793 | Gets or sets the <see cref="T:System.Runtime.Serialization.SerializationBinder"/> used by the serializer when resolving type names. | ||
3794 | </summary> | ||
3795 | <value>The binder.</value> | ||
3796 | </member> | ||
3797 | <member name="P:Newtonsoft.Json.JsonSerializerSettings.Error"> | ||
3798 | <summary> | ||
3799 | Gets or sets the error handler called during serialization and deserialization. | ||
3800 | </summary> | ||
3801 | <value>The error handler called during serialization and deserialization.</value> | ||
3802 | </member> | ||
3803 | <member name="P:Newtonsoft.Json.JsonSerializerSettings.Context"> | ||
3804 | <summary> | ||
3805 | Gets or sets the <see cref="T:System.Runtime.Serialization.StreamingContext"/> used by the serializer when invoking serialization callback methods. | ||
3806 | </summary> | ||
3807 | <value>The context.</value> | ||
3808 | </member> | ||
3809 | <member name="P:Newtonsoft.Json.JsonSerializerSettings.DateFormatString"> | ||
3810 | <summary> | ||
3811 | Get or set how <see cref="T:System.DateTime"/> and <see cref="T:System.DateTimeOffset"/> values are formatting when writing JSON text. | ||
3812 | </summary> | ||
3813 | </member> | ||
3814 | <member name="P:Newtonsoft.Json.JsonSerializerSettings.MaxDepth"> | ||
3815 | <summary> | ||
3816 | Gets or sets the maximum depth allowed when reading JSON. Reading past this depth will throw a <see cref="T:Newtonsoft.Json.JsonReaderException"/>. | ||
3817 | </summary> | ||
3818 | </member> | ||
3819 | <member name="P:Newtonsoft.Json.JsonSerializerSettings.Formatting"> | ||
3820 | <summary> | ||
3821 | Indicates how JSON text output is formatted. | ||
3822 | </summary> | ||
3823 | </member> | ||
3824 | <member name="P:Newtonsoft.Json.JsonSerializerSettings.DateFormatHandling"> | ||
3825 | <summary> | ||
3826 | Get or set how dates are written to JSON text. | ||
3827 | </summary> | ||
3828 | </member> | ||
3829 | <member name="P:Newtonsoft.Json.JsonSerializerSettings.DateTimeZoneHandling"> | ||
3830 | <summary> | ||
3831 | Get or set how <see cref="T:System.DateTime"/> time zones are handling during serialization and deserialization. | ||
3832 | </summary> | ||
3833 | </member> | ||
3834 | <member name="P:Newtonsoft.Json.JsonSerializerSettings.DateParseHandling"> | ||
3835 | <summary> | ||
3836 | Get or set how date formatted strings, e.g. "\/Date(1198908717056)\/" and "2012-03-21T05:40Z", are parsed when reading JSON. | ||
3837 | </summary> | ||
3838 | </member> | ||
3839 | <member name="P:Newtonsoft.Json.JsonSerializerSettings.FloatFormatHandling"> | ||
3840 | <summary> | ||
3841 | Get or set how special floating point numbers, e.g. <see cref="F:System.Double.NaN"/>, | ||
3842 | <see cref="F:System.Double.PositiveInfinity"/> and <see cref="F:System.Double.NegativeInfinity"/>, | ||
3843 | are written as JSON. | ||
3844 | </summary> | ||
3845 | </member> | ||
3846 | <member name="P:Newtonsoft.Json.JsonSerializerSettings.FloatParseHandling"> | ||
3847 | <summary> | ||
3848 | Get or set how floating point numbers, e.g. 1.0 and 9.9, are parsed when reading JSON text. | ||
3849 | </summary> | ||
3850 | </member> | ||
3851 | <member name="P:Newtonsoft.Json.JsonSerializerSettings.StringEscapeHandling"> | ||
3852 | <summary> | ||
3853 | Get or set how strings are escaped when writing JSON text. | ||
3854 | </summary> | ||
3855 | </member> | ||
3856 | <member name="P:Newtonsoft.Json.JsonSerializerSettings.Culture"> | ||
3857 | <summary> | ||
3858 | Gets or sets the culture used when reading JSON. Defaults to <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>. | ||
3859 | </summary> | ||
3860 | </member> | ||
3861 | <member name="P:Newtonsoft.Json.JsonSerializerSettings.CheckAdditionalContent"> | ||
3862 | <summary> | ||
3863 | Gets a value indicating whether there will be a check for additional content after deserializing an object. | ||
3864 | </summary> | ||
3865 | <value> | ||
3866 | <c>true</c> if there will be a check for additional content after deserializing an object; otherwise, <c>false</c>. | ||
3867 | </value> | ||
3868 | </member> | ||
3869 | <member name="T:Newtonsoft.Json.JsonValidatingReader"> | ||
3870 | <summary> | ||
3871 | Represents a reader that provides <see cref="T:Newtonsoft.Json.Schema.JsonSchema"/> validation. | ||
3872 | </summary> | ||
3873 | </member> | ||
3874 | <member name="M:Newtonsoft.Json.JsonValidatingReader.#ctor(Newtonsoft.Json.JsonReader)"> | ||
3875 | <summary> | ||
3876 | Initializes a new instance of the <see cref="T:Newtonsoft.Json.JsonValidatingReader"/> class that | ||
3877 | validates the content returned from the given <see cref="T:Newtonsoft.Json.JsonReader"/>. | ||
3878 | </summary> | ||
3879 | <param name="reader">The <see cref="T:Newtonsoft.Json.JsonReader"/> to read from while validating.</param> | ||
3880 | </member> | ||
3881 | <member name="M:Newtonsoft.Json.JsonValidatingReader.ReadAsInt32"> | ||
3882 | <summary> | ||
3883 | Reads the next JSON token from the stream as a <see cref="T:System.Nullable`1"/>. | ||
3884 | </summary> | ||
3885 | <returns>A <see cref="T:System.Nullable`1"/>.</returns> | ||
3886 | </member> | ||
3887 | <member name="M:Newtonsoft.Json.JsonValidatingReader.ReadAsBytes"> | ||
3888 | <summary> | ||
3889 | Reads the next JSON token from the stream as a <see cref="T:Byte[]"/>. | ||
3890 | </summary> | ||
3891 | <returns> | ||
3892 | A <see cref="T:Byte[]"/> or a null reference if the next JSON token is null. | ||
3893 | </returns> | ||
3894 | </member> | ||
3895 | <member name="M:Newtonsoft.Json.JsonValidatingReader.ReadAsDecimal"> | ||
3896 | <summary> | ||
3897 | Reads the next JSON token from the stream as a <see cref="T:System.Nullable`1"/>. | ||
3898 | </summary> | ||
3899 | <returns>A <see cref="T:System.Nullable`1"/>.</returns> | ||
3900 | </member> | ||
3901 | <member name="M:Newtonsoft.Json.JsonValidatingReader.ReadAsString"> | ||
3902 | <summary> | ||
3903 | Reads the next JSON token from the stream as a <see cref="T:System.String"/>. | ||
3904 | </summary> | ||
3905 | <returns>A <see cref="T:System.String"/>. This method will return <c>null</c> at the end of an array.</returns> | ||
3906 | </member> | ||
3907 | <member name="M:Newtonsoft.Json.JsonValidatingReader.ReadAsDateTime"> | ||
3908 | <summary> | ||
3909 | Reads the next JSON token from the stream as a <see cref="T:System.Nullable`1"/>. | ||
3910 | </summary> | ||
3911 | <returns>A <see cref="T:System.String"/>. This method will return <c>null</c> at the end of an array.</returns> | ||
3912 | </member> | ||
3913 | <member name="M:Newtonsoft.Json.JsonValidatingReader.ReadAsDateTimeOffset"> | ||
3914 | <summary> | ||
3915 | Reads the next JSON token from the stream as a <see cref="T:System.Nullable`1"/>. | ||
3916 | </summary> | ||
3917 | <returns>A <see cref="T:System.Nullable`1"/>.</returns> | ||
3918 | </member> | ||
3919 | <member name="M:Newtonsoft.Json.JsonValidatingReader.Read"> | ||
3920 | <summary> | ||
3921 | Reads the next JSON token from the stream. | ||
3922 | </summary> | ||
3923 | <returns> | ||
3924 | true if the next token was read successfully; false if there are no more tokens to read. | ||
3925 | </returns> | ||
3926 | </member> | ||
3927 | <member name="E:Newtonsoft.Json.JsonValidatingReader.ValidationEventHandler"> | ||
3928 | <summary> | ||
3929 | Sets an event handler for receiving schema validation errors. | ||
3930 | </summary> | ||
3931 | </member> | ||
3932 | <member name="P:Newtonsoft.Json.JsonValidatingReader.Value"> | ||
3933 | <summary> | ||
3934 | Gets the text value of the current JSON token. | ||
3935 | </summary> | ||
3936 | <value></value> | ||
3937 | </member> | ||
3938 | <member name="P:Newtonsoft.Json.JsonValidatingReader.Depth"> | ||
3939 | <summary> | ||
3940 | Gets the depth of the current token in the JSON document. | ||
3941 | </summary> | ||
3942 | <value>The depth of the current token in the JSON document.</value> | ||
3943 | </member> | ||
3944 | <member name="P:Newtonsoft.Json.JsonValidatingReader.Path"> | ||
3945 | <summary> | ||
3946 | Gets the path of the current JSON token. | ||
3947 | </summary> | ||
3948 | </member> | ||
3949 | <member name="P:Newtonsoft.Json.JsonValidatingReader.QuoteChar"> | ||
3950 | <summary> | ||
3951 | Gets the quotation mark character used to enclose the value of a string. | ||
3952 | </summary> | ||
3953 | <value></value> | ||
3954 | </member> | ||
3955 | <member name="P:Newtonsoft.Json.JsonValidatingReader.TokenType"> | ||
3956 | <summary> | ||
3957 | Gets the type of the current JSON token. | ||
3958 | </summary> | ||
3959 | <value></value> | ||
3960 | </member> | ||
3961 | <member name="P:Newtonsoft.Json.JsonValidatingReader.ValueType"> | ||
3962 | <summary> | ||
3963 | Gets the Common Language Runtime (CLR) type for the current JSON token. | ||
3964 | </summary> | ||
3965 | <value></value> | ||
3966 | </member> | ||
3967 | <member name="P:Newtonsoft.Json.JsonValidatingReader.Schema"> | ||
3968 | <summary> | ||
3969 | Gets or sets the schema. | ||
3970 | </summary> | ||
3971 | <value>The schema.</value> | ||
3972 | </member> | ||
3973 | <member name="P:Newtonsoft.Json.JsonValidatingReader.Reader"> | ||
3974 | <summary> | ||
3975 | Gets the <see cref="T:Newtonsoft.Json.JsonReader"/> used to construct this <see cref="T:Newtonsoft.Json.JsonValidatingReader"/>. | ||
3976 | </summary> | ||
3977 | <value>The <see cref="T:Newtonsoft.Json.JsonReader"/> specified in the constructor.</value> | ||
3978 | </member> | ||
3979 | <member name="T:Newtonsoft.Json.Linq.JTokenEqualityComparer"> | ||
3980 | <summary> | ||
3981 | Compares tokens to determine whether they are equal. | ||
3982 | </summary> | ||
3983 | </member> | ||
3984 | <member name="M:Newtonsoft.Json.Linq.JTokenEqualityComparer.Equals(Newtonsoft.Json.Linq.JToken,Newtonsoft.Json.Linq.JToken)"> | ||
3985 | <summary> | ||
3986 | Determines whether the specified objects are equal. | ||
3987 | </summary> | ||
3988 | <param name="x">The first object of type <see cref="T:Newtonsoft.Json.Linq.JToken"/> to compare.</param> | ||
3989 | <param name="y">The second object of type <see cref="T:Newtonsoft.Json.Linq.JToken"/> to compare.</param> | ||
3990 | <returns> | ||
3991 | true if the specified objects are equal; otherwise, false. | ||
3992 | </returns> | ||
3993 | </member> | ||
3994 | <member name="M:Newtonsoft.Json.Linq.JTokenEqualityComparer.GetHashCode(Newtonsoft.Json.Linq.JToken)"> | ||
3995 | <summary> | ||
3996 | Returns a hash code for the specified object. | ||
3997 | </summary> | ||
3998 | <param name="obj">The <see cref="T:System.Object"/> for which a hash code is to be returned.</param> | ||
3999 | <returns>A hash code for the specified object.</returns> | ||
4000 | <exception cref="T:System.ArgumentNullException">The type of <paramref name="obj"/> is a reference type and <paramref name="obj"/> is null.</exception> | ||
4001 | </member> | ||
4002 | <member name="T:Newtonsoft.Json.MemberSerialization"> | ||
4003 | <summary> | ||
4004 | Specifies the member serialization options for the <see cref="T:Newtonsoft.Json.JsonSerializer"/>. | ||
4005 | </summary> | ||
4006 | </member> | ||
4007 | <member name="F:Newtonsoft.Json.MemberSerialization.OptOut"> | ||
4008 | <summary> | ||
4009 | All public members are serialized by default. Members can be excluded using <see cref="T:Newtonsoft.Json.JsonIgnoreAttribute"/> or <see cref="T:System.NonSerializedAttribute"/>. | ||
4010 | This is the default member serialization mode. | ||
4011 | </summary> | ||
4012 | </member> | ||
4013 | <member name="F:Newtonsoft.Json.MemberSerialization.OptIn"> | ||
4014 | <summary> | ||
4015 | Only members must be marked with <see cref="T:Newtonsoft.Json.JsonPropertyAttribute"/> or <see cref="T:System.Runtime.Serialization.DataMemberAttribute"/> are serialized. | ||
4016 | This member serialization mode can also be set by marking the class with <see cref="T:System.Runtime.Serialization.DataContractAttribute"/>. | ||
4017 | </summary> | ||
4018 | </member> | ||
4019 | <member name="F:Newtonsoft.Json.MemberSerialization.Fields"> | ||
4020 | <summary> | ||
4021 | All public and private fields are serialized. Members can be excluded using <see cref="T:Newtonsoft.Json.JsonIgnoreAttribute"/> or <see cref="T:System.NonSerializedAttribute"/>. | ||
4022 | This member serialization mode can also be set by marking the class with <see cref="T:System.SerializableAttribute"/> | ||
4023 | and setting IgnoreSerializableAttribute on <see cref="T:Newtonsoft.Json.Serialization.DefaultContractResolver"/> to false. | ||
4024 | </summary> | ||
4025 | </member> | ||
4026 | <member name="T:Newtonsoft.Json.ObjectCreationHandling"> | ||
4027 | <summary> | ||
4028 | Specifies how object creation is handled by the <see cref="T:Newtonsoft.Json.JsonSerializer"/>. | ||
4029 | </summary> | ||
4030 | </member> | ||
4031 | <member name="F:Newtonsoft.Json.ObjectCreationHandling.Auto"> | ||
4032 | <summary> | ||
4033 | Reuse existing objects, create new objects when needed. | ||
4034 | </summary> | ||
4035 | </member> | ||
4036 | <member name="F:Newtonsoft.Json.ObjectCreationHandling.Reuse"> | ||
4037 | <summary> | ||
4038 | Only reuse existing objects. | ||
4039 | </summary> | ||
4040 | </member> | ||
4041 | <member name="F:Newtonsoft.Json.ObjectCreationHandling.Replace"> | ||
4042 | <summary> | ||
4043 | Always create new objects. | ||
4044 | </summary> | ||
4045 | </member> | ||
4046 | <member name="T:Newtonsoft.Json.Converters.IsoDateTimeConverter"> | ||
4047 | <summary> | ||
4048 | Converts a <see cref="T:System.DateTime"/> to and from the ISO 8601 date format (e.g. 2008-04-12T12:53Z). | ||
4049 | </summary> | ||
4050 | </member> | ||
4051 | <member name="M:Newtonsoft.Json.Converters.IsoDateTimeConverter.WriteJson(Newtonsoft.Json.JsonWriter,System.Object,Newtonsoft.Json.JsonSerializer)"> | ||
4052 | <summary> | ||
4053 | Writes the JSON representation of the object. | ||
4054 | </summary> | ||
4055 | <param name="writer">The <see cref="T:Newtonsoft.Json.JsonWriter"/> to write to.</param> | ||
4056 | <param name="value">The value.</param> | ||
4057 | <param name="serializer">The calling serializer.</param> | ||
4058 | </member> | ||
4059 | <member name="M:Newtonsoft.Json.Converters.IsoDateTimeConverter.ReadJson(Newtonsoft.Json.JsonReader,System.Type,System.Object,Newtonsoft.Json.JsonSerializer)"> | ||
4060 | <summary> | ||
4061 | Reads the JSON representation of the object. | ||
4062 | </summary> | ||
4063 | <param name="reader">The <see cref="T:Newtonsoft.Json.JsonReader"/> to read from.</param> | ||
4064 | <param name="objectType">Type of the object.</param> | ||
4065 | <param name="existingValue">The existing value of object being read.</param> | ||
4066 | <param name="serializer">The calling serializer.</param> | ||
4067 | <returns>The object value.</returns> | ||
4068 | </member> | ||
4069 | <member name="P:Newtonsoft.Json.Converters.IsoDateTimeConverter.DateTimeStyles"> | ||
4070 | <summary> | ||
4071 | Gets or sets the date time styles used when converting a date to and from JSON. | ||
4072 | </summary> | ||
4073 | <value>The date time styles used when converting a date to and from JSON.</value> | ||
4074 | </member> | ||
4075 | <member name="P:Newtonsoft.Json.Converters.IsoDateTimeConverter.DateTimeFormat"> | ||
4076 | <summary> | ||
4077 | Gets or sets the date time format used when converting a date to and from JSON. | ||
4078 | </summary> | ||
4079 | <value>The date time format used when converting a date to and from JSON.</value> | ||
4080 | </member> | ||
4081 | <member name="P:Newtonsoft.Json.Converters.IsoDateTimeConverter.Culture"> | ||
4082 | <summary> | ||
4083 | Gets or sets the culture used when converting a date to and from JSON. | ||
4084 | </summary> | ||
4085 | <value>The culture used when converting a date to and from JSON.</value> | ||
4086 | </member> | ||
4087 | <member name="T:Newtonsoft.Json.Converters.JavaScriptDateTimeConverter"> | ||
4088 | <summary> | ||
4089 | Converts a <see cref="T:System.DateTime"/> to and from a JavaScript date constructor (e.g. new Date(52231943)). | ||
4090 | </summary> | ||
4091 | </member> | ||
4092 | <member name="M:Newtonsoft.Json.Converters.JavaScriptDateTimeConverter.WriteJson(Newtonsoft.Json.JsonWriter,System.Object,Newtonsoft.Json.JsonSerializer)"> | ||
4093 | <summary> | ||
4094 | Writes the JSON representation of the object. | ||
4095 | </summary> | ||
4096 | <param name="writer">The <see cref="T:Newtonsoft.Json.JsonWriter"/> to write to.</param> | ||
4097 | <param name="value">The value.</param> | ||
4098 | <param name="serializer">The calling serializer.</param> | ||
4099 | </member> | ||
4100 | <member name="M:Newtonsoft.Json.Converters.JavaScriptDateTimeConverter.ReadJson(Newtonsoft.Json.JsonReader,System.Type,System.Object,Newtonsoft.Json.JsonSerializer)"> | ||
4101 | <summary> | ||
4102 | Reads the JSON representation of the object. | ||
4103 | </summary> | ||
4104 | <param name="reader">The <see cref="T:Newtonsoft.Json.JsonReader"/> to read from.</param> | ||
4105 | <param name="objectType">Type of the object.</param> | ||
4106 | <param name="existingValue">The existing property value of the JSON that is being converted.</param> | ||
4107 | <param name="serializer">The calling serializer.</param> | ||
4108 | <returns>The object value.</returns> | ||
4109 | </member> | ||
4110 | <member name="T:Newtonsoft.Json.Converters.XmlNodeConverter"> | ||
4111 | <summary> | ||
4112 | Converts XML to and from JSON. | ||
4113 | </summary> | ||
4114 | </member> | ||
4115 | <member name="M:Newtonsoft.Json.Converters.XmlNodeConverter.WriteJson(Newtonsoft.Json.JsonWriter,System.Object,Newtonsoft.Json.JsonSerializer)"> | ||
4116 | <summary> | ||
4117 | Writes the JSON representation of the object. | ||
4118 | </summary> | ||
4119 | <param name="writer">The <see cref="T:Newtonsoft.Json.JsonWriter"/> to write to.</param> | ||
4120 | <param name="serializer">The calling serializer.</param> | ||
4121 | <param name="value">The value.</param> | ||
4122 | </member> | ||
4123 | <member name="M:Newtonsoft.Json.Converters.XmlNodeConverter.ReadJson(Newtonsoft.Json.JsonReader,System.Type,System.Object,Newtonsoft.Json.JsonSerializer)"> | ||
4124 | <summary> | ||
4125 | Reads the JSON representation of the object. | ||
4126 | </summary> | ||
4127 | <param name="reader">The <see cref="T:Newtonsoft.Json.JsonReader"/> to read from.</param> | ||
4128 | <param name="objectType">Type of the object.</param> | ||
4129 | <param name="existingValue">The existing value of object being read.</param> | ||
4130 | <param name="serializer">The calling serializer.</param> | ||
4131 | <returns>The object value.</returns> | ||
4132 | </member> | ||
4133 | <member name="M:Newtonsoft.Json.Converters.XmlNodeConverter.IsNamespaceAttribute(System.String,System.String@)"> | ||
4134 | <summary> | ||
4135 | Checks if the attributeName is a namespace attribute. | ||
4136 | </summary> | ||
4137 | <param name="attributeName">Attribute name to test.</param> | ||
4138 | <param name="prefix">The attribute name prefix if it has one, otherwise an empty string.</param> | ||
4139 | <returns>True if attribute name is for a namespace attribute, otherwise false.</returns> | ||
4140 | </member> | ||
4141 | <member name="M:Newtonsoft.Json.Converters.XmlNodeConverter.CanConvert(System.Type)"> | ||
4142 | <summary> | ||
4143 | Determines whether this instance can convert the specified value type. | ||
4144 | </summary> | ||
4145 | <param name="valueType">Type of the value.</param> | ||
4146 | <returns> | ||
4147 | <c>true</c> if this instance can convert the specified value type; otherwise, <c>false</c>. | ||
4148 | </returns> | ||
4149 | </member> | ||
4150 | <member name="P:Newtonsoft.Json.Converters.XmlNodeConverter.DeserializeRootElementName"> | ||
4151 | <summary> | ||
4152 | Gets or sets the name of the root element to insert when deserializing to XML if the JSON structure has produces multiple root elements. | ||
4153 | </summary> | ||
4154 | <value>The name of the deserialize root element.</value> | ||
4155 | </member> | ||
4156 | <member name="P:Newtonsoft.Json.Converters.XmlNodeConverter.WriteArrayAttribute"> | ||
4157 | <summary> | ||
4158 | Gets or sets a flag to indicate whether to write the Json.NET array attribute. | ||
4159 | This attribute helps preserve arrays when converting the written XML back to JSON. | ||
4160 | </summary> | ||
4161 | <value><c>true</c> if the array attibute is written to the XML; otherwise, <c>false</c>.</value> | ||
4162 | </member> | ||
4163 | <member name="P:Newtonsoft.Json.Converters.XmlNodeConverter.OmitRootObject"> | ||
4164 | <summary> | ||
4165 | Gets or sets a value indicating whether to write the root JSON object. | ||
4166 | </summary> | ||
4167 | <value><c>true</c> if the JSON root object is omitted; otherwise, <c>false</c>.</value> | ||
4168 | </member> | ||
4169 | <member name="T:Newtonsoft.Json.JsonTextReader"> | ||
4170 | <summary> | ||
4171 | Represents a reader that provides fast, non-cached, forward-only access to JSON text data. | ||
4172 | </summary> | ||
4173 | </member> | ||
4174 | <member name="M:Newtonsoft.Json.JsonTextReader.#ctor(System.IO.TextReader)"> | ||
4175 | <summary> | ||
4176 | Initializes a new instance of the <see cref="T:Newtonsoft.Json.JsonReader"/> class with the specified <see cref="T:System.IO.TextReader"/>. | ||
4177 | </summary> | ||
4178 | <param name="reader">The <c>TextReader</c> containing the XML data to read.</param> | ||
4179 | </member> | ||
4180 | <member name="M:Newtonsoft.Json.JsonTextReader.Read"> | ||
4181 | <summary> | ||
4182 | Reads the next JSON token from the stream. | ||
4183 | </summary> | ||
4184 | <returns> | ||
4185 | true if the next token was read successfully; false if there are no more tokens to read. | ||
4186 | </returns> | ||
4187 | </member> | ||
4188 | <member name="M:Newtonsoft.Json.JsonTextReader.ReadAsBytes"> | ||
4189 | <summary> | ||
4190 | Reads the next JSON token from the stream as a <see cref="T:Byte[]"/>. | ||
4191 | </summary> | ||
4192 | <returns> | ||
4193 | A <see cref="T:Byte[]"/> or a null reference if the next JSON token is null. This method will return <c>null</c> at the end of an array. | ||
4194 | </returns> | ||
4195 | </member> | ||
4196 | <member name="M:Newtonsoft.Json.JsonTextReader.ReadAsDecimal"> | ||
4197 | <summary> | ||
4198 | Reads the next JSON token from the stream as a <see cref="T:System.Nullable`1"/>. | ||
4199 | </summary> | ||
4200 | <returns>A <see cref="T:System.Nullable`1"/>. This method will return <c>null</c> at the end of an array.</returns> | ||
4201 | </member> | ||
4202 | <member name="M:Newtonsoft.Json.JsonTextReader.ReadAsInt32"> | ||
4203 | <summary> | ||
4204 | Reads the next JSON token from the stream as a <see cref="T:System.Nullable`1"/>. | ||
4205 | </summary> | ||
4206 | <returns>A <see cref="T:System.Nullable`1"/>. This method will return <c>null</c> at the end of an array.</returns> | ||
4207 | </member> | ||
4208 | <member name="M:Newtonsoft.Json.JsonTextReader.ReadAsString"> | ||
4209 | <summary> | ||
4210 | Reads the next JSON token from the stream as a <see cref="T:System.String"/>. | ||
4211 | </summary> | ||
4212 | <returns>A <see cref="T:System.String"/>. This method will return <c>null</c> at the end of an array.</returns> | ||
4213 | </member> | ||
4214 | <member name="M:Newtonsoft.Json.JsonTextReader.ReadAsDateTime"> | ||
4215 | <summary> | ||
4216 | Reads the next JSON token from the stream as a <see cref="T:System.Nullable`1"/>. | ||
4217 | </summary> | ||
4218 | <returns>A <see cref="T:System.String"/>. This method will return <c>null</c> at the end of an array.</returns> | ||
4219 | </member> | ||
4220 | <member name="M:Newtonsoft.Json.JsonTextReader.ReadAsDateTimeOffset"> | ||
4221 | <summary> | ||
4222 | Reads the next JSON token from the stream as a <see cref="T:System.Nullable`1"/>. | ||
4223 | </summary> | ||
4224 | <returns>A <see cref="T:System.DateTimeOffset"/>. This method will return <c>null</c> at the end of an array.</returns> | ||
4225 | </member> | ||
4226 | <member name="M:Newtonsoft.Json.JsonTextReader.Close"> | ||
4227 | <summary> | ||
4228 | Changes the state to closed. | ||
4229 | </summary> | ||
4230 | </member> | ||
4231 | <member name="M:Newtonsoft.Json.JsonTextReader.HasLineInfo"> | ||
4232 | <summary> | ||
4233 | Gets a value indicating whether the class can return line information. | ||
4234 | </summary> | ||
4235 | <returns> | ||
4236 | <c>true</c> if LineNumber and LinePosition can be provided; otherwise, <c>false</c>. | ||
4237 | </returns> | ||
4238 | </member> | ||
4239 | <member name="P:Newtonsoft.Json.JsonTextReader.LineNumber"> | ||
4240 | <summary> | ||
4241 | Gets the current line number. | ||
4242 | </summary> | ||
4243 | <value> | ||
4244 | The current line number or 0 if no line information is available (for example, HasLineInfo returns false). | ||
4245 | </value> | ||
4246 | </member> | ||
4247 | <member name="P:Newtonsoft.Json.JsonTextReader.LinePosition"> | ||
4248 | <summary> | ||
4249 | Gets the current line position. | ||
4250 | </summary> | ||
4251 | <value> | ||
4252 | The current line position or 0 if no line information is available (for example, HasLineInfo returns false). | ||
4253 | </value> | ||
4254 | </member> | ||
4255 | <member name="T:Newtonsoft.Json.JsonPropertyAttribute"> | ||
4256 | <summary> | ||
4257 | Instructs the <see cref="T:Newtonsoft.Json.JsonSerializer"/> to always serialize the member with the specified name. | ||
4258 | </summary> | ||
4259 | </member> | ||
4260 | <member name="M:Newtonsoft.Json.JsonPropertyAttribute.#ctor"> | ||
4261 | <summary> | ||
4262 | Initializes a new instance of the <see cref="T:Newtonsoft.Json.JsonPropertyAttribute"/> class. | ||
4263 | </summary> | ||
4264 | </member> | ||
4265 | <member name="M:Newtonsoft.Json.JsonPropertyAttribute.#ctor(System.String)"> | ||
4266 | <summary> | ||
4267 | Initializes a new instance of the <see cref="T:Newtonsoft.Json.JsonPropertyAttribute"/> class with the specified name. | ||
4268 | </summary> | ||
4269 | <param name="propertyName">Name of the property.</param> | ||
4270 | </member> | ||
4271 | <member name="P:Newtonsoft.Json.JsonPropertyAttribute.ItemConverterType"> | ||
4272 | <summary> | ||
4273 | Gets or sets the converter used when serializing the property's collection items. | ||
4274 | </summary> | ||
4275 | <value>The collection's items converter.</value> | ||
4276 | </member> | ||
4277 | <member name="P:Newtonsoft.Json.JsonPropertyAttribute.ItemConverterParameters"> | ||
4278 | <summary> | ||
4279 | The parameter list to use when constructing the JsonConverter described by ItemConverterType. | ||
4280 | If null, the default constructor is used. | ||
4281 | When non-null, there must be a constructor defined in the JsonConverter that exactly matches the number, | ||
4282 | order, and type of these parameters. | ||
4283 | </summary> | ||
4284 | <example> | ||
4285 | [JsonProperty(ItemConverterType = typeof(MyContainerConverter), ItemConverterParameters = new object[] { 123, "Four" })] | ||
4286 | </example> | ||
4287 | </member> | ||
4288 | <member name="P:Newtonsoft.Json.JsonPropertyAttribute.NullValueHandling"> | ||
4289 | <summary> | ||
4290 | Gets or sets the null value handling used when serializing this property. | ||
4291 | </summary> | ||
4292 | <value>The null value handling.</value> | ||
4293 | </member> | ||
4294 | <member name="P:Newtonsoft.Json.JsonPropertyAttribute.DefaultValueHandling"> | ||
4295 | <summary> | ||
4296 | Gets or sets the default value handling used when serializing this property. | ||
4297 | </summary> | ||
4298 | <value>The default value handling.</value> | ||
4299 | </member> | ||
4300 | <member name="P:Newtonsoft.Json.JsonPropertyAttribute.ReferenceLoopHandling"> | ||
4301 | <summary> | ||
4302 | Gets or sets the reference loop handling used when serializing this property. | ||
4303 | </summary> | ||
4304 | <value>The reference loop handling.</value> | ||
4305 | </member> | ||
4306 | <member name="P:Newtonsoft.Json.JsonPropertyAttribute.ObjectCreationHandling"> | ||
4307 | <summary> | ||
4308 | Gets or sets the object creation handling used when deserializing this property. | ||
4309 | </summary> | ||
4310 | <value>The object creation handling.</value> | ||
4311 | </member> | ||
4312 | <member name="P:Newtonsoft.Json.JsonPropertyAttribute.TypeNameHandling"> | ||
4313 | <summary> | ||
4314 | Gets or sets the type name handling used when serializing this property. | ||
4315 | </summary> | ||
4316 | <value>The type name handling.</value> | ||
4317 | </member> | ||
4318 | <member name="P:Newtonsoft.Json.JsonPropertyAttribute.IsReference"> | ||
4319 | <summary> | ||
4320 | Gets or sets whether this property's value is serialized as a reference. | ||
4321 | </summary> | ||
4322 | <value>Whether this property's value is serialized as a reference.</value> | ||
4323 | </member> | ||
4324 | <member name="P:Newtonsoft.Json.JsonPropertyAttribute.Order"> | ||
4325 | <summary> | ||
4326 | Gets or sets the order of serialization and deserialization of a member. | ||
4327 | </summary> | ||
4328 | <value>The numeric order of serialization or deserialization.</value> | ||
4329 | </member> | ||
4330 | <member name="P:Newtonsoft.Json.JsonPropertyAttribute.Required"> | ||
4331 | <summary> | ||
4332 | Gets or sets a value indicating whether this property is required. | ||
4333 | </summary> | ||
4334 | <value> | ||
4335 | A value indicating whether this property is required. | ||
4336 | </value> | ||
4337 | </member> | ||
4338 | <member name="P:Newtonsoft.Json.JsonPropertyAttribute.PropertyName"> | ||
4339 | <summary> | ||
4340 | Gets or sets the name of the property. | ||
4341 | </summary> | ||
4342 | <value>The name of the property.</value> | ||
4343 | </member> | ||
4344 | <member name="P:Newtonsoft.Json.JsonPropertyAttribute.ItemReferenceLoopHandling"> | ||
4345 | <summary> | ||
4346 | Gets or sets the the reference loop handling used when serializing the property's collection items. | ||
4347 | </summary> | ||
4348 | <value>The collection's items reference loop handling.</value> | ||
4349 | </member> | ||
4350 | <member name="P:Newtonsoft.Json.JsonPropertyAttribute.ItemTypeNameHandling"> | ||
4351 | <summary> | ||
4352 | Gets or sets the the type name handling used when serializing the property's collection items. | ||
4353 | </summary> | ||
4354 | <value>The collection's items type name handling.</value> | ||
4355 | </member> | ||
4356 | <member name="P:Newtonsoft.Json.JsonPropertyAttribute.ItemIsReference"> | ||
4357 | <summary> | ||
4358 | Gets or sets whether this property's collection items are serialized as a reference. | ||
4359 | </summary> | ||
4360 | <value>Whether this property's collection items are serialized as a reference.</value> | ||
4361 | </member> | ||
4362 | <member name="T:Newtonsoft.Json.JsonIgnoreAttribute"> | ||
4363 | <summary> | ||
4364 | Instructs the <see cref="T:Newtonsoft.Json.JsonSerializer"/> not to serialize the public field or public read/write property value. | ||
4365 | </summary> | ||
4366 | </member> | ||
4367 | <member name="T:Newtonsoft.Json.JsonTextWriter"> | ||
4368 | <summary> | ||
4369 | Represents a writer that provides a fast, non-cached, forward-only way of generating Json data. | ||
4370 | </summary> | ||
4371 | </member> | ||
4372 | <member name="M:Newtonsoft.Json.JsonTextWriter.#ctor(System.IO.TextWriter)"> | ||
4373 | <summary> | ||
4374 | Creates an instance of the <c>JsonWriter</c> class using the specified <see cref="T:System.IO.TextWriter"/>. | ||
4375 | </summary> | ||
4376 | <param name="textWriter">The <c>TextWriter</c> to write to.</param> | ||
4377 | </member> | ||
4378 | <member name="M:Newtonsoft.Json.JsonTextWriter.Flush"> | ||
4379 | <summary> | ||
4380 | Flushes whatever is in the buffer to the underlying streams and also flushes the underlying stream. | ||
4381 | </summary> | ||
4382 | </member> | ||
4383 | <member name="M:Newtonsoft.Json.JsonTextWriter.Close"> | ||
4384 | <summary> | ||
4385 | Closes this stream and the underlying stream. | ||
4386 | </summary> | ||
4387 | </member> | ||
4388 | <member name="M:Newtonsoft.Json.JsonTextWriter.WriteStartObject"> | ||
4389 | <summary> | ||
4390 | Writes the beginning of a Json object. | ||
4391 | </summary> | ||
4392 | </member> | ||
4393 | <member name="M:Newtonsoft.Json.JsonTextWriter.WriteStartArray"> | ||
4394 | <summary> | ||
4395 | Writes the beginning of a Json array. | ||
4396 | </summary> | ||
4397 | </member> | ||
4398 | <member name="M:Newtonsoft.Json.JsonTextWriter.WriteStartConstructor(System.String)"> | ||
4399 | <summary> | ||
4400 | Writes the start of a constructor with the given name. | ||
4401 | </summary> | ||
4402 | <param name="name">The name of the constructor.</param> | ||
4403 | </member> | ||
4404 | <member name="M:Newtonsoft.Json.JsonTextWriter.WriteEnd(Newtonsoft.Json.JsonToken)"> | ||
4405 | <summary> | ||
4406 | Writes the specified end token. | ||
4407 | </summary> | ||
4408 | <param name="token">The end token to write.</param> | ||
4409 | </member> | ||
4410 | <member name="M:Newtonsoft.Json.JsonTextWriter.WritePropertyName(System.String)"> | ||
4411 | <summary> | ||
4412 | Writes the property name of a name/value pair on a Json object. | ||
4413 | </summary> | ||
4414 | <param name="name">The name of the property.</param> | ||
4415 | </member> | ||
4416 | <member name="M:Newtonsoft.Json.JsonTextWriter.WritePropertyName(System.String,System.Boolean)"> | ||
4417 | <summary> | ||
4418 | Writes the property name of a name/value pair on a JSON object. | ||
4419 | </summary> | ||
4420 | <param name="name">The name of the property.</param> | ||
4421 | <param name="escape">A flag to indicate whether the text should be escaped when it is written as a JSON property name.</param> | ||
4422 | </member> | ||
4423 | <member name="M:Newtonsoft.Json.JsonTextWriter.WriteIndent"> | ||
4424 | <summary> | ||
4425 | Writes indent characters. | ||
4426 | </summary> | ||
4427 | </member> | ||
4428 | <member name="M:Newtonsoft.Json.JsonTextWriter.WriteValueDelimiter"> | ||
4429 | <summary> | ||
4430 | Writes the JSON value delimiter. | ||
4431 | </summary> | ||
4432 | </member> | ||
4433 | <member name="M:Newtonsoft.Json.JsonTextWriter.WriteIndentSpace"> | ||
4434 | <summary> | ||
4435 | Writes an indent space. | ||
4436 | </summary> | ||
4437 | </member> | ||
4438 | <member name="M:Newtonsoft.Json.JsonTextWriter.WriteValue(System.Object)"> | ||
4439 | <summary> | ||
4440 | Writes a <see cref="T:System.Object"/> value. | ||
4441 | An error will raised if the value cannot be written as a single JSON token. | ||
4442 | </summary> | ||
4443 | <param name="value">The <see cref="T:System.Object"/> value to write.</param> | ||
4444 | </member> | ||
4445 | <member name="M:Newtonsoft.Json.JsonTextWriter.WriteNull"> | ||
4446 | <summary> | ||
4447 | Writes a null value. | ||
4448 | </summary> | ||
4449 | </member> | ||
4450 | <member name="M:Newtonsoft.Json.JsonTextWriter.WriteUndefined"> | ||
4451 | <summary> | ||
4452 | Writes an undefined value. | ||
4453 | </summary> | ||
4454 | </member> | ||
4455 | <member name="M:Newtonsoft.Json.JsonTextWriter.WriteRaw(System.String)"> | ||
4456 | <summary> | ||
4457 | Writes raw JSON. | ||
4458 | </summary> | ||
4459 | <param name="json">The raw JSON to write.</param> | ||
4460 | </member> | ||
4461 | <member name="M:Newtonsoft.Json.JsonTextWriter.WriteValue(System.String)"> | ||
4462 | <summary> | ||
4463 | Writes a <see cref="T:System.String"/> value. | ||
4464 | </summary> | ||
4465 | <param name="value">The <see cref="T:System.String"/> value to write.</param> | ||
4466 | </member> | ||
4467 | <member name="M:Newtonsoft.Json.JsonTextWriter.WriteValue(System.Int32)"> | ||
4468 | <summary> | ||
4469 | Writes a <see cref="T:System.Int32"/> value. | ||
4470 | </summary> | ||
4471 | <param name="value">The <see cref="T:System.Int32"/> value to write.</param> | ||
4472 | </member> | ||
4473 | <member name="M:Newtonsoft.Json.JsonTextWriter.WriteValue(System.UInt32)"> | ||
4474 | <summary> | ||
4475 | Writes a <see cref="T:System.UInt32"/> value. | ||
4476 | </summary> | ||
4477 | <param name="value">The <see cref="T:System.UInt32"/> value to write.</param> | ||
4478 | </member> | ||
4479 | <member name="M:Newtonsoft.Json.JsonTextWriter.WriteValue(System.Int64)"> | ||
4480 | <summary> | ||
4481 | Writes a <see cref="T:System.Int64"/> value. | ||
4482 | </summary> | ||
4483 | <param name="value">The <see cref="T:System.Int64"/> value to write.</param> | ||
4484 | </member> | ||
4485 | <member name="M:Newtonsoft.Json.JsonTextWriter.WriteValue(System.UInt64)"> | ||
4486 | <summary> | ||
4487 | Writes a <see cref="T:System.UInt64"/> value. | ||
4488 | </summary> | ||
4489 | <param name="value">The <see cref="T:System.UInt64"/> value to write.</param> | ||
4490 | </member> | ||
4491 | <member name="M:Newtonsoft.Json.JsonTextWriter.WriteValue(System.Single)"> | ||
4492 | <summary> | ||
4493 | Writes a <see cref="T:System.Single"/> value. | ||
4494 | </summary> | ||
4495 | <param name="value">The <see cref="T:System.Single"/> value to write.</param> | ||
4496 | </member> | ||
4497 | <member name="M:Newtonsoft.Json.JsonTextWriter.WriteValue(System.Nullable{System.Single})"> | ||
4498 | <summary> | ||
4499 | Writes a <see cref="T:System.Nullable`1"/> value. | ||
4500 | </summary> | ||
4501 | <param name="value">The <see cref="T:System.Nullable`1"/> value to write.</param> | ||
4502 | </member> | ||
4503 | <member name="M:Newtonsoft.Json.JsonTextWriter.WriteValue(System.Double)"> | ||
4504 | <summary> | ||
4505 | Writes a <see cref="T:System.Double"/> value. | ||
4506 | </summary> | ||
4507 | <param name="value">The <see cref="T:System.Double"/> value to write.</param> | ||
4508 | </member> | ||
4509 | <member name="M:Newtonsoft.Json.JsonTextWriter.WriteValue(System.Nullable{System.Double})"> | ||
4510 | <summary> | ||
4511 | Writes a <see cref="T:System.Nullable`1"/> value. | ||
4512 | </summary> | ||
4513 | <param name="value">The <see cref="T:System.Nullable`1"/> value to write.</param> | ||
4514 | </member> | ||
4515 | <member name="M:Newtonsoft.Json.JsonTextWriter.WriteValue(System.Boolean)"> | ||
4516 | <summary> | ||
4517 | Writes a <see cref="T:System.Boolean"/> value. | ||
4518 | </summary> | ||
4519 | <param name="value">The <see cref="T:System.Boolean"/> value to write.</param> | ||
4520 | </member> | ||
4521 | <member name="M:Newtonsoft.Json.JsonTextWriter.WriteValue(System.Int16)"> | ||
4522 | <summary> | ||
4523 | Writes a <see cref="T:System.Int16"/> value. | ||
4524 | </summary> | ||
4525 | <param name="value">The <see cref="T:System.Int16"/> value to write.</param> | ||
4526 | </member> | ||
4527 | <member name="M:Newtonsoft.Json.JsonTextWriter.WriteValue(System.UInt16)"> | ||
4528 | <summary> | ||
4529 | Writes a <see cref="T:System.UInt16"/> value. | ||
4530 | </summary> | ||
4531 | <param name="value">The <see cref="T:System.UInt16"/> value to write.</param> | ||
4532 | </member> | ||
4533 | <member name="M:Newtonsoft.Json.JsonTextWriter.WriteValue(System.Char)"> | ||
4534 | <summary> | ||
4535 | Writes a <see cref="T:System.Char"/> value. | ||
4536 | </summary> | ||
4537 | <param name="value">The <see cref="T:System.Char"/> value to write.</param> | ||
4538 | </member> | ||
4539 | <member name="M:Newtonsoft.Json.JsonTextWriter.WriteValue(System.Byte)"> | ||
4540 | <summary> | ||
4541 | Writes a <see cref="T:System.Byte"/> value. | ||
4542 | </summary> | ||
4543 | <param name="value">The <see cref="T:System.Byte"/> value to write.</param> | ||
4544 | </member> | ||
4545 | <member name="M:Newtonsoft.Json.JsonTextWriter.WriteValue(System.SByte)"> | ||
4546 | <summary> | ||
4547 | Writes a <see cref="T:System.SByte"/> value. | ||
4548 | </summary> | ||
4549 | <param name="value">The <see cref="T:System.SByte"/> value to write.</param> | ||
4550 | </member> | ||
4551 | <member name="M:Newtonsoft.Json.JsonTextWriter.WriteValue(System.Decimal)"> | ||
4552 | <summary> | ||
4553 | Writes a <see cref="T:System.Decimal"/> value. | ||
4554 | </summary> | ||
4555 | <param name="value">The <see cref="T:System.Decimal"/> value to write.</param> | ||
4556 | </member> | ||
4557 | <member name="M:Newtonsoft.Json.JsonTextWriter.WriteValue(System.DateTime)"> | ||
4558 | <summary> | ||
4559 | Writes a <see cref="T:System.DateTime"/> value. | ||
4560 | </summary> | ||
4561 | <param name="value">The <see cref="T:System.DateTime"/> value to write.</param> | ||
4562 | </member> | ||
4563 | <member name="M:Newtonsoft.Json.JsonTextWriter.WriteValue(System.Byte[])"> | ||
4564 | <summary> | ||
4565 | Writes a <see cref="T:Byte[]"/> value. | ||
4566 | </summary> | ||
4567 | <param name="value">The <see cref="T:Byte[]"/> value to write.</param> | ||
4568 | </member> | ||
4569 | <member name="M:Newtonsoft.Json.JsonTextWriter.WriteValue(System.DateTimeOffset)"> | ||
4570 | <summary> | ||
4571 | Writes a <see cref="T:System.DateTimeOffset"/> value. | ||
4572 | </summary> | ||
4573 | <param name="value">The <see cref="T:System.DateTimeOffset"/> value to write.</param> | ||
4574 | </member> | ||
4575 | <member name="M:Newtonsoft.Json.JsonTextWriter.WriteValue(System.Guid)"> | ||
4576 | <summary> | ||
4577 | Writes a <see cref="T:System.Guid"/> value. | ||
4578 | </summary> | ||
4579 | <param name="value">The <see cref="T:System.Guid"/> value to write.</param> | ||
4580 | </member> | ||
4581 | <member name="M:Newtonsoft.Json.JsonTextWriter.WriteValue(System.TimeSpan)"> | ||
4582 | <summary> | ||
4583 | Writes a <see cref="T:System.TimeSpan"/> value. | ||
4584 | </summary> | ||
4585 | <param name="value">The <see cref="T:System.TimeSpan"/> value to write.</param> | ||
4586 | </member> | ||
4587 | <member name="M:Newtonsoft.Json.JsonTextWriter.WriteValue(System.Uri)"> | ||
4588 | <summary> | ||
4589 | Writes a <see cref="T:System.Uri"/> value. | ||
4590 | </summary> | ||
4591 | <param name="value">The <see cref="T:System.Uri"/> value to write.</param> | ||
4592 | </member> | ||
4593 | <member name="M:Newtonsoft.Json.JsonTextWriter.WriteComment(System.String)"> | ||
4594 | <summary> | ||
4595 | Writes out a comment <code>/*...*/</code> containing the specified text. | ||
4596 | </summary> | ||
4597 | <param name="text">Text to place inside the comment.</param> | ||
4598 | </member> | ||
4599 | <member name="M:Newtonsoft.Json.JsonTextWriter.WriteWhitespace(System.String)"> | ||
4600 | <summary> | ||
4601 | Writes out the given white space. | ||
4602 | </summary> | ||
4603 | <param name="ws">The string of white space characters.</param> | ||
4604 | </member> | ||
4605 | <member name="P:Newtonsoft.Json.JsonTextWriter.Indentation"> | ||
4606 | <summary> | ||
4607 | Gets or sets how many IndentChars to write for each level in the hierarchy when <see cref="T:Newtonsoft.Json.Formatting"/> is set to <c>Formatting.Indented</c>. | ||
4608 | </summary> | ||
4609 | </member> | ||
4610 | <member name="P:Newtonsoft.Json.JsonTextWriter.QuoteChar"> | ||
4611 | <summary> | ||
4612 | Gets or sets which character to use to quote attribute values. | ||
4613 | </summary> | ||
4614 | </member> | ||
4615 | <member name="P:Newtonsoft.Json.JsonTextWriter.IndentChar"> | ||
4616 | <summary> | ||
4617 | Gets or sets which character to use for indenting when <see cref="T:Newtonsoft.Json.Formatting"/> is set to <c>Formatting.Indented</c>. | ||
4618 | </summary> | ||
4619 | </member> | ||
4620 | <member name="P:Newtonsoft.Json.JsonTextWriter.QuoteName"> | ||
4621 | <summary> | ||
4622 | Gets or sets a value indicating whether object names will be surrounded with quotes. | ||
4623 | </summary> | ||
4624 | </member> | ||
4625 | <member name="T:Newtonsoft.Json.JsonWriterException"> | ||
4626 | <summary> | ||
4627 | The exception thrown when an error occurs while reading Json text. | ||
4628 | </summary> | ||
4629 | </member> | ||
4630 | <member name="M:Newtonsoft.Json.JsonWriterException.#ctor"> | ||
4631 | <summary> | ||
4632 | Initializes a new instance of the <see cref="T:Newtonsoft.Json.JsonWriterException"/> class. | ||
4633 | </summary> | ||
4634 | </member> | ||
4635 | <member name="M:Newtonsoft.Json.JsonWriterException.#ctor(System.String)"> | ||
4636 | <summary> | ||
4637 | Initializes a new instance of the <see cref="T:Newtonsoft.Json.JsonWriterException"/> class | ||
4638 | with a specified error message. | ||
4639 | </summary> | ||
4640 | <param name="message">The error message that explains the reason for the exception.</param> | ||
4641 | </member> | ||
4642 | <member name="M:Newtonsoft.Json.JsonWriterException.#ctor(System.String,System.Exception)"> | ||
4643 | <summary> | ||
4644 | Initializes a new instance of the <see cref="T:Newtonsoft.Json.JsonWriterException"/> class | ||
4645 | with a specified error message and a reference to the inner exception that is the cause of this exception. | ||
4646 | </summary> | ||
4647 | <param name="message">The error message that explains the reason for the exception.</param> | ||
4648 | <param name="innerException">The exception that is the cause of the current exception, or a null reference (Nothing in Visual Basic) if no inner exception is specified.</param> | ||
4649 | </member> | ||
4650 | <member name="M:Newtonsoft.Json.JsonWriterException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> | ||
4651 | <summary> | ||
4652 | Initializes a new instance of the <see cref="T:Newtonsoft.Json.JsonWriterException"/> class. | ||
4653 | </summary> | ||
4654 | <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param> | ||
4655 | <param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param> | ||
4656 | <exception cref="T:System.ArgumentNullException">The <paramref name="info"/> parameter is null. </exception> | ||
4657 | <exception cref="T:System.Runtime.Serialization.SerializationException">The class name is null or <see cref="P:System.Exception.HResult"/> is zero (0). </exception> | ||
4658 | </member> | ||
4659 | <member name="P:Newtonsoft.Json.JsonWriterException.Path"> | ||
4660 | <summary> | ||
4661 | Gets the path to the JSON where the error occurred. | ||
4662 | </summary> | ||
4663 | <value>The path to the JSON where the error occurred.</value> | ||
4664 | </member> | ||
4665 | <member name="T:Newtonsoft.Json.JsonReaderException"> | ||
4666 | <summary> | ||
4667 | The exception thrown when an error occurs while reading Json text. | ||
4668 | </summary> | ||
4669 | </member> | ||
4670 | <member name="M:Newtonsoft.Json.JsonReaderException.#ctor"> | ||
4671 | <summary> | ||
4672 | Initializes a new instance of the <see cref="T:Newtonsoft.Json.JsonReaderException"/> class. | ||
4673 | </summary> | ||
4674 | </member> | ||
4675 | <member name="M:Newtonsoft.Json.JsonReaderException.#ctor(System.String)"> | ||
4676 | <summary> | ||
4677 | Initializes a new instance of the <see cref="T:Newtonsoft.Json.JsonReaderException"/> class | ||
4678 | with a specified error message. | ||
4679 | </summary> | ||
4680 | <param name="message">The error message that explains the reason for the exception.</param> | ||
4681 | </member> | ||
4682 | <member name="M:Newtonsoft.Json.JsonReaderException.#ctor(System.String,System.Exception)"> | ||
4683 | <summary> | ||
4684 | Initializes a new instance of the <see cref="T:Newtonsoft.Json.JsonReaderException"/> class | ||
4685 | with a specified error message and a reference to the inner exception that is the cause of this exception. | ||
4686 | </summary> | ||
4687 | <param name="message">The error message that explains the reason for the exception.</param> | ||
4688 | <param name="innerException">The exception that is the cause of the current exception, or a null reference (Nothing in Visual Basic) if no inner exception is specified.</param> | ||
4689 | </member> | ||
4690 | <member name="M:Newtonsoft.Json.JsonReaderException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> | ||
4691 | <summary> | ||
4692 | Initializes a new instance of the <see cref="T:Newtonsoft.Json.JsonReaderException"/> class. | ||
4693 | </summary> | ||
4694 | <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param> | ||
4695 | <param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param> | ||
4696 | <exception cref="T:System.ArgumentNullException">The <paramref name="info"/> parameter is null. </exception> | ||
4697 | <exception cref="T:System.Runtime.Serialization.SerializationException">The class name is null or <see cref="P:System.Exception.HResult"/> is zero (0). </exception> | ||
4698 | </member> | ||
4699 | <member name="P:Newtonsoft.Json.JsonReaderException.LineNumber"> | ||
4700 | <summary> | ||
4701 | Gets the line number indicating where the error occurred. | ||
4702 | </summary> | ||
4703 | <value>The line number indicating where the error occurred.</value> | ||
4704 | </member> | ||
4705 | <member name="P:Newtonsoft.Json.JsonReaderException.LinePosition"> | ||
4706 | <summary> | ||
4707 | Gets the line position indicating where the error occurred. | ||
4708 | </summary> | ||
4709 | <value>The line position indicating where the error occurred.</value> | ||
4710 | </member> | ||
4711 | <member name="P:Newtonsoft.Json.JsonReaderException.Path"> | ||
4712 | <summary> | ||
4713 | Gets the path to the JSON where the error occurred. | ||
4714 | </summary> | ||
4715 | <value>The path to the JSON where the error occurred.</value> | ||
4716 | </member> | ||
4717 | <member name="T:Newtonsoft.Json.JsonConverterCollection"> | ||
4718 | <summary> | ||
4719 | Represents a collection of <see cref="T:Newtonsoft.Json.JsonConverter"/>. | ||
4720 | </summary> | ||
4721 | </member> | ||
4722 | <member name="T:Newtonsoft.Json.JsonConvert"> | ||
4723 | <summary> | ||
4724 | Provides methods for converting between common language runtime types and JSON types. | ||
4725 | </summary> | ||
4726 | <example> | ||
4727 | <code lang="cs" source="..\Src\Newtonsoft.Json.Tests\Documentation\SerializationTests.cs" region="SerializeObject" title="Serializing and Deserializing JSON with JsonConvert" /> | ||
4728 | </example> | ||
4729 | </member> | ||
4730 | <member name="F:Newtonsoft.Json.JsonConvert.True"> | ||
4731 | <summary> | ||
4732 | Represents JavaScript's boolean value true as a string. This field is read-only. | ||
4733 | </summary> | ||
4734 | </member> | ||
4735 | <member name="F:Newtonsoft.Json.JsonConvert.False"> | ||
4736 | <summary> | ||
4737 | Represents JavaScript's boolean value false as a string. This field is read-only. | ||
4738 | </summary> | ||
4739 | </member> | ||
4740 | <member name="F:Newtonsoft.Json.JsonConvert.Null"> | ||
4741 | <summary> | ||
4742 | Represents JavaScript's null as a string. This field is read-only. | ||
4743 | </summary> | ||
4744 | </member> | ||
4745 | <member name="F:Newtonsoft.Json.JsonConvert.Undefined"> | ||
4746 | <summary> | ||
4747 | Represents JavaScript's undefined as a string. This field is read-only. | ||
4748 | </summary> | ||
4749 | </member> | ||
4750 | <member name="F:Newtonsoft.Json.JsonConvert.PositiveInfinity"> | ||
4751 | <summary> | ||
4752 | Represents JavaScript's positive infinity as a string. This field is read-only. | ||
4753 | </summary> | ||
4754 | </member> | ||
4755 | <member name="F:Newtonsoft.Json.JsonConvert.NegativeInfinity"> | ||
4756 | <summary> | ||
4757 | Represents JavaScript's negative infinity as a string. This field is read-only. | ||
4758 | </summary> | ||
4759 | </member> | ||
4760 | <member name="F:Newtonsoft.Json.JsonConvert.NaN"> | ||
4761 | <summary> | ||
4762 | Represents JavaScript's NaN as a string. This field is read-only. | ||
4763 | </summary> | ||
4764 | </member> | ||
4765 | <member name="M:Newtonsoft.Json.JsonConvert.ToString(System.DateTime)"> | ||
4766 | <summary> | ||
4767 | Converts the <see cref="T:System.DateTime"/> to its JSON string representation. | ||
4768 | </summary> | ||
4769 | <param name="value">The value to convert.</param> | ||
4770 | <returns>A JSON string representation of the <see cref="T:System.DateTime"/>.</returns> | ||
4771 | </member> | ||
4772 | <member name="M:Newtonsoft.Json.JsonConvert.ToString(System.DateTime,Newtonsoft.Json.DateFormatHandling,Newtonsoft.Json.DateTimeZoneHandling)"> | ||
4773 | <summary> | ||
4774 | Converts the <see cref="T:System.DateTime"/> to its JSON string representation using the <see cref="T:Newtonsoft.Json.DateFormatHandling"/> specified. | ||
4775 | </summary> | ||
4776 | <param name="value">The value to convert.</param> | ||
4777 | <param name="format">The format the date will be converted to.</param> | ||
4778 | <param name="timeZoneHandling">The time zone handling when the date is converted to a string.</param> | ||
4779 | <returns>A JSON string representation of the <see cref="T:System.DateTime"/>.</returns> | ||
4780 | </member> | ||
4781 | <member name="M:Newtonsoft.Json.JsonConvert.ToString(System.DateTimeOffset)"> | ||
4782 | <summary> | ||
4783 | Converts the <see cref="T:System.DateTimeOffset"/> to its JSON string representation. | ||
4784 | </summary> | ||
4785 | <param name="value">The value to convert.</param> | ||
4786 | <returns>A JSON string representation of the <see cref="T:System.DateTimeOffset"/>.</returns> | ||
4787 | </member> | ||
4788 | <member name="M:Newtonsoft.Json.JsonConvert.ToString(System.DateTimeOffset,Newtonsoft.Json.DateFormatHandling)"> | ||
4789 | <summary> | ||
4790 | Converts the <see cref="T:System.DateTimeOffset"/> to its JSON string representation using the <see cref="T:Newtonsoft.Json.DateFormatHandling"/> specified. | ||
4791 | </summary> | ||
4792 | <param name="value">The value to convert.</param> | ||
4793 | <param name="format">The format the date will be converted to.</param> | ||
4794 | <returns>A JSON string representation of the <see cref="T:System.DateTimeOffset"/>.</returns> | ||
4795 | </member> | ||
4796 | <member name="M:Newtonsoft.Json.JsonConvert.ToString(System.Boolean)"> | ||
4797 | <summary> | ||
4798 | Converts the <see cref="T:System.Boolean"/> to its JSON string representation. | ||
4799 | </summary> | ||
4800 | <param name="value">The value to convert.</param> | ||
4801 | <returns>A JSON string representation of the <see cref="T:System.Boolean"/>.</returns> | ||
4802 | </member> | ||
4803 | <member name="M:Newtonsoft.Json.JsonConvert.ToString(System.Char)"> | ||
4804 | <summary> | ||
4805 | Converts the <see cref="T:System.Char"/> to its JSON string representation. | ||
4806 | </summary> | ||
4807 | <param name="value">The value to convert.</param> | ||
4808 | <returns>A JSON string representation of the <see cref="T:System.Char"/>.</returns> | ||
4809 | </member> | ||
4810 | <member name="M:Newtonsoft.Json.JsonConvert.ToString(System.Enum)"> | ||
4811 | <summary> | ||
4812 | Converts the <see cref="T:System.Enum"/> to its JSON string representation. | ||
4813 | </summary> | ||
4814 | <param name="value">The value to convert.</param> | ||
4815 | <returns>A JSON string representation of the <see cref="T:System.Enum"/>.</returns> | ||
4816 | </member> | ||
4817 | <member name="M:Newtonsoft.Json.JsonConvert.ToString(System.Int32)"> | ||
4818 | <summary> | ||
4819 | Converts the <see cref="T:System.Int32"/> to its JSON string representation. | ||
4820 | </summary> | ||
4821 | <param name="value">The value to convert.</param> | ||
4822 | <returns>A JSON string representation of the <see cref="T:System.Int32"/>.</returns> | ||
4823 | </member> | ||
4824 | <member name="M:Newtonsoft.Json.JsonConvert.ToString(System.Int16)"> | ||
4825 | <summary> | ||
4826 | Converts the <see cref="T:System.Int16"/> to its JSON string representation. | ||
4827 | </summary> | ||
4828 | <param name="value">The value to convert.</param> | ||
4829 | <returns>A JSON string representation of the <see cref="T:System.Int16"/>.</returns> | ||
4830 | </member> | ||
4831 | <member name="M:Newtonsoft.Json.JsonConvert.ToString(System.UInt16)"> | ||
4832 | <summary> | ||
4833 | Converts the <see cref="T:System.UInt16"/> to its JSON string representation. | ||
4834 | </summary> | ||
4835 | <param name="value">The value to convert.</param> | ||
4836 | <returns>A JSON string representation of the <see cref="T:System.UInt16"/>.</returns> | ||
4837 | </member> | ||
4838 | <member name="M:Newtonsoft.Json.JsonConvert.ToString(System.UInt32)"> | ||
4839 | <summary> | ||
4840 | Converts the <see cref="T:System.UInt32"/> to its JSON string representation. | ||
4841 | </summary> | ||
4842 | <param name="value">The value to convert.</param> | ||
4843 | <returns>A JSON string representation of the <see cref="T:System.UInt32"/>.</returns> | ||
4844 | </member> | ||
4845 | <member name="M:Newtonsoft.Json.JsonConvert.ToString(System.Int64)"> | ||
4846 | <summary> | ||
4847 | Converts the <see cref="T:System.Int64"/> to its JSON string representation. | ||
4848 | </summary> | ||
4849 | <param name="value">The value to convert.</param> | ||
4850 | <returns>A JSON string representation of the <see cref="T:System.Int64"/>.</returns> | ||
4851 | </member> | ||
4852 | <member name="M:Newtonsoft.Json.JsonConvert.ToString(System.UInt64)"> | ||
4853 | <summary> | ||
4854 | Converts the <see cref="T:System.UInt64"/> to its JSON string representation. | ||
4855 | </summary> | ||
4856 | <param name="value">The value to convert.</param> | ||
4857 | <returns>A JSON string representation of the <see cref="T:System.UInt64"/>.</returns> | ||
4858 | </member> | ||
4859 | <member name="M:Newtonsoft.Json.JsonConvert.ToString(System.Single)"> | ||
4860 | <summary> | ||
4861 | Converts the <see cref="T:System.Single"/> to its JSON string representation. | ||
4862 | </summary> | ||
4863 | <param name="value">The value to convert.</param> | ||
4864 | <returns>A JSON string representation of the <see cref="T:System.Single"/>.</returns> | ||
4865 | </member> | ||
4866 | <member name="M:Newtonsoft.Json.JsonConvert.ToString(System.Double)"> | ||
4867 | <summary> | ||
4868 | Converts the <see cref="T:System.Double"/> to its JSON string representation. | ||
4869 | </summary> | ||
4870 | <param name="value">The value to convert.</param> | ||
4871 | <returns>A JSON string representation of the <see cref="T:System.Double"/>.</returns> | ||
4872 | </member> | ||
4873 | <member name="M:Newtonsoft.Json.JsonConvert.ToString(System.Byte)"> | ||
4874 | <summary> | ||
4875 | Converts the <see cref="T:System.Byte"/> to its JSON string representation. | ||
4876 | </summary> | ||
4877 | <param name="value">The value to convert.</param> | ||
4878 | <returns>A JSON string representation of the <see cref="T:System.Byte"/>.</returns> | ||
4879 | </member> | ||
4880 | <member name="M:Newtonsoft.Json.JsonConvert.ToString(System.SByte)"> | ||
4881 | <summary> | ||
4882 | Converts the <see cref="T:System.SByte"/> to its JSON string representation. | ||
4883 | </summary> | ||
4884 | <param name="value">The value to convert.</param> | ||
4885 | <returns>A JSON string representation of the <see cref="T:System.SByte"/>.</returns> | ||
4886 | </member> | ||
4887 | <member name="M:Newtonsoft.Json.JsonConvert.ToString(System.Decimal)"> | ||
4888 | <summary> | ||
4889 | Converts the <see cref="T:System.Decimal"/> to its JSON string representation. | ||
4890 | </summary> | ||
4891 | <param name="value">The value to convert.</param> | ||
4892 | <returns>A JSON string representation of the <see cref="T:System.SByte"/>.</returns> | ||
4893 | </member> | ||
4894 | <member name="M:Newtonsoft.Json.JsonConvert.ToString(System.Guid)"> | ||
4895 | <summary> | ||
4896 | Converts the <see cref="T:System.Guid"/> to its JSON string representation. | ||
4897 | </summary> | ||
4898 | <param name="value">The value to convert.</param> | ||
4899 | <returns>A JSON string representation of the <see cref="T:System.Guid"/>.</returns> | ||
4900 | </member> | ||
4901 | <member name="M:Newtonsoft.Json.JsonConvert.ToString(System.TimeSpan)"> | ||
4902 | <summary> | ||
4903 | Converts the <see cref="T:System.TimeSpan"/> to its JSON string representation. | ||
4904 | </summary> | ||
4905 | <param name="value">The value to convert.</param> | ||
4906 | <returns>A JSON string representation of the <see cref="T:System.TimeSpan"/>.</returns> | ||
4907 | </member> | ||
4908 | <member name="M:Newtonsoft.Json.JsonConvert.ToString(System.Uri)"> | ||
4909 | <summary> | ||
4910 | Converts the <see cref="T:System.Uri"/> to its JSON string representation. | ||
4911 | </summary> | ||
4912 | <param name="value">The value to convert.</param> | ||
4913 | <returns>A JSON string representation of the <see cref="T:System.Uri"/>.</returns> | ||
4914 | </member> | ||
4915 | <member name="M:Newtonsoft.Json.JsonConvert.ToString(System.String)"> | ||
4916 | <summary> | ||
4917 | Converts the <see cref="T:System.String"/> to its JSON string representation. | ||
4918 | </summary> | ||
4919 | <param name="value">The value to convert.</param> | ||
4920 | <returns>A JSON string representation of the <see cref="T:System.String"/>.</returns> | ||
4921 | </member> | ||
4922 | <member name="M:Newtonsoft.Json.JsonConvert.ToString(System.String,System.Char)"> | ||
4923 | <summary> | ||
4924 | Converts the <see cref="T:System.String"/> to its JSON string representation. | ||
4925 | </summary> | ||
4926 | <param name="value">The value to convert.</param> | ||
4927 | <param name="delimiter">The string delimiter character.</param> | ||
4928 | <returns>A JSON string representation of the <see cref="T:System.String"/>.</returns> | ||
4929 | </member> | ||
4930 | <member name="M:Newtonsoft.Json.JsonConvert.ToString(System.String,System.Char,Newtonsoft.Json.StringEscapeHandling)"> | ||
4931 | <summary> | ||
4932 | Converts the <see cref="T:System.String"/> to its JSON string representation. | ||
4933 | </summary> | ||
4934 | <param name="value">The value to convert.</param> | ||
4935 | <param name="delimiter">The string delimiter character.</param> | ||
4936 | <param name="stringEscapeHandling">The string escape handling.</param> | ||
4937 | <returns>A JSON string representation of the <see cref="T:System.String"/>.</returns> | ||
4938 | </member> | ||
4939 | <member name="M:Newtonsoft.Json.JsonConvert.ToString(System.Object)"> | ||
4940 | <summary> | ||
4941 | Converts the <see cref="T:System.Object"/> to its JSON string representation. | ||
4942 | </summary> | ||
4943 | <param name="value">The value to convert.</param> | ||
4944 | <returns>A JSON string representation of the <see cref="T:System.Object"/>.</returns> | ||
4945 | </member> | ||
4946 | <member name="M:Newtonsoft.Json.JsonConvert.SerializeObject(System.Object)"> | ||
4947 | <summary> | ||
4948 | Serializes the specified object to a JSON string. | ||
4949 | </summary> | ||
4950 | <param name="value">The object to serialize.</param> | ||
4951 | <returns>A JSON string representation of the object.</returns> | ||
4952 | </member> | ||
4953 | <member name="M:Newtonsoft.Json.JsonConvert.SerializeObject(System.Object,Newtonsoft.Json.Formatting)"> | ||
4954 | <summary> | ||
4955 | Serializes the specified object to a JSON string using formatting. | ||
4956 | </summary> | ||
4957 | <param name="value">The object to serialize.</param> | ||
4958 | <param name="formatting">Indicates how the output is formatted.</param> | ||
4959 | <returns> | ||
4960 | A JSON string representation of the object. | ||
4961 | </returns> | ||
4962 | </member> | ||
4963 | <member name="M:Newtonsoft.Json.JsonConvert.SerializeObject(System.Object,Newtonsoft.Json.JsonConverter[])"> | ||
4964 | <summary> | ||
4965 | Serializes the specified object to a JSON string using a collection of <see cref="T:Newtonsoft.Json.JsonConverter"/>. | ||
4966 | </summary> | ||
4967 | <param name="value">The object to serialize.</param> | ||
4968 | <param name="converters">A collection converters used while serializing.</param> | ||
4969 | <returns>A JSON string representation of the object.</returns> | ||
4970 | </member> | ||
4971 | <member name="M:Newtonsoft.Json.JsonConvert.SerializeObject(System.Object,Newtonsoft.Json.Formatting,Newtonsoft.Json.JsonConverter[])"> | ||
4972 | <summary> | ||
4973 | Serializes the specified object to a JSON string using formatting and a collection of <see cref="T:Newtonsoft.Json.JsonConverter"/>. | ||
4974 | </summary> | ||
4975 | <param name="value">The object to serialize.</param> | ||
4976 | <param name="formatting">Indicates how the output is formatted.</param> | ||
4977 | <param name="converters">A collection converters used while serializing.</param> | ||
4978 | <returns>A JSON string representation of the object.</returns> | ||
4979 | </member> | ||
4980 | <member name="M:Newtonsoft.Json.JsonConvert.SerializeObject(System.Object,Newtonsoft.Json.JsonSerializerSettings)"> | ||
4981 | <summary> | ||
4982 | Serializes the specified object to a JSON string using <see cref="T:Newtonsoft.Json.JsonSerializerSettings"/>. | ||
4983 | </summary> | ||
4984 | <param name="value">The object to serialize.</param> | ||
4985 | <param name="settings">The <see cref="T:Newtonsoft.Json.JsonSerializerSettings"/> used to serialize the object. | ||
4986 | If this is null, default serialization settings will be used.</param> | ||
4987 | <returns> | ||
4988 | A JSON string representation of the object. | ||
4989 | </returns> | ||
4990 | </member> | ||
4991 | <member name="M:Newtonsoft.Json.JsonConvert.SerializeObject(System.Object,System.Type,Newtonsoft.Json.JsonSerializerSettings)"> | ||
4992 | <summary> | ||
4993 | Serializes the specified object to a JSON string using a type, formatting and <see cref="T:Newtonsoft.Json.JsonSerializerSettings"/>. | ||
4994 | </summary> | ||
4995 | <param name="value">The object to serialize.</param> | ||
4996 | <param name="settings">The <see cref="T:Newtonsoft.Json.JsonSerializerSettings"/> used to serialize the object. | ||
4997 | If this is null, default serialization settings will be used.</param> | ||
4998 | <param name="type"> | ||
4999 | The type of the value being serialized. | ||
5000 | This parameter is used when <see cref="T:Newtonsoft.Json.TypeNameHandling"/> is Auto to write out the type name if the type of the value does not match. | ||
5001 | Specifing the type is optional. | ||
5002 | </param> | ||
5003 | <returns> | ||
5004 | A JSON string representation of the object. | ||
5005 | </returns> | ||
5006 | </member> | ||
5007 | <member name="M:Newtonsoft.Json.JsonConvert.SerializeObject(System.Object,Newtonsoft.Json.Formatting,Newtonsoft.Json.JsonSerializerSettings)"> | ||
5008 | <summary> | ||
5009 | Serializes the specified object to a JSON string using formatting and <see cref="T:Newtonsoft.Json.JsonSerializerSettings"/>. | ||
5010 | </summary> | ||
5011 | <param name="value">The object to serialize.</param> | ||
5012 | <param name="formatting">Indicates how the output is formatted.</param> | ||
5013 | <param name="settings">The <see cref="T:Newtonsoft.Json.JsonSerializerSettings"/> used to serialize the object. | ||
5014 | If this is null, default serialization settings will be used.</param> | ||
5015 | <returns> | ||
5016 | A JSON string representation of the object. | ||
5017 | </returns> | ||
5018 | </member> | ||
5019 | <member name="M:Newtonsoft.Json.JsonConvert.SerializeObject(System.Object,System.Type,Newtonsoft.Json.Formatting,Newtonsoft.Json.JsonSerializerSettings)"> | ||
5020 | <summary> | ||
5021 | Serializes the specified object to a JSON string using a type, formatting and <see cref="T:Newtonsoft.Json.JsonSerializerSettings"/>. | ||
5022 | </summary> | ||
5023 | <param name="value">The object to serialize.</param> | ||
5024 | <param name="formatting">Indicates how the output is formatted.</param> | ||
5025 | <param name="settings">The <see cref="T:Newtonsoft.Json.JsonSerializerSettings"/> used to serialize the object. | ||
5026 | If this is null, default serialization settings will be used.</param> | ||
5027 | <param name="type"> | ||
5028 | The type of the value being serialized. | ||
5029 | This parameter is used when <see cref="T:Newtonsoft.Json.TypeNameHandling"/> is Auto to write out the type name if the type of the value does not match. | ||
5030 | Specifing the type is optional. | ||
5031 | </param> | ||
5032 | <returns> | ||
5033 | A JSON string representation of the object. | ||
5034 | </returns> | ||
5035 | </member> | ||
5036 | <member name="M:Newtonsoft.Json.JsonConvert.SerializeObjectAsync(System.Object)"> | ||
5037 | <summary> | ||
5038 | Asynchronously serializes the specified object to a JSON string. | ||
5039 | Serialization will happen on a new thread. | ||
5040 | </summary> | ||
5041 | <param name="value">The object to serialize.</param> | ||
5042 | <returns> | ||
5043 | A task that represents the asynchronous serialize operation. The value of the <c>TResult</c> parameter contains a JSON string representation of the object. | ||
5044 | </returns> | ||
5045 | </member> | ||
5046 | <member name="M:Newtonsoft.Json.JsonConvert.SerializeObjectAsync(System.Object,Newtonsoft.Json.Formatting)"> | ||
5047 | <summary> | ||
5048 | Asynchronously serializes the specified object to a JSON string using formatting. | ||
5049 | Serialization will happen on a new thread. | ||
5050 | </summary> | ||
5051 | <param name="value">The object to serialize.</param> | ||
5052 | <param name="formatting">Indicates how the output is formatted.</param> | ||
5053 | <returns> | ||
5054 | A task that represents the asynchronous serialize operation. The value of the <c>TResult</c> parameter contains a JSON string representation of the object. | ||
5055 | </returns> | ||
5056 | </member> | ||
5057 | <member name="M:Newtonsoft.Json.JsonConvert.SerializeObjectAsync(System.Object,Newtonsoft.Json.Formatting,Newtonsoft.Json.JsonSerializerSettings)"> | ||
5058 | <summary> | ||
5059 | Asynchronously serializes the specified object to a JSON string using formatting and a collection of <see cref="T:Newtonsoft.Json.JsonConverter"/>. | ||
5060 | Serialization will happen on a new thread. | ||
5061 | </summary> | ||
5062 | <param name="value">The object to serialize.</param> | ||
5063 | <param name="formatting">Indicates how the output is formatted.</param> | ||
5064 | <param name="settings">The <see cref="T:Newtonsoft.Json.JsonSerializerSettings"/> used to serialize the object. | ||
5065 | If this is null, default serialization settings will be used.</param> | ||
5066 | <returns> | ||
5067 | A task that represents the asynchronous serialize operation. The value of the <c>TResult</c> parameter contains a JSON string representation of the object. | ||
5068 | </returns> | ||
5069 | </member> | ||
5070 | <member name="M:Newtonsoft.Json.JsonConvert.DeserializeObject(System.String)"> | ||
5071 | <summary> | ||
5072 | Deserializes the JSON to a .NET object. | ||
5073 | </summary> | ||
5074 | <param name="value">The JSON to deserialize.</param> | ||
5075 | <returns>The deserialized object from the JSON string.</returns> | ||
5076 | </member> | ||
5077 | <member name="M:Newtonsoft.Json.JsonConvert.DeserializeObject(System.String,Newtonsoft.Json.JsonSerializerSettings)"> | ||
5078 | <summary> | ||
5079 | Deserializes the JSON to a .NET object using <see cref="T:Newtonsoft.Json.JsonSerializerSettings"/>. | ||
5080 | </summary> | ||
5081 | <param name="value">The JSON to deserialize.</param> | ||
5082 | <param name="settings"> | ||
5083 | The <see cref="T:Newtonsoft.Json.JsonSerializerSettings"/> used to deserialize the object. | ||
5084 | If this is null, default serialization settings will be used. | ||
5085 | </param> | ||
5086 | <returns>The deserialized object from the JSON string.</returns> | ||
5087 | </member> | ||
5088 | <member name="M:Newtonsoft.Json.JsonConvert.DeserializeObject(System.String,System.Type)"> | ||
5089 | <summary> | ||
5090 | Deserializes the JSON to the specified .NET type. | ||
5091 | </summary> | ||
5092 | <param name="value">The JSON to deserialize.</param> | ||
5093 | <param name="type">The <see cref="T:System.Type"/> of object being deserialized.</param> | ||
5094 | <returns>The deserialized object from the JSON string.</returns> | ||
5095 | </member> | ||
5096 | <member name="M:Newtonsoft.Json.JsonConvert.DeserializeObject``1(System.String)"> | ||
5097 | <summary> | ||
5098 | Deserializes the JSON to the specified .NET type. | ||
5099 | </summary> | ||
5100 | <typeparam name="T">The type of the object to deserialize to.</typeparam> | ||
5101 | <param name="value">The JSON to deserialize.</param> | ||
5102 | <returns>The deserialized object from the JSON string.</returns> | ||
5103 | </member> | ||
5104 | <member name="M:Newtonsoft.Json.JsonConvert.DeserializeAnonymousType``1(System.String,``0)"> | ||
5105 | <summary> | ||
5106 | Deserializes the JSON to the given anonymous type. | ||
5107 | </summary> | ||
5108 | <typeparam name="T"> | ||
5109 | The anonymous type to deserialize to. This can't be specified | ||
5110 | traditionally and must be infered from the anonymous type passed | ||
5111 | as a parameter. | ||
5112 | </typeparam> | ||
5113 | <param name="value">The JSON to deserialize.</param> | ||
5114 | <param name="anonymousTypeObject">The anonymous type object.</param> | ||
5115 | <returns>The deserialized anonymous type from the JSON string.</returns> | ||
5116 | </member> | ||
5117 | <member name="M:Newtonsoft.Json.JsonConvert.DeserializeAnonymousType``1(System.String,``0,Newtonsoft.Json.JsonSerializerSettings)"> | ||
5118 | <summary> | ||
5119 | Deserializes the JSON to the given anonymous type using <see cref="T:Newtonsoft.Json.JsonSerializerSettings"/>. | ||
5120 | </summary> | ||
5121 | <typeparam name="T"> | ||
5122 | The anonymous type to deserialize to. This can't be specified | ||
5123 | traditionally and must be infered from the anonymous type passed | ||
5124 | as a parameter. | ||
5125 | </typeparam> | ||
5126 | <param name="value">The JSON to deserialize.</param> | ||
5127 | <param name="anonymousTypeObject">The anonymous type object.</param> | ||
5128 | <param name="settings"> | ||
5129 | The <see cref="T:Newtonsoft.Json.JsonSerializerSettings"/> used to deserialize the object. | ||
5130 | If this is null, default serialization settings will be used. | ||
5131 | </param> | ||
5132 | <returns>The deserialized anonymous type from the JSON string.</returns> | ||
5133 | </member> | ||
5134 | <member name="M:Newtonsoft.Json.JsonConvert.DeserializeObject``1(System.String,Newtonsoft.Json.JsonConverter[])"> | ||
5135 | <summary> | ||
5136 | Deserializes the JSON to the specified .NET type using a collection of <see cref="T:Newtonsoft.Json.JsonConverter"/>. | ||
5137 | </summary> | ||
5138 | <typeparam name="T">The type of the object to deserialize to.</typeparam> | ||
5139 | <param name="value">The JSON to deserialize.</param> | ||
5140 | <param name="converters">Converters to use while deserializing.</param> | ||
5141 | <returns>The deserialized object from the JSON string.</returns> | ||
5142 | </member> | ||
5143 | <member name="M:Newtonsoft.Json.JsonConvert.DeserializeObject``1(System.String,Newtonsoft.Json.JsonSerializerSettings)"> | ||
5144 | <summary> | ||
5145 | Deserializes the JSON to the specified .NET type using <see cref="T:Newtonsoft.Json.JsonSerializerSettings"/>. | ||
5146 | </summary> | ||
5147 | <typeparam name="T">The type of the object to deserialize to.</typeparam> | ||
5148 | <param name="value">The object to deserialize.</param> | ||
5149 | <param name="settings"> | ||
5150 | The <see cref="T:Newtonsoft.Json.JsonSerializerSettings"/> used to deserialize the object. | ||
5151 | If this is null, default serialization settings will be used. | ||
5152 | </param> | ||
5153 | <returns>The deserialized object from the JSON string.</returns> | ||
5154 | </member> | ||
5155 | <member name="M:Newtonsoft.Json.JsonConvert.DeserializeObject(System.String,System.Type,Newtonsoft.Json.JsonConverter[])"> | ||
5156 | <summary> | ||
5157 | Deserializes the JSON to the specified .NET type using a collection of <see cref="T:Newtonsoft.Json.JsonConverter"/>. | ||
5158 | </summary> | ||
5159 | <param name="value">The JSON to deserialize.</param> | ||
5160 | <param name="type">The type of the object to deserialize.</param> | ||
5161 | <param name="converters">Converters to use while deserializing.</param> | ||
5162 | <returns>The deserialized object from the JSON string.</returns> | ||
5163 | </member> | ||
5164 | <member name="M:Newtonsoft.Json.JsonConvert.DeserializeObject(System.String,System.Type,Newtonsoft.Json.JsonSerializerSettings)"> | ||
5165 | <summary> | ||
5166 | Deserializes the JSON to the specified .NET type using <see cref="T:Newtonsoft.Json.JsonSerializerSettings"/>. | ||
5167 | </summary> | ||
5168 | <param name="value">The JSON to deserialize.</param> | ||
5169 | <param name="type">The type of the object to deserialize to.</param> | ||
5170 | <param name="settings"> | ||
5171 | The <see cref="T:Newtonsoft.Json.JsonSerializerSettings"/> used to deserialize the object. | ||
5172 | If this is null, default serialization settings will be used. | ||
5173 | </param> | ||
5174 | <returns>The deserialized object from the JSON string.</returns> | ||
5175 | </member> | ||
5176 | <member name="M:Newtonsoft.Json.JsonConvert.DeserializeObjectAsync``1(System.String)"> | ||
5177 | <summary> | ||
5178 | Asynchronously deserializes the JSON to the specified .NET type. | ||
5179 | Deserialization will happen on a new thread. | ||
5180 | </summary> | ||
5181 | <typeparam name="T">The type of the object to deserialize to.</typeparam> | ||
5182 | <param name="value">The JSON to deserialize.</param> | ||
5183 | <returns> | ||
5184 | A task that represents the asynchronous deserialize operation. The value of the <c>TResult</c> parameter contains the deserialized object from the JSON string. | ||
5185 | </returns> | ||
5186 | </member> | ||
5187 | <member name="M:Newtonsoft.Json.JsonConvert.DeserializeObjectAsync``1(System.String,Newtonsoft.Json.JsonSerializerSettings)"> | ||
5188 | <summary> | ||
5189 | Asynchronously deserializes the JSON to the specified .NET type using <see cref="T:Newtonsoft.Json.JsonSerializerSettings"/>. | ||
5190 | Deserialization will happen on a new thread. | ||
5191 | </summary> | ||
5192 | <typeparam name="T">The type of the object to deserialize to.</typeparam> | ||
5193 | <param name="value">The JSON to deserialize.</param> | ||
5194 | <param name="settings"> | ||
5195 | The <see cref="T:Newtonsoft.Json.JsonSerializerSettings"/> used to deserialize the object. | ||
5196 | If this is null, default serialization settings will be used. | ||
5197 | </param> | ||
5198 | <returns> | ||
5199 | A task that represents the asynchronous deserialize operation. The value of the <c>TResult</c> parameter contains the deserialized object from the JSON string. | ||
5200 | </returns> | ||
5201 | </member> | ||
5202 | <member name="M:Newtonsoft.Json.JsonConvert.DeserializeObjectAsync(System.String)"> | ||
5203 | <summary> | ||
5204 | Asynchronously deserializes the JSON to the specified .NET type. | ||
5205 | Deserialization will happen on a new thread. | ||
5206 | </summary> | ||
5207 | <param name="value">The JSON to deserialize.</param> | ||
5208 | <returns> | ||
5209 | A task that represents the asynchronous deserialize operation. The value of the <c>TResult</c> parameter contains the deserialized object from the JSON string. | ||
5210 | </returns> | ||
5211 | </member> | ||
5212 | <member name="M:Newtonsoft.Json.JsonConvert.DeserializeObjectAsync(System.String,System.Type,Newtonsoft.Json.JsonSerializerSettings)"> | ||
5213 | <summary> | ||
5214 | Asynchronously deserializes the JSON to the specified .NET type using <see cref="T:Newtonsoft.Json.JsonSerializerSettings"/>. | ||
5215 | Deserialization will happen on a new thread. | ||
5216 | </summary> | ||
5217 | <param name="value">The JSON to deserialize.</param> | ||
5218 | <param name="type">The type of the object to deserialize to.</param> | ||
5219 | <param name="settings"> | ||
5220 | The <see cref="T:Newtonsoft.Json.JsonSerializerSettings"/> used to deserialize the object. | ||
5221 | If this is null, default serialization settings will be used. | ||
5222 | </param> | ||
5223 | <returns> | ||
5224 | A task that represents the asynchronous deserialize operation. The value of the <c>TResult</c> parameter contains the deserialized object from the JSON string. | ||
5225 | </returns> | ||
5226 | </member> | ||
5227 | <member name="M:Newtonsoft.Json.JsonConvert.PopulateObject(System.String,System.Object)"> | ||
5228 | <summary> | ||
5229 | Populates the object with values from the JSON string. | ||
5230 | </summary> | ||
5231 | <param name="value">The JSON to populate values from.</param> | ||
5232 | <param name="target">The target object to populate values onto.</param> | ||
5233 | </member> | ||
5234 | <member name="M:Newtonsoft.Json.JsonConvert.PopulateObject(System.String,System.Object,Newtonsoft.Json.JsonSerializerSettings)"> | ||
5235 | <summary> | ||
5236 | Populates the object with values from the JSON string using <see cref="T:Newtonsoft.Json.JsonSerializerSettings"/>. | ||
5237 | </summary> | ||
5238 | <param name="value">The JSON to populate values from.</param> | ||
5239 | <param name="target">The target object to populate values onto.</param> | ||
5240 | <param name="settings"> | ||
5241 | The <see cref="T:Newtonsoft.Json.JsonSerializerSettings"/> used to deserialize the object. | ||
5242 | If this is null, default serialization settings will be used. | ||
5243 | </param> | ||
5244 | </member> | ||
5245 | <member name="M:Newtonsoft.Json.JsonConvert.PopulateObjectAsync(System.String,System.Object,Newtonsoft.Json.JsonSerializerSettings)"> | ||
5246 | <summary> | ||
5247 | Asynchronously populates the object with values from the JSON string using <see cref="T:Newtonsoft.Json.JsonSerializerSettings"/>. | ||
5248 | </summary> | ||
5249 | <param name="value">The JSON to populate values from.</param> | ||
5250 | <param name="target">The target object to populate values onto.</param> | ||
5251 | <param name="settings"> | ||
5252 | The <see cref="T:Newtonsoft.Json.JsonSerializerSettings"/> used to deserialize the object. | ||
5253 | If this is null, default serialization settings will be used. | ||
5254 | </param> | ||
5255 | <returns> | ||
5256 | A task that represents the asynchronous populate operation. | ||
5257 | </returns> | ||
5258 | </member> | ||
5259 | <member name="M:Newtonsoft.Json.JsonConvert.SerializeXmlNode(System.Xml.XmlNode)"> | ||
5260 | <summary> | ||
5261 | Serializes the XML node to a JSON string. | ||
5262 | </summary> | ||
5263 | <param name="node">The node to serialize.</param> | ||
5264 | <returns>A JSON string of the XmlNode.</returns> | ||
5265 | </member> | ||
5266 | <member name="M:Newtonsoft.Json.JsonConvert.SerializeXmlNode(System.Xml.XmlNode,Newtonsoft.Json.Formatting)"> | ||
5267 | <summary> | ||
5268 | Serializes the XML node to a JSON string using formatting. | ||
5269 | </summary> | ||
5270 | <param name="node">The node to serialize.</param> | ||
5271 | <param name="formatting">Indicates how the output is formatted.</param> | ||
5272 | <returns>A JSON string of the XmlNode.</returns> | ||
5273 | </member> | ||
5274 | <member name="M:Newtonsoft.Json.JsonConvert.SerializeXmlNode(System.Xml.XmlNode,Newtonsoft.Json.Formatting,System.Boolean)"> | ||
5275 | <summary> | ||
5276 | Serializes the XML node to a JSON string using formatting and omits the root object if <paramref name="omitRootObject"/> is <c>true</c>. | ||
5277 | </summary> | ||
5278 | <param name="node">The node to serialize.</param> | ||
5279 | <param name="formatting">Indicates how the output is formatted.</param> | ||
5280 | <param name="omitRootObject">Omits writing the root object.</param> | ||
5281 | <returns>A JSON string of the XmlNode.</returns> | ||
5282 | </member> | ||
5283 | <member name="M:Newtonsoft.Json.JsonConvert.DeserializeXmlNode(System.String)"> | ||
5284 | <summary> | ||
5285 | Deserializes the XmlNode from a JSON string. | ||
5286 | </summary> | ||
5287 | <param name="value">The JSON string.</param> | ||
5288 | <returns>The deserialized XmlNode</returns> | ||
5289 | </member> | ||
5290 | <member name="M:Newtonsoft.Json.JsonConvert.DeserializeXmlNode(System.String,System.String)"> | ||
5291 | <summary> | ||
5292 | Deserializes the XmlNode from a JSON string nested in a root elment specified by <paramref name="deserializeRootElementName"/>. | ||
5293 | </summary> | ||
5294 | <param name="value">The JSON string.</param> | ||
5295 | <param name="deserializeRootElementName">The name of the root element to append when deserializing.</param> | ||
5296 | <returns>The deserialized XmlNode</returns> | ||
5297 | </member> | ||
5298 | <member name="M:Newtonsoft.Json.JsonConvert.DeserializeXmlNode(System.String,System.String,System.Boolean)"> | ||
5299 | <summary> | ||
5300 | Deserializes the XmlNode from a JSON string nested in a root elment specified by <paramref name="deserializeRootElementName"/> | ||
5301 | and writes a .NET array attribute for collections. | ||
5302 | </summary> | ||
5303 | <param name="value">The JSON string.</param> | ||
5304 | <param name="deserializeRootElementName">The name of the root element to append when deserializing.</param> | ||
5305 | <param name="writeArrayAttribute"> | ||
5306 | A flag to indicate whether to write the Json.NET array attribute. | ||
5307 | This attribute helps preserve arrays when converting the written XML back to JSON. | ||
5308 | </param> | ||
5309 | <returns>The deserialized XmlNode</returns> | ||
5310 | </member> | ||
5311 | <member name="M:Newtonsoft.Json.JsonConvert.SerializeXNode(System.Xml.Linq.XObject)"> | ||
5312 | <summary> | ||
5313 | Serializes the <see cref="T:System.Xml.Linq.XNode"/> to a JSON string. | ||
5314 | </summary> | ||
5315 | <param name="node">The node to convert to JSON.</param> | ||
5316 | <returns>A JSON string of the XNode.</returns> | ||
5317 | </member> | ||
5318 | <member name="M:Newtonsoft.Json.JsonConvert.SerializeXNode(System.Xml.Linq.XObject,Newtonsoft.Json.Formatting)"> | ||
5319 | <summary> | ||
5320 | Serializes the <see cref="T:System.Xml.Linq.XNode"/> to a JSON string using formatting. | ||
5321 | </summary> | ||
5322 | <param name="node">The node to convert to JSON.</param> | ||
5323 | <param name="formatting">Indicates how the output is formatted.</param> | ||
5324 | <returns>A JSON string of the XNode.</returns> | ||
5325 | </member> | ||
5326 | <member name="M:Newtonsoft.Json.JsonConvert.SerializeXNode(System.Xml.Linq.XObject,Newtonsoft.Json.Formatting,System.Boolean)"> | ||
5327 | <summary> | ||
5328 | Serializes the <see cref="T:System.Xml.Linq.XNode"/> to a JSON string using formatting and omits the root object if <paramref name="omitRootObject"/> is <c>true</c>. | ||
5329 | </summary> | ||
5330 | <param name="node">The node to serialize.</param> | ||
5331 | <param name="formatting">Indicates how the output is formatted.</param> | ||
5332 | <param name="omitRootObject">Omits writing the root object.</param> | ||
5333 | <returns>A JSON string of the XNode.</returns> | ||
5334 | </member> | ||
5335 | <member name="M:Newtonsoft.Json.JsonConvert.DeserializeXNode(System.String)"> | ||
5336 | <summary> | ||
5337 | Deserializes the <see cref="T:System.Xml.Linq.XNode"/> from a JSON string. | ||
5338 | </summary> | ||
5339 | <param name="value">The JSON string.</param> | ||
5340 | <returns>The deserialized XNode</returns> | ||
5341 | </member> | ||
5342 | <member name="M:Newtonsoft.Json.JsonConvert.DeserializeXNode(System.String,System.String)"> | ||
5343 | <summary> | ||
5344 | Deserializes the <see cref="T:System.Xml.Linq.XNode"/> from a JSON string nested in a root elment specified by <paramref name="deserializeRootElementName"/>. | ||
5345 | </summary> | ||
5346 | <param name="value">The JSON string.</param> | ||
5347 | <param name="deserializeRootElementName">The name of the root element to append when deserializing.</param> | ||
5348 | <returns>The deserialized XNode</returns> | ||
5349 | </member> | ||
5350 | <member name="M:Newtonsoft.Json.JsonConvert.DeserializeXNode(System.String,System.String,System.Boolean)"> | ||
5351 | <summary> | ||
5352 | Deserializes the <see cref="T:System.Xml.Linq.XNode"/> from a JSON string nested in a root elment specified by <paramref name="deserializeRootElementName"/> | ||
5353 | and writes a .NET array attribute for collections. | ||
5354 | </summary> | ||
5355 | <param name="value">The JSON string.</param> | ||
5356 | <param name="deserializeRootElementName">The name of the root element to append when deserializing.</param> | ||
5357 | <param name="writeArrayAttribute"> | ||
5358 | A flag to indicate whether to write the Json.NET array attribute. | ||
5359 | This attribute helps preserve arrays when converting the written XML back to JSON. | ||
5360 | </param> | ||
5361 | <returns>The deserialized XNode</returns> | ||
5362 | </member> | ||
5363 | <member name="P:Newtonsoft.Json.JsonConvert.DefaultSettings"> | ||
5364 | <summary> | ||
5365 | Gets or sets a function that creates default <see cref="T:Newtonsoft.Json.JsonSerializerSettings"/>. | ||
5366 | Default settings are automatically used by serialization methods on <see cref="T:Newtonsoft.Json.JsonConvert"/>, | ||
5367 | and <see cref="M:Newtonsoft.Json.Linq.JToken.ToObject``1"/> and <see cref="M:Newtonsoft.Json.Linq.JToken.FromObject(System.Object)"/> on <see cref="T:Newtonsoft.Json.Linq.JToken"/>. | ||
5368 | To serialize without using any default settings create a <see cref="T:Newtonsoft.Json.JsonSerializer"/> with | ||
5369 | <see cref="M:Newtonsoft.Json.JsonSerializer.Create"/>. | ||
5370 | </summary> | ||
5371 | </member> | ||
5372 | <member name="T:Newtonsoft.Json.JsonSerializationException"> | ||
5373 | <summary> | ||
5374 | The exception thrown when an error occurs during Json serialization or deserialization. | ||
5375 | </summary> | ||
5376 | </member> | ||
5377 | <member name="M:Newtonsoft.Json.JsonSerializationException.#ctor"> | ||
5378 | <summary> | ||
5379 | Initializes a new instance of the <see cref="T:Newtonsoft.Json.JsonSerializationException"/> class. | ||
5380 | </summary> | ||
5381 | </member> | ||
5382 | <member name="M:Newtonsoft.Json.JsonSerializationException.#ctor(System.String)"> | ||
5383 | <summary> | ||
5384 | Initializes a new instance of the <see cref="T:Newtonsoft.Json.JsonSerializationException"/> class | ||
5385 | with a specified error message. | ||
5386 | </summary> | ||
5387 | <param name="message">The error message that explains the reason for the exception.</param> | ||
5388 | </member> | ||
5389 | <member name="M:Newtonsoft.Json.JsonSerializationException.#ctor(System.String,System.Exception)"> | ||
5390 | <summary> | ||
5391 | Initializes a new instance of the <see cref="T:Newtonsoft.Json.JsonSerializationException"/> class | ||
5392 | with a specified error message and a reference to the inner exception that is the cause of this exception. | ||
5393 | </summary> | ||
5394 | <param name="message">The error message that explains the reason for the exception.</param> | ||
5395 | <param name="innerException">The exception that is the cause of the current exception, or a null reference (Nothing in Visual Basic) if no inner exception is specified.</param> | ||
5396 | </member> | ||
5397 | <member name="M:Newtonsoft.Json.JsonSerializationException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> | ||
5398 | <summary> | ||
5399 | Initializes a new instance of the <see cref="T:Newtonsoft.Json.JsonSerializationException"/> class. | ||
5400 | </summary> | ||
5401 | <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param> | ||
5402 | <param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param> | ||
5403 | <exception cref="T:System.ArgumentNullException">The <paramref name="info"/> parameter is null. </exception> | ||
5404 | <exception cref="T:System.Runtime.Serialization.SerializationException">The class name is null or <see cref="P:System.Exception.HResult"/> is zero (0). </exception> | ||
5405 | </member> | ||
5406 | <member name="T:Newtonsoft.Json.JsonSerializer"> | ||
5407 | <summary> | ||
5408 | Serializes and deserializes objects into and from the JSON format. | ||
5409 | The <see cref="T:Newtonsoft.Json.JsonSerializer"/> enables you to control how objects are encoded into JSON. | ||
5410 | </summary> | ||
5411 | </member> | ||
5412 | <member name="M:Newtonsoft.Json.JsonSerializer.#ctor"> | ||
5413 | <summary> | ||
5414 | Initializes a new instance of the <see cref="T:Newtonsoft.Json.JsonSerializer"/> class. | ||
5415 | </summary> | ||
5416 | </member> | ||
5417 | <member name="M:Newtonsoft.Json.JsonSerializer.Create"> | ||
5418 | <summary> | ||
5419 | Creates a new <see cref="T:Newtonsoft.Json.JsonSerializer"/> instance. | ||
5420 | The <see cref="T:Newtonsoft.Json.JsonSerializer"/> will not use default settings. | ||
5421 | </summary> | ||
5422 | <returns> | ||
5423 | A new <see cref="T:Newtonsoft.Json.JsonSerializer"/> instance. | ||
5424 | The <see cref="T:Newtonsoft.Json.JsonSerializer"/> will not use default settings. | ||
5425 | </returns> | ||
5426 | </member> | ||
5427 | <member name="M:Newtonsoft.Json.JsonSerializer.Create(Newtonsoft.Json.JsonSerializerSettings)"> | ||
5428 | <summary> | ||
5429 | Creates a new <see cref="T:Newtonsoft.Json.JsonSerializer"/> instance using the specified <see cref="T:Newtonsoft.Json.JsonSerializerSettings"/>. | ||
5430 | The <see cref="T:Newtonsoft.Json.JsonSerializer"/> will not use default settings. | ||
5431 | </summary> | ||
5432 | <param name="settings">The settings to be applied to the <see cref="T:Newtonsoft.Json.JsonSerializer"/>.</param> | ||
5433 | <returns> | ||
5434 | A new <see cref="T:Newtonsoft.Json.JsonSerializer"/> instance using the specified <see cref="T:Newtonsoft.Json.JsonSerializerSettings"/>. | ||
5435 | The <see cref="T:Newtonsoft.Json.JsonSerializer"/> will not use default settings. | ||
5436 | </returns> | ||
5437 | </member> | ||
5438 | <member name="M:Newtonsoft.Json.JsonSerializer.CreateDefault"> | ||
5439 | <summary> | ||
5440 | Creates a new <see cref="T:Newtonsoft.Json.JsonSerializer"/> instance. | ||
5441 | The <see cref="T:Newtonsoft.Json.JsonSerializer"/> will use default settings. | ||
5442 | </summary> | ||
5443 | <returns> | ||
5444 | A new <see cref="T:Newtonsoft.Json.JsonSerializer"/> instance. | ||
5445 | The <see cref="T:Newtonsoft.Json.JsonSerializer"/> will use default settings. | ||
5446 | </returns> | ||
5447 | </member> | ||
5448 | <member name="M:Newtonsoft.Json.JsonSerializer.CreateDefault(Newtonsoft.Json.JsonSerializerSettings)"> | ||
5449 | <summary> | ||
5450 | Creates a new <see cref="T:Newtonsoft.Json.JsonSerializer"/> instance using the specified <see cref="T:Newtonsoft.Json.JsonSerializerSettings"/>. | ||
5451 | The <see cref="T:Newtonsoft.Json.JsonSerializer"/> will use default settings. | ||
5452 | </summary> | ||
5453 | <param name="settings">The settings to be applied to the <see cref="T:Newtonsoft.Json.JsonSerializer"/>.</param> | ||
5454 | <returns> | ||
5455 | A new <see cref="T:Newtonsoft.Json.JsonSerializer"/> instance using the specified <see cref="T:Newtonsoft.Json.JsonSerializerSettings"/>. | ||
5456 | The <see cref="T:Newtonsoft.Json.JsonSerializer"/> will use default settings. | ||
5457 | </returns> | ||
5458 | </member> | ||
5459 | <member name="M:Newtonsoft.Json.JsonSerializer.Populate(System.IO.TextReader,System.Object)"> | ||
5460 | <summary> | ||
5461 | Populates the JSON values onto the target object. | ||
5462 | </summary> | ||
5463 | <param name="reader">The <see cref="T:System.IO.TextReader"/> that contains the JSON structure to reader values from.</param> | ||
5464 | <param name="target">The target object to populate values onto.</param> | ||
5465 | </member> | ||
5466 | <member name="M:Newtonsoft.Json.JsonSerializer.Populate(Newtonsoft.Json.JsonReader,System.Object)"> | ||
5467 | <summary> | ||
5468 | Populates the JSON values onto the target object. | ||
5469 | </summary> | ||
5470 | <param name="reader">The <see cref="T:Newtonsoft.Json.JsonReader"/> that contains the JSON structure to reader values from.</param> | ||
5471 | <param name="target">The target object to populate values onto.</param> | ||
5472 | </member> | ||
5473 | <member name="M:Newtonsoft.Json.JsonSerializer.Deserialize(Newtonsoft.Json.JsonReader)"> | ||
5474 | <summary> | ||
5475 | Deserializes the Json structure contained by the specified <see cref="T:Newtonsoft.Json.JsonReader"/>. | ||
5476 | </summary> | ||
5477 | <param name="reader">The <see cref="T:Newtonsoft.Json.JsonReader"/> that contains the JSON structure to deserialize.</param> | ||
5478 | <returns>The <see cref="T:System.Object"/> being deserialized.</returns> | ||
5479 | </member> | ||
5480 | <member name="M:Newtonsoft.Json.JsonSerializer.Deserialize(System.IO.TextReader,System.Type)"> | ||
5481 | <summary> | ||
5482 | Deserializes the Json structure contained by the specified <see cref="T:System.IO.StringReader"/> | ||
5483 | into an instance of the specified type. | ||
5484 | </summary> | ||
5485 | <param name="reader">The <see cref="T:System.IO.TextReader"/> containing the object.</param> | ||
5486 | <param name="objectType">The <see cref="T:System.Type"/> of object being deserialized.</param> | ||
5487 | <returns>The instance of <paramref name="objectType"/> being deserialized.</returns> | ||
5488 | </member> | ||
5489 | <member name="M:Newtonsoft.Json.JsonSerializer.Deserialize``1(Newtonsoft.Json.JsonReader)"> | ||
5490 | <summary> | ||
5491 | Deserializes the Json structure contained by the specified <see cref="T:Newtonsoft.Json.JsonReader"/> | ||
5492 | into an instance of the specified type. | ||
5493 | </summary> | ||
5494 | <param name="reader">The <see cref="T:Newtonsoft.Json.JsonReader"/> containing the object.</param> | ||
5495 | <typeparam name="T">The type of the object to deserialize.</typeparam> | ||
5496 | <returns>The instance of <typeparamref name="T"/> being deserialized.</returns> | ||
5497 | </member> | ||
5498 | <member name="M:Newtonsoft.Json.JsonSerializer.Deserialize(Newtonsoft.Json.JsonReader,System.Type)"> | ||
5499 | <summary> | ||
5500 | Deserializes the Json structure contained by the specified <see cref="T:Newtonsoft.Json.JsonReader"/> | ||
5501 | into an instance of the specified type. | ||
5502 | </summary> | ||
5503 | <param name="reader">The <see cref="T:Newtonsoft.Json.JsonReader"/> containing the object.</param> | ||
5504 | <param name="objectType">The <see cref="T:System.Type"/> of object being deserialized.</param> | ||
5505 | <returns>The instance of <paramref name="objectType"/> being deserialized.</returns> | ||
5506 | </member> | ||
5507 | <member name="M:Newtonsoft.Json.JsonSerializer.Serialize(System.IO.TextWriter,System.Object)"> | ||
5508 | <summary> | ||
5509 | Serializes the specified <see cref="T:System.Object"/> and writes the Json structure | ||
5510 | to a <c>Stream</c> using the specified <see cref="T:System.IO.TextWriter"/>. | ||
5511 | </summary> | ||
5512 | <param name="textWriter">The <see cref="T:System.IO.TextWriter"/> used to write the Json structure.</param> | ||
5513 | <param name="value">The <see cref="T:System.Object"/> to serialize.</param> | ||
5514 | </member> | ||
5515 | <member name="M:Newtonsoft.Json.JsonSerializer.Serialize(Newtonsoft.Json.JsonWriter,System.Object,System.Type)"> | ||
5516 | <summary> | ||
5517 | Serializes the specified <see cref="T:System.Object"/> and writes the Json structure | ||
5518 | to a <c>Stream</c> using the specified <see cref="T:System.IO.TextWriter"/>. | ||
5519 | </summary> | ||
5520 | <param name="jsonWriter">The <see cref="T:Newtonsoft.Json.JsonWriter"/> used to write the Json structure.</param> | ||
5521 | <param name="value">The <see cref="T:System.Object"/> to serialize.</param> | ||
5522 | <param name="objectType"> | ||
5523 | The type of the value being serialized. | ||
5524 | This parameter is used when <see cref="P:Newtonsoft.Json.JsonSerializer.TypeNameHandling"/> is Auto to write out the type name if the type of the value does not match. | ||
5525 | Specifing the type is optional. | ||
5526 | </param> | ||
5527 | </member> | ||
5528 | <member name="M:Newtonsoft.Json.JsonSerializer.Serialize(System.IO.TextWriter,System.Object,System.Type)"> | ||
5529 | <summary> | ||
5530 | Serializes the specified <see cref="T:System.Object"/> and writes the Json structure | ||
5531 | to a <c>Stream</c> using the specified <see cref="T:System.IO.TextWriter"/>. | ||
5532 | </summary> | ||
5533 | <param name="textWriter">The <see cref="T:System.IO.TextWriter"/> used to write the Json structure.</param> | ||
5534 | <param name="value">The <see cref="T:System.Object"/> to serialize.</param> | ||
5535 | <param name="objectType"> | ||
5536 | The type of the value being serialized. | ||
5537 | This parameter is used when <see cref="P:Newtonsoft.Json.JsonSerializer.TypeNameHandling"/> is Auto to write out the type name if the type of the value does not match. | ||
5538 | Specifing the type is optional. | ||
5539 | </param> | ||
5540 | </member> | ||
5541 | <member name="M:Newtonsoft.Json.JsonSerializer.Serialize(Newtonsoft.Json.JsonWriter,System.Object)"> | ||
5542 | <summary> | ||
5543 | Serializes the specified <see cref="T:System.Object"/> and writes the Json structure | ||
5544 | to a <c>Stream</c> using the specified <see cref="T:Newtonsoft.Json.JsonWriter"/>. | ||
5545 | </summary> | ||
5546 | <param name="jsonWriter">The <see cref="T:Newtonsoft.Json.JsonWriter"/> used to write the Json structure.</param> | ||
5547 | <param name="value">The <see cref="T:System.Object"/> to serialize.</param> | ||
5548 | </member> | ||
5549 | <member name="E:Newtonsoft.Json.JsonSerializer.Error"> | ||
5550 | <summary> | ||
5551 | Occurs when the <see cref="T:Newtonsoft.Json.JsonSerializer"/> errors during serialization and deserialization. | ||
5552 | </summary> | ||
5553 | </member> | ||
5554 | <member name="P:Newtonsoft.Json.JsonSerializer.ReferenceResolver"> | ||
5555 | <summary> | ||
5556 | Gets or sets the <see cref="T:Newtonsoft.Json.Serialization.IReferenceResolver"/> used by the serializer when resolving references. | ||
5557 | </summary> | ||
5558 | </member> | ||
5559 | <member name="P:Newtonsoft.Json.JsonSerializer.Binder"> | ||
5560 | <summary> | ||
5561 | Gets or sets the <see cref="T:System.Runtime.Serialization.SerializationBinder"/> used by the serializer when resolving type names. | ||
5562 | </summary> | ||
5563 | </member> | ||
5564 | <member name="P:Newtonsoft.Json.JsonSerializer.TraceWriter"> | ||
5565 | <summary> | ||
5566 | Gets or sets the <see cref="T:Newtonsoft.Json.Serialization.ITraceWriter"/> used by the serializer when writing trace messages. | ||
5567 | </summary> | ||
5568 | <value>The trace writer.</value> | ||
5569 | </member> | ||
5570 | <member name="P:Newtonsoft.Json.JsonSerializer.TypeNameHandling"> | ||
5571 | <summary> | ||
5572 | Gets or sets how type name writing and reading is handled by the serializer. | ||
5573 | </summary> | ||
5574 | </member> | ||
5575 | <member name="P:Newtonsoft.Json.JsonSerializer.TypeNameAssemblyFormat"> | ||
5576 | <summary> | ||
5577 | Gets or sets how a type name assembly is written and resolved by the serializer. | ||
5578 | </summary> | ||
5579 | <value>The type name assembly format.</value> | ||
5580 | </member> | ||
5581 | <member name="P:Newtonsoft.Json.JsonSerializer.PreserveReferencesHandling"> | ||
5582 | <summary> | ||
5583 | Gets or sets how object references are preserved by the serializer. | ||
5584 | </summary> | ||
5585 | </member> | ||
5586 | <member name="P:Newtonsoft.Json.JsonSerializer.ReferenceLoopHandling"> | ||
5587 | <summary> | ||
5588 | Get or set how reference loops (e.g. a class referencing itself) is handled. | ||
5589 | </summary> | ||
5590 | </member> | ||
5591 | <member name="P:Newtonsoft.Json.JsonSerializer.MissingMemberHandling"> | ||
5592 | <summary> | ||
5593 | Get or set how missing members (e.g. JSON contains a property that isn't a member on the object) are handled during deserialization. | ||
5594 | </summary> | ||
5595 | </member> | ||
5596 | <member name="P:Newtonsoft.Json.JsonSerializer.NullValueHandling"> | ||
5597 | <summary> | ||
5598 | Get or set how null values are handled during serialization and deserialization. | ||
5599 | </summary> | ||
5600 | </member> | ||
5601 | <member name="P:Newtonsoft.Json.JsonSerializer.DefaultValueHandling"> | ||
5602 | <summary> | ||
5603 | Get or set how null default are handled during serialization and deserialization. | ||
5604 | </summary> | ||
5605 | </member> | ||
5606 | <member name="P:Newtonsoft.Json.JsonSerializer.ObjectCreationHandling"> | ||
5607 | <summary> | ||
5608 | Gets or sets how objects are created during deserialization. | ||
5609 | </summary> | ||
5610 | <value>The object creation handling.</value> | ||
5611 | </member> | ||
5612 | <member name="P:Newtonsoft.Json.JsonSerializer.ConstructorHandling"> | ||
5613 | <summary> | ||
5614 | Gets or sets how constructors are used during deserialization. | ||
5615 | </summary> | ||
5616 | <value>The constructor handling.</value> | ||
5617 | </member> | ||
5618 | <member name="P:Newtonsoft.Json.JsonSerializer.MetadataPropertyHandling"> | ||
5619 | <summary> | ||
5620 | Gets or sets how metadata properties are used during deserialization. | ||
5621 | </summary> | ||
5622 | <value>The metadata properties handling.</value> | ||
5623 | </member> | ||
5624 | <member name="P:Newtonsoft.Json.JsonSerializer.Converters"> | ||
5625 | <summary> | ||
5626 | Gets a collection <see cref="T:Newtonsoft.Json.JsonConverter"/> that will be used during serialization. | ||
5627 | </summary> | ||
5628 | <value>Collection <see cref="T:Newtonsoft.Json.JsonConverter"/> that will be used during serialization.</value> | ||
5629 | </member> | ||
5630 | <member name="P:Newtonsoft.Json.JsonSerializer.ContractResolver"> | ||
5631 | <summary> | ||
5632 | Gets or sets the contract resolver used by the serializer when | ||
5633 | serializing .NET objects to JSON and vice versa. | ||
5634 | </summary> | ||
5635 | </member> | ||
5636 | <member name="P:Newtonsoft.Json.JsonSerializer.Context"> | ||
5637 | <summary> | ||
5638 | Gets or sets the <see cref="T:System.Runtime.Serialization.StreamingContext"/> used by the serializer when invoking serialization callback methods. | ||
5639 | </summary> | ||
5640 | <value>The context.</value> | ||
5641 | </member> | ||
5642 | <member name="P:Newtonsoft.Json.JsonSerializer.Formatting"> | ||
5643 | <summary> | ||
5644 | Indicates how JSON text output is formatted. | ||
5645 | </summary> | ||
5646 | </member> | ||
5647 | <member name="P:Newtonsoft.Json.JsonSerializer.DateFormatHandling"> | ||
5648 | <summary> | ||
5649 | Get or set how dates are written to JSON text. | ||
5650 | </summary> | ||
5651 | </member> | ||
5652 | <member name="P:Newtonsoft.Json.JsonSerializer.DateTimeZoneHandling"> | ||
5653 | <summary> | ||
5654 | Get or set how <see cref="T:System.DateTime"/> time zones are handling during serialization and deserialization. | ||
5655 | </summary> | ||
5656 | </member> | ||
5657 | <member name="P:Newtonsoft.Json.JsonSerializer.DateParseHandling"> | ||
5658 | <summary> | ||
5659 | Get or set how date formatted strings, e.g. "\/Date(1198908717056)\/" and "2012-03-21T05:40Z", are parsed when reading JSON. | ||
5660 | </summary> | ||
5661 | </member> | ||
5662 | <member name="P:Newtonsoft.Json.JsonSerializer.FloatParseHandling"> | ||
5663 | <summary> | ||
5664 | Get or set how floating point numbers, e.g. 1.0 and 9.9, are parsed when reading JSON text. | ||
5665 | </summary> | ||
5666 | </member> | ||
5667 | <member name="P:Newtonsoft.Json.JsonSerializer.FloatFormatHandling"> | ||
5668 | <summary> | ||
5669 | Get or set how special floating point numbers, e.g. <see cref="F:System.Double.NaN"/>, | ||
5670 | <see cref="F:System.Double.PositiveInfinity"/> and <see cref="F:System.Double.NegativeInfinity"/>, | ||
5671 | are written as JSON text. | ||
5672 | </summary> | ||
5673 | </member> | ||
5674 | <member name="P:Newtonsoft.Json.JsonSerializer.StringEscapeHandling"> | ||
5675 | <summary> | ||
5676 | Get or set how strings are escaped when writing JSON text. | ||
5677 | </summary> | ||
5678 | </member> | ||
5679 | <member name="P:Newtonsoft.Json.JsonSerializer.DateFormatString"> | ||
5680 | <summary> | ||
5681 | Get or set how <see cref="T:System.DateTime"/> and <see cref="T:System.DateTimeOffset"/> values are formatting when writing JSON text. | ||
5682 | </summary> | ||
5683 | </member> | ||
5684 | <member name="P:Newtonsoft.Json.JsonSerializer.Culture"> | ||
5685 | <summary> | ||
5686 | Gets or sets the culture used when reading JSON. Defaults to <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>. | ||
5687 | </summary> | ||
5688 | </member> | ||
5689 | <member name="P:Newtonsoft.Json.JsonSerializer.MaxDepth"> | ||
5690 | <summary> | ||
5691 | Gets or sets the maximum depth allowed when reading JSON. Reading past this depth will throw a <see cref="T:Newtonsoft.Json.JsonReaderException"/>. | ||
5692 | </summary> | ||
5693 | </member> | ||
5694 | <member name="P:Newtonsoft.Json.JsonSerializer.CheckAdditionalContent"> | ||
5695 | <summary> | ||
5696 | Gets a value indicating whether there will be a check for additional JSON content after deserializing an object. | ||
5697 | </summary> | ||
5698 | <value> | ||
5699 | <c>true</c> if there will be a check for additional JSON content after deserializing an object; otherwise, <c>false</c>. | ||
5700 | </value> | ||
5701 | </member> | ||
5702 | <member name="T:Newtonsoft.Json.Linq.Extensions"> | ||
5703 | <summary> | ||
5704 | Contains the LINQ to JSON extension methods. | ||
5705 | </summary> | ||
5706 | </member> | ||
5707 | <member name="M:Newtonsoft.Json.Linq.Extensions.Ancestors``1(System.Collections.Generic.IEnumerable{``0})"> | ||
5708 | <summary> | ||
5709 | Returns a collection of tokens that contains the ancestors of every token in the source collection. | ||
5710 | </summary> | ||
5711 | <typeparam name="T">The type of the objects in source, constrained to <see cref="T:Newtonsoft.Json.Linq.JToken"/>.</typeparam> | ||
5712 | <param name="source">An <see cref="T:System.Collections.Generic.IEnumerable`1"/> of <see cref="T:Newtonsoft.Json.Linq.JToken"/> that contains the source collection.</param> | ||
5713 | <returns>An <see cref="T:System.Collections.Generic.IEnumerable`1"/> of <see cref="T:Newtonsoft.Json.Linq.JToken"/> that contains the ancestors of every node in the source collection.</returns> | ||
5714 | </member> | ||
5715 | <member name="M:Newtonsoft.Json.Linq.Extensions.Descendants``1(System.Collections.Generic.IEnumerable{``0})"> | ||
5716 | <summary> | ||
5717 | Returns a collection of tokens that contains the descendants of every token in the source collection. | ||
5718 | </summary> | ||
5719 | <typeparam name="T">The type of the objects in source, constrained to <see cref="T:Newtonsoft.Json.Linq.JContainer"/>.</typeparam> | ||
5720 | <param name="source">An <see cref="T:System.Collections.Generic.IEnumerable`1"/> of <see cref="T:Newtonsoft.Json.Linq.JToken"/> that contains the source collection.</param> | ||
5721 | <returns>An <see cref="T:System.Collections.Generic.IEnumerable`1"/> of <see cref="T:Newtonsoft.Json.Linq.JToken"/> that contains the descendants of every node in the source collection.</returns> | ||
5722 | </member> | ||
5723 | <member name="M:Newtonsoft.Json.Linq.Extensions.Properties(System.Collections.Generic.IEnumerable{Newtonsoft.Json.Linq.JObject})"> | ||
5724 | <summary> | ||
5725 | Returns a collection of child properties of every object in the source collection. | ||
5726 | </summary> | ||
5727 | <param name="source">An <see cref="T:System.Collections.Generic.IEnumerable`1"/> of <see cref="T:Newtonsoft.Json.Linq.JObject"/> that contains the source collection.</param> | ||
5728 | <returns>An <see cref="T:System.Collections.Generic.IEnumerable`1"/> of <see cref="T:Newtonsoft.Json.Linq.JProperty"/> that contains the properties of every object in the source collection.</returns> | ||
5729 | </member> | ||
5730 | <member name="M:Newtonsoft.Json.Linq.Extensions.Values(System.Collections.Generic.IEnumerable{Newtonsoft.Json.Linq.JToken},System.Object)"> | ||
5731 | <summary> | ||
5732 | Returns a collection of child values of every object in the source collection with the given key. | ||
5733 | </summary> | ||
5734 | <param name="source">An <see cref="T:System.Collections.Generic.IEnumerable`1"/> of <see cref="T:Newtonsoft.Json.Linq.JToken"/> that contains the source collection.</param> | ||
5735 | <param name="key">The token key.</param> | ||
5736 | <returns>An <see cref="T:System.Collections.Generic.IEnumerable`1"/> of <see cref="T:Newtonsoft.Json.Linq.JToken"/> that contains the values of every node in the source collection with the given key.</returns> | ||
5737 | </member> | ||
5738 | <member name="M:Newtonsoft.Json.Linq.Extensions.Values(System.Collections.Generic.IEnumerable{Newtonsoft.Json.Linq.JToken})"> | ||
5739 | <summary> | ||
5740 | Returns a collection of child values of every object in the source collection. | ||
5741 | </summary> | ||
5742 | <param name="source">An <see cref="T:System.Collections.Generic.IEnumerable`1"/> of <see cref="T:Newtonsoft.Json.Linq.JToken"/> that contains the source collection.</param> | ||
5743 | <returns>An <see cref="T:System.Collections.Generic.IEnumerable`1"/> of <see cref="T:Newtonsoft.Json.Linq.JToken"/> that contains the values of every node in the source collection.</returns> | ||
5744 | </member> | ||
5745 | <member name="M:Newtonsoft.Json.Linq.Extensions.Values``1(System.Collections.Generic.IEnumerable{Newtonsoft.Json.Linq.JToken},System.Object)"> | ||
5746 | <summary> | ||
5747 | Returns a collection of converted child values of every object in the source collection with the given key. | ||
5748 | </summary> | ||
5749 | <typeparam name="U">The type to convert the values to.</typeparam> | ||
5750 | <param name="source">An <see cref="T:System.Collections.Generic.IEnumerable`1"/> of <see cref="T:Newtonsoft.Json.Linq.JToken"/> that contains the source collection.</param> | ||
5751 | <param name="key">The token key.</param> | ||
5752 | <returns>An <see cref="T:System.Collections.Generic.IEnumerable`1"/> that contains the converted values of every node in the source collection with the given key.</returns> | ||
5753 | </member> | ||
5754 | <member name="M:Newtonsoft.Json.Linq.Extensions.Values``1(System.Collections.Generic.IEnumerable{Newtonsoft.Json.Linq.JToken})"> | ||
5755 | <summary> | ||
5756 | Returns a collection of converted child values of every object in the source collection. | ||
5757 | </summary> | ||
5758 | <typeparam name="U">The type to convert the values to.</typeparam> | ||
5759 | <param name="source">An <see cref="T:System.Collections.Generic.IEnumerable`1"/> of <see cref="T:Newtonsoft.Json.Linq.JToken"/> that contains the source collection.</param> | ||
5760 | <returns>An <see cref="T:System.Collections.Generic.IEnumerable`1"/> that contains the converted values of every node in the source collection.</returns> | ||
5761 | </member> | ||
5762 | <member name="M:Newtonsoft.Json.Linq.Extensions.Value``1(System.Collections.Generic.IEnumerable{Newtonsoft.Json.Linq.JToken})"> | ||
5763 | <summary> | ||
5764 | Converts the value. | ||
5765 | </summary> | ||
5766 | <typeparam name="U">The type to convert the value to.</typeparam> | ||
5767 | <param name="value">A <see cref="T:Newtonsoft.Json.Linq.JToken"/> cast as a <see cref="T:System.Collections.Generic.IEnumerable`1"/> of <see cref="T:Newtonsoft.Json.Linq.JToken"/>.</param> | ||
5768 | <returns>A converted value.</returns> | ||
5769 | </member> | ||
5770 | <member name="M:Newtonsoft.Json.Linq.Extensions.Value``2(System.Collections.Generic.IEnumerable{``0})"> | ||
5771 | <summary> | ||
5772 | Converts the value. | ||
5773 | </summary> | ||
5774 | <typeparam name="T">The source collection type.</typeparam> | ||
5775 | <typeparam name="U">The type to convert the value to.</typeparam> | ||
5776 | <param name="value">A <see cref="T:Newtonsoft.Json.Linq.JToken"/> cast as a <see cref="T:System.Collections.Generic.IEnumerable`1"/> of <see cref="T:Newtonsoft.Json.Linq.JToken"/>.</param> | ||
5777 | <returns>A converted value.</returns> | ||
5778 | </member> | ||
5779 | <member name="M:Newtonsoft.Json.Linq.Extensions.Children``1(System.Collections.Generic.IEnumerable{``0})"> | ||
5780 | <summary> | ||
5781 | Returns a collection of child tokens of every array in the source collection. | ||
5782 | </summary> | ||
5783 | <typeparam name="T">The source collection type.</typeparam> | ||
5784 | <param name="source">An <see cref="T:System.Collections.Generic.IEnumerable`1"/> of <see cref="T:Newtonsoft.Json.Linq.JToken"/> that contains the source collection.</param> | ||
5785 | <returns>An <see cref="T:System.Collections.Generic.IEnumerable`1"/> of <see cref="T:Newtonsoft.Json.Linq.JToken"/> that contains the values of every node in the source collection.</returns> | ||
5786 | </member> | ||
5787 | <member name="M:Newtonsoft.Json.Linq.Extensions.Children``2(System.Collections.Generic.IEnumerable{``0})"> | ||
5788 | <summary> | ||
5789 | Returns a collection of converted child tokens of every array in the source collection. | ||
5790 | </summary> | ||
5791 | <param name="source">An <see cref="T:System.Collections.Generic.IEnumerable`1"/> of <see cref="T:Newtonsoft.Json.Linq.JToken"/> that contains the source collection.</param> | ||
5792 | <typeparam name="U">The type to convert the values to.</typeparam> | ||
5793 | <typeparam name="T">The source collection type.</typeparam> | ||
5794 | <returns>An <see cref="T:System.Collections.Generic.IEnumerable`1"/> that contains the converted values of every node in the source collection.</returns> | ||
5795 | </member> | ||
5796 | <member name="M:Newtonsoft.Json.Linq.Extensions.AsJEnumerable(System.Collections.Generic.IEnumerable{Newtonsoft.Json.Linq.JToken})"> | ||
5797 | <summary> | ||
5798 | Returns the input typed as <see cref="T:Newtonsoft.Json.Linq.IJEnumerable`1"/>. | ||
5799 | </summary> | ||
5800 | <param name="source">An <see cref="T:System.Collections.Generic.IEnumerable`1"/> of <see cref="T:Newtonsoft.Json.Linq.JToken"/> that contains the source collection.</param> | ||
5801 | <returns>The input typed as <see cref="T:Newtonsoft.Json.Linq.IJEnumerable`1"/>.</returns> | ||
5802 | </member> | ||
5803 | <member name="M:Newtonsoft.Json.Linq.Extensions.AsJEnumerable``1(System.Collections.Generic.IEnumerable{``0})"> | ||
5804 | <summary> | ||
5805 | Returns the input typed as <see cref="T:Newtonsoft.Json.Linq.IJEnumerable`1"/>. | ||
5806 | </summary> | ||
5807 | <typeparam name="T">The source collection type.</typeparam> | ||
5808 | <param name="source">An <see cref="T:System.Collections.Generic.IEnumerable`1"/> of <see cref="T:Newtonsoft.Json.Linq.JToken"/> that contains the source collection.</param> | ||
5809 | <returns>The input typed as <see cref="T:Newtonsoft.Json.Linq.IJEnumerable`1"/>.</returns> | ||
5810 | </member> | ||
5811 | <member name="T:Newtonsoft.Json.Linq.JConstructor"> | ||
5812 | <summary> | ||
5813 | Represents a JSON constructor. | ||
5814 | </summary> | ||
5815 | </member> | ||
5816 | <member name="T:Newtonsoft.Json.Linq.JContainer"> | ||
5817 | <summary> | ||
5818 | Represents a token that can contain other tokens. | ||
5819 | </summary> | ||
5820 | </member> | ||
5821 | <member name="M:Newtonsoft.Json.Linq.JContainer.OnAddingNew(System.ComponentModel.AddingNewEventArgs)"> | ||
5822 | <summary> | ||
5823 | Raises the <see cref="E:Newtonsoft.Json.Linq.JContainer.AddingNew"/> event. | ||
5824 | </summary> | ||
5825 | <param name="e">The <see cref="T:System.ComponentModel.AddingNewEventArgs"/> instance containing the event data.</param> | ||
5826 | </member> | ||
5827 | <member name="M:Newtonsoft.Json.Linq.JContainer.OnListChanged(System.ComponentModel.ListChangedEventArgs)"> | ||
5828 | <summary> | ||
5829 | Raises the <see cref="E:Newtonsoft.Json.Linq.JContainer.ListChanged"/> event. | ||
5830 | </summary> | ||
5831 | <param name="e">The <see cref="T:System.ComponentModel.ListChangedEventArgs"/> instance containing the event data.</param> | ||
5832 | </member> | ||
5833 | <member name="M:Newtonsoft.Json.Linq.JContainer.OnCollectionChanged(System.Collections.Specialized.NotifyCollectionChangedEventArgs)"> | ||
5834 | <summary> | ||
5835 | Raises the <see cref="E:Newtonsoft.Json.Linq.JContainer.CollectionChanged"/> event. | ||
5836 | </summary> | ||
5837 | <param name="e">The <see cref="T:System.Collections.Specialized.NotifyCollectionChangedEventArgs"/> instance containing the event data.</param> | ||
5838 | </member> | ||
5839 | <member name="M:Newtonsoft.Json.Linq.JContainer.Children"> | ||
5840 | <summary> | ||
5841 | Returns a collection of the child tokens of this token, in document order. | ||
5842 | </summary> | ||
5843 | <returns> | ||
5844 | An <see cref="T:System.Collections.Generic.IEnumerable`1"/> of <see cref="T:Newtonsoft.Json.Linq.JToken"/> containing the child tokens of this <see cref="T:Newtonsoft.Json.Linq.JToken"/>, in document order. | ||
5845 | </returns> | ||
5846 | </member> | ||
5847 | <member name="M:Newtonsoft.Json.Linq.JContainer.Values``1"> | ||
5848 | <summary> | ||
5849 | Returns a collection of the child values of this token, in document order. | ||
5850 | </summary> | ||
5851 | <typeparam name="T">The type to convert the values to.</typeparam> | ||
5852 | <returns> | ||
5853 | A <see cref="T:System.Collections.Generic.IEnumerable`1"/> containing the child values of this <see cref="T:Newtonsoft.Json.Linq.JToken"/>, in document order. | ||
5854 | </returns> | ||
5855 | </member> | ||
5856 | <member name="M:Newtonsoft.Json.Linq.JContainer.Descendants"> | ||
5857 | <summary> | ||
5858 | Returns a collection of the descendant tokens for this token in document order. | ||
5859 | </summary> | ||
5860 | <returns>An <see cref="T:System.Collections.Generic.IEnumerable`1"/> containing the descendant tokens of the <see cref="T:Newtonsoft.Json.Linq.JToken"/>.</returns> | ||
5861 | </member> | ||
5862 | <member name="M:Newtonsoft.Json.Linq.JContainer.Add(System.Object)"> | ||
5863 | <summary> | ||
5864 | Adds the specified content as children of this <see cref="T:Newtonsoft.Json.Linq.JToken"/>. | ||
5865 | </summary> | ||
5866 | <param name="content">The content to be added.</param> | ||
5867 | </member> | ||
5868 | <member name="M:Newtonsoft.Json.Linq.JContainer.AddFirst(System.Object)"> | ||
5869 | <summary> | ||
5870 | Adds the specified content as the first children of this <see cref="T:Newtonsoft.Json.Linq.JToken"/>. | ||
5871 | </summary> | ||
5872 | <param name="content">The content to be added.</param> | ||
5873 | </member> | ||
5874 | <member name="M:Newtonsoft.Json.Linq.JContainer.CreateWriter"> | ||
5875 | <summary> | ||
5876 | Creates an <see cref="T:Newtonsoft.Json.JsonWriter"/> that can be used to add tokens to the <see cref="T:Newtonsoft.Json.Linq.JToken"/>. | ||
5877 | </summary> | ||
5878 | <returns>An <see cref="T:Newtonsoft.Json.JsonWriter"/> that is ready to have content written to it.</returns> | ||
5879 | </member> | ||
5880 | <member name="M:Newtonsoft.Json.Linq.JContainer.ReplaceAll(System.Object)"> | ||
5881 | <summary> | ||
5882 | Replaces the children nodes of this token with the specified content. | ||
5883 | </summary> | ||
5884 | <param name="content">The content.</param> | ||
5885 | </member> | ||
5886 | <member name="M:Newtonsoft.Json.Linq.JContainer.RemoveAll"> | ||
5887 | <summary> | ||
5888 | Removes the child nodes from this token. | ||
5889 | </summary> | ||
5890 | </member> | ||
5891 | <member name="M:Newtonsoft.Json.Linq.JContainer.Merge(System.Object)"> | ||
5892 | <summary> | ||
5893 | Merge the specified content into this <see cref="T:Newtonsoft.Json.Linq.JToken"/>. | ||
5894 | </summary> | ||
5895 | <param name="content">The content to be merged.</param> | ||
5896 | </member> | ||
5897 | <member name="M:Newtonsoft.Json.Linq.JContainer.Merge(System.Object,Newtonsoft.Json.Linq.JsonMergeSettings)"> | ||
5898 | <summary> | ||
5899 | Merge the specified content into this <see cref="T:Newtonsoft.Json.Linq.JToken"/> using <see cref="T:Newtonsoft.Json.Linq.JsonMergeSettings"/>. | ||
5900 | </summary> | ||
5901 | <param name="content">The content to be merged.</param> | ||
5902 | <param name="settings">The <see cref="T:Newtonsoft.Json.Linq.JsonMergeSettings"/> used to merge the content.</param> | ||
5903 | </member> | ||
5904 | <member name="E:Newtonsoft.Json.Linq.JContainer.ListChanged"> | ||
5905 | <summary> | ||
5906 | Occurs when the list changes or an item in the list changes. | ||
5907 | </summary> | ||
5908 | </member> | ||
5909 | <member name="E:Newtonsoft.Json.Linq.JContainer.AddingNew"> | ||
5910 | <summary> | ||
5911 | Occurs before an item is added to the collection. | ||
5912 | </summary> | ||
5913 | </member> | ||
5914 | <member name="E:Newtonsoft.Json.Linq.JContainer.CollectionChanged"> | ||
5915 | <summary> | ||
5916 | Occurs when the items list of the collection has changed, or the collection is reset. | ||
5917 | </summary> | ||
5918 | </member> | ||
5919 | <member name="P:Newtonsoft.Json.Linq.JContainer.ChildrenTokens"> | ||
5920 | <summary> | ||
5921 | Gets the container's children tokens. | ||
5922 | </summary> | ||
5923 | <value>The container's children tokens.</value> | ||
5924 | </member> | ||
5925 | <member name="P:Newtonsoft.Json.Linq.JContainer.HasValues"> | ||
5926 | <summary> | ||
5927 | Gets a value indicating whether this token has child tokens. | ||
5928 | </summary> | ||
5929 | <value> | ||
5930 | <c>true</c> if this token has child values; otherwise, <c>false</c>. | ||
5931 | </value> | ||
5932 | </member> | ||
5933 | <member name="P:Newtonsoft.Json.Linq.JContainer.First"> | ||
5934 | <summary> | ||
5935 | Get the first child token of this token. | ||
5936 | </summary> | ||
5937 | <value> | ||
5938 | A <see cref="T:Newtonsoft.Json.Linq.JToken"/> containing the first child token of the <see cref="T:Newtonsoft.Json.Linq.JToken"/>. | ||
5939 | </value> | ||
5940 | </member> | ||
5941 | <member name="P:Newtonsoft.Json.Linq.JContainer.Last"> | ||
5942 | <summary> | ||
5943 | Get the last child token of this token. | ||
5944 | </summary> | ||
5945 | <value> | ||
5946 | A <see cref="T:Newtonsoft.Json.Linq.JToken"/> containing the last child token of the <see cref="T:Newtonsoft.Json.Linq.JToken"/>. | ||
5947 | </value> | ||
5948 | </member> | ||
5949 | <member name="P:Newtonsoft.Json.Linq.JContainer.Count"> | ||
5950 | <summary> | ||
5951 | Gets the count of child JSON tokens. | ||
5952 | </summary> | ||
5953 | <value>The count of child JSON tokens</value> | ||
5954 | </member> | ||
5955 | <member name="M:Newtonsoft.Json.Linq.JConstructor.#ctor"> | ||
5956 | <summary> | ||
5957 | Initializes a new instance of the <see cref="T:Newtonsoft.Json.Linq.JConstructor"/> class. | ||
5958 | </summary> | ||
5959 | </member> | ||
5960 | <member name="M:Newtonsoft.Json.Linq.JConstructor.#ctor(Newtonsoft.Json.Linq.JConstructor)"> | ||
5961 | <summary> | ||
5962 | Initializes a new instance of the <see cref="T:Newtonsoft.Json.Linq.JConstructor"/> class from another <see cref="T:Newtonsoft.Json.Linq.JConstructor"/> object. | ||
5963 | </summary> | ||
5964 | <param name="other">A <see cref="T:Newtonsoft.Json.Linq.JConstructor"/> object to copy from.</param> | ||
5965 | </member> | ||
5966 | <member name="M:Newtonsoft.Json.Linq.JConstructor.#ctor(System.String,System.Object[])"> | ||
5967 | <summary> | ||
5968 | Initializes a new instance of the <see cref="T:Newtonsoft.Json.Linq.JConstructor"/> class with the specified name and content. | ||
5969 | </summary> | ||
5970 | <param name="name">The constructor name.</param> | ||
5971 | <param name="content">The contents of the constructor.</param> | ||
5972 | </member> | ||
5973 | <member name="M:Newtonsoft.Json.Linq.JConstructor.#ctor(System.String,System.Object)"> | ||
5974 | <summary> | ||
5975 | Initializes a new instance of the <see cref="T:Newtonsoft.Json.Linq.JConstructor"/> class with the specified name and content. | ||
5976 | </summary> | ||
5977 | <param name="name">The constructor name.</param> | ||
5978 | <param name="content">The contents of the constructor.</param> | ||
5979 | </member> | ||
5980 | <member name="M:Newtonsoft.Json.Linq.JConstructor.#ctor(System.String)"> | ||
5981 | <summary> | ||
5982 | Initializes a new instance of the <see cref="T:Newtonsoft.Json.Linq.JConstructor"/> class with the specified name. | ||
5983 | </summary> | ||
5984 | <param name="name">The constructor name.</param> | ||
5985 | </member> | ||
5986 | <member name="M:Newtonsoft.Json.Linq.JConstructor.WriteTo(Newtonsoft.Json.JsonWriter,Newtonsoft.Json.JsonConverter[])"> | ||
5987 | <summary> | ||
5988 | Writes this token to a <see cref="T:Newtonsoft.Json.JsonWriter"/>. | ||
5989 | </summary> | ||
5990 | <param name="writer">A <see cref="T:Newtonsoft.Json.JsonWriter"/> into which this method will write.</param> | ||
5991 | <param name="converters">A collection of <see cref="T:Newtonsoft.Json.JsonConverter"/> which will be used when writing the token.</param> | ||
5992 | </member> | ||
5993 | <member name="M:Newtonsoft.Json.Linq.JConstructor.Load(Newtonsoft.Json.JsonReader)"> | ||
5994 | <summary> | ||
5995 | Loads an <see cref="T:Newtonsoft.Json.Linq.JConstructor"/> from a <see cref="T:Newtonsoft.Json.JsonReader"/>. | ||
5996 | </summary> | ||
5997 | <param name="reader">A <see cref="T:Newtonsoft.Json.JsonReader"/> that will be read for the content of the <see cref="T:Newtonsoft.Json.Linq.JConstructor"/>.</param> | ||
5998 | <returns>A <see cref="T:Newtonsoft.Json.Linq.JConstructor"/> that contains the JSON that was read from the specified <see cref="T:Newtonsoft.Json.JsonReader"/>.</returns> | ||
5999 | </member> | ||
6000 | <member name="P:Newtonsoft.Json.Linq.JConstructor.ChildrenTokens"> | ||
6001 | <summary> | ||
6002 | Gets the container's children tokens. | ||
6003 | </summary> | ||
6004 | <value>The container's children tokens.</value> | ||
6005 | </member> | ||
6006 | <member name="P:Newtonsoft.Json.Linq.JConstructor.Name"> | ||
6007 | <summary> | ||
6008 | Gets or sets the name of this constructor. | ||
6009 | </summary> | ||
6010 | <value>The constructor name.</value> | ||
6011 | </member> | ||
6012 | <member name="P:Newtonsoft.Json.Linq.JConstructor.Type"> | ||
6013 | <summary> | ||
6014 | Gets the node type for this <see cref="T:Newtonsoft.Json.Linq.JToken"/>. | ||
6015 | </summary> | ||
6016 | <value>The type.</value> | ||
6017 | </member> | ||
6018 | <member name="P:Newtonsoft.Json.Linq.JConstructor.Item(System.Object)"> | ||
6019 | <summary> | ||
6020 | Gets the <see cref="T:Newtonsoft.Json.Linq.JToken"/> with the specified key. | ||
6021 | </summary> | ||
6022 | <value>The <see cref="T:Newtonsoft.Json.Linq.JToken"/> with the specified key.</value> | ||
6023 | </member> | ||
6024 | <member name="T:Newtonsoft.Json.Linq.JEnumerable`1"> | ||
6025 | <summary> | ||
6026 | Represents a collection of <see cref="T:Newtonsoft.Json.Linq.JToken"/> objects. | ||
6027 | </summary> | ||
6028 | <typeparam name="T">The type of token</typeparam> | ||
6029 | </member> | ||
6030 | <member name="F:Newtonsoft.Json.Linq.JEnumerable`1.Empty"> | ||
6031 | <summary> | ||
6032 | An empty collection of <see cref="T:Newtonsoft.Json.Linq.JToken"/> objects. | ||
6033 | </summary> | ||
6034 | </member> | ||
6035 | <member name="M:Newtonsoft.Json.Linq.JEnumerable`1.#ctor(System.Collections.Generic.IEnumerable{`0})"> | ||
6036 | <summary> | ||
6037 | Initializes a new instance of the <see cref="T:Newtonsoft.Json.Linq.JEnumerable`1"/> struct. | ||
6038 | </summary> | ||
6039 | <param name="enumerable">The enumerable.</param> | ||
6040 | </member> | ||
6041 | <member name="M:Newtonsoft.Json.Linq.JEnumerable`1.GetEnumerator"> | ||
6042 | <summary> | ||
6043 | Returns an enumerator that iterates through the collection. | ||
6044 | </summary> | ||
6045 | <returns> | ||
6046 | A <see cref="T:System.Collections.Generic.IEnumerator`1"/> that can be used to iterate through the collection. | ||
6047 | </returns> | ||
6048 | </member> | ||
6049 | <member name="M:Newtonsoft.Json.Linq.JEnumerable`1.System#Collections#IEnumerable#GetEnumerator"> | ||
6050 | <summary> | ||
6051 | Returns an enumerator that iterates through a collection. | ||
6052 | </summary> | ||
6053 | <returns> | ||
6054 | An <see cref="T:System.Collections.IEnumerator"/> object that can be used to iterate through the collection. | ||
6055 | </returns> | ||
6056 | </member> | ||
6057 | <member name="M:Newtonsoft.Json.Linq.JEnumerable`1.Equals(Newtonsoft.Json.Linq.JEnumerable{`0})"> | ||
6058 | <summary> | ||
6059 | Determines whether the specified <see cref="T:Newtonsoft.Json.Linq.JEnumerable`1"/> is equal to this instance. | ||
6060 | </summary> | ||
6061 | <param name="other">The <see cref="T:Newtonsoft.Json.Linq.JEnumerable`1"/> to compare with this instance.</param> | ||
6062 | <returns> | ||
6063 | <c>true</c> if the specified <see cref="T:Newtonsoft.Json.Linq.JEnumerable`1"/> is equal to this instance; otherwise, <c>false</c>. | ||
6064 | </returns> | ||
6065 | </member> | ||
6066 | <member name="M:Newtonsoft.Json.Linq.JEnumerable`1.Equals(System.Object)"> | ||
6067 | <summary> | ||
6068 | Determines whether the specified <see cref="T:System.Object"/> is equal to this instance. | ||
6069 | </summary> | ||
6070 | <param name="obj">The <see cref="T:System.Object"/> to compare with this instance.</param> | ||
6071 | <returns> | ||
6072 | <c>true</c> if the specified <see cref="T:System.Object"/> is equal to this instance; otherwise, <c>false</c>. | ||
6073 | </returns> | ||
6074 | </member> | ||
6075 | <member name="M:Newtonsoft.Json.Linq.JEnumerable`1.GetHashCode"> | ||
6076 | <summary> | ||
6077 | Returns a hash code for this instance. | ||
6078 | </summary> | ||
6079 | <returns> | ||
6080 | A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. | ||
6081 | </returns> | ||
6082 | </member> | ||
6083 | <member name="P:Newtonsoft.Json.Linq.JEnumerable`1.Item(System.Object)"> | ||
6084 | <summary> | ||
6085 | Gets the <see cref="T:Newtonsoft.Json.Linq.IJEnumerable`1"/> with the specified key. | ||
6086 | </summary> | ||
6087 | <value></value> | ||
6088 | </member> | ||
6089 | <member name="T:Newtonsoft.Json.Linq.JObject"> | ||
6090 | <summary> | ||
6091 | Represents a JSON object. | ||
6092 | </summary> | ||
6093 | <example> | ||
6094 | <code lang="cs" source="..\Src\Newtonsoft.Json.Tests\Documentation\LinqToJsonTests.cs" region="LinqToJsonCreateParse" title="Parsing a JSON Object from Text" /> | ||
6095 | </example> | ||
6096 | </member> | ||
6097 | <member name="M:Newtonsoft.Json.Linq.JObject.#ctor"> | ||
6098 | <summary> | ||
6099 | Initializes a new instance of the <see cref="T:Newtonsoft.Json.Linq.JObject"/> class. | ||
6100 | </summary> | ||
6101 | </member> | ||
6102 | <member name="M:Newtonsoft.Json.Linq.JObject.#ctor(Newtonsoft.Json.Linq.JObject)"> | ||
6103 | <summary> | ||
6104 | Initializes a new instance of the <see cref="T:Newtonsoft.Json.Linq.JObject"/> class from another <see cref="T:Newtonsoft.Json.Linq.JObject"/> object. | ||
6105 | </summary> | ||
6106 | <param name="other">A <see cref="T:Newtonsoft.Json.Linq.JObject"/> object to copy from.</param> | ||
6107 | </member> | ||
6108 | <member name="M:Newtonsoft.Json.Linq.JObject.#ctor(System.Object[])"> | ||
6109 | <summary> | ||
6110 | Initializes a new instance of the <see cref="T:Newtonsoft.Json.Linq.JObject"/> class with the specified content. | ||
6111 | </summary> | ||
6112 | <param name="content">The contents of the object.</param> | ||
6113 | </member> | ||
6114 | <member name="M:Newtonsoft.Json.Linq.JObject.#ctor(System.Object)"> | ||
6115 | <summary> | ||
6116 | Initializes a new instance of the <see cref="T:Newtonsoft.Json.Linq.JObject"/> class with the specified content. | ||
6117 | </summary> | ||
6118 | <param name="content">The contents of the object.</param> | ||
6119 | </member> | ||
6120 | <member name="M:Newtonsoft.Json.Linq.JObject.Properties"> | ||
6121 | <summary> | ||
6122 | Gets an <see cref="T:System.Collections.Generic.IEnumerable`1"/> of this object's properties. | ||
6123 | </summary> | ||
6124 | <returns>An <see cref="T:System.Collections.Generic.IEnumerable`1"/> of this object's properties.</returns> | ||
6125 | </member> | ||
6126 | <member name="M:Newtonsoft.Json.Linq.JObject.Property(System.String)"> | ||
6127 | <summary> | ||
6128 | Gets a <see cref="T:Newtonsoft.Json.Linq.JProperty"/> the specified name. | ||
6129 | </summary> | ||
6130 | <param name="name">The property name.</param> | ||
6131 | <returns>A <see cref="T:Newtonsoft.Json.Linq.JProperty"/> with the specified name or null.</returns> | ||
6132 | </member> | ||
6133 | <member name="M:Newtonsoft.Json.Linq.JObject.PropertyValues"> | ||
6134 | <summary> | ||
6135 | Gets an <see cref="T:Newtonsoft.Json.Linq.JEnumerable`1"/> of this object's property values. | ||
6136 | </summary> | ||
6137 | <returns>An <see cref="T:Newtonsoft.Json.Linq.JEnumerable`1"/> of this object's property values.</returns> | ||
6138 | </member> | ||
6139 | <member name="M:Newtonsoft.Json.Linq.JObject.Load(Newtonsoft.Json.JsonReader)"> | ||
6140 | <summary> | ||
6141 | Loads an <see cref="T:Newtonsoft.Json.Linq.JObject"/> from a <see cref="T:Newtonsoft.Json.JsonReader"/>. | ||
6142 | </summary> | ||
6143 | <param name="reader">A <see cref="T:Newtonsoft.Json.JsonReader"/> that will be read for the content of the <see cref="T:Newtonsoft.Json.Linq.JObject"/>.</param> | ||
6144 | <returns>A <see cref="T:Newtonsoft.Json.Linq.JObject"/> that contains the JSON that was read from the specified <see cref="T:Newtonsoft.Json.JsonReader"/>.</returns> | ||
6145 | </member> | ||
6146 | <member name="M:Newtonsoft.Json.Linq.JObject.Parse(System.String)"> | ||
6147 | <summary> | ||
6148 | Load a <see cref="T:Newtonsoft.Json.Linq.JObject"/> from a string that contains JSON. | ||
6149 | </summary> | ||
6150 | <param name="json">A <see cref="T:System.String"/> that contains JSON.</param> | ||
6151 | <returns>A <see cref="T:Newtonsoft.Json.Linq.JObject"/> populated from the string that contains JSON.</returns> | ||
6152 | <example> | ||
6153 | <code lang="cs" source="..\Src\Newtonsoft.Json.Tests\Documentation\LinqToJsonTests.cs" region="LinqToJsonCreateParse" title="Parsing a JSON Object from Text"/> | ||
6154 | </example> | ||
6155 | </member> | ||
6156 | <member name="M:Newtonsoft.Json.Linq.JObject.FromObject(System.Object)"> | ||
6157 | <summary> | ||
6158 | Creates a <see cref="T:Newtonsoft.Json.Linq.JObject"/> from an object. | ||
6159 | </summary> | ||
6160 | <param name="o">The object that will be used to create <see cref="T:Newtonsoft.Json.Linq.JObject"/>.</param> | ||
6161 | <returns>A <see cref="T:Newtonsoft.Json.Linq.JObject"/> with the values of the specified object</returns> | ||
6162 | </member> | ||
6163 | <member name="M:Newtonsoft.Json.Linq.JObject.FromObject(System.Object,Newtonsoft.Json.JsonSerializer)"> | ||
6164 | <summary> | ||
6165 | Creates a <see cref="T:Newtonsoft.Json.Linq.JObject"/> from an object. | ||
6166 | </summary> | ||
6167 | <param name="o">The object that will be used to create <see cref="T:Newtonsoft.Json.Linq.JObject"/>.</param> | ||
6168 | <param name="jsonSerializer">The <see cref="T:Newtonsoft.Json.JsonSerializer"/> that will be used to read the object.</param> | ||
6169 | <returns>A <see cref="T:Newtonsoft.Json.Linq.JObject"/> with the values of the specified object</returns> | ||
6170 | </member> | ||
6171 | <member name="M:Newtonsoft.Json.Linq.JObject.WriteTo(Newtonsoft.Json.JsonWriter,Newtonsoft.Json.JsonConverter[])"> | ||
6172 | <summary> | ||
6173 | Writes this token to a <see cref="T:Newtonsoft.Json.JsonWriter"/>. | ||
6174 | </summary> | ||
6175 | <param name="writer">A <see cref="T:Newtonsoft.Json.JsonWriter"/> into which this method will write.</param> | ||
6176 | <param name="converters">A collection of <see cref="T:Newtonsoft.Json.JsonConverter"/> which will be used when writing the token.</param> | ||
6177 | </member> | ||
6178 | <member name="M:Newtonsoft.Json.Linq.JObject.GetValue(System.String)"> | ||
6179 | <summary> | ||
6180 | Gets the <see cref="T:Newtonsoft.Json.Linq.JToken"/> with the specified property name. | ||
6181 | </summary> | ||
6182 | <param name="propertyName">Name of the property.</param> | ||
6183 | <returns>The <see cref="T:Newtonsoft.Json.Linq.JToken"/> with the specified property name.</returns> | ||
6184 | </member> | ||
6185 | <member name="M:Newtonsoft.Json.Linq.JObject.GetValue(System.String,System.StringComparison)"> | ||
6186 | <summary> | ||
6187 | Gets the <see cref="T:Newtonsoft.Json.Linq.JToken"/> with the specified property name. | ||
6188 | The exact property name will be searched for first and if no matching property is found then | ||
6189 | the <see cref="T:System.StringComparison"/> will be used to match a property. | ||
6190 | </summary> | ||
6191 | <param name="propertyName">Name of the property.</param> | ||
6192 | <param name="comparison">One of the enumeration values that specifies how the strings will be compared.</param> | ||
6193 | <returns>The <see cref="T:Newtonsoft.Json.Linq.JToken"/> with the specified property name.</returns> | ||
6194 | </member> | ||
6195 | <member name="M:Newtonsoft.Json.Linq.JObject.TryGetValue(System.String,System.StringComparison,Newtonsoft.Json.Linq.JToken@)"> | ||
6196 | <summary> | ||
6197 | Tries to get the <see cref="T:Newtonsoft.Json.Linq.JToken"/> with the specified property name. | ||
6198 | The exact property name will be searched for first and if no matching property is found then | ||
6199 | the <see cref="T:System.StringComparison"/> will be used to match a property. | ||
6200 | </summary> | ||
6201 | <param name="propertyName">Name of the property.</param> | ||
6202 | <param name="value">The value.</param> | ||
6203 | <param name="comparison">One of the enumeration values that specifies how the strings will be compared.</param> | ||
6204 | <returns>true if a value was successfully retrieved; otherwise, false.</returns> | ||
6205 | </member> | ||
6206 | <member name="M:Newtonsoft.Json.Linq.JObject.Add(System.String,Newtonsoft.Json.Linq.JToken)"> | ||
6207 | <summary> | ||
6208 | Adds the specified property name. | ||
6209 | </summary> | ||
6210 | <param name="propertyName">Name of the property.</param> | ||
6211 | <param name="value">The value.</param> | ||
6212 | </member> | ||
6213 | <member name="M:Newtonsoft.Json.Linq.JObject.Remove(System.String)"> | ||
6214 | <summary> | ||
6215 | Removes the property with the specified name. | ||
6216 | </summary> | ||
6217 | <param name="propertyName">Name of the property.</param> | ||
6218 | <returns>true if item was successfully removed; otherwise, false.</returns> | ||
6219 | </member> | ||
6220 | <member name="M:Newtonsoft.Json.Linq.JObject.TryGetValue(System.String,Newtonsoft.Json.Linq.JToken@)"> | ||
6221 | <summary> | ||
6222 | Tries the get value. | ||
6223 | </summary> | ||
6224 | <param name="propertyName">Name of the property.</param> | ||
6225 | <param name="value">The value.</param> | ||
6226 | <returns>true if a value was successfully retrieved; otherwise, false.</returns> | ||
6227 | </member> | ||
6228 | <member name="M:Newtonsoft.Json.Linq.JObject.GetEnumerator"> | ||
6229 | <summary> | ||
6230 | Returns an enumerator that iterates through the collection. | ||
6231 | </summary> | ||
6232 | <returns> | ||
6233 | A <see cref="T:System.Collections.Generic.IEnumerator`1"/> that can be used to iterate through the collection. | ||
6234 | </returns> | ||
6235 | </member> | ||
6236 | <member name="M:Newtonsoft.Json.Linq.JObject.OnPropertyChanged(System.String)"> | ||
6237 | <summary> | ||
6238 | Raises the <see cref="E:Newtonsoft.Json.Linq.JObject.PropertyChanged"/> event with the provided arguments. | ||
6239 | </summary> | ||
6240 | <param name="propertyName">Name of the property.</param> | ||
6241 | </member> | ||
6242 | <member name="M:Newtonsoft.Json.Linq.JObject.OnPropertyChanging(System.String)"> | ||
6243 | <summary> | ||
6244 | Raises the <see cref="E:Newtonsoft.Json.Linq.JObject.PropertyChanging"/> event with the provided arguments. | ||
6245 | </summary> | ||
6246 | <param name="propertyName">Name of the property.</param> | ||
6247 | </member> | ||
6248 | <member name="M:Newtonsoft.Json.Linq.JObject.System#ComponentModel#ICustomTypeDescriptor#GetProperties"> | ||
6249 | <summary> | ||
6250 | Returns the properties for this instance of a component. | ||
6251 | </summary> | ||
6252 | <returns> | ||
6253 | A <see cref="T:System.ComponentModel.PropertyDescriptorCollection"/> that represents the properties for this component instance. | ||
6254 | </returns> | ||
6255 | </member> | ||
6256 | <member name="M:Newtonsoft.Json.Linq.JObject.System#ComponentModel#ICustomTypeDescriptor#GetProperties(System.Attribute[])"> | ||
6257 | <summary> | ||
6258 | Returns the properties for this instance of a component using the attribute array as a filter. | ||
6259 | </summary> | ||
6260 | <param name="attributes">An array of type <see cref="T:System.Attribute"/> that is used as a filter.</param> | ||
6261 | <returns> | ||
6262 | A <see cref="T:System.ComponentModel.PropertyDescriptorCollection"/> that represents the filtered properties for this component instance. | ||
6263 | </returns> | ||
6264 | </member> | ||
6265 | <member name="M:Newtonsoft.Json.Linq.JObject.System#ComponentModel#ICustomTypeDescriptor#GetAttributes"> | ||
6266 | <summary> | ||
6267 | Returns a collection of custom attributes for this instance of a component. | ||
6268 | </summary> | ||
6269 | <returns> | ||
6270 | An <see cref="T:System.ComponentModel.AttributeCollection"/> containing the attributes for this object. | ||
6271 | </returns> | ||
6272 | </member> | ||
6273 | <member name="M:Newtonsoft.Json.Linq.JObject.System#ComponentModel#ICustomTypeDescriptor#GetClassName"> | ||
6274 | <summary> | ||
6275 | Returns the class name of this instance of a component. | ||
6276 | </summary> | ||
6277 | <returns> | ||
6278 | The class name of the object, or null if the class does not have a name. | ||
6279 | </returns> | ||
6280 | </member> | ||
6281 | <member name="M:Newtonsoft.Json.Linq.JObject.System#ComponentModel#ICustomTypeDescriptor#GetComponentName"> | ||
6282 | <summary> | ||
6283 | Returns the name of this instance of a component. | ||
6284 | </summary> | ||
6285 | <returns> | ||
6286 | The name of the object, or null if the object does not have a name. | ||
6287 | </returns> | ||
6288 | </member> | ||
6289 | <member name="M:Newtonsoft.Json.Linq.JObject.System#ComponentModel#ICustomTypeDescriptor#GetConverter"> | ||
6290 | <summary> | ||
6291 | Returns a type converter for this instance of a component. | ||
6292 | </summary> | ||
6293 | <returns> | ||
6294 | A <see cref="T:System.ComponentModel.TypeConverter"/> that is the converter for this object, or null if there is no <see cref="T:System.ComponentModel.TypeConverter"/> for this object. | ||
6295 | </returns> | ||
6296 | </member> | ||
6297 | <member name="M:Newtonsoft.Json.Linq.JObject.System#ComponentModel#ICustomTypeDescriptor#GetDefaultEvent"> | ||
6298 | <summary> | ||
6299 | Returns the default event for this instance of a component. | ||
6300 | </summary> | ||
6301 | <returns> | ||
6302 | An <see cref="T:System.ComponentModel.EventDescriptor"/> that represents the default event for this object, or null if this object does not have events. | ||
6303 | </returns> | ||
6304 | </member> | ||
6305 | <member name="M:Newtonsoft.Json.Linq.JObject.System#ComponentModel#ICustomTypeDescriptor#GetDefaultProperty"> | ||
6306 | <summary> | ||
6307 | Returns the default property for this instance of a component. | ||
6308 | </summary> | ||
6309 | <returns> | ||
6310 | A <see cref="T:System.ComponentModel.PropertyDescriptor"/> that represents the default property for this object, or null if this object does not have properties. | ||
6311 | </returns> | ||
6312 | </member> | ||
6313 | <member name="M:Newtonsoft.Json.Linq.JObject.System#ComponentModel#ICustomTypeDescriptor#GetEditor(System.Type)"> | ||
6314 | <summary> | ||
6315 | Returns an editor of the specified type for this instance of a component. | ||
6316 | </summary> | ||
6317 | <param name="editorBaseType">A <see cref="T:System.Type"/> that represents the editor for this object.</param> | ||
6318 | <returns> | ||
6319 | An <see cref="T:System.Object"/> of the specified type that is the editor for this object, or null if the editor cannot be found. | ||
6320 | </returns> | ||
6321 | </member> | ||
6322 | <member name="M:Newtonsoft.Json.Linq.JObject.System#ComponentModel#ICustomTypeDescriptor#GetEvents(System.Attribute[])"> | ||
6323 | <summary> | ||
6324 | Returns the events for this instance of a component using the specified attribute array as a filter. | ||
6325 | </summary> | ||
6326 | <param name="attributes">An array of type <see cref="T:System.Attribute"/> that is used as a filter.</param> | ||
6327 | <returns> | ||
6328 | An <see cref="T:System.ComponentModel.EventDescriptorCollection"/> that represents the filtered events for this component instance. | ||
6329 | </returns> | ||
6330 | </member> | ||
6331 | <member name="M:Newtonsoft.Json.Linq.JObject.System#ComponentModel#ICustomTypeDescriptor#GetEvents"> | ||
6332 | <summary> | ||
6333 | Returns the events for this instance of a component. | ||
6334 | </summary> | ||
6335 | <returns> | ||
6336 | An <see cref="T:System.ComponentModel.EventDescriptorCollection"/> that represents the events for this component instance. | ||
6337 | </returns> | ||
6338 | </member> | ||
6339 | <member name="M:Newtonsoft.Json.Linq.JObject.System#ComponentModel#ICustomTypeDescriptor#GetPropertyOwner(System.ComponentModel.PropertyDescriptor)"> | ||
6340 | <summary> | ||
6341 | Returns an object that contains the property described by the specified property descriptor. | ||
6342 | </summary> | ||
6343 | <param name="pd">A <see cref="T:System.ComponentModel.PropertyDescriptor"/> that represents the property whose owner is to be found.</param> | ||
6344 | <returns> | ||
6345 | An <see cref="T:System.Object"/> that represents the owner of the specified property. | ||
6346 | </returns> | ||
6347 | </member> | ||
6348 | <member name="M:Newtonsoft.Json.Linq.JObject.GetMetaObject(System.Linq.Expressions.Expression)"> | ||
6349 | <summary> | ||
6350 | Returns the <see cref="T:System.Dynamic.DynamicMetaObject"/> responsible for binding operations performed on this object. | ||
6351 | </summary> | ||
6352 | <param name="parameter">The expression tree representation of the runtime value.</param> | ||
6353 | <returns> | ||
6354 | The <see cref="T:System.Dynamic.DynamicMetaObject"/> to bind this object. | ||
6355 | </returns> | ||
6356 | </member> | ||
6357 | <member name="P:Newtonsoft.Json.Linq.JObject.ChildrenTokens"> | ||
6358 | <summary> | ||
6359 | Gets the container's children tokens. | ||
6360 | </summary> | ||
6361 | <value>The container's children tokens.</value> | ||
6362 | </member> | ||
6363 | <member name="E:Newtonsoft.Json.Linq.JObject.PropertyChanged"> | ||
6364 | <summary> | ||
6365 | Occurs when a property value changes. | ||
6366 | </summary> | ||
6367 | </member> | ||
6368 | <member name="E:Newtonsoft.Json.Linq.JObject.PropertyChanging"> | ||
6369 | <summary> | ||
6370 | Occurs when a property value is changing. | ||
6371 | </summary> | ||
6372 | </member> | ||
6373 | <member name="P:Newtonsoft.Json.Linq.JObject.Type"> | ||
6374 | <summary> | ||
6375 | Gets the node type for this <see cref="T:Newtonsoft.Json.Linq.JToken"/>. | ||
6376 | </summary> | ||
6377 | <value>The type.</value> | ||
6378 | </member> | ||
6379 | <member name="P:Newtonsoft.Json.Linq.JObject.Item(System.Object)"> | ||
6380 | <summary> | ||
6381 | Gets the <see cref="T:Newtonsoft.Json.Linq.JToken"/> with the specified key. | ||
6382 | </summary> | ||
6383 | <value>The <see cref="T:Newtonsoft.Json.Linq.JToken"/> with the specified key.</value> | ||
6384 | </member> | ||
6385 | <member name="P:Newtonsoft.Json.Linq.JObject.Item(System.String)"> | ||
6386 | <summary> | ||
6387 | Gets or sets the <see cref="T:Newtonsoft.Json.Linq.JToken"/> with the specified property name. | ||
6388 | </summary> | ||
6389 | <value></value> | ||
6390 | </member> | ||
6391 | <member name="T:Newtonsoft.Json.Linq.JArray"> | ||
6392 | <summary> | ||
6393 | Represents a JSON array. | ||
6394 | </summary> | ||
6395 | <example> | ||
6396 | <code lang="cs" source="..\Src\Newtonsoft.Json.Tests\Documentation\LinqToJsonTests.cs" region="LinqToJsonCreateParseArray" title="Parsing a JSON Array from Text" /> | ||
6397 | </example> | ||
6398 | </member> | ||
6399 | <member name="M:Newtonsoft.Json.Linq.JArray.#ctor"> | ||
6400 | <summary> | ||
6401 | Initializes a new instance of the <see cref="T:Newtonsoft.Json.Linq.JArray"/> class. | ||
6402 | </summary> | ||
6403 | </member> | ||
6404 | <member name="M:Newtonsoft.Json.Linq.JArray.#ctor(Newtonsoft.Json.Linq.JArray)"> | ||
6405 | <summary> | ||
6406 | Initializes a new instance of the <see cref="T:Newtonsoft.Json.Linq.JArray"/> class from another <see cref="T:Newtonsoft.Json.Linq.JArray"/> object. | ||
6407 | </summary> | ||
6408 | <param name="other">A <see cref="T:Newtonsoft.Json.Linq.JArray"/> object to copy from.</param> | ||
6409 | </member> | ||
6410 | <member name="M:Newtonsoft.Json.Linq.JArray.#ctor(System.Object[])"> | ||
6411 | <summary> | ||
6412 | Initializes a new instance of the <see cref="T:Newtonsoft.Json.Linq.JArray"/> class with the specified content. | ||
6413 | </summary> | ||
6414 | <param name="content">The contents of the array.</param> | ||
6415 | </member> | ||
6416 | <member name="M:Newtonsoft.Json.Linq.JArray.#ctor(System.Object)"> | ||
6417 | <summary> | ||
6418 | Initializes a new instance of the <see cref="T:Newtonsoft.Json.Linq.JArray"/> class with the specified content. | ||
6419 | </summary> | ||
6420 | <param name="content">The contents of the array.</param> | ||
6421 | </member> | ||
6422 | <member name="M:Newtonsoft.Json.Linq.JArray.Load(Newtonsoft.Json.JsonReader)"> | ||
6423 | <summary> | ||
6424 | Loads an <see cref="T:Newtonsoft.Json.Linq.JArray"/> from a <see cref="T:Newtonsoft.Json.JsonReader"/>. | ||
6425 | </summary> | ||
6426 | <param name="reader">A <see cref="T:Newtonsoft.Json.JsonReader"/> that will be read for the content of the <see cref="T:Newtonsoft.Json.Linq.JArray"/>.</param> | ||
6427 | <returns>A <see cref="T:Newtonsoft.Json.Linq.JArray"/> that contains the JSON that was read from the specified <see cref="T:Newtonsoft.Json.JsonReader"/>.</returns> | ||
6428 | </member> | ||
6429 | <member name="M:Newtonsoft.Json.Linq.JArray.Parse(System.String)"> | ||
6430 | <summary> | ||
6431 | Load a <see cref="T:Newtonsoft.Json.Linq.JArray"/> from a string that contains JSON. | ||
6432 | </summary> | ||
6433 | <param name="json">A <see cref="T:System.String"/> that contains JSON.</param> | ||
6434 | <returns>A <see cref="T:Newtonsoft.Json.Linq.JArray"/> populated from the string that contains JSON.</returns> | ||
6435 | <example> | ||
6436 | <code lang="cs" source="..\Src\Newtonsoft.Json.Tests\Documentation\LinqToJsonTests.cs" region="LinqToJsonCreateParseArray" title="Parsing a JSON Array from Text"/> | ||
6437 | </example> | ||
6438 | </member> | ||
6439 | <member name="M:Newtonsoft.Json.Linq.JArray.FromObject(System.Object)"> | ||
6440 | <summary> | ||
6441 | Creates a <see cref="T:Newtonsoft.Json.Linq.JArray"/> from an object. | ||
6442 | </summary> | ||
6443 | <param name="o">The object that will be used to create <see cref="T:Newtonsoft.Json.Linq.JArray"/>.</param> | ||
6444 | <returns>A <see cref="T:Newtonsoft.Json.Linq.JArray"/> with the values of the specified object</returns> | ||
6445 | </member> | ||
6446 | <member name="M:Newtonsoft.Json.Linq.JArray.FromObject(System.Object,Newtonsoft.Json.JsonSerializer)"> | ||
6447 | <summary> | ||
6448 | Creates a <see cref="T:Newtonsoft.Json.Linq.JArray"/> from an object. | ||
6449 | </summary> | ||
6450 | <param name="o">The object that will be used to create <see cref="T:Newtonsoft.Json.Linq.JArray"/>.</param> | ||
6451 | <param name="jsonSerializer">The <see cref="T:Newtonsoft.Json.JsonSerializer"/> that will be used to read the object.</param> | ||
6452 | <returns>A <see cref="T:Newtonsoft.Json.Linq.JArray"/> with the values of the specified object</returns> | ||
6453 | </member> | ||
6454 | <member name="M:Newtonsoft.Json.Linq.JArray.WriteTo(Newtonsoft.Json.JsonWriter,Newtonsoft.Json.JsonConverter[])"> | ||
6455 | <summary> | ||
6456 | Writes this token to a <see cref="T:Newtonsoft.Json.JsonWriter"/>. | ||
6457 | </summary> | ||
6458 | <param name="writer">A <see cref="T:Newtonsoft.Json.JsonWriter"/> into which this method will write.</param> | ||
6459 | <param name="converters">A collection of <see cref="T:Newtonsoft.Json.JsonConverter"/> which will be used when writing the token.</param> | ||
6460 | </member> | ||
6461 | <member name="M:Newtonsoft.Json.Linq.JArray.IndexOf(Newtonsoft.Json.Linq.JToken)"> | ||
6462 | <summary> | ||
6463 | Determines the index of a specific item in the <see cref="T:System.Collections.Generic.IList`1"/>. | ||
6464 | </summary> | ||
6465 | <param name="item">The object to locate in the <see cref="T:System.Collections.Generic.IList`1"/>.</param> | ||
6466 | <returns> | ||
6467 | The index of <paramref name="item"/> if found in the list; otherwise, -1. | ||
6468 | </returns> | ||
6469 | </member> | ||
6470 | <member name="M:Newtonsoft.Json.Linq.JArray.Insert(System.Int32,Newtonsoft.Json.Linq.JToken)"> | ||
6471 | <summary> | ||
6472 | Inserts an item to the <see cref="T:System.Collections.Generic.IList`1"/> at the specified index. | ||
6473 | </summary> | ||
6474 | <param name="index">The zero-based index at which <paramref name="item"/> should be inserted.</param> | ||
6475 | <param name="item">The object to insert into the <see cref="T:System.Collections.Generic.IList`1"/>.</param> | ||
6476 | <exception cref="T:System.ArgumentOutOfRangeException"> | ||
6477 | <paramref name="index"/> is not a valid index in the <see cref="T:System.Collections.Generic.IList`1"/>.</exception> | ||
6478 | <exception cref="T:System.NotSupportedException">The <see cref="T:System.Collections.Generic.IList`1"/> is read-only.</exception> | ||
6479 | </member> | ||
6480 | <member name="M:Newtonsoft.Json.Linq.JArray.RemoveAt(System.Int32)"> | ||
6481 | <summary> | ||
6482 | Removes the <see cref="T:System.Collections.Generic.IList`1"/> item at the specified index. | ||
6483 | </summary> | ||
6484 | <param name="index">The zero-based index of the item to remove.</param> | ||
6485 | <exception cref="T:System.ArgumentOutOfRangeException"> | ||
6486 | <paramref name="index"/> is not a valid index in the <see cref="T:System.Collections.Generic.IList`1"/>.</exception> | ||
6487 | <exception cref="T:System.NotSupportedException">The <see cref="T:System.Collections.Generic.IList`1"/> is read-only.</exception> | ||
6488 | </member> | ||
6489 | <member name="M:Newtonsoft.Json.Linq.JArray.GetEnumerator"> | ||
6490 | <summary> | ||
6491 | Returns an enumerator that iterates through the collection. | ||
6492 | </summary> | ||
6493 | <returns> | ||
6494 | A <see cref="T:System.Collections.Generic.IEnumerator`1" /> that can be used to iterate through the collection. | ||
6495 | </returns> | ||
6496 | </member> | ||
6497 | <member name="M:Newtonsoft.Json.Linq.JArray.Add(Newtonsoft.Json.Linq.JToken)"> | ||
6498 | <summary> | ||
6499 | Adds an item to the <see cref="T:System.Collections.Generic.ICollection`1"/>. | ||
6500 | </summary> | ||
6501 | <param name="item">The object to add to the <see cref="T:System.Collections.Generic.ICollection`1"/>.</param> | ||
6502 | <exception cref="T:System.NotSupportedException">The <see cref="T:System.Collections.Generic.ICollection`1"/> is read-only.</exception> | ||
6503 | </member> | ||
6504 | <member name="M:Newtonsoft.Json.Linq.JArray.Clear"> | ||
6505 | <summary> | ||
6506 | Removes all items from the <see cref="T:System.Collections.Generic.ICollection`1"/>. | ||
6507 | </summary> | ||
6508 | <exception cref="T:System.NotSupportedException">The <see cref="T:System.Collections.Generic.ICollection`1"/> is read-only. </exception> | ||
6509 | </member> | ||
6510 | <member name="M:Newtonsoft.Json.Linq.JArray.Contains(Newtonsoft.Json.Linq.JToken)"> | ||
6511 | <summary> | ||
6512 | Determines whether the <see cref="T:System.Collections.Generic.ICollection`1"/> contains a specific value. | ||
6513 | </summary> | ||
6514 | <param name="item">The object to locate in the <see cref="T:System.Collections.Generic.ICollection`1"/>.</param> | ||
6515 | <returns> | ||
6516 | true if <paramref name="item"/> is found in the <see cref="T:System.Collections.Generic.ICollection`1"/>; otherwise, false. | ||
6517 | </returns> | ||
6518 | </member> | ||
6519 | <member name="M:Newtonsoft.Json.Linq.JArray.CopyTo(Newtonsoft.Json.Linq.JToken[],System.Int32)"> | ||
6520 | <summary> | ||
6521 | Copies to. | ||
6522 | </summary> | ||
6523 | <param name="array">The array.</param> | ||
6524 | <param name="arrayIndex">Index of the array.</param> | ||
6525 | </member> | ||
6526 | <member name="M:Newtonsoft.Json.Linq.JArray.Remove(Newtonsoft.Json.Linq.JToken)"> | ||
6527 | <summary> | ||
6528 | Removes the first occurrence of a specific object from the <see cref="T:System.Collections.Generic.ICollection`1"/>. | ||
6529 | </summary> | ||
6530 | <param name="item">The object to remove from the <see cref="T:System.Collections.Generic.ICollection`1"/>.</param> | ||
6531 | <returns> | ||
6532 | true if <paramref name="item"/> was successfully removed from the <see cref="T:System.Collections.Generic.ICollection`1"/>; otherwise, false. This method also returns false if <paramref name="item"/> is not found in the original <see cref="T:System.Collections.Generic.ICollection`1"/>. | ||
6533 | </returns> | ||
6534 | <exception cref="T:System.NotSupportedException">The <see cref="T:System.Collections.Generic.ICollection`1"/> is read-only.</exception> | ||
6535 | </member> | ||
6536 | <member name="P:Newtonsoft.Json.Linq.JArray.ChildrenTokens"> | ||
6537 | <summary> | ||
6538 | Gets the container's children tokens. | ||
6539 | </summary> | ||
6540 | <value>The container's children tokens.</value> | ||
6541 | </member> | ||
6542 | <member name="P:Newtonsoft.Json.Linq.JArray.Type"> | ||
6543 | <summary> | ||
6544 | Gets the node type for this <see cref="T:Newtonsoft.Json.Linq.JToken"/>. | ||
6545 | </summary> | ||
6546 | <value>The type.</value> | ||
6547 | </member> | ||
6548 | <member name="P:Newtonsoft.Json.Linq.JArray.Item(System.Object)"> | ||
6549 | <summary> | ||
6550 | Gets the <see cref="T:Newtonsoft.Json.Linq.JToken"/> with the specified key. | ||
6551 | </summary> | ||
6552 | <value>The <see cref="T:Newtonsoft.Json.Linq.JToken"/> with the specified key.</value> | ||
6553 | </member> | ||
6554 | <member name="P:Newtonsoft.Json.Linq.JArray.Item(System.Int32)"> | ||
6555 | <summary> | ||
6556 | Gets or sets the <see cref="T:Newtonsoft.Json.Linq.JToken"/> at the specified index. | ||
6557 | </summary> | ||
6558 | <value></value> | ||
6559 | </member> | ||
6560 | <member name="P:Newtonsoft.Json.Linq.JArray.IsReadOnly"> | ||
6561 | <summary> | ||
6562 | Gets a value indicating whether the <see cref="T:System.Collections.Generic.ICollection`1" /> is read-only. | ||
6563 | </summary> | ||
6564 | <returns>true if the <see cref="T:System.Collections.Generic.ICollection`1" /> is read-only; otherwise, false.</returns> | ||
6565 | </member> | ||
6566 | <member name="T:Newtonsoft.Json.Linq.JTokenReader"> | ||
6567 | <summary> | ||
6568 | Represents a reader that provides fast, non-cached, forward-only access to serialized Json data. | ||
6569 | </summary> | ||
6570 | </member> | ||
6571 | <member name="M:Newtonsoft.Json.Linq.JTokenReader.#ctor(Newtonsoft.Json.Linq.JToken)"> | ||
6572 | <summary> | ||
6573 | Initializes a new instance of the <see cref="T:Newtonsoft.Json.Linq.JTokenReader"/> class. | ||
6574 | </summary> | ||
6575 | <param name="token">The token to read from.</param> | ||
6576 | </member> | ||
6577 | <member name="M:Newtonsoft.Json.Linq.JTokenReader.ReadAsBytes"> | ||
6578 | <summary> | ||
6579 | Reads the next JSON token from the stream as a <see cref="T:Byte[]"/>. | ||
6580 | </summary> | ||
6581 | <returns> | ||
6582 | A <see cref="T:Byte[]"/> or a null reference if the next JSON token is null. This method will return <c>null</c> at the end of an array. | ||
6583 | </returns> | ||
6584 | </member> | ||
6585 | <member name="M:Newtonsoft.Json.Linq.JTokenReader.ReadAsDecimal"> | ||
6586 | <summary> | ||
6587 | Reads the next JSON token from the stream as a <see cref="T:System.Nullable`1"/>. | ||
6588 | </summary> | ||
6589 | <returns>A <see cref="T:System.Nullable`1"/>. This method will return <c>null</c> at the end of an array.</returns> | ||
6590 | </member> | ||
6591 | <member name="M:Newtonsoft.Json.Linq.JTokenReader.ReadAsInt32"> | ||
6592 | <summary> | ||
6593 | Reads the next JSON token from the stream as a <see cref="T:System.Nullable`1"/>. | ||
6594 | </summary> | ||
6595 | <returns>A <see cref="T:System.Nullable`1"/>. This method will return <c>null</c> at the end of an array.</returns> | ||
6596 | </member> | ||
6597 | <member name="M:Newtonsoft.Json.Linq.JTokenReader.ReadAsString"> | ||
6598 | <summary> | ||
6599 | Reads the next JSON token from the stream as a <see cref="T:System.String"/>. | ||
6600 | </summary> | ||
6601 | <returns>A <see cref="T:System.String"/>. This method will return <c>null</c> at the end of an array.</returns> | ||
6602 | </member> | ||
6603 | <member name="M:Newtonsoft.Json.Linq.JTokenReader.ReadAsDateTime"> | ||
6604 | <summary> | ||
6605 | Reads the next JSON token from the stream as a <see cref="T:System.Nullable`1"/>. | ||
6606 | </summary> | ||
6607 | <returns>A <see cref="T:System.String"/>. This method will return <c>null</c> at the end of an array.</returns> | ||
6608 | </member> | ||
6609 | <member name="M:Newtonsoft.Json.Linq.JTokenReader.ReadAsDateTimeOffset"> | ||
6610 | <summary> | ||
6611 | Reads the next JSON token from the stream as a <see cref="T:System.Nullable`1"/>. | ||
6612 | </summary> | ||
6613 | <returns>A <see cref="T:System.Nullable`1"/>. This method will return <c>null</c> at the end of an array.</returns> | ||
6614 | </member> | ||
6615 | <member name="M:Newtonsoft.Json.Linq.JTokenReader.Read"> | ||
6616 | <summary> | ||
6617 | Reads the next JSON token from the stream. | ||
6618 | </summary> | ||
6619 | <returns> | ||
6620 | true if the next token was read successfully; false if there are no more tokens to read. | ||
6621 | </returns> | ||
6622 | </member> | ||
6623 | <member name="P:Newtonsoft.Json.Linq.JTokenReader.Path"> | ||
6624 | <summary> | ||
6625 | Gets the path of the current JSON token. | ||
6626 | </summary> | ||
6627 | </member> | ||
6628 | <member name="T:Newtonsoft.Json.Linq.JTokenWriter"> | ||
6629 | <summary> | ||
6630 | Represents a writer that provides a fast, non-cached, forward-only way of generating Json data. | ||
6631 | </summary> | ||
6632 | </member> | ||
6633 | <member name="M:Newtonsoft.Json.Linq.JTokenWriter.#ctor(Newtonsoft.Json.Linq.JContainer)"> | ||
6634 | <summary> | ||
6635 | Initializes a new instance of the <see cref="T:Newtonsoft.Json.Linq.JTokenWriter"/> class writing to the given <see cref="T:Newtonsoft.Json.Linq.JContainer"/>. | ||
6636 | </summary> | ||
6637 | <param name="container">The container being written to.</param> | ||
6638 | </member> | ||
6639 | <member name="M:Newtonsoft.Json.Linq.JTokenWriter.#ctor"> | ||
6640 | <summary> | ||
6641 | Initializes a new instance of the <see cref="T:Newtonsoft.Json.Linq.JTokenWriter"/> class. | ||
6642 | </summary> | ||
6643 | </member> | ||
6644 | <member name="M:Newtonsoft.Json.Linq.JTokenWriter.Flush"> | ||
6645 | <summary> | ||
6646 | Flushes whatever is in the buffer to the underlying streams and also flushes the underlying stream. | ||
6647 | </summary> | ||
6648 | </member> | ||
6649 | <member name="M:Newtonsoft.Json.Linq.JTokenWriter.Close"> | ||
6650 | <summary> | ||
6651 | Closes this stream and the underlying stream. | ||
6652 | </summary> | ||
6653 | </member> | ||
6654 | <member name="M:Newtonsoft.Json.Linq.JTokenWriter.WriteStartObject"> | ||
6655 | <summary> | ||
6656 | Writes the beginning of a Json object. | ||
6657 | </summary> | ||
6658 | </member> | ||
6659 | <member name="M:Newtonsoft.Json.Linq.JTokenWriter.WriteStartArray"> | ||
6660 | <summary> | ||
6661 | Writes the beginning of a Json array. | ||
6662 | </summary> | ||
6663 | </member> | ||
6664 | <member name="M:Newtonsoft.Json.Linq.JTokenWriter.WriteStartConstructor(System.String)"> | ||
6665 | <summary> | ||
6666 | Writes the start of a constructor with the given name. | ||
6667 | </summary> | ||
6668 | <param name="name">The name of the constructor.</param> | ||
6669 | </member> | ||
6670 | <member name="M:Newtonsoft.Json.Linq.JTokenWriter.WriteEnd(Newtonsoft.Json.JsonToken)"> | ||
6671 | <summary> | ||
6672 | Writes the end. | ||
6673 | </summary> | ||
6674 | <param name="token">The token.</param> | ||
6675 | </member> | ||
6676 | <member name="M:Newtonsoft.Json.Linq.JTokenWriter.WritePropertyName(System.String)"> | ||
6677 | <summary> | ||
6678 | Writes the property name of a name/value pair on a Json object. | ||
6679 | </summary> | ||
6680 | <param name="name">The name of the property.</param> | ||
6681 | </member> | ||
6682 | <member name="M:Newtonsoft.Json.Linq.JTokenWriter.WriteValue(System.Object)"> | ||
6683 | <summary> | ||
6684 | Writes a <see cref="T:System.Object"/> value. | ||
6685 | An error will raised if the value cannot be written as a single JSON token. | ||
6686 | </summary> | ||
6687 | <param name="value">The <see cref="T:System.Object"/> value to write.</param> | ||
6688 | </member> | ||
6689 | <member name="M:Newtonsoft.Json.Linq.JTokenWriter.WriteNull"> | ||
6690 | <summary> | ||
6691 | Writes a null value. | ||
6692 | </summary> | ||
6693 | </member> | ||
6694 | <member name="M:Newtonsoft.Json.Linq.JTokenWriter.WriteUndefined"> | ||
6695 | <summary> | ||
6696 | Writes an undefined value. | ||
6697 | </summary> | ||
6698 | </member> | ||
6699 | <member name="M:Newtonsoft.Json.Linq.JTokenWriter.WriteRaw(System.String)"> | ||
6700 | <summary> | ||
6701 | Writes raw JSON. | ||
6702 | </summary> | ||
6703 | <param name="json">The raw JSON to write.</param> | ||
6704 | </member> | ||
6705 | <member name="M:Newtonsoft.Json.Linq.JTokenWriter.WriteComment(System.String)"> | ||
6706 | <summary> | ||
6707 | Writes out a comment <code>/*...*/</code> containing the specified text. | ||
6708 | </summary> | ||
6709 | <param name="text">Text to place inside the comment.</param> | ||
6710 | </member> | ||
6711 | <member name="M:Newtonsoft.Json.Linq.JTokenWriter.WriteValue(System.String)"> | ||
6712 | <summary> | ||
6713 | Writes a <see cref="T:System.String"/> value. | ||
6714 | </summary> | ||
6715 | <param name="value">The <see cref="T:System.String"/> value to write.</param> | ||
6716 | </member> | ||
6717 | <member name="M:Newtonsoft.Json.Linq.JTokenWriter.WriteValue(System.Int32)"> | ||
6718 | <summary> | ||
6719 | Writes a <see cref="T:System.Int32"/> value. | ||
6720 | </summary> | ||
6721 | <param name="value">The <see cref="T:System.Int32"/> value to write.</param> | ||
6722 | </member> | ||
6723 | <member name="M:Newtonsoft.Json.Linq.JTokenWriter.WriteValue(System.UInt32)"> | ||
6724 | <summary> | ||
6725 | Writes a <see cref="T:System.UInt32"/> value. | ||
6726 | </summary> | ||
6727 | <param name="value">The <see cref="T:System.UInt32"/> value to write.</param> | ||
6728 | </member> | ||
6729 | <member name="M:Newtonsoft.Json.Linq.JTokenWriter.WriteValue(System.Int64)"> | ||
6730 | <summary> | ||
6731 | Writes a <see cref="T:System.Int64"/> value. | ||
6732 | </summary> | ||
6733 | <param name="value">The <see cref="T:System.Int64"/> value to write.</param> | ||
6734 | </member> | ||
6735 | <member name="M:Newtonsoft.Json.Linq.JTokenWriter.WriteValue(System.UInt64)"> | ||
6736 | <summary> | ||
6737 | Writes a <see cref="T:System.UInt64"/> value. | ||
6738 | </summary> | ||
6739 | <param name="value">The <see cref="T:System.UInt64"/> value to write.</param> | ||
6740 | </member> | ||
6741 | <member name="M:Newtonsoft.Json.Linq.JTokenWriter.WriteValue(System.Single)"> | ||
6742 | <summary> | ||
6743 | Writes a <see cref="T:System.Single"/> value. | ||
6744 | </summary> | ||
6745 | <param name="value">The <see cref="T:System.Single"/> value to write.</param> | ||
6746 | </member> | ||
6747 | <member name="M:Newtonsoft.Json.Linq.JTokenWriter.WriteValue(System.Double)"> | ||
6748 | <summary> | ||
6749 | Writes a <see cref="T:System.Double"/> value. | ||
6750 | </summary> | ||
6751 | <param name="value">The <see cref="T:System.Double"/> value to write.</param> | ||
6752 | </member> | ||
6753 | <member name="M:Newtonsoft.Json.Linq.JTokenWriter.WriteValue(System.Boolean)"> | ||
6754 | <summary> | ||
6755 | Writes a <see cref="T:System.Boolean"/> value. | ||
6756 | </summary> | ||
6757 | <param name="value">The <see cref="T:System.Boolean"/> value to write.</param> | ||
6758 | </member> | ||
6759 | <member name="M:Newtonsoft.Json.Linq.JTokenWriter.WriteValue(System.Int16)"> | ||
6760 | <summary> | ||
6761 | Writes a <see cref="T:System.Int16"/> value. | ||
6762 | </summary> | ||
6763 | <param name="value">The <see cref="T:System.Int16"/> value to write.</param> | ||
6764 | </member> | ||
6765 | <member name="M:Newtonsoft.Json.Linq.JTokenWriter.WriteValue(System.UInt16)"> | ||
6766 | <summary> | ||
6767 | Writes a <see cref="T:System.UInt16"/> value. | ||
6768 | </summary> | ||
6769 | <param name="value">The <see cref="T:System.UInt16"/> value to write.</param> | ||
6770 | </member> | ||
6771 | <member name="M:Newtonsoft.Json.Linq.JTokenWriter.WriteValue(System.Char)"> | ||
6772 | <summary> | ||
6773 | Writes a <see cref="T:System.Char"/> value. | ||
6774 | </summary> | ||
6775 | <param name="value">The <see cref="T:System.Char"/> value to write.</param> | ||
6776 | </member> | ||
6777 | <member name="M:Newtonsoft.Json.Linq.JTokenWriter.WriteValue(System.Byte)"> | ||
6778 | <summary> | ||
6779 | Writes a <see cref="T:System.Byte"/> value. | ||
6780 | </summary> | ||
6781 | <param name="value">The <see cref="T:System.Byte"/> value to write.</param> | ||
6782 | </member> | ||
6783 | <member name="M:Newtonsoft.Json.Linq.JTokenWriter.WriteValue(System.SByte)"> | ||
6784 | <summary> | ||
6785 | Writes a <see cref="T:System.SByte"/> value. | ||
6786 | </summary> | ||
6787 | <param name="value">The <see cref="T:System.SByte"/> value to write.</param> | ||
6788 | </member> | ||
6789 | <member name="M:Newtonsoft.Json.Linq.JTokenWriter.WriteValue(System.Decimal)"> | ||
6790 | <summary> | ||
6791 | Writes a <see cref="T:System.Decimal"/> value. | ||
6792 | </summary> | ||
6793 | <param name="value">The <see cref="T:System.Decimal"/> value to write.</param> | ||
6794 | </member> | ||
6795 | <member name="M:Newtonsoft.Json.Linq.JTokenWriter.WriteValue(System.DateTime)"> | ||
6796 | <summary> | ||
6797 | Writes a <see cref="T:System.DateTime"/> value. | ||
6798 | </summary> | ||
6799 | <param name="value">The <see cref="T:System.DateTime"/> value to write.</param> | ||
6800 | </member> | ||
6801 | <member name="M:Newtonsoft.Json.Linq.JTokenWriter.WriteValue(System.DateTimeOffset)"> | ||
6802 | <summary> | ||
6803 | Writes a <see cref="T:System.DateTimeOffset"/> value. | ||
6804 | </summary> | ||
6805 | <param name="value">The <see cref="T:System.DateTimeOffset"/> value to write.</param> | ||
6806 | </member> | ||
6807 | <member name="M:Newtonsoft.Json.Linq.JTokenWriter.WriteValue(System.Byte[])"> | ||
6808 | <summary> | ||
6809 | Writes a <see cref="T:Byte[]"/> value. | ||
6810 | </summary> | ||
6811 | <param name="value">The <see cref="T:Byte[]"/> value to write.</param> | ||
6812 | </member> | ||
6813 | <member name="M:Newtonsoft.Json.Linq.JTokenWriter.WriteValue(System.TimeSpan)"> | ||
6814 | <summary> | ||
6815 | Writes a <see cref="T:System.TimeSpan"/> value. | ||
6816 | </summary> | ||
6817 | <param name="value">The <see cref="T:System.TimeSpan"/> value to write.</param> | ||
6818 | </member> | ||
6819 | <member name="M:Newtonsoft.Json.Linq.JTokenWriter.WriteValue(System.Guid)"> | ||
6820 | <summary> | ||
6821 | Writes a <see cref="T:System.Guid"/> value. | ||
6822 | </summary> | ||
6823 | <param name="value">The <see cref="T:System.Guid"/> value to write.</param> | ||
6824 | </member> | ||
6825 | <member name="M:Newtonsoft.Json.Linq.JTokenWriter.WriteValue(System.Uri)"> | ||
6826 | <summary> | ||
6827 | Writes a <see cref="T:System.Uri"/> value. | ||
6828 | </summary> | ||
6829 | <param name="value">The <see cref="T:System.Uri"/> value to write.</param> | ||
6830 | </member> | ||
6831 | <member name="P:Newtonsoft.Json.Linq.JTokenWriter.Token"> | ||
6832 | <summary> | ||
6833 | Gets the token being writen. | ||
6834 | </summary> | ||
6835 | <value>The token being writen.</value> | ||
6836 | </member> | ||
6837 | <member name="T:Newtonsoft.Json.Linq.JProperty"> | ||
6838 | <summary> | ||
6839 | Represents a JSON property. | ||
6840 | </summary> | ||
6841 | </member> | ||
6842 | <member name="M:Newtonsoft.Json.Linq.JProperty.#ctor(Newtonsoft.Json.Linq.JProperty)"> | ||
6843 | <summary> | ||
6844 | Initializes a new instance of the <see cref="T:Newtonsoft.Json.Linq.JProperty"/> class from another <see cref="T:Newtonsoft.Json.Linq.JProperty"/> object. | ||
6845 | </summary> | ||
6846 | <param name="other">A <see cref="T:Newtonsoft.Json.Linq.JProperty"/> object to copy from.</param> | ||
6847 | </member> | ||
6848 | <member name="M:Newtonsoft.Json.Linq.JProperty.#ctor(System.String,System.Object[])"> | ||
6849 | <summary> | ||
6850 | Initializes a new instance of the <see cref="T:Newtonsoft.Json.Linq.JProperty"/> class. | ||
6851 | </summary> | ||
6852 | <param name="name">The property name.</param> | ||
6853 | <param name="content">The property content.</param> | ||
6854 | </member> | ||
6855 | <member name="M:Newtonsoft.Json.Linq.JProperty.#ctor(System.String,System.Object)"> | ||
6856 | <summary> | ||
6857 | Initializes a new instance of the <see cref="T:Newtonsoft.Json.Linq.JProperty"/> class. | ||
6858 | </summary> | ||
6859 | <param name="name">The property name.</param> | ||
6860 | <param name="content">The property content.</param> | ||
6861 | </member> | ||
6862 | <member name="M:Newtonsoft.Json.Linq.JProperty.WriteTo(Newtonsoft.Json.JsonWriter,Newtonsoft.Json.JsonConverter[])"> | ||
6863 | <summary> | ||
6864 | Writes this token to a <see cref="T:Newtonsoft.Json.JsonWriter"/>. | ||
6865 | </summary> | ||
6866 | <param name="writer">A <see cref="T:Newtonsoft.Json.JsonWriter"/> into which this method will write.</param> | ||
6867 | <param name="converters">A collection of <see cref="T:Newtonsoft.Json.JsonConverter"/> which will be used when writing the token.</param> | ||
6868 | </member> | ||
6869 | <member name="M:Newtonsoft.Json.Linq.JProperty.Load(Newtonsoft.Json.JsonReader)"> | ||
6870 | <summary> | ||
6871 | Loads an <see cref="T:Newtonsoft.Json.Linq.JProperty"/> from a <see cref="T:Newtonsoft.Json.JsonReader"/>. | ||
6872 | </summary> | ||
6873 | <param name="reader">A <see cref="T:Newtonsoft.Json.JsonReader"/> that will be read for the content of the <see cref="T:Newtonsoft.Json.Linq.JProperty"/>.</param> | ||
6874 | <returns>A <see cref="T:Newtonsoft.Json.Linq.JProperty"/> that contains the JSON that was read from the specified <see cref="T:Newtonsoft.Json.JsonReader"/>.</returns> | ||
6875 | </member> | ||
6876 | <member name="P:Newtonsoft.Json.Linq.JProperty.ChildrenTokens"> | ||
6877 | <summary> | ||
6878 | Gets the container's children tokens. | ||
6879 | </summary> | ||
6880 | <value>The container's children tokens.</value> | ||
6881 | </member> | ||
6882 | <member name="P:Newtonsoft.Json.Linq.JProperty.Name"> | ||
6883 | <summary> | ||
6884 | Gets the property name. | ||
6885 | </summary> | ||
6886 | <value>The property name.</value> | ||
6887 | </member> | ||
6888 | <member name="P:Newtonsoft.Json.Linq.JProperty.Value"> | ||
6889 | <summary> | ||
6890 | Gets or sets the property value. | ||
6891 | </summary> | ||
6892 | <value>The property value.</value> | ||
6893 | </member> | ||
6894 | <member name="P:Newtonsoft.Json.Linq.JProperty.Type"> | ||
6895 | <summary> | ||
6896 | Gets the node type for this <see cref="T:Newtonsoft.Json.Linq.JToken"/>. | ||
6897 | </summary> | ||
6898 | <value>The type.</value> | ||
6899 | </member> | ||
6900 | <member name="T:Newtonsoft.Json.Linq.JTokenType"> | ||
6901 | <summary> | ||
6902 | Specifies the type of token. | ||
6903 | </summary> | ||
6904 | </member> | ||
6905 | <member name="F:Newtonsoft.Json.Linq.JTokenType.None"> | ||
6906 | <summary> | ||
6907 | No token type has been set. | ||
6908 | </summary> | ||
6909 | </member> | ||
6910 | <member name="F:Newtonsoft.Json.Linq.JTokenType.Object"> | ||
6911 | <summary> | ||
6912 | A JSON object. | ||
6913 | </summary> | ||
6914 | </member> | ||
6915 | <member name="F:Newtonsoft.Json.Linq.JTokenType.Array"> | ||
6916 | <summary> | ||
6917 | A JSON array. | ||
6918 | </summary> | ||
6919 | </member> | ||
6920 | <member name="F:Newtonsoft.Json.Linq.JTokenType.Constructor"> | ||
6921 | <summary> | ||
6922 | A JSON constructor. | ||
6923 | </summary> | ||
6924 | </member> | ||
6925 | <member name="F:Newtonsoft.Json.Linq.JTokenType.Property"> | ||
6926 | <summary> | ||
6927 | A JSON object property. | ||
6928 | </summary> | ||
6929 | </member> | ||
6930 | <member name="F:Newtonsoft.Json.Linq.JTokenType.Comment"> | ||
6931 | <summary> | ||
6932 | A comment. | ||
6933 | </summary> | ||
6934 | </member> | ||
6935 | <member name="F:Newtonsoft.Json.Linq.JTokenType.Integer"> | ||
6936 | <summary> | ||
6937 | An integer value. | ||
6938 | </summary> | ||
6939 | </member> | ||
6940 | <member name="F:Newtonsoft.Json.Linq.JTokenType.Float"> | ||
6941 | <summary> | ||
6942 | A float value. | ||
6943 | </summary> | ||
6944 | </member> | ||
6945 | <member name="F:Newtonsoft.Json.Linq.JTokenType.String"> | ||
6946 | <summary> | ||
6947 | A string value. | ||
6948 | </summary> | ||
6949 | </member> | ||
6950 | <member name="F:Newtonsoft.Json.Linq.JTokenType.Boolean"> | ||
6951 | <summary> | ||
6952 | A boolean value. | ||
6953 | </summary> | ||
6954 | </member> | ||
6955 | <member name="F:Newtonsoft.Json.Linq.JTokenType.Null"> | ||
6956 | <summary> | ||
6957 | A null value. | ||
6958 | </summary> | ||
6959 | </member> | ||
6960 | <member name="F:Newtonsoft.Json.Linq.JTokenType.Undefined"> | ||
6961 | <summary> | ||
6962 | An undefined value. | ||
6963 | </summary> | ||
6964 | </member> | ||
6965 | <member name="F:Newtonsoft.Json.Linq.JTokenType.Date"> | ||
6966 | <summary> | ||
6967 | A date value. | ||
6968 | </summary> | ||
6969 | </member> | ||
6970 | <member name="F:Newtonsoft.Json.Linq.JTokenType.Raw"> | ||
6971 | <summary> | ||
6972 | A raw JSON value. | ||
6973 | </summary> | ||
6974 | </member> | ||
6975 | <member name="F:Newtonsoft.Json.Linq.JTokenType.Bytes"> | ||
6976 | <summary> | ||
6977 | A collection of bytes value. | ||
6978 | </summary> | ||
6979 | </member> | ||
6980 | <member name="F:Newtonsoft.Json.Linq.JTokenType.Guid"> | ||
6981 | <summary> | ||
6982 | A Guid value. | ||
6983 | </summary> | ||
6984 | </member> | ||
6985 | <member name="F:Newtonsoft.Json.Linq.JTokenType.Uri"> | ||
6986 | <summary> | ||
6987 | A Uri value. | ||
6988 | </summary> | ||
6989 | </member> | ||
6990 | <member name="F:Newtonsoft.Json.Linq.JTokenType.TimeSpan"> | ||
6991 | <summary> | ||
6992 | A TimeSpan value. | ||
6993 | </summary> | ||
6994 | </member> | ||
6995 | <member name="T:Newtonsoft.Json.Schema.Extensions"> | ||
6996 | <summary> | ||
6997 | Contains the JSON schema extension methods. | ||
6998 | </summary> | ||
6999 | </member> | ||
7000 | <member name="M:Newtonsoft.Json.Schema.Extensions.IsValid(Newtonsoft.Json.Linq.JToken,Newtonsoft.Json.Schema.JsonSchema)"> | ||
7001 | <summary> | ||
7002 | Determines whether the <see cref="T:Newtonsoft.Json.Linq.JToken"/> is valid. | ||
7003 | </summary> | ||
7004 | <param name="source">The source <see cref="T:Newtonsoft.Json.Linq.JToken"/> to test.</param> | ||
7005 | <param name="schema">The schema to test with.</param> | ||
7006 | <returns> | ||
7007 | <c>true</c> if the specified <see cref="T:Newtonsoft.Json.Linq.JToken"/> is valid; otherwise, <c>false</c>. | ||
7008 | </returns> | ||
7009 | </member> | ||
7010 | <member name="M:Newtonsoft.Json.Schema.Extensions.IsValid(Newtonsoft.Json.Linq.JToken,Newtonsoft.Json.Schema.JsonSchema,System.Collections.Generic.IList{System.String}@)"> | ||
7011 | <summary> | ||
7012 | Determines whether the <see cref="T:Newtonsoft.Json.Linq.JToken"/> is valid. | ||
7013 | </summary> | ||
7014 | <param name="source">The source <see cref="T:Newtonsoft.Json.Linq.JToken"/> to test.</param> | ||
7015 | <param name="schema">The schema to test with.</param> | ||
7016 | <param name="errorMessages">When this method returns, contains any error messages generated while validating. </param> | ||
7017 | <returns> | ||
7018 | <c>true</c> if the specified <see cref="T:Newtonsoft.Json.Linq.JToken"/> is valid; otherwise, <c>false</c>. | ||
7019 | </returns> | ||
7020 | </member> | ||
7021 | <member name="M:Newtonsoft.Json.Schema.Extensions.Validate(Newtonsoft.Json.Linq.JToken,Newtonsoft.Json.Schema.JsonSchema)"> | ||
7022 | <summary> | ||
7023 | Validates the specified <see cref="T:Newtonsoft.Json.Linq.JToken"/>. | ||
7024 | </summary> | ||
7025 | <param name="source">The source <see cref="T:Newtonsoft.Json.Linq.JToken"/> to test.</param> | ||
7026 | <param name="schema">The schema to test with.</param> | ||
7027 | </member> | ||
7028 | <member name="M:Newtonsoft.Json.Schema.Extensions.Validate(Newtonsoft.Json.Linq.JToken,Newtonsoft.Json.Schema.JsonSchema,Newtonsoft.Json.Schema.ValidationEventHandler)"> | ||
7029 | <summary> | ||
7030 | Validates the specified <see cref="T:Newtonsoft.Json.Linq.JToken"/>. | ||
7031 | </summary> | ||
7032 | <param name="source">The source <see cref="T:Newtonsoft.Json.Linq.JToken"/> to test.</param> | ||
7033 | <param name="schema">The schema to test with.</param> | ||
7034 | <param name="validationEventHandler">The validation event handler.</param> | ||
7035 | </member> | ||
7036 | <member name="T:Newtonsoft.Json.Schema.JsonSchemaException"> | ||
7037 | <summary> | ||
7038 | Returns detailed information about the schema exception. | ||
7039 | </summary> | ||
7040 | </member> | ||
7041 | <member name="M:Newtonsoft.Json.Schema.JsonSchemaException.#ctor"> | ||
7042 | <summary> | ||
7043 | Initializes a new instance of the <see cref="T:Newtonsoft.Json.Schema.JsonSchemaException"/> class. | ||
7044 | </summary> | ||
7045 | </member> | ||
7046 | <member name="M:Newtonsoft.Json.Schema.JsonSchemaException.#ctor(System.String)"> | ||
7047 | <summary> | ||
7048 | Initializes a new instance of the <see cref="T:Newtonsoft.Json.Schema.JsonSchemaException"/> class | ||
7049 | with a specified error message. | ||
7050 | </summary> | ||
7051 | <param name="message">The error message that explains the reason for the exception.</param> | ||
7052 | </member> | ||
7053 | <member name="M:Newtonsoft.Json.Schema.JsonSchemaException.#ctor(System.String,System.Exception)"> | ||
7054 | <summary> | ||
7055 | Initializes a new instance of the <see cref="T:Newtonsoft.Json.Schema.JsonSchemaException"/> class | ||
7056 | with a specified error message and a reference to the inner exception that is the cause of this exception. | ||
7057 | </summary> | ||
7058 | <param name="message">The error message that explains the reason for the exception.</param> | ||
7059 | <param name="innerException">The exception that is the cause of the current exception, or a null reference (Nothing in Visual Basic) if no inner exception is specified.</param> | ||
7060 | </member> | ||
7061 | <member name="M:Newtonsoft.Json.Schema.JsonSchemaException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> | ||
7062 | <summary> | ||
7063 | Initializes a new instance of the <see cref="T:Newtonsoft.Json.Schema.JsonSchemaException"/> class. | ||
7064 | </summary> | ||
7065 | <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param> | ||
7066 | <param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param> | ||
7067 | <exception cref="T:System.ArgumentNullException">The <paramref name="info"/> parameter is null. </exception> | ||
7068 | <exception cref="T:System.Runtime.Serialization.SerializationException">The class name is null or <see cref="P:System.Exception.HResult"/> is zero (0). </exception> | ||
7069 | </member> | ||
7070 | <member name="P:Newtonsoft.Json.Schema.JsonSchemaException.LineNumber"> | ||
7071 | <summary> | ||
7072 | Gets the line number indicating where the error occurred. | ||
7073 | </summary> | ||
7074 | <value>The line number indicating where the error occurred.</value> | ||
7075 | </member> | ||
7076 | <member name="P:Newtonsoft.Json.Schema.JsonSchemaException.LinePosition"> | ||
7077 | <summary> | ||
7078 | Gets the line position indicating where the error occurred. | ||
7079 | </summary> | ||
7080 | <value>The line position indicating where the error occurred.</value> | ||
7081 | </member> | ||
7082 | <member name="P:Newtonsoft.Json.Schema.JsonSchemaException.Path"> | ||
7083 | <summary> | ||
7084 | Gets the path to the JSON where the error occurred. | ||
7085 | </summary> | ||
7086 | <value>The path to the JSON where the error occurred.</value> | ||
7087 | </member> | ||
7088 | <member name="T:Newtonsoft.Json.Schema.JsonSchemaResolver"> | ||
7089 | <summary> | ||
7090 | Resolves <see cref="T:Newtonsoft.Json.Schema.JsonSchema"/> from an id. | ||
7091 | </summary> | ||
7092 | </member> | ||
7093 | <member name="M:Newtonsoft.Json.Schema.JsonSchemaResolver.#ctor"> | ||
7094 | <summary> | ||
7095 | Initializes a new instance of the <see cref="T:Newtonsoft.Json.Schema.JsonSchemaResolver"/> class. | ||
7096 | </summary> | ||
7097 | </member> | ||
7098 | <member name="M:Newtonsoft.Json.Schema.JsonSchemaResolver.GetSchema(System.String)"> | ||
7099 | <summary> | ||
7100 | Gets a <see cref="T:Newtonsoft.Json.Schema.JsonSchema"/> for the specified reference. | ||
7101 | </summary> | ||
7102 | <param name="reference">The id.</param> | ||
7103 | <returns>A <see cref="T:Newtonsoft.Json.Schema.JsonSchema"/> for the specified reference.</returns> | ||
7104 | </member> | ||
7105 | <member name="P:Newtonsoft.Json.Schema.JsonSchemaResolver.LoadedSchemas"> | ||
7106 | <summary> | ||
7107 | Gets or sets the loaded schemas. | ||
7108 | </summary> | ||
7109 | <value>The loaded schemas.</value> | ||
7110 | </member> | ||
7111 | <member name="T:Newtonsoft.Json.Schema.UndefinedSchemaIdHandling"> | ||
7112 | <summary> | ||
7113 | Specifies undefined schema Id handling options for the <see cref="T:Newtonsoft.Json.Schema.JsonSchemaGenerator"/>. | ||
7114 | </summary> | ||
7115 | </member> | ||
7116 | <member name="F:Newtonsoft.Json.Schema.UndefinedSchemaIdHandling.None"> | ||
7117 | <summary> | ||
7118 | Do not infer a schema Id. | ||
7119 | </summary> | ||
7120 | </member> | ||
7121 | <member name="F:Newtonsoft.Json.Schema.UndefinedSchemaIdHandling.UseTypeName"> | ||
7122 | <summary> | ||
7123 | Use the .NET type name as the schema Id. | ||
7124 | </summary> | ||
7125 | </member> | ||
7126 | <member name="F:Newtonsoft.Json.Schema.UndefinedSchemaIdHandling.UseAssemblyQualifiedName"> | ||
7127 | <summary> | ||
7128 | Use the assembly qualified .NET type name as the schema Id. | ||
7129 | </summary> | ||
7130 | </member> | ||
7131 | <member name="T:Newtonsoft.Json.Schema.ValidationEventArgs"> | ||
7132 | <summary> | ||
7133 | Returns detailed information related to the <see cref="T:Newtonsoft.Json.Schema.ValidationEventHandler"/>. | ||
7134 | </summary> | ||
7135 | </member> | ||
7136 | <member name="P:Newtonsoft.Json.Schema.ValidationEventArgs.Exception"> | ||
7137 | <summary> | ||
7138 | Gets the <see cref="T:Newtonsoft.Json.Schema.JsonSchemaException"/> associated with the validation error. | ||
7139 | </summary> | ||
7140 | <value>The JsonSchemaException associated with the validation error.</value> | ||
7141 | </member> | ||
7142 | <member name="P:Newtonsoft.Json.Schema.ValidationEventArgs.Path"> | ||
7143 | <summary> | ||
7144 | Gets the path of the JSON location where the validation error occurred. | ||
7145 | </summary> | ||
7146 | <value>The path of the JSON location where the validation error occurred.</value> | ||
7147 | </member> | ||
7148 | <member name="P:Newtonsoft.Json.Schema.ValidationEventArgs.Message"> | ||
7149 | <summary> | ||
7150 | Gets the text description corresponding to the validation error. | ||
7151 | </summary> | ||
7152 | <value>The text description.</value> | ||
7153 | </member> | ||
7154 | <member name="T:Newtonsoft.Json.Schema.ValidationEventHandler"> | ||
7155 | <summary> | ||
7156 | Represents the callback method that will handle JSON schema validation events and the <see cref="T:Newtonsoft.Json.Schema.ValidationEventArgs"/>. | ||
7157 | </summary> | ||
7158 | </member> | ||
7159 | <member name="T:Newtonsoft.Json.Serialization.CamelCasePropertyNamesContractResolver"> | ||
7160 | <summary> | ||
7161 | Resolves member mappings for a type, camel casing property names. | ||
7162 | </summary> | ||
7163 | </member> | ||
7164 | <member name="T:Newtonsoft.Json.Serialization.DefaultContractResolver"> | ||
7165 | <summary> | ||
7166 | Used by <see cref="T:Newtonsoft.Json.JsonSerializer"/> to resolves a <see cref="T:Newtonsoft.Json.Serialization.JsonContract"/> for a given <see cref="T:System.Type"/>. | ||
7167 | </summary> | ||
7168 | </member> | ||
7169 | <member name="T:Newtonsoft.Json.Serialization.IContractResolver"> | ||
7170 | <summary> | ||
7171 | Used by <see cref="T:Newtonsoft.Json.JsonSerializer"/> to resolves a <see cref="T:Newtonsoft.Json.Serialization.JsonContract"/> for a given <see cref="T:System.Type"/>. | ||
7172 | </summary> | ||
7173 | <example> | ||
7174 | <code lang="cs" source="..\Src\Newtonsoft.Json.Tests\Documentation\SerializationTests.cs" region="ReducingSerializedJsonSizeContractResolverObject" title="IContractResolver Class"/> | ||
7175 | <code lang="cs" source="..\Src\Newtonsoft.Json.Tests\Documentation\SerializationTests.cs" region="ReducingSerializedJsonSizeContractResolverExample" title="IContractResolver Example"/> | ||
7176 | </example> | ||
7177 | </member> | ||
7178 | <member name="M:Newtonsoft.Json.Serialization.IContractResolver.ResolveContract(System.Type)"> | ||
7179 | <summary> | ||
7180 | Resolves the contract for a given type. | ||
7181 | </summary> | ||
7182 | <param name="type">The type to resolve a contract for.</param> | ||
7183 | <returns>The contract for a given type.</returns> | ||
7184 | </member> | ||
7185 | <member name="M:Newtonsoft.Json.Serialization.DefaultContractResolver.#ctor"> | ||
7186 | <summary> | ||
7187 | Initializes a new instance of the <see cref="T:Newtonsoft.Json.Serialization.DefaultContractResolver"/> class. | ||
7188 | </summary> | ||
7189 | </member> | ||
7190 | <member name="M:Newtonsoft.Json.Serialization.DefaultContractResolver.#ctor(System.Boolean)"> | ||
7191 | <summary> | ||
7192 | Initializes a new instance of the <see cref="T:Newtonsoft.Json.Serialization.DefaultContractResolver"/> class. | ||
7193 | </summary> | ||
7194 | <param name="shareCache"> | ||
7195 | If set to <c>true</c> the <see cref="T:Newtonsoft.Json.Serialization.DefaultContractResolver"/> will use a cached shared with other resolvers of the same type. | ||
7196 | Sharing the cache will significantly improve performance with multiple resolver instances because expensive reflection will only | ||
7197 | happen once. This setting can cause unexpected behavior if different instances of the resolver are suppose to produce different | ||
7198 | results. When set to false it is highly recommended to reuse <see cref="T:Newtonsoft.Json.Serialization.DefaultContractResolver"/> instances with the <see cref="T:Newtonsoft.Json.JsonSerializer"/>. | ||
7199 | </param> | ||
7200 | </member> | ||
7201 | <member name="M:Newtonsoft.Json.Serialization.DefaultContractResolver.ResolveContract(System.Type)"> | ||
7202 | <summary> | ||
7203 | Resolves the contract for a given type. | ||
7204 | </summary> | ||
7205 | <param name="type">The type to resolve a contract for.</param> | ||
7206 | <returns>The contract for a given type.</returns> | ||
7207 | </member> | ||
7208 | <member name="M:Newtonsoft.Json.Serialization.DefaultContractResolver.GetSerializableMembers(System.Type)"> | ||
7209 | <summary> | ||
7210 | Gets the serializable members for the type. | ||
7211 | </summary> | ||
7212 | <param name="objectType">The type to get serializable members for.</param> | ||
7213 | <returns>The serializable members for the type.</returns> | ||
7214 | </member> | ||
7215 | <member name="M:Newtonsoft.Json.Serialization.DefaultContractResolver.CreateObjectContract(System.Type)"> | ||
7216 | <summary> | ||
7217 | Creates a <see cref="T:Newtonsoft.Json.Serialization.JsonObjectContract"/> for the given type. | ||
7218 | </summary> | ||
7219 | <param name="objectType">Type of the object.</param> | ||
7220 | <returns>A <see cref="T:Newtonsoft.Json.Serialization.JsonObjectContract"/> for the given type.</returns> | ||
7221 | </member> | ||
7222 | <member name="M:Newtonsoft.Json.Serialization.DefaultContractResolver.CreateConstructorParameters(System.Reflection.ConstructorInfo,Newtonsoft.Json.Serialization.JsonPropertyCollection)"> | ||
7223 | <summary> | ||
7224 | Creates the constructor parameters. | ||
7225 | </summary> | ||
7226 | <param name="constructor">The constructor to create properties for.</param> | ||
7227 | <param name="memberProperties">The type's member properties.</param> | ||
7228 | <returns>Properties for the given <see cref="T:System.Reflection.ConstructorInfo"/>.</returns> | ||
7229 | </member> | ||
7230 | <member name="M:Newtonsoft.Json.Serialization.DefaultContractResolver.CreatePropertyFromConstructorParameter(Newtonsoft.Json.Serialization.JsonProperty,System.Reflection.ParameterInfo)"> | ||
7231 | <summary> | ||
7232 | Creates a <see cref="T:Newtonsoft.Json.Serialization.JsonProperty"/> for the given <see cref="T:System.Reflection.ParameterInfo"/>. | ||
7233 | </summary> | ||
7234 | <param name="matchingMemberProperty">The matching member property.</param> | ||
7235 | <param name="parameterInfo">The constructor parameter.</param> | ||
7236 | <returns>A created <see cref="T:Newtonsoft.Json.Serialization.JsonProperty"/> for the given <see cref="T:System.Reflection.ParameterInfo"/>.</returns> | ||
7237 | </member> | ||
7238 | <member name="M:Newtonsoft.Json.Serialization.DefaultContractResolver.ResolveContractConverter(System.Type)"> | ||
7239 | <summary> | ||
7240 | Resolves the default <see cref="T:Newtonsoft.Json.JsonConverter"/> for the contract. | ||
7241 | </summary> | ||
7242 | <param name="objectType">Type of the object.</param> | ||
7243 | <returns>The contract's default <see cref="T:Newtonsoft.Json.JsonConverter"/>.</returns> | ||
7244 | </member> | ||
7245 | <member name="M:Newtonsoft.Json.Serialization.DefaultContractResolver.CreateDictionaryContract(System.Type)"> | ||
7246 | <summary> | ||
7247 | Creates a <see cref="T:Newtonsoft.Json.Serialization.JsonDictionaryContract"/> for the given type. | ||
7248 | </summary> | ||
7249 | <param name="objectType">Type of the object.</param> | ||
7250 | <returns>A <see cref="T:Newtonsoft.Json.Serialization.JsonDictionaryContract"/> for the given type.</returns> | ||
7251 | </member> | ||
7252 | <member name="M:Newtonsoft.Json.Serialization.DefaultContractResolver.CreateArrayContract(System.Type)"> | ||
7253 | <summary> | ||
7254 | Creates a <see cref="T:Newtonsoft.Json.Serialization.JsonArrayContract"/> for the given type. | ||
7255 | </summary> | ||
7256 | <param name="objectType">Type of the object.</param> | ||
7257 | <returns>A <see cref="T:Newtonsoft.Json.Serialization.JsonArrayContract"/> for the given type.</returns> | ||
7258 | </member> | ||
7259 | <member name="M:Newtonsoft.Json.Serialization.DefaultContractResolver.CreatePrimitiveContract(System.Type)"> | ||
7260 | <summary> | ||
7261 | Creates a <see cref="T:Newtonsoft.Json.Serialization.JsonPrimitiveContract"/> for the given type. | ||
7262 | </summary> | ||
7263 | <param name="objectType">Type of the object.</param> | ||
7264 | <returns>A <see cref="T:Newtonsoft.Json.Serialization.JsonPrimitiveContract"/> for the given type.</returns> | ||
7265 | </member> | ||
7266 | <member name="M:Newtonsoft.Json.Serialization.DefaultContractResolver.CreateLinqContract(System.Type)"> | ||
7267 | <summary> | ||
7268 | Creates a <see cref="T:Newtonsoft.Json.Serialization.JsonLinqContract"/> for the given type. | ||
7269 | </summary> | ||
7270 | <param name="objectType">Type of the object.</param> | ||
7271 | <returns>A <see cref="T:Newtonsoft.Json.Serialization.JsonLinqContract"/> for the given type.</returns> | ||
7272 | </member> | ||
7273 | <member name="M:Newtonsoft.Json.Serialization.DefaultContractResolver.CreateISerializableContract(System.Type)"> | ||
7274 | <summary> | ||
7275 | Creates a <see cref="T:Newtonsoft.Json.Serialization.JsonISerializableContract"/> for the given type. | ||
7276 | </summary> | ||
7277 | <param name="objectType">Type of the object.</param> | ||
7278 | <returns>A <see cref="T:Newtonsoft.Json.Serialization.JsonISerializableContract"/> for the given type.</returns> | ||
7279 | </member> | ||
7280 | <member name="M:Newtonsoft.Json.Serialization.DefaultContractResolver.CreateDynamicContract(System.Type)"> | ||
7281 | <summary> | ||
7282 | Creates a <see cref="T:Newtonsoft.Json.Serialization.JsonDynamicContract"/> for the given type. | ||
7283 | </summary> | ||
7284 | <param name="objectType">Type of the object.</param> | ||
7285 | <returns>A <see cref="T:Newtonsoft.Json.Serialization.JsonDynamicContract"/> for the given type.</returns> | ||
7286 | </member> | ||
7287 | <member name="M:Newtonsoft.Json.Serialization.DefaultContractResolver.CreateStringContract(System.Type)"> | ||
7288 | <summary> | ||
7289 | Creates a <see cref="T:Newtonsoft.Json.Serialization.JsonStringContract"/> for the given type. | ||
7290 | </summary> | ||
7291 | <param name="objectType">Type of the object.</param> | ||
7292 | <returns>A <see cref="T:Newtonsoft.Json.Serialization.JsonStringContract"/> for the given type.</returns> | ||
7293 | </member> | ||
7294 | <member name="M:Newtonsoft.Json.Serialization.DefaultContractResolver.CreateContract(System.Type)"> | ||
7295 | <summary> | ||
7296 | Determines which contract type is created for the given type. | ||
7297 | </summary> | ||
7298 | <param name="objectType">Type of the object.</param> | ||
7299 | <returns>A <see cref="T:Newtonsoft.Json.Serialization.JsonContract"/> for the given type.</returns> | ||
7300 | </member> | ||
7301 | <member name="M:Newtonsoft.Json.Serialization.DefaultContractResolver.CreateProperties(System.Type,Newtonsoft.Json.MemberSerialization)"> | ||
7302 | <summary> | ||
7303 | Creates properties for the given <see cref="T:Newtonsoft.Json.Serialization.JsonContract"/>. | ||
7304 | </summary> | ||
7305 | <param name="type">The type to create properties for.</param> | ||
7306 | /// <param name="memberSerialization">The member serialization mode for the type.</param> | ||
7307 | <returns>Properties for the given <see cref="T:Newtonsoft.Json.Serialization.JsonContract"/>.</returns> | ||
7308 | </member> | ||
7309 | <member name="M:Newtonsoft.Json.Serialization.DefaultContractResolver.CreateMemberValueProvider(System.Reflection.MemberInfo)"> | ||
7310 | <summary> | ||
7311 | Creates the <see cref="T:Newtonsoft.Json.Serialization.IValueProvider"/> used by the serializer to get and set values from a member. | ||
7312 | </summary> | ||
7313 | <param name="member">The member.</param> | ||
7314 | <returns>The <see cref="T:Newtonsoft.Json.Serialization.IValueProvider"/> used by the serializer to get and set values from a member.</returns> | ||
7315 | </member> | ||
7316 | <member name="M:Newtonsoft.Json.Serialization.DefaultContractResolver.CreateProperty(System.Reflection.MemberInfo,Newtonsoft.Json.MemberSerialization)"> | ||
7317 | <summary> | ||
7318 | Creates a <see cref="T:Newtonsoft.Json.Serialization.JsonProperty"/> for the given <see cref="T:System.Reflection.MemberInfo"/>. | ||
7319 | </summary> | ||
7320 | <param name="memberSerialization">The member's parent <see cref="T:Newtonsoft.Json.MemberSerialization"/>.</param> | ||
7321 | <param name="member">The member to create a <see cref="T:Newtonsoft.Json.Serialization.JsonProperty"/> for.</param> | ||
7322 | <returns>A created <see cref="T:Newtonsoft.Json.Serialization.JsonProperty"/> for the given <see cref="T:System.Reflection.MemberInfo"/>.</returns> | ||
7323 | </member> | ||
7324 | <member name="M:Newtonsoft.Json.Serialization.DefaultContractResolver.ResolvePropertyName(System.String)"> | ||
7325 | <summary> | ||
7326 | Resolves the name of the property. | ||
7327 | </summary> | ||
7328 | <param name="propertyName">Name of the property.</param> | ||
7329 | <returns>Name of the property.</returns> | ||
7330 | </member> | ||
7331 | <member name="M:Newtonsoft.Json.Serialization.DefaultContractResolver.GetResolvedPropertyName(System.String)"> | ||
7332 | <summary> | ||
7333 | Gets the resolved name of the property. | ||
7334 | </summary> | ||
7335 | <param name="propertyName">Name of the property.</param> | ||
7336 | <returns>Name of the property.</returns> | ||
7337 | </member> | ||
7338 | <member name="P:Newtonsoft.Json.Serialization.DefaultContractResolver.DynamicCodeGeneration"> | ||
7339 | <summary> | ||
7340 | Gets a value indicating whether members are being get and set using dynamic code generation. | ||
7341 | This value is determined by the runtime permissions available. | ||
7342 | </summary> | ||
7343 | <value> | ||
7344 | <c>true</c> if using dynamic code generation; otherwise, <c>false</c>. | ||
7345 | </value> | ||
7346 | </member> | ||
7347 | <member name="P:Newtonsoft.Json.Serialization.DefaultContractResolver.DefaultMembersSearchFlags"> | ||
7348 | <summary> | ||
7349 | Gets or sets the default members search flags. | ||
7350 | </summary> | ||
7351 | <value>The default members search flags.</value> | ||
7352 | </member> | ||
7353 | <member name="P:Newtonsoft.Json.Serialization.DefaultContractResolver.SerializeCompilerGeneratedMembers"> | ||
7354 | <summary> | ||
7355 | Gets or sets a value indicating whether compiler generated members should be serialized. | ||
7356 | </summary> | ||
7357 | <value> | ||
7358 | <c>true</c> if serialized compiler generated members; otherwise, <c>false</c>. | ||
7359 | </value> | ||
7360 | </member> | ||
7361 | <member name="P:Newtonsoft.Json.Serialization.DefaultContractResolver.IgnoreSerializableInterface"> | ||
7362 | <summary> | ||
7363 | Gets or sets a value indicating whether to ignore the <see cref="T:System.Runtime.Serialization.ISerializable"/> interface when serializing and deserializing types. | ||
7364 | </summary> | ||
7365 | <value> | ||
7366 | <c>true</c> if the <see cref="T:System.Runtime.Serialization.ISerializable"/> interface will be ignored when serializing and deserializing types; otherwise, <c>false</c>. | ||
7367 | </value> | ||
7368 | </member> | ||
7369 | <member name="P:Newtonsoft.Json.Serialization.DefaultContractResolver.IgnoreSerializableAttribute"> | ||
7370 | <summary> | ||
7371 | Gets or sets a value indicating whether to ignore the <see cref="T:System.SerializableAttribute"/> attribute when serializing and deserializing types. | ||
7372 | </summary> | ||
7373 | <value> | ||
7374 | <c>true</c> if the <see cref="T:System.SerializableAttribute"/> attribute will be ignored when serializing and deserializing types; otherwise, <c>false</c>. | ||
7375 | </value> | ||
7376 | </member> | ||
7377 | <member name="M:Newtonsoft.Json.Serialization.CamelCasePropertyNamesContractResolver.#ctor"> | ||
7378 | <summary> | ||
7379 | Initializes a new instance of the <see cref="T:Newtonsoft.Json.Serialization.CamelCasePropertyNamesContractResolver"/> class. | ||
7380 | </summary> | ||
7381 | </member> | ||
7382 | <member name="M:Newtonsoft.Json.Serialization.CamelCasePropertyNamesContractResolver.ResolvePropertyName(System.String)"> | ||
7383 | <summary> | ||
7384 | Resolves the name of the property. | ||
7385 | </summary> | ||
7386 | <param name="propertyName">Name of the property.</param> | ||
7387 | <returns>The property name camel cased.</returns> | ||
7388 | </member> | ||
7389 | <member name="T:Newtonsoft.Json.Serialization.DefaultSerializationBinder"> | ||
7390 | <summary> | ||
7391 | The default serialization binder used when resolving and loading classes from type names. | ||
7392 | </summary> | ||
7393 | </member> | ||
7394 | <member name="M:Newtonsoft.Json.Serialization.DefaultSerializationBinder.BindToType(System.String,System.String)"> | ||
7395 | <summary> | ||
7396 | When overridden in a derived class, controls the binding of a serialized object to a type. | ||
7397 | </summary> | ||
7398 | <param name="assemblyName">Specifies the <see cref="T:System.Reflection.Assembly"/> name of the serialized object.</param> | ||
7399 | <param name="typeName">Specifies the <see cref="T:System.Type"/> name of the serialized object.</param> | ||
7400 | <returns> | ||
7401 | The type of the object the formatter creates a new instance of. | ||
7402 | </returns> | ||
7403 | </member> | ||
7404 | <member name="M:Newtonsoft.Json.Serialization.DefaultSerializationBinder.BindToName(System.Type,System.String@,System.String@)"> | ||
7405 | <summary> | ||
7406 | When overridden in a derived class, controls the binding of a serialized object to a type. | ||
7407 | </summary> | ||
7408 | <param name="serializedType">The type of the object the formatter creates a new instance of.</param> | ||
7409 | <param name="assemblyName">Specifies the <see cref="T:System.Reflection.Assembly"/> name of the serialized object. </param> | ||
7410 | <param name="typeName">Specifies the <see cref="T:System.Type"/> name of the serialized object. </param> | ||
7411 | </member> | ||
7412 | <member name="T:Newtonsoft.Json.Serialization.ErrorContext"> | ||
7413 | <summary> | ||
7414 | Provides information surrounding an error. | ||
7415 | </summary> | ||
7416 | </member> | ||
7417 | <member name="P:Newtonsoft.Json.Serialization.ErrorContext.Error"> | ||
7418 | <summary> | ||
7419 | Gets the error. | ||
7420 | </summary> | ||
7421 | <value>The error.</value> | ||
7422 | </member> | ||
7423 | <member name="P:Newtonsoft.Json.Serialization.ErrorContext.OriginalObject"> | ||
7424 | <summary> | ||
7425 | Gets the original object that caused the error. | ||
7426 | </summary> | ||
7427 | <value>The original object that caused the error.</value> | ||
7428 | </member> | ||
7429 | <member name="P:Newtonsoft.Json.Serialization.ErrorContext.Member"> | ||
7430 | <summary> | ||
7431 | Gets the member that caused the error. | ||
7432 | </summary> | ||
7433 | <value>The member that caused the error.</value> | ||
7434 | </member> | ||
7435 | <member name="P:Newtonsoft.Json.Serialization.ErrorContext.Path"> | ||
7436 | <summary> | ||
7437 | Gets the path of the JSON location where the error occurred. | ||
7438 | </summary> | ||
7439 | <value>The path of the JSON location where the error occurred.</value> | ||
7440 | </member> | ||
7441 | <member name="P:Newtonsoft.Json.Serialization.ErrorContext.Handled"> | ||
7442 | <summary> | ||
7443 | Gets or sets a value indicating whether this <see cref="T:Newtonsoft.Json.Serialization.ErrorContext"/> is handled. | ||
7444 | </summary> | ||
7445 | <value><c>true</c> if handled; otherwise, <c>false</c>.</value> | ||
7446 | </member> | ||
7447 | <member name="T:Newtonsoft.Json.Serialization.JsonArrayContract"> | ||
7448 | <summary> | ||
7449 | Contract details for a <see cref="T:System.Type"/> used by the <see cref="T:Newtonsoft.Json.JsonSerializer"/>. | ||
7450 | </summary> | ||
7451 | </member> | ||
7452 | <member name="M:Newtonsoft.Json.Serialization.JsonArrayContract.#ctor(System.Type)"> | ||
7453 | <summary> | ||
7454 | Initializes a new instance of the <see cref="T:Newtonsoft.Json.Serialization.JsonArrayContract"/> class. | ||
7455 | </summary> | ||
7456 | <param name="underlyingType">The underlying type for the contract.</param> | ||
7457 | </member> | ||
7458 | <member name="P:Newtonsoft.Json.Serialization.JsonArrayContract.CollectionItemType"> | ||
7459 | <summary> | ||
7460 | Gets the <see cref="T:System.Type"/> of the collection items. | ||
7461 | </summary> | ||
7462 | <value>The <see cref="T:System.Type"/> of the collection items.</value> | ||
7463 | </member> | ||
7464 | <member name="P:Newtonsoft.Json.Serialization.JsonArrayContract.IsMultidimensionalArray"> | ||
7465 | <summary> | ||
7466 | Gets a value indicating whether the collection type is a multidimensional array. | ||
7467 | </summary> | ||
7468 | <value><c>true</c> if the collection type is a multidimensional array; otherwise, <c>false</c>.</value> | ||
7469 | </member> | ||
7470 | <member name="T:Newtonsoft.Json.Serialization.SerializationCallback"> | ||
7471 | <summary> | ||
7472 | Handles <see cref="T:Newtonsoft.Json.JsonSerializer"/> serialization callback events. | ||
7473 | </summary> | ||
7474 | <param name="o">The object that raised the callback event.</param> | ||
7475 | <param name="context">The streaming context.</param> | ||
7476 | </member> | ||
7477 | <member name="T:Newtonsoft.Json.Serialization.SerializationErrorCallback"> | ||
7478 | <summary> | ||
7479 | Handles <see cref="T:Newtonsoft.Json.JsonSerializer"/> serialization error callback events. | ||
7480 | </summary> | ||
7481 | <param name="o">The object that raised the callback event.</param> | ||
7482 | <param name="context">The streaming context.</param> | ||
7483 | <param name="errorContext">The error context.</param> | ||
7484 | </member> | ||
7485 | <member name="T:Newtonsoft.Json.Serialization.ExtensionDataSetter"> | ||
7486 | <summary> | ||
7487 | Sets extension data for an object during deserialization. | ||
7488 | </summary> | ||
7489 | <param name="o">The object to set extension data on.</param> | ||
7490 | <param name="key">The extension data key.</param> | ||
7491 | <param name="value">The extension data value.</param> | ||
7492 | </member> | ||
7493 | <member name="T:Newtonsoft.Json.Serialization.ExtensionDataGetter"> | ||
7494 | <summary> | ||
7495 | Gets extension data for an object during serialization. | ||
7496 | </summary> | ||
7497 | <param name="o">The object to set extension data on.</param> | ||
7498 | </member> | ||
7499 | <member name="T:Newtonsoft.Json.Serialization.JsonDictionaryContract"> | ||
7500 | <summary> | ||
7501 | Contract details for a <see cref="T:System.Type"/> used by the <see cref="T:Newtonsoft.Json.JsonSerializer"/>. | ||
7502 | </summary> | ||
7503 | </member> | ||
7504 | <member name="M:Newtonsoft.Json.Serialization.JsonDictionaryContract.#ctor(System.Type)"> | ||
7505 | <summary> | ||
7506 | Initializes a new instance of the <see cref="T:Newtonsoft.Json.Serialization.JsonDictionaryContract"/> class. | ||
7507 | </summary> | ||
7508 | <param name="underlyingType">The underlying type for the contract.</param> | ||
7509 | </member> | ||
7510 | <member name="P:Newtonsoft.Json.Serialization.JsonDictionaryContract.PropertyNameResolver"> | ||
7511 | <summary> | ||
7512 | Gets or sets the property name resolver. | ||
7513 | </summary> | ||
7514 | <value>The property name resolver.</value> | ||
7515 | </member> | ||
7516 | <member name="P:Newtonsoft.Json.Serialization.JsonDictionaryContract.DictionaryKeyType"> | ||
7517 | <summary> | ||
7518 | Gets the <see cref="T:System.Type"/> of the dictionary keys. | ||
7519 | </summary> | ||
7520 | <value>The <see cref="T:System.Type"/> of the dictionary keys.</value> | ||
7521 | </member> | ||
7522 | <member name="P:Newtonsoft.Json.Serialization.JsonDictionaryContract.DictionaryValueType"> | ||
7523 | <summary> | ||
7524 | Gets the <see cref="T:System.Type"/> of the dictionary values. | ||
7525 | </summary> | ||
7526 | <value>The <see cref="T:System.Type"/> of the dictionary values.</value> | ||
7527 | </member> | ||
7528 | <member name="T:Newtonsoft.Json.Serialization.JsonProperty"> | ||
7529 | <summary> | ||
7530 | Maps a JSON property to a .NET member or constructor parameter. | ||
7531 | </summary> | ||
7532 | </member> | ||
7533 | <member name="M:Newtonsoft.Json.Serialization.JsonProperty.ToString"> | ||
7534 | <summary> | ||
7535 | Returns a <see cref="T:System.String"/> that represents this instance. | ||
7536 | </summary> | ||
7537 | <returns> | ||
7538 | A <see cref="T:System.String"/> that represents this instance. | ||
7539 | </returns> | ||
7540 | </member> | ||
7541 | <member name="P:Newtonsoft.Json.Serialization.JsonProperty.PropertyName"> | ||
7542 | <summary> | ||
7543 | Gets or sets the name of the property. | ||
7544 | </summary> | ||
7545 | <value>The name of the property.</value> | ||
7546 | </member> | ||
7547 | <member name="P:Newtonsoft.Json.Serialization.JsonProperty.DeclaringType"> | ||
7548 | <summary> | ||
7549 | Gets or sets the type that declared this property. | ||
7550 | </summary> | ||
7551 | <value>The type that declared this property.</value> | ||
7552 | </member> | ||
7553 | <member name="P:Newtonsoft.Json.Serialization.JsonProperty.Order"> | ||
7554 | <summary> | ||
7555 | Gets or sets the order of serialization and deserialization of a member. | ||
7556 | </summary> | ||
7557 | <value>The numeric order of serialization or deserialization.</value> | ||
7558 | </member> | ||
7559 | <member name="P:Newtonsoft.Json.Serialization.JsonProperty.UnderlyingName"> | ||
7560 | <summary> | ||
7561 | Gets or sets the name of the underlying member or parameter. | ||
7562 | </summary> | ||
7563 | <value>The name of the underlying member or parameter.</value> | ||
7564 | </member> | ||
7565 | <member name="P:Newtonsoft.Json.Serialization.JsonProperty.ValueProvider"> | ||
7566 | <summary> | ||
7567 | Gets the <see cref="T:Newtonsoft.Json.Serialization.IValueProvider"/> that will get and set the <see cref="T:Newtonsoft.Json.Serialization.JsonProperty"/> during serialization. | ||
7568 | </summary> | ||
7569 | <value>The <see cref="T:Newtonsoft.Json.Serialization.IValueProvider"/> that will get and set the <see cref="T:Newtonsoft.Json.Serialization.JsonProperty"/> during serialization.</value> | ||
7570 | </member> | ||
7571 | <member name="P:Newtonsoft.Json.Serialization.JsonProperty.PropertyType"> | ||
7572 | <summary> | ||
7573 | Gets or sets the type of the property. | ||
7574 | </summary> | ||
7575 | <value>The type of the property.</value> | ||
7576 | </member> | ||
7577 | <member name="P:Newtonsoft.Json.Serialization.JsonProperty.Converter"> | ||
7578 | <summary> | ||
7579 | Gets or sets the <see cref="T:Newtonsoft.Json.JsonConverter"/> for the property. | ||
7580 | If set this converter takes presidence over the contract converter for the property type. | ||
7581 | </summary> | ||
7582 | <value>The converter.</value> | ||
7583 | </member> | ||
7584 | <member name="P:Newtonsoft.Json.Serialization.JsonProperty.MemberConverter"> | ||
7585 | <summary> | ||
7586 | Gets or sets the member converter. | ||
7587 | </summary> | ||
7588 | <value>The member converter.</value> | ||
7589 | </member> | ||
7590 | <member name="P:Newtonsoft.Json.Serialization.JsonProperty.Ignored"> | ||
7591 | <summary> | ||
7592 | Gets or sets a value indicating whether this <see cref="T:Newtonsoft.Json.Serialization.JsonProperty"/> is ignored. | ||
7593 | </summary> | ||
7594 | <value><c>true</c> if ignored; otherwise, <c>false</c>.</value> | ||
7595 | </member> | ||
7596 | <member name="P:Newtonsoft.Json.Serialization.JsonProperty.Readable"> | ||
7597 | <summary> | ||
7598 | Gets or sets a value indicating whether this <see cref="T:Newtonsoft.Json.Serialization.JsonProperty"/> is readable. | ||
7599 | </summary> | ||
7600 | <value><c>true</c> if readable; otherwise, <c>false</c>.</value> | ||
7601 | </member> | ||
7602 | <member name="P:Newtonsoft.Json.Serialization.JsonProperty.Writable"> | ||
7603 | <summary> | ||
7604 | Gets or sets a value indicating whether this <see cref="T:Newtonsoft.Json.Serialization.JsonProperty"/> is writable. | ||
7605 | </summary> | ||
7606 | <value><c>true</c> if writable; otherwise, <c>false</c>.</value> | ||
7607 | </member> | ||
7608 | <member name="P:Newtonsoft.Json.Serialization.JsonProperty.HasMemberAttribute"> | ||
7609 | <summary> | ||
7610 | Gets or sets a value indicating whether this <see cref="T:Newtonsoft.Json.Serialization.JsonProperty"/> has a member attribute. | ||
7611 | </summary> | ||
7612 | <value><c>true</c> if has a member attribute; otherwise, <c>false</c>.</value> | ||
7613 | </member> | ||
7614 | <member name="P:Newtonsoft.Json.Serialization.JsonProperty.DefaultValue"> | ||
7615 | <summary> | ||
7616 | Gets the default value. | ||
7617 | </summary> | ||
7618 | <value>The default value.</value> | ||
7619 | </member> | ||
7620 | <member name="P:Newtonsoft.Json.Serialization.JsonProperty.Required"> | ||
7621 | <summary> | ||
7622 | Gets or sets a value indicating whether this <see cref="T:Newtonsoft.Json.Serialization.JsonProperty"/> is required. | ||
7623 | </summary> | ||
7624 | <value>A value indicating whether this <see cref="T:Newtonsoft.Json.Serialization.JsonProperty"/> is required.</value> | ||
7625 | </member> | ||
7626 | <member name="P:Newtonsoft.Json.Serialization.JsonProperty.IsReference"> | ||
7627 | <summary> | ||
7628 | Gets or sets a value indicating whether this property preserves object references. | ||
7629 | </summary> | ||
7630 | <value> | ||
7631 | <c>true</c> if this instance is reference; otherwise, <c>false</c>. | ||
7632 | </value> | ||
7633 | </member> | ||
7634 | <member name="P:Newtonsoft.Json.Serialization.JsonProperty.NullValueHandling"> | ||
7635 | <summary> | ||
7636 | Gets or sets the property null value handling. | ||
7637 | </summary> | ||
7638 | <value>The null value handling.</value> | ||
7639 | </member> | ||
7640 | <member name="P:Newtonsoft.Json.Serialization.JsonProperty.DefaultValueHandling"> | ||
7641 | <summary> | ||
7642 | Gets or sets the property default value handling. | ||
7643 | </summary> | ||
7644 | <value>The default value handling.</value> | ||
7645 | </member> | ||
7646 | <member name="P:Newtonsoft.Json.Serialization.JsonProperty.ReferenceLoopHandling"> | ||
7647 | <summary> | ||
7648 | Gets or sets the property reference loop handling. | ||
7649 | </summary> | ||
7650 | <value>The reference loop handling.</value> | ||
7651 | </member> | ||
7652 | <member name="P:Newtonsoft.Json.Serialization.JsonProperty.ObjectCreationHandling"> | ||
7653 | <summary> | ||
7654 | Gets or sets the property object creation handling. | ||
7655 | </summary> | ||
7656 | <value>The object creation handling.</value> | ||
7657 | </member> | ||
7658 | <member name="P:Newtonsoft.Json.Serialization.JsonProperty.TypeNameHandling"> | ||
7659 | <summary> | ||
7660 | Gets or sets or sets the type name handling. | ||
7661 | </summary> | ||
7662 | <value>The type name handling.</value> | ||
7663 | </member> | ||
7664 | <member name="P:Newtonsoft.Json.Serialization.JsonProperty.ShouldSerialize"> | ||
7665 | <summary> | ||
7666 | Gets or sets a predicate used to determine whether the property should be serialize. | ||
7667 | </summary> | ||
7668 | <value>A predicate used to determine whether the property should be serialize.</value> | ||
7669 | </member> | ||
7670 | <member name="P:Newtonsoft.Json.Serialization.JsonProperty.GetIsSpecified"> | ||
7671 | <summary> | ||
7672 | Gets or sets a predicate used to determine whether the property should be serialized. | ||
7673 | </summary> | ||
7674 | <value>A predicate used to determine whether the property should be serialized.</value> | ||
7675 | </member> | ||
7676 | <member name="P:Newtonsoft.Json.Serialization.JsonProperty.SetIsSpecified"> | ||
7677 | <summary> | ||
7678 | Gets or sets an action used to set whether the property has been deserialized. | ||
7679 | </summary> | ||
7680 | <value>An action used to set whether the property has been deserialized.</value> | ||
7681 | </member> | ||
7682 | <member name="P:Newtonsoft.Json.Serialization.JsonProperty.ItemConverter"> | ||
7683 | <summary> | ||
7684 | Gets or sets the converter used when serializing the property's collection items. | ||
7685 | </summary> | ||
7686 | <value>The collection's items converter.</value> | ||
7687 | </member> | ||
7688 | <member name="P:Newtonsoft.Json.Serialization.JsonProperty.ItemIsReference"> | ||
7689 | <summary> | ||
7690 | Gets or sets whether this property's collection items are serialized as a reference. | ||
7691 | </summary> | ||
7692 | <value>Whether this property's collection items are serialized as a reference.</value> | ||
7693 | </member> | ||
7694 | <member name="P:Newtonsoft.Json.Serialization.JsonProperty.ItemTypeNameHandling"> | ||
7695 | <summary> | ||
7696 | Gets or sets the the type name handling used when serializing the property's collection items. | ||
7697 | </summary> | ||
7698 | <value>The collection's items type name handling.</value> | ||
7699 | </member> | ||
7700 | <member name="P:Newtonsoft.Json.Serialization.JsonProperty.ItemReferenceLoopHandling"> | ||
7701 | <summary> | ||
7702 | Gets or sets the the reference loop handling used when serializing the property's collection items. | ||
7703 | </summary> | ||
7704 | <value>The collection's items reference loop handling.</value> | ||
7705 | </member> | ||
7706 | <member name="T:Newtonsoft.Json.Serialization.JsonPropertyCollection"> | ||
7707 | <summary> | ||
7708 | A collection of <see cref="T:Newtonsoft.Json.Serialization.JsonProperty"/> objects. | ||
7709 | </summary> | ||
7710 | </member> | ||
7711 | <member name="M:Newtonsoft.Json.Serialization.JsonPropertyCollection.#ctor(System.Type)"> | ||
7712 | <summary> | ||
7713 | Initializes a new instance of the <see cref="T:Newtonsoft.Json.Serialization.JsonPropertyCollection"/> class. | ||
7714 | </summary> | ||
7715 | <param name="type">The type.</param> | ||
7716 | </member> | ||
7717 | <member name="M:Newtonsoft.Json.Serialization.JsonPropertyCollection.GetKeyForItem(Newtonsoft.Json.Serialization.JsonProperty)"> | ||
7718 | <summary> | ||
7719 | When implemented in a derived class, extracts the key from the specified element. | ||
7720 | </summary> | ||
7721 | <param name="item">The element from which to extract the key.</param> | ||
7722 | <returns>The key for the specified element.</returns> | ||
7723 | </member> | ||
7724 | <member name="M:Newtonsoft.Json.Serialization.JsonPropertyCollection.AddProperty(Newtonsoft.Json.Serialization.JsonProperty)"> | ||
7725 | <summary> | ||
7726 | Adds a <see cref="T:Newtonsoft.Json.Serialization.JsonProperty"/> object. | ||
7727 | </summary> | ||
7728 | <param name="property">The property to add to the collection.</param> | ||
7729 | </member> | ||
7730 | <member name="M:Newtonsoft.Json.Serialization.JsonPropertyCollection.GetClosestMatchProperty(System.String)"> | ||
7731 | <summary> | ||
7732 | Gets the closest matching <see cref="T:Newtonsoft.Json.Serialization.JsonProperty"/> object. | ||
7733 | First attempts to get an exact case match of propertyName and then | ||
7734 | a case insensitive match. | ||
7735 | </summary> | ||
7736 | <param name="propertyName">Name of the property.</param> | ||
7737 | <returns>A matching property if found.</returns> | ||
7738 | </member> | ||
7739 | <member name="M:Newtonsoft.Json.Serialization.JsonPropertyCollection.GetProperty(System.String,System.StringComparison)"> | ||
7740 | <summary> | ||
7741 | Gets a property by property name. | ||
7742 | </summary> | ||
7743 | <param name="propertyName">The name of the property to get.</param> | ||
7744 | <param name="comparisonType">Type property name string comparison.</param> | ||
7745 | <returns>A matching property if found.</returns> | ||
7746 | </member> | ||
7747 | <member name="T:Newtonsoft.Json.MissingMemberHandling"> | ||
7748 | <summary> | ||
7749 | Specifies missing member handling options for the <see cref="T:Newtonsoft.Json.JsonSerializer"/>. | ||
7750 | </summary> | ||
7751 | </member> | ||
7752 | <member name="F:Newtonsoft.Json.MissingMemberHandling.Ignore"> | ||
7753 | <summary> | ||
7754 | Ignore a missing member and do not attempt to deserialize it. | ||
7755 | </summary> | ||
7756 | </member> | ||
7757 | <member name="F:Newtonsoft.Json.MissingMemberHandling.Error"> | ||
7758 | <summary> | ||
7759 | Throw a <see cref="T:Newtonsoft.Json.JsonSerializationException"/> when a missing member is encountered during deserialization. | ||
7760 | </summary> | ||
7761 | </member> | ||
7762 | <member name="T:Newtonsoft.Json.NullValueHandling"> | ||
7763 | <summary> | ||
7764 | Specifies null value handling options for the <see cref="T:Newtonsoft.Json.JsonSerializer"/>. | ||
7765 | </summary> | ||
7766 | <example> | ||
7767 | <code lang="cs" source="..\Src\Newtonsoft.Json.Tests\Documentation\SerializationTests.cs" region="ReducingSerializedJsonSizeNullValueHandlingObject" title="NullValueHandling Class"/> | ||
7768 | <code lang="cs" source="..\Src\Newtonsoft.Json.Tests\Documentation\SerializationTests.cs" region="ReducingSerializedJsonSizeNullValueHandlingExample" title="NullValueHandling Ignore Example"/> | ||
7769 | </example> | ||
7770 | </member> | ||
7771 | <member name="F:Newtonsoft.Json.NullValueHandling.Include"> | ||
7772 | <summary> | ||
7773 | Include null values when serializing and deserializing objects. | ||
7774 | </summary> | ||
7775 | </member> | ||
7776 | <member name="F:Newtonsoft.Json.NullValueHandling.Ignore"> | ||
7777 | <summary> | ||
7778 | Ignore null values when serializing and deserializing objects. | ||
7779 | </summary> | ||
7780 | </member> | ||
7781 | <member name="T:Newtonsoft.Json.ReferenceLoopHandling"> | ||
7782 | <summary> | ||
7783 | Specifies reference loop handling options for the <see cref="T:Newtonsoft.Json.JsonSerializer"/>. | ||
7784 | </summary> | ||
7785 | </member> | ||
7786 | <member name="F:Newtonsoft.Json.ReferenceLoopHandling.Error"> | ||
7787 | <summary> | ||
7788 | Throw a <see cref="T:Newtonsoft.Json.JsonSerializationException"/> when a loop is encountered. | ||
7789 | </summary> | ||
7790 | </member> | ||
7791 | <member name="F:Newtonsoft.Json.ReferenceLoopHandling.Ignore"> | ||
7792 | <summary> | ||
7793 | Ignore loop references and do not serialize. | ||
7794 | </summary> | ||
7795 | </member> | ||
7796 | <member name="F:Newtonsoft.Json.ReferenceLoopHandling.Serialize"> | ||
7797 | <summary> | ||
7798 | Serialize loop references. | ||
7799 | </summary> | ||
7800 | </member> | ||
7801 | <member name="T:Newtonsoft.Json.Schema.JsonSchema"> | ||
7802 | <summary> | ||
7803 | An in-memory representation of a JSON Schema. | ||
7804 | </summary> | ||
7805 | </member> | ||
7806 | <member name="M:Newtonsoft.Json.Schema.JsonSchema.#ctor"> | ||
7807 | <summary> | ||
7808 | Initializes a new instance of the <see cref="T:Newtonsoft.Json.Schema.JsonSchema"/> class. | ||
7809 | </summary> | ||
7810 | </member> | ||
7811 | <member name="M:Newtonsoft.Json.Schema.JsonSchema.Read(Newtonsoft.Json.JsonReader)"> | ||
7812 | <summary> | ||
7813 | Reads a <see cref="T:Newtonsoft.Json.Schema.JsonSchema"/> from the specified <see cref="T:Newtonsoft.Json.JsonReader"/>. | ||
7814 | </summary> | ||
7815 | <param name="reader">The <see cref="T:Newtonsoft.Json.JsonReader"/> containing the JSON Schema to read.</param> | ||
7816 | <returns>The <see cref="T:Newtonsoft.Json.Schema.JsonSchema"/> object representing the JSON Schema.</returns> | ||
7817 | </member> | ||
7818 | <member name="M:Newtonsoft.Json.Schema.JsonSchema.Read(Newtonsoft.Json.JsonReader,Newtonsoft.Json.Schema.JsonSchemaResolver)"> | ||
7819 | <summary> | ||
7820 | Reads a <see cref="T:Newtonsoft.Json.Schema.JsonSchema"/> from the specified <see cref="T:Newtonsoft.Json.JsonReader"/>. | ||
7821 | </summary> | ||
7822 | <param name="reader">The <see cref="T:Newtonsoft.Json.JsonReader"/> containing the JSON Schema to read.</param> | ||
7823 | <param name="resolver">The <see cref="T:Newtonsoft.Json.Schema.JsonSchemaResolver"/> to use when resolving schema references.</param> | ||
7824 | <returns>The <see cref="T:Newtonsoft.Json.Schema.JsonSchema"/> object representing the JSON Schema.</returns> | ||
7825 | </member> | ||
7826 | <member name="M:Newtonsoft.Json.Schema.JsonSchema.Parse(System.String)"> | ||
7827 | <summary> | ||
7828 | Load a <see cref="T:Newtonsoft.Json.Schema.JsonSchema"/> from a string that contains schema JSON. | ||
7829 | </summary> | ||
7830 | <param name="json">A <see cref="T:System.String"/> that contains JSON.</param> | ||
7831 | <returns>A <see cref="T:Newtonsoft.Json.Schema.JsonSchema"/> populated from the string that contains JSON.</returns> | ||
7832 | </member> | ||
7833 | <member name="M:Newtonsoft.Json.Schema.JsonSchema.Parse(System.String,Newtonsoft.Json.Schema.JsonSchemaResolver)"> | ||
7834 | <summary> | ||
7835 | Parses the specified json. | ||
7836 | </summary> | ||
7837 | <param name="json">The json.</param> | ||
7838 | <param name="resolver">The resolver.</param> | ||
7839 | <returns>A <see cref="T:Newtonsoft.Json.Schema.JsonSchema"/> populated from the string that contains JSON.</returns> | ||
7840 | </member> | ||
7841 | <member name="M:Newtonsoft.Json.Schema.JsonSchema.WriteTo(Newtonsoft.Json.JsonWriter)"> | ||
7842 | <summary> | ||
7843 | Writes this schema to a <see cref="T:Newtonsoft.Json.JsonWriter"/>. | ||
7844 | </summary> | ||
7845 | <param name="writer">A <see cref="T:Newtonsoft.Json.JsonWriter"/> into which this method will write.</param> | ||
7846 | </member> | ||
7847 | <member name="M:Newtonsoft.Json.Schema.JsonSchema.WriteTo(Newtonsoft.Json.JsonWriter,Newtonsoft.Json.Schema.JsonSchemaResolver)"> | ||
7848 | <summary> | ||
7849 | Writes this schema to a <see cref="T:Newtonsoft.Json.JsonWriter"/> using the specified <see cref="T:Newtonsoft.Json.Schema.JsonSchemaResolver"/>. | ||
7850 | </summary> | ||
7851 | <param name="writer">A <see cref="T:Newtonsoft.Json.JsonWriter"/> into which this method will write.</param> | ||
7852 | <param name="resolver">The resolver used.</param> | ||
7853 | </member> | ||
7854 | <member name="M:Newtonsoft.Json.Schema.JsonSchema.ToString"> | ||
7855 | <summary> | ||
7856 | Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>. | ||
7857 | </summary> | ||
7858 | <returns> | ||
7859 | A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>. | ||
7860 | </returns> | ||
7861 | </member> | ||
7862 | <member name="P:Newtonsoft.Json.Schema.JsonSchema.Id"> | ||
7863 | <summary> | ||
7864 | Gets or sets the id. | ||
7865 | </summary> | ||
7866 | </member> | ||
7867 | <member name="P:Newtonsoft.Json.Schema.JsonSchema.Title"> | ||
7868 | <summary> | ||
7869 | Gets or sets the title. | ||
7870 | </summary> | ||
7871 | </member> | ||
7872 | <member name="P:Newtonsoft.Json.Schema.JsonSchema.Required"> | ||
7873 | <summary> | ||
7874 | Gets or sets whether the object is required. | ||
7875 | </summary> | ||
7876 | </member> | ||
7877 | <member name="P:Newtonsoft.Json.Schema.JsonSchema.ReadOnly"> | ||
7878 | <summary> | ||
7879 | Gets or sets whether the object is read only. | ||
7880 | </summary> | ||
7881 | </member> | ||
7882 | <member name="P:Newtonsoft.Json.Schema.JsonSchema.Hidden"> | ||
7883 | <summary> | ||
7884 | Gets or sets whether the object is visible to users. | ||
7885 | </summary> | ||
7886 | </member> | ||
7887 | <member name="P:Newtonsoft.Json.Schema.JsonSchema.Transient"> | ||
7888 | <summary> | ||
7889 | Gets or sets whether the object is transient. | ||
7890 | </summary> | ||
7891 | </member> | ||
7892 | <member name="P:Newtonsoft.Json.Schema.JsonSchema.Description"> | ||
7893 | <summary> | ||
7894 | Gets or sets the description of the object. | ||
7895 | </summary> | ||
7896 | </member> | ||
7897 | <member name="P:Newtonsoft.Json.Schema.JsonSchema.Type"> | ||
7898 | <summary> | ||
7899 | Gets or sets the types of values allowed by the object. | ||
7900 | </summary> | ||
7901 | <value>The type.</value> | ||
7902 | </member> | ||
7903 | <member name="P:Newtonsoft.Json.Schema.JsonSchema.Pattern"> | ||
7904 | <summary> | ||
7905 | Gets or sets the pattern. | ||
7906 | </summary> | ||
7907 | <value>The pattern.</value> | ||
7908 | </member> | ||
7909 | <member name="P:Newtonsoft.Json.Schema.JsonSchema.MinimumLength"> | ||
7910 | <summary> | ||
7911 | Gets or sets the minimum length. | ||
7912 | </summary> | ||
7913 | <value>The minimum length.</value> | ||
7914 | </member> | ||
7915 | <member name="P:Newtonsoft.Json.Schema.JsonSchema.MaximumLength"> | ||
7916 | <summary> | ||
7917 | Gets or sets the maximum length. | ||
7918 | </summary> | ||
7919 | <value>The maximum length.</value> | ||
7920 | </member> | ||
7921 | <member name="P:Newtonsoft.Json.Schema.JsonSchema.DivisibleBy"> | ||
7922 | <summary> | ||
7923 | Gets or sets a number that the value should be divisble by. | ||
7924 | </summary> | ||
7925 | <value>A number that the value should be divisble by.</value> | ||
7926 | </member> | ||
7927 | <member name="P:Newtonsoft.Json.Schema.JsonSchema.Minimum"> | ||
7928 | <summary> | ||
7929 | Gets or sets the minimum. | ||
7930 | </summary> | ||
7931 | <value>The minimum.</value> | ||
7932 | </member> | ||
7933 | <member name="P:Newtonsoft.Json.Schema.JsonSchema.Maximum"> | ||
7934 | <summary> | ||
7935 | Gets or sets the maximum. | ||
7936 | </summary> | ||
7937 | <value>The maximum.</value> | ||
7938 | </member> | ||
7939 | <member name="P:Newtonsoft.Json.Schema.JsonSchema.ExclusiveMinimum"> | ||
7940 | <summary> | ||
7941 | Gets or sets a flag indicating whether the value can not equal the number defined by the "minimum" attribute. | ||
7942 | </summary> | ||
7943 | <value>A flag indicating whether the value can not equal the number defined by the "minimum" attribute.</value> | ||
7944 | </member> | ||
7945 | <member name="P:Newtonsoft.Json.Schema.JsonSchema.ExclusiveMaximum"> | ||
7946 | <summary> | ||
7947 | Gets or sets a flag indicating whether the value can not equal the number defined by the "maximum" attribute. | ||
7948 | </summary> | ||
7949 | <value>A flag indicating whether the value can not equal the number defined by the "maximum" attribute.</value> | ||
7950 | </member> | ||
7951 | <member name="P:Newtonsoft.Json.Schema.JsonSchema.MinimumItems"> | ||
7952 | <summary> | ||
7953 | Gets or sets the minimum number of items. | ||
7954 | </summary> | ||
7955 | <value>The minimum number of items.</value> | ||
7956 | </member> | ||
7957 | <member name="P:Newtonsoft.Json.Schema.JsonSchema.MaximumItems"> | ||
7958 | <summary> | ||
7959 | Gets or sets the maximum number of items. | ||
7960 | </summary> | ||
7961 | <value>The maximum number of items.</value> | ||
7962 | </member> | ||
7963 | <member name="P:Newtonsoft.Json.Schema.JsonSchema.Items"> | ||
7964 | <summary> | ||
7965 | Gets or sets the <see cref="T:Newtonsoft.Json.Schema.JsonSchema"/> of items. | ||
7966 | </summary> | ||
7967 | <value>The <see cref="T:Newtonsoft.Json.Schema.JsonSchema"/> of items.</value> | ||
7968 | </member> | ||
7969 | <member name="P:Newtonsoft.Json.Schema.JsonSchema.PositionalItemsValidation"> | ||
7970 | <summary> | ||
7971 | Gets or sets a value indicating whether items in an array are validated using the <see cref="T:Newtonsoft.Json.Schema.JsonSchema"/> instance at their array position from <see cref="P:Newtonsoft.Json.Schema.JsonSchema.Items"/>. | ||
7972 | </summary> | ||
7973 | <value> | ||
7974 | <c>true</c> if items are validated using their array position; otherwise, <c>false</c>. | ||
7975 | </value> | ||
7976 | </member> | ||
7977 | <member name="P:Newtonsoft.Json.Schema.JsonSchema.AdditionalItems"> | ||
7978 | <summary> | ||
7979 | Gets or sets the <see cref="T:Newtonsoft.Json.Schema.JsonSchema"/> of additional items. | ||
7980 | </summary> | ||
7981 | <value>The <see cref="T:Newtonsoft.Json.Schema.JsonSchema"/> of additional items.</value> | ||
7982 | </member> | ||
7983 | <member name="P:Newtonsoft.Json.Schema.JsonSchema.AllowAdditionalItems"> | ||
7984 | <summary> | ||
7985 | Gets or sets a value indicating whether additional items are allowed. | ||
7986 | </summary> | ||
7987 | <value> | ||
7988 | <c>true</c> if additional items are allowed; otherwise, <c>false</c>. | ||
7989 | </value> | ||
7990 | </member> | ||
7991 | <member name="P:Newtonsoft.Json.Schema.JsonSchema.UniqueItems"> | ||
7992 | <summary> | ||
7993 | Gets or sets whether the array items must be unique. | ||
7994 | </summary> | ||
7995 | </member> | ||
7996 | <member name="P:Newtonsoft.Json.Schema.JsonSchema.Properties"> | ||
7997 | <summary> | ||
7998 | Gets or sets the <see cref="T:Newtonsoft.Json.Schema.JsonSchema"/> of properties. | ||
7999 | </summary> | ||
8000 | <value>The <see cref="T:Newtonsoft.Json.Schema.JsonSchema"/> of properties.</value> | ||
8001 | </member> | ||
8002 | <member name="P:Newtonsoft.Json.Schema.JsonSchema.AdditionalProperties"> | ||
8003 | <summary> | ||
8004 | Gets or sets the <see cref="T:Newtonsoft.Json.Schema.JsonSchema"/> of additional properties. | ||
8005 | </summary> | ||
8006 | <value>The <see cref="T:Newtonsoft.Json.Schema.JsonSchema"/> of additional properties.</value> | ||
8007 | </member> | ||
8008 | <member name="P:Newtonsoft.Json.Schema.JsonSchema.PatternProperties"> | ||
8009 | <summary> | ||
8010 | Gets or sets the pattern properties. | ||
8011 | </summary> | ||
8012 | <value>The pattern properties.</value> | ||
8013 | </member> | ||
8014 | <member name="P:Newtonsoft.Json.Schema.JsonSchema.AllowAdditionalProperties"> | ||
8015 | <summary> | ||
8016 | Gets or sets a value indicating whether additional properties are allowed. | ||
8017 | </summary> | ||
8018 | <value> | ||
8019 | <c>true</c> if additional properties are allowed; otherwise, <c>false</c>. | ||
8020 | </value> | ||
8021 | </member> | ||
8022 | <member name="P:Newtonsoft.Json.Schema.JsonSchema.Requires"> | ||
8023 | <summary> | ||
8024 | Gets or sets the required property if this property is present. | ||
8025 | </summary> | ||
8026 | <value>The required property if this property is present.</value> | ||
8027 | </member> | ||
8028 | <member name="P:Newtonsoft.Json.Schema.JsonSchema.Enum"> | ||
8029 | <summary> | ||
8030 | Gets or sets the a collection of valid enum values allowed. | ||
8031 | </summary> | ||
8032 | <value>A collection of valid enum values allowed.</value> | ||
8033 | </member> | ||
8034 | <member name="P:Newtonsoft.Json.Schema.JsonSchema.Disallow"> | ||
8035 | <summary> | ||
8036 | Gets or sets disallowed types. | ||
8037 | </summary> | ||
8038 | <value>The disallow types.</value> | ||
8039 | </member> | ||
8040 | <member name="P:Newtonsoft.Json.Schema.JsonSchema.Default"> | ||
8041 | <summary> | ||
8042 | Gets or sets the default value. | ||
8043 | </summary> | ||
8044 | <value>The default value.</value> | ||
8045 | </member> | ||
8046 | <member name="P:Newtonsoft.Json.Schema.JsonSchema.Extends"> | ||
8047 | <summary> | ||
8048 | Gets or sets the collection of <see cref="T:Newtonsoft.Json.Schema.JsonSchema"/> that this schema extends. | ||
8049 | </summary> | ||
8050 | <value>The collection of <see cref="T:Newtonsoft.Json.Schema.JsonSchema"/> that this schema extends.</value> | ||
8051 | </member> | ||
8052 | <member name="P:Newtonsoft.Json.Schema.JsonSchema.Format"> | ||
8053 | <summary> | ||
8054 | Gets or sets the format. | ||
8055 | </summary> | ||
8056 | <value>The format.</value> | ||
8057 | </member> | ||
8058 | <member name="T:Newtonsoft.Json.Schema.JsonSchemaGenerator"> | ||
8059 | <summary> | ||
8060 | Generates a <see cref="T:Newtonsoft.Json.Schema.JsonSchema"/> from a specified <see cref="T:System.Type"/>. | ||
8061 | </summary> | ||
8062 | </member> | ||
8063 | <member name="M:Newtonsoft.Json.Schema.JsonSchemaGenerator.Generate(System.Type)"> | ||
8064 | <summary> | ||
8065 | Generate a <see cref="T:Newtonsoft.Json.Schema.JsonSchema"/> from the specified type. | ||
8066 | </summary> | ||
8067 | <param name="type">The type to generate a <see cref="T:Newtonsoft.Json.Schema.JsonSchema"/> from.</param> | ||
8068 | <returns>A <see cref="T:Newtonsoft.Json.Schema.JsonSchema"/> generated from the specified type.</returns> | ||
8069 | </member> | ||
8070 | <member name="M:Newtonsoft.Json.Schema.JsonSchemaGenerator.Generate(System.Type,Newtonsoft.Json.Schema.JsonSchemaResolver)"> | ||
8071 | <summary> | ||
8072 | Generate a <see cref="T:Newtonsoft.Json.Schema.JsonSchema"/> from the specified type. | ||
8073 | </summary> | ||
8074 | <param name="type">The type to generate a <see cref="T:Newtonsoft.Json.Schema.JsonSchema"/> from.</param> | ||
8075 | <param name="resolver">The <see cref="T:Newtonsoft.Json.Schema.JsonSchemaResolver"/> used to resolve schema references.</param> | ||
8076 | <returns>A <see cref="T:Newtonsoft.Json.Schema.JsonSchema"/> generated from the specified type.</returns> | ||
8077 | </member> | ||
8078 | <member name="M:Newtonsoft.Json.Schema.JsonSchemaGenerator.Generate(System.Type,System.Boolean)"> | ||
8079 | <summary> | ||
8080 | Generate a <see cref="T:Newtonsoft.Json.Schema.JsonSchema"/> from the specified type. | ||
8081 | </summary> | ||
8082 | <param name="type">The type to generate a <see cref="T:Newtonsoft.Json.Schema.JsonSchema"/> from.</param> | ||
8083 | <param name="rootSchemaNullable">Specify whether the generated root <see cref="T:Newtonsoft.Json.Schema.JsonSchema"/> will be nullable.</param> | ||
8084 | <returns>A <see cref="T:Newtonsoft.Json.Schema.JsonSchema"/> generated from the specified type.</returns> | ||
8085 | </member> | ||
8086 | <member name="M:Newtonsoft.Json.Schema.JsonSchemaGenerator.Generate(System.Type,Newtonsoft.Json.Schema.JsonSchemaResolver,System.Boolean)"> | ||
8087 | <summary> | ||
8088 | Generate a <see cref="T:Newtonsoft.Json.Schema.JsonSchema"/> from the specified type. | ||
8089 | </summary> | ||
8090 | <param name="type">The type to generate a <see cref="T:Newtonsoft.Json.Schema.JsonSchema"/> from.</param> | ||
8091 | <param name="resolver">The <see cref="T:Newtonsoft.Json.Schema.JsonSchemaResolver"/> used to resolve schema references.</param> | ||
8092 | <param name="rootSchemaNullable">Specify whether the generated root <see cref="T:Newtonsoft.Json.Schema.JsonSchema"/> will be nullable.</param> | ||
8093 | <returns>A <see cref="T:Newtonsoft.Json.Schema.JsonSchema"/> generated from the specified type.</returns> | ||
8094 | </member> | ||
8095 | <member name="P:Newtonsoft.Json.Schema.JsonSchemaGenerator.UndefinedSchemaIdHandling"> | ||
8096 | <summary> | ||
8097 | Gets or sets how undefined schemas are handled by the serializer. | ||
8098 | </summary> | ||
8099 | </member> | ||
8100 | <member name="P:Newtonsoft.Json.Schema.JsonSchemaGenerator.ContractResolver"> | ||
8101 | <summary> | ||
8102 | Gets or sets the contract resolver. | ||
8103 | </summary> | ||
8104 | <value>The contract resolver.</value> | ||
8105 | </member> | ||
8106 | <member name="T:Newtonsoft.Json.Schema.JsonSchemaType"> | ||
8107 | <summary> | ||
8108 | The value types allowed by the <see cref="T:Newtonsoft.Json.Schema.JsonSchema"/>. | ||
8109 | </summary> | ||
8110 | </member> | ||
8111 | <member name="F:Newtonsoft.Json.Schema.JsonSchemaType.None"> | ||
8112 | <summary> | ||
8113 | No type specified. | ||
8114 | </summary> | ||
8115 | </member> | ||
8116 | <member name="F:Newtonsoft.Json.Schema.JsonSchemaType.String"> | ||
8117 | <summary> | ||
8118 | String type. | ||
8119 | </summary> | ||
8120 | </member> | ||
8121 | <member name="F:Newtonsoft.Json.Schema.JsonSchemaType.Float"> | ||
8122 | <summary> | ||
8123 | Float type. | ||
8124 | </summary> | ||
8125 | </member> | ||
8126 | <member name="F:Newtonsoft.Json.Schema.JsonSchemaType.Integer"> | ||
8127 | <summary> | ||
8128 | Integer type. | ||
8129 | </summary> | ||
8130 | </member> | ||
8131 | <member name="F:Newtonsoft.Json.Schema.JsonSchemaType.Boolean"> | ||
8132 | <summary> | ||
8133 | Boolean type. | ||
8134 | </summary> | ||
8135 | </member> | ||
8136 | <member name="F:Newtonsoft.Json.Schema.JsonSchemaType.Object"> | ||
8137 | <summary> | ||
8138 | Object type. | ||
8139 | </summary> | ||
8140 | </member> | ||
8141 | <member name="F:Newtonsoft.Json.Schema.JsonSchemaType.Array"> | ||
8142 | <summary> | ||
8143 | Array type. | ||
8144 | </summary> | ||
8145 | </member> | ||
8146 | <member name="F:Newtonsoft.Json.Schema.JsonSchemaType.Null"> | ||
8147 | <summary> | ||
8148 | Null type. | ||
8149 | </summary> | ||
8150 | </member> | ||
8151 | <member name="F:Newtonsoft.Json.Schema.JsonSchemaType.Any"> | ||
8152 | <summary> | ||
8153 | Any type. | ||
8154 | </summary> | ||
8155 | </member> | ||
8156 | <member name="T:Newtonsoft.Json.Serialization.JsonObjectContract"> | ||
8157 | <summary> | ||
8158 | Contract details for a <see cref="T:System.Type"/> used by the <see cref="T:Newtonsoft.Json.JsonSerializer"/>. | ||
8159 | </summary> | ||
8160 | </member> | ||
8161 | <member name="M:Newtonsoft.Json.Serialization.JsonObjectContract.#ctor(System.Type)"> | ||
8162 | <summary> | ||
8163 | Initializes a new instance of the <see cref="T:Newtonsoft.Json.Serialization.JsonObjectContract"/> class. | ||
8164 | </summary> | ||
8165 | <param name="underlyingType">The underlying type for the contract.</param> | ||
8166 | </member> | ||
8167 | <member name="P:Newtonsoft.Json.Serialization.JsonObjectContract.MemberSerialization"> | ||
8168 | <summary> | ||
8169 | Gets or sets the object member serialization. | ||
8170 | </summary> | ||
8171 | <value>The member object serialization.</value> | ||
8172 | </member> | ||
8173 | <member name="P:Newtonsoft.Json.Serialization.JsonObjectContract.ItemRequired"> | ||
8174 | <summary> | ||
8175 | Gets or sets a value that indicates whether the object's properties are required. | ||
8176 | </summary> | ||
8177 | <value> | ||
8178 | A value indicating whether the object's properties are required. | ||
8179 | </value> | ||
8180 | </member> | ||
8181 | <member name="P:Newtonsoft.Json.Serialization.JsonObjectContract.Properties"> | ||
8182 | <summary> | ||
8183 | Gets the object's properties. | ||
8184 | </summary> | ||
8185 | <value>The object's properties.</value> | ||
8186 | </member> | ||
8187 | <member name="P:Newtonsoft.Json.Serialization.JsonObjectContract.ConstructorParameters"> | ||
8188 | <summary> | ||
8189 | Gets the constructor parameters required for any non-default constructor | ||
8190 | </summary> | ||
8191 | </member> | ||
8192 | <member name="P:Newtonsoft.Json.Serialization.JsonObjectContract.CreatorParameters"> | ||
8193 | <summary> | ||
8194 | Gets a collection of <see cref="T:Newtonsoft.Json.Serialization.JsonProperty"/> instances that define the parameters used with <see cref="P:Newtonsoft.Json.Serialization.JsonObjectContract.OverrideCreator"/>. | ||
8195 | </summary> | ||
8196 | </member> | ||
8197 | <member name="P:Newtonsoft.Json.Serialization.JsonObjectContract.OverrideConstructor"> | ||
8198 | <summary> | ||
8199 | Gets or sets the override constructor used to create the object. | ||
8200 | This is set when a constructor is marked up using the | ||
8201 | JsonConstructor attribute. | ||
8202 | </summary> | ||
8203 | <value>The override constructor.</value> | ||
8204 | </member> | ||
8205 | <member name="P:Newtonsoft.Json.Serialization.JsonObjectContract.ParametrizedConstructor"> | ||
8206 | <summary> | ||
8207 | Gets or sets the parametrized constructor used to create the object. | ||
8208 | </summary> | ||
8209 | <value>The parametrized constructor.</value> | ||
8210 | </member> | ||
8211 | <member name="P:Newtonsoft.Json.Serialization.JsonObjectContract.OverrideCreator"> | ||
8212 | <summary> | ||
8213 | Gets or sets the function used to create the object. When set this function will override <see cref="P:Newtonsoft.Json.Serialization.JsonContract.DefaultCreator"/>. | ||
8214 | This function is called with a collection of arguments which are defined by the <see cref="P:Newtonsoft.Json.Serialization.JsonObjectContract.CreatorParameters"/> collection. | ||
8215 | </summary> | ||
8216 | <value>The function used to create the object.</value> | ||
8217 | </member> | ||
8218 | <member name="P:Newtonsoft.Json.Serialization.JsonObjectContract.ExtensionDataSetter"> | ||
8219 | <summary> | ||
8220 | Gets or sets the extension data setter. | ||
8221 | </summary> | ||
8222 | </member> | ||
8223 | <member name="P:Newtonsoft.Json.Serialization.JsonObjectContract.ExtensionDataGetter"> | ||
8224 | <summary> | ||
8225 | Gets or sets the extension data getter. | ||
8226 | </summary> | ||
8227 | </member> | ||
8228 | <member name="T:Newtonsoft.Json.Serialization.JsonStringContract"> | ||
8229 | <summary> | ||
8230 | Contract details for a <see cref="T:System.Type"/> used by the <see cref="T:Newtonsoft.Json.JsonSerializer"/>. | ||
8231 | </summary> | ||
8232 | </member> | ||
8233 | <member name="M:Newtonsoft.Json.Serialization.JsonStringContract.#ctor(System.Type)"> | ||
8234 | <summary> | ||
8235 | Initializes a new instance of the <see cref="T:Newtonsoft.Json.Serialization.JsonStringContract"/> class. | ||
8236 | </summary> | ||
8237 | <param name="underlyingType">The underlying type for the contract.</param> | ||
8238 | </member> | ||
8239 | <member name="M:Newtonsoft.Json.Serialization.JsonTypeReflector.CreateJsonConverterInstance(System.Type,System.Object[])"> | ||
8240 | <summary> | ||
8241 | Lookup and create an instance of the JsonConverter type described by the argument. | ||
8242 | </summary> | ||
8243 | <param name="converterType">The JsonConverter type to create.</param> | ||
8244 | <param name="converterArgs">Optional arguments to pass to an initializing constructor of the JsonConverter. | ||
8245 | If null, the default constructor is used.</param> | ||
8246 | </member> | ||
8247 | <member name="M:Newtonsoft.Json.Serialization.JsonTypeReflector.GetJsonConverterCreator(System.Type)"> | ||
8248 | <summary> | ||
8249 | Create a factory function that can be used to create instances of a JsonConverter described by the | ||
8250 | argument type. The returned function can then be used to either invoke the converter's default ctor, or any | ||
8251 | parameterized constructors by way of an object array. | ||
8252 | </summary> | ||
8253 | </member> | ||
8254 | <member name="T:Newtonsoft.Json.Serialization.ReflectionValueProvider"> | ||
8255 | <summary> | ||
8256 | Get and set values for a <see cref="T:System.Reflection.MemberInfo"/> using reflection. | ||
8257 | </summary> | ||
8258 | </member> | ||
8259 | <member name="M:Newtonsoft.Json.Serialization.ReflectionValueProvider.#ctor(System.Reflection.MemberInfo)"> | ||
8260 | <summary> | ||
8261 | Initializes a new instance of the <see cref="T:Newtonsoft.Json.Serialization.ReflectionValueProvider"/> class. | ||
8262 | </summary> | ||
8263 | <param name="memberInfo">The member info.</param> | ||
8264 | </member> | ||
8265 | <member name="M:Newtonsoft.Json.Serialization.ReflectionValueProvider.SetValue(System.Object,System.Object)"> | ||
8266 | <summary> | ||
8267 | Sets the value. | ||
8268 | </summary> | ||
8269 | <param name="target">The target to set the value on.</param> | ||
8270 | <param name="value">The value to set on the target.</param> | ||
8271 | </member> | ||
8272 | <member name="M:Newtonsoft.Json.Serialization.ReflectionValueProvider.GetValue(System.Object)"> | ||
8273 | <summary> | ||
8274 | Gets the value. | ||
8275 | </summary> | ||
8276 | <param name="target">The target to get the value from.</param> | ||
8277 | <returns>The value.</returns> | ||
8278 | </member> | ||
8279 | <member name="T:Newtonsoft.Json.Serialization.OnErrorAttribute"> | ||
8280 | <summary> | ||
8281 | When applied to a method, specifies that the method is called when an error occurs serializing an object. | ||
8282 | </summary> | ||
8283 | </member> | ||
8284 | <member name="M:Newtonsoft.Json.Utilities.DynamicProxyMetaObject`1.CallMethodWithResult(System.String,System.Dynamic.DynamicMetaObjectBinder,System.Linq.Expressions.Expression[],Newtonsoft.Json.Utilities.DynamicProxyMetaObject{`0}.Fallback,Newtonsoft.Json.Utilities.DynamicProxyMetaObject{`0}.Fallback)"> | ||
8285 | <summary> | ||
8286 | Helper method for generating a MetaObject which calls a | ||
8287 | specific method on Dynamic that returns a result | ||
8288 | </summary> | ||
8289 | </member> | ||
8290 | <member name="M:Newtonsoft.Json.Utilities.DynamicProxyMetaObject`1.CallMethodReturnLast(System.String,System.Dynamic.DynamicMetaObjectBinder,System.Linq.Expressions.Expression[],Newtonsoft.Json.Utilities.DynamicProxyMetaObject{`0}.Fallback)"> | ||
8291 | <summary> | ||
8292 | Helper method for generating a MetaObject which calls a | ||
8293 | specific method on Dynamic, but uses one of the arguments for | ||
8294 | the result. | ||
8295 | </summary> | ||
8296 | </member> | ||
8297 | <member name="M:Newtonsoft.Json.Utilities.DynamicProxyMetaObject`1.CallMethodNoResult(System.String,System.Dynamic.DynamicMetaObjectBinder,System.Linq.Expressions.Expression[],Newtonsoft.Json.Utilities.DynamicProxyMetaObject{`0}.Fallback)"> | ||
8298 | <summary> | ||
8299 | Helper method for generating a MetaObject which calls a | ||
8300 | specific method on Dynamic, but uses one of the arguments for | ||
8301 | the result. | ||
8302 | </summary> | ||
8303 | </member> | ||
8304 | <member name="M:Newtonsoft.Json.Utilities.DynamicProxyMetaObject`1.GetRestrictions"> | ||
8305 | <summary> | ||
8306 | Returns a Restrictions object which includes our current restrictions merged | ||
8307 | with a restriction limiting our type | ||
8308 | </summary> | ||
8309 | </member> | ||
8310 | <member name="T:Newtonsoft.Json.Serialization.ObjectConstructor`1"> | ||
8311 | <summary> | ||
8312 | Represents a method that constructs an object. | ||
8313 | </summary> | ||
8314 | <typeparam name="T">The object type to create.</typeparam> | ||
8315 | </member> | ||
8316 | <member name="T:Newtonsoft.Json.TypeNameHandling"> | ||
8317 | <summary> | ||
8318 | Specifies type name handling options for the <see cref="T:Newtonsoft.Json.JsonSerializer"/>. | ||
8319 | </summary> | ||
8320 | </member> | ||
8321 | <member name="F:Newtonsoft.Json.TypeNameHandling.None"> | ||
8322 | <summary> | ||
8323 | Do not include the .NET type name when serializing types. | ||
8324 | </summary> | ||
8325 | </member> | ||
8326 | <member name="F:Newtonsoft.Json.TypeNameHandling.Objects"> | ||
8327 | <summary> | ||
8328 | Include the .NET type name when serializing into a JSON object structure. | ||
8329 | </summary> | ||
8330 | </member> | ||
8331 | <member name="F:Newtonsoft.Json.TypeNameHandling.Arrays"> | ||
8332 | <summary> | ||
8333 | Include the .NET type name when serializing into a JSON array structure. | ||
8334 | </summary> | ||
8335 | </member> | ||
8336 | <member name="F:Newtonsoft.Json.TypeNameHandling.All"> | ||
8337 | <summary> | ||
8338 | Always include the .NET type name when serializing. | ||
8339 | </summary> | ||
8340 | </member> | ||
8341 | <member name="F:Newtonsoft.Json.TypeNameHandling.Auto"> | ||
8342 | <summary> | ||
8343 | Include the .NET type name when the type of the object being serialized is not the same as its declared type. | ||
8344 | </summary> | ||
8345 | </member> | ||
8346 | <member name="M:Newtonsoft.Json.Utilities.ConvertUtils.ConvertOrCast(System.Object,System.Globalization.CultureInfo,System.Type)"> | ||
8347 | <summary> | ||
8348 | Converts the value to the specified type. If the value is unable to be converted, the | ||
8349 | value is checked whether it assignable to the specified type. | ||
8350 | </summary> | ||
8351 | <param name="initialValue">The value to convert.</param> | ||
8352 | <param name="culture">The culture to use when converting.</param> | ||
8353 | <param name="targetType">The type to convert or cast the value to.</param> | ||
8354 | <returns> | ||
8355 | The converted type. If conversion was unsuccessful, the initial value | ||
8356 | is returned if assignable to the target type. | ||
8357 | </returns> | ||
8358 | </member> | ||
8359 | <member name="M:Newtonsoft.Json.Utilities.EnumUtils.GetNamesAndValues``1"> | ||
8360 | <summary> | ||
8361 | Gets a dictionary of the names and values of an Enum type. | ||
8362 | </summary> | ||
8363 | <returns></returns> | ||
8364 | </member> | ||
8365 | <member name="M:Newtonsoft.Json.Utilities.EnumUtils.GetNamesAndValues``1(System.Type)"> | ||
8366 | <summary> | ||
8367 | Gets a dictionary of the names and values of an Enum type. | ||
8368 | </summary> | ||
8369 | <param name="enumType">The enum type to get names and values for.</param> | ||
8370 | <returns></returns> | ||
8371 | </member> | ||
8372 | <member name="T:Newtonsoft.Json.JsonToken"> | ||
8373 | <summary> | ||
8374 | Specifies the type of Json token. | ||
8375 | </summary> | ||
8376 | </member> | ||
8377 | <member name="F:Newtonsoft.Json.JsonToken.None"> | ||
8378 | <summary> | ||
8379 | This is returned by the <see cref="T:Newtonsoft.Json.JsonReader"/> if a <see cref="M:Newtonsoft.Json.JsonReader.Read"/> method has not been called. | ||
8380 | </summary> | ||
8381 | </member> | ||
8382 | <member name="F:Newtonsoft.Json.JsonToken.StartObject"> | ||
8383 | <summary> | ||
8384 | An object start token. | ||
8385 | </summary> | ||
8386 | </member> | ||
8387 | <member name="F:Newtonsoft.Json.JsonToken.StartArray"> | ||
8388 | <summary> | ||
8389 | An array start token. | ||
8390 | </summary> | ||
8391 | </member> | ||
8392 | <member name="F:Newtonsoft.Json.JsonToken.StartConstructor"> | ||
8393 | <summary> | ||
8394 | A constructor start token. | ||
8395 | </summary> | ||
8396 | </member> | ||
8397 | <member name="F:Newtonsoft.Json.JsonToken.PropertyName"> | ||
8398 | <summary> | ||
8399 | An object property name. | ||
8400 | </summary> | ||
8401 | </member> | ||
8402 | <member name="F:Newtonsoft.Json.JsonToken.Comment"> | ||
8403 | <summary> | ||
8404 | A comment. | ||
8405 | </summary> | ||
8406 | </member> | ||
8407 | <member name="F:Newtonsoft.Json.JsonToken.Raw"> | ||
8408 | <summary> | ||
8409 | Raw JSON. | ||
8410 | </summary> | ||
8411 | </member> | ||
8412 | <member name="F:Newtonsoft.Json.JsonToken.Integer"> | ||
8413 | <summary> | ||
8414 | An integer. | ||
8415 | </summary> | ||
8416 | </member> | ||
8417 | <member name="F:Newtonsoft.Json.JsonToken.Float"> | ||
8418 | <summary> | ||
8419 | A float. | ||
8420 | </summary> | ||
8421 | </member> | ||
8422 | <member name="F:Newtonsoft.Json.JsonToken.String"> | ||
8423 | <summary> | ||
8424 | A string. | ||
8425 | </summary> | ||
8426 | </member> | ||
8427 | <member name="F:Newtonsoft.Json.JsonToken.Boolean"> | ||
8428 | <summary> | ||
8429 | A boolean. | ||
8430 | </summary> | ||
8431 | </member> | ||
8432 | <member name="F:Newtonsoft.Json.JsonToken.Null"> | ||
8433 | <summary> | ||
8434 | A null token. | ||
8435 | </summary> | ||
8436 | </member> | ||
8437 | <member name="F:Newtonsoft.Json.JsonToken.Undefined"> | ||
8438 | <summary> | ||
8439 | An undefined token. | ||
8440 | </summary> | ||
8441 | </member> | ||
8442 | <member name="F:Newtonsoft.Json.JsonToken.EndObject"> | ||
8443 | <summary> | ||
8444 | An object end token. | ||
8445 | </summary> | ||
8446 | </member> | ||
8447 | <member name="F:Newtonsoft.Json.JsonToken.EndArray"> | ||
8448 | <summary> | ||
8449 | An array end token. | ||
8450 | </summary> | ||
8451 | </member> | ||
8452 | <member name="F:Newtonsoft.Json.JsonToken.EndConstructor"> | ||
8453 | <summary> | ||
8454 | A constructor end token. | ||
8455 | </summary> | ||
8456 | </member> | ||
8457 | <member name="F:Newtonsoft.Json.JsonToken.Date"> | ||
8458 | <summary> | ||
8459 | A Date. | ||
8460 | </summary> | ||
8461 | </member> | ||
8462 | <member name="F:Newtonsoft.Json.JsonToken.Bytes"> | ||
8463 | <summary> | ||
8464 | Byte data. | ||
8465 | </summary> | ||
8466 | </member> | ||
8467 | <member name="T:Newtonsoft.Json.Utilities.StringBuffer"> | ||
8468 | <summary> | ||
8469 | Builds a string. Unlike StringBuilder this class lets you reuse it's internal buffer. | ||
8470 | </summary> | ||
8471 | </member> | ||
8472 | <member name="M:Newtonsoft.Json.Utilities.CollectionUtils.IsNullOrEmpty``1(System.Collections.Generic.ICollection{``0})"> | ||
8473 | <summary> | ||
8474 | Determines whether the collection is null or empty. | ||
8475 | </summary> | ||
8476 | <param name="collection">The collection.</param> | ||
8477 | <returns> | ||
8478 | <c>true</c> if the collection is null or empty; otherwise, <c>false</c>. | ||
8479 | </returns> | ||
8480 | </member> | ||
8481 | <member name="M:Newtonsoft.Json.Utilities.CollectionUtils.AddRange``1(System.Collections.Generic.IList{``0},System.Collections.Generic.IEnumerable{``0})"> | ||
8482 | <summary> | ||
8483 | Adds the elements of the specified collection to the specified generic IList. | ||
8484 | </summary> | ||
8485 | <param name="initial">The list to add to.</param> | ||
8486 | <param name="collection">The collection of elements to add.</param> | ||
8487 | </member> | ||
8488 | <member name="M:Newtonsoft.Json.Utilities.CollectionUtils.IndexOf``1(System.Collections.Generic.IEnumerable{``0},``0,System.Collections.Generic.IEqualityComparer{``0})"> | ||
8489 | <summary> | ||
8490 | Returns the index of the first occurrence in a sequence by using a specified IEqualityComparer. | ||
8491 | </summary> | ||
8492 | <typeparam name="TSource">The type of the elements of source.</typeparam> | ||
8493 | <param name="list">A sequence in which to locate a value.</param> | ||
8494 | <param name="value">The object to locate in the sequence</param> | ||
8495 | <param name="comparer">An equality comparer to compare values.</param> | ||
8496 | <returns>The zero-based index of the first occurrence of value within the entire sequence, if found; otherwise, –1.</returns> | ||
8497 | </member> | ||
8498 | <member name="M:Newtonsoft.Json.Utilities.ReflectionUtils.GetCollectionItemType(System.Type)"> | ||
8499 | <summary> | ||
8500 | Gets the type of the typed collection's items. | ||
8501 | </summary> | ||
8502 | <param name="type">The type.</param> | ||
8503 | <returns>The type of the typed collection's items.</returns> | ||
8504 | </member> | ||
8505 | <member name="M:Newtonsoft.Json.Utilities.ReflectionUtils.GetMemberUnderlyingType(System.Reflection.MemberInfo)"> | ||
8506 | <summary> | ||
8507 | Gets the member's underlying type. | ||
8508 | </summary> | ||
8509 | <param name="member">The member.</param> | ||
8510 | <returns>The underlying type of the member.</returns> | ||
8511 | </member> | ||
8512 | <member name="M:Newtonsoft.Json.Utilities.ReflectionUtils.IsIndexedProperty(System.Reflection.MemberInfo)"> | ||
8513 | <summary> | ||
8514 | Determines whether the member is an indexed property. | ||
8515 | </summary> | ||
8516 | <param name="member">The member.</param> | ||
8517 | <returns> | ||
8518 | <c>true</c> if the member is an indexed property; otherwise, <c>false</c>. | ||
8519 | </returns> | ||
8520 | </member> | ||
8521 | <member name="M:Newtonsoft.Json.Utilities.ReflectionUtils.IsIndexedProperty(System.Reflection.PropertyInfo)"> | ||
8522 | <summary> | ||
8523 | Determines whether the property is an indexed property. | ||
8524 | </summary> | ||
8525 | <param name="property">The property.</param> | ||
8526 | <returns> | ||
8527 | <c>true</c> if the property is an indexed property; otherwise, <c>false</c>. | ||
8528 | </returns> | ||
8529 | </member> | ||
8530 | <member name="M:Newtonsoft.Json.Utilities.ReflectionUtils.GetMemberValue(System.Reflection.MemberInfo,System.Object)"> | ||
8531 | <summary> | ||
8532 | Gets the member's value on the object. | ||
8533 | </summary> | ||
8534 | <param name="member">The member.</param> | ||
8535 | <param name="target">The target object.</param> | ||
8536 | <returns>The member's value on the object.</returns> | ||
8537 | </member> | ||
8538 | <member name="M:Newtonsoft.Json.Utilities.ReflectionUtils.SetMemberValue(System.Reflection.MemberInfo,System.Object,System.Object)"> | ||
8539 | <summary> | ||
8540 | Sets the member's value on the target object. | ||
8541 | </summary> | ||
8542 | <param name="member">The member.</param> | ||
8543 | <param name="target">The target.</param> | ||
8544 | <param name="value">The value.</param> | ||
8545 | </member> | ||
8546 | <member name="M:Newtonsoft.Json.Utilities.ReflectionUtils.CanReadMemberValue(System.Reflection.MemberInfo,System.Boolean)"> | ||
8547 | <summary> | ||
8548 | Determines whether the specified MemberInfo can be read. | ||
8549 | </summary> | ||
8550 | <param name="member">The MemberInfo to determine whether can be read.</param> | ||
8551 | /// <param name="nonPublic">if set to <c>true</c> then allow the member to be gotten non-publicly.</param> | ||
8552 | <returns> | ||
8553 | <c>true</c> if the specified MemberInfo can be read; otherwise, <c>false</c>. | ||
8554 | </returns> | ||
8555 | </member> | ||
8556 | <member name="M:Newtonsoft.Json.Utilities.ReflectionUtils.CanSetMemberValue(System.Reflection.MemberInfo,System.Boolean,System.Boolean)"> | ||
8557 | <summary> | ||
8558 | Determines whether the specified MemberInfo can be set. | ||
8559 | </summary> | ||
8560 | <param name="member">The MemberInfo to determine whether can be set.</param> | ||
8561 | <param name="nonPublic">if set to <c>true</c> then allow the member to be set non-publicly.</param> | ||
8562 | <param name="canSetReadOnly">if set to <c>true</c> then allow the member to be set if read-only.</param> | ||
8563 | <returns> | ||
8564 | <c>true</c> if the specified MemberInfo can be set; otherwise, <c>false</c>. | ||
8565 | </returns> | ||
8566 | </member> | ||
8567 | <member name="M:Newtonsoft.Json.Utilities.StringUtils.IsWhiteSpace(System.String)"> | ||
8568 | <summary> | ||
8569 | Determines whether the string is all white space. Empty string will return false. | ||
8570 | </summary> | ||
8571 | <param name="s">The string to test whether it is all white space.</param> | ||
8572 | <returns> | ||
8573 | <c>true</c> if the string is all white space; otherwise, <c>false</c>. | ||
8574 | </returns> | ||
8575 | </member> | ||
8576 | <member name="M:Newtonsoft.Json.Utilities.StringUtils.NullEmptyString(System.String)"> | ||
8577 | <summary> | ||
8578 | Nulls an empty string. | ||
8579 | </summary> | ||
8580 | <param name="s">The string.</param> | ||
8581 | <returns>Null if the string was null, otherwise the string unchanged.</returns> | ||
8582 | </member> | ||
8583 | <member name="T:Newtonsoft.Json.WriteState"> | ||
8584 | <summary> | ||
8585 | Specifies the state of the <see cref="T:Newtonsoft.Json.JsonWriter"/>. | ||
8586 | </summary> | ||
8587 | </member> | ||
8588 | <member name="F:Newtonsoft.Json.WriteState.Error"> | ||
8589 | <summary> | ||
8590 | An exception has been thrown, which has left the <see cref="T:Newtonsoft.Json.JsonWriter"/> in an invalid state. | ||
8591 | You may call the <see cref="M:Newtonsoft.Json.JsonWriter.Close"/> method to put the <see cref="T:Newtonsoft.Json.JsonWriter"/> in the <c>Closed</c> state. | ||
8592 | Any other <see cref="T:Newtonsoft.Json.JsonWriter"/> method calls results in an <see cref="T:System.InvalidOperationException"/> being thrown. | ||
8593 | </summary> | ||
8594 | </member> | ||
8595 | <member name="F:Newtonsoft.Json.WriteState.Closed"> | ||
8596 | <summary> | ||
8597 | The <see cref="M:Newtonsoft.Json.JsonWriter.Close"/> method has been called. | ||
8598 | </summary> | ||
8599 | </member> | ||
8600 | <member name="F:Newtonsoft.Json.WriteState.Object"> | ||
8601 | <summary> | ||
8602 | An object is being written. | ||
8603 | </summary> | ||
8604 | </member> | ||
8605 | <member name="F:Newtonsoft.Json.WriteState.Array"> | ||
8606 | <summary> | ||
8607 | A array is being written. | ||
8608 | </summary> | ||
8609 | </member> | ||
8610 | <member name="F:Newtonsoft.Json.WriteState.Constructor"> | ||
8611 | <summary> | ||
8612 | A constructor is being written. | ||
8613 | </summary> | ||
8614 | </member> | ||
8615 | <member name="F:Newtonsoft.Json.WriteState.Property"> | ||
8616 | <summary> | ||
8617 | A property is being written. | ||
8618 | </summary> | ||
8619 | </member> | ||
8620 | <member name="F:Newtonsoft.Json.WriteState.Start"> | ||
8621 | <summary> | ||
8622 | A write method has not been called. | ||
8623 | </summary> | ||
8624 | </member> | ||
8625 | </members> | ||
8626 | </doc> | ||
diff --git a/bin/Nini.dll b/bin/Nini.dll index 2d16d95..aa4d431 100755 --- a/bin/Nini.dll +++ b/bin/Nini.dll | |||
Binary files differ | |||
diff --git a/bin/OpenMetaverse.Rendering.Meshmerizer.dll b/bin/OpenMetaverse.Rendering.Meshmerizer.dll index 5d792d7..f047f58 100755 --- a/bin/OpenMetaverse.Rendering.Meshmerizer.dll +++ b/bin/OpenMetaverse.Rendering.Meshmerizer.dll | |||
Binary files differ | |||
diff --git a/bin/OpenMetaverse.StructuredData.dll b/bin/OpenMetaverse.StructuredData.dll index a81400f..62aecd4 100755 --- a/bin/OpenMetaverse.StructuredData.dll +++ b/bin/OpenMetaverse.StructuredData.dll | |||
Binary files differ | |||
diff --git a/bin/OpenMetaverse.dll b/bin/OpenMetaverse.dll index ba8db16..64f79c2 100755 --- a/bin/OpenMetaverse.dll +++ b/bin/OpenMetaverse.dll | |||
Binary files differ | |||
diff --git a/bin/OpenMetaverseTypes.dll b/bin/OpenMetaverseTypes.dll index 1d3590e..135b5b0 100755 --- a/bin/OpenMetaverseTypes.dll +++ b/bin/OpenMetaverseTypes.dll | |||
Binary files differ | |||
diff --git a/bin/OpenSim.ini.example b/bin/OpenSim.ini.example index 14a41b0..fc29304 100644 --- a/bin/OpenSim.ini.example +++ b/bin/OpenSim.ini.example | |||
@@ -46,11 +46,8 @@ | |||
46 | 46 | ||
47 | 47 | ||
48 | [Const] | 48 | [Const] |
49 | ; For a grid these will usually be the externally accessible IP/DNS | 49 | ; this section defines constants for grid services |
50 | ; name and use default public port 8002 and default private port 8003 | 50 | ; to simplify other configuration files default settings |
51 | ; For a standalone this will usually be the externally accessible IP/DNS | ||
52 | ; name and use default public port 9000. The private port is not used | ||
53 | ; in the configuration for a standalone. | ||
54 | 51 | ||
55 | ;# {BaseHostname} {} {BaseHostname} {"example.com" "127.0.0.1"} "127.0.0.1" | 52 | ;# {BaseHostname} {} {BaseHostname} {"example.com" "127.0.0.1"} "127.0.0.1" |
56 | BaseHostname = "127.0.0.1" | 53 | BaseHostname = "127.0.0.1" |
@@ -61,13 +58,13 @@ | |||
61 | ;# {PublicPort} {} {PublicPort} {8002 9000} "8002" | 58 | ;# {PublicPort} {} {PublicPort} {8002 9000} "8002" |
62 | PublicPort = "8002" | 59 | PublicPort = "8002" |
63 | 60 | ||
61 | ;grid default private port 8003, not used in standalone | ||
64 | ;# {PrivatePort} {} {PrivatePort} {8003} "8003" | 62 | ;# {PrivatePort} {} {PrivatePort} {8003} "8003" |
65 | ; port to access private grid services. | 63 | ; port to access private grid services. |
66 | ; grids that run all their regions should deny access to this port | 64 | ; grids that run all their regions should deny access to this port |
67 | ; from outside their networks, using firewalls | 65 | ; from outside their networks, using firewalls |
68 | PrivatePort = "8003" | 66 | PrivatePort = "8003" |
69 | 67 | ||
70 | |||
71 | [Startup] | 68 | [Startup] |
72 | ;# {ConsolePrompt} {} {ConsolePrompt} {} "Region (\R) " | 69 | ;# {ConsolePrompt} {} {ConsolePrompt} {} "Region (\R) " |
73 | ;; Console prompt | 70 | ;; Console prompt |
@@ -264,9 +261,13 @@ | |||
264 | ; edit the line ulimit -s 262144, and change this last value | 261 | ; edit the line ulimit -s 262144, and change this last value |
265 | 262 | ||
266 | ;# {DefaultScriptEngine} {} {Default script engine} {XEngine} XEngine | 263 | ;# {DefaultScriptEngine} {} {Default script engine} {XEngine} XEngine |
267 | ;; Default script engine to use. Currently, we only have XEngine | 264 | ;; Default script engine to use (Xengine if all commented) |
268 | ; DefaultScriptEngine = "XEngine" | 265 | ; DefaultScriptEngine = "XEngine" |
269 | 266 | ;; ***DANGER***DANGER*** | |
267 | ;; experimental engine | ||
268 | ;; see section [XMREngine} below | ||
269 | ; DefaultScriptEngine = "XMREngine" | ||
270 | |||
270 | ;# {HttpProxy} {} {Proxy URL for llHTTPRequest and dynamic texture loading} {} http://proxy.com:8080 | 271 | ;# {HttpProxy} {} {Proxy URL for llHTTPRequest and dynamic texture loading} {} http://proxy.com:8080 |
271 | ;; Http proxy setting for llHTTPRequest and dynamic texture loading, if | 272 | ;; Http proxy setting for llHTTPRequest and dynamic texture loading, if |
272 | ;; required | 273 | ;; required |
@@ -299,7 +300,18 @@ | |||
299 | ;; default is false | 300 | ;; default is false |
300 | ; TelehubAllowLandmark = false | 301 | ; TelehubAllowLandmark = false |
301 | 302 | ||
302 | 303 | ||
304 | ;; SSL certificate validation options | ||
305 | ;; you can allow selfsigned certificates or no official CA with next option set to true | ||
306 | ;# {NoVerifyCertChain} {} {do not verify SSL Cert Chain} {true false} true | ||
307 | ; NoVerifyCertChain = true | ||
308 | |||
309 | ;; you can also bypass the hostname or domain verification | ||
310 | ;# {NoVerifyCertHostname} {} {do not verify SSL Cert name versus peer name} {true false} true | ||
311 | ; NoVerifyCertHostname = true | ||
312 | ;; having both options true does provide encryption but with low security | ||
313 | ;; set both true if you don't care to use SSL, they are needed to contact regions or grids that do use it. | ||
314 | |||
303 | [AccessControl] | 315 | [AccessControl] |
304 | ;# {AllowedClients} {} {Bar (|) separated list of allowed clients} {} | 316 | ;# {AllowedClients} {} {Bar (|) separated list of allowed clients} {} |
305 | ;; Bar (|) separated list of viewers which may gain access to the regions. | 317 | ;; Bar (|) separated list of viewers which may gain access to the regions. |
@@ -458,7 +470,6 @@ | |||
458 | ;; Password for the default estate owner | 470 | ;; Password for the default estate owner |
459 | ; DefaultEstateOwnerPassword = password | 471 | ; DefaultEstateOwnerPassword = password |
460 | 472 | ||
461 | |||
462 | [SMTP] | 473 | [SMTP] |
463 | ;; The SMTP server enabled the email module to send email to external | 474 | ;; The SMTP server enabled the email module to send email to external |
464 | ;; destinations. | 475 | ;; destinations. |
@@ -491,7 +502,6 @@ | |||
491 | ;# {SMTP_SERVER_PASSWORD} {[Startup]emailmodule:DefaultEmailModule enabled:true} {SMTP server password} {} | 502 | ;# {SMTP_SERVER_PASSWORD} {[Startup]emailmodule:DefaultEmailModule enabled:true} {SMTP server password} {} |
492 | ; SMTP_SERVER_PASSWORD = "" | 503 | ; SMTP_SERVER_PASSWORD = "" |
493 | 504 | ||
494 | |||
495 | [Network] | 505 | [Network] |
496 | ;# {ConsoleUser} {} {User name for console account} {} | 506 | ;# {ConsoleUser} {} {User name for console account} {} |
497 | ;; Configure the remote console user here. This will not actually be used | 507 | ;; Configure the remote console user here. This will not actually be used |
@@ -508,10 +518,39 @@ | |||
508 | ;; the region ports use UDP. | 518 | ;; the region ports use UDP. |
509 | ; http_listener_port = 9000 | 519 | ; http_listener_port = 9000 |
510 | 520 | ||
521 | ; optional main server secure http (ssl) | ||
522 | ; to use ssl you need a ssl certificate in PKCS12 format that validates the ExternalHostnames | ||
523 | ; or their domains | ||
524 | ; some viewers by default only accept certificates signed by a oficial CA | ||
525 | ; to use others like self signed certificates with those viewers, | ||
526 | ; their debug option NoVerifySSLCert needs to be set true, You need to inform users about this | ||
527 | ; the main unsecure port will still open for some services. this may change in future. | ||
528 | |||
529 | ; set http_listener_ssl to enable main server ssl. it will replace unsecure port on most functions | ||
530 | ;# {http_listener_ssl}{} {enable main server ssl port)} {} false | ||
531 | ;http_listener_ssl = false | ||
532 | |||
533 | ; Set port for main SSL connections | ||
534 | ;# {http_listener_sslport}{} {main server ssl port)} {} 9001 | ||
535 | ;http_listener_sslport = 9001 ; | ||
536 | |||
537 | ; currently if using ssl, regions ExternalHostName must the the same and equal to http_listener_cn | ||
538 | ; this may be removed in future | ||
539 | ;# {http_listener_cn}{} {main server ssl externalHostName)} {} "" | ||
540 | ;http_listener_cn = "myRegionsExternalHostName" | ||
541 | |||
542 | ; the path for the certificate path | ||
543 | ;# {http_listener_cert_path}{} {main server ssl certificate file path)} {} "" | ||
544 | ;http_listener_cert_path = "mycert.p12" | ||
545 | |||
546 | ;# {http_listener_cert_pass}{} {main server ssl certificate password)} {} "" | ||
547 | ;http_listener_cert_pass = "mycertpass" ; the cert passwork | ||
548 | |||
511 | ; By default, OpenSimulator does not allow scripts to make HTTP calls to addresses on the simulator's LAN. | 549 | ; By default, OpenSimulator does not allow scripts to make HTTP calls to addresses on the simulator's LAN. |
512 | ; See the OutboundDisallowForUserScripts parameter in OpenSimDefaults.ini for more information on this filter. | 550 | ; See the OutboundDisallowForUserScripts parameter in OpenSimDefaults.ini for more information on this filter. |
513 | ; If you need to allow scripts to make some LAN calls use the OutboundDisallowForUserScriptsExcept parameter below. | 551 | ; If you need to allow scripts to make some LAN calls use the OutboundDisallowForUserScriptsExcept parameter below. |
514 | ; We recommend that you do not override OutboundDisallowForUserScripts directly unless you are very sure about what you're doing. | 552 | ; We recommend that you do not override OutboundDisallowForUserScripts directly unless you are very sure about what you're doing. |
553 | ; this HTTP calls can also use ssl see opensimDefaults.ini | ||
515 | ; | 554 | ; |
516 | ; You can whitelist individual endpoints by IP or FQDN, e.g. | 555 | ; You can whitelist individual endpoints by IP or FQDN, e.g. |
517 | ; | 556 | ; |
@@ -880,6 +919,23 @@ | |||
880 | ;; Money Unit fee to create groups. Default is 0. | 919 | ;; Money Unit fee to create groups. Default is 0. |
881 | ; PriceGroupCreate = 0 | 920 | ; PriceGroupCreate = 0 |
882 | 921 | ||
922 | [XMREngine] | ||
923 | ;; experimental engine | ||
924 | ;; ONLY SUPORTS ONE REGION PER INSTANCE at this point | ||
925 | ;; implements microthreading, so fixing problems like llSleep or long events handlers | ||
926 | ;; but those will suffer from timeslicing, so will be slower. | ||
927 | ;; compiles LSL directly to IL, so only suports LSL scripting (no C# etc) | ||
928 | ;; shares the Xengine APIs like LSL, OSSL, etc. | ||
929 | ;; DANGER, do not use with HG, don't leave regions running alone with it. | ||
930 | ;; TPs or crossings to/from Xengine will recompile scripts losing state. | ||
931 | ;; attachment scripts may misbehave, cars will stop on crossings, etc. | ||
932 | Enabled = false | ||
933 | UThreadModel = sys | ||
934 | ScriptStackSize = 256 | ||
935 | ScriptHeapSize = 256 | ||
936 | UseSourceHashCode = true | ||
937 | MinTimerInterval = 0.1 | ||
938 | ;ScriptBasePath="ScriptData" | ||
883 | 939 | ||
884 | [XEngine] | 940 | [XEngine] |
885 | ;# {Enabled} {} {Enable the XEngine scripting engine?} {true false} true | 941 | ;# {Enabled} {} {Enable the XEngine scripting engine?} {true false} true |
diff --git a/bin/OpenSim32.exe.config b/bin/OpenSim32.exe.config index 9224240..a3b2026 100644 --- a/bin/OpenSim32.exe.config +++ b/bin/OpenSim32.exe.config | |||
@@ -1,3 +1,4 @@ | |||
1 | <?xml version="1.0" encoding="utf-8" ?> | ||
1 | <configuration> | 2 | <configuration> |
2 | <configSections> | 3 | <configSections> |
3 | <section name="log4net" type="log4net.Config.Log4NetConfigurationSectionHandler,log4net" /> | 4 | <section name="log4net" type="log4net.Config.Log4NetConfigurationSectionHandler,log4net" /> |
diff --git a/bin/OpenSimDefaults.ini b/bin/OpenSimDefaults.ini index bb81c95..51f6c9c 100644 --- a/bin/OpenSimDefaults.ini +++ b/bin/OpenSimDefaults.ini | |||
@@ -401,7 +401,18 @@ | |||
401 | ; routing and land at the landmark coordinates when set to true | 401 | ; routing and land at the landmark coordinates when set to true |
402 | ; default is false | 402 | ; default is false |
403 | ; TelehubAllowLandmark = false | 403 | ; TelehubAllowLandmark = false |
404 | 404 | ||
405 | ; # | ||
406 | ; # SSL certificates validation options | ||
407 | ; # | ||
408 | |||
409 | ; SSL certificate validation options | ||
410 | ; you can allow selfsigned certificates or no official CA with next option set to true | ||
411 | ; NoVerifyCertChain = true | ||
412 | ; you can also bypass the hostname or domain verification | ||
413 | ; NoVerifyCertHostname = true | ||
414 | ; having both options true does provide encryption but with low security | ||
415 | ; set both true if you don't care to use SSL, they are needed to contact regions or grids that do use it. | ||
405 | 416 | ||
406 | [Map] | 417 | [Map] |
407 | ; Map tile options. | 418 | ; Map tile options. |
@@ -571,16 +582,18 @@ | |||
571 | http_listener_port = 9000 | 582 | http_listener_port = 9000 |
572 | console_port = 0 | 583 | console_port = 0 |
573 | 584 | ||
574 | ; ssl config: Experimental! The auto https config only really works definately on windows XP now | 585 | ; ssl config: Experimental! |
575 | ; you need a Cert Request/Signed pair installed in the MY store with the CN specified below | 586 | http_listener_ssl = false ; if set to true main server is replaced by a ssl one |
576 | ; you can use https on other platforms, but you'll need to configure the httpapi yourself for now | ||
577 | http_listener_ssl = false ; Also create a SSL server | ||
578 | http_listener_cn = "localhost" ; Use the cert with the common name | ||
579 | http_listener_sslport = 9001 ; Use this port for SSL connections | 587 | http_listener_sslport = 9001 ; Use this port for SSL connections |
580 | http_listener_ssl_cert = "" ; Currently unused, but will be used for OSHttpServer | 588 | ; currently if using ssl, regions ExternalHostName must the the same and equal to http_listener_cn |
581 | 589 | ; this will change is future | |
582 | ; HTTPS for "Out of band" management applications such as the remote | 590 | http_listener_cn = "myRegionsExternalHostName" |
583 | ; admin module | 591 | ; if the cert doesnt have a oficial CA or is selfsigned viewers option NoVerifySSLCert need to be set true |
592 | http_listener_cert_path = "mycert.p12" ; path for the cert file that is valid for the ExternalHostName | ||
593 | http_listener_cert_pass = "mycertpass" ; the cert passwork | ||
594 | |||
595 | ; addicional HTTPS for "Out of band" management applications such as the remote | ||
596 | ; admin module or scripts | ||
584 | ; | 597 | ; |
585 | ; Create https_listener = "True" will create a listener on the port | 598 | ; Create https_listener = "True" will create a listener on the port |
586 | ; specified. Provide the path to your server certificate along with it's | 599 | ; specified. Provide the path to your server certificate along with it's |
@@ -588,7 +601,7 @@ | |||
588 | ; https_listener = False | 601 | ; https_listener = False |
589 | ; Set our listener to this port | 602 | ; Set our listener to this port |
590 | ; https_port = 0 | 603 | ; https_port = 0 |
591 | ; Path to X509 certificate | 604 | ; Path to X509 certificate, can be the same as main or another |
592 | ; cert_path = "path/to/cert.p12" | 605 | ; cert_path = "path/to/cert.p12" |
593 | ; Password for cert | 606 | ; Password for cert |
594 | ; cert_pass = "password" | 607 | ; cert_pass = "password" |
@@ -600,7 +613,8 @@ | |||
600 | ; HttpBodyMaxLenMAX=16384 | 613 | ; HttpBodyMaxLenMAX=16384 |
601 | 614 | ||
602 | ; Hostname to use in llRequestURL/llRequestSecureURL | 615 | ; Hostname to use in llRequestURL/llRequestSecureURL |
603 | ; if not defined - llRequestURL/llRequestSecureURL are disabled | 616 | ; must be a valid hostname for the ssl cert. |
617 | ; if not defined - llRequestURL/llRequestSecureURL are disabled | ||
604 | ; ExternalHostNameForLSL=127.0.0.1 | 618 | ; ExternalHostNameForLSL=127.0.0.1 |
605 | 619 | ||
606 | ; Disallow the following address ranges for user scripting calls (e.g. llHttpRequest()) | 620 | ; Disallow the following address ranges for user scripting calls (e.g. llHttpRequest()) |
diff --git a/bin/Prebuild.exe b/bin/Prebuild.exe index 05deb1f..aeecacc 100755 --- a/bin/Prebuild.exe +++ b/bin/Prebuild.exe | |||
Binary files differ | |||
diff --git a/bin/PrimMesher.dll b/bin/PrimMesher.dll index 87022b7..1f7b1b9 100755 --- a/bin/PrimMesher.dll +++ b/bin/PrimMesher.dll | |||
Binary files differ | |||
diff --git a/bin/Robust.HG.ini.example b/bin/Robust.HG.ini.example index fed9ea2..a327c6b 100644 --- a/bin/Robust.HG.ini.example +++ b/bin/Robust.HG.ini.example | |||
@@ -70,6 +70,14 @@ | |||
70 | ; How many lines of command history should we keep? (default is 100) | 70 | ; How many lines of command history should we keep? (default is 100) |
71 | ConsoleHistoryFileLines = 100 | 71 | ConsoleHistoryFileLines = 100 |
72 | 72 | ||
73 | ; peers SSL certificate validation options | ||
74 | ; you can allow selfsigned certificates or no official CA with next option set to true | ||
75 | NoVerifyCertChain = true | ||
76 | ; you can also bypass the hostname or domain verification | ||
77 | NoVerifyCertHostname = true | ||
78 | ; having both options true does provide encryption but with low security | ||
79 | ; set both true if you don't care to use SSL, they are needed to contact regions or grids that do use it. | ||
80 | |||
73 | 81 | ||
74 | [ServiceList] | 82 | [ServiceList] |
75 | AssetServiceConnector = "${Const|PrivatePort}/OpenSim.Server.Handlers.dll:AssetServiceConnector" | 83 | AssetServiceConnector = "${Const|PrivatePort}/OpenSim.Server.Handlers.dll:AssetServiceConnector" |
@@ -514,7 +522,7 @@ | |||
514 | 522 | ||
515 | ; If you run this login server behind a proxy, set this to true | 523 | ; If you run this login server behind a proxy, set this to true |
516 | ; HasProxy = false | 524 | ; HasProxy = false |
517 | 525 | ||
518 | ; Defaults for the users, if none is specified in the useraccounts table entry (ServiceURLs) | 526 | ; Defaults for the users, if none is specified in the useraccounts table entry (ServiceURLs) |
519 | ;; If you have GatekeeperURI set under [Hypergrid], no need to set it here, leave it commented | 527 | ;; If you have GatekeeperURI set under [Hypergrid], no need to set it here, leave it commented |
520 | ; GatekeeperURI = "${Const|BaseURL}:${Const|PublicPort}" | 528 | ; GatekeeperURI = "${Const|BaseURL}:${Const|PublicPort}" |
diff --git a/bin/Robust.ini.example b/bin/Robust.ini.example index ff00601..5690c1d 100644 --- a/bin/Robust.ini.example +++ b/bin/Robust.ini.example | |||
@@ -61,6 +61,14 @@ | |||
61 | 61 | ||
62 | ; How many lines of command history should we keep? (default is 100) | 62 | ; How many lines of command history should we keep? (default is 100) |
63 | ConsoleHistoryFileLines = 100 | 63 | ConsoleHistoryFileLines = 100 |
64 | |||
65 | ; peers SSL certificate validation options | ||
66 | ; you can allow selfsigned certificates or no official CA with next option set to true | ||
67 | NoVerifyCertChain = true | ||
68 | ; you can also bypass the hostname or domain verification | ||
69 | NoVerifyCertHostname = true | ||
70 | ; having both options true does provide encryption but with low security | ||
71 | ; set both true if you don't care to use SSL, they are needed to contact regions or grids that do use it. | ||
64 | 72 | ||
65 | [ServiceList] | 73 | [ServiceList] |
66 | AssetServiceConnector = "${Const|PrivatePort}/OpenSim.Server.Handlers.dll:AssetServiceConnector" | 74 | AssetServiceConnector = "${Const|PrivatePort}/OpenSim.Server.Handlers.dll:AssetServiceConnector" |
diff --git a/bin/Robust32.exe.config b/bin/Robust32.exe.config index ca3ee0e..a27f22a 100644 --- a/bin/Robust32.exe.config +++ b/bin/Robust32.exe.config | |||
@@ -3,9 +3,6 @@ | |||
3 | <configSections> | 3 | <configSections> |
4 | <section name="log4net" type="log4net.Config.Log4NetConfigurationSectionHandler,log4net" /> | 4 | <section name="log4net" type="log4net.Config.Log4NetConfigurationSectionHandler,log4net" /> |
5 | </configSections> | 5 | </configSections> |
6 | <startup> | ||
7 | <supportedRuntime version="v4.0" sku=".NETFramework,Version=v4.0" /> | ||
8 | </startup> | ||
9 | <runtime> | 6 | <runtime> |
10 | <loadFromRemoteSources enabled="true" /> | 7 | <loadFromRemoteSources enabled="true" /> |
11 | </runtime> | 8 | </runtime> |
diff --git a/bin/Robust32.vshost.exe.config b/bin/Robust32.vshost.exe.config index ca3ee0e..a27f22a 100644 --- a/bin/Robust32.vshost.exe.config +++ b/bin/Robust32.vshost.exe.config | |||
@@ -3,9 +3,6 @@ | |||
3 | <configSections> | 3 | <configSections> |
4 | <section name="log4net" type="log4net.Config.Log4NetConfigurationSectionHandler,log4net" /> | 4 | <section name="log4net" type="log4net.Config.Log4NetConfigurationSectionHandler,log4net" /> |
5 | </configSections> | 5 | </configSections> |
6 | <startup> | ||
7 | <supportedRuntime version="v4.0" sku=".NETFramework,Version=v4.0" /> | ||
8 | </startup> | ||
9 | <runtime> | 6 | <runtime> |
10 | <loadFromRemoteSources enabled="true" /> | 7 | <loadFromRemoteSources enabled="true" /> |
11 | </runtime> | 8 | </runtime> |
diff --git a/bin/Tools.dll b/bin/Tools.dll index 08dcf42..2c9079c 100755 --- a/bin/Tools.dll +++ b/bin/Tools.dll | |||
Binary files differ | |||
diff --git a/bin/Warp3D.dll b/bin/Warp3D.dll index 4c5519d..520e04c 100755 --- a/bin/Warp3D.dll +++ b/bin/Warp3D.dll | |||
Binary files differ | |||
diff --git a/bin/XMLRPC.dll b/bin/XMLRPC.dll index 1559a73..8d13509 100755 --- a/bin/XMLRPC.dll +++ b/bin/XMLRPC.dll | |||
Binary files differ | |||
diff --git a/bin/config-include/osslEnable.ini b/bin/config-include/osslEnable.ini index aed43f0..7535b47 100644 --- a/bin/config-include/osslEnable.ini +++ b/bin/config-include/osslEnable.ini | |||
@@ -9,7 +9,7 @@ | |||
9 | ; mis-used so the permission to execute a function can be limited. Ability to | 9 | ; mis-used so the permission to execute a function can be limited. Ability to |
10 | ; execute a function is based on the owner of the prim holding the script. | 10 | ; execute a function is based on the owner of the prim holding the script. |
11 | 11 | ||
12 | [XEngine] | 12 | [OSSL] |
13 | ; Allow the use of os* functions (some are dangerous) | 13 | ; Allow the use of os* functions (some are dangerous) |
14 | AllowOSFunctions = true | 14 | AllowOSFunctions = true |
15 | 15 | ||
@@ -46,7 +46,7 @@ | |||
46 | ; "PARCEL_GROUP_MEMBER" -- enable for any member of the parcel group | 46 | ; "PARCEL_GROUP_MEMBER" -- enable for any member of the parcel group |
47 | ; uuid -- enable for specified ID (may be avatar or group ID) | 47 | ; uuid -- enable for specified ID (may be avatar or group ID) |
48 | ; from this we can also create macros that can be include in the list as | 48 | ; from this we can also create macros that can be include in the list as |
49 | ; ${XEngine|macroname} see examples below | 49 | ; ${OSSL|macroname} see examples below |
50 | 50 | ||
51 | ; parcel macros | 51 | ; parcel macros |
52 | ; Allowing ossl functions for anyone owning a parcel can be dangerous especially if | 52 | ; Allowing ossl functions for anyone owning a parcel can be dangerous especially if |
@@ -62,7 +62,7 @@ | |||
62 | 62 | ||
63 | ; NPC macros | 63 | ; NPC macros |
64 | ; These can be mis-used so limit use to those you can trust. | 64 | ; These can be mis-used so limit use to those you can trust. |
65 | osslNPC = ${XEngine|osslParcelOG}ESTATE_MANAGER,ESTATE_OWNER | 65 | osslNPC = ${OSSL|osslParcelOG}ESTATE_MANAGER,ESTATE_OWNER |
66 | 66 | ||
67 | ; The OSSL function name is prepended with "Allow_" and it checks against | 67 | ; The OSSL function name is prepended with "Allow_" and it checks against |
68 | ; the owners of the containing prim. There can also be entries beginning with | 68 | ; the owners of the containing prim. There can also be entries beginning with |
@@ -72,18 +72,18 @@ | |||
72 | ; ************************************************* | 72 | ; ************************************************* |
73 | 73 | ||
74 | ; ThreatLevel None | 74 | ; ThreatLevel None |
75 | Allow_osGetAgents = ${XEngine|osslParcelOG}ESTATE_MANAGER,ESTATE_OWNER | 75 | Allow_osGetAgents = ${OSSL|osslParcelOG}ESTATE_MANAGER,ESTATE_OWNER |
76 | Allow_osGetAvatarList = ${XEngine|osslParcelOG}ESTATE_MANAGER,ESTATE_OWNER | 76 | Allow_osGetAvatarList = ${OSSL|osslParcelOG}ESTATE_MANAGER,ESTATE_OWNER |
77 | Allow_osGetGender = true | 77 | Allow_osGetGender = true |
78 | Allow_osGetHealth = true | 78 | Allow_osGetHealth = true |
79 | Allow_osGetHealRate = true | 79 | Allow_osGetHealRate = true |
80 | Allow_osGetNPCList = ${XEngine|osslParcelOG}ESTATE_MANAGER,ESTATE_OWNER | 80 | Allow_osGetNPCList = ${OSSL|osslParcelOG}ESTATE_MANAGER,ESTATE_OWNER |
81 | Allow_osGetRezzingObject = true | 81 | Allow_osGetRezzingObject = true |
82 | Allow_osNpcGetOwner = ${XEngine|osslNPC} | 82 | Allow_osNpcGetOwner = ${OSSL|osslNPC} |
83 | Allow_osParseJSON = true | 83 | Allow_osParseJSON = true |
84 | Allow_osParseJSONNew = true | 84 | Allow_osParseJSONNew = true |
85 | Allow_osSetSunParam = ${XEngine|osslParcelOG}ESTATE_MANAGER,ESTATE_OWNER | 85 | Allow_osSetSunParam = ${OSSL|osslParcelOG}ESTATE_MANAGER,ESTATE_OWNER |
86 | Allow_osTeleportOwner = ${XEngine|osslParcelOG}ESTATE_MANAGER,ESTATE_OWNER | 86 | Allow_osTeleportOwner = ${OSSL|osslParcelOG}ESTATE_MANAGER,ESTATE_OWNER |
87 | Allow_osWindActiveModelPluginName = true | 87 | Allow_osWindActiveModelPluginName = true |
88 | 88 | ||
89 | ; ThreatLevel Nuisance | 89 | ; ThreatLevel Nuisance |
@@ -91,100 +91,100 @@ | |||
91 | Allow_osSetRegionSunSettings = ESTATE_MANAGER,ESTATE_OWNER | 91 | Allow_osSetRegionSunSettings = ESTATE_MANAGER,ESTATE_OWNER |
92 | 92 | ||
93 | ; ThreatLevel VeryLow | 93 | ; ThreatLevel VeryLow |
94 | Allow_osEjectFromGroup = ${XEngine|osslParcelOG}ESTATE_MANAGER,ESTATE_OWNER | 94 | Allow_osEjectFromGroup = ${OSSL|osslParcelOG}ESTATE_MANAGER,ESTATE_OWNER |
95 | Allow_osForceBreakAllLinks = ${XEngine|osslParcelOG}ESTATE_MANAGER,ESTATE_OWNER | 95 | Allow_osForceBreakAllLinks = ${OSSL|osslParcelOG}ESTATE_MANAGER,ESTATE_OWNER |
96 | Allow_osForceBreakLink = ${XEngine|osslParcelOG}ESTATE_MANAGER,ESTATE_OWNER | 96 | Allow_osForceBreakLink = ${OSSL|osslParcelOG}ESTATE_MANAGER,ESTATE_OWNER |
97 | Allow_osGetWindParam = true | 97 | Allow_osGetWindParam = true |
98 | Allow_osInviteToGroup = ${XEngine|osslParcelOG}ESTATE_MANAGER,ESTATE_OWNER | 98 | Allow_osInviteToGroup = ${OSSL|osslParcelOG}ESTATE_MANAGER,ESTATE_OWNER |
99 | Allow_osReplaceString = true | 99 | Allow_osReplaceString = true |
100 | Allow_osSetDynamicTextureData = ${XEngine|osslParcelOG}ESTATE_MANAGER,ESTATE_OWNER | 100 | Allow_osSetDynamicTextureData = ${OSSL|osslParcelOG}ESTATE_MANAGER,ESTATE_OWNER |
101 | Allow_osSetDynamicTextureDataFace = ${XEngine|osslParcelOG}ESTATE_MANAGER,ESTATE_OWNER | 101 | Allow_osSetDynamicTextureDataFace = ${OSSL|osslParcelOG}ESTATE_MANAGER,ESTATE_OWNER |
102 | Allow_osSetDynamicTextureDataBlend = ${XEngine|osslParcelOG}ESTATE_MANAGER,ESTATE_OWNER | 102 | Allow_osSetDynamicTextureDataBlend = ${OSSL|osslParcelOG}ESTATE_MANAGER,ESTATE_OWNER |
103 | Allow_osSetDynamicTextureDataBlendFace = ${XEngine|osslParcelOG}ESTATE_MANAGER,ESTATE_OWNER | 103 | Allow_osSetDynamicTextureDataBlendFace = ${OSSL|osslParcelOG}ESTATE_MANAGER,ESTATE_OWNER |
104 | Allow_osSetDynamicTextureURL = ${XEngine|osslParcelOG}ESTATE_MANAGER,ESTATE_OWNER | 104 | Allow_osSetDynamicTextureURL = ${OSSL|osslParcelOG}ESTATE_MANAGER,ESTATE_OWNER |
105 | Allow_osSetDynamicTextureURLBlend = ${XEngine|osslParcelOG}ESTATE_MANAGER,ESTATE_OWNER | 105 | Allow_osSetDynamicTextureURLBlend = ${OSSL|osslParcelOG}ESTATE_MANAGER,ESTATE_OWNER |
106 | Allow_osSetDynamicTextureURLBlendFace = ${XEngine|osslParcelOG}ESTATE_MANAGER,ESTATE_OWNER | 106 | Allow_osSetDynamicTextureURLBlendFace = ${OSSL|osslParcelOG}ESTATE_MANAGER,ESTATE_OWNER |
107 | Allow_osSetParcelMediaURL = ${XEngine|osslParcelOG}ESTATE_MANAGER,ESTATE_OWNER | 107 | Allow_osSetParcelMediaURL = ${OSSL|osslParcelOG}ESTATE_MANAGER,ESTATE_OWNER |
108 | Allow_osSetParcelSIPAddress = ${XEngine|osslParcelOG}ESTATE_MANAGER,ESTATE_OWNER | 108 | Allow_osSetParcelSIPAddress = ${OSSL|osslParcelOG}ESTATE_MANAGER,ESTATE_OWNER |
109 | Allow_osSetPrimFloatOnWater = true | 109 | Allow_osSetPrimFloatOnWater = true |
110 | Allow_osSetWindParam = ${XEngine|osslParcelOG}ESTATE_MANAGER,ESTATE_OWNER | 110 | Allow_osSetWindParam = ${OSSL|osslParcelOG}ESTATE_MANAGER,ESTATE_OWNER |
111 | Allow_osTerrainFlush = ESTATE_MANAGER,ESTATE_OWNER | 111 | Allow_osTerrainFlush = ESTATE_MANAGER,ESTATE_OWNER |
112 | Allow_osUnixTimeToTimestamp = true | 112 | Allow_osUnixTimeToTimestamp = true |
113 | 113 | ||
114 | ; ThreatLevel Low | 114 | ; ThreatLevel Low |
115 | Allow_osAvatarName2Key = ${XEngine|osslParcelO}ESTATE_MANAGER,ESTATE_OWNER | 115 | Allow_osAvatarName2Key = ${OSSL|osslParcelO}ESTATE_MANAGER,ESTATE_OWNER |
116 | Allow_osFormatString = true | 116 | Allow_osFormatString = true |
117 | Allow_osKey2Name = ${XEngine|osslParcelO}ESTATE_MANAGER,ESTATE_OWNER | 117 | Allow_osKey2Name = ${OSSL|osslParcelO}ESTATE_MANAGER,ESTATE_OWNER |
118 | Allow_osListenRegex = true | 118 | Allow_osListenRegex = true |
119 | Allow_osLoadedCreationDate = ${XEngine|osslParcelOG}ESTATE_MANAGER,ESTATE_OWNER | 119 | Allow_osLoadedCreationDate = ${OSSL|osslParcelOG}ESTATE_MANAGER,ESTATE_OWNER |
120 | Allow_osLoadedCreationID = ${XEngine|osslParcelOG}ESTATE_MANAGER,ESTATE_OWNER | 120 | Allow_osLoadedCreationID = ${OSSL|osslParcelOG}ESTATE_MANAGER,ESTATE_OWNER |
121 | Allow_osLoadedCreationTime = ${XEngine|osslParcelOG}ESTATE_MANAGER,ESTATE_OWNER | 121 | Allow_osLoadedCreationTime = ${OSSL|osslParcelOG}ESTATE_MANAGER,ESTATE_OWNER |
122 | Allow_osMessageObject = ${XEngine|osslParcelOG}ESTATE_MANAGER,ESTATE_OWNER | 122 | Allow_osMessageObject = ${OSSL|osslParcelOG}ESTATE_MANAGER,ESTATE_OWNER |
123 | Allow_osRegexIsMatch = true | 123 | Allow_osRegexIsMatch = true |
124 | Allow_osGetAvatarHomeURI = ${XEngine|osslParcelOG}ESTATE_MANAGER,ESTATE_OWNER | 124 | Allow_osGetAvatarHomeURI = ${OSSL|osslParcelOG}ESTATE_MANAGER,ESTATE_OWNER |
125 | Allow_osNpcSetProfileAbout = ${XEngine|osslNPC} | 125 | Allow_osNpcSetProfileAbout = ${OSSL|osslNPC} |
126 | Allow_osNpcSetProfileImage = ${XEngine|osslNPC} | 126 | Allow_osNpcSetProfileImage = ${OSSL|osslNPC} |
127 | Allow_osDie = ${XEngine|osslParcelOG}ESTATE_MANAGER,ESTATE_OWNER | 127 | Allow_osDie = ${OSSL|osslParcelOG}ESTATE_MANAGER,ESTATE_OWNER |
128 | 128 | ||
129 | ; ThreatLevel Moderate | 129 | ; ThreatLevel Moderate |
130 | Allow_osDropAttachment = ${XEngine|osslParcelO}ESTATE_MANAGER,ESTATE_OWNER | 130 | Allow_osDropAttachment = ${OSSL|osslParcelO}ESTATE_MANAGER,ESTATE_OWNER |
131 | Allow_osDropAttachmentAt = ${XEngine|osslParcelO}ESTATE_MANAGER,ESTATE_OWNER | 131 | Allow_osDropAttachmentAt = ${OSSL|osslParcelO}ESTATE_MANAGER,ESTATE_OWNER |
132 | Allow_osGetGridCustom = ${XEngine|osslParcelO}ESTATE_MANAGER,ESTATE_OWNER | 132 | Allow_osGetGridCustom = ${OSSL|osslParcelO}ESTATE_MANAGER,ESTATE_OWNER |
133 | Allow_osGetGridGatekeeperURI = ${XEngine|osslParcelO}ESTATE_MANAGER,ESTATE_OWNER | 133 | Allow_osGetGridGatekeeperURI = ${OSSL|osslParcelO}ESTATE_MANAGER,ESTATE_OWNER |
134 | Allow_osGetGridHomeURI = ${XEngine|osslParcelO}ESTATE_MANAGER,ESTATE_OWNER | 134 | Allow_osGetGridHomeURI = ${OSSL|osslParcelO}ESTATE_MANAGER,ESTATE_OWNER |
135 | Allow_osGetGridLoginURI = ${XEngine|osslParcelO}ESTATE_MANAGER,ESTATE_OWNER | 135 | Allow_osGetGridLoginURI = ${OSSL|osslParcelO}ESTATE_MANAGER,ESTATE_OWNER |
136 | Allow_osGetGridName = true | 136 | Allow_osGetGridName = true |
137 | Allow_osGetGridNick = true | 137 | Allow_osGetGridNick = true |
138 | Allow_osGetNumberOfAttachments = ${XEngine|osslParcelO}ESTATE_MANAGER,ESTATE_OWNER | 138 | Allow_osGetNumberOfAttachments = ${OSSL|osslParcelO}ESTATE_MANAGER,ESTATE_OWNER |
139 | Allow_osGetRegionStats = ${XEngine|osslParcelO}ESTATE_MANAGER,ESTATE_OWNER | 139 | Allow_osGetRegionStats = ${OSSL|osslParcelO}ESTATE_MANAGER,ESTATE_OWNER |
140 | Allow_osGetSimulatorMemory = ${XEngine|osslParcelO}ESTATE_MANAGER,ESTATE_OWNER | 140 | Allow_osGetSimulatorMemory = ${OSSL|osslParcelO}ESTATE_MANAGER,ESTATE_OWNER |
141 | Allow_osGetSimulatorMemoryKB = ${XEngine|osslParcelO}ESTATE_MANAGER,ESTATE_OWNER | 141 | Allow_osGetSimulatorMemoryKB = ${OSSL|osslParcelO}ESTATE_MANAGER,ESTATE_OWNER |
142 | Allow_osMessageAttachments = ${XEngine|osslParcelO}ESTATE_MANAGER,ESTATE_OWNER | 142 | Allow_osMessageAttachments = ${OSSL|osslParcelO}ESTATE_MANAGER,ESTATE_OWNER |
143 | Allow_osSetSpeed = ${XEngine|osslParcelO}ESTATE_MANAGER,ESTATE_OWNER | 143 | Allow_osSetSpeed = ${OSSL|osslParcelO}ESTATE_MANAGER,ESTATE_OWNER |
144 | 144 | ||
145 | ; ThreatLevel High | 145 | ; ThreatLevel High |
146 | Allow_osCauseDamage = ${XEngine|osslParcelO}ESTATE_MANAGER,ESTATE_OWNER | 146 | Allow_osCauseDamage = ${OSSL|osslParcelO}ESTATE_MANAGER,ESTATE_OWNER |
147 | Allow_osCauseHealing = ${XEngine|osslParcelO}ESTATE_MANAGER,ESTATE_OWNER | 147 | Allow_osCauseHealing = ${OSSL|osslParcelO}ESTATE_MANAGER,ESTATE_OWNER |
148 | Allow_osSetHealth = ${XEngine|osslParcelO}ESTATE_MANAGER,ESTATE_OWNER | 148 | Allow_osSetHealth = ${OSSL|osslParcelO}ESTATE_MANAGER,ESTATE_OWNER |
149 | Allow_osSetHealRate = ${XEngine|osslParcelO}ESTATE_MANAGER,ESTATE_OWNER | 149 | Allow_osSetHealRate = ${OSSL|osslParcelO}ESTATE_MANAGER,ESTATE_OWNER |
150 | Allow_osForceAttachToAvatar = ${XEngine|osslParcelO}ESTATE_MANAGER,ESTATE_OWNER | 150 | Allow_osForceAttachToAvatar = ${OSSL|osslParcelO}ESTATE_MANAGER,ESTATE_OWNER |
151 | Allow_osForceAttachToAvatarFromInventory = ${XEngine|osslParcelO}ESTATE_MANAGER,ESTATE_OWNER | 151 | Allow_osForceAttachToAvatarFromInventory = ${OSSL|osslParcelO}ESTATE_MANAGER,ESTATE_OWNER |
152 | Allow_osForceCreateLink = ${XEngine|osslParcelO}ESTATE_MANAGER,ESTATE_OWNER | 152 | Allow_osForceCreateLink = ${OSSL|osslParcelO}ESTATE_MANAGER,ESTATE_OWNER |
153 | Allow_osForceDropAttachment = ${XEngine|osslParcelO}ESTATE_MANAGER,ESTATE_OWNER | 153 | Allow_osForceDropAttachment = ${OSSL|osslParcelO}ESTATE_MANAGER,ESTATE_OWNER |
154 | Allow_osForceDropAttachmentAt = ${XEngine|osslParcelO}ESTATE_MANAGER,ESTATE_OWNER | 154 | Allow_osForceDropAttachmentAt = ${OSSL|osslParcelO}ESTATE_MANAGER,ESTATE_OWNER |
155 | Allow_osGetLinkPrimitiveParams = ${XEngine|osslParcelO}ESTATE_MANAGER,ESTATE_OWNER | 155 | Allow_osGetLinkPrimitiveParams = ${OSSL|osslParcelO}ESTATE_MANAGER,ESTATE_OWNER |
156 | Allow_osGetPhysicsEngineType = true | 156 | Allow_osGetPhysicsEngineType = true |
157 | Allow_osGetPrimitiveParams = ${XEngine|osslParcelO}ESTATE_MANAGER,ESTATE_OWNER | 157 | Allow_osGetPrimitiveParams = ${OSSL|osslParcelO}ESTATE_MANAGER,ESTATE_OWNER |
158 | Allow_osGetRegionMapTexture = ${XEngine|osslParcelO}ESTATE_MANAGER,ESTATE_OWNER | 158 | Allow_osGetRegionMapTexture = ${OSSL|osslParcelO}ESTATE_MANAGER,ESTATE_OWNER |
159 | Allow_osGetScriptEngineName = true | 159 | Allow_osGetScriptEngineName = true |
160 | Allow_osGetSimulatorVersion = true | 160 | Allow_osGetSimulatorVersion = true |
161 | Allow_osMakeNotecard = ${XEngine|osslParcelO}ESTATE_MANAGER,ESTATE_OWNER | 161 | Allow_osMakeNotecard = ${OSSL|osslParcelO}ESTATE_MANAGER,ESTATE_OWNER |
162 | Allow_osMatchString = true | 162 | Allow_osMatchString = true |
163 | Allow_osNpcCreate = ${XEngine|osslNPC} | 163 | Allow_osNpcCreate = ${OSSL|osslNPC} |
164 | Allow_osNpcGetPos = ${XEngine|osslNPC} | 164 | Allow_osNpcGetPos = ${OSSL|osslNPC} |
165 | Allow_osNpcGetRot = ${XEngine|osslNPC} | 165 | Allow_osNpcGetRot = ${OSSL|osslNPC} |
166 | Allow_osNpcLoadAppearance = ${XEngine|osslNPC} | 166 | Allow_osNpcLoadAppearance = ${OSSL|osslNPC} |
167 | Allow_osNpcMoveTo = ${XEngine|osslNPC} | 167 | Allow_osNpcMoveTo = ${OSSL|osslNPC} |
168 | Allow_osNpcMoveToTarget = ${XEngine|osslNPC} | 168 | Allow_osNpcMoveToTarget = ${OSSL|osslNPC} |
169 | Allow_osNpcPlayAnimation = ${XEngine|osslNPC} | 169 | Allow_osNpcPlayAnimation = ${OSSL|osslNPC} |
170 | Allow_osNpcRemove = ${XEngine|osslNPC} | 170 | Allow_osNpcRemove = ${OSSL|osslNPC} |
171 | Allow_osNpcSaveAppearance = ${XEngine|osslNPC} | 171 | Allow_osNpcSaveAppearance = ${OSSL|osslNPC} |
172 | Allow_osNpcSay = ${XEngine|osslNPC} | 172 | Allow_osNpcSay = ${OSSL|osslNPC} |
173 | Allow_osNpcSetRot = ${XEngine|osslNPC} | 173 | Allow_osNpcSetRot = ${OSSL|osslNPC} |
174 | Allow_osNpcShout = ${XEngine|osslNPC} | 174 | Allow_osNpcShout = ${OSSL|osslNPC} |
175 | Allow_osNpcSit = ${XEngine|osslNPC} | 175 | Allow_osNpcSit = ${OSSL|osslNPC} |
176 | Allow_osNpcStand = ${XEngine|osslNPC} | 176 | Allow_osNpcStand = ${OSSL|osslNPC} |
177 | Allow_osNpcStopAnimation = ${XEngine|osslNPC} | 177 | Allow_osNpcStopAnimation = ${OSSL|osslNPC} |
178 | Allow_osNpcStopMoveToTarget = ${XEngine|osslNPC} | 178 | Allow_osNpcStopMoveToTarget = ${OSSL|osslNPC} |
179 | Allow_osNpcTouch = ${XEngine|osslNPC} | 179 | Allow_osNpcTouch = ${OSSL|osslNPC} |
180 | Allow_osNpcWhisper = ${XEngine|osslNPC} | 180 | Allow_osNpcWhisper = ${OSSL|osslNPC} |
181 | Allow_osOwnerSaveAppearance = ${XEngine|osslParcelO}ESTATE_MANAGER,ESTATE_OWNER | 181 | Allow_osOwnerSaveAppearance = ${OSSL|osslParcelO}ESTATE_MANAGER,ESTATE_OWNER |
182 | Allow_osParcelJoin = ESTATE_MANAGER,ESTATE_OWNER | 182 | Allow_osParcelJoin = ESTATE_MANAGER,ESTATE_OWNER |
183 | Allow_osParcelSubdivide = ESTATE_MANAGER,ESTATE_OWNER | 183 | Allow_osParcelSubdivide = ESTATE_MANAGER,ESTATE_OWNER |
184 | Allow_osRegionRestart = ESTATE_MANAGER,ESTATE_OWNER | 184 | Allow_osRegionRestart = ESTATE_MANAGER,ESTATE_OWNER |
185 | Allow_osSetContentType = ${XEngine|osslParcelO}ESTATE_MANAGER,ESTATE_OWNER | 185 | Allow_osSetContentType = ${OSSL|osslParcelO}ESTATE_MANAGER,ESTATE_OWNER |
186 | Allow_osSetPrimitiveParams = false | 186 | Allow_osSetPrimitiveParams = false |
187 | Allow_osSetProjectionParams = ${XEngine|osslParcelOG}ESTATE_MANAGER,ESTATE_OWNER | 187 | Allow_osSetProjectionParams = ${OSSL|osslParcelOG}ESTATE_MANAGER,ESTATE_OWNER |
188 | Allow_osSetRegionWaterHeight = ESTATE_MANAGER,ESTATE_OWNER | 188 | Allow_osSetRegionWaterHeight = ESTATE_MANAGER,ESTATE_OWNER |
189 | Allow_osSetStateEvents = false ; deprecated | 189 | Allow_osSetStateEvents = false ; deprecated |
190 | Allow_osSetTerrainHeight = ESTATE_MANAGER,ESTATE_OWNER | 190 | Allow_osSetTerrainHeight = ESTATE_MANAGER,ESTATE_OWNER |
@@ -203,20 +203,20 @@ | |||
203 | Allow_osForceDetachFromAvatar = false | 203 | Allow_osForceDetachFromAvatar = false |
204 | Allow_osForceOtherSit = false | 204 | Allow_osForceOtherSit = false |
205 | ; The notecard functions can cause a lot of load on the region if over used | 205 | ; The notecard functions can cause a lot of load on the region if over used |
206 | Allow_osGetNotecard = ${XEngine|osslParcelO}ESTATE_MANAGER,ESTATE_OWNER | 206 | Allow_osGetNotecard = ${OSSL|osslParcelO}ESTATE_MANAGER,ESTATE_OWNER |
207 | Allow_osGetNotecardLine = ${XEngine|osslParcelO}ESTATE_MANAGER,ESTATE_OWNER | 207 | Allow_osGetNotecardLine = ${OSSL|osslParcelO}ESTATE_MANAGER,ESTATE_OWNER |
208 | Allow_osGetNumberOfNotecardLines = ${XEngine|osslParcelO}ESTATE_MANAGER,ESTATE_OWNER | 208 | Allow_osGetNumberOfNotecardLines = ${OSSL|osslParcelO}ESTATE_MANAGER,ESTATE_OWNER |
209 | Allow_osRegionNotice = ESTATE_MANAGER,ESTATE_OWNER | 209 | Allow_osRegionNotice = ESTATE_MANAGER,ESTATE_OWNER |
210 | Allow_osSetRot = false | 210 | Allow_osSetRot = false |
211 | Allow_osSetParcelDetails = ${XEngine|osslParcelO}ESTATE_MANAGER,ESTATE_OWNER | 211 | Allow_osSetParcelDetails = ${OSSL|osslParcelO}ESTATE_MANAGER,ESTATE_OWNER |
212 | 212 | ||
213 | ; ThreatLevel Severe | 213 | ; ThreatLevel Severe |
214 | Allow_osConsoleCommand = false | 214 | Allow_osConsoleCommand = false |
215 | Allow_osGrantScriptPermissions = false | 215 | Allow_osGrantScriptPermissions = false |
216 | Allow_osKickAvatar = ${XEngine|osslParcelO}ESTATE_MANAGER,ESTATE_OWNER | 216 | Allow_osKickAvatar = ${OSSL|osslParcelO}ESTATE_MANAGER,ESTATE_OWNER |
217 | Allow_osRevokeScriptPermissions = false | 217 | Allow_osRevokeScriptPermissions = false |
218 | Allow_osTeleportAgent = ${XEngine|osslParcelO}ESTATE_MANAGER,ESTATE_OWNER | 218 | Allow_osTeleportAgent = ${OSSL|osslParcelO}ESTATE_MANAGER,ESTATE_OWNER |
219 | Allow_osTeleportObject = ${XEngine|osslParcelO}ESTATE_MANAGER,ESTATE_OWNER | 219 | Allow_osTeleportObject = ${OSSL|osslParcelO}ESTATE_MANAGER,ESTATE_OWNER |
220 | 220 | ||
221 | ; ThreatLevel Severe with additional internal restrictions | 221 | ; ThreatLevel Severe with additional internal restrictions |
222 | Allow_osGetAgentIP = true ; always restricted to Administrators (true or false to disable) | 222 | Allow_osGetAgentIP = true ; always restricted to Administrators (true or false to disable) |
diff --git a/bin/lib32/ode.dll b/bin/lib32/ode.dll index cb4d1a0..6d02b53 100755 --- a/bin/lib32/ode.dll +++ b/bin/lib32/ode.dll | |||
Binary files differ | |||
diff --git a/bin/lib64/ode.dll b/bin/lib64/ode.dll index 050ee46..b8e3414 100755 --- a/bin/lib64/ode.dll +++ b/bin/lib64/ode.dll | |||
Binary files differ | |||
diff --git a/bin/log4net.dll b/bin/log4net.dll index ffc57e1..7740fbd 100755 --- a/bin/log4net.dll +++ b/bin/log4net.dll | |||
Binary files differ | |||
diff --git a/bin/mautil.exe b/bin/mautil.exe index 534df19..022ca5a 100755 --- a/bin/mautil.exe +++ b/bin/mautil.exe | |||
Binary files differ | |||
diff --git a/bin/zlib.net.dll b/bin/zlib.net.dll index 9d15654..1ce10af 100755 --- a/bin/zlib.net.dll +++ b/bin/zlib.net.dll | |||
Binary files differ | |||