GalaSoft.MvvmLight.Platform.XML 65 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931
  1. <?xml version="1.0"?>
  2. <doc>
  3. <assembly>
  4. <name>GalaSoft.MvvmLight.Platform</name>
  5. </assembly>
  6. <members>
  7. <member name="T:GalaSoft.MvvmLight.Helpers.Binding">
  8. <summary>
  9. Base class for bindings in Xamarin.iOS and Xamarin.Android.
  10. </summary>
  11. </member>
  12. <member name="F:GalaSoft.MvvmLight.Helpers.Binding.TopSource">
  13. <summary>
  14. The source at the "top" of the property chain.
  15. </summary>
  16. </member>
  17. <member name="F:GalaSoft.MvvmLight.Helpers.Binding.TopTarget">
  18. <summary>
  19. The target at the "top" of the property chain.
  20. </summary>
  21. </member>
  22. <member name="M:GalaSoft.MvvmLight.Helpers.Binding.Detach">
  23. <summary>
  24. Instructs the Binding instance to stop listening to value changes and to
  25. remove all listeneners.
  26. </summary>
  27. </member>
  28. <member name="M:GalaSoft.MvvmLight.Helpers.Binding.ForceUpdateValueFromSourceToTarget">
  29. <summary>
  30. Forces the Binding's value to be reevaluated. The target value will
  31. be set to the source value.
  32. </summary>
  33. </member>
  34. <member name="M:GalaSoft.MvvmLight.Helpers.Binding.ForceUpdateValueFromTargetToSource">
  35. <summary>
  36. Forces the Binding's value to be reevaluated. The source value will
  37. be set to the target value.
  38. </summary>
  39. </member>
  40. <member name="E:GalaSoft.MvvmLight.Helpers.Binding.ValueChanged">
  41. <summary>
  42. Occurs when the value of the databound property changes.
  43. </summary>
  44. </member>
  45. <member name="P:GalaSoft.MvvmLight.Helpers.Binding.Mode">
  46. <summary>
  47. The mode of the binding. OneTime means that the target property will be set once (when the binding is
  48. created) but that subsequent changes will be ignored. OneWay means that the target property will be set, and
  49. if the PropertyChanged event is raised by the source, the target property will be updated. TwoWay means that the source
  50. property will also be updated if the target raises the PropertyChanged event. Default means OneWay if only the source
  51. implements INPC, and TwoWay if both the source and the target implement INPC.
  52. </summary>
  53. </member>
  54. <member name="P:GalaSoft.MvvmLight.Helpers.Binding.Source">
  55. <summary>
  56. Gets the source object for the binding.
  57. </summary>
  58. </member>
  59. <member name="P:GalaSoft.MvvmLight.Helpers.Binding.Target">
  60. <summary>
  61. Gets the target object for the binding.
  62. </summary>
  63. </member>
  64. <member name="T:GalaSoft.MvvmLight.Helpers.Binding`2">
  65. <summary>
  66. Creates a binding between two properties. If the source implements INotifyPropertyChanged, the source property raises the PropertyChanged event
  67. and the BindingMode is OneWay or TwoWay, the target property will be synchronized with the source property. If
  68. the target implements INotifyPropertyChanged, the target property raises the PropertyChanged event and the BindingMode is
  69. TwoWay, the source property will also be synchronized with the target property.
  70. </summary>
  71. <typeparam name="TSource">The type of the source property that is being databound.</typeparam>
  72. <typeparam name="TTarget">The type of the target property that is being databound. If the source type
  73. is not the same as the target type, an automatic conversion will be attempted. However only
  74. simple types can be converted. For more complex conversions, use the <see cref="M:GalaSoft.MvvmLight.Helpers.Binding`2.ConvertSourceToTarget(System.Func{`0,`1})"/>
  75. and <see cref="M:GalaSoft.MvvmLight.Helpers.Binding`2.ConvertTargetToSource(System.Func{`1,`0})"/> methods to define custom converters.</typeparam>
  76. </member>
  77. <member name="M:GalaSoft.MvvmLight.Helpers.Binding`2.#ctor(System.Object,System.String,System.Object,System.String,GalaSoft.MvvmLight.Helpers.BindingMode)">
  78. <summary>
  79. Initializes a new instance of the Binding class for which the source and target properties
  80. are located in different objects.
  81. </summary>
  82. <param name="source">The source of the binding. If this object implements INotifyPropertyChanged and the
  83. BindingMode is OneWay or TwoWay, the target will be notified of changes to the target property.</param>
  84. <param name="sourcePropertyName">The name of the source property for the binding.</param>
  85. <param name="target">The target of the binding. If this object implements INotifyPropertyChanged and the
  86. BindingMode is TwoWay, the source will be notified of changes to the source property.</param>
  87. <param name="targetPropertyName">The name of the target property for the binding.</param>
  88. <param name="mode">The mode of the binding. OneTime means that the target property will be set once (when the binding is
  89. created) but that subsequent changes will be ignored. OneWay means that the target property will be set, and
  90. if the PropertyChanged event is raised by the source, the target property will be updated. TwoWay means that the source
  91. property will also be updated if the target raises the PropertyChanged event. Default means OneWay if only the source
  92. implements INPC, and TwoWay if both the source and the target implement INPC.</param>
  93. </member>
  94. <member name="M:GalaSoft.MvvmLight.Helpers.Binding`2.#ctor(System.Object,System.Linq.Expressions.Expression{System.Func{`0}},System.Object,System.Linq.Expressions.Expression{System.Func{`1}},GalaSoft.MvvmLight.Helpers.BindingMode)">
  95. <summary>
  96. Initializes a new instance of the Binding class for which the source and target properties
  97. are located in different objects.
  98. </summary>
  99. <param name="source">The source of the binding. If this object implements INotifyPropertyChanged and the
  100. BindingMode is OneWay or TwoWay, the target will be notified of changes to the target property.</param>
  101. <param name="sourcePropertyExpression">An expression pointing to the source property. It can be
  102. a simple expression "() => [source].MyProperty" or a composed expression "() => [source].SomeObject.SomeOtherObject.SomeProperty".</param>
  103. <param name="target">The target of the binding. If this object implements INotifyPropertyChanged and the
  104. BindingMode is TwoWay, the source will be notified of changes to the source property.</param>
  105. <param name="targetPropertyExpression">An expression pointing to the target property. It can be
  106. a simple expression "() => [target].MyProperty" or a composed expression "() => [target].SomeObject.SomeOtherObject.SomeProperty".</param>
  107. <param name="mode">The mode of the binding. OneTime means that the target property will be set once (when the binding is
  108. created) but that subsequent changes will be ignored. OneWay means that the target property will be set, and
  109. if the PropertyChanged event is raised by the source, the target property will be updated. TwoWay means that the source
  110. property will also be updated if the target raises the PropertyChanged event. Default means OneWay if only the source
  111. implements INPC, and TwoWay if both the source and the target implement INPC.</param>
  112. </member>
  113. <member name="M:GalaSoft.MvvmLight.Helpers.Binding`2.ConvertSourceToTarget(System.Func{`0,`1})">
  114. <summary>
  115. Defines a custom conversion method for a binding. To be used when the
  116. binding's source property is of a different type than the binding's
  117. target property, and the conversion cannot be done automatically (simple
  118. values).
  119. </summary>
  120. <param name="convert">A func that will be called with the source
  121. property's value, and will return the target property's value.</param>
  122. <returns>The Binding instance.</returns>
  123. </member>
  124. <member name="M:GalaSoft.MvvmLight.Helpers.Binding`2.ConvertTargetToSource(System.Func{`1,`0})">
  125. <summary>
  126. Defines a custom conversion method for a two-way binding. To be used when the
  127. binding's target property is of a different type than the binding's
  128. source property, and the conversion cannot be done automatically (simple
  129. values).
  130. </summary>
  131. <param name="convertBack">A func that will be called with the source
  132. property's value, and will return the target property's value.</param>
  133. <returns>The Binding instance.</returns>
  134. <remarks>This method is inactive on OneTime or OneWay bindings.</remarks>
  135. </member>
  136. <member name="M:GalaSoft.MvvmLight.Helpers.Binding`2.Detach">
  137. <summary>
  138. Instructs the Binding instance to stop listening to value changes and to
  139. remove all listeneners.
  140. </summary>
  141. </member>
  142. <member name="M:GalaSoft.MvvmLight.Helpers.Binding`2.ForceUpdateValueFromSourceToTarget">
  143. <summary>
  144. Forces the Binding's value to be reevaluated. The target value will
  145. be set to the source value.
  146. </summary>
  147. </member>
  148. <member name="M:GalaSoft.MvvmLight.Helpers.Binding`2.ForceUpdateValueFromTargetToSource">
  149. <summary>
  150. Forces the Binding's value to be reevaluated. The source value will
  151. be set to the target value.
  152. </summary>
  153. </member>
  154. <member name="M:GalaSoft.MvvmLight.Helpers.Binding`2.UpdateSourceTrigger(System.String)">
  155. <summary>
  156. Define when the binding should be evaluated when the bound source object
  157. is a control. Because Xamarin controls are not DependencyObjects, the
  158. bound property will not automatically update the binding attached to it. Instead,
  159. use this method to define which of the control's events should be observed.
  160. </summary>
  161. <param name="eventName">The name of the event that should be observed
  162. to update the binding's value.</param>
  163. <returns>The Binding instance.</returns>
  164. <exception cref="T:System.InvalidOperationException">When this method is called
  165. on a OneTime binding. Such bindings cannot be updated. This exception can
  166. also be thrown when the source object is null or has already been
  167. garbage collected before this method is called.</exception>
  168. <exception cref="T:System.ArgumentNullException">When the eventName parameter is null
  169. or is an empty string.</exception>
  170. <exception cref="T:System.ArgumentException">When the requested event does not exist on the
  171. source control.</exception>
  172. </member>
  173. <member name="M:GalaSoft.MvvmLight.Helpers.Binding`2.UpdateSourceTrigger">
  174. <summary>
  175. Define that the binding should be evaluated when the bound control's source property changes.
  176. Because Xamarin controls are not DependencyObjects, the
  177. bound property will not automatically update the binding attached to it. Instead,
  178. use this method to specify that the binding must be updated when the property changes.
  179. </summary>
  180. <remarks>This method should only be used with the following items:
  181. <para>- an EditText control and its Text property (TextChanged event).</para>
  182. <para>- a CompoundButton control and its Checked property (CheckedChange event).</para>
  183. </remarks>
  184. <returns>The Binding instance.</returns>
  185. <exception cref="T:System.InvalidOperationException">When this method is called
  186. on a OneTime binding. Such bindings cannot be updated. This exception can
  187. also be thrown when the source object is null or has already been
  188. garbage collected before this method is called.</exception>
  189. </member>
  190. <member name="M:GalaSoft.MvvmLight.Helpers.Binding`2.UpdateSourceTrigger(GalaSoft.MvvmLight.Helpers.UpdateTriggerMode)">
  191. <summary>
  192. Define when the binding should be evaluated when the bound source object
  193. is a control. Because Xamarin controls are not DependencyObjects, the
  194. bound property will not automatically update the binding attached to it. Instead,
  195. use this method to define which of the control's events should be observed.
  196. </summary>
  197. <param name="mode">Defines the binding's update mode. Use
  198. <see cref="F:GalaSoft.MvvmLight.Helpers.UpdateTriggerMode.LostFocus"/> to update the binding when
  199. the source control loses the focus. You can also use
  200. <see cref="F:GalaSoft.MvvmLight.Helpers.UpdateTriggerMode.PropertyChanged"/> to update the binding
  201. when the source control's property changes.
  202. The PropertyChanged mode should only be used with the following items:
  203. <para>- an EditText control and its Text property (TextChanged event).</para>
  204. <para>- a CompoundButton control and its Checked property (CheckedChange event).</para>
  205. </param>
  206. <returns>The Binding instance.</returns>
  207. <exception cref="T:System.InvalidOperationException">When this method is called
  208. on a OneTime binding. Such bindings cannot be updated. This exception can
  209. also be thrown when the source object is null or has already been
  210. garbage collected before this method is called.</exception>
  211. </member>
  212. <member name="M:GalaSoft.MvvmLight.Helpers.Binding`2.UpdateSourceTrigger``1(System.String)">
  213. <summary>
  214. Define when the binding should be evaluated when the bound source object
  215. is a control. Because Xamarin controls are not DependencyObjects, the
  216. bound property will not automatically update the binding attached to it. Instead,
  217. use this method to define which of the control's events should be observed.
  218. </summary>
  219. <remarks>Use this method when the event requires a specific EventArgs type
  220. instead of the standard EventHandler.</remarks>
  221. <typeparam name="TEventArgs">The type of the EventArgs used by this control's event.</typeparam>
  222. <param name="eventName">The name of the event that should be observed
  223. to update the binding's value.</param>
  224. <returns>The Binding instance.</returns>
  225. <exception cref="T:System.InvalidOperationException">When this method is called
  226. on a OneTime binding. Such bindings cannot be updated. This exception can
  227. also be thrown when the source object is null or has already been
  228. garbage collected before this method is called.</exception>
  229. <exception cref="T:System.ArgumentNullException">When the eventName parameter is null
  230. or is an empty string.</exception>
  231. <exception cref="T:System.ArgumentException">When the requested event does not exist on the
  232. source control.</exception>
  233. </member>
  234. <member name="M:GalaSoft.MvvmLight.Helpers.Binding`2.UpdateTargetTrigger">
  235. <summary>
  236. Define that the binding should be evaluated when the bound control's target property changes.
  237. Because Xamarin controls are not DependencyObjects, the
  238. bound property will not automatically update the binding attached to it. Instead,
  239. use this method to specify that the binding must be updated when the property changes.
  240. </summary>
  241. <remarks>This method should only be used with the following items:
  242. <para>- an EditText control and its Text property (TextChanged event).</para>
  243. <para>- a CompoundButton control and its Checked property (CheckedChange event).</para>
  244. </remarks>
  245. <returns>The Binding instance.</returns>
  246. <exception cref="T:System.InvalidOperationException">When this method is called
  247. on a OneTime or a OneWay binding. This exception can
  248. also be thrown when the target object is null or has already been
  249. garbage collected before this method is called.</exception>
  250. </member>
  251. <member name="M:GalaSoft.MvvmLight.Helpers.Binding`2.UpdateTargetTrigger(GalaSoft.MvvmLight.Helpers.UpdateTriggerMode)">
  252. <summary>
  253. Define when the binding should be evaluated when the bound target object
  254. is a control. Because Xamarin controls are not DependencyObjects, the
  255. bound property will not automatically update the binding attached to it. Instead,
  256. use this method to define which of the control's events should be observed.
  257. </summary>
  258. <param name="mode">Defines the binding's update mode. Use
  259. <see cref="F:GalaSoft.MvvmLight.Helpers.UpdateTriggerMode.LostFocus"/> to update the binding when
  260. the source control loses the focus. You can also use
  261. <see cref="F:GalaSoft.MvvmLight.Helpers.UpdateTriggerMode.PropertyChanged"/> to update the binding
  262. when the source control's property changes.
  263. The PropertyChanged mode should only be used with the following items:
  264. <para>- an EditText control and its Text property (TextChanged event).</para>
  265. <para>- a CompoundButton control and its Checked property (CheckedChange event).</para>
  266. </param>
  267. <returns>The Binding instance.</returns>
  268. <exception cref="T:System.InvalidOperationException">When this method is called
  269. on a OneTime or a OneWay binding. This exception can
  270. also be thrown when the source object is null or has already been
  271. garbage collected before this method is called.</exception>
  272. </member>
  273. <member name="M:GalaSoft.MvvmLight.Helpers.Binding`2.UpdateTargetTrigger(System.String)">
  274. <summary>
  275. Define when the binding should be evaluated when the bound target object
  276. is a control. Because Xamarin controls are not DependencyObjects, the
  277. bound property will not automatically update the binding attached to it. Instead,
  278. use this method to define which of the control's events should be observed.
  279. </summary>
  280. <param name="eventName">The name of the event that should be observed
  281. to update the binding's value.</param>
  282. <returns>The Binding instance.</returns>
  283. <exception cref="T:System.InvalidOperationException">When this method is called
  284. on a OneTime or a OneWay binding. This exception can
  285. also be thrown when the source object is null or has already been
  286. garbage collected before this method is called.</exception>
  287. <exception cref="T:System.ArgumentNullException">When the eventName parameter is null
  288. or is an empty string.</exception>
  289. <exception cref="T:System.ArgumentException">When the requested event does not exist on the
  290. target control.</exception>
  291. </member>
  292. <member name="M:GalaSoft.MvvmLight.Helpers.Binding`2.UpdateTargetTrigger``1(System.String)">
  293. <summary>
  294. Define when the binding should be evaluated when the bound target object
  295. is a control. Because Xamarin controls are not DependencyObjects, the
  296. bound property will not automatically update the binding attached to it. Instead,
  297. use this method to define which of the control's events should be observed.
  298. </summary>
  299. <remarks>Use this method when the event requires a specific EventArgs type
  300. instead of the standard EventHandler.</remarks>
  301. <typeparam name="TEventArgs">The type of the EventArgs used by this control's event.</typeparam>
  302. <param name="eventName">The name of the event that should be observed
  303. to update the binding's value.</param>
  304. <returns>The Binding instance.</returns>
  305. <exception cref="T:System.InvalidOperationException">When this method is called
  306. on a OneTime or OneWay binding. This exception can
  307. also be thrown when the target object is null or has already been
  308. garbage collected before this method is called.</exception>
  309. <exception cref="T:System.ArgumentNullException">When the eventName parameter is null
  310. or is an empty string.</exception>
  311. <exception cref="T:System.ArgumentException">When the requested event does not exist on the
  312. target control.</exception>
  313. </member>
  314. <member name="M:GalaSoft.MvvmLight.Helpers.Binding`2.WhenSourceChanges(System.Action)">
  315. <summary>
  316. Defines an action that will be executed every time that the binding value
  317. changes.
  318. </summary>
  319. <param name="callback">The action that will be executed when the binding changes.</param>
  320. <returns>The Binding instance.</returns>
  321. <exception cref="T:System.InvalidOperationException">When WhenSourceChanges is called on
  322. a binding which already has a target property set.</exception>
  323. </member>
  324. <member name="E:GalaSoft.MvvmLight.Helpers.Binding`2.ValueChanged">
  325. <summary>
  326. Occurs when the value of the databound property changes.
  327. </summary>
  328. </member>
  329. <member name="P:GalaSoft.MvvmLight.Helpers.Binding`2.Value">
  330. <summary>
  331. Gets the current value of the binding.
  332. </summary>
  333. </member>
  334. <member name="T:System.Windows.IWeakEventListener">
  335. <summary>
  336. Provides event listening support for classes that expect to receive events
  337. through the WeakEvent pattern and a WeakEventManager.
  338. </summary>
  339. </member>
  340. <member name="M:System.Windows.IWeakEventListener.ReceiveWeakEvent(System.Type,System.Object,System.EventArgs)">
  341. <summary>
  342. Receives events from the centralized event manager.
  343. </summary>
  344. <param name="managerType">The type of the WeakEventManager calling this method.</param>
  345. <param name="sender">Object that originated the event.</param>
  346. <param name="e">Event data.</param>
  347. <returns>true if the listener handled the event. It is considered an error by the
  348. WeakEventManager handling in WPF to register a listener for an event that the
  349. listener does not handle. Regardless, the method should return false if it receives
  350. an event that it does not recognize or handle.
  351. </returns>
  352. </member>
  353. <member name="T:GalaSoft.MvvmLight.Helpers.BindingMode">
  354. <summary>
  355. The mode of the <see cref="T:GalaSoft.MvvmLight.Helpers.Binding`2"/>.
  356. </summary>
  357. </member>
  358. <member name="F:GalaSoft.MvvmLight.Helpers.BindingMode.Default">
  359. <summary>
  360. A default binding is a one way binding.
  361. </summary>
  362. </member>
  363. <member name="F:GalaSoft.MvvmLight.Helpers.BindingMode.OneTime">
  364. <summary>
  365. A one time binding. The binding's value will be set when the
  366. binding is created but subsequent changes will be ignored/
  367. </summary>
  368. </member>
  369. <member name="F:GalaSoft.MvvmLight.Helpers.BindingMode.OneWay">
  370. <summary>
  371. A one way binding, where the changes to the source
  372. property will update the target property, but changes to the
  373. target property don't affect the source property.
  374. </summary>
  375. </member>
  376. <member name="F:GalaSoft.MvvmLight.Helpers.BindingMode.TwoWay">
  377. <summary>
  378. A two way binding, where the changes to the source
  379. property will update the target property, and vice versa.
  380. </summary>
  381. </member>
  382. <member name="T:GalaSoft.MvvmLight.Helpers.Extensions">
  383. <summary>
  384. Defines extension methods used to add data bindings and commands between Xamarin
  385. Android and iOS elements.
  386. </summary>
  387. </member>
  388. <member name="M:GalaSoft.MvvmLight.Helpers.Extensions.SetBinding``2(System.Object,System.Linq.Expressions.Expression{System.Func{``0}},System.Object,System.Linq.Expressions.Expression{System.Func{``1}},GalaSoft.MvvmLight.Helpers.BindingMode)">
  389. <summary>
  390. Sets a data binding between two properties. If the source implements INotifyPropertyChanged, the source property raises the PropertyChanged event
  391. and the BindingMode is OneWay or TwoWay, the target property will be synchronized with the source property. If
  392. the target implements INotifyPropertyChanged, the target property raises the PropertyChanged event and the BindingMode is
  393. TwoWay, the source property will also be synchronized with the target property.
  394. </summary>
  395. <remarks>This class allows for a different TSource and TTarget and is able to perform simple
  396. type conversions automatically. This is useful if the source property and the target
  397. property are of different type.
  398. If the type conversion is complex, please use the <see cref="M:GalaSoft.MvvmLight.Helpers.Binding`2.ConvertSourceToTarget(System.Func{`0,`1})"/>
  399. and <see cref="M:GalaSoft.MvvmLight.Helpers.Binding`2.ConvertTargetToSource(System.Func{`1,`0})"/> methods to configure the binding.
  400. It is very possible that TSource and TTarget are the same type in which case no conversion occurs.</remarks>
  401. <typeparam name="TSource">The type of the property that is being databound before conversion.</typeparam>
  402. <typeparam name="TTarget">The type of the property that is being databound after conversion.</typeparam>
  403. <param name="target">The target of the binding. If this object implements INotifyPropertyChanged and the
  404. BindingMode is TwoWay, the source will be notified of changes to the source property.</param>
  405. <param name="targetPropertyExpression">An expression pointing to the target property. It can be
  406. a simple expression "() =&gt; [target].MyProperty" or a composed expression "() =&gt; [target].SomeObject.SomeOtherObject.SomeProperty".</param>
  407. <param name="source">The source of the binding. If this object implements INotifyPropertyChanged and the
  408. BindingMode is OneWay or TwoWay, the target will be notified of changes to the target property.</param>
  409. <param name="sourcePropertyExpression">An expression pointing to the source property. It can be
  410. a simple expression "() =&gt; [source].MyProperty" or a composed expression "() =&gt; [source].SomeObject.SomeOtherObject.SomeProperty".</param>
  411. <param name="mode">The mode of the binding. OneTime means that the target property will be set once (when the binding is
  412. created) but that subsequent changes will be ignored. OneWay means that the target property will be set, and
  413. if the PropertyChanged event is raised by the source, the target property will be updated. TwoWay means that the source
  414. property will also be updated if the target raises the PropertyChanged event. Default means OneWay if only the source
  415. implements INPC, and TwoWay if both the source and the target implement INPC.</param>
  416. <returns>The new Binding instance.</returns>
  417. </member>
  418. <member name="M:GalaSoft.MvvmLight.Helpers.Extensions.SetBinding``1(System.Object,System.Linq.Expressions.Expression{System.Func{``0}},GalaSoft.MvvmLight.Helpers.BindingMode)">
  419. <summary>
  420. Creates a <see cref="T:GalaSoft.MvvmLight.Helpers.Binding`2"/> with a source property but without a target.
  421. This type of bindings is useful for the <see cref="M:GalaSoft.MvvmLight.Helpers.Extensions.SetCommand``2(System.Object,System.String,GalaSoft.MvvmLight.Command.RelayCommand{``0},GalaSoft.MvvmLight.Helpers.Binding)"/>
  422. and <see cref="M:GalaSoft.MvvmLight.Helpers.Extensions.SetCommand``2(System.Object,System.String,GalaSoft.MvvmLight.Command.RelayCommand{``0},GalaSoft.MvvmLight.Helpers.Binding)"/> methods, to use as CommandParameter
  423. binding.
  424. </summary>
  425. <param name="source">The source of the binding. If this object implements INotifyPropertyChanged and the
  426. BindingMode is OneWay or TwoWay, the target will be notified of changes to the target property.</param>
  427. <param name="sourcePropertyExpression">An expression pointing to the source property. It can be
  428. a simple expression "() =&gt; [source].MyProperty" or a composed expression "() =&gt; [source].SomeObject.SomeOtherObject.SomeProperty".</param>
  429. <param name="mode">The mode of the binding. OneTime means that the target property will be set once (when the binding is
  430. created) but that subsequent changes will be ignored. OneWay means that the target property will be set, and
  431. if the PropertyChanged event is raised by the source, the target property will be updated. TwoWay means that the source
  432. property will also be updated if the target raises the PropertyChanged event. Default means OneWay if only the source
  433. implements INPC, and TwoWay if both the source and the target implement INPC.</param>
  434. <typeparam name="TSource">The type of the bound property.</typeparam>
  435. <returns>The created binding instance.</returns>
  436. </member>
  437. <member name="M:GalaSoft.MvvmLight.Helpers.Extensions.SetBinding``2(System.Object,System.Linq.Expressions.Expression{System.Func{``0}},System.Linq.Expressions.Expression{System.Func{``1}},GalaSoft.MvvmLight.Helpers.BindingMode)">
  438. <summary>
  439. Sets a data binding between two properties of the same object. If the source implements INotifyPropertyChanged, has observable properties
  440. and the BindingMode is OneWay or TwoWay, the target property will be notified of changes to the source property. If
  441. the target implements INotifyPropertyChanged, has observable properties and the BindingMode is
  442. TwoWay, the source will also be notified of changes to the target's properties.
  443. </summary>
  444. <typeparam name="TSource">The type of the source property that is being databound.</typeparam>
  445. <typeparam name="TTarget">The type of the target property that is being databound. If the source type
  446. is not the same as the target type, an automatic conversion will be attempted. However only
  447. simple types can be converted. For more complex conversions, use the <see cref="M:GalaSoft.MvvmLight.Helpers.Binding`2.ConvertSourceToTarget(System.Func{`0,`1})"/>
  448. and <see cref="M:GalaSoft.MvvmLight.Helpers.Binding`2.ConvertTargetToSource(System.Func{`1,`0})"/> methods to define custom converters.</typeparam>
  449. <param name="targetPropertyExpression">An expression pointing to the target property. It can be
  450. a simple expression "() =&gt; [target].MyProperty" or a composed expression "() =&gt; [target].SomeObject.SomeOtherObject.SomeProperty".</param>
  451. <param name="source">The source of the binding. If this object implements INotifyPropertyChanged and the
  452. BindingMode is OneWay or TwoWay, the target will be notified of changes to the target property.</param>
  453. <param name="sourcePropertyExpression">An expression pointing to the source property. It can be
  454. a simple expression "() =&gt; [source].MyProperty" or a composed expression "() =&gt; [source].SomeObject.SomeOtherObject.SomeProperty".</param>
  455. <param name="mode">The mode of the binding. OneTime means that the target property will be set once (when the binding is
  456. created) but that subsequent changes will be ignored. OneWay means that the target property will be set, and
  457. if the PropertyChanged event is raised by the source, the target property will be updated. TwoWay means that the source
  458. property will also be updated if the target raises the PropertyChanged event. Default means OneWay if only the source
  459. implements INPC, and TwoWay if both the source and the target implement INPC.</param>
  460. <returns>The new Binding instance.</returns>
  461. </member>
  462. <member name="M:GalaSoft.MvvmLight.Helpers.Extensions.SetBinding``2(System.Object,System.String,System.Object,System.String,GalaSoft.MvvmLight.Helpers.BindingMode)">
  463. <summary>
  464. Sets a data binding between two properties. If the source implements INotifyPropertyChanged, the source property raises the PropertyChanged event
  465. and the BindingMode is OneWay or TwoWay, the target property will be synchronized with the source property. If
  466. the target implements INotifyPropertyChanged, the target property raises the PropertyChanged event and the BindingMode is
  467. TwoWay, the source property will also be synchronized with the target property.
  468. </summary>
  469. <typeparam name="TSource">The type of the source property that is being databound.</typeparam>
  470. <typeparam name="TTarget">The type of the target property that is being databound. If the source type
  471. is not the same as the target type, an automatic conversion will be attempted. However only
  472. simple types can be converted. For more complex conversions, use the <see cref="M:GalaSoft.MvvmLight.Helpers.Binding`2.ConvertSourceToTarget(System.Func{`0,`1})"/>
  473. and <see cref="M:GalaSoft.MvvmLight.Helpers.Binding`2.ConvertTargetToSource(System.Func{`1,`0})"/> methods to define custom converters.</typeparam>
  474. <param name="target">The target of the binding. If this object implements INotifyPropertyChanged and the
  475. BindingMode is TwoWay, the source will be notified of changes to the source property.</param>
  476. <param name="targetPropertyName">The name of the target property. This must be a simple name, without dots.</param>
  477. <param name="source">The source of the binding. If this object implements INotifyPropertyChanged and the
  478. BindingMode is OneWay or TwoWay, the target will be notified of changes to the target property.</param>
  479. <param name="sourcePropertyName">The name of the source property. This must be a simple name, without dots.</param>
  480. <param name="mode">The mode of the binding. OneTime means that the target property will be set once (when the binding is
  481. created) but that subsequent changes will be ignored. OneWay means that the target property will be set, and
  482. if the PropertyChanged event is raised by the source, the target property will be updated. TwoWay means that the source
  483. property will also be updated if the target raises the PropertyChanged event. Default means OneWay if only the source
  484. implements INPC, and TwoWay if both the source and the target implement INPC.</param>
  485. <returns>The new Binding instance.</returns>
  486. </member>
  487. <member name="M:GalaSoft.MvvmLight.Helpers.Extensions.SetBinding``2(System.Object,System.String,System.String,GalaSoft.MvvmLight.Helpers.BindingMode)">
  488. <summary>
  489. Sets a data binding between two properties of the same object. If the source implements INotifyPropertyChanged, has observable properties
  490. and the BindingMode is OneWay or TwoWay, the target property will be notified of changes to the source property. If
  491. the target implements INotifyPropertyChanged, has observable properties and the BindingMode is
  492. TwoWay, the source will also be notified of changes to the target's properties.
  493. </summary>
  494. <typeparam name="TSource">The type of the source property that is being databound.</typeparam>
  495. <typeparam name="TTarget">The type of the target property that is being databound. If the source type
  496. is not the same as the target type, an automatic conversion will be attempted. However only
  497. simple types can be converted. For more complex conversions, use the <see cref="M:GalaSoft.MvvmLight.Helpers.Binding`2.ConvertSourceToTarget(System.Func{`0,`1})"/>
  498. and <see cref="M:GalaSoft.MvvmLight.Helpers.Binding`2.ConvertTargetToSource(System.Func{`1,`0})"/> methods to define custom converters.</typeparam>
  499. <param name="targetPropertyName">The name of the target property. This must be a simple name, without dots.</param>
  500. <param name="source">The source of the binding. If this object implements INotifyPropertyChanged and the
  501. BindingMode is OneWay or TwoWay, the target will be notified of changes to the target property.</param>
  502. <param name="sourcePropertyName">The name of the source property. This must be a simple name, without dots.</param>
  503. <param name="mode">The mode of the binding. OneTime means that the target property will be set once (when the binding is
  504. created) but that subsequent changes will be ignored. OneWay means that the target property will be set, and
  505. if the PropertyChanged event is raised by the source, the target property will be updated. TwoWay means that the source
  506. property will also be updated if the target raises the PropertyChanged event. Default means OneWay if only the source
  507. implements INPC, and TwoWay if both the source and the target implement INPC.</param>
  508. <returns>The new Binding instance.</returns>
  509. </member>
  510. <member name="M:GalaSoft.MvvmLight.Helpers.Extensions.SetCommand``2(System.Object,System.String,GalaSoft.MvvmLight.Command.RelayCommand{``0},GalaSoft.MvvmLight.Helpers.Binding)">
  511. <summary>
  512. Sets a generic RelayCommand to an object and actuate the command when a specific event is raised. This method
  513. should be used when the event uses an EventHandler&lt;TEventArgs&gt;.
  514. </summary>
  515. <typeparam name="T">The type of the CommandParameter that will be passed to the RelayCommand.</typeparam>
  516. <typeparam name="TEventArgs">The type of the event's arguments.</typeparam>
  517. <param name="element">The element to which the command is added.</param>
  518. <param name="eventName">The name of the event that will be subscribed to to actuate the command.</param>
  519. <param name="command">The command that must be added to the element.</param>
  520. <param name="commandParameterBinding">A <see cref="T:GalaSoft.MvvmLight.Helpers.Binding`2">Binding</see> instance subscribed to
  521. the CommandParameter that will passed to the RelayCommand. Depending on the Binding, the CommandParameter
  522. will be observed and changes will be passed to the command, for example to update the CanExecute.</param>
  523. </member>
  524. <member name="M:GalaSoft.MvvmLight.Helpers.Extensions.SetCommand``1(System.Object,System.String,GalaSoft.MvvmLight.Command.RelayCommand{``0},GalaSoft.MvvmLight.Helpers.Binding)">
  525. <summary>
  526. Sets a generic RelayCommand to an object and actuate the command when a specific event is raised. This method
  527. can only be used when the event uses a standard EventHandler.
  528. </summary>
  529. <typeparam name="T">The type of the CommandParameter that will be passed to the RelayCommand.</typeparam>
  530. <param name="element">The element to which the command is added.</param>
  531. <param name="eventName">The name of the event that will be subscribed to to actuate the command.</param>
  532. <param name="command">The command that must be added to the element.</param>
  533. <param name="commandParameterBinding">A <see cref="T:GalaSoft.MvvmLight.Helpers.Binding`2">Binding</see> instance subscribed to
  534. the CommandParameter that will passed to the RelayCommand. Depending on the Binding, the CommandParameter
  535. will be observed and changes will be passed to the command, for example to update the CanExecute.</param>
  536. </member>
  537. <member name="M:GalaSoft.MvvmLight.Helpers.Extensions.SetCommand(System.Object,System.String,GalaSoft.MvvmLight.Command.RelayCommand)">
  538. <summary>
  539. Sets a non-generic RelayCommand to an object and actuate the command when a specific event is raised. This method
  540. can only be used when the event uses a standard EventHandler.
  541. </summary>
  542. <param name="element">The element to which the command is added.</param>
  543. <param name="eventName">The name of the event that will be subscribed to to actuate the command.</param>
  544. <param name="command">The command that must be added to the element.</param>
  545. </member>
  546. <member name="M:GalaSoft.MvvmLight.Helpers.Extensions.GetAdapter``1(System.Collections.ObjectModel.ObservableCollection{``0},System.Func{System.Int32,``0,Android.Views.View,Android.Views.View})">
  547. <summary>
  548. Creates a new <see cref="T:GalaSoft.MvvmLight.Helpers.ObservableAdapter`1"/> for a given <see cref="T:System.Collections.ObjectModel.ObservableCollection`1"/>.
  549. </summary>
  550. <typeparam name="T">The type of the items contained in the <see cref="T:System.Collections.ObjectModel.ObservableCollection`1"/>.</typeparam>
  551. <param name="collection">The collection that the adapter will be created for.</param>
  552. <param name="getTemplateDelegate">A method taking an item's position in the list, the item itself,
  553. and a recycled Android View, and returning an adapted View for this item. Note that the recycled
  554. view might be null, in which case a new View must be inflated by this method.</param>
  555. <returns>A View adapted for the item passed as parameter.</returns>
  556. </member>
  557. <member name="M:GalaSoft.MvvmLight.Helpers.Extensions.GetAdapter``1(System.Collections.Generic.IList{``0},System.Func{System.Int32,``0,Android.Views.View,Android.Views.View})">
  558. <summary>
  559. Creates a new <see cref="T:GalaSoft.MvvmLight.Helpers.ObservableAdapter`1"/> for a given <see cref="T:System.Collections.Generic.IList`1"/>.
  560. </summary>
  561. <typeparam name="T">The type of the items contained in the <see cref="T:System.Collections.Generic.IList`1"/>.</typeparam>
  562. <param name="list">The list that the adapter will be created for.</param>
  563. <param name="getTemplateDelegate">A method taking an item's position in the list, the item itself,
  564. and a recycled Android <see cref="T:Android.Views.View"/>, and returning an adapted View for this item. Note that the recycled
  565. View might be null, in which case a new View must be inflated by this method.</param>
  566. <returns>An adapter adapted to the collection passed in parameter..</returns>
  567. </member>
  568. <member name="T:GalaSoft.MvvmLight.Helpers.ObservableAdapter`1">
  569. <summary>
  570. A <see cref="T:Android.Widget.BaseAdapter`1"/> that can be used with an Android ListView. After setting
  571. the <see cref="P:GalaSoft.MvvmLight.Helpers.ObservableAdapter`1.DataSource"/> and the <see cref="P:GalaSoft.MvvmLight.Helpers.ObservableAdapter`1.GetTemplateDelegate"/> properties, the adapter is
  572. suitable for a list control. If the DataSource is an <see cref="T:System.Collections.Specialized.INotifyCollectionChanged"/>,
  573. changes to the collection will be observed and the UI will automatically be updated.
  574. </summary>
  575. <typeparam name="T">The type of the items contained in the <see cref="P:GalaSoft.MvvmLight.Helpers.ObservableAdapter`1.DataSource"/>.</typeparam>
  576. </member>
  577. <member name="M:GalaSoft.MvvmLight.Helpers.ObservableAdapter`1.GetItemId(System.Int32)">
  578. <summary>
  579. Returns a unique ID for the item corresponding to the position parameter.
  580. In this implementation, the method always returns the position itself.
  581. </summary>
  582. <param name="position">The position of the item for which the ID needs to be returned.</param>
  583. <returns>A unique ID for the item corresponding to the position parameter.</returns>
  584. </member>
  585. <member name="M:GalaSoft.MvvmLight.Helpers.ObservableAdapter`1.GetView(System.Int32,Android.Views.View,Android.Views.ViewGroup)">
  586. <summary>
  587. Prepares the view (template) for the item corresponding to the position
  588. in the DataSource. This method calls the <see cref="P:GalaSoft.MvvmLight.Helpers.ObservableAdapter`1.GetTemplateDelegate"/> method so that the caller
  589. can create (if necessary) and adapt the template for the corresponding item.
  590. </summary>
  591. <param name="position">The position of the item in the DataSource.</param>
  592. <param name="convertView">A recycled view. If this parameter is null,
  593. a new view must be inflated.</param>
  594. <param name="parent">The view's parent.</param>
  595. <returns>A view adapted for the item at the corresponding position.</returns>
  596. </member>
  597. <member name="P:GalaSoft.MvvmLight.Helpers.ObservableAdapter`1.Count">
  598. <summary>
  599. Gets the number of items in the DataSource.
  600. </summary>
  601. </member>
  602. <member name="P:GalaSoft.MvvmLight.Helpers.ObservableAdapter`1.DataSource">
  603. <summary>
  604. Gets or sets the list containing the items to be represented in the list control.
  605. </summary>
  606. </member>
  607. <member name="P:GalaSoft.MvvmLight.Helpers.ObservableAdapter`1.GetTemplateDelegate">
  608. <summary>
  609. Gets and sets a method taking an item's position in the list, the item itself,
  610. and a recycled Android View, and returning an adapted View for this item. Note that the recycled
  611. view might be null, in which case a new View must be inflated by this method.
  612. </summary>
  613. </member>
  614. <member name="P:GalaSoft.MvvmLight.Helpers.ObservableAdapter`1.Item(System.Int32)">
  615. <summary>
  616. Gets the item corresponding to the index in the DataSource.
  617. </summary>
  618. <param name="index">The index of the item that needs to be returned.</param>
  619. <returns>The item corresponding to the index in the DataSource</returns>
  620. </member>
  621. <member name="T:System.Windows.PropertyChangedEventManager">
  622. <summary>
  623. Provides an implementation so that you can use the
  624. "weak event listener" pattern to attach listeners
  625. for the <see cref="M:System.Windows.PropertyChangedEventManager.PropertyChanged(System.Object,System.ComponentModel.PropertyChangedEventArgs)"/> event.
  626. </summary>
  627. </member>
  628. <member name="M:System.Windows.PropertyChangedEventManager.AddListener(System.ComponentModel.INotifyPropertyChanged,System.Windows.IWeakEventListener,System.String)">
  629. <summary>
  630. Adds the specified listener to the list of listeners on the specified source.
  631. </summary>
  632. <param name="source">The object with the event.</param>
  633. <param name="listener">The object to add as a listener.</param>
  634. <param name="propertyName">The name of the property that exists on
  635. source upon which to listen for changes.</param>
  636. </member>
  637. <member name="M:System.Windows.PropertyChangedEventManager.RemoveListener(System.Windows.IWeakEventListener)">
  638. <summary>
  639. Removes the specified listener from the list of listeners on the
  640. specified source.
  641. </summary>
  642. <param name="listener">The object to remove as a listener.</param>
  643. </member>
  644. <member name="M:System.Windows.PropertyChangedEventManager.StartListening(System.ComponentModel.INotifyPropertyChanged)">
  645. <summary>
  646. Begin listening for the <see cref="M:System.Windows.PropertyChangedEventManager.PropertyChanged(System.Object,System.ComponentModel.PropertyChangedEventArgs)"/> event on
  647. the provided source.
  648. </summary>
  649. <param name="source">The object on which to start listening
  650. for <see cref="M:System.Windows.PropertyChangedEventManager.PropertyChanged(System.Object,System.ComponentModel.PropertyChangedEventArgs)"/>.</param>
  651. </member>
  652. <member name="M:System.Windows.PropertyChangedEventManager.StopListening(System.ComponentModel.INotifyPropertyChanged)">
  653. <summary>
  654. Stop listening for the <see cref="M:System.Windows.PropertyChangedEventManager.PropertyChanged(System.Object,System.ComponentModel.PropertyChangedEventArgs)"/> event on the
  655. provided source.
  656. </summary>
  657. <param name="source">The object on which to start listening for
  658. <see cref="M:System.Windows.PropertyChangedEventManager.PropertyChanged(System.Object,System.ComponentModel.PropertyChangedEventArgs)"/>.</param>
  659. </member>
  660. <member name="M:System.Windows.PropertyChangedEventManager.PropertyChanged(System.Object,System.ComponentModel.PropertyChangedEventArgs)">
  661. <summary>
  662. The method that handles the <see cref="E:System.ComponentModel.INotifyPropertyChanged.PropertyChanged"/> event.
  663. </summary>
  664. <param name="sender">The source of the event.</param>
  665. <param name="args">A <see cref="T:System.ComponentModel.PropertyChangedEventArgs"/> that
  666. contains the event data.</param>
  667. </member>
  668. <member name="M:System.Windows.PropertyChangedEventManager.PrivateAddListener(System.ComponentModel.INotifyPropertyChanged,System.Windows.IWeakEventListener,System.String)">
  669. <summary>
  670. Private method to add the specified listener to the list of listeners
  671. on the specified source.
  672. </summary>
  673. <param name="source">The object with the event.</param>
  674. <param name="listener">The object to add as a listener.</param>
  675. <param name="propertyName">The name of the property that exists
  676. on source upon which to listen for changes.</param>
  677. </member>
  678. <member name="M:System.Windows.PropertyChangedEventManager.PrivateRemoveListener(System.Windows.IWeakEventListener)">
  679. <summary>
  680. Private method to remove the specified listener from the list of listeners
  681. on the specified source.
  682. </summary>
  683. <param name="listener">The object to remove as a listener.</param>
  684. </member>
  685. <member name="P:System.Windows.PropertyChangedEventManager.Instance">
  686. <summary>
  687. Get the current instance of <see cref="T:System.Windows.PropertyChangedEventManager"/>
  688. </summary>
  689. </member>
  690. <member name="T:GalaSoft.MvvmLight.Helpers.UpdateTriggerMode">
  691. <summary>
  692. Defines how a <see cref="T:GalaSoft.MvvmLight.Helpers.Binding"/> is updated by a source control.
  693. </summary>
  694. </member>
  695. <member name="F:GalaSoft.MvvmLight.Helpers.UpdateTriggerMode.LostFocus">
  696. <summary>
  697. Defines that the binding should be updated when the control
  698. loses the focus.
  699. </summary>
  700. </member>
  701. <member name="F:GalaSoft.MvvmLight.Helpers.UpdateTriggerMode.PropertyChanged">
  702. <summary>
  703. Defines that the binding should be updated when the control's
  704. bound property changes.
  705. </summary>
  706. </member>
  707. <member name="T:GalaSoft.MvvmLight.Views.ActivityBase">
  708. <summary>
  709. A base class for Activities that allow the <see cref="T:GalaSoft.MvvmLight.Views.NavigationService"/>
  710. to keep track of the navigation journal.
  711. </summary>
  712. </member>
  713. <member name="M:GalaSoft.MvvmLight.Views.ActivityBase.GoBack">
  714. <summary>
  715. If possible, discards the current page and displays the previous page
  716. on the navigation stack.
  717. </summary>
  718. </member>
  719. <member name="M:GalaSoft.MvvmLight.Views.ActivityBase.OnDestroy">
  720. <summary>
  721. Overrides <see cref="M:Android.App.Activity.OnDestroy"/>. If you override
  722. this method in your own Activities, make sure to call
  723. base.OnDestroy to allow the <see cref="T:GalaSoft.MvvmLight.Views.NavigationService"/>
  724. to work properly.
  725. </summary>
  726. </member>
  727. <member name="M:GalaSoft.MvvmLight.Views.ActivityBase.OnPause">
  728. <summary>
  729. Overrides <see cref="M:Android.App.Activity.OnPause"/>. If you override
  730. this method in your own Activities, make sure to call
  731. base.OnPause to allow the <see cref="T:GalaSoft.MvvmLight.Views.NavigationService"/>
  732. to work properly.
  733. </summary>
  734. </member>
  735. <member name="M:GalaSoft.MvvmLight.Views.ActivityBase.OnResume">
  736. <summary>
  737. Overrides <see cref="M:Android.App.Activity.OnResume"/>. If you override
  738. this method in your own Activities, make sure to call
  739. base.OnResume to allow the <see cref="T:GalaSoft.MvvmLight.Views.NavigationService"/>
  740. to work properly.
  741. </summary>
  742. </member>
  743. <member name="P:GalaSoft.MvvmLight.Views.ActivityBase.CurrentActivity">
  744. <summary>
  745. The activity that is currently in the foreground.
  746. </summary>
  747. </member>
  748. <member name="T:GalaSoft.MvvmLight.Views.DialogService">
  749. <summary>
  750. An implementation of <see cref="T:GalaSoft.MvvmLight.Views.IDialogService"/> allowing
  751. to display simple dialogs to the user. Note that this class
  752. uses the built in Android dialogs which may or may not
  753. be sufficient for your needs. Using this class is easy
  754. but feel free to develop your own IDialogService implementation
  755. if needed.
  756. </summary>
  757. </member>
  758. <member name="M:GalaSoft.MvvmLight.Views.DialogService.ShowError(System.String,System.String,System.String,System.Action)">
  759. <summary>
  760. Displays information about an error.
  761. </summary>
  762. <param name="message">The message to be shown to the user.</param>
  763. <param name="title">The title of the dialog box. This may be null.</param>
  764. <param name="buttonText">The text shown in the only button
  765. in the dialog box. If left null, the text "OK" will be used.</param>
  766. <param name="afterHideCallback">A callback that should be executed after
  767. the dialog box is closed by the user.</param>
  768. <returns>A Task allowing this async method to be awaited.</returns>
  769. <remarks>Displaying dialogs in Android is synchronous. As such,
  770. this method will be executed synchronously even though it can be awaited
  771. for cross-platform compatibility purposes.</remarks>
  772. </member>
  773. <member name="M:GalaSoft.MvvmLight.Views.DialogService.ShowError(System.Exception,System.String,System.String,System.Action)">
  774. <summary>
  775. Displays information about an error.
  776. </summary>
  777. <param name="error">The exception of which the message must be shown to the user.</param>
  778. <param name="title">The title of the dialog box. This may be null.</param>
  779. <param name="buttonText">The text shown in the only button
  780. in the dialog box. If left null, the text "OK" will be used.</param>
  781. <param name="afterHideCallback">A callback that should be executed after
  782. the dialog box is closed by the user.</param>
  783. <returns>A Task allowing this async method to be awaited.</returns>
  784. <remarks>Displaying dialogs in Android is synchronous. As such,
  785. this method will be executed synchronously even though it can be awaited
  786. for cross-platform compatibility purposes.</remarks>
  787. </member>
  788. <member name="M:GalaSoft.MvvmLight.Views.DialogService.ShowMessage(System.String,System.String)">
  789. <summary>
  790. Displays information to the user. The dialog box will have only
  791. one button with the text "OK".
  792. </summary>
  793. <param name="message">The message to be shown to the user.</param>
  794. <param name="title">The title of the dialog box. This may be null.</param>
  795. <returns>A Task allowing this async method to be awaited.</returns>
  796. <remarks>Displaying dialogs in Android is synchronous. As such,
  797. this method will be executed synchronously even though it can be awaited
  798. for cross-platform compatibility purposes.</remarks>
  799. </member>
  800. <member name="M:GalaSoft.MvvmLight.Views.DialogService.ShowMessage(System.String,System.String,System.String,System.Action)">
  801. <summary>
  802. Displays information to the user. The dialog box will have only
  803. one button.
  804. </summary>
  805. <param name="message">The message to be shown to the user.</param>
  806. <param name="title">The title of the dialog box. This may be null.</param>
  807. <param name="buttonText">The text shown in the only button
  808. in the dialog box. If left null, the text "OK" will be used.</param>
  809. <param name="afterHideCallback">A callback that should be executed after
  810. the dialog box is closed by the user.</param>
  811. <returns>A Task allowing this async method to be awaited.</returns>
  812. <remarks>Displaying dialogs in Android is synchronous. As such,
  813. this method will be executed synchronously even though it can be awaited
  814. for cross-platform compatibility purposes.</remarks>
  815. </member>
  816. <member name="M:GalaSoft.MvvmLight.Views.DialogService.ShowMessage(System.String,System.String,System.String,System.String,System.Action{System.Boolean})">
  817. <summary>
  818. Displays information to the user. The dialog box will have only
  819. one button.
  820. </summary>
  821. <param name="message">The message to be shown to the user.</param>
  822. <param name="title">The title of the dialog box. This may be null.</param>
  823. <param name="buttonConfirmText">The text shown in the "confirm" button
  824. in the dialog box. If left null, the text "OK" will be used.</param>
  825. <param name="buttonCancelText">The text shown in the "cancel" button
  826. in the dialog box. If left null, the text "Cancel" will be used.</param>
  827. <param name="afterHideCallback">A callback that should be executed after
  828. the dialog box is closed by the user. The callback method will get a boolean
  829. parameter indicating if the "confirm" button (true) or the "cancel" button
  830. (false) was pressed by the user.</param>
  831. <returns>A Task allowing this async method to be awaited. The task will return
  832. true or false depending on the dialog result.</returns>
  833. <remarks>Displaying dialogs in Android is synchronous. As such,
  834. this method will be executed synchronously even though it can be awaited
  835. for cross-platform compatibility purposes.</remarks>
  836. </member>
  837. <member name="M:GalaSoft.MvvmLight.Views.DialogService.ShowMessageBox(System.String,System.String)">
  838. <summary>
  839. Displays information to the user in a simple dialog box. The dialog box will have only
  840. one button with the text "OK". This method should be used for debugging purposes.
  841. </summary>
  842. <param name="message">The message to be shown to the user.</param>
  843. <param name="title">The title of the dialog box. This may be null.</param>
  844. <returns>A Task allowing this async method to be awaited.</returns>
  845. <remarks>Displaying dialogs in Android is synchronous. As such,
  846. this method will be executed synchronously even though it can be awaited
  847. for cross-platform compatibility purposes.</remarks>
  848. </member>
  849. <member name="T:GalaSoft.MvvmLight.Views.NavigationService">
  850. <summary>
  851. Xamarin Android implementation of <see cref="T:GalaSoft.MvvmLight.Views.INavigationService"/>.
  852. This implementation can be used in Xamarin Android applications (not Xamarin Forms).
  853. </summary>
  854. <remarks>For this navigation service to work properly, your Activities
  855. should derive from the <see cref="T:GalaSoft.MvvmLight.Views.ActivityBase"/> class.</remarks>
  856. </member>
  857. <member name="F:GalaSoft.MvvmLight.Views.NavigationService.RootPageKey">
  858. <summary>
  859. The key that is returned by the <see cref="P:GalaSoft.MvvmLight.Views.NavigationService.CurrentPageKey"/> property
  860. when the current Activiy is the root activity.
  861. </summary>
  862. </member>
  863. <member name="M:GalaSoft.MvvmLight.Views.NavigationService.GoBack">
  864. <summary>
  865. If possible, discards the current page and displays the previous page
  866. on the navigation stack.
  867. </summary>
  868. </member>
  869. <member name="M:GalaSoft.MvvmLight.Views.NavigationService.NavigateTo(System.String)">
  870. <summary>
  871. Displays a new page corresponding to the given key.
  872. Make sure to call the <see cref="M:GalaSoft.MvvmLight.Views.NavigationService.Configure(System.String,System.Type)"/>
  873. method first.
  874. </summary>
  875. <param name="pageKey">The key corresponding to the page
  876. that should be displayed.</param>
  877. <exception cref="T:System.ArgumentException">When this method is called for
  878. a key that has not been configured earlier.</exception>
  879. </member>
  880. <member name="M:GalaSoft.MvvmLight.Views.NavigationService.NavigateTo(System.String,System.Object)">
  881. <summary>
  882. Displays a new page corresponding to the given key,
  883. and passes a parameter to the new page.
  884. Make sure to call the <see cref="M:GalaSoft.MvvmLight.Views.NavigationService.Configure(System.String,System.Type)"/>
  885. method first.
  886. </summary>
  887. <param name="pageKey">The key corresponding to the page
  888. that should be displayed.</param>
  889. <param name="parameter">The parameter that should be passed
  890. to the new page.</param>
  891. <exception cref="T:System.ArgumentException">When this method is called for
  892. a key that has not been configured earlier.</exception>
  893. </member>
  894. <member name="M:GalaSoft.MvvmLight.Views.NavigationService.Configure(System.String,System.Type)">
  895. <summary>
  896. Adds a key/page pair to the navigation service.
  897. </summary>
  898. <remarks>For this navigation service to work properly, your Activities
  899. should derive from the <see cref="T:GalaSoft.MvvmLight.Views.ActivityBase"/> class.</remarks>
  900. <param name="key">The key that will be used later
  901. in the <see cref="M:GalaSoft.MvvmLight.Views.NavigationService.NavigateTo(System.String)"/> or <see cref="M:GalaSoft.MvvmLight.Views.NavigationService.NavigateTo(System.String,System.Object)"/> methods.</param>
  902. <param name="activityType">The type of the activity (page) corresponding to the key.</param>
  903. </member>
  904. <member name="M:GalaSoft.MvvmLight.Views.NavigationService.GetAndRemoveParameter(Android.Content.Intent)">
  905. <summary>
  906. Allows a caller to get the navigation parameter corresponding
  907. to the Intent parameter.
  908. </summary>
  909. <param name="intent">The <see cref="P:Android.App.Activity.Intent"/>
  910. of the navigated page.</param>
  911. <returns>The navigation parameter. If no parameter is found,
  912. returns null.</returns>
  913. </member>
  914. <member name="M:GalaSoft.MvvmLight.Views.NavigationService.GetAndRemoveParameter``1(Android.Content.Intent)">
  915. <summary>
  916. Allows a caller to get the navigation parameter corresponding
  917. to the Intent parameter.
  918. </summary>
  919. <typeparam name="T">The type of the retrieved parameter.</typeparam>
  920. <param name="intent">The <see cref="P:Android.App.Activity.Intent"/>
  921. of the navigated page.</param>
  922. <returns>The navigation parameter casted to the proper type.
  923. If no parameter is found, returns default(T).</returns>
  924. </member>
  925. <member name="P:GalaSoft.MvvmLight.Views.NavigationService.CurrentPageKey">
  926. <summary>
  927. The key corresponding to the currently displayed page.
  928. </summary>
  929. </member>
  930. </members>
  931. </doc>