diff options
Diffstat (limited to 'docs/Xamarin.Forms.Core/Xamarin.Forms/MenuItem.xml')
| -rw-r--r-- | docs/Xamarin.Forms.Core/Xamarin.Forms/MenuItem.xml | 297 |
1 files changed, 297 insertions, 0 deletions
diff --git a/docs/Xamarin.Forms.Core/Xamarin.Forms/MenuItem.xml b/docs/Xamarin.Forms.Core/Xamarin.Forms/MenuItem.xml new file mode 100644 index 00000000..19b4049f --- /dev/null +++ b/docs/Xamarin.Forms.Core/Xamarin.Forms/MenuItem.xml @@ -0,0 +1,297 @@ +<Type Name="MenuItem" FullName="Xamarin.Forms.MenuItem"> + <TypeSignature Language="C#" Value="public class MenuItem : Xamarin.Forms.BaseMenuItem" /> + <TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit MenuItem extends Xamarin.Forms.BaseMenuItem" /> + <AssemblyInfo> + <AssemblyName>Xamarin.Forms.Core</AssemblyName> + <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>Xamarin.Forms.BaseMenuItem</BaseTypeName> + </Base> + <Interfaces /> + <Docs> + <summary>Class that presents a menu item and associates it with a command.</summary> + <remarks> + <para>XAML for Xamarin.Forms supports the following properties for the <see cref="T:Xamarin.Forms.MenuItem" /> class:</para> + <list type="table"> + <listheader> + <term>Property</term> + <description>Value</description> + </listheader> + <item> + <term>Command</term> + <description> + <para>A binding to a command.</para> + </description> + </item> + <item> + <term>CommandParameter</term> + <description> + <para>A parameter to pass to the command.</para> + </description> + </item> + <!-- TODO: Getting info from Jason on how to specify images + <item> + <term>Icon</term> + <description><para></para></description> + </item> --> + <item> + <term>IsDestructive</term> + <description> + <para> + <c>true</c> or <c>false</c>, to indicate whether the command deletes an item in a list.</para> + </description> + </item> + <item> + <term>Text</term> + <description> + <para>The text to display on the menu item.</para> + </description> + </item> + </list> + </remarks> + </Docs> + <Members> + <Member MemberName=".ctor"> + <MemberSignature Language="C#" Value="public MenuItem ();" /> + <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" /> + <MemberType>Constructor</MemberType> + <AssemblyInfo> + <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 /> + <Docs> + <summary>Intitializes a new <see cref="T:Xamarin.Forms.MenuItem" /> instance.</summary> + <remarks>To be added.</remarks> + </Docs> + </Member> + <Member MemberName="Clicked"> + <MemberSignature Language="C#" Value="public event EventHandler Clicked;" /> + <MemberSignature Language="ILAsm" Value=".event class System.EventHandler Clicked" /> + <MemberType>Event</MemberType> + <AssemblyInfo> + <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>Event that is raised when the menu item is clicked.</summary> + <remarks>To be added.</remarks> + </Docs> + </Member> + <Member MemberName="Command"> + <MemberSignature Language="C#" Value="public System.Windows.Input.ICommand Command { get; set; }" /> + <MemberSignature Language="ILAsm" Value=".property instance class System.Windows.Input.ICommand Command" /> + <MemberType>Property</MemberType> + <AssemblyInfo> + <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.Windows.Input.ICommand</ReturnType> + </ReturnValue> + <Docs> + <summary>Gets or sets the command that is run when the menu is clicked.</summary> + <value>To be added.</value> + <remarks>To be added.</remarks> + </Docs> + </Member> + <Member MemberName="CommandParameter"> + <MemberSignature Language="C#" Value="public object CommandParameter { get; set; }" /> + <MemberSignature Language="ILAsm" Value=".property instance object CommandParameter" /> + <MemberType>Property</MemberType> + <AssemblyInfo> + <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.Object</ReturnType> + </ReturnValue> + <Docs> + <summary>Gets or sets the parameter that is passed to the command.</summary> + <value>To be added.</value> + <remarks>To be added.</remarks> + </Docs> + </Member> + <Member MemberName="CommandParameterProperty"> + <MemberSignature Language="C#" Value="public static readonly Xamarin.Forms.BindableProperty CommandParameterProperty;" /> + <MemberSignature Language="ILAsm" Value=".field public static initonly class Xamarin.Forms.BindableProperty CommandParameterProperty" /> + <MemberType>Field</MemberType> + <AssemblyInfo> + <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>Xamarin.Forms.BindableProperty</ReturnType> + </ReturnValue> + <Docs> + <summary>Identifies the command parameter bound property.</summary> + <remarks>To be added.</remarks> + </Docs> + </Member> + <Member MemberName="CommandProperty"> + <MemberSignature Language="C#" Value="public static readonly Xamarin.Forms.BindableProperty CommandProperty;" /> + <MemberSignature Language="ILAsm" Value=".field public static initonly class Xamarin.Forms.BindableProperty CommandProperty" /> + <MemberType>Field</MemberType> + <AssemblyInfo> + <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>Xamarin.Forms.BindableProperty</ReturnType> + </ReturnValue> + <Docs> + <summary>Identifies the command bound property.</summary> + <remarks>To be added.</remarks> + </Docs> + </Member> + <Member MemberName="Icon"> + <MemberSignature Language="C#" Value="public Xamarin.Forms.FileImageSource Icon { get; set; }" /> + <MemberSignature Language="ILAsm" Value=".property instance class Xamarin.Forms.FileImageSource Icon" /> + <MemberType>Property</MemberType> + <AssemblyInfo> + <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>Xamarin.Forms.FileImageSource</ReturnType> + </ReturnValue> + <Docs> + <summary>Gets or sets the icon for the menu item.</summary> + <value>To be added.</value> + <remarks>To be added.</remarks> + </Docs> + </Member> + <Member MemberName="IconProperty"> + <MemberSignature Language="C#" Value="public static readonly Xamarin.Forms.BindableProperty IconProperty;" /> + <MemberSignature Language="ILAsm" Value=".field public static initonly class Xamarin.Forms.BindableProperty IconProperty" /> + <MemberType>Field</MemberType> + <AssemblyInfo> + <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>Xamarin.Forms.BindableProperty</ReturnType> + </ReturnValue> + <Docs> + <summary>Identfies the icon bound property.</summary> + <remarks>To be added.</remarks> + </Docs> + </Member> + <Member MemberName="IsDestructive"> + <MemberSignature Language="C#" Value="public bool IsDestructive { get; set; }" /> + <MemberSignature Language="ILAsm" Value=".property instance bool IsDestructive" /> + <MemberType>Property</MemberType> + <AssemblyInfo> + <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> + <Docs> + <summary>Gets or sets a value that indicates whether or not the menu item removes its associated UI element.</summary> + <value>To be added.</value> + <remarks>To be added.</remarks> + </Docs> + </Member> + <Member MemberName="IsDestructiveProperty"> + <MemberSignature Language="C#" Value="public static readonly Xamarin.Forms.BindableProperty IsDestructiveProperty;" /> + <MemberSignature Language="ILAsm" Value=".field public static initonly class Xamarin.Forms.BindableProperty IsDestructiveProperty" /> + <MemberType>Field</MemberType> + <AssemblyInfo> + <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>Xamarin.Forms.BindableProperty</ReturnType> + </ReturnValue> + <Docs> + <summary>Identifies the IsDestructive bound property.</summary> + <remarks>To be added.</remarks> + </Docs> + </Member> + <Member MemberName="OnClicked"> + <MemberSignature Language="C#" Value="protected virtual void OnClicked ();" /> + <MemberSignature Language="ILAsm" Value=".method familyhidebysig newslot virtual instance void OnClicked() cil managed" /> + <MemberType>Method</MemberType> + <AssemblyInfo> + <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>When overriden by an app dev, implements behavior when the menu item is clicked.</summary> + <remarks>To be added.</remarks> + </Docs> + </Member> + <Member MemberName="Text"> + <MemberSignature Language="C#" Value="public string Text { get; set; }" /> + <MemberSignature Language="ILAsm" Value=".property instance string Text" /> + <MemberType>Property</MemberType> + <AssemblyInfo> + <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.String</ReturnType> + </ReturnValue> + <Docs> + <summary>The text of the menu item.</summary> + <value>To be added.</value> + <remarks>To be added.</remarks> + </Docs> + </Member> + <Member MemberName="TextProperty"> + <MemberSignature Language="C#" Value="public static readonly Xamarin.Forms.BindableProperty TextProperty;" /> + <MemberSignature Language="ILAsm" Value=".field public static initonly class Xamarin.Forms.BindableProperty TextProperty" /> + <MemberType>Field</MemberType> + <AssemblyInfo> + <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>Xamarin.Forms.BindableProperty</ReturnType> + </ReturnValue> + <Docs> + <summary>Identifies the text bound property.</summary> + <remarks>To be added.</remarks> + </Docs> + </Member> + </Members> +</Type> |