Border Class

In This Topic

Similar to the Framework's Border control, but with more flexibility than said control.

Syntax

Visual Basic
C#

'Declaration
 
<DefaultPropertyAttribute("Content")>
<ContentPropertyAttribute("Content")>
Public Class Border 
   Inherits Control
   Implements Microsoft.Maui.Controls.IAnimatable, Microsoft.Maui.Controls.IEffectControlProvider, Microsoft.Maui.Controls.IElementController, Microsoft.Maui.Controls.IGestureRecognizers, Microsoft.Maui.Controls.ILayout, Microsoft.Maui.Controls.ILayoutController, Microsoft.Maui.Controls.Internals.IGestureController, Microsoft.Maui.Controls.IViewController, Microsoft.Maui.Controls.IVisualElementController, Microsoft.Maui.HotReload.IHotReloadableView, Microsoft.Maui.IContentView, Microsoft.Maui.IContextFlyoutElement, Microsoft.Maui.ICrossPlatformLayout, Microsoft.Maui.IElement, Microsoft.Maui.IPadding, Microsoft.Maui.IPropertyMapperView, Microsoft.Maui.IReplaceableView, Microsoft.Maui.IToolTipElement, Microsoft.Maui.ITransform, Microsoft.Maui.IView, Microsoft.Maui.IVisualTreeElement, IBorder

'Usage
 
Dim instance As Border

[DefaultProperty("Content")]
[ContentProperty("Content")]
public class Border : Control, Microsoft.Maui.Controls.IAnimatable, Microsoft.Maui.Controls.IEffectControlProvider, Microsoft.Maui.Controls.IElementController, Microsoft.Maui.Controls.IGestureRecognizers, Microsoft.Maui.Controls.ILayout, Microsoft.Maui.Controls.ILayoutController, Microsoft.Maui.Controls.Internals.IGestureController, Microsoft.Maui.Controls.IViewController, Microsoft.Maui.Controls.IVisualElementController, Microsoft.Maui.HotReload.IHotReloadableView, Microsoft.Maui.IContentView, Microsoft.Maui.IContextFlyoutElement, Microsoft.Maui.ICrossPlatformLayout, Microsoft.Maui.IElement, Microsoft.Maui.IPadding, Microsoft.Maui.IPropertyMapperView, Microsoft.Maui.IReplaceableView, Microsoft.Maui.IToolTipElement, Microsoft.Maui.ITransform, Microsoft.Maui.IView, Microsoft.Maui.IVisualTreeElement, IBorder

Remarks

The first reason for this control's flexibility is that the Thickness & CornerRadius of all 4 sides of the Border can be set independently.

On top of that, any View control can be set as the Border's Content & aligned easily through the HorizontalContentOptions & VerticalContentOptions properties.

Finally, the Border's Content will also inherit the TextColor, FontAttributes, FontSize & FontFamily properties when they are set.

Example

The following code will surround the inserted Content with this type of Border:

XAML

<xctk:Border HeightRequest="96"
             WidthRequest="120"
             BorderThickness="10,6,5,9"
             CornerRadius="40,10,0,20"
             TextColor="Red"
             HorizontalContentOptions="Center"
             VerticalContentOptions="Center"
             Margin="20"
             BorderBrush="Orange">
 <VerticalStackLayout>
  <Label Text="My"/>
  <Label Text="Border"/>
 </VerticalStackLayout>
</xctk:Border>

Inheritance Hierarchy

System.Object
   Microsoft.Maui.Controls.BindableObject
      Microsoft.Maui.Controls.Element
         Microsoft.Maui.Controls.NavigableElement
            Microsoft.Maui.Controls.VisualElement
               Microsoft.Maui.Controls.View
                  Microsoft.Maui.Controls.Compatibility.Layout
                     Microsoft.Maui.Controls.TemplatedView
                        Xceed.Maui.Toolkit.Control
                           Xceed.Maui.Toolkit.Border

Public Constructors

	Name	Description
	Border Constructor

Top

Public Fields

	Name	Description
	ContentProperty

Top

Protected Fields

	Name	Description
	propertyMapper	(Inherited from Microsoft.Maui.Controls.View)

Top

Public Properties

	Name	Description
	AnchorX	(Inherited from Microsoft.Maui.Controls.VisualElement)
	AnchorY	(Inherited from Microsoft.Maui.Controls.VisualElement)
	AutomationId	(Inherited from Microsoft.Maui.Controls.Element)
	Background	Gets or sets the Brush that will be used to paint the Control's background. (Inherited from Xceed.Maui.Toolkit.Control)
	BackgroundColor	(Inherited from Microsoft.Maui.Controls.VisualElement)
	Behaviors	(Inherited from Microsoft.Maui.Controls.VisualElement)
	BindingContext	(Inherited from Microsoft.Maui.Controls.BindableObject)
	BorderBrush	Gets or sets the Brush that will be used to paint the Control's Border. (Inherited from Xceed.Maui.Toolkit.Control)
	BorderThickness	Gets or sets the thickness of this Control's Border. (Inherited from Xceed.Maui.Toolkit.Control)
	Bounds	(Inherited from Microsoft.Maui.Controls.VisualElement)
	CascadeInputTransparent	(Inherited from Microsoft.Maui.Controls.Compatibility.Layout)
	class	(Inherited from Microsoft.Maui.Controls.NavigableElement)
	ClassId	(Inherited from Microsoft.Maui.Controls.Element)
	Clip	(Inherited from Microsoft.Maui.Controls.VisualElement)
	Content	Gets or sets the Border's content, in other words, what's inside the Border.
	ControlTemplate	(Inherited from Microsoft.Maui.Controls.TemplatedView)
	CornerRadius	Gets or sets the radius for the 4 corners of this Control. (Inherited from Xceed.Maui.Toolkit.Control)
	DesiredSize	(Inherited from Microsoft.Maui.Controls.VisualElement)
	Dispatcher	(Inherited from Microsoft.Maui.Controls.BindableObject)
	Effects	(Inherited from Microsoft.Maui.Controls.Element)
	FlowDirection	(Inherited from Microsoft.Maui.Controls.VisualElement)
	FontAttributes	Gets or sets the FontAttributes that will be applied to the Control's textual Content. (Inherited from Xceed.Maui.Toolkit.Control)
	FontFamily	Gets or sets the font family that will be used to display the Control's textual Content. (Inherited from Xceed.Maui.Toolkit.Control)
	FontSize	Gets or sets the font size that will determine the scale of the Control's textual Content. (Inherited from Xceed.Maui.Toolkit.Control)
	Frame	(Inherited from Microsoft.Maui.Controls.VisualElement)
	GestureRecognizers	(Inherited from Microsoft.Maui.Controls.View)
	Handler	(Inherited from Microsoft.Maui.Controls.VisualElement)
	Height	(Inherited from Microsoft.Maui.Controls.VisualElement)
	HeightRequest	(Inherited from Microsoft.Maui.Controls.VisualElement)
	HorizontalContentOptions	Gets or sets how the Control's Content is aligned horizontally. (Inherited from Xceed.Maui.Toolkit.Control)
	HorizontalOptions	(Inherited from Microsoft.Maui.Controls.View)
	Id	(Inherited from Microsoft.Maui.Controls.Element)
	InputTransparent	(Inherited from Microsoft.Maui.Controls.VisualElement)
	IsClippedToBounds	(Inherited from Microsoft.Maui.Controls.Compatibility.Layout)
	IsEnabled	(Inherited from Microsoft.Maui.Controls.VisualElement)
	IsFocused	(Inherited from Microsoft.Maui.Controls.VisualElement)
	IsLoaded	(Inherited from Microsoft.Maui.Controls.VisualElement)
	IsVisible	(Inherited from Microsoft.Maui.Controls.VisualElement)
	Margin	(Inherited from Microsoft.Maui.Controls.View)
	MaximumHeightRequest	(Inherited from Microsoft.Maui.Controls.VisualElement)
	MaximumWidthRequest	(Inherited from Microsoft.Maui.Controls.VisualElement)
	MinimumHeightRequest	(Inherited from Microsoft.Maui.Controls.VisualElement)
	MinimumWidthRequest	(Inherited from Microsoft.Maui.Controls.VisualElement)
	Navigation	(Inherited from Microsoft.Maui.Controls.NavigableElement)
	Opacity	(Inherited from Microsoft.Maui.Controls.VisualElement)
	OverrideDefaultVisualStates	Gets or sets if the Control's VisualStates are overridden or not. (Inherited from Xceed.Maui.Toolkit.Control)
	Padding	Gets or sets the amount of padding added around the Control. (Inherited from Xceed.Maui.Toolkit.Control)
	Parent	(Inherited from Microsoft.Maui.Controls.Element)
	Resources	(Inherited from Microsoft.Maui.Controls.VisualElement)
	Rotation	(Inherited from Microsoft.Maui.Controls.VisualElement)
	RotationX	(Inherited from Microsoft.Maui.Controls.VisualElement)
	RotationY	(Inherited from Microsoft.Maui.Controls.VisualElement)
	Scale	(Inherited from Microsoft.Maui.Controls.VisualElement)
	ScaleX	(Inherited from Microsoft.Maui.Controls.VisualElement)
	ScaleY	(Inherited from Microsoft.Maui.Controls.VisualElement)
	Shadow	(Inherited from Microsoft.Maui.Controls.VisualElement)
	Style	(Inherited from Microsoft.Maui.Controls.NavigableElement)
	StyleClass	(Inherited from Microsoft.Maui.Controls.NavigableElement)
	StyleId	(Inherited from Microsoft.Maui.Controls.Element)
	TextColor	Gets or sets the text's Color. (Inherited from Xceed.Maui.Toolkit.Control)
	TranslationX	(Inherited from Microsoft.Maui.Controls.VisualElement)
	TranslationY	(Inherited from Microsoft.Maui.Controls.VisualElement)
	Triggers	(Inherited from Microsoft.Maui.Controls.VisualElement)
	VerticalContentOptions	Gets or sets how the Control's Content is aligned vertically. (Inherited from Xceed.Maui.Toolkit.Control)
	VerticalOptions	(Inherited from Microsoft.Maui.Controls.View)
	Visual	(Inherited from Microsoft.Maui.Controls.VisualElement)
	Width	(Inherited from Microsoft.Maui.Controls.VisualElement)
	WidthRequest	(Inherited from Microsoft.Maui.Controls.VisualElement)
	Window	(Inherited from Microsoft.Maui.Controls.VisualElement)
	X	(Inherited from Microsoft.Maui.Controls.VisualElement)
	Y	(Inherited from Microsoft.Maui.Controls.VisualElement)
	ZIndex	(Inherited from Microsoft.Maui.Controls.VisualElement)

Top

Protected Properties

	Name	Description
	GestureController	(Inherited from Microsoft.Maui.Controls.View)
	IsEnabledCore	(Inherited from Microsoft.Maui.Controls.VisualElement)

Top

Public Methods

	Name	Description
	AddLogicalChild	(Inherited from Microsoft.Maui.Controls.Element)
	Arrange	(Inherited from Microsoft.Maui.Controls.VisualElement)
	BatchBegin	(Inherited from Microsoft.Maui.Controls.VisualElement)
	BatchCommit	(Inherited from Microsoft.Maui.Controls.VisualElement)
	ClearLogicalChildren	(Inherited from Microsoft.Maui.Controls.Element)
	ClearValue	Overloaded. (Inherited from Microsoft.Maui.Controls.BindableObject)
	CoerceValue	Overloaded. (Inherited from Microsoft.Maui.Controls.BindableObject)
	CrossPlatformArrange	(Inherited from Microsoft.Maui.Controls.Compatibility.Layout)
	CrossPlatformMeasure	(Inherited from Microsoft.Maui.Controls.Compatibility.Layout)
	FindByName	(Inherited from Microsoft.Maui.Controls.Element)
	Focus	(Inherited from Microsoft.Maui.Controls.VisualElement)
	ForceLayout	(Inherited from Microsoft.Maui.Controls.Compatibility.Layout)
	GetChildElements	(Inherited from Microsoft.Maui.Controls.View)
	GetValue	(Inherited from Microsoft.Maui.Controls.BindableObject)
	InsertLogicalChild	(Inherited from Microsoft.Maui.Controls.Element)
	IsSet	(Inherited from Microsoft.Maui.Controls.BindableObject)
	Layout	(Inherited from Microsoft.Maui.Controls.VisualElement)
	LowerChild	(Inherited from Microsoft.Maui.Controls.Compatibility.Layout)
	Measure	(Inherited from Microsoft.Maui.Controls.Compatibility.Layout)
	RaiseChild	(Inherited from Microsoft.Maui.Controls.Compatibility.Layout)
	RaisePointerDownEvent
	RaisePointerEnterEvent
	RaisePointerLeaveEvent
	RaisePointerUpEvent
	RemoveBinding	(Inherited from Microsoft.Maui.Controls.BindableObject)
	RemoveDynamicResource	(Inherited from Microsoft.Maui.Controls.Element)
	RemoveLogicalChild	(Inherited from Microsoft.Maui.Controls.Element)
	ResolveControlTemplate	(Inherited from Microsoft.Maui.Controls.TemplatedView)
	SetBinding	(Inherited from Microsoft.Maui.Controls.BindableObject)
	SetDynamicResource	(Inherited from Microsoft.Maui.Controls.Element)
	SetValue	Overloaded. (Inherited from Microsoft.Maui.Controls.BindableObject)
	Unfocus	(Inherited from Microsoft.Maui.Controls.VisualElement)

Top

Protected Methods

	Name	Description
	ApplyBindings	(Inherited from Microsoft.Maui.Controls.BindableObject)
	ArrangeOverride	(Inherited from Microsoft.Maui.Controls.TemplatedView)
	ChangeVisualState	(Inherited from Microsoft.Maui.Controls.View)
	Finalize	(Inherited from Microsoft.Maui.Controls.VisualElement)
	GetRendererOverrides	(Inherited from Microsoft.Maui.Controls.View)
	GetTemplateChild	(Inherited from Microsoft.Maui.Controls.TemplatedView)
	InvalidateLayout	(Inherited from Microsoft.Maui.Controls.Compatibility.Layout)
	InvalidateMeasure	(Inherited from Microsoft.Maui.Controls.VisualElement)
	InvalidateMeasureOverride	(Inherited from Microsoft.Maui.Controls.Compatibility.Layout)
	LayoutChildren	(Inherited from Microsoft.Maui.Controls.TemplatedView)
	MeasureOverride	(Inherited from Microsoft.Maui.Controls.TemplatedView)
	OnApplyTemplate	(Inherited from Xceed.Maui.Toolkit.Control)
	OnBindingContextChanged	Overridden.
	OnChildAdded	(Inherited from Microsoft.Maui.Controls.VisualElement)
	OnChildMeasureInvalidated	Overloaded. (Inherited from Microsoft.Maui.Controls.Compatibility.Layout)
	OnChildRemoved	(Inherited from Microsoft.Maui.Controls.TemplatedView)
	OnChildrenReordered	(Inherited from Microsoft.Maui.Controls.VisualElement)
	OnContentChanged
	OnFontAttributesChanged	Overridden.
	OnFontFamilyChanged	Overridden.
	OnFontSizeChanged	Overridden.
	OnHandlerChanged	(Inherited from Microsoft.Maui.Controls.Element)
	OnHandlerChanging	(Inherited from Microsoft.Maui.Controls.Element)
	OnMeasure	(Inherited from Microsoft.Maui.Controls.TemplatedView)
	OnParentChanged	(Inherited from Microsoft.Maui.Controls.Element)
	OnParentChanging	(Inherited from Microsoft.Maui.Controls.Element)
	OnParentSet	(Inherited from Microsoft.Maui.Controls.NavigableElement)
	OnPropertyChanged	(Inherited from Xceed.Maui.Toolkit.Control)
	OnPropertyChanging	Overridden.
	OnSizeAllocated	(Inherited from Microsoft.Maui.Controls.Compatibility.Layout)
	OnTextColorChanged	Overridden.
	RefreshIsEnabledProperty	(Inherited from Microsoft.Maui.Controls.VisualElement)
	ShouldInvalidateOnChildAdded	(Inherited from Microsoft.Maui.Controls.Compatibility.Layout)
	ShouldInvalidateOnChildRemoved	(Inherited from Microsoft.Maui.Controls.Compatibility.Layout)
	SizeAllocated	(Inherited from Microsoft.Maui.Controls.VisualElement)
	UnapplyBindings	(Inherited from Microsoft.Maui.Controls.BindableObject)
	UpdateChildrenLayout	(Inherited from Microsoft.Maui.Controls.Compatibility.Layout)

Top

Public Events

	Name	Description
	BindingContextChanged	(Inherited from Microsoft.Maui.Controls.BindableObject)
	ChildAdded	(Inherited from Microsoft.Maui.Controls.Element)
	ChildRemoved	(Inherited from Microsoft.Maui.Controls.Element)
	ChildrenReordered	(Inherited from Microsoft.Maui.Controls.VisualElement)
	DescendantAdded	(Inherited from Microsoft.Maui.Controls.Element)
	DescendantRemoved	(Inherited from Microsoft.Maui.Controls.Element)
	Focused	(Inherited from Microsoft.Maui.Controls.VisualElement)
	HandlerChanged	(Inherited from Microsoft.Maui.Controls.Element)
	HandlerChanging	(Inherited from Microsoft.Maui.Controls.Element)
	LayoutChanged	(Inherited from Microsoft.Maui.Controls.Compatibility.Layout)
	Loaded	(Inherited from Microsoft.Maui.Controls.VisualElement)
	MeasureInvalidated	(Inherited from Microsoft.Maui.Controls.VisualElement)
	ParentChanged	(Inherited from Microsoft.Maui.Controls.Element)
	ParentChanging	(Inherited from Microsoft.Maui.Controls.Element)
	PointerDown	This event is raised when the finger is pressed or the mouse button is clicked while inside the Border's bounds.
	PointerEnter	This event is raised when the pointer enters the Border's bounds.
	PointerLeave	This event is raised when the pointer leaves the Border's bounds.
	PointerUp	This event is raised when the finger or mouse button is released while inside the Border's bounds.
	PropertyChanged	(Inherited from Microsoft.Maui.Controls.BindableObject)
	PropertyChanging	(Inherited from Microsoft.Maui.Controls.BindableObject)
	SizeChanged	(Inherited from Microsoft.Maui.Controls.VisualElement)
	Unfocused	(Inherited from Microsoft.Maui.Controls.VisualElement)
	Unloaded	(Inherited from Microsoft.Maui.Controls.VisualElement)

Top

Requirements

Target Platforms: Windows 11, Windows 10, Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

Reference

Border Members
Xceed.Maui.Toolkit Namespace

Send Feedback

Business Suite

Ultimate Suite

Reference