diff options
Diffstat (limited to 'docs/Xamarin.Forms.Core/Xamarin.Forms/Command.xml')
| -rw-r--r-- | docs/Xamarin.Forms.Core/Xamarin.Forms/Command.xml | 249 |
1 files changed, 249 insertions, 0 deletions
diff --git a/docs/Xamarin.Forms.Core/Xamarin.Forms/Command.xml b/docs/Xamarin.Forms.Core/Xamarin.Forms/Command.xml new file mode 100644 index 00000000..3e2d4ecf --- /dev/null +++ b/docs/Xamarin.Forms.Core/Xamarin.Forms/Command.xml @@ -0,0 +1,249 @@ +<Type Name="Command" FullName="Xamarin.Forms.Command"> + <TypeSignature Language="C#" Value="public class Command : System.Windows.Input.ICommand" /> + <TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit Command extends System.Object implements class System.Windows.Input.ICommand" /> + <AssemblyInfo> + <AssemblyName>Xamarin.Forms.Core</AssemblyName> + <AssemblyVersion>1.0.0.0</AssemblyVersion> + <AssemblyVersion>1.1.0.0</AssemblyVersion> + <AssemblyVersion>1.2.0.0</AssemblyVersion> + <AssemblyVersion>1.3.0.0</AssemblyVersion> + <AssemblyVersion>1.4.0.0</AssemblyVersion> + <AssemblyVersion>1.5.0.0</AssemblyVersion> + <AssemblyVersion>2.0.0.0</AssemblyVersion> + </AssemblyInfo> + <Base> + <BaseTypeName>System.Object</BaseTypeName> + </Base> + <Interfaces> + <Interface> + <InterfaceName>System.Windows.Input.ICommand</InterfaceName> + </Interface> + </Interfaces> + <Docs> + <summary>Defines an <see cref="T:System.Windows.Input.ICommand" /> implementation wrapping an <see cref="System.Action" />.</summary> + <remarks> + <para> + The following example creates a new Command and set it to a button. + </para> + <example> + <code lang="C#"><![CDATA[ +var command = new Command (() => Debug.WriteLine ("Command executed")); +var button = new Button { + Text = "Hit me to execute the command", + Command = command, +}; +]]></code> + </example> + <para> + More useful scenarios takes a parameter + </para> + <example> + <code lang="C#"><![CDATA[ +var command = new Command (o => Debug.WriteLine ("Command executed: {0}", o)); +var button = new Button { + Text = "Hit me to execute the command", + Command = command, + CommandParameter = "button0", +}; +]]></code> + </example> + </remarks> + </Docs> + <Members> + <Member MemberName=".ctor"> + <MemberSignature Language="C#" Value="public Command (Action execute);" /> + <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class System.Action execute) cil managed" /> + <MemberType>Constructor</MemberType> + <AssemblyInfo> + <AssemblyVersion>1.0.0.0</AssemblyVersion> + <AssemblyVersion>1.1.0.0</AssemblyVersion> + <AssemblyVersion>1.2.0.0</AssemblyVersion> + <AssemblyVersion>1.3.0.0</AssemblyVersion> + <AssemblyVersion>1.4.0.0</AssemblyVersion> + <AssemblyVersion>1.5.0.0</AssemblyVersion> + <AssemblyVersion>2.0.0.0</AssemblyVersion> + </AssemblyInfo> + <Parameters> + <Parameter Name="execute" Type="System.Action" /> + </Parameters> + <Docs> + <param name="execute">An Action to execute when the Command is executed.</param> + <summary>Initializes a new instance of the Command class.</summary> + <remarks> + </remarks> + </Docs> + </Member> + <Member MemberName=".ctor"> + <MemberSignature Language="C#" Value="public Command (Action<object> execute);" /> + <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class System.Action`1<object> execute) cil managed" /> + <MemberType>Constructor</MemberType> + <AssemblyInfo> + <AssemblyVersion>1.0.0.0</AssemblyVersion> + <AssemblyVersion>1.1.0.0</AssemblyVersion> + <AssemblyVersion>1.2.0.0</AssemblyVersion> + <AssemblyVersion>1.3.0.0</AssemblyVersion> + <AssemblyVersion>1.4.0.0</AssemblyVersion> + <AssemblyVersion>1.5.0.0</AssemblyVersion> + <AssemblyVersion>2.0.0.0</AssemblyVersion> + </AssemblyInfo> + <Parameters> + <Parameter Name="execute" Type="System.Action<System.Object>" /> + </Parameters> + <Docs> + <param name="execute">An Action<object> to execute when the Command is executed.</param> + <summary>Initializes a new instance of the Command class.</summary> + <remarks>The Action will be executed with a parameter.</remarks> + </Docs> + </Member> + <Member MemberName=".ctor"> + <MemberSignature Language="C#" Value="public Command (Action execute, Func<bool> canExecute);" /> + <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class System.Action execute, class System.Func`1<bool> canExecute) cil managed" /> + <MemberType>Constructor</MemberType> + <AssemblyInfo> + <AssemblyVersion>1.0.0.0</AssemblyVersion> + <AssemblyVersion>1.1.0.0</AssemblyVersion> + <AssemblyVersion>1.2.0.0</AssemblyVersion> + <AssemblyVersion>1.3.0.0</AssemblyVersion> + <AssemblyVersion>1.4.0.0</AssemblyVersion> + <AssemblyVersion>1.5.0.0</AssemblyVersion> + <AssemblyVersion>2.0.0.0</AssemblyVersion> + </AssemblyInfo> + <Parameters> + <Parameter Name="execute" Type="System.Action" /> + <Parameter Name="canExecute" Type="System.Func<System.Boolean>" /> + </Parameters> + <Docs> + <param name="execute">An Action to execute when the Command is executed.</param> + <param name="canExecute">A <see cref="T:System.Func<bool>" /> indicating if the Command can be executed.</param> + <summary>Initializes a new instance of the Command class.</summary> + <remarks>Wehenever the value returned by canExecute has changed, a call to <see cref="M:Xamarin.QuickuI.Command.ChangeCanExecute" /> is required to trigger <see cref="E:System.Windows.Input.ICommand.CanExecuteChanged" />.</remarks> + </Docs> + </Member> + <Member MemberName=".ctor"> + <MemberSignature Language="C#" Value="public Command (Action<object> execute, Func<object,bool> canExecute);" /> + <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class System.Action`1<object> execute, class System.Func`2<object, bool> canExecute) cil managed" /> + <MemberType>Constructor</MemberType> + <AssemblyInfo> + <AssemblyVersion>1.0.0.0</AssemblyVersion> + <AssemblyVersion>1.1.0.0</AssemblyVersion> + <AssemblyVersion>1.2.0.0</AssemblyVersion> + <AssemblyVersion>1.3.0.0</AssemblyVersion> + <AssemblyVersion>1.4.0.0</AssemblyVersion> + <AssemblyVersion>1.5.0.0</AssemblyVersion> + <AssemblyVersion>2.0.0.0</AssemblyVersion> + </AssemblyInfo> + <Parameters> + <Parameter Name="execute" Type="System.Action<System.Object>" /> + <Parameter Name="canExecute" Type="System.Func<System.Object,System.Boolean>" /> + </Parameters> + <Docs> + <param name="execute">An Action<object> to execute when the Command is executed.</param> + <param name="canExecute">A <see cref="T:System.Func<object,bool>" /> indicating if the Command can be executed.</param> + <summary>Initializes a new instance of the Command class.</summary> + <remarks>Wehenever the value returned by canExecute has changed, a call to <see cref="M:Xamarin.QuickuI.Command.ChangeCanExecute" /> is required to trigger <see cref="E:System.Windows.Input.ICommand.CanExecuteChanged" />.</remarks> + </Docs> + </Member> + <Member MemberName="CanExecute"> + <MemberSignature Language="C#" Value="public bool CanExecute (object parameter);" /> + <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance bool CanExecute(object parameter) cil managed" /> + <MemberType>Method</MemberType> + <AssemblyInfo> + <AssemblyVersion>1.0.0.0</AssemblyVersion> + <AssemblyVersion>1.1.0.0</AssemblyVersion> + <AssemblyVersion>1.2.0.0</AssemblyVersion> + <AssemblyVersion>1.3.0.0</AssemblyVersion> + <AssemblyVersion>1.4.0.0</AssemblyVersion> + <AssemblyVersion>1.5.0.0</AssemblyVersion> + <AssemblyVersion>2.0.0.0</AssemblyVersion> + </AssemblyInfo> + <ReturnValue> + <ReturnType>System.Boolean</ReturnType> + </ReturnValue> + <Parameters> + <Parameter Name="parameter" Type="System.Object" /> + </Parameters> + <Docs> + <param name="parameter">An <see cref="T:System.Object" /> used as parameter to determine if the Command can be executed.</param> + <summary>Returns a <see cref="T:System.Boolean" /> indicating if the Command can be exectued with the given parameter.</summary> + <returns> + <see langword="true" /> if the Command can be executed, <see langword="false" /> otherwise.</returns> + <remarks> + <para>If no canExecute parameter was passed to the Command constructor, this method always returns <see langword="true" />.</para> + <para>If the Command was created with non-generic execute parameter, the parameter of this method is ignored.</para> + </remarks> + </Docs> + </Member> + <Member MemberName="CanExecuteChanged"> + <MemberSignature Language="C#" Value="public event EventHandler CanExecuteChanged;" /> + <MemberSignature Language="ILAsm" Value=".event class System.EventHandler CanExecuteChanged" /> + <MemberType>Event</MemberType> + <AssemblyInfo> + <AssemblyVersion>1.0.0.0</AssemblyVersion> + <AssemblyVersion>1.1.0.0</AssemblyVersion> + <AssemblyVersion>1.2.0.0</AssemblyVersion> + <AssemblyVersion>1.3.0.0</AssemblyVersion> + <AssemblyVersion>1.4.0.0</AssemblyVersion> + <AssemblyVersion>1.5.0.0</AssemblyVersion> + <AssemblyVersion>2.0.0.0</AssemblyVersion> + </AssemblyInfo> + <ReturnValue> + <ReturnType>System.EventHandler</ReturnType> + </ReturnValue> + <Docs> + <summary>Occurs when the target of the Command should reevaluate whether or not the Command can be executed.</summary> + <remarks> + </remarks> + </Docs> + </Member> + <Member MemberName="ChangeCanExecute"> + <MemberSignature Language="C#" Value="public void ChangeCanExecute ();" /> + <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void ChangeCanExecute() cil managed" /> + <MemberType>Method</MemberType> + <AssemblyInfo> + <AssemblyVersion>1.0.0.0</AssemblyVersion> + <AssemblyVersion>1.1.0.0</AssemblyVersion> + <AssemblyVersion>1.2.0.0</AssemblyVersion> + <AssemblyVersion>1.3.0.0</AssemblyVersion> + <AssemblyVersion>1.4.0.0</AssemblyVersion> + <AssemblyVersion>1.5.0.0</AssemblyVersion> + <AssemblyVersion>2.0.0.0</AssemblyVersion> + </AssemblyInfo> + <ReturnValue> + <ReturnType>System.Void</ReturnType> + </ReturnValue> + <Parameters /> + <Docs> + <summary>Send a <see cref="E:System.Windows.Input.ICommand.CanExecuteChanged" /></summary> + <remarks> + </remarks> + </Docs> + </Member> + <Member MemberName="Execute"> + <MemberSignature Language="C#" Value="public void Execute (object parameter);" /> + <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void Execute(object parameter) cil managed" /> + <MemberType>Method</MemberType> + <AssemblyInfo> + <AssemblyVersion>1.0.0.0</AssemblyVersion> + <AssemblyVersion>1.1.0.0</AssemblyVersion> + <AssemblyVersion>1.2.0.0</AssemblyVersion> + <AssemblyVersion>1.3.0.0</AssemblyVersion> + <AssemblyVersion>1.4.0.0</AssemblyVersion> + <AssemblyVersion>1.5.0.0</AssemblyVersion> + <AssemblyVersion>2.0.0.0</AssemblyVersion> + </AssemblyInfo> + <ReturnValue> + <ReturnType>System.Void</ReturnType> + </ReturnValue> + <Parameters> + <Parameter Name="parameter" Type="System.Object" /> + </Parameters> + <Docs> + <param name="parameter">An <see cref="T:System.Object" /> used as parameter for the execute Action.</param> + <summary>Invokes the execute Action</summary> + <remarks> + <para>If the Command was created with non-generic execute parameter, the parameter of this method is ignored.</para> + </remarks> + </Docs> + </Member> + </Members> +</Type> |