Xamarin.Forms.Core 1.0.0.0 1.1.0.0 1.2.0.0 1.3.0.0 1.4.0.0 1.5.0.0 2.0.0.0 Xamarin.Forms.Element Xamarin.Forms.IAnimatable Xamarin.Forms.IVisualElementController A that occupies an area on the screen, has a visual appearance, and can obtain touch input. The base class for most Xamarin.Forms on-screen elements. Provides most properties, events, and methods for presenting an item on screen. Property 1.0.0.0 1.1.0.0 1.2.0.0 1.3.0.0 1.4.0.0 1.5.0.0 2.0.0.0 System.Double Gets or sets the X component of the center point for any transform, relative to the bounds of the element. This is a bindable property. The value that declares the X component of the transform. The default value is 0.5. To be added. Field 1.0.0.0 1.1.0.0 1.2.0.0 1.3.0.0 1.4.0.0 1.5.0.0 2.0.0.0 Xamarin.Forms.BindableProperty Identifies the AnchorX bindable property. To be added. Property 1.0.0.0 1.1.0.0 1.2.0.0 1.3.0.0 1.4.0.0 1.5.0.0 2.0.0.0 System.Double Gets or sets the Y component of the center point for any transform, relative to the bounds of the element. This is a bindable property. The value that declares the Y component of the transform. The default value is 0.5. To be added. Field 1.0.0.0 1.1.0.0 1.2.0.0 1.3.0.0 1.4.0.0 1.5.0.0 2.0.0.0 Xamarin.Forms.BindableProperty Identifies the AnchorY bindable property. To be added. Property 1.0.0.0 1.1.0.0 1.2.0.0 1.3.0.0 1.4.0.0 1.5.0.0 2.0.0.0 Xamarin.Forms.Color Gets or sets the color which will fill the background of a VisualElement. This is a bindable property. The color that is used to fill the background of a VisualElement. The default is . To be added. Field 1.0.0.0 1.1.0.0 1.2.0.0 1.3.0.0 1.4.0.0 1.5.0.0 2.0.0.0 Xamarin.Forms.BindableProperty Identifies the BackgroundColor bindable property. To be added. Method 1.0.0.0 1.1.0.0 1.2.0.0 1.3.0.0 1.4.0.0 1.5.0.0 2.0.0.0 System.Void Signals the start of a batch of changes to the elements properties. Application authors will not generally need to batch updates manually as the animation framework will do this for them. Method 1.0.0.0 1.1.0.0 1.2.0.0 1.3.0.0 1.4.0.0 1.5.0.0 2.0.0.0 System.Void Signals the end of a batch of commands to the element and that those commands should now be committed. This method merely ensures that updates sent during the batch have been committed. It does not ensure that they were not committed before calling this. Property 1.3.0.0 1.4.0.0 1.5.0.0 2.0.0.0 System.Collections.Generic.IList<Xamarin.Forms.Behavior> Gets the list of Behavior associated to this element. This is a bindable propery. Field 1.3.0.0 1.4.0.0 1.5.0.0 2.0.0.0 Xamarin.Forms.BindableProperty Identifies the Behaviors bindable property. Property 1.0.0.0 1.1.0.0 1.2.0.0 1.3.0.0 1.4.0.0 1.5.0.0 2.0.0.0 Xamarin.Forms.Rectangle Gets the bounds of the element. The bounds of an element, in device-independent units. Bounds is assigned during the Layout cycle by a call to . Event 1.0.0.0 1.1.0.0 1.2.0.0 1.3.0.0 1.4.0.0 1.5.0.0 2.0.0.0 System.EventHandler Occurs when the Children of a VisualElement have been re-ordered. Method 2.0.0.0 System.Void Finalizer for visual elements. To be added. Method 1.0.0.0 1.1.0.0 1.2.0.0 1.3.0.0 1.4.0.0 1.5.0.0 2.0.0.0 System.Boolean Attemps to set focus to this element. if the keyboard focus was set to this element; if the call to this method did not force a focus change. Element must be able to receive focus for this to work. Calling Focus on offscreen or unrealized elements has undefined behavior. Event 1.0.0.0 1.1.0.0 1.2.0.0 1.3.0.0 1.4.0.0 1.5.0.0 2.0.0.0 System.EventHandler<Xamarin.Forms.FocusEventArgs> Occurs when the element receives focus. Focused event is raised whenever the VisualElement receives focus. This event is not bubbled through the Forms stack and is received directly from the native control. This event is emitted by the IsFocusedProperty setter. Method 1.0.0.0 1.1.0.0 1.2.0.0 1.3.0.0 1.4.0.0 1.5.0.0 2.0.0.0 System.Obsolete("Use Measure") Xamarin.Forms.SizeRequest The available width that a parent element can allocated to a child. Value will be between 0 and double.PositiveInfinity. The available height that a parent element can allocated to a child. Value will be between 0 and double.PositiveInfinity. Returns the of the element. Calling this method begins the measure pass of a layout cycle. A which contains a requested size and a minimum size. Calling GetSizeRequest causes a measure pass to occur for the subtree of elements it is called on. It is ideal to only call GetSizeRequest when needed as excessive calls can negatively impact the performance of your app. Overriding GetSizeRequest should only be done if you want to ignore Width/HeightRequest. More likely a subclass would wish to override . Property 1.0.0.0 1.1.0.0 1.2.0.0 1.3.0.0 1.4.0.0 1.5.0.0 2.0.0.0 System.Double Gets the current rendered height of this element. This is a read-only bindable property. The renderered height of this element. The height of an element is set during the Layout phase. Field 1.0.0.0 1.1.0.0 1.2.0.0 1.3.0.0 1.4.0.0 1.5.0.0 2.0.0.0 Xamarin.Forms.BindableProperty Identifies the Height bindable property. Property 1.0.0.0 1.1.0.0 1.2.0.0 1.3.0.0 1.4.0.0 1.5.0.0 2.0.0.0 System.Double Gets or sets the desired height override of this element. The height this element desires to be. HeightRequest does not immediately change the Bounds of a VisualElement, however setting the HeightRequest will change the result of calls to GetSizeRequest, which will in turn modify the final size the element receives during a layout cycle. Field 1.3.0.0 1.4.0.0 1.5.0.0 2.0.0.0 Xamarin.Forms.BindableProperty Backing store for the HeightRequest property. To be added. Property 1.0.0.0 1.1.0.0 1.2.0.0 1.3.0.0 1.4.0.0 1.5.0.0 2.0.0.0 System.Boolean Gets or sets a value indicating whether this element should be involved in the user interaction cycle. This is a bindable property. if the element should receive input; if element should not receive input and should, instead, pass inputs to the element below. Default is . Setting InputTransparent is not the same as setting IsEnabled to false. Setting InputTransparent only disables inputs and instead causes them to be passed to the VisualElement below the element. Usually this is the parent of the element. Field 1.0.0.0 1.1.0.0 1.2.0.0 1.3.0.0 1.4.0.0 1.5.0.0 2.0.0.0 Xamarin.Forms.BindableProperty Identifies the InputTransparent bindable property. Method 1.0.0.0 1.1.0.0 1.2.0.0 1.3.0.0 1.4.0.0 1.5.0.0 2.0.0.0 System.Void Method that is called to invalidate the layout of this . Raises the event. To be added. Property 1.0.0.0 1.1.0.0 1.2.0.0 1.3.0.0 1.4.0.0 1.5.0.0 2.0.0.0 System.Boolean Gets or sets a value indicating whether this element is enabled in the user interface. This is a bindable property. if the element is enabled; otherwise, . The default value is Elements that are not enabled do not participate in hit detection, and therefore will not receive focus or emit input events. The following example shows a handler on a button which will then set IsEnabled to false on another button. button2.IsEnabled = false; } } ]]> Field 1.0.0.0 1.1.0.0 1.2.0.0 1.3.0.0 1.4.0.0 1.5.0.0 2.0.0.0 Xamarin.Forms.BindableProperty Identifies the IsEnabled bindable property. Property 1.0.0.0 1.1.0.0 1.2.0.0 1.3.0.0 1.4.0.0 1.5.0.0 2.0.0.0 System.Boolean Gets a value indicating whether this element is focused currently. This is a bindable property. if the element is focused; otherwise, . Applications may have multiple focuses depending on the implementation of the underlying toolkit. Menus and modals in particular may leave multiple items with focus. The following example shows conditionally setting a background color based on the focus state. Field 1.3.0.0 1.4.0.0 1.5.0.0 2.0.0.0 Xamarin.Forms.BindableProperty Identifies the IsFocused bindable property. Property 1.0.0.0 1.1.0.0 1.2.0.0 1.3.0.0 1.4.0.0 1.5.0.0 2.0.0.0 System.Boolean Gets or sets a value that determines whether this elements should be part of the visual tree or not. This is a bindable property. if the element should be rendered; otherwise, . Default value is . Setting IsVisible to false will remove the element from the visual tree. The element will no longer take up space in layouts or be eligle to receive any kind of input event. The following example shows a stack where the middle element is toggled when a button is activated. Field 1.0.0.0 1.1.0.0 1.2.0.0 1.3.0.0 1.4.0.0 1.5.0.0 2.0.0.0 Xamarin.Forms.BindableProperty Identifies the IsVisible bindable property. Method 1.0.0.0 1.1.0.0 1.2.0.0 1.3.0.0 1.4.0.0 1.5.0.0 2.0.0.0 System.Void The new bounds of the element. Updates the bounds of the element during the layout cycle. Calling Layout will trigger a layout cycle for the sub-tree of this element. Method 2.0.0.0 Xamarin.Forms.SizeRequest To be added. To be added. To be added. Measures a visual element for layout operations. To be added. To be added. Event 1.0.0.0 1.1.0.0 1.2.0.0 1.3.0.0 1.4.0.0 1.5.0.0 2.0.0.0 System.EventHandler Event that is raised when the layout of a visual element is invalidated. To be added. Property 1.0.0.0 1.1.0.0 1.2.0.0 1.3.0.0 1.4.0.0 1.5.0.0 2.0.0.0 System.Double Gets or sets a value which overrides the minimum height the element will request during layout. The minimum height the element requires. Default value is -1. MinimumHeightRequest is used to override the results of a call to by setting the minimum height property. This causes overflow handling to shrink this element to its minimum height before elements who do not have a minimum size set. The following example sets the MinimumHeightRequest to enable an image to shrink below it's normal size. Field 1.3.0.0 1.4.0.0 1.5.0.0 2.0.0.0 Xamarin.Forms.BindableProperty Backing store for the MinimumHeightRequest property. To be added. Property 1.0.0.0 1.1.0.0 1.2.0.0 1.3.0.0 1.4.0.0 1.5.0.0 2.0.0.0 System.Double Gets or sets a value which overrides the minimum width the element will request during layout. The minimum width the element requires. Default value is -1. MinimumWidthRequest is used to override the results of a call to by setting the minimum width property. This causes overflow handling to shrink this element to its minimum width before elements who do not have a minimum size set. The following example sets the MinimumWidthRequest to enable an image to shrink below it's normal size. Field 1.3.0.0 1.4.0.0 1.5.0.0 2.0.0.0 Xamarin.Forms.BindableProperty Backing store for the MinimumWidthRequest property. To be added. Property 1.0.0.0 1.1.0.0 1.2.0.0 1.3.0.0 1.4.0.0 1.5.0.0 2.0.0.0 Xamarin.Forms.INavigation Gets the context aware navigation interface for the element. An that allows for navigation using the ancestral navigation implementor. Use the Navigation property to perform navigation from any element. If the element has not yet been added to a tree which contains a navigation implementor, the actions are queued up until it is. The following example navigates to a new page created in the callback of a buttons event. Field 1.0.0.0 1.1.0.0 1.2.0.0 1.3.0.0 1.4.0.0 1.5.0.0 2.0.0.0 Xamarin.Forms.BindableProperty Identifies the Navigation bindable property. Method 1.5.0.0 2.0.0.0 System.Void To be added. Application developers can override this method to respond when a child is added. Application developers who override this method must call base.OnChildAdded before performing any other actions in their override. Method 1.5.0.0 2.0.0.0 System.Void To be added. Application developers can override this method to respond when a child is removed. Application developers who override this method must call base.OnChildRemoved before performing any other actions in their override. Method 1.0.0.0 1.1.0.0 1.2.0.0 1.3.0.0 1.4.0.0 1.5.0.0 2.0.0.0 System.Void Invoked whenever the event is about to be emitted. Implement this method to add class handling for this event. This method has no default implementation. You should still call the base implementation in case an intermediate class has implemented this method. Method 2.0.0.0 Xamarin.Forms.SizeRequest To be added. To be added. Method that is called when a layout measurement happens. To be added. To be added. Method 1.0.0.0 1.1.0.0 1.2.0.0 1.3.0.0 1.4.0.0 1.5.0.0 2.0.0.0 System.Void Invoked whenever the Parent of an element is set. Implement this method in order to add behavior when the element is added to a parent. It is required to call the base implementation. Method 1.0.0.0 1.1.0.0 1.2.0.0 1.3.0.0 1.4.0.0 1.5.0.0 2.0.0.0 System.Void The new width of the element. The new height of the element. This method is called when the size of the element is set during a layout cycle. This method is called directly before the event is emitted. Implement this method to add class handling for this event. This method has no default implementation. You should still call the base implementation in case an intermediate class has implemented this method. Most layouts will want to implement this method in order to layout their children during a layout cycle. Method 1.0.0.0 1.1.0.0 1.2.0.0 1.3.0.0 1.4.0.0 1.5.0.0 2.0.0.0 System.Obsolete("Use OnMeasure") Xamarin.Forms.SizeRequest The available width for the element to use. The available height for the element to use. This method is called during the measure pass of a layout cycle to get the desired size of an element. A which contains the desired size of the element. The results of this method will be (-1, -1) if the element has not yet been realized with a platform specific backing control. Overriding this method does not require a call to the base class so long as a valid SizeRequest is returned. Property 1.0.0.0 1.1.0.0 1.2.0.0 1.3.0.0 1.4.0.0 1.5.0.0 2.0.0.0 System.Double Gets or sets the opacity value applied to the element when it is rendered. This is a bindable property. The opacity value. Default opacity is 1.0. Values will be clamped between 0 and 1 on set. The opacity value has no effect unless IsVisible is . Opacity is inherited down the element hierarchy. If a parent has 0.5 opacity, and a child has 0.5 opacity, the child will render with an effective 0.25 opacity. Setting opacity to 0 has undefined behavior with input elements. The following example sets the opacity of a layout to 0.5 and the opacity of one of its children to 0.5, making the child 25% opaque. Field 1.0.0.0 1.1.0.0 1.2.0.0 1.3.0.0 1.4.0.0 1.5.0.0 2.0.0.0 Xamarin.Forms.BindableProperty Identifies the Opacity bindable property. Property 1.0.0.0 1.1.0.0 1.2.0.0 1.3.0.0 1.4.0.0 1.5.0.0 2.0.0.0 Xamarin.Forms.ResourceDictionary Gets or sets the local resource dictionary. The current resource dictionary, where resources are stored by key. In XAML, resource dictionaries are filled with key/value pairs that are specified in XML and consequently created at run time. The keys in the resource dictionary are specified with the x:Key attribute of the XML tag for the type to create. An object of that type is created, and is initialized with the property and field values that are specified either by additional attributes or by nested tags, both of which, when present are simply string representations of the property or field names. The object is then inserted into the for the enclosing type at runtime. For example, the XAML below, taken from the XAML for Xamarin.Forms series, creates a resource dictionary that contains object constants that can be used for any objects that are added to the surrounding : ]]> Note that the above snippet is only valid when nested within a <ContentPage>...</ContentPage> tag pair. Within that pair, the app developer can use both of the horzOptions and vertOptions keys to specify values for properties of type by using the "{...}" static resource syntax. The short example below, also taken from the XAML for Xamarin.Forms series, illustrates this syntax: ]]> Resource dictionaries and their associated XML provide the application developer with a convenient method to reuse code inside the XAML compile-time and run-time engines. Property 1.0.0.0 1.1.0.0 1.2.0.0 1.3.0.0 1.4.0.0 1.5.0.0 2.0.0.0 System.Double Gets or sets the rotation about the Z-axis (affine rotation) when the element is rendered. The rotation about the Z-axis in degrees. Rotation is applied relative to and . Field 1.0.0.0 1.1.0.0 1.2.0.0 1.3.0.0 1.4.0.0 1.5.0.0 2.0.0.0 Xamarin.Forms.BindableProperty Identifies the Rotation bindable property. Property 1.0.0.0 1.1.0.0 1.2.0.0 1.3.0.0 1.4.0.0 1.5.0.0 2.0.0.0 System.Double Gets or sets the rotation about the X-axis (perspective rotation) when the element is rendered. The rotation about the X-axis in degrees. RotationX is applied relative to and . Field 1.0.0.0 1.1.0.0 1.2.0.0 1.3.0.0 1.4.0.0 1.5.0.0 2.0.0.0 Xamarin.Forms.BindableProperty Identifies the RotationX bindable property. Property 1.0.0.0 1.1.0.0 1.2.0.0 1.3.0.0 1.4.0.0 1.5.0.0 2.0.0.0 System.Double Gets or sets the rotation about the Y-axis (perspective rotation) when the element is rendered. The rotation about the Y-axis in degrees. RotationY is applied relative to and . Field 1.0.0.0 1.1.0.0 1.2.0.0 1.3.0.0 1.4.0.0 1.5.0.0 2.0.0.0 Xamarin.Forms.BindableProperty Identifies the RotationY bindable property. Property 1.0.0.0 1.1.0.0 1.2.0.0 1.3.0.0 1.4.0.0 1.5.0.0 2.0.0.0 System.Double Gets or sets the scale factor applied to the element. The scale factor of the element. Default value is 1.0. Scale is applied relative to and . Field 1.0.0.0 1.1.0.0 1.2.0.0 1.3.0.0 1.4.0.0 1.5.0.0 2.0.0.0 Xamarin.Forms.BindableProperty Identifies the Scale bindable property. Method 1.0.0.0 1.1.0.0 1.2.0.0 1.3.0.0 1.4.0.0 1.5.0.0 2.0.0.0 System.Void The newly allocated width. The newly allocated height. SizeAllocated is called during a layout cycle to signal the start of a sub-tree layout. Calling SizeAllocated will start a new layout cycle on the children of the element. Excessive calls to SizeAllocated may cause performance problems. Event 1.0.0.0 1.1.0.0 1.2.0.0 1.3.0.0 1.4.0.0 1.5.0.0 2.0.0.0 System.EventHandler Occurs when either the Width or the Height properties change value on this element. Classes should implement if they wish to respond to size change events directly. Property 1.3.0.0 1.4.0.0 1.5.0.0 2.0.0.0 Xamarin.Forms.Style Gets or sets the style that defines how this visual element is displayed. To be added. To be added. Property 2.0.0.0 Xamarin.Forms.TypeConverter(typeof(Xamarin.Forms.ListStringTypeConverter)) System.Collections.Generic.IList<System.String> Gets or sets the style class for the visual element. To be added. To be added. Field 1.3.0.0 1.4.0.0 1.5.0.0 2.0.0.0 Xamarin.Forms.BindableProperty Backing store for the Style property. To be added. Property 1.2.0.0 1.3.0.0 1.4.0.0 1.5.0.0 2.0.0.0 System.Double Gets or sets the X translation delta of the element. The amount to translate the element. Translation is applied post layout. It is particularly good for applying animations. Translating an element outside the bounds of its parent container may prevent inputs from working. Field 1.2.0.0 1.3.0.0 1.4.0.0 1.5.0.0 2.0.0.0 Xamarin.Forms.BindableProperty Identifies the TranslationX bindable property. Property 1.2.0.0 1.3.0.0 1.4.0.0 1.5.0.0 2.0.0.0 System.Double Gets or sets the Y translation delta of the element. The amount to translate the element. Translation is applied post layout. It is particularly good for applying animations. Translating an element outside the bounds of its parent container may prevent inputs from working. Field 1.2.0.0 1.3.0.0 1.4.0.0 1.5.0.0 2.0.0.0 Xamarin.Forms.BindableProperty Identifies the TranslationY bindable property. Property 1.3.0.0 1.4.0.0 1.5.0.0 2.0.0.0 System.Collections.Generic.IList<Xamarin.Forms.TriggerBase> Gets the list of Trigger associated to this element. This is a bindable property. Field 1.3.0.0 1.4.0.0 1.5.0.0 2.0.0.0 Xamarin.Forms.BindableProperty Identifies the Triggers bindable property. Method 1.0.0.0 1.1.0.0 1.2.0.0 1.3.0.0 1.4.0.0 1.5.0.0 2.0.0.0 System.Void Unsets focus to this element. Element must already have focus for this to have any effect. Event 1.0.0.0 1.1.0.0 1.2.0.0 1.3.0.0 1.4.0.0 1.5.0.0 2.0.0.0 System.EventHandler<Xamarin.Forms.FocusEventArgs> Occurs when the element loses focus. Unfocused event is raised whenever the VisualElement loses focus. This event is not bubbled through the Forms stack and is received directly from the native control. This event is emitted by the IsFocusedProperty setter. Property 1.0.0.0 1.1.0.0 1.2.0.0 1.3.0.0 1.4.0.0 1.5.0.0 2.0.0.0 System.Double Gets the current rendered width of this element. This is a read-only bindable property. The renderered width of this element. The width of an element is set during the Layout phase. Field 1.0.0.0 1.1.0.0 1.2.0.0 1.3.0.0 1.4.0.0 1.5.0.0 2.0.0.0 Xamarin.Forms.BindableProperty Identifies the Width bindable property. Property 1.0.0.0 1.1.0.0 1.2.0.0 1.3.0.0 1.4.0.0 1.5.0.0 2.0.0.0 System.Double Gets or sets the desired width override of this element. The width this element desires to be. WidthRequest does not immediately change the Bounds of a VisualElement, however setting the WidthRequest will change the result of calls to GetSizeRequest, which will in turn modify the final size the element receives during a layout cycle. Field 1.3.0.0 1.4.0.0 1.5.0.0 2.0.0.0 Xamarin.Forms.BindableProperty Backing store for the WidthRequest property. To be added. Property 1.0.0.0 1.1.0.0 1.2.0.0 1.3.0.0 1.4.0.0 1.5.0.0 2.0.0.0 System.Double Gets the current X position of this element. This is a read-only bindable property. The X position of this element relative to its parents bounds. The x value of an element is set during the Layout phase. Method 2.0.0.0 System.Void To be added. This method is for internal use. To be added. Method 1.3.0.0 1.4.0.0 1.5.0.0 2.0.0.0 System.Void Invalidates the measure when the native size of the element changes. To be added. Field 1.0.0.0 1.1.0.0 1.2.0.0 1.3.0.0 1.4.0.0 1.5.0.0 2.0.0.0 Xamarin.Forms.BindableProperty Identifies the X bindable property. Property 1.0.0.0 1.1.0.0 1.2.0.0 1.3.0.0 1.4.0.0 1.5.0.0 2.0.0.0 System.Double Gets the current Y position of this element. This is a read-only bindable property. The Y position of this element relative to its parents bounds. The y value of an element is set during the Layout phase. Field 1.0.0.0 1.1.0.0 1.2.0.0 1.3.0.0 1.4.0.0 1.5.0.0 2.0.0.0 Xamarin.Forms.BindableProperty Identifies the Y bindable property.