TableView TableView Class

Definition

Namespace:
Xamarin.Forms Xamarin.Forms
Assembly:
Xamarin.Forms.Core.dll

A View that holds rows of Cell elements.

[Xamarin.Forms.ContentProperty("Root")]
[Xamarin.Forms.RenderWith(typeof(Xamarin.Forms.Platform._TableViewRenderer))]
public class TableView : Xamarin.Forms.View, Xamarin.Forms.IElementConfiguration<Xamarin.Forms.TableView>, Xamarin.Forms.ITableViewController
type TableView = class
    inherit View
    interface ITableViewController
    interface IElementConfiguration<TableView>
Inheritance
ObjectObject
BindableObjectBindableObject
ElementElement
NavigableElementNavigableElement
VisualElementVisualElement
ViewView
TableViewTableView
Attributes
ContentPropertyAttribute RenderWithAttribute
Implements
IElementConfiguration<TableView> ITableViewControllerITableViewController

Remarks

A TableView has a TableRoot as its Root property. The TableRoot is a type of TableSection.

The following example shows a basic table with two sections.


public class App : Application
{
    public App()
    {
        MainPage = new ContentPage {
            Content = new TableView {
                Intent = TableIntent.Form,
                Root = new TableRoot ("Table Title") {
                    new TableSection ("Section 1 Title") {
                        new TextCell {
                            Text = "TextCell Text",
                            Detail = "TextCell Detail"
                        },
                        new EntryCell {
                            Label = "EntryCell:",
                            Placeholder = "default keyboard",
                            Keyboard = Keyboard.Default
                        }
                    },
                    new TableSection ("Section 2 Title") {
                        new EntryCell {
                            Label = "Another EntryCell:",
                            Placeholder = "phone keyboard",
                            Keyboard = Keyboard.Telephone
                        },
                        new SwitchCell {
                            Text = "SwitchCell:"
                        }
                    }
                }
            }
        }; 
    }
    // OnStart, OnSleep, OnResume overrides omitted...
}

Constructors

TableView() TableView()

Initializes a new TableView instance.
TableView(TableRoot) TableView(TableRoot)

Initializes a new TableView instance.

Fields

HasUnevenRowsProperty HasUnevenRowsProperty

Backing store for the HasUnevenRows property.
RowHeightProperty RowHeightProperty

Backing store for the row height property.

Properties

AnchorX AnchorX

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.

(Inherited from VisualElement)
AnchorY AnchorY

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.

(Inherited from VisualElement)
AutomationId AutomationId

Gets or sets a value that allows the automation framework to find and interact with this element.

(Inherited from Element)
BackgroundColor BackgroundColor

Gets or sets the color which will fill the background of a VisualElement. This is a bindable property.

(Inherited from VisualElement)
Batched Batched

For internal use by the Xamarin.Forms platform.

(Inherited from VisualElement)
Behaviors Behaviors

Gets the list of Behavior associated to this element. This is a bindable propery.

(Inherited from VisualElement)
BindingContext BindingContext

Gets or sets object that contains the properties that will be targeted by the bound properties that belong to this BindableObject.

(Inherited from BindableObject)
Bounds Bounds

Gets the bounds of the element.

(Inherited from VisualElement)
class class

Gets or sets the style class of the visual element.

(Inherited from VisualElement)
ClassId ClassId

Gets or sets a value used to identify a collection of semantically similar elements.

(Inherited from Element)
DisableLayout DisableLayout

For internal use by the Xamarin.Forms platform.

(Inherited from VisualElement)
EffectControlProvider EffectControlProvider

For internal use by the Xamarin.Forms platform.

(Inherited from Element)
Effects Effects

A list of the effects that are applied to this item.

(Inherited from Element)
FlowDirection FlowDirection

Gets or sets the layout flow direction.

(Inherited from VisualElement)
GestureController GestureController

Gets the gesture controller for the view.

(Inherited from View)
GestureRecognizers GestureRecognizers

The collection of gesture recognizers associated with this view.

(Inherited from View)
HasUnevenRows HasUnevenRows

Gets or sets a value that indicates whether the rows that are contained in this TableView can have uneven rows.
Height Height

Gets the current rendered height of this element. This is a read-only bindable property.

(Inherited from VisualElement)
HeightRequest HeightRequest

Gets or sets the desired height override of this element.

(Inherited from VisualElement)
HorizontalOptions HorizontalOptions

Gets or sets the LayoutOptions that define how the element gets laid in a layout cycle. This is a bindable property.

(Inherited from View)
Id Id

Gets a value that can be used to uniquely identify an element through the run of an application.

(Inherited from Element)
IGestureController.CompositeGestureRecognizers IGestureController.CompositeGestureRecognizers

For internal use by the Xamarin.Forms platform.

(Inherited from View)
InputTransparent InputTransparent

Gets or sets a value indicating whether this element should be involved in the user interaction cycle. This is a bindable property.

(Inherited from VisualElement)
Intent Intent

Gets or sets the intent of the table.
IsEnabled IsEnabled

Gets or sets a value indicating whether this element is enabled in the user interface. This is a bindable property.

(Inherited from VisualElement)
IsFocused IsFocused

Gets a value indicating whether this element is focused currently. This is a bindable property.

(Inherited from VisualElement)
IsInNativeLayout IsInNativeLayout

For internal use by the Xamarin.Forms platform.

(Inherited from VisualElement)
IsNativeStateConsistent IsNativeStateConsistent

For internal use by the Xamarin.Forms platform.

(Inherited from VisualElement)
IsPlatformEnabled IsPlatformEnabled

For internal use by the Xamarin.Forms platform.

(Inherited from VisualElement)
IsTabStop IsTabStop Inherited from VisualElement
IsVisible IsVisible

Gets or sets a value that determines whether this elements should be part of the visual tree or not. This is a bindable property.

(Inherited from VisualElement)
IVisualElementController.EffectiveFlowDirection IVisualElementController.EffectiveFlowDirection

Gets the effective visual flow direction for the element on the platform, taking into account the locale and logical flow settings.

(Inherited from VisualElement)
LogicalChildren LogicalChildren

For internal use by the Xamarin.Forms platform.

(Inherited from Element)
Margin Margin

Gets or sets the margin for the view.

(Inherited from View)
MinimumHeightRequest MinimumHeightRequest

Gets or sets a value which overrides the minimum height the element will request during layout.

(Inherited from VisualElement)
MinimumWidthRequest MinimumWidthRequest

Gets or sets a value which overrides the minimum width the element will request during layout.

(Inherited from VisualElement)
Model Model

For internal use by the Xamarin.Forms platform.
Navigation Navigation Inherited from NavigableElement
NavigationProxy NavigationProxy Inherited from NavigableElement
Opacity Opacity

Gets or sets the opacity value applied to the element when it is rendered. This is a bindable property.

(Inherited from VisualElement)
Parent Parent

Gets or sets the parent element of the element.

(Inherited from Element)
ParentView ParentView

Gets the element which is the closest ancestor of this element that is a VisualElement.

(Inherited from Element)
Platform Platform Inherited from Element
RealParent RealParent

For internal use by the Xamarin.Forms platform.

(Inherited from Element)
Resources Resources

Gets or sets the local resource dictionary.

(Inherited from VisualElement)
Root Root

Gets or sets the root of the table.
Rotation Rotation

Gets or sets the rotation about the Z-axis (affine rotation) when the element is rendered.

(Inherited from VisualElement)
RotationX RotationX

Gets or sets the rotation about the X-axis (perspective rotation) when the element is rendered.

(Inherited from VisualElement)
RotationY RotationY

Gets or sets the rotation about the Y-axis (perspective rotation) when the element is rendered.

(Inherited from VisualElement)
RowHeight RowHeight

An integer that describes the height of the items in the list. This is ignored if HasUnevenRows is true.
Scale Scale

Gets or sets the scale factor applied to the element.

(Inherited from VisualElement)
ScaleX ScaleX

Gets or sets a scale value to apply to the X direction.

(Inherited from VisualElement)
ScaleY ScaleY

Gets or sets a scale value to apply to the Y direction.

(Inherited from VisualElement)
Style Style

Gets or sets the style that defines how this visual element is displayed.

(Inherited from VisualElement)
StyleClass StyleClass

Gets or sets the style class for the visual element.

(Inherited from VisualElement)
StyleId StyleId

Gets or sets a user defined value to uniquely identify the element.

(Inherited from Element)
TabIndex TabIndex Inherited from VisualElement
TranslationX TranslationX

Gets or sets the X translation delta of the element.

(Inherited from VisualElement)
TranslationY TranslationY

Gets or sets the Y translation delta of the element.

(Inherited from VisualElement)
Triggers Triggers

Gets the list of Trigger associated to this element. This is a bindable property.

(Inherited from VisualElement)
VerticalOptions VerticalOptions

Gets or sets the LayoutOptions that define how the element gets laid in a layout cycle. This is a bindable property.

(Inherited from View)
Visual Visual Inherited from VisualElement
Width Width

Gets the current rendered width of this element. This is a read-only bindable property.

(Inherited from VisualElement)
WidthRequest WidthRequest

Gets or sets the desired width override of this element.

(Inherited from VisualElement)
X X

Gets the current X position of this element. This is a read-only bindable property.

(Inherited from VisualElement)
Y Y

Gets the current Y position of this element. This is a read-only bindable property.

(Inherited from VisualElement)

Methods

ApplyBindings() ApplyBindings()

Apply the bindings to BindingContext.

(Inherited from BindableObject)
BatchBegin() BatchBegin()

Signals the start of a batch of changes to the elements properties.

(Inherited from VisualElement)
BatchCommit() BatchCommit()

Signals the end of a batch of commands to the element and that those commands should now be committed.

(Inherited from VisualElement)
ChangeVisualState() ChangeVisualState()

For internal use by the Xamarin.Forms platform.

(Inherited from VisualElement)
ClearValue(BindableProperty) ClearValue(BindableProperty)

Clears any value set by SetValue for property.

(Inherited from BindableObject)
ClearValue(BindablePropertyKey) ClearValue(BindablePropertyKey)

Clears any value set by SetValue for the property that is identified by propertyKey.

(Inherited from BindableObject)
Descendants() Descendants()

For internal use by the Xamarin.Forms platform.

(Inherited from Element)
EffectIsAttached(String) EffectIsAttached(String)

For internal use by the Xamarin.Forms platform.

(Inherited from Element)
FindByName(String) FindByName(String)

Returns the element that has the specified name.

(Inherited from Element)
Focus() Focus()

Attemps to set focus to this element.

(Inherited from VisualElement)
GetChildElements(Point) GetChildElements(Point)

Returns the child elements that are visually beneath the specified point.

(Inherited from View)
GetSizeRequest(Double, Double) GetSizeRequest(Double, Double)

Returns the SizeRequest of the element. Calling this method begins the measure pass of a layout cycle.

(Inherited from VisualElement)
GetValue(BindableProperty) GetValue(BindableProperty)

Returns the value that is contained the BindableProperty.

(Inherited from BindableObject)
GetValues(BindableProperty, BindableProperty) GetValues(BindableProperty, BindableProperty)

For internal use by the Xamarin.Forms platform.

(Inherited from BindableObject)
GetValues(BindableProperty, BindableProperty, BindableProperty) GetValues(BindableProperty, BindableProperty, BindableProperty)

For internal use by the Xamarin.Forms platform.

(Inherited from BindableObject)
InvalidateMeasure() InvalidateMeasure()

Method that is called to invalidate the layout of this VisualElement. Raises the MeasureInvalidated event.

(Inherited from VisualElement)
InvalidateMeasureNonVirtual(InvalidationTrigger) InvalidateMeasureNonVirtual(InvalidationTrigger)

For internal use by the Xamarin.Forms platform.

(Inherited from VisualElement)
IsSet(BindableProperty) IsSet(BindableProperty)

Returns true if the target property exists and has been set.

(Inherited from BindableObject)
Layout(Rectangle) Layout(Rectangle)

Updates the bounds of the element during the layout cycle.

(Inherited from VisualElement)
Measure(Double, Double, MeasureFlags) Measure(Double, Double, MeasureFlags)

Returns the minimum size that a visual element needs in order to be displayed on the device.

(Inherited from VisualElement)
NativeSizeChanged() NativeSizeChanged()

For internal use by the Xamarin.Forms platform.

(Inherited from VisualElement)
On<T>() On<T>()

Returns the platform-specific instance of this TableView, on which a platform-specific method may be called.
OnBindingContextChanged() OnBindingContextChanged()

Method that is called when the binding context changes.
OnChildAdded(Element) OnChildAdded(Element)

Application developers can override this method to respond when a child is added.

(Inherited from VisualElement)
OnChildRemoved(Element) OnChildRemoved(Element)

Application developers can override this method to respond when a child is removed.

(Inherited from VisualElement)
OnChildrenReordered() OnChildrenReordered()

Invoked whenever the ChildrenReordered event is about to be emitted. Implement this method to add class handling for this event.

(Inherited from VisualElement)
OnMeasure(Double, Double) OnMeasure(Double, Double)

Method that is called when a layout measurement happens.

(Inherited from VisualElement)
OnModelChanged() OnModelChanged()

Method that is called when the model changes.
OnParentSet() OnParentSet() Inherited from NavigableElement
OnPropertyChanged(String) OnPropertyChanged(String)

Method that is called when a bound property is changed.

(Inherited from Element)
OnPropertyChanging(String) OnPropertyChanging(String)

Call this method from a child class to notify that a change is going to happen on a property.

(Inherited from BindableObject)
OnSizeAllocated(Double, Double) OnSizeAllocated(Double, Double)

This method is called when the size of the element is set during a layout cycle. This method is called directly before the SizeChanged event is emitted. Implement this method to add class handling for this event.

(Inherited from VisualElement)
OnSizeRequest(Double, Double) OnSizeRequest(Double, Double)

Method that is called when a size request is made.
OnTabIndexPropertyChanged(Int32, Int32) OnTabIndexPropertyChanged(Int32, Int32) Inherited from VisualElement
OnTabStopPropertyChanged(Boolean, Boolean) OnTabStopPropertyChanged(Boolean, Boolean) Inherited from VisualElement
RemoveBinding(BindableProperty) RemoveBinding(BindableProperty)

Removes a previously set binding.

(Inherited from BindableObject)
RemoveDynamicResource(BindableProperty) RemoveDynamicResource(BindableProperty)

Removes a previously set dynamic resource

(Inherited from Element)
SetBinding(BindableProperty, BindingBase) SetBinding(BindableProperty, BindingBase)

Assigns a binding to a property.

(Inherited from BindableObject)
SetDynamicResource(BindableProperty, String) SetDynamicResource(BindableProperty, String)

Sets the BindableProperty property of this element to be updated via the DynamicResource with the provided key.

(Inherited from Element)
SetValue(BindableProperty, Object) SetValue(BindableProperty, Object)

Sets the value of the specified property.

(Inherited from BindableObject)
SetValue(BindablePropertyKey, Object) SetValue(BindablePropertyKey, Object)

Sets the value of the propertyKey.

(Inherited from BindableObject)
SetValueCore(BindableProperty, Object, SetValueFlags) SetValueCore(BindableProperty, Object, SetValueFlags)

For internal use by the Xamarin.Forms platform.

(Inherited from BindableObject)
SetValueFromRenderer(BindableProperty, Object) SetValueFromRenderer(BindableProperty, Object)

For internal use by the Xamarin.Forms platform.

(Inherited from Element)
SetValueFromRenderer(BindablePropertyKey, Object) SetValueFromRenderer(BindablePropertyKey, Object)

For internal use by the Xamarin.Forms platform.

(Inherited from Element)
SizeAllocated(Double, Double) SizeAllocated(Double, Double)

SizeAllocated is called during a layout cycle to signal the start of a sub-tree layout.

(Inherited from VisualElement)
TabIndexDefaultValueCreator() TabIndexDefaultValueCreator() Inherited from VisualElement
TabStopDefaultValueCreator() TabStopDefaultValueCreator() Inherited from VisualElement
UnapplyBindings() UnapplyBindings()

Unapplies all previously set bindings.

(Inherited from BindableObject)
Unfocus() Unfocus()

Unsets focus to this element.

(Inherited from VisualElement)

Events

BatchCommitted BatchCommitted

For internal use by the Xamarin.Forms platform.

(Inherited from VisualElement)
BindingContextChanged BindingContextChanged

Raised whenever the BindingContext property changes.

(Inherited from BindableObject)
ChildAdded ChildAdded

Occurs whenever a child element is added to the element.

(Inherited from Element)
ChildRemoved ChildRemoved

Occurs whenever a child element is removed from the element.

(Inherited from Element)
ChildrenReordered ChildrenReordered

Occurs when the Children of a VisualElement have been re-ordered.

(Inherited from VisualElement)
DescendantAdded DescendantAdded

Occurs whenever a child element is added to the elements subtree.

(Inherited from Element)
DescendantRemoved DescendantRemoved

Occurs whenever a child element is removed from the elements subtree.

(Inherited from Element)
FocusChangeRequested FocusChangeRequested

For internal use by the Xamarin.Forms platform.

(Inherited from VisualElement)
Focused Focused

Occurs when the element receives focus.

(Inherited from VisualElement)
MeasureInvalidated MeasureInvalidated

Event that is raised when the layout of a visual element is invalidated.

(Inherited from VisualElement)
ModelChanged ModelChanged

For internal use by the Xamarin.Forms platform.
PlatformSet PlatformSet Inherited from Element
PropertyChanged PropertyChanged

Raised when a property has changed.

(Inherited from BindableObject)
PropertyChanging PropertyChanging

Raised when a property is about to change.

(Inherited from BindableObject)
SizeChanged SizeChanged

Occurs when either the Width or the Height properties change value on this element.

(Inherited from VisualElement)
Unfocused Unfocused

Occurs when the element loses focus.

(Inherited from VisualElement)

Explicit Interface Implementations

IDynamicResourceHandler.SetDynamicResource(BindableProperty, String) IDynamicResourceHandler.SetDynamicResource(BindableProperty, String)

For internal use by the Xamarin.Forms platform.

(Inherited from BindableObject)
IElementController.SetValueFromRenderer(BindableProperty, Object) IElementController.SetValueFromRenderer(BindableProperty, Object)

For internal use by the Xamarin.Forms platform.

(Inherited from Element)
INameScope.RegisterName(String, Object) INameScope.RegisterName(String, Object)

For internal use only.

(Inherited from Element)
ITableViewController.Model ITableViewController.Model

Internal.
IVisualElementController.InvalidateMeasure(InvalidationTrigger) IVisualElementController.InvalidateMeasure(InvalidationTrigger)

This method is for internal use.

(Inherited from VisualElement)

Extension Methods

AbortAnimation(IAnimatable, String) AbortAnimation(IAnimatable, String)

Stops the animation.
Animate(IAnimatable, String, Action<Double>, Double, Double, UInt32, UInt32, Easing, Action<Double,Boolean>, Func<Boolean>) Animate(IAnimatable, String, Action<Double>, Double, Double, UInt32, UInt32, Easing, Action<Double,Boolean>, Func<Boolean>)

Sets the specified parameters and starts the animation.
Animate(IAnimatable, String, Action<Double>, UInt32, UInt32, Easing, Action<Double,Boolean>, Func<Boolean>) Animate(IAnimatable, String, Action<Double>, UInt32, UInt32, Easing, Action<Double,Boolean>, Func<Boolean>)

Sets the specified parameters and starts the animation.
Animate(IAnimatable, String, Animation, UInt32, UInt32, Easing, Action<Double,Boolean>, Func<Boolean>) Animate(IAnimatable, String, Animation, UInt32, UInt32, Easing, Action<Double,Boolean>, Func<Boolean>)

Sets the specified parameters and starts the animation.
Animate<T>(IAnimatable, String, Func<Double,T>, Action<T>, UInt32, UInt32, Easing, Action<T,Boolean>, Func<Boolean>) Animate<T>(IAnimatable, String, Func<Double,T>, Action<T>, UInt32, UInt32, Easing, Action<T,Boolean>, Func<Boolean>)

Sets the specified parameters and starts the animation.
AnimateKinetic(IAnimatable, String, Func<Double,Double,Boolean>, Double, Double, Action) AnimateKinetic(IAnimatable, String, Func<Double,Double,Boolean>, Double, Double, Action)

Sets the specified parameters and starts the kinetic animation.
AnimationIsRunning(IAnimatable, String) AnimationIsRunning(IAnimatable, String)

Returns a Boolean value that indicates whether or not the animation that is specified by handle is running.
SetBinding(BindableObject, BindableProperty, String, BindingMode, IValueConverter, String) SetBinding(BindableObject, BindableProperty, String, BindingMode, IValueConverter, String)

Creates and applies a binding to a property.
SetBinding<TSource>(BindableObject, BindableProperty, Expression<Func<TSource,Object>>, BindingMode, IValueConverter, String) SetBinding<TSource>(BindableObject, BindableProperty, Expression<Func<TSource,Object>>, BindingMode, IValueConverter, String)

Creates and applies a binding from an expression.
GetGroup<TView,TItem>(TItem) GetGroup<TView,TItem>(TItem)

For internal use by platform renderers.
GetGroupHeaderContent<TView,TItem>(TItem) GetGroupHeaderContent<TView,TItem>(TItem)

For internal use by platform renderers.
GetIndex<TView,TItem>(TItem) GetIndex<TView,TItem>(TItem)

For internal use by platform renderers.
GetIsGroupHeader<TView,TItem>(TItem) GetIsGroupHeader<TView,TItem>(TItem)

For internal use by platform renderers.
SetIsGroupHeader<TView,TItem>(TItem, Boolean) SetIsGroupHeader<TView,TItem>(TItem, Boolean)

For internal use by platform renderers.
FindByName<T>(Element, String) FindByName<T>(Element, String)

Returns the instance of type T that has name name in the scope that includes element.
FindNextElement(VisualElement, Boolean, IDictionary<Int32,List<VisualElement>>, Int32) FindNextElement(VisualElement, Boolean, IDictionary<Int32,List<VisualElement>>, Int32)

Retrieves the next (or previous if = false) VisualElement within the tab group at [].
GetTabIndexesOnParentPage(VisualElement, Int32) GetTabIndexesOnParentPage(VisualElement, Int32)

Gets a dictionary mapping between index values and lists of VisualElement objects whose IsTabStop value is true.
FadeTo(VisualElement, Double, UInt32, Easing) FadeTo(VisualElement, Double, UInt32, Easing)

Returns a task that performs the fade that is described by the opacity, length, and easing parameters.
LayoutTo(VisualElement, Rectangle, UInt32, Easing) LayoutTo(VisualElement, Rectangle, UInt32, Easing)

Returns a task that eases the bounds of the VisualElement that is specified by the view to the rectangle that is specified by the bounds parameter.
RelRotateTo(VisualElement, Double, UInt32, Easing) RelRotateTo(VisualElement, Double, UInt32, Easing)

Rotates the VisualElement that is specified by view from its current rotation by drotation.
RelScaleTo(VisualElement, Double, UInt32, Easing) RelScaleTo(VisualElement, Double, UInt32, Easing)

Returns a task that scales the VisualElement that is specified by view from its current scale to dscale.
RotateTo(VisualElement, Double, UInt32, Easing) RotateTo(VisualElement, Double, UInt32, Easing)

Returns a task that performs the rotation that is described by the rotation, length, and easing parameters..
RotateXTo(VisualElement, Double, UInt32, Easing) RotateXTo(VisualElement, Double, UInt32, Easing)

Returns a task that skews the Y axis by opacity, taking time length and using easing.
RotateYTo(VisualElement, Double, UInt32, Easing) RotateYTo(VisualElement, Double, UInt32, Easing)

Returns a task that skews the X axis by opacity, taking time length and using easing.
ScaleTo(VisualElement, Double, UInt32, Easing) ScaleTo(VisualElement, Double, UInt32, Easing)

Returns a task that scales the VisualElement that is specified by view to the absolute scale factor scale.
TranslateTo(VisualElement, Double, Double, UInt32, Easing) TranslateTo(VisualElement, Double, Double, UInt32, Easing)

Animates an elements TranslationX and TranslationY properties from their current values to the new values. This ensures that the input layout is in the same position as the visual layout.
HasVisualStateGroups(VisualElement) HasVisualStateGroups(VisualElement)

Returns true if element has one or more visual state groups associated with it. Otherwise, returns false.
LoadFromXaml<TXaml>(TXaml, String) LoadFromXaml<TXaml>(TXaml, String)

Returns an initialized view by loading the specified xaml.
LoadFromXaml<TXaml>(TXaml, Type) LoadFromXaml<TXaml>(TXaml, Type)

Returns a TXaml with the properties that are defined in the application manifest for callingType.

Applies to