/
WebBodyFormatMessageProperty.xml
157 lines (153 loc) · 10.3 KB
/
WebBodyFormatMessageProperty.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
<Type Name="WebBodyFormatMessageProperty" FullName="System.ServiceModel.Channels.WebBodyFormatMessageProperty">
<TypeSignature Language="C#" Value="public sealed class WebBodyFormatMessageProperty : System.ServiceModel.Channels.IMessageProperty" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi sealed beforefieldinit WebBodyFormatMessageProperty extends System.Object implements class System.ServiceModel.Channels.IMessageProperty" />
<TypeSignature Language="DocId" Value="T:System.ServiceModel.Channels.WebBodyFormatMessageProperty" />
<TypeSignature Language="VB.NET" Value="Public NotInheritable Class WebBodyFormatMessageProperty
Implements IMessageProperty" />
<TypeSignature Language="F#" Value="type WebBodyFormatMessageProperty = class
 interface IMessageProperty" />
<TypeSignature Language="C++ CLI" Value="public ref class WebBodyFormatMessageProperty sealed : System::ServiceModel::Channels::IMessageProperty" />
<AssemblyInfo>
<AssemblyName>System.ServiceModel.Web</AssemblyName>
<AssemblyVersion>2.0.5.0</AssemblyVersion>
<AssemblyVersion>3.5.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces>
<Interface>
<InterfaceName>System.ServiceModel.Channels.IMessageProperty</InterfaceName>
</Interface>
</Interfaces>
<Docs>
<summary>Stores and retrieves the message encoding format of incoming and outgoing messages for the composite Web message encoder.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
This property allows, for example, the composite Web message formatter to know how the composite Web message encoder has encoded the message. <xref:System.ServiceModel.Channels.WebBodyFormatMessageProperty> implements <xref:System.ServiceModel.Channels.IMessageProperty>. Objects that implement this interface are added by value to <xref:System.ServiceModel.Channels.Message.Properties%2A> with the <xref:System.ServiceModel.Channels.WebBodyFormatMessageProperty.Name> providing the access key.
]]></format>
</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public WebBodyFormatMessageProperty (System.ServiceModel.Channels.WebContentFormat format);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(valuetype System.ServiceModel.Channels.WebContentFormat format) cil managed" />
<MemberSignature Language="DocId" Value="M:System.ServiceModel.Channels.WebBodyFormatMessageProperty.#ctor(System.ServiceModel.Channels.WebContentFormat)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (format As WebContentFormat)" />
<MemberSignature Language="F#" Value="new System.ServiceModel.Channels.WebBodyFormatMessageProperty : System.ServiceModel.Channels.WebContentFormat -> System.ServiceModel.Channels.WebBodyFormatMessageProperty" Usage="new System.ServiceModel.Channels.WebBodyFormatMessageProperty format" />
<MemberSignature Language="C++ CLI" Value="public:
 WebBodyFormatMessageProperty(System::ServiceModel::Channels::WebContentFormat format);" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>System.ServiceModel.Web</AssemblyName>
<AssemblyVersion>3.5.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="format" Type="System.ServiceModel.Channels.WebContentFormat" />
</Parameters>
<Docs>
<param name="format">The <see cref="T:System.ServiceModel.Channels.WebContentFormat" /> of the message body.</param>
<summary>Initializes a new instance of the <see cref="T:System.ServiceModel.Channels.WebBodyFormatMessageProperty" /> class with a specified format.</summary>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentException">The format cannot be set to the <see cref="F:System.ServiceModel.Channels.WebContentFormat.Default" /> value in the constructor.</exception>
</Docs>
</Member>
<Member MemberName="CreateCopy">
<MemberSignature Language="C#" Value="public System.ServiceModel.Channels.IMessageProperty CreateCopy ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.ServiceModel.Channels.IMessageProperty CreateCopy() cil managed" />
<MemberSignature Language="DocId" Value="M:System.ServiceModel.Channels.WebBodyFormatMessageProperty.CreateCopy" />
<MemberSignature Language="VB.NET" Value="Public Function CreateCopy () As IMessageProperty" />
<MemberSignature Language="F#" Value="abstract member CreateCopy : unit -> System.ServiceModel.Channels.IMessageProperty
override this.CreateCopy : unit -> System.ServiceModel.Channels.IMessageProperty" Usage="webBodyFormatMessageProperty.CreateCopy " />
<MemberSignature Language="C++ CLI" Value="public:
 virtual System::ServiceModel::Channels::IMessageProperty ^ CreateCopy();" />
<MemberType>Method</MemberType>
<Implements>
<InterfaceMember>M:System.ServiceModel.Channels.IMessageProperty.CreateCopy</InterfaceMember>
</Implements>
<AssemblyInfo>
<AssemblyName>System.ServiceModel.Web</AssemblyName>
<AssemblyVersion>3.5.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.ServiceModel.Channels.IMessageProperty</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Returns the current instance of the current property.</summary>
<returns>An instance of the <see cref="T:System.ServiceModel.Channels.IMessageProperty" /> interface that is a copy of the current <see cref="T:System.ServiceModel.Channels.WebBodyFormatMessageProperty" />.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Format">
<MemberSignature Language="C#" Value="public System.ServiceModel.Channels.WebContentFormat Format { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.ServiceModel.Channels.WebContentFormat Format" />
<MemberSignature Language="DocId" Value="P:System.ServiceModel.Channels.WebBodyFormatMessageProperty.Format" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Format As WebContentFormat" />
<MemberSignature Language="F#" Value="member this.Format : System.ServiceModel.Channels.WebContentFormat" Usage="System.ServiceModel.Channels.WebBodyFormatMessageProperty.Format" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::ServiceModel::Channels::WebContentFormat Format { System::ServiceModel::Channels::WebContentFormat get(); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.ServiceModel.Web</AssemblyName>
<AssemblyVersion>3.5.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.ServiceModel.Channels.WebContentFormat</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the format used for the message body.</summary>
<value>The <see cref="T:System.ServiceModel.Channels.WebContentFormat" /> that specifies the format used for the message body.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Name">
<MemberSignature Language="C#" Value="public const string Name;" />
<MemberSignature Language="ILAsm" Value=".field public static literal string Name" />
<MemberSignature Language="DocId" Value="F:System.ServiceModel.Channels.WebBodyFormatMessageProperty.Name" />
<MemberSignature Language="VB.NET" Value="Public Const Name As String " />
<MemberSignature Language="F#" Value="val mutable Name : string" Usage="System.ServiceModel.Channels.WebBodyFormatMessageProperty.Name" />
<MemberSignature Language="C++ CLI" Value="public: System::String ^ Name;" />
<MemberType>Field</MemberType>
<AssemblyInfo>
<AssemblyName>System.ServiceModel.Web</AssemblyName>
<AssemblyVersion>3.5.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>Returns the name of the property.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The <xref:System.ServiceModel.Channels.WebBodyFormatMessageProperty> object must have the name "WebBodyFormatMessageProperty" as its key in the <xref:System.ServiceModel.Channels.MessageProperties> collection for the value to be accessed and used as a processing annotation.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="ToString">
<MemberSignature Language="C#" Value="public override string ToString ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance string ToString() cil managed" />
<MemberSignature Language="DocId" Value="M:System.ServiceModel.Channels.WebBodyFormatMessageProperty.ToString" />
<MemberSignature Language="VB.NET" Value="Public Overrides Function ToString () As String" />
<MemberSignature Language="F#" Value="override this.ToString : unit -> string" Usage="webBodyFormatMessageProperty.ToString " />
<MemberSignature Language="C++ CLI" Value="public:
 override System::String ^ ToString();" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.ServiceModel.Web</AssemblyName>
<AssemblyVersion>3.5.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Returns the name of the property and the encoding format used when constructed.</summary>
<returns>Returns "WebBodyFormatMessageProperty: EncodingFormat={0}", where {0} is <see langword="WebContentFormat.ToString()" />, which specifies the encoding format used.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>