diff options
Diffstat (limited to 'docs/Xamarin.Forms.Core/Xamarin.Forms/EntryCell.xml')
| -rw-r--r-- | docs/Xamarin.Forms.Core/Xamarin.Forms/EntryCell.xml | 474 |
1 files changed, 474 insertions, 0 deletions
diff --git a/docs/Xamarin.Forms.Core/Xamarin.Forms/EntryCell.xml b/docs/Xamarin.Forms.Core/Xamarin.Forms/EntryCell.xml new file mode 100644 index 00000000..49a7f662 --- /dev/null +++ b/docs/Xamarin.Forms.Core/Xamarin.Forms/EntryCell.xml @@ -0,0 +1,474 @@ +<Type Name="EntryCell" FullName="Xamarin.Forms.EntryCell"> + <TypeSignature Language="C#" Value="public class EntryCell : Xamarin.Forms.Cell" /> + <TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit EntryCell extends Xamarin.Forms.Cell" /> + <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>Xamarin.Forms.Cell</BaseTypeName> + </Base> + <Interfaces /> + <Docs> + <summary>A <see cref="T:Xamarin.Forms.Cell" /> with a label and a single line text entry field.</summary> + <remarks> + <para>The following example shows a basic use.</para> + <example> + <code lang="C#"><![CDATA[using System; +using Xamarin.Forms; + +namespace FormsGallery +{ + class EntryCellDemoPage : ContentPage + { + public EntryCellDemoPage() + { + Label header = new Label + { + Text = "EntryCell", + FontSize = Device.GetNamedSize (NamedSize.Large, typeof(EntryCell)), + HorizontalOptions = LayoutOptions.Center + }; + + TableView tableView = new TableView + { + Intent = TableIntent.Form, + Root = new TableRoot + { + new TableSection + { + new EntryCell + { + Label = "EntryCell:", + Placeholder = "Type Text Here" + } + } + } + }; + + // Accomodate iPhone status bar. + this.Padding = new Thickness(10, Device.OnPlatform(20, 0, 0), 10, 5); + + // Build the page. + this.Content = new StackLayout + { + Children = + { + header, + tableView + } + }; + } + } +} +]]></code> + </example> + <para>XAML for Xamarin.Forms supports the following properties for the <see cref="T:Xamarin.Forms.EntryCell" /> class:</para> + <list type="table"> + <listheader> + <term>Property</term> + <description>Value</description> + </listheader> + <item> + <term>Keyboard</term> + <description>A <see cref="T:Xamarin.Forms.Keyboard" /> property name that indicates which keyboard to present to the user when editing text.</description> + </item> + <item> + <term>Label</term> + <description> + <para>The text that is presented next to the entry area in the <see cref="T:Xamarin.Forms.EntryCell" />. </para> + </description> + </item> + <item> + <term>LabelColor</term> + <description> + <para>A color specification, with or without the prefix, "Color". For example, "Color.Red" and "Red" both specify the color red.</para> + </description> + </item> + <item> + <term>Placeholder</term> + <description>The default text that will appear in the control when it is empty.</description> + </item> + <item> + <term>Text</term> + <description> + <para>The initial text that will appear in the editor.</para> + </description> + </item> + <item> + <term>XAlign</term> + <description> + <para> + <c>Center</c>, <c>End</c>, or <c>Start</c>, to indicate the placement of the text that is entered by the user.</para> + </description> + </item> + </list> + <para> + <img href="EntryCell.TripleScreenShot.png" /> + </para> + </remarks> + </Docs> + <Members> + <Member MemberName=".ctor"> + <MemberSignature Language="C#" Value="public EntryCell ();" /> + <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() 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 /> + <Docs> + <summary>Initializes a new instance of the EntryCell class.</summary> + <remarks> + </remarks> + </Docs> + </Member> + <Member MemberName="Completed"> + <MemberSignature Language="C#" Value="public event EventHandler Completed;" /> + <MemberSignature Language="ILAsm" Value=".event class System.EventHandler Completed" /> + <MemberType>Event</MemberType> + <AssemblyInfo> + <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>Event fired when the user presses 'Done' on the EntryCell's keyboard</summary> + <remarks> + </remarks> + </Docs> + </Member> + <Member MemberName="HorizontalTextAlignment"> + <MemberSignature Language="C#" Value="public Xamarin.Forms.TextAlignment HorizontalTextAlignment { get; set; }" /> + <MemberSignature Language="ILAsm" Value=".property instance valuetype Xamarin.Forms.TextAlignment HorizontalTextAlignment" /> + <MemberType>Property</MemberType> + <AssemblyInfo> + <AssemblyVersion>1.5.0.0</AssemblyVersion> + <AssemblyVersion>2.0.0.0</AssemblyVersion> + </AssemblyInfo> + <ReturnValue> + <ReturnType>Xamarin.Forms.TextAlignment</ReturnType> + </ReturnValue> + <Docs> + <summary>Gets or sets the horizontal alignement of the Text property. This is a bindable property.</summary> + <value>To be added.</value> + <remarks>To be added.</remarks> + </Docs> + </Member> + <Member MemberName="HorizontalTextAlignmentProperty"> + <MemberSignature Language="C#" Value="public static readonly Xamarin.Forms.BindableProperty HorizontalTextAlignmentProperty;" /> + <MemberSignature Language="ILAsm" Value=".field public static initonly class Xamarin.Forms.BindableProperty HorizontalTextAlignmentProperty" /> + <MemberType>Field</MemberType> + <AssemblyInfo> + <AssemblyVersion>1.5.0.0</AssemblyVersion> + <AssemblyVersion>2.0.0.0</AssemblyVersion> + </AssemblyInfo> + <ReturnValue> + <ReturnType>Xamarin.Forms.BindableProperty</ReturnType> + </ReturnValue> + <Docs> + <summary>Identifies the HorizontalTextAlignment bindable property.</summary> + <remarks>To be added.</remarks> + </Docs> + </Member> + <Member MemberName="Keyboard"> + <MemberSignature Language="C#" Value="public Xamarin.Forms.Keyboard Keyboard { get; set; }" /> + <MemberSignature Language="ILAsm" Value=".property instance class Xamarin.Forms.Keyboard Keyboard" /> + <MemberType>Property</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>Xamarin.Forms.Keyboard</ReturnType> + </ReturnValue> + <Docs> + <summary>Gets or sets the Keyboard to display while editing the EntryCell. This is a bindable property.</summary> + <value>A <see cref="T:Xamarin.Forms.Keyboard" /> representing the keyboard kind. Default is <see cref="P:Xamarin.Forms.Keyboard.Default" />.</value> + <remarks> + </remarks> + </Docs> + </Member> + <Member MemberName="KeyboardProperty"> + <MemberSignature Language="C#" Value="public static readonly Xamarin.Forms.BindableProperty KeyboardProperty;" /> + <MemberSignature Language="ILAsm" Value=".field public static initonly class Xamarin.Forms.BindableProperty KeyboardProperty" /> + <MemberType>Field</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>Xamarin.Forms.BindableProperty</ReturnType> + </ReturnValue> + <Docs> + <summary>Identifies the Keyboard bindable property.</summary> + <remarks> + </remarks> + </Docs> + </Member> + <Member MemberName="Label"> + <MemberSignature Language="C#" Value="public string Label { get; set; }" /> + <MemberSignature Language="ILAsm" Value=".property instance string Label" /> + <MemberType>Property</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.String</ReturnType> + </ReturnValue> + <Docs> + <summary>Gets or sets the fixed text presented next to the Entry in the EntryCell. This is a bindable property.</summary> + <value>A <see cref="T:System.String" />.</value> + <remarks> + </remarks> + </Docs> + </Member> + <Member MemberName="LabelColor"> + <MemberSignature Language="C#" Value="public Xamarin.Forms.Color LabelColor { get; set; }" /> + <MemberSignature Language="ILAsm" Value=".property instance valuetype Xamarin.Forms.Color LabelColor" /> + <MemberType>Property</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>Xamarin.Forms.Color</ReturnType> + </ReturnValue> + <Docs> + <summary>Gets or sets the Color used for rendering the Label property. This is a bindable property.</summary> + <value>Default is Color.Default.</value> + <remarks> + </remarks> + </Docs> + </Member> + <Member MemberName="LabelColorProperty"> + <MemberSignature Language="C#" Value="public static readonly Xamarin.Forms.BindableProperty LabelColorProperty;" /> + <MemberSignature Language="ILAsm" Value=".field public static initonly class Xamarin.Forms.BindableProperty LabelColorProperty" /> + <MemberType>Field</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>Xamarin.Forms.BindableProperty</ReturnType> + </ReturnValue> + <Docs> + <summary>Identifies the LabelColor bindable property.</summary> + <remarks> + </remarks> + </Docs> + </Member> + <Member MemberName="LabelProperty"> + <MemberSignature Language="C#" Value="public static readonly Xamarin.Forms.BindableProperty LabelProperty;" /> + <MemberSignature Language="ILAsm" Value=".field public static initonly class Xamarin.Forms.BindableProperty LabelProperty" /> + <MemberType>Field</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>Xamarin.Forms.BindableProperty</ReturnType> + </ReturnValue> + <Docs> + <summary>Identifies the Label bindable property.</summary> + <remarks> + </remarks> + </Docs> + </Member> + <Member MemberName="Placeholder"> + <MemberSignature Language="C#" Value="public string Placeholder { get; set; }" /> + <MemberSignature Language="ILAsm" Value=".property instance string Placeholder" /> + <MemberType>Property</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.String</ReturnType> + </ReturnValue> + <Docs> + <summary>Gets or sets the placeholder text displayed in the Entry when the Text is null or empty. This is a bindable property.</summary> + <value> + </value> + <remarks> + </remarks> + </Docs> + </Member> + <Member MemberName="PlaceholderProperty"> + <MemberSignature Language="C#" Value="public static readonly Xamarin.Forms.BindableProperty PlaceholderProperty;" /> + <MemberSignature Language="ILAsm" Value=".field public static initonly class Xamarin.Forms.BindableProperty PlaceholderProperty" /> + <MemberType>Field</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>Xamarin.Forms.BindableProperty</ReturnType> + </ReturnValue> + <Docs> + <summary>Identifies the Placeholder bindable property,</summary> + <remarks> + </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.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.String</ReturnType> + </ReturnValue> + <Docs> + <summary>Gets or sets the content of the Entry of the EntryCell. This is a bindable property.</summary> + <value> + </value> + <remarks> + </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.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>Xamarin.Forms.BindableProperty</ReturnType> + </ReturnValue> + <Docs> + <summary>Identifies the Text bindable property.</summary> + <remarks> + </remarks> + </Docs> + </Member> + <Member MemberName="XAlign"> + <MemberSignature Language="C#" Value="public Xamarin.Forms.TextAlignment XAlign { get; set; }" /> + <MemberSignature Language="ILAsm" Value=".property instance valuetype Xamarin.Forms.TextAlignment XAlign" /> + <MemberType>Property</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> + <Attributes> + <Attribute> + <AttributeName>System.Obsolete("XAlign is obsolete. Please use HorizontalTextAlignment instead.")</AttributeName> + </Attribute> + </Attributes> + <ReturnValue> + <ReturnType>Xamarin.Forms.TextAlignment</ReturnType> + </ReturnValue> + <Docs> + <summary>Gets or sets the horizontal alignement of the Text property. This is a bindable property.</summary> + <value>Default is <see cref="E:Xamarin.Forms.TextAlignment.Start" />.</value> + <remarks> + </remarks> + </Docs> + </Member> + <Member MemberName="XAlignProperty"> + <MemberSignature Language="C#" Value="public static readonly Xamarin.Forms.BindableProperty XAlignProperty;" /> + <MemberSignature Language="ILAsm" Value=".field public static initonly class Xamarin.Forms.BindableProperty XAlignProperty" /> + <MemberType>Field</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> + <Attributes> + <Attribute> + <AttributeName>System.Obsolete("XAlignProperty is obsolete. Please use HorizontalTextAlignmentProperty instead.")</AttributeName> + </Attribute> + </Attributes> + <ReturnValue> + <ReturnType>Xamarin.Forms.BindableProperty</ReturnType> + </ReturnValue> + <Docs> + <summary>Identifies the XAlign bindable property.</summary> + <remarks> + </remarks> + </Docs> + </Member> + </Members> +</Type> |