-
Notifications
You must be signed in to change notification settings - Fork 4
/
Binding.xml
276 lines (272 loc) · 16.3 KB
/
Binding.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
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
<Type Name="Binding" FullName="Microsoft.Maui.Controls.Binding">
<TypeSignature Language="C#" Value="public sealed class Binding : Microsoft.Maui.Controls.BindingBase" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi sealed beforefieldinit Binding extends Microsoft.Maui.Controls.BindingBase" />
<TypeSignature Language="DocId" Value="T:Microsoft.Maui.Controls.Binding" />
<TypeSignature Language="VB.NET" Value="Public NotInheritable Class Binding
Inherits BindingBase" />
<TypeSignature Language="C++ CLI" Value="public ref class Binding sealed : Microsoft::Maui::Controls::BindingBase" />
<TypeSignature Language="F#" Value="type Binding = class
 inherit BindingBase" />
<AssemblyInfo>
<AssemblyName>Microsoft.Maui.Controls</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>Microsoft.Maui.Controls.BindingBase</BaseTypeName>
</Base>
<Interfaces />
<Attributes>
<Attribute FrameworkAlternate="net-maui-9.0">
<AttributeName Language="C#">[System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("Using bindings with string paths is not trim safe. Use expression-based binding instead.", Url=null)]</AttributeName>
<AttributeName Language="F#">[<System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("Using bindings with string paths is not trim safe. Use expression-based binding instead.", Url=null)>]</AttributeName>
</Attribute>
</Attributes>
<Docs>
<summary>A single 1:1 immutable data binding.</summary>
<remarks>This class is immutable.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public Binding ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Maui.Controls.Binding.#ctor" />
<MemberSignature Language="VB.NET" Value="Public Sub New ()" />
<MemberSignature Language="C++ CLI" Value="public:
 Binding();" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Maui.Controls</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters />
<Docs>
<summary>Constructs and initializes a new instance of the <see cref="T:Microsoft.Maui.Controls.Binding" /> class.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public Binding (string path, Microsoft.Maui.Controls.BindingMode mode = Microsoft.Maui.Controls.BindingMode.Default, Microsoft.Maui.Controls.IValueConverter converter = default, object converterParameter = default, string stringFormat = default, object source = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string path, valuetype Microsoft.Maui.Controls.BindingMode mode, class Microsoft.Maui.Controls.IValueConverter converter, object converterParameter, string stringFormat, object source) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Maui.Controls.Binding.#ctor(System.String,Microsoft.Maui.Controls.BindingMode,Microsoft.Maui.Controls.IValueConverter,System.Object,System.String,System.Object)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (path As String, Optional mode As BindingMode = Microsoft.Maui.Controls.BindingMode.Default, Optional converter As IValueConverter = Nothing, Optional converterParameter As Object = Nothing, Optional stringFormat As String = Nothing, Optional source As Object = Nothing)" />
<MemberSignature Language="F#" Value="new Microsoft.Maui.Controls.Binding : string * Microsoft.Maui.Controls.BindingMode * Microsoft.Maui.Controls.IValueConverter * obj * string * obj -> Microsoft.Maui.Controls.Binding" Usage="new Microsoft.Maui.Controls.Binding (path, mode, converter, converterParameter, stringFormat, source)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Maui.Controls</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="path" Type="System.String" />
<Parameter Name="mode" Type="Microsoft.Maui.Controls.BindingMode" />
<Parameter Name="converter" Type="Microsoft.Maui.Controls.IValueConverter" />
<Parameter Name="converterParameter" Type="System.Object" />
<Parameter Name="stringFormat" Type="System.String" />
<Parameter Name="source" Type="System.Object" />
</Parameters>
<Docs>
<param name="path">The property path.</param>
<param name="mode">The binding mode. This property is optional. Default is <see cref="F:Microsoft.Maui.Controls.BindingMode.Default" />.</param>
<param name="converter">The converter. This parameter is optional. Default is <see langword="null" />.</param>
<param name="converterParameter">An user-defined parameter to pass to the converter. This parameter is optional. Default is <see langword="null" />.</param>
<param name="stringFormat">A String format. This parameter is optional. Default is <see langword="null" />.</param>
<param name="source">An object used as the source for this binding. This parameter is optional. Default is <see langword="null" />.</param>
<summary>Constructs and initializes a new instance of the <see cref="T:Microsoft.Maui.Controls.Binding" /> class.</summary>
<remarks>To be added.</remarks>
<remarks>
<para>The following example shows how to set a binding to a property with a BindingMode and Converter:</para>
<example>
<code lang="csharp lang-csharp"><![CDATA[
public class PersonViewModel
{
public string Name { get; set; }
public string Company { get; set; }
}
public class ReverseConverter : IValueConverter
{
public object Convert (object value, Type targetType, object parameter, System.Globalization.CultureInfo culture)
{
var s = value as string;
if (s == null)
return value;
return new string (s.Reverse ().ToArray ());
}
public object ConvertBack (object value, Type targetType, object parameter, System.Globalization.CultureInfo culture)
{
var s = value as string;
if (s == null)
return value;
return new string (s.Reverse ().ToArray ());
}
}
var label = new Label ();
PersonViewModel person;
label.BindingContext = person = new PersonViewModel { Name = "John Doe", Company= "Xamarin" };
label.SetBinding (Label.TextProperty, new Binding ("Name", mode: BindingMode.TwoWay, converter: new ReverseConverter ()));
Debug.WriteLine (label.Text); //prints "eoD nhoJ". ReverseConverter.Convert () is invoked in this case.
label.Text = "ooF";
Debug.WriteLine (person.Name); //prints "Foo". ReverseConverter.ConvertBack () is invoked in this case. The label Text change is propagated back as the BindingMode is TwoWay.
]]></code>
</example>
</remarks>
</Docs>
</Member>
<Member MemberName="Converter">
<MemberSignature Language="C#" Value="public Microsoft.Maui.Controls.IValueConverter Converter { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class Microsoft.Maui.Controls.IValueConverter Converter" />
<MemberSignature Language="DocId" Value="P:Microsoft.Maui.Controls.Binding.Converter" />
<MemberSignature Language="VB.NET" Value="Public Property Converter As IValueConverter" />
<MemberSignature Language="C++ CLI" Value="public:
 property Microsoft::Maui::Controls::IValueConverter ^ Converter { Microsoft::Maui::Controls::IValueConverter ^ get(); void set(Microsoft::Maui::Controls::IValueConverter ^ value); };" />
<MemberSignature Language="F#" Value="member this.Converter : Microsoft.Maui.Controls.IValueConverter with get, set" Usage="Microsoft.Maui.Controls.Binding.Converter" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Maui.Controls</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Maui.Controls.IValueConverter</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets the converter to be used for this binding ?</summary>
<value>An IValueConverter, or <see langword="null" />.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ConverterParameter">
<MemberSignature Language="C#" Value="public object ConverterParameter { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance object ConverterParameter" />
<MemberSignature Language="DocId" Value="P:Microsoft.Maui.Controls.Binding.ConverterParameter" />
<MemberSignature Language="VB.NET" Value="Public Property ConverterParameter As Object" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::Object ^ ConverterParameter { System::Object ^ get(); void set(System::Object ^ value); };" />
<MemberSignature Language="F#" Value="member this.ConverterParameter : obj with get, set" Usage="Microsoft.Maui.Controls.Binding.ConverterParameter" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Maui.Controls</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Object</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets the parameter passed as argument to the converter.</summary>
<value>An object, or <see langword="null" />.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="DoNothing">
<MemberSignature Language="C#" Value="public static readonly object DoNothing;" />
<MemberSignature Language="ILAsm" Value=".field public static initonly object DoNothing" />
<MemberSignature Language="DocId" Value="F:Microsoft.Maui.Controls.Binding.DoNothing" />
<MemberSignature Language="VB.NET" Value="Public Shared ReadOnly DoNothing As Object " />
<MemberSignature Language="C++ CLI" Value="public: static initonly System::Object ^ DoNothing;" />
<MemberSignature Language="F#" Value=" staticval mutable DoNothing : obj" Usage="Microsoft.Maui.Controls.Binding.DoNothing" />
<MemberType>Field</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Maui.Controls</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Object</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Path">
<MemberSignature Language="C#" Value="public string Path { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string Path" />
<MemberSignature Language="DocId" Value="P:Microsoft.Maui.Controls.Binding.Path" />
<MemberSignature Language="VB.NET" Value="Public Property Path As String" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::String ^ Path { System::String ^ get(); void set(System::String ^ value); };" />
<MemberSignature Language="F#" Value="member this.Path : string with get, set" Usage="Microsoft.Maui.Controls.Binding.Path" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Maui.Controls</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets the path of the property</summary>
<value>A string indicating the path to the property.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="SelfPath">
<MemberSignature Language="C#" Value="public const string SelfPath;" />
<MemberSignature Language="ILAsm" Value=".field public static literal string SelfPath" />
<MemberSignature Language="DocId" Value="F:Microsoft.Maui.Controls.Binding.SelfPath" />
<MemberSignature Language="VB.NET" Value="Public Const SelfPath As String " />
<MemberSignature Language="C++ CLI" Value="public: System::String ^ SelfPath;" />
<MemberSignature Language="F#" Value="val mutable SelfPath : string" Usage="Microsoft.Maui.Controls.Binding.SelfPath" />
<MemberType>Field</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Maui.Controls</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Source">
<MemberSignature Language="C#" Value="public object Source { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance object Source" />
<MemberSignature Language="DocId" Value="P:Microsoft.Maui.Controls.Binding.Source" />
<MemberSignature Language="VB.NET" Value="Public Property Source As Object" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::Object ^ Source { System::Object ^ get(); void set(System::Object ^ value); };" />
<MemberSignature Language="F#" Value="member this.Source : obj with get, set" Usage="Microsoft.Maui.Controls.Binding.Source" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Maui.Controls</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Object</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets the source of the binding.</summary>
<value>An object used as the binding source.</value>
<remarks>If the Source is not null, the BindingContext is ignored, and the Source is used instead. This allows to set a source for a single Binding, and not for all the Bindings applied to the BindableObject.</remarks>
</Docs>
</Member>
<Member MemberName="UpdateSourceEventName">
<MemberSignature Language="C#" Value="public string UpdateSourceEventName { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string UpdateSourceEventName" />
<MemberSignature Language="DocId" Value="P:Microsoft.Maui.Controls.Binding.UpdateSourceEventName" />
<MemberSignature Language="VB.NET" Value="Public Property UpdateSourceEventName As String" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::String ^ UpdateSourceEventName { System::String ^ get(); void set(System::String ^ value); };" />
<MemberSignature Language="F#" Value="member this.UpdateSourceEventName : string with get, set" Usage="Microsoft.Maui.Controls.Binding.UpdateSourceEventName" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Maui.Controls</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)]</AttributeName>
<AttributeName Language="F#">[<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>For internal use by the Microsoft.Maui.Controls platform.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>