1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
|
<?xml version="1.0" encoding="utf-8"?>
<Type Name="ServiceDebugElement" FullName="System.ServiceModel.Configuration.ServiceDebugElement">
<TypeSignature Language="C#" Value="public sealed class ServiceDebugElement : System.ServiceModel.Configuration.BehaviorExtensionElement" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi sealed beforefieldinit ServiceDebugElement extends System.ServiceModel.Configuration.BehaviorExtensionElement" />
<AssemblyInfo>
<AssemblyName>System.ServiceModel</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.ServiceModel.Configuration.BehaviorExtensionElement</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>If you set the <see cref="P:System.ServiceModel.Configuration.ServiceDebugElement.IncludeExceptionDetailInFaults" /> property to true programmatically, you can enable the flow of managed exception information to the client for debugging purposes, as well as the publication of HTML information files for users browsing the service in Web browsers.</para>
<block subset="none" type="note">
<para>Returning managed exception information to services can be a security risk. This is because exception details expose information about the internal client implementation that could be used by unauthorized services.</para>
</block>
<para>The <see cref="P:System.ServiceModel.Configuration.ServiceDebugElement.HttpHelpPageEnabled" /> and <see cref="P:System.ServiceModel.Configuration.ServiceDebugElement.HttpsHelpPageEnabled" /> properties instruct the service to publish HTML help files when the service is viewed using an HTML browser.</para>
<para>The <see cref="P:System.ServiceModel.Configuration.ServiceDebugElement.HttpHelpPageUrl" /> and <see cref="P:System.ServiceModel.Configuration.ServiceDebugElement.HttpsHelpPageUrl" /> properties control the location of the HTML help page that is viewed.</para>
<para>To enable or disable one of the <see cref="T:System.ServiceModel.Configuration.ServiceDebugElement" /> features using a configuration file, you must:</para>
<list type="ordered">
<item>
<para>Add a behaviorConfiguration attribute to the <format type="text/html"><a href="13123dd6-c4a9-4a04-a984-df184b851788"><service></a></format> element for your indigo2 service. (Endpoint behaviors are configured on <endpoint> elements; service behaviors on <format type="text/html"><a href="13123dd6-c4a9-4a04-a984-df184b851788"><service></a></format> elements.)</para>
</item>
<item>
<para>Add to or create a <format type="text/html"><a href="5aed9062-cc36-4b72-b9dd-a3018b8ffafc"><serviceBehaviors></a></format> section and add a <format type="text/html"><a href="b90ca3bc-3c22-4174-b903-e3a39898bd27"><behavior></a></format> element to that with the name that matches the behaviorConfiguration attribute value from step 1. (Endpoint behaviors are configured using an <format type="text/html"><a href="fb851947-e8dd-4f8c-8323-26fae90b09c3"><endpointBehaviors></a></format> element; service behaviors are configured using a <format type="text/html"><a href="5aed9062-cc36-4b72-b9dd-a3018b8ffafc"><serviceBehaviors></a></format> element.</para>
</item>
<item>
<para>Add a <format type="text/html"><a href="6d7ea986-f232-49fe-842c-f934d9966889"><serviceDebug></a></format> element to the <format type="text/html"><a href="b90ca3bc-3c22-4174-b903-e3a39898bd27"><behavior></a></format> element from step 2 and enable or disable the various properties appropriate to your scenario.</para>
</item>
</list>
<para>For a specific example, see the Example section.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Represents a configuration element that specifies debugging and help information features for a indigo1 service. This class cannot be inherited.</para>
</summary>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public ServiceDebugElement ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters />
<Docs>
<remarks>To be added.</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Initializes a new instance of the <see cref="T:System.ServiceModel.Configuration.ServiceDebugElement" /> class.</para>
</summary>
</Docs>
</Member>
<Member MemberName="BehaviorType">
<MemberSignature Language="C#" Value="public override Type BehaviorType { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Type BehaviorType" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Type</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<remarks>To be added.</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets the type of this behavior element.</para>
</summary>
</Docs>
</Member>
<Member MemberName="CreateBehavior">
<MemberSignature Language="C#" Value="protected override object CreateBehavior ();" />
<MemberSignature Language="ILAsm" Value=".method familyorassemblyhidebysig virtual instance object CreateBehavior() cil managed" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Object</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="HttpHelpPageBinding">
<MemberSignature Language="C#" Value="public string HttpHelpPageBinding { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string HttpHelpPageBinding" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName>System.Configuration.ConfigurationProperty("httpHelpPageBinding", DefaultValue=Mono.Cecil.CustomAttributeArgument)</AttributeName>
</Attribute>
<Attribute>
<AttributeName>System.Configuration.StringValidator(MinLength=0)</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>If this property is not set, the default binding (HttpTransportBindingElement) is used for service help page access as appropriate.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets or sets a string value that specifies the binding to be used when HTTP is utilized to access the service help page.</para>
</summary>
</Docs>
</Member>
<Member MemberName="HttpHelpPageBindingConfiguration">
<MemberSignature Language="C#" Value="public string HttpHelpPageBindingConfiguration { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string HttpHelpPageBindingConfiguration" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName>System.Configuration.ConfigurationProperty("httpHelpPageBindingConfiguration", DefaultValue=Mono.Cecil.CustomAttributeArgument)</AttributeName>
</Attribute>
<Attribute>
<AttributeName>System.Configuration.StringValidator(MinLength=0)</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<remarks>To be added.</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets or sets a string that points to an XML section defining additional configuration information for the binding specified in <see cref="P:System.ServiceModel.Configuration.ServiceDebugElement.HttpHelpPageBinding" />.</para>
</summary>
</Docs>
</Member>
<Member MemberName="HttpHelpPageEnabled">
<MemberSignature Language="C#" Value="public bool HttpHelpPageEnabled { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool HttpHelpPageEnabled" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName>System.Configuration.ConfigurationProperty("httpHelpPageEnabled", DefaultValue=Mono.Cecil.CustomAttributeArgument, Options=System.Configuration.ConfigurationPropertyOptions.None)</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>You can set this property to false to disable the publication of an HTML help page visible to HTML browsers.</para>
<para>To ensure the HTML help page is published at the location controlled by the <see cref="P:System.ServiceModel.Configuration.ServiceDebugElement.HttpHelpPageUrl" /> property, you must set this property to true. In addition, one of the following conditions must also be met:</para>
<list type="bullet">
<item>
<para>The <see cref="P:System.ServiceModel.Configuration.ServiceDebugElement.HttpHelpPageUrl" /> property is an absolute address that supports the HTTP protocol scheme.</para>
</item>
<item>
<para>There is a base address for the service that supports the HTTP protocol scheme.</para>
</item>
</list>
<para>Although an exception is thrown if an absolute address that does not support the HTTP protocol scheme is assigned to the <see cref="P:System.ServiceModel.Configuration.ServiceDebugElement.HttpHelpPageUrl" /> property, any other scenario in which neither of the preceding criteria is met results in no exception and no HTML help page.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets or sets a value that indicates whether indigo1 publishes an HTML help page at the address specified by the <see cref="P:System.ServiceModel.Configuration.ServiceDebugElement.HttpHelpPageUrl" /> property.</para>
</summary>
</Docs>
</Member>
<Member MemberName="HttpHelpPageUrl">
<MemberSignature Language="C#" Value="public Uri HttpHelpPageUrl { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Uri HttpHelpPageUrl" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName>System.Configuration.ConfigurationProperty("httpHelpPageUrl", Options=System.Configuration.ConfigurationPropertyOptions.None)</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Uri</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>You can use this property to enable the use of a custom HTML help file that is returned from an HTTP/Get request, for example, from an HTML browser. The location of the HTML help file is resolved as follows.</para>
<list type="ordered">
<item>
<para>If the value of this property is a relative address, the location of the HTML help file is the value of the service base address that supports HTTP requests, plus this property value.</para>
</item>
<item>
<para>If the value of this property is an absolute address and supports HTTP requests, the location of the HTML help file is the value of this property.</para>
</item>
<item>
<para>If the value of this property is absolute but does not support HTTP requests, an exception is thrown.</para>
</item>
</list>
<para>This property is valid only when the <see cref="P:System.ServiceModel.Configuration.ServiceDebugElement.HttpHelpPageEnabled" /> property is true.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets or sets the location at which the HTML help file is published.</para>
</summary>
</Docs>
</Member>
<Member MemberName="HttpsHelpPageBinding">
<MemberSignature Language="C#" Value="public string HttpsHelpPageBinding { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string HttpsHelpPageBinding" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName>System.Configuration.ConfigurationProperty("httpsHelpPageBinding", DefaultValue=Mono.Cecil.CustomAttributeArgument)</AttributeName>
</Attribute>
<Attribute>
<AttributeName>System.Configuration.StringValidator(MinLength=0)</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>If this property is not set, the default binding (HttpsTransportBindingElement) is used for service help page access as appropriate.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets or sets a string value that specifies the binding to be used when HTTPS is utilized to access the service help page.</para>
</summary>
</Docs>
</Member>
<Member MemberName="HttpsHelpPageBindingConfiguration">
<MemberSignature Language="C#" Value="public string HttpsHelpPageBindingConfiguration { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string HttpsHelpPageBindingConfiguration" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName>System.Configuration.ConfigurationProperty("httpsHelpPageBindingConfiguration", DefaultValue=Mono.Cecil.CustomAttributeArgument)</AttributeName>
</Attribute>
<Attribute>
<AttributeName>System.Configuration.StringValidator(MinLength=0)</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<remarks>To be added.</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets or sets a string that points to an XML section defining additional configuration information for the binding specified in <see cref="P:System.ServiceModel.Configuration.ServiceDebugElement.HttpsHelpPageBinding" />.</para>
</summary>
</Docs>
</Member>
<Member MemberName="HttpsHelpPageEnabled">
<MemberSignature Language="C#" Value="public bool HttpsHelpPageEnabled { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool HttpsHelpPageEnabled" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName>System.Configuration.ConfigurationProperty("httpsHelpPageEnabled", DefaultValue=Mono.Cecil.CustomAttributeArgument, Options=System.Configuration.ConfigurationPropertyOptions.None)</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>You can set this property to false to disable the publication of an HTML help page visible to HTML browsers.</para>
<para>To ensure the HTML help page is published at the location controlled by the <see cref="P:System.ServiceModel.Configuration.ServiceDebugElement.HttpsHelpPageUrl" /> property, you must set this property to true. In addition, one of the following conditions must also be met:</para>
<list type="bullet">
<item>
<para>The <see cref="P:System.ServiceModel.Configuration.ServiceDebugElement.HttpsHelpPageUrl" /> property is an absolute address that supports the HTTPS protocol scheme.</para>
</item>
<item>
<para>There is a base address for the service that supports the HTTPS protocol scheme.</para>
</item>
<item>
<para>Although an exception is thrown if an absolute address that does not support the HTTPS protocol scheme is assigned to the <see cref="P:System.ServiceModel.Configuration.ServiceDebugElement.HttpsHelpPageUrl" /> property, any other scenario in which neither of the preceding criteria is met results in no exception and no HTML help page.</para>
</item>
</list>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets or sets a value that specifies whether indigo1 returns an HTML help file over HTTPS at the address specified by the <see cref="P:System.ServiceModel.Configuration.ServiceDebugElement.HttpsHelpPageUrl" /> property.</para>
</summary>
</Docs>
</Member>
<Member MemberName="HttpsHelpPageUrl">
<MemberSignature Language="C#" Value="public Uri HttpsHelpPageUrl { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Uri HttpsHelpPageUrl" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName>System.Configuration.ConfigurationProperty("httpsHelpPageUrl", Options=System.Configuration.ConfigurationPropertyOptions.None)</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Uri</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>You can use this property to enable the use of a custom HTML help file that is returned from an HTTPS/Get request, for example, from an HTML browser. The location of the HTML help file is resolved as follows.</para>
<list type="ordered">
<item>
<para>If the value of this property is a relative address, the location of the HTML help file is the value of the service base address that supports HTTPS requests, plus this property value.</para>
</item>
<item>
<para>If the value of this property is an absolute address and supports HTTPS requests, the location of the HTML help file is the value of this property.</para>
</item>
<item>
<para>If the value of this property is absolute but does not support HTTPS requests, an exception is thrown.</para>
</item>
</list>
<para>This property is valid only when the <see cref="P:System.ServiceModel.Configuration.ServiceDebugElement.HttpsHelpPageEnabled" /> property is true.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets or sets the location at which an HTML help file is published for retrieval using HTTPS.</para>
</summary>
</Docs>
</Member>
<Member MemberName="IncludeExceptionDetailInFaults">
<MemberSignature Language="C#" Value="public bool IncludeExceptionDetailInFaults { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool IncludeExceptionDetailInFaults" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName>System.Configuration.ConfigurationProperty("includeExceptionDetailInFaults", DefaultValue=Mono.Cecil.CustomAttributeArgument, Options=System.Configuration.ConfigurationPropertyOptions.None)</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>If you set the <see cref="P:System.ServiceModel.Configuration.ServiceDebugElement.IncludeExceptionDetailInFaults" /> property to true programmatically, you can enable the flow of managed exception information to the client for debugging purposes, as well as the publication of HTML information files for users browsing the service in Web browsers.</para>
<block subset="none" type="note">
<para>Returning managed exception information to services can be a security risk. This is because exception details expose information about the internal client implementation that could be used by unauthorized services.</para>
</block>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets or sets a value that specifies whether to include managed exception information in the detail of SOAP faults returned to the client for debugging purposes.</para>
</summary>
</Docs>
</Member>
<Member MemberName="Properties">
<MemberSignature Language="C#" Value="protected override System.Configuration.ConfigurationPropertyCollection Properties { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Configuration.ConfigurationPropertyCollection Properties" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Configuration.ConfigurationPropertyCollection</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>
|
