Grid Class

Definition

Defines a flexible grid area that consists of columns and rows. Child elements of the Grid are measured and arranged according to their row/column assignments (set by using Grid.Row and Grid.Column attached properties) and other logic.

Equivalent WinUI class: Microsoft.UI.Xaml.Controls.Grid.

/// [Windows.Foundation.Metadata.Composable(Windows.UI.Xaml.Controls.IGridFactory, Windows.Foundation.Metadata.CompositionType.Public, 65536, Windows.Foundation.UniversalApiContract)]
/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Static(Windows.UI.Xaml.Controls.IGridStatics2, 65536, Windows.Foundation.UniversalApiContract)]
/// [Windows.Foundation.Metadata.Static(Windows.UI.Xaml.Controls.IGridStatics, 65536, Windows.Foundation.UniversalApiContract)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
/// [Windows.Foundation.Metadata.WebHostHidden]
class Grid : Panel
/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
/// [Windows.Foundation.Metadata.WebHostHidden]
/// [Windows.Foundation.Metadata.Composable(Windows.UI.Xaml.Controls.IGridFactory, Windows.Foundation.Metadata.CompositionType.Public, 65536, "Windows.Foundation.UniversalApiContract")]
/// [Windows.Foundation.Metadata.Static(Windows.UI.Xaml.Controls.IGridStatics, 65536, "Windows.Foundation.UniversalApiContract")]
/// [Windows.Foundation.Metadata.Static(Windows.UI.Xaml.Controls.IGridStatics2, 65536, "Windows.Foundation.UniversalApiContract")]
class Grid : Panel
/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
/// [Windows.Foundation.Metadata.WebHostHidden]
/// [Windows.Foundation.Metadata.Composable(Windows.UI.Xaml.Controls.IGridFactory, Windows.Foundation.Metadata.CompositionType.Public, 65536, "Windows.Foundation.UniversalApiContract")]
/// [Windows.Foundation.Metadata.Static(Windows.UI.Xaml.Controls.IGridStatics, 65536, "Windows.Foundation.UniversalApiContract")]
/// [Windows.Foundation.Metadata.Static(Windows.UI.Xaml.Controls.IGridStatics2, 65536, "Windows.Foundation.UniversalApiContract")]
/// [Windows.Foundation.Metadata.Static(Windows.UI.Xaml.Controls.IGridStatics3, 327680, "Windows.Foundation.UniversalApiContract")]
class Grid : Panel
/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
/// [Windows.Foundation.Metadata.WebHostHidden]
/// [Windows.Foundation.Metadata.Composable(Windows.UI.Xaml.Controls.IGridFactory, Windows.Foundation.Metadata.CompositionType.Public, 65536, "Windows.Foundation.UniversalApiContract")]
/// [Windows.Foundation.Metadata.Static(Windows.UI.Xaml.Controls.IGridStatics, 65536, "Windows.Foundation.UniversalApiContract")]
/// [Windows.Foundation.Metadata.Static(Windows.UI.Xaml.Controls.IGridStatics2, 65536, "Windows.Foundation.UniversalApiContract")]
/// [Windows.Foundation.Metadata.Static(Windows.UI.Xaml.Controls.IGridStatics3, 327680, "Windows.Foundation.UniversalApiContract")]
/// [Windows.Foundation.Metadata.Static(Windows.UI.Xaml.Controls.IGridStatics4, 458752, "Windows.Foundation.UniversalApiContract")]
class Grid : Panel
[Windows.Foundation.Metadata.Composable(typeof(Windows.UI.Xaml.Controls.IGridFactory), Windows.Foundation.Metadata.CompositionType.Public, 65536, typeof(Windows.Foundation.UniversalApiContract))]
[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Static(typeof(Windows.UI.Xaml.Controls.IGridStatics2), 65536, typeof(Windows.Foundation.UniversalApiContract))]
[Windows.Foundation.Metadata.Static(typeof(Windows.UI.Xaml.Controls.IGridStatics), 65536, typeof(Windows.Foundation.UniversalApiContract))]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
[Windows.Foundation.Metadata.WebHostHidden]
public class Grid : Panel
[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
[Windows.Foundation.Metadata.WebHostHidden]
[Windows.Foundation.Metadata.Composable(typeof(Windows.UI.Xaml.Controls.IGridFactory), Windows.Foundation.Metadata.CompositionType.Public, 65536, "Windows.Foundation.UniversalApiContract")]
[Windows.Foundation.Metadata.Static(typeof(Windows.UI.Xaml.Controls.IGridStatics), 65536, "Windows.Foundation.UniversalApiContract")]
[Windows.Foundation.Metadata.Static(typeof(Windows.UI.Xaml.Controls.IGridStatics2), 65536, "Windows.Foundation.UniversalApiContract")]
public class Grid : Panel
[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
[Windows.Foundation.Metadata.WebHostHidden]
[Windows.Foundation.Metadata.Composable(typeof(Windows.UI.Xaml.Controls.IGridFactory), Windows.Foundation.Metadata.CompositionType.Public, 65536, "Windows.Foundation.UniversalApiContract")]
[Windows.Foundation.Metadata.Static(typeof(Windows.UI.Xaml.Controls.IGridStatics), 65536, "Windows.Foundation.UniversalApiContract")]
[Windows.Foundation.Metadata.Static(typeof(Windows.UI.Xaml.Controls.IGridStatics2), 65536, "Windows.Foundation.UniversalApiContract")]
[Windows.Foundation.Metadata.Static(typeof(Windows.UI.Xaml.Controls.IGridStatics3), 327680, "Windows.Foundation.UniversalApiContract")]
public class Grid : Panel
[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
[Windows.Foundation.Metadata.WebHostHidden]
[Windows.Foundation.Metadata.Composable(typeof(Windows.UI.Xaml.Controls.IGridFactory), Windows.Foundation.Metadata.CompositionType.Public, 65536, "Windows.Foundation.UniversalApiContract")]
[Windows.Foundation.Metadata.Static(typeof(Windows.UI.Xaml.Controls.IGridStatics), 65536, "Windows.Foundation.UniversalApiContract")]
[Windows.Foundation.Metadata.Static(typeof(Windows.UI.Xaml.Controls.IGridStatics2), 65536, "Windows.Foundation.UniversalApiContract")]
[Windows.Foundation.Metadata.Static(typeof(Windows.UI.Xaml.Controls.IGridStatics3), 327680, "Windows.Foundation.UniversalApiContract")]
[Windows.Foundation.Metadata.Static(typeof(Windows.UI.Xaml.Controls.IGridStatics4), 458752, "Windows.Foundation.UniversalApiContract")]
public class Grid : Panel
Public Class Grid
Inherits Panel
<Grid ...>
  oneOrMoreUIElements
</Grid>
-or-
<Grid .../>
Inheritance
Derived
Attributes

Windows 10 requirements

Device family
Windows 10 (introduced in 10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced in v1.0)

Examples

Tip

For more info, design guidance, and code examples, see Layout panels.

If you have the XAML Controls Gallery app installed, click here to open the app and see the Grid in action.

This XAML example shows how to design a layout by using a Grid.

<Grid x:Name="LayoutRoot" Background="#555555" Width="400" Height="300">
    <Grid.ColumnDefinitions>
        <ColumnDefinition Width="250" />
        <ColumnDefinition Width="150" />
    </Grid.ColumnDefinitions>
    <Grid.RowDefinitions>
        <RowDefinition Height="Auto" />
        <RowDefinition Height="2*" />
        <RowDefinition Height="*"/>
    </Grid.RowDefinitions>
    <TextBlock Grid.Row="0" Grid.Column="0" Grid.ColumnSpan="2" 
               Margin="10" FontWeight="Bold" 
               Text="Contoso Corporation" HorizontalAlignment="Center" VerticalAlignment="Center" />
    <Grid x:Name="FormLayoutGrid" Grid.Row="1" Grid.Column="0">
        <Grid.ColumnDefinitions>
            <ColumnDefinition Width="Auto" />
            <ColumnDefinition />
        </Grid.ColumnDefinitions>
        <Grid.RowDefinitions>
            <RowDefinition Height="*" />
            <RowDefinition Height="*" />
            <RowDefinition Height="*" />
        </Grid.RowDefinitions>
        <TextBlock Grid.Row="0" Grid.Column="0" Text="First Name" Margin="10" 
                   HorizontalAlignment="Left" VerticalAlignment="Center" />
        <TextBox Grid.Row="0" Grid.Column="1" Margin="10" />
        <TextBlock Grid.Row="1" Grid.Column="0" Text="Last Name" Margin="10" 
                   HorizontalAlignment="Left" VerticalAlignment="Center" />
        <TextBox Grid.Row="1" Grid.Column="1" Margin="10" />
        <TextBlock Grid.Row="2" Grid.Column="0" Text="Address" Margin="10" 
                   HorizontalAlignment="Left" VerticalAlignment="Center" />
        <TextBox Grid.Row="2" Grid.Column="1" Margin="10" />
      
    </Grid>
 </Grid>
    public Page()
    {
        InitializeComponent();
        LayoutDesign();
    }

    private void LayoutDesign()
    {
        //Create Stackpanel for ListBox Control and its description
        StackPanel DeptStackPanel = new StackPanel();
        DeptStackPanel.Margin = new Thickness(10);

        LayoutRoot.Children.Add(DeptStackPanel);
        Grid.SetColumn(DeptStackPanel, 1);
        Grid.SetRow(DeptStackPanel, 1);

        TextBlock DeptListHeading = new TextBlock();
        DeptListHeading.Text = "Department";

        ListBox DeptList = new ListBox();
        DeptList.Items.Add("Finance");
        DeptList.Items.Add("Marketing");
        DeptList.Items.Add("Human Resources");
        DeptList.Items.Add("Payroll");

        DeptStackPanel.Children.Add(DeptListHeading);
        DeptStackPanel.Children.Add(DeptList);

        //Create StackPanel for buttons
        StackPanel ButtonsStackPanel = new StackPanel();
        ButtonsStackPanel.Margin = new Thickness(10);
        ButtonsStackPanel.Orientation = Orientation.Horizontal;
        ButtonsStackPanel.HorizontalAlignment = HorizontalAlignment.Center;

        LayoutRoot.Children.Add(ButtonsStackPanel);
        Grid.SetColumn(ButtonsStackPanel, 0);
        Grid.SetRow(ButtonsStackPanel, 2);
        Grid.SetColumnSpan(ButtonsStackPanel, 2);

        Button BackButton = new Button();
        BackButton.Content = "Back";
        BackButton.Width = 100;

        Button CancelButton = new Button();
        CancelButton.Content = "Cancel";
        CancelButton.Width = 100;

        Button NextButton = new Button();
        NextButton.Content = "Next";
        NextButton.Width = 100;

        ButtonsStackPanel.Children.Add(BackButton);
        ButtonsStackPanel.Children.Add(CancelButton);
        ButtonsStackPanel.Children.Add(NextButton);

        BackButton.Margin = new Thickness(10);
        CancelButton.Margin = new Thickness(10);
        NextButton.Margin = new Thickness(10);
    }
}
Partial Public Class Page
    Inherits UserControl

    Public Sub New()
        InitializeComponent()
        LayoutDesign()
    End Sub

    Private Sub LayoutDesign()
        'Create Stackpanel for ListBox Control and its description 
        Dim DeptStackPanel As New StackPanel()
        DeptStackPanel.Margin = New Thickness(10)

        LayoutRoot.Children.Add(DeptStackPanel)
        Grid.SetColumn(DeptStackPanel, 1)
        Grid.SetRow(DeptStackPanel, 1)

        Dim DeptListHeading As New TextBlock()
        DeptListHeading.Text = "Department"

        Dim DeptList As New ListBox()
        DeptList.Items.Add("Finance")
        DeptList.Items.Add("Marketing")
        DeptList.Items.Add("Human Resources")
        DeptList.Items.Add("Payroll")

        DeptStackPanel.Children.Add(DeptListHeading)
        DeptStackPanel.Children.Add(DeptList)

        'Create StackPanel for buttons 
        Dim ButtonsStackPanel As New StackPanel()
        ButtonsStackPanel.Margin = New Thickness(10)
        ButtonsStackPanel.Orientation = Orientation.Horizontal
        ButtonsStackPanel.HorizontalAlignment = HorizontalAlignment.Center

        LayoutRoot.Children.Add(ButtonsStackPanel)
        Grid.SetColumn(ButtonsStackPanel, 0)
        Grid.SetRow(ButtonsStackPanel, 2)
        Grid.SetColumnSpan(ButtonsStackPanel, 2)

        Dim BackButton As New Button()
        BackButton.Content = "Back"
        BackButton.Height = 30
        BackButton.Width = 100

        Dim CancelButton As New Button()
        CancelButton.Content = "Cancel"
        CancelButton.Height = 30
        CancelButton.Width = 100

        Dim NextButton As New Button()
        NextButton.Content = "Next"
        NextButton.Height = 30
        NextButton.Width = 100

        ButtonsStackPanel.Children.Add(BackButton)
        ButtonsStackPanel.Children.Add(CancelButton)
        ButtonsStackPanel.Children.Add(NextButton)

        BackButton.Margin = New Thickness(10)
        CancelButton.Margin = New Thickness(10)
        NextButton.Margin = New Thickness(10)
    End Sub
End Class

Remarks

Tip

For more info, design guidance, and code examples, see Layout panels.

Grid is a layout panel that supports arranging child elements in rows and columns.

Grid layout panel

You typically define layout behavior for a Grid in XAML by providing one or more RowDefinition elements as the value of Grid.RowDefinitions, and one or more ColumnDefinition elements as the value of Grid.ColumnDefinitions. Then, you apply the Grid.Row and Grid.Column attached properties to each of the element children of the Grid, to indicate which row/column combination is used to position that element within the parent Grid.

To set the height of rows and the width of columns, you set RowDefinition.Height for each RowDefinition and ColumnDefinition.Width for each ColumnDefinition. By default, each row or column divides layout space equally. You can change this behavior either by providing absolute pixel values, or a Star sizing that divides available space using a weighted factor. For more info on how to use Star sizing in a Grid, see Define layouts with XAML or GridLength. You also can use an Auto sizing that sizes to content.

To indicate that an element child should span multiple rows or multiple columns in the Grid, you can apply the Grid.RowSpan or Grid.ColumnSpan attached properties to child elements of a Grid.

By default, a Grid contains one row and one column.

Setting the Margin property on the child elements in a Grid sets the distance between the element and its grid cell boundaries. The HorizontalAlignment and VerticalAlignment properties describe how the child element should be positioned within the grid cell. You can precisely position child elements of a Grid by using a combination of the Margin property and alignment properties. If you need even more control over the layout of individual child elements, consider using VariableSizedWrapGrid.

WrapGrid is another similar layout panel that has the benefit of better handling for content that's too wide, which might be clipped by a regular Grid depending on values of other layout properties.

An element in the first column that spans multiple rows can affect the height of each spanned row even if the first row has enough height to accommodate the element, and subsequent spanned rows would otherwise have a height of 0. For example, the second row in this Grid has its height set to 0, so the blue rectangle would not typically be visible. In this case, you might expect that the red ellipse would not affect the second row because the first row is tall enough to contain the ellipse. However, the Grid calculates the MinHeight of each row to be enough to accommodate the red ellipse, and then spans the element across the rows. As a result, the second row is given a MinHeight of 50, the red ellipse is centered in the 150px span, and half of the blue rectangle is visible in the second row.

Note

(This example uses an element that spans columns, but also applies to an element in the first column that spans multiple rows.)

<Grid Background="Yellow" Width="300">
    <Grid.ColumnDefinitions>
        <ColumnDefinition Width="50"/>
        <ColumnDefinition Width="*"/>
    </Grid.ColumnDefinitions>
    <Grid.RowDefinitions>
        <RowDefinition Height="Auto"/>
        <RowDefinition Height="0"/>
    </Grid.RowDefinitions>
    <Ellipse   Grid.Row="0" Grid.Column="0"  Height="50" Fill="Red" Grid.RowSpan="2"/>
    <Rectangle Grid.Row="0" Grid.Column="1" Fill="Green" Height="100"/>
    <Rectangle Grid.Row="1" Grid.Column="1" Fill="Blue" Height="100"/>
</Grid>

Border properties

Grid defines border properties that let you draw a border around the Grid without using an additional Border element. The properties are Grid.BorderBrush, Grid.BorderThickness, Grid.CornerRadius, and Grid.Padding.

<Grid BorderBrush="Red" BorderThickness="2" CornerRadius="10" Padding="12">
    <TextBlock Text="Hello World!"/>
</Grid>

Grid derived classes

Grid is the parent class for SwapChainPanel and SwapChainBackgroundPanel.

XAML attached properties

Grid is the host service class for several XAML attached properties. These attached properties enable child elements to report how they should be positioned in their Grid parent.

In order to support XAML processor access to the attached properties, and also to expose equivalent get and set operations to code, each XAML attached property has a pair of Get and Set accessor methods. Another way to get or set the value in code is to use the dependency property system, calling either GetValue or SetValue and passing the identifier field as the dependency property identifier.

Attached property Description
Column Gets or sets the column alignment of an element when child layout is processed by a parent Grid layout container.The value is the zero-based index of the Grid column that the element should appear within. Negative values are not permitted.
ColumnSpan Gets or sets a value that indicates the total number of columns that the element content spans within a parent Grid. Zero or negative integer values are not permitted. Values that are greater than the total number of columns are treated as if they specified the total number and will span all columns.
Row Gets or sets the row alignment of an element when child layout is processed by a parent Grid layout container.The value is the zero-based index of the Grid row that the element should appear within. Negative values are not permitted.
RowSpan Gets or sets a value that indicates the total number of rows that the element content spans within a parent Grid. Zero or negative integer values are not permitted. Values that are greater than the total number of rows are treated as if they specified the total number and will span all rows.

Version history

Windows version SDK version Value added
1709 16299 ColumnSpacing
1709 16299 RowSpacing
1809 17763 BackgroundSizing

Constructors

Grid()

Initializes a new instance of the Grid class.

Equivalent WinUI constructor: Microsoft.UI.Xaml.Controls.Grid.Grid.

Properties

AccessKey

Gets or sets the access key (mnemonic) for this element.

Equivalent WinUI property: Microsoft.UI.Xaml.UIElement.AccessKey.

(Inherited from UIElement)
AccessKeyScopeOwner

Gets or sets a source element that provides the access key scope for this element, even if it's not in the visual tree of the source element.

Equivalent WinUI property: Microsoft.UI.Xaml.UIElement.AccessKeyScopeOwner.

(Inherited from UIElement)
ActualHeight

Gets the rendered height of a FrameworkElement. See Remarks.

Equivalent WinUI property: Microsoft.UI.Xaml.FrameworkElement.ActualHeight.

(Inherited from FrameworkElement)
ActualOffset

Gets the position of this UIElement, relative to its parent, computed during the arrange pass of the layout process.

Equivalent WinUI property: Microsoft.UI.Xaml.UIElement.ActualOffset.

(Inherited from UIElement)
ActualSize

Gets the size that this UIElement computed during the arrange pass of the layout process.

Equivalent WinUI property: Microsoft.UI.Xaml.UIElement.ActualSize.

(Inherited from UIElement)
ActualTheme

Gets the UI theme that is currently used by the element, which might be different than the RequestedTheme.

Equivalent WinUI property: Microsoft.UI.Xaml.FrameworkElement.ActualTheme.

(Inherited from FrameworkElement)
ActualWidth

Gets the rendered width of a FrameworkElement. See Remarks.

Equivalent WinUI property: Microsoft.UI.Xaml.FrameworkElement.ActualWidth.

(Inherited from FrameworkElement)
AllowDrop

Gets or sets a value that determines whether this UIElement can be a drop target for purposes of drag-and-drop operations.

Equivalent WinUI property: Microsoft.UI.Xaml.UIElement.AllowDrop.

(Inherited from UIElement)
AllowFocusOnInteraction

Gets or sets a value that indicates whether the element automatically gets focus when the user interacts with it.

Equivalent WinUI property: Microsoft.UI.Xaml.FrameworkElement.AllowFocusOnInteraction.

(Inherited from FrameworkElement)
AllowFocusWhenDisabled

Gets or sets whether a disabled control can receive focus.

Equivalent WinUI property: Microsoft.UI.Xaml.FrameworkElement.AllowFocusWhenDisabled.

(Inherited from FrameworkElement)
Background

Gets or sets a Brush that fills the panel content area.

Equivalent WinUI property: Microsoft.UI.Xaml.Controls.Panel.Background.

(Inherited from Panel)
BackgroundSizing

Gets or sets a value that indicates how far the background extends in relation to this element's border.

Equivalent WinUI property: Microsoft.UI.Xaml.Controls.Grid.BackgroundSizing.

BackgroundSizingProperty

Identifies the BackgroundSizing dependency property.

Equivalent WinUI property: Microsoft.UI.Xaml.Controls.Grid.BackgroundSizingProperty.

BackgroundTransition

Gets or sets an instance of BrushTransition to automatically animate changes to the Background property.

Equivalent WinUI property: Microsoft.UI.Xaml.Controls.Panel.BackgroundTransition.

(Inherited from Panel)
BaseUri

Gets a Uniform Resource Identifier (URI) that represents the base Uniform Resource Identifier (URI) for an XAML-constructed object at XAML load time. This property is useful for Uniform Resource Identifier (URI) resolution at run time.

Equivalent WinUI property: Microsoft.UI.Xaml.FrameworkElement.BaseUri.

(Inherited from FrameworkElement)
BorderBrush

Gets or sets a brush that describes the border fill of the panel.

Equivalent WinUI property: Microsoft.UI.Xaml.Controls.Grid.BorderBrush.

BorderBrushProperty

Identifies the BorderBrush dependency property.

Equivalent WinUI property: Microsoft.UI.Xaml.Controls.Grid.BorderBrushProperty.

BorderThickness

Gets or sets the border thickness of the panel.

Equivalent WinUI property: Microsoft.UI.Xaml.Controls.Grid.BorderThickness.

BorderThicknessProperty

Identifies the BorderThickness dependency property.

Equivalent WinUI property: Microsoft.UI.Xaml.Controls.Grid.BorderThicknessProperty.

CacheMode

Gets or sets a value that indicates that rendered content should be cached as a composited bitmap when possible.

Equivalent WinUI property: Microsoft.UI.Xaml.UIElement.CacheMode.

(Inherited from UIElement)
CanBeScrollAnchor

Gets or sets a value that indicates whether the UIElement can be a candidate for scroll anchoring.

Equivalent WinUI property: Microsoft.UI.Xaml.UIElement.CanBeScrollAnchor.

(Inherited from UIElement)
CanDrag

Gets or sets a value that indicates whether the element can be dragged as data in a drag-and-drop operation.

Equivalent WinUI property: Microsoft.UI.Xaml.UIElement.CanDrag.

(Inherited from UIElement)
CenterPoint

Gets or sets the center point of the element, which is the point about which rotation or scaling occurs. Affects the rendering position of the element.

Equivalent WinUI property: Microsoft.UI.Xaml.UIElement.CenterPoint.

(Inherited from UIElement)
Children

Gets the collection of child elements of the panel.

Equivalent WinUI property: Microsoft.UI.Xaml.Controls.Panel.Children.

(Inherited from Panel)
ChildrenTransitions

Gets or sets the collection of Transition style elements that apply to child content of a Panel subclass.

Equivalent WinUI property: Microsoft.UI.Xaml.Controls.Panel.ChildrenTransitions.

(Inherited from Panel)
Clip

Gets or sets the RectangleGeometry used to define the outline of the contents of a UIElement.

Equivalent WinUI property: Microsoft.UI.Xaml.UIElement.Clip.

(Inherited from UIElement)
ColumnDefinitions

Gets a list of ColumnDefinition objects defined on this instance of Grid.

Equivalent WinUI property: Microsoft.UI.Xaml.Controls.Grid.ColumnDefinitions.

ColumnProperty

Identifies the Grid.Column XAML attached property.

Equivalent WinUI property: Microsoft.UI.Xaml.Controls.Grid.ColumnProperty.

ColumnSpacing

Gets or sets the uniform distance (in pixels) between grid columns.

Equivalent WinUI property: Microsoft.UI.Xaml.Controls.Grid.ColumnSpacing.

ColumnSpacingProperty

Identifies the ColumnSpacing dependency property.

Equivalent WinUI property: Microsoft.UI.Xaml.Controls.Grid.ColumnSpacingProperty.

ColumnSpanProperty

Identifies the Grid.ColumnSpan XAML attached property.

Equivalent WinUI property: Microsoft.UI.Xaml.Controls.Grid.ColumnSpanProperty.

CompositeMode

Gets or sets a property that declares alternate composition and blending modes for the element in its parent layout and window. This is relevant for elements that are involved in a mixed XAML / Microsoft DirectX UI.

Equivalent WinUI property: Microsoft.UI.Xaml.UIElement.CompositeMode.

(Inherited from UIElement)
ContextFlyout

Gets or sets the flyout associated with this element.

Equivalent WinUI property: Microsoft.UI.Xaml.UIElement.ContextFlyout.

(Inherited from UIElement)
CornerRadius

Gets or sets the radius for the corners of the panel's border.

Equivalent WinUI property: Microsoft.UI.Xaml.Controls.Grid.CornerRadius.

CornerRadiusProperty

Identifies the CornerRadius dependency property.

Equivalent WinUI property: Microsoft.UI.Xaml.Controls.Grid.CornerRadiusProperty.

DataContext

Gets or sets the data context for a FrameworkElement. A common use of a data context is when a FrameworkElement uses the {Binding} markup extension and participates in data binding.

Equivalent WinUI property: Microsoft.UI.Xaml.FrameworkElement.DataContext.

(Inherited from FrameworkElement)
DesiredSize

Gets the size that this UIElement computed during the measure pass of the layout process.

Equivalent WinUI property: Microsoft.UI.Xaml.UIElement.DesiredSize.

(Inherited from UIElement)
Dispatcher

Gets the CoreDispatcher that this object is associated with. The CoreDispatcher represents a facility that can access the DependencyObject on the UI thread even if the code is initiated by a non-UI thread.

Equivalent WinUI property: Microsoft.UI.Xaml.DependencyObject.Dispatcher.

(Inherited from DependencyObject)
ExitDisplayModeOnAccessKeyInvoked

Gets or sets a value that specifies whether the access key display is dismissed when an access key is invoked.

Equivalent WinUI property: Microsoft.UI.Xaml.UIElement.ExitDisplayModeOnAccessKeyInvoked.

(Inherited from UIElement)
FlowDirection

Gets or sets the direction in which text and other UI elements flow within any parent element that controls their layout. This property can be set to either LeftToRight or RightToLeft. Setting FlowDirection to RightToLeft on any element sets the alignment to the right, the reading order to right-to-left and the layout of the control to flow from right to left.

Equivalent WinUI property: Microsoft.UI.Xaml.FrameworkElement.FlowDirection.

(Inherited from FrameworkElement)
FocusVisualMargin

Gets or sets the outer margin of the focus visual for a FrameworkElement.

Equivalent WinUI property: Microsoft.UI.Xaml.FrameworkElement.FocusVisualMargin.

(Inherited from FrameworkElement)
FocusVisualPrimaryBrush

Gets or sets the brush used to draw the outer border of a HighVisibility or Reveal focus visual for a FrameworkElement.

Equivalent WinUI property: Microsoft.UI.Xaml.FrameworkElement.FocusVisualPrimaryBrush.

(Inherited from FrameworkElement)
FocusVisualPrimaryThickness

Gets or sets the thickness of the outer border of a HighVisibility or Reveal focus visual for a FrameworkElement.

Equivalent WinUI property: Microsoft.UI.Xaml.FrameworkElement.FocusVisualPrimaryThickness.

(Inherited from FrameworkElement)
FocusVisualSecondaryBrush

Gets or sets the brush used to draw the inner border of a HighVisibility or Reveal focus visual for a FrameworkElement.

Equivalent WinUI property: Microsoft.UI.Xaml.FrameworkElement.FocusVisualSecondaryBrush.

(Inherited from FrameworkElement)
FocusVisualSecondaryThickness

Gets or sets the thickness of the inner border of a HighVisibility or Reveal focus visual for a FrameworkElement.

Equivalent WinUI property: Microsoft.UI.Xaml.FrameworkElement.FocusVisualSecondaryThickness.

(Inherited from FrameworkElement)
Height

Gets or sets the suggested height of a FrameworkElement.

Equivalent WinUI property: Microsoft.UI.Xaml.FrameworkElement.Height.

(Inherited from FrameworkElement)
HighContrastAdjustment

Gets or sets a value that indicates whether the framework automatically adjusts the element's visual properties when high contrast themes are enabled.

Equivalent WinUI property: Microsoft.UI.Xaml.UIElement.HighContrastAdjustment.

(Inherited from UIElement)
HorizontalAlignment

Gets or sets the horizontal alignment characteristics that are applied to a FrameworkElement when it is composed in a layout parent, such as a panel or items control.

Equivalent WinUI property: Microsoft.UI.Xaml.FrameworkElement.HorizontalAlignment.

(Inherited from FrameworkElement)
IsAccessKeyScope

Gets or sets a value that indicates whether an element defines its own access key scope.

Equivalent WinUI property: Microsoft.UI.Xaml.UIElement.IsAccessKeyScope.

(Inherited from UIElement)
IsDoubleTapEnabled

Gets or sets a value that determines whether the DoubleTapped event can originate from that element.

Equivalent WinUI property: Microsoft.UI.Xaml.UIElement.IsDoubleTapEnabled.

(Inherited from UIElement)
IsHitTestVisible

Gets or sets whether the contained area of this UIElement can return true values for hit testing.

Equivalent WinUI property: Microsoft.UI.Xaml.UIElement.IsHitTestVisible.

(Inherited from UIElement)
IsHoldingEnabled

Gets or sets a value that determines whether the Holding event can originate from that element.

Equivalent WinUI property: Microsoft.UI.Xaml.UIElement.IsHoldingEnabled.

(Inherited from UIElement)
IsItemsHost

Gets a value that indicates whether this Panel is a container for UI items that are generated by an ItemsControl.

Equivalent WinUI property: Microsoft.UI.Xaml.Controls.Panel.IsItemsHost.

(Inherited from Panel)
IsLoaded

Gets a value that indicates whether the element has been added to the element tree and is ready for interaction.

Equivalent WinUI property: Microsoft.UI.Xaml.FrameworkElement.IsLoaded.

(Inherited from FrameworkElement)
IsRightTapEnabled

Gets or sets a value that determines whether the RightTapped event can originate from that element.

Equivalent WinUI property: Microsoft.UI.Xaml.UIElement.IsRightTapEnabled.

(Inherited from UIElement)
IsTapEnabled

Gets or sets a value that determines whether the Tapped event can originate from that element.

Equivalent WinUI property: Microsoft.UI.Xaml.UIElement.IsTapEnabled.

(Inherited from UIElement)
KeyboardAcceleratorPlacementMode

Gets or sets a value that indicates whether the control tooltip displays the key combination for it's associated keyboard accelerator.

Equivalent WinUI property: Microsoft.UI.Xaml.UIElement.KeyboardAcceleratorPlacementMode.

(Inherited from UIElement)
KeyboardAcceleratorPlacementTarget

Gets or sets a value that indicates the control tooltip that displays the accelerator key combination.

Equivalent WinUI property: Microsoft.UI.Xaml.UIElement.KeyboardAcceleratorPlacementTarget.

(Inherited from UIElement)
KeyboardAccelerators

Gets the collection of key combinations that invoke an action using the keyboard.

Accelerators are typically assigned to buttons or menu items.

Example of a menu showing keyboard accelerators for various menu items
Example of a menu showing keyboard accelerators for various menu items

Equivalent WinUI property: Microsoft.UI.Xaml.UIElement.KeyboardAccelerators.

(Inherited from UIElement)
KeyTipHorizontalOffset

Gets or sets a value that indicates how far left or right the Key Tip is placed in relation to the UIElement.

Equivalent WinUI property: Microsoft.UI.Xaml.UIElement.KeyTipHorizontalOffset.

(Inherited from UIElement)
KeyTipPlacementMode

Gets or sets a value that indicates where the access key Key Tip is placed in relation to the boundary of the UIElement.

Equivalent WinUI property: Microsoft.UI.Xaml.UIElement.KeyTipPlacementMode.

(Inherited from UIElement)
KeyTipTarget

Gets or sets a value that indicates the element targeted by the access key Key Tip.

Equivalent WinUI property: Microsoft.UI.Xaml.UIElement.KeyTipTarget.

(Inherited from UIElement)
KeyTipVerticalOffset

Gets or sets a value that indicates how far up or down the Key Tip is placed in relation to the UI element.

Equivalent WinUI property: Microsoft.UI.Xaml.UIElement.KeyTipVerticalOffset.

(Inherited from UIElement)
Language

Gets or sets localization/globalization language information that applies to a FrameworkElement, and also to all child elements of the current FrameworkElement in the object representation and in UI.

Equivalent WinUI property: Microsoft.UI.Xaml.FrameworkElement.Language.

(Inherited from FrameworkElement)
Lights

Gets the collection of XamlLight objects attached to this element.

Equivalent WinUI property: Microsoft.UI.Xaml.UIElement.Lights.

(Inherited from UIElement)
ManipulationMode

Gets or sets the ManipulationModes value used for UIElement behavior and interaction with gestures. Setting this value enables handling the manipulation events from this element in app code.

Equivalent WinUI property: Microsoft.UI.Xaml.UIElement.ManipulationMode.

(Inherited from UIElement)
Margin

Gets or sets the outer margin of a FrameworkElement.

Equivalent WinUI property: Microsoft.UI.Xaml.FrameworkElement.Margin.

(Inherited from FrameworkElement)
MaxHeight

Gets or sets the maximum height constraint of a FrameworkElement.

Equivalent WinUI property: Microsoft.UI.Xaml.FrameworkElement.MaxHeight.

(Inherited from FrameworkElement)
MaxWidth

Gets or sets the maximum width constraint of a FrameworkElement.

Equivalent WinUI property: Microsoft.UI.Xaml.FrameworkElement.MaxWidth.

(Inherited from FrameworkElement)
MinHeight

Gets or sets the minimum height constraint of a FrameworkElement.

Equivalent WinUI property: Microsoft.UI.Xaml.FrameworkElement.MinHeight.

(Inherited from FrameworkElement)
MinWidth

Gets or sets the minimum width constraint of a FrameworkElement.

Equivalent WinUI property: Microsoft.UI.Xaml.FrameworkElement.MinWidth.

(Inherited from FrameworkElement)
Name

Gets or sets the identifying name of the object. When a XAML processor creates the object tree from XAML markup, run-time code can refer to the XAML-declared object by this name.

Equivalent WinUI property: Microsoft.UI.Xaml.FrameworkElement.Name.

(Inherited from FrameworkElement)
Opacity

Gets or sets the degree of the object's opacity.

Equivalent WinUI property: Microsoft.UI.Xaml.UIElement.Opacity.

(Inherited from UIElement)
OpacityTransition

Gets or sets the ScalarTransition that animates changes to the Opacity property.

Equivalent WinUI property: Microsoft.UI.Xaml.UIElement.OpacityTransition.

(Inherited from UIElement)
Padding

Gets or sets the distance between the border and its child object.

Equivalent WinUI property: Microsoft.UI.Xaml.Controls.Grid.Padding.

PaddingProperty

Identifies the Padding dependency property.

Equivalent WinUI property: Microsoft.UI.Xaml.Controls.Grid.PaddingProperty.

Parent

Gets the parent object of this FrameworkElement in the object tree.

Equivalent WinUI property: Microsoft.UI.Xaml.FrameworkElement.Parent.

(Inherited from FrameworkElement)
PointerCaptures

Gets the set of all captured pointers, represented as Pointer values.

Equivalent WinUI property: Microsoft.UI.Xaml.UIElement.PointerCaptures.

(Inherited from UIElement)
Projection

Gets or sets the perspective projection (3-D effect) to apply when rendering this element.

Equivalent WinUI property: Microsoft.UI.Xaml.UIElement.Projection.

(Inherited from UIElement)
RenderSize

Gets the final render size of a UIElement. Use is not recommended, see Remarks.

Equivalent WinUI property: Microsoft.UI.Xaml.UIElement.RenderSize.

(Inherited from UIElement)
RenderTransform

Gets or sets transform information that affects the rendering position of a UIElement.

Equivalent WinUI property: Microsoft.UI.Xaml.UIElement.RenderTransform.

(Inherited from UIElement)
RenderTransformOrigin

Gets or sets the origin point of any possible render transform declared by RenderTransform, relative to the bounds of the UIElement.

Equivalent WinUI property: Microsoft.UI.Xaml.UIElement.RenderTransformOrigin.

(Inherited from UIElement)
RequestedTheme

Gets or sets the UI theme that is used by the UIElement (and its child elements) for resource determination. The UI theme you specify with RequestedTheme can override the app-level RequestedTheme.

Equivalent WinUI property: Microsoft.UI.Xaml.FrameworkElement.RequestedTheme.

(Inherited from FrameworkElement)
Resources

Gets the locally defined resource dictionary. In XAML, you can establish resource items as child object elements of a frameworkElement.Resources property element, through XAML implicit collection syntax.

Equivalent WinUI property: Microsoft.UI.Xaml.FrameworkElement.Resources.

(Inherited from FrameworkElement)
Rotation

Gets or sets the angle of clockwise rotation, in degrees. Rotates relative to the RotationAxis and the CenterPoint. Affects the rendering position of the element.

Equivalent WinUI property: Microsoft.UI.Xaml.UIElement.Rotation.

(Inherited from UIElement)
RotationAxis

Gets or sets the axis to rotate the element around.

Equivalent WinUI property: Microsoft.UI.Xaml.UIElement.RotationAxis.

(Inherited from UIElement)
RotationTransition

Gets or sets the ScalarTransition that animates changes to the Rotation property.

Equivalent WinUI property: Microsoft.UI.Xaml.UIElement.RotationTransition.

(Inherited from UIElement)
RowDefinitions

Gets a list of RowDefinition objects defined on this instance of Grid.

Equivalent WinUI property: Microsoft.UI.Xaml.Controls.Grid.RowDefinitions.

RowProperty

Identifies the Grid.Row XAML attached property.

Equivalent WinUI property: Microsoft.UI.Xaml.Controls.Grid.RowProperty.

RowSpacing

Gets or sets the uniform distance (in pixels) between grid rows.

Equivalent WinUI property: Microsoft.UI.Xaml.Controls.Grid.RowSpacing.

RowSpacingProperty

Identifies the RowSpacing dependency property.

Equivalent WinUI property: Microsoft.UI.Xaml.Controls.Grid.RowSpacingProperty.

RowSpanProperty

Identifies the Grid.RowSpan XAML attached property.

Equivalent WinUI property: Microsoft.UI.Xaml.Controls.Grid.RowSpanProperty.

Scale

Gets or sets the scale of the element. Scales relative to the element's CenterPoint. Affects the rendering position of the element.

Equivalent WinUI property: Microsoft.UI.Xaml.UIElement.Scale.

(Inherited from UIElement)
ScaleTransition

Gets or sets the Vector3Transition that animates changes to the Scale property.

Equivalent WinUI property: Microsoft.UI.Xaml.UIElement.ScaleTransition.

(Inherited from UIElement)
Shadow

Gets or sets the shadow effect cast by the element.

Equivalent WinUI property: Microsoft.UI.Xaml.UIElement.Shadow.

(Inherited from UIElement)
Style

Gets or sets an instance Style that is applied for this object during layout and rendering.

Equivalent WinUI property: Microsoft.UI.Xaml.FrameworkElement.Style.

(Inherited from FrameworkElement)
TabFocusNavigation

Gets or sets a value that modifies how tabbing and TabIndex work for this control.

Equivalent WinUI property: Microsoft.UI.Xaml.UIElement.TabFocusNavigation.

(Inherited from UIElement)
Tag

Gets or sets an arbitrary object value that can be used to store custom information about this object.

Equivalent WinUI property: Microsoft.UI.Xaml.FrameworkElement.Tag.

(Inherited from FrameworkElement)
Transform3D

Gets or sets the 3-D transform effect to apply when rendering this element.

Equivalent WinUI property: Microsoft.UI.Xaml.UIElement.Transform3D.

(Inherited from UIElement)
TransformMatrix

Gets or sets the transformation matrix to apply to the element.

Equivalent WinUI property: Microsoft.UI.Xaml.UIElement.TransformMatrix.

(Inherited from UIElement)
Transitions

Gets or sets the collection of Transition style elements that apply to a UIElement.

Equivalent WinUI property: Microsoft.UI.Xaml.UIElement.Transitions.

(Inherited from UIElement)
Translation

Gets or sets the x, y, and z rendering position of the element.

Equivalent WinUI property: Microsoft.UI.Xaml.UIElement.Translation.

(Inherited from UIElement)
TranslationTransition

Gets or sets the Vector3Transition that animates changes to the Translation property.

Equivalent WinUI property: Microsoft.UI.Xaml.UIElement.TranslationTransition.

(Inherited from UIElement)
Triggers

Gets the collection of triggers for animations that are defined for a FrameworkElement. Not commonly used. See Remarks.

Equivalent WinUI property: Microsoft.UI.Xaml.FrameworkElement.Triggers.

(Inherited from FrameworkElement)
UIContext

Gets the context identifier for the element.

(Inherited from UIElement)
UseLayoutRounding

Gets or sets a value that determines whether rendering for the object and its visual subtree should use rounding behavior that aligns rendering to whole pixels.

Equivalent WinUI property: Microsoft.UI.Xaml.UIElement.UseLayoutRounding.

(Inherited from UIElement)
VerticalAlignment

Gets or sets the vertical alignment characteristics that are applied to a FrameworkElement when it is composed in a parent object such as a panel or items control.

Equivalent WinUI property: Microsoft.UI.Xaml.FrameworkElement.VerticalAlignment.

(Inherited from FrameworkElement)
Visibility

Gets or sets the visibility of a UIElement. A UIElement that is not visible is not rendered and does not communicate its desired size to layout.

Equivalent WinUI property: Microsoft.UI.Xaml.UIElement.Visibility.

(Inherited from UIElement)
Width

Gets or sets the width of a FrameworkElement.

Equivalent WinUI property: Microsoft.UI.Xaml.FrameworkElement.Width.

(Inherited from FrameworkElement)
XamlRoot

Gets or sets the XamlRoot in which this element is being viewed.

Equivalent WinUI property: Microsoft.UI.Xaml.UIElement.XamlRoot.

(Inherited from UIElement)
XYFocusDownNavigationStrategy

Gets or sets a value that specifies the strategy used to determine the target element of a down navigation.

Equivalent WinUI property: Microsoft.UI.Xaml.UIElement.XYFocusDownNavigationStrategy.

(Inherited from UIElement)
XYFocusKeyboardNavigation

Gets or sets a value that enables or disables navigation using the keyboard directional arrows.

Equivalent WinUI property: Microsoft.UI.Xaml.UIElement.XYFocusKeyboardNavigation.

(Inherited from UIElement)
XYFocusLeftNavigationStrategy

Gets or sets a value that specifies the strategy used to determine the target element of a left navigation.

Equivalent WinUI property: Microsoft.UI.Xaml.UIElement.XYFocusLeftNavigationStrategy.

(Inherited from UIElement)
XYFocusRightNavigationStrategy

Gets or sets a value that specifies the strategy used to determine the target element of a right navigation.

Equivalent WinUI property: Microsoft.UI.Xaml.UIElement.XYFocusRightNavigationStrategy.

(Inherited from UIElement)
XYFocusUpNavigationStrategy

Gets or sets a value that specifies the strategy used to determine the target element of an up navigation.

Equivalent WinUI property: Microsoft.UI.Xaml.UIElement.XYFocusUpNavigationStrategy.

(Inherited from UIElement)

Attached Properties

Column
ColumnSpan
Row
RowSpan

Methods

AddHandler(RoutedEvent, Object, Boolean)

Adds a routed event handler for a specified routed event, adding the handler to the handler collection on the current element. Specify handledEventsToo as true to have the provided handler be invoked even if the event is handled elsewhere.

Equivalent WinUI method: Microsoft.UI.Xaml.UIElement.AddHandler.

(Inherited from UIElement)
Arrange(Rect)

Positions child objects and determines a size for a UIElement. Parent objects that implement custom layout for their child elements should call this method from their layout override implementations to form a recursive layout update.

Equivalent WinUI method: Microsoft.UI.Xaml.UIElement.Arrange.

(Inherited from UIElement)
ArrangeOverride(Size)

Provides the behavior for the "Arrange" pass of layout. Classes can override this method to define their own "Arrange" pass behavior.

Equivalent WinUI method: Microsoft.UI.Xaml.FrameworkElement.ArrangeOverride.

(Inherited from FrameworkElement)
CancelDirectManipulations()

Cancels ongoing direct manipulation processing (system-defined panning/zooming) on any ScrollViewer parent that contains the current UIElement.

Equivalent WinUI method: Microsoft.UI.Xaml.UIElement.CancelDirectManipulations.

(Inherited from UIElement)
CapturePointer(Pointer)

Sets pointer capture to a UIElement. Once captured, only the element that has capture will fire pointer-related events.

Equivalent WinUI method: Microsoft.UI.Xaml.UIElement.CapturePointer.

(Inherited from UIElement)
ClearValue(DependencyProperty)

Clears the local value of a dependency property.

Equivalent WinUI method: Microsoft.UI.Xaml.DependencyObject.ClearValue.

(Inherited from DependencyObject)
FindName(String)

Retrieves an object that has the specified identifier name.

Equivalent WinUI method: Microsoft.UI.Xaml.FrameworkElement.FindName.

(Inherited from FrameworkElement)
FindSubElementsForTouchTargeting(Point, Rect)

Enables a UIElement subclass to expose child elements that assist with resolving touch targeting.

Equivalent WinUI method: Microsoft.UI.Xaml.UIElement.FindSubElementsForTouchTargeting.

(Inherited from UIElement)
GetAnimationBaseValue(DependencyProperty)

Returns any base value established for a dependency property, which would apply in cases where an animation is not active.

Equivalent WinUI method: Microsoft.UI.Xaml.DependencyObject.GetAnimationBaseValue.

(Inherited from DependencyObject)
GetBindingExpression(DependencyProperty)

Returns the BindingExpression that represents the binding on the specified property.

Equivalent WinUI method: Microsoft.UI.Xaml.FrameworkElement.GetBindingExpression.

(Inherited from FrameworkElement)
GetChildrenInTabFocusOrder()

Enables a UIElement subclass to expose child elements that take part in Tab focus.

Equivalent WinUI method: Microsoft.UI.Xaml.UIElement.GetChildrenInTabFocusOrder.

(Inherited from UIElement)
GetColumn(FrameworkElement)

Gets the value of the Grid.Column XAML attached property from the specified FrameworkElement.

Equivalent WinUI method: Microsoft.UI.Xaml.Controls.Grid.GetColumn.

GetColumnSpan(FrameworkElement)

Gets the value of the Grid.ColumnSpan XAML attached property from the specified FrameworkElement.

Equivalent WinUI method: Microsoft.UI.Xaml.Controls.Grid.GetColumnSpan.

GetRow(FrameworkElement)

Gets the value of the Grid.Row XAML attached property from the specified FrameworkElement.

Equivalent WinUI method: Microsoft.UI.Xaml.Controls.Grid.GetRow.

GetRowSpan(FrameworkElement)

Gets the value of the Grid.RowSpan XAML attached property from the specified FrameworkElement.

Equivalent WinUI method: Microsoft.UI.Xaml.Controls.Grid.GetRowSpan.

GetValue(DependencyProperty)

Returns the current effective value of a dependency property from a DependencyObject.

Equivalent WinUI method: Microsoft.UI.Xaml.DependencyObject.GetValue.

(Inherited from DependencyObject)
GoToElementStateCore(String, Boolean)

When implemented in a derived class, enables per-state construction of a visual tree for a control template in code, rather than by loading XAML for all states at control startup.

Equivalent WinUI method: Microsoft.UI.Xaml.FrameworkElement.GoToElementStateCore.

(Inherited from FrameworkElement)
InvalidateArrange()

Invalidates the arrange state (layout) for a UIElement. After the invalidation, the UIElement will have its layout updated, which will occur asynchronously.

Equivalent WinUI method: Microsoft.UI.Xaml.UIElement.InvalidateArrange.

(Inherited from UIElement)
InvalidateMeasure()

Invalidates the measurement state (layout) for a UIElement.

Equivalent WinUI method: Microsoft.UI.Xaml.UIElement.InvalidateMeasure.

(Inherited from UIElement)
InvalidateViewport()

Invalidates the viewport state for a UIElement that is used to calculate the effective viewport.

Equivalent WinUI method: Microsoft.UI.Xaml.FrameworkElement.InvalidateViewport.

(Inherited from FrameworkElement)
Measure(Size)

Updates the DesiredSize of a UIElement. Typically, objects that implement custom layout for their layout children call this method from their own MeasureOverride implementations to form a recursive layout update.

Equivalent WinUI method: Microsoft.UI.Xaml.UIElement.Measure.

(Inherited from UIElement)
MeasureOverride(Size)

Provides the behavior for the "Measure" pass of the layout cycle. Classes can override this method to define their own "Measure" pass behavior.

Equivalent WinUI method: Microsoft.UI.Xaml.FrameworkElement.MeasureOverride.

(Inherited from FrameworkElement)
OnApplyTemplate()

Invoked whenever application code or internal processes (such as a rebuilding layout pass) call ApplyTemplate. In simplest terms, this means the method is called just before a UI element displays in your app. Override this method to influence the default post-template logic of a class.

Equivalent WinUI method: Microsoft.UI.Xaml.FrameworkElement.OnApplyTemplate.

(Inherited from FrameworkElement)
OnBringIntoViewRequested(BringIntoViewRequestedEventArgs)

Called before the BringIntoViewRequested event occurs. Equivalent WinUI method: Microsoft.UI.Xaml.UIElement.OnBringIntoViewRequested.

(Inherited from UIElement)
OnCreateAutomationPeer()

When implemented in a derived class, returns class-specific AutomationPeer implementations for the Microsoft UI Automation infrastructure.

Equivalent WinUI method: Microsoft.UI.Xaml.UIElement.OnCreateAutomationPeer.

(Inherited from UIElement)
OnDisconnectVisualChildren()

Override this method to implement how layout and logic should behave when items are removed from a class-specific content or children property.

Equivalent WinUI method: Microsoft.UI.Xaml.UIElement.OnDisconnectVisualChildren.

(Inherited from UIElement)
OnKeyboardAcceleratorInvoked(KeyboardAcceleratorInvokedEventArgs)

Called when a keyboard shortcut (or accelerator) is processed in your app. Override this method to handle how your app responds when a keyboard accelerator is invoked.

Equivalent WinUI method: Microsoft.UI.Xaml.UIElement.OnKeyboardAcceleratorInvoked.

(Inherited from UIElement)
OnProcessKeyboardAccelerators(ProcessKeyboardAcceleratorEventArgs)

Called just before a keyboard shortcut (or accelerator) is processed in your app. Invoked whenever application code or internal processes call ProcessKeyboardAccelerators. Override this method to influence the default accelerator handling.

Equivalent WinUI method: Microsoft.UI.Xaml.UIElement.OnProcessKeyboardAccelerators.

(Inherited from UIElement)
PopulatePropertyInfo(String, AnimationPropertyInfo)

Defines a property that can be animated.

Equivalent WinUI method: Microsoft.UI.Xaml.UIElement.PopulatePropertyInfo.

(Inherited from UIElement)
PopulatePropertyInfoOverride(String, AnimationPropertyInfo)

When overridden in a derived class, defines a property that can be animated.

Equivalent WinUI method: Microsoft.UI.Xaml.UIElement.PopulatePropertyInfoOverride.

(Inherited from UIElement)
ReadLocalValue(DependencyProperty)

Returns the local value of a dependency property, if a local value is set.

Equivalent WinUI method: Microsoft.UI.Xaml.DependencyObject.ReadLocalValue.

(Inherited from DependencyObject)
RegisterPropertyChangedCallback(DependencyProperty, DependencyPropertyChangedCallback)

Registers a notification function for listening to changes to a specific DependencyProperty on this DependencyObject instance.

Equivalent WinUI method: Microsoft.UI.Xaml.DependencyObject.RegisterPropertyChangedCallback.

(Inherited from DependencyObject)
ReleasePointerCapture(Pointer)

Releases pointer captures for capture of one specific pointer by this UIElement.

Equivalent WinUI method: Microsoft.UI.Xaml.UIElement.ReleasePointerCapture.

(Inherited from UIElement)
ReleasePointerCaptures()

Releases all pointer captures held by this element.

Equivalent WinUI method: Microsoft.UI.Xaml.UIElement.ReleasePointerCaptures.

(Inherited from UIElement)
RemoveHandler(RoutedEvent, Object)

Removes the specified routed event handler from this UIElement. Typically the handler in question was added by AddHandler.

Equivalent WinUI method: Microsoft.UI.Xaml.UIElement.RemoveHandler.

(Inherited from UIElement)
SetBinding(DependencyProperty, BindingBase)

Attaches a binding to a FrameworkElement, using the provided binding object.

Equivalent WinUI method: Microsoft.UI.Xaml.FrameworkElement.SetBinding.

(Inherited from FrameworkElement)
SetColumn(FrameworkElement, Int32)

Sets the value of the Grid.Column XAML attached property on the specified FrameworkElement.

Equivalent WinUI method: Microsoft.UI.Xaml.Controls.Grid.SetColumn.

SetColumnSpan(FrameworkElement, Int32)

Sets the value of the Grid.ColumnSpan XAML attached property on the specified FrameworkElement.

Equivalent WinUI method: Microsoft.UI.Xaml.Controls.Grid.SetColumnSpan.

SetRow(FrameworkElement, Int32)

Sets the value of the Grid.Row XAML attached property on the specified FrameworkElement.

Equivalent WinUI method: Microsoft.UI.Xaml.Controls.Grid.SetRow.

SetRowSpan(FrameworkElement, Int32)

Sets the value of the Grid.RowSpan XAML attached property on the specified FrameworkElement.

Equivalent WinUI method: Microsoft.UI.Xaml.Controls.Grid.SetRowSpan.

SetValue(DependencyProperty, Object)

Sets the local value of a dependency property on a DependencyObject.

Equivalent WinUI method: Microsoft.UI.Xaml.DependencyObject.SetValue.

(Inherited from DependencyObject)
StartAnimation(ICompositionAnimationBase)

Begins the specified animation on the element.

Equivalent WinUI method: Microsoft.UI.Xaml.UIElement.StartAnimation.

(Inherited from UIElement)
StartBringIntoView()

Initiates a request to the XAML framework to bring the element into view within any scrollable regions it is contained within.

Equivalent WinUI method: Microsoft.UI.Xaml.UIElement.StartBringIntoView.

(Inherited from UIElement)
StartBringIntoView(BringIntoViewOptions)

Initiates a request to the XAML framework to bring the element into view using the specified options.

Equivalent WinUI method: Microsoft.UI.Xaml.UIElement.StartBringIntoView.

(Inherited from UIElement)
StartDragAsync(PointerPoint)

Initiates a drag-and-drop operation.

(Inherited from UIElement)
StopAnimation(ICompositionAnimationBase)

Stops the specified animation on the element.

Equivalent WinUI method: Microsoft.UI.Xaml.UIElement.StopAnimation.

(Inherited from UIElement)
TransformToVisual(UIElement)

Returns a transform object that can be used to transform coordinates from the UIElement to the specified object.

Equivalent WinUI method: Microsoft.UI.Xaml.UIElement.TransformToVisual.

(Inherited from UIElement)
TryInvokeKeyboardAccelerator(ProcessKeyboardAcceleratorEventArgs)

Attempts to invoke a keyboard shortcut (or accelerator) by searching the entire visual tree of the UIElement for the shortcut.

Equivalent WinUI method: Microsoft.UI.Xaml.UIElement.TryInvokeKeyboardAccelerator.

(Inherited from UIElement)
UnregisterPropertyChangedCallback(DependencyProperty, Int64)

Cancels a change notification that was previously registered by calling RegisterPropertyChangedCallback.

Equivalent WinUI method: Microsoft.UI.Xaml.DependencyObject.UnregisterPropertyChangedCallback.

(Inherited from DependencyObject)
UpdateLayout()

Ensures that all positions of child objects of a UIElement are properly updated for layout.

Equivalent WinUI method: Microsoft.UI.Xaml.UIElement.UpdateLayout.

(Inherited from UIElement)

Events

AccessKeyDisplayDismissed

Occurs when access keys should no longer be displayed.

Equivalent WinUI event: Microsoft.UI.Xaml.UIElement.AccessKeyDisplayDismissed.

(Inherited from UIElement)
AccessKeyDisplayRequested

Occurs when the user requests that access keys be displayed.

Equivalent WinUI event: Microsoft.UI.Xaml.UIElement.AccessKeyDisplayRequested.

(Inherited from UIElement)
AccessKeyInvoked

Occurs when a user completes an access key sequence.

Equivalent WinUI event: Microsoft.UI.Xaml.UIElement.AccessKeyInvoked.

(Inherited from UIElement)
ActualThemeChanged

Occurs when the ActualTheme property value has changed.

Equivalent WinUI event: Microsoft.UI.Xaml.FrameworkElement.ActualThemeChanged.

(Inherited from FrameworkElement)
BringIntoViewRequested

Occurs when StartBringIntoView is called on this element or one of its descendants.

Equivalent WinUI event: Microsoft.UI.Xaml.UIElement.BringIntoViewRequested.

(Inherited from UIElement)
CharacterReceived

Occurs when a single, composed character is received by the input queue.

Equivalent WinUI event: Microsoft.UI.Xaml.UIElement.CharacterReceived.

(Inherited from UIElement)
ContextCanceled

Occurs when a context input gesture continues into a manipulation gesture, to notify the element that the context flyout should not be opened.

Equivalent WinUI event: Microsoft.UI.Xaml.UIElement.ContextCanceled.

(Inherited from UIElement)
ContextRequested

Occurs when the user has completed a context input gesture, such as a right-click.

Equivalent WinUI event: Microsoft.UI.Xaml.UIElement.ContextRequested.

(Inherited from UIElement)
DataContextChanged

Occurs when the value of the FrameworkElement.DataContext property changes.

Equivalent WinUI event: Microsoft.UI.Xaml.FrameworkElement.DataContextChanged.

(Inherited from FrameworkElement)
DoubleTapped

Occurs when an otherwise unhandled DoubleTap interaction occurs over the hit test area of this element.

Equivalent WinUI event: Microsoft.UI.Xaml.UIElement.DoubleTapped.

(Inherited from UIElement)
DragEnter

Occurs when the input system reports an underlying drag event with this element as the target.

Equivalent WinUI event: Microsoft.UI.Xaml.UIElement.DragEnter.

(Inherited from UIElement)
DragLeave

Occurs when the input system reports an underlying drag event with this element as the origin.

Equivalent WinUI event: Microsoft.UI.Xaml.UIElement.DragLeave.

(Inherited from UIElement)
DragOver

Occurs when the input system reports an underlying drag event with this element as the potential drop target.

Equivalent WinUI event: Microsoft.UI.Xaml.UIElement.DragOver.

(Inherited from UIElement)
DragStarting

Occurs when a drag operation is initiated.

Equivalent WinUI event: Microsoft.UI.Xaml.UIElement.DragStarting.

(Inherited from UIElement)
Drop

Occurs when the input system reports an underlying drop event with this element as the drop target.

Equivalent WinUI event: Microsoft.UI.Xaml.UIElement.Drop.

(Inherited from UIElement)
DropCompleted

Occurs when a drag-and-drop operation with this element as the source is ended.

Equivalent WinUI event: Microsoft.UI.Xaml.UIElement.DropCompleted.

(Inherited from UIElement)
EffectiveViewportChanged

Occurs when the FrameworkElement 's effective viewport changes.

Equivalent WinUI event: Microsoft.UI.Xaml.FrameworkElement.EffectiveViewportChanged.

(Inherited from FrameworkElement)
GettingFocus

Occurs before a UIElement receives focus. This event is raised synchronously to ensure focus isn't moved while the event is bubbling.

Equivalent WinUI event: Microsoft.UI.Xaml.UIElement.GettingFocus.

(Inherited from UIElement)
GotFocus

Occurs when a UIElement receives focus. This event is raised asynchronously, so focus can move again before bubbling is complete.

Equivalent WinUI event: Microsoft.UI.Xaml.UIElement.GotFocus.

(Inherited from UIElement)
Holding

Occurs when an otherwise unhandled Hold interaction occurs over the hit test area of this element.

Equivalent WinUI event: Microsoft.UI.Xaml.UIElement.Holding.

(Inherited from UIElement)
KeyDown

Occurs when a keyboard key is pressed while the UIElement has focus.

Equivalent WinUI event: Microsoft.UI.Xaml.UIElement.KeyDown.

(Inherited from UIElement)
KeyUp

Occurs when a keyboard key is released while the UIElement has focus.

Equivalent WinUI event: Microsoft.UI.Xaml.UIElement.KeyUp.

(Inherited from UIElement)
LayoutUpdated

Occurs when the layout of the visual tree changes, due to layout-relevant properties changing value or some other action that refreshes the layout.

Equivalent WinUI event: Microsoft.UI.Xaml.FrameworkElement.LayoutUpdated.

(Inherited from FrameworkElement)
Loaded

Occurs when a FrameworkElement has been constructed and added to the object tree, and is ready for interaction.

Equivalent WinUI event: Microsoft.UI.Xaml.FrameworkElement.Loaded.

(Inherited from FrameworkElement)
Loading

Occurs when a FrameworkElement begins to load.

Equivalent WinUI event: Microsoft.UI.Xaml.FrameworkElement.Loading.

(Inherited from FrameworkElement)
LosingFocus

Occurs before a UIElement loses focus. This event is raised synchronously to ensure focus isn't moved while the event is bubbling.

Equivalent WinUI event: Microsoft.UI.Xaml.UIElement.LosingFocus.

(Inherited from UIElement)
LostFocus

Occurs when a UIElement loses focus. This event is raised asynchronously, so focus can move again before bubbling is complete.

Equivalent WinUI event: Microsoft.UI.Xaml.UIElement.LostFocus.

(Inherited from UIElement)
ManipulationCompleted

Occurs when a manipulation on the UIElement is complete.

Equivalent WinUI event: Microsoft.UI.Xaml.UIElement.ManipulationCompleted.

(Inherited from UIElement)
ManipulationDelta

Occurs when the input device changes position during a manipulation.

Equivalent WinUI event: Microsoft.UI.Xaml.UIElement.ManipulationDelta.

(Inherited from UIElement)
ManipulationInertiaStarting

Occurs when the input device loses contact with the UIElement object during a manipulation and inertia begins.

Equivalent WinUI event: Microsoft.UI.Xaml.UIElement.ManipulationInertiaStarting.

(Inherited from UIElement)
ManipulationStarted

Occurs when an input device begins a manipulation on the UIElement.

Equivalent WinUI event: Microsoft.UI.Xaml.UIElement.ManipulationStarted.

(Inherited from UIElement)
ManipulationStarting

Occurs when the manipulation processor is first created.

Equivalent WinUI event: Microsoft.UI.Xaml.UIElement.ManipulationStarting.

(Inherited from UIElement)
NoFocusCandidateFound

Occurs when a user attempts to move focus (via tab or directional arrows), but focus doesn't move because no focus candidate is found in the direction of movement.

Equivalent WinUI event: Microsoft.UI.Xaml.UIElement.NoFocusCandidateFound.

(Inherited from UIElement)
PointerCanceled

Occurs when a pointer that made contact abnormally loses contact.

Equivalent WinUI event: Microsoft.UI.Xaml.UIElement.PointerCanceled.

(Inherited from UIElement)
PointerCaptureLost

Occurs when pointer capture previously held by this element moves to another element or elsewhere.

Equivalent WinUI event: Microsoft.UI.Xaml.UIElement.PointerCaptureLost.

(Inherited from UIElement)
PointerEntered

Occurs when a pointer enters the hit test area of this element.

Equivalent WinUI event: Microsoft.UI.Xaml.UIElement.PointerEntered.

(Inherited from UIElement)
PointerExited

Occurs when a pointer leaves the hit test area of this element.

Equivalent WinUI event: Microsoft.UI.Xaml.UIElement.PointerExited.

(Inherited from UIElement)
PointerMoved

Occurs when a pointer moves while the pointer remains within the hit test area of this element.

Equivalent WinUI event: Microsoft.UI.Xaml.UIElement.PointerMoved.

(Inherited from UIElement)
PointerPressed

Occurs when the pointer device initiates a Press action within this element.

Equivalent WinUI event: Microsoft.UI.Xaml.UIElement.PointerPressed.

(Inherited from UIElement)
PointerReleased

Occurs when the pointer device that previously initiated a Press action is released, while within this element. Note that the end of a Press action is not guaranteed to fire a PointerReleased event; other events may fire instead. For more info, see Remarks.

Equivalent WinUI event: Microsoft.UI.Xaml.UIElement.PointerReleased.

(Inherited from UIElement)
PointerWheelChanged

Occurs when the delta value of a pointer wheel changes.

Equivalent WinUI event: Microsoft.UI.Xaml.UIElement.PointerWheelChanged.

(Inherited from UIElement)
PreviewKeyDown

Occurs when a keyboard key is pressed while the UIElement has focus.

Equivalent WinUI event: Microsoft.UI.Xaml.UIElement.PreviewKeyDown.

(Inherited from UIElement)
PreviewKeyUp

Occurs when a keyboard key is released while the UIElement has focus.

Equivalent WinUI event: Microsoft.UI.Xaml.UIElement.PreviewKeyUp.

(Inherited from UIElement)
ProcessKeyboardAccelerators

Occurs when a keyboard shortcut (or accelerator) is pressed.

Equivalent WinUI event: Microsoft.UI.Xaml.UIElement.ProcessKeyboardAccelerators.

(Inherited from UIElement)
RightTapped

Occurs when a right-tap input stimulus happens while the pointer is over the element.

Equivalent WinUI event: Microsoft.UI.Xaml.UIElement.RightTapped.

(Inherited from UIElement)
SizeChanged

Occurs when either the ActualHeight or the ActualWidth property changes value on a FrameworkElement.

Equivalent WinUI event: Microsoft.UI.Xaml.FrameworkElement.SizeChanged.

(Inherited from FrameworkElement)
Tapped

Occurs when an otherwise unhandled Tap interaction occurs over the hit test area of this element.

Equivalent WinUI event: Microsoft.UI.Xaml.UIElement.Tapped.

(Inherited from UIElement)
Unloaded

Occurs when this object is no longer connected to the main object tree.

Equivalent WinUI event: Microsoft.UI.Xaml.FrameworkElement.Unloaded.

(Inherited from FrameworkElement)

Applies to

See also