diff options
Diffstat (limited to 'docs/Xamarin.Forms.Core/Xamarin.Forms/MasterDetailPage.xml')
| -rw-r--r-- | docs/Xamarin.Forms.Core/Xamarin.Forms/MasterDetailPage.xml | 466 |
1 files changed, 466 insertions, 0 deletions
diff --git a/docs/Xamarin.Forms.Core/Xamarin.Forms/MasterDetailPage.xml b/docs/Xamarin.Forms.Core/Xamarin.Forms/MasterDetailPage.xml new file mode 100644 index 00000000..81d1ef3e --- /dev/null +++ b/docs/Xamarin.Forms.Core/Xamarin.Forms/MasterDetailPage.xml @@ -0,0 +1,466 @@ +<Type Name="MasterDetailPage" FullName="Xamarin.Forms.MasterDetailPage"> + <TypeSignature Language="C#" Value="public class MasterDetailPage : Xamarin.Forms.Page" /> + <TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit MasterDetailPage extends Xamarin.Forms.Page" /> + <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.Page</BaseTypeName> + </Base> + <Interfaces /> + <Attributes> + <Attribute> + <AttributeName>Xamarin.Forms.RenderWith(typeof(Xamarin.Forms.Platform._MasterDetailPageRenderer))</AttributeName> + </Attribute> + </Attributes> + <Docs> + <summary>A <see cref="T:Xamarin.Forms.Page" /> that manages two panes of information: A master page that presents data at a high level, and a detail page that displays low-level details about information in the master.</summary> + <remarks> + <para>The following example code, taken from the <format type="text/html"><a href="https://github.com/xamarin/xamarin-forms-samples/tree/master/FormsGallery/FormsGallery/FormsGallery">FormsGallery</a></format> sample application, creates a <see cref="T:Xamarin.Forms.MasterDetailPage" /> that allows the user to view detailed information about a color that she chooses from a list. Note that the <c>NamedColorPage</c> class, defined in as a sublcass of <see cref="T:Xamarin.Forms.ContentPage" /> in another file in the sample application, simply displays RGB data, a <see cref="T:Xamarin.Forms.BoxView" /> with its background color set to the color that the user selected, and, finally, hue, saturation, and luminosity data.</para> + <para>The sample below illustrates three key concepts. First, the "Master" portion of the MasterDetailPage is represented by the <see cref="P:Xamarin.Forms.MasterDetailPage.Master" /> property, which is set to a <see cref="T:Xamarin.Forms.ListView" /> element in this example. This <see cref="T:Xamarin.Forms.ListView" /> element contains a label and a list of colors. Second, the "Detail" portion of the <see cref="T:Xamarin.Forms.MasterDetailPage" /> is represented by the <see cref="P:Xamarin.Forms.MasterDetailPage.Detail" /> property, which, in this example, is set to the <c>NamedColorPage</c> that was noted above. Third, and finally, the page that is represented by the <see cref="P:Xamarin.Forms.MasterDetailPage.Detail" /> property is displayed by setting the <see cref="P:Xamarin.Forms.MasterDetailPage.IsPresented" /> property to <see langword="false" />; That is, the <see cref="P:Xamarin.Forms.MasterDetailPage.IsPresented" /> property controls whether or not the page that is represented by the <see cref="P:Xamarin.Forms.MasterDetailPage.Master" /> is presented to the user.</para> + <block type="note">The <see cref="P:Xamarin.Forms.MasterDetailPage.Master" /> page must have its <see cref="P:Xamarin.Forms.Page.Title" /> property set. Additionally, the <see cref="P:Xamarin.Forms.MasterDetailPage.Detail" /> page will only display a navigation bar if it is an instance of <see cref="T:Xamarin.Forms.NavigationPage" />.</block> + <example> + <code lang="C#"><![CDATA[ +using System; +using Xamarin.Forms; + +namespace FormsGallery +{ + class MasterDetailPageDemoPage : MasterDetailPage + { + public MasterDetailPageDemoPage() + { + Label header = new Label + { + Text = "MasterDetailPage", + FontSize = Device.GetNamedSize (NamedSize.Large, typeof(Label)), + HorizontalOptions = LayoutOptions.Center + }; + + // Assemble an array of NamedColor objects. + NamedColor[] namedColors = + { + new NamedColor("Aqua", Color.Aqua), + new NamedColor("Black", Color.Black), + new NamedColor("Blue", Color.Blue), + new NamedColor("Fuschia", Color.Fuschia), + new NamedColor("Gray", Color.Gray), + new NamedColor("Green", Color.Green), + new NamedColor("Lime", Color.Lime), + new NamedColor("Maroon", Color.Maroon), + new NamedColor("Navy", Color.Navy), + new NamedColor("Olive", Color.Olive), + new NamedColor("Purple", Color.Purple), + new NamedColor("Red", Color.Red), + new NamedColor("Silver", Color.Silver), + new NamedColor("Teal", Color.Teal), + new NamedColor("White", Color.White), + new NamedColor("Yellow", Color.Yellow) + }; + + // Create ListView for the master page. + ListView listView = new ListView + { + ItemsSource = namedColors + }; + + // Create the master page with the ListView. + this.Master = new ContentPage + { + Title = header.Text, + Content = new StackLayout + { + Children = + { + header, + listView + } + } + }; + + // Create the detail page using NamedColorPage and wrap it in a + // navigation page to provide a NavigationBar and Toggle button + this.Detail = new NavigationPage(new NamedColorPage(true)); + + // For Windows Phone, provide a way to get back to the master page. + if (Device.OS == TargetPlatform.WinPhone) + { + (this.Detail as ContentPage).Content.GestureRecognizers.Add( + new TapGestureRecognizer((view) => + { + this.IsPresented = true; + })); + } + + // Define a selected handler for the ListView. + listView.ItemSelected += (sender, args) => + { + // Set the BindingContext of the detail page. + this.Detail.BindingContext = args.SelectedItem; + + // Show the detail page. + this.IsPresented = false; + }; + + // Initialize the ListView selection. + listView.SelectedItem = namedColors[0]; + + + } + } +} + ]]></code> + </example> + <block subset="none" type="note"> + <para>The Windows Phone and Android platforms do not support sliding the detail screen in order to show or hide it. Application developers can use a <see cref="T:Xamarin.Forms.TapGestureRecognizer" /> to provide the user an additional way to show and hide the Detail screen on these platforms. On Windows Phone, developers could consider using a user interface class that provides an experience that is more consistent with that platform, such as <see cref="T:Xamarin.Forms.CarouselPage" />.</para> + </block> + </remarks> + </Docs> + <Members> + <Member MemberName=".ctor"> + <MemberSignature Language="C#" Value="public MasterDetailPage ();" /> + <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>Creates a new empty <see cref="T:Xamarin.Forms.MasterDetailPage" />.</summary> + <remarks>To be added.</remarks> + </Docs> + </Member> + <Member MemberName="Detail"> + <MemberSignature Language="C#" Value="public Xamarin.Forms.Page Detail { get; set; }" /> + <MemberSignature Language="ILAsm" Value=".property instance class Xamarin.Forms.Page Detail" /> + <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.Page</ReturnType> + </ReturnValue> + <Docs> + <summary>Gets or sets the detail page that is used to display details about items on the master page.</summary> + <value>To be added.</value> + <remarks>To be added.</remarks> + </Docs> + </Member> + <Member MemberName="IsGestureEnabled"> + <MemberSignature Language="C#" Value="public bool IsGestureEnabled { get; set; }" /> + <MemberSignature Language="ILAsm" Value=".property instance bool IsGestureEnabled" /> + <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.Boolean</ReturnType> + </ReturnValue> + <Docs> + <summary>Gets or sets a value that turns on or off the gesture to reveal the master page. This is a bindable property.</summary> + <value> + <see langword="true" /> if gesture is enabled; otherwise <see langword="false" />. Default is <see langword="true" />.</value> + <remarks>Has no effect on Windows Phone.</remarks> + </Docs> + </Member> + <Member MemberName="IsGestureEnabledProperty"> + <MemberSignature Language="C#" Value="public static readonly Xamarin.Forms.BindableProperty IsGestureEnabledProperty;" /> + <MemberSignature Language="ILAsm" Value=".field public static initonly class Xamarin.Forms.BindableProperty IsGestureEnabledProperty" /> + <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>Backing store for the IsGestureEnabled bindable property.</summary> + <remarks> + </remarks> + </Docs> + </Member> + <Member MemberName="IsPresented"> + <MemberSignature Language="C#" Value="public bool IsPresented { get; set; }" /> + <MemberSignature Language="ILAsm" Value=".property instance bool IsPresented" /> + <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.Boolean</ReturnType> + </ReturnValue> + <Docs> + <summary>Gets or sets a value that indicates whether or not the visual element that is represented by the <see cref="P:Xamarin.Forms.MasterDetailPage.Master" /> property is presented to the user.</summary> + <value>To be added.</value> + <remarks>Setting this property causes the <see cref="E:Xamarin.Forms.MasterDetailPage.IsPresentedChanged" /> event to be raised.</remarks> + </Docs> + </Member> + <Member MemberName="IsPresentedChanged"> + <MemberSignature Language="C#" Value="public event EventHandler IsPresentedChanged;" /> + <MemberSignature Language="ILAsm" Value=".event class System.EventHandler IsPresentedChanged" /> + <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>Event that is raised when the visual element that is represented by the <see cref="P:Xamarin.Forms.MasterDetailPage.Master" /> property is presented or hidden.</summary> + <remarks>To be added.</remarks> + </Docs> + </Member> + <Member MemberName="IsPresentedProperty"> + <MemberSignature Language="C#" Value="public static readonly Xamarin.Forms.BindableProperty IsPresentedProperty;" /> + <MemberSignature Language="ILAsm" Value=".field public static initonly class Xamarin.Forms.BindableProperty IsPresentedProperty" /> + <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>Backing store for the <see cref="P:Xamarin.Forms.MasterDetailPage.IsPresented" /> property.</summary> + <remarks>To be added.</remarks> + </Docs> + </Member> + <Member MemberName="LayoutChildren"> + <MemberSignature Language="C#" Value="protected override void LayoutChildren (double x, double y, double width, double height);" /> + <MemberSignature Language="ILAsm" Value=".method familyhidebysig virtual instance void LayoutChildren(float64 x, float64 y, float64 width, float64 height) 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="x" Type="System.Double" /> + <Parameter Name="y" Type="System.Double" /> + <Parameter Name="width" Type="System.Double" /> + <Parameter Name="height" Type="System.Double" /> + </Parameters> + <Docs> + <param name="x">To be added.</param> + <param name="y">To be added.</param> + <param name="width">To be added.</param> + <param name="height">To be added.</param> + <summary>Lays out the master and detail pages.</summary> + <remarks>To be added.</remarks> + </Docs> + </Member> + <Member MemberName="Master"> + <MemberSignature Language="C#" Value="public Xamarin.Forms.Page Master { get; set; }" /> + <MemberSignature Language="ILAsm" Value=".property instance class Xamarin.Forms.Page Master" /> + <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.Page</ReturnType> + </ReturnValue> + <Docs> + <summary>Gets or sets the master page.</summary> + <value>To be added.</value> + <remarks>To be added.</remarks> + </Docs> + </Member> + <Member MemberName="MasterBehavior"> + <MemberSignature Language="C#" Value="public Xamarin.Forms.MasterBehavior MasterBehavior { get; set; }" /> + <MemberSignature Language="ILAsm" Value=".property instance valuetype Xamarin.Forms.MasterBehavior MasterBehavior" /> + <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.MasterBehavior</ReturnType> + </ReturnValue> + <Docs> + <summary>Gets or sets a value that indicates how detail content is displayed.</summary> + <value>To be added.</value> + <remarks>To be added.</remarks> + </Docs> + </Member> + <Member MemberName="MasterBehaviorProperty"> + <MemberSignature Language="C#" Value="public static readonly Xamarin.Forms.BindableProperty MasterBehaviorProperty;" /> + <MemberSignature Language="ILAsm" Value=".field public static initonly class Xamarin.Forms.BindableProperty MasterBehaviorProperty" /> + <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>Backing store for the MasterBehavior property.</summary> + <remarks>To be added.</remarks> + </Docs> + </Member> + <Member MemberName="OnAppearing"> + <MemberSignature Language="C#" Value="protected override void OnAppearing ();" /> + <MemberSignature Language="ILAsm" Value=".method familyhidebysig virtual instance void OnAppearing() 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>Event that is raised when a detail appears.</summary> + <remarks>To be added.</remarks> + </Docs> + </Member> + <Member MemberName="OnBackButtonPressed"> + <MemberSignature Language="C#" Value="protected override bool OnBackButtonPressed ();" /> + <MemberSignature Language="ILAsm" Value=".method familyhidebysig virtual instance bool OnBackButtonPressed() 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.Boolean</ReturnType> + </ReturnValue> + <Parameters /> + <Docs> + <summary>Event that is raised when the back button is pressed.</summary> + <returns>To be added.</returns> + <remarks>To be added.</remarks> + </Docs> + </Member> + <Member MemberName="OnDisappearing"> + <MemberSignature Language="C#" Value="protected override void OnDisappearing ();" /> + <MemberSignature Language="ILAsm" Value=".method familyhidebysig virtual instance void OnDisappearing() cil managed" /> + <MemberType>Method</MemberType> + <AssemblyInfo> + <AssemblyVersion>1.3.0.0</AssemblyVersion> + <AssemblyVersion>1.4.0.0</AssemblyVersion> + </AssemblyInfo> + <ReturnValue> + <ReturnType>System.Void</ReturnType> + </ReturnValue> + <Parameters /> + <Docs> + <summary>Event that is raised when a detail disappears.</summary> + <remarks>To be added.</remarks> + </Docs> + </Member> + <Member MemberName="OnParentSet"> + <MemberSignature Language="C#" Value="protected override void OnParentSet ();" /> + <MemberSignature Language="ILAsm" Value=".method familyhidebysig virtual instance void OnParentSet() 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>Method that is called when the <see cref="P:Xamarin.Forms.Element.Parent" /> property of this <see cref="Xamarin.Forms.MasterDetailPage" /> is set.</summary> + <remarks>To be added.</remarks> + </Docs> + </Member> + <Member MemberName="ShouldShowToolbarButton"> + <MemberSignature Language="C#" Value="public virtual bool ShouldShowToolbarButton ();" /> + <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance bool ShouldShowToolbarButton() 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.Boolean</ReturnType> + </ReturnValue> + <Parameters /> + <Docs> + <summary>Returns a value that tells whether the list view should display a toolbar button.</summary> + <returns>To be added.</returns> + <remarks>To be added.</remarks> + </Docs> + </Member> + </Members> +</Type> |