Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > UMG > Components > UCanvasPanelSlot

Light Theme

Dark Theme

UCanvasPanelSlot

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UVisual

UPanelSlot

UCanvasPanelSlot

References

Module	UMG
Header	/Engine/Source/Runtime/UMG/Public/Components/CanvasPanelSlot.h
Include	#include "Components/CanvasPanelSlot.h"

Syntax

class UCanvasPanelSlot : public UPanelSlot

Variables

	Name	Description
bool	bAutoSize	When AutoSize is true we use the widget's desired size
FAnchorData	LayoutData	The anchoring information for the slot
int32	ZOrder	The order priority this widget is rendered in.

Constructors

	Name	Description
	UCanvasPanelSlot ( const FObjectInitializer& ObjectIn... )

Functions

	Name	Description
void	BuildSlot ( TSharedRef< SConstraintCanvas > Can... )
FVector2D	GetAlignment()	Gets the alignment on the slot
FAnchors	GetAnchors()	Gets the anchors on the slot
bool	GetAutoSize()	Gets if the slot to be auto-sized
FAnchorData	GetLayout()	Gets the layout data of the slot
FMargin	GetOffsets()	Gets the offset data of the slot, which could be position and size, or margins depending on the anchor points
FVector2D	GetPosition()	Gets the position of the slot
FVector2D	GetSize()	Gets the size of the slot
int32	GetZOrder()	Gets the z-order on the slot
void	RebaseLayout ( bool PreserveSize )	Compares the saved base layout against the current state.
void	SaveBaseLayout()	Stores the current layout information about the slot and parent canvas.
void	SetAlignment ( FVector2D InAlignment )	Sets the alignment on the slot
void	SetAnchors ( FAnchors InAnchors )	Sets the anchors on the slot
void	SetAutoSize ( bool InbAutoSize )	Sets if the slot to be auto-sized
void	SetDesiredPosition ( FVector2D InPosition )
void	SetLayout ( const FAnchorData& InLayoutData )	Sets the layout data of the slot
void	SetMaximum ( FVector2D InMaximumAnchors )	Sets the anchors on the slot
void	SetMinimum ( FVector2D InMinimumAnchors )	Sets the anchors on the slot
void	SetOffsets ( FMargin InOffset )	Sets the offset data of the slot, which could be position and size, or margins depending on the anchor points
void	SetPosition ( FVector2D InPosition )	Sets the position of the slot
void	SetSize ( FVector2D InSize )	Sets the size of the slot
void	SetZOrder ( int32 InZOrder )	Sets the z-order on the slot

Overridden from UPanelSlot

	Name	Description
bool	DragDropPreviewByDesigner ( const FVector2D& LocalCursorPositi..., const TOptional< int32 >& XGridSna..., const TOptional< int32 >& YGridSna... )	Called by the designer when a design-time widget is dragged.
bool	NudgeByDesigner ( const FVector2D& NudgeDirection, const TOptional< int32 >& GridSnap... )	Called by the designer to "nudge" a widget in a direction.
void	SynchronizeFromTemplate ( const UPanelSlot*const Templat... )	Called by the designer when a design-time widget needs to have changes to its associated template synchronized.
void	SynchronizeProperties()	Applies all properties to the live slot if possible.

Overridden from UVisual

		Name	Description
	void	ReleaseSlateResources ( bool bReleaseChildren )

Overridden from UObject

		Name	Description
	void	PostEditChangeChainProperty ( FPropertyChangedChainEvent& Proper... )	This alternate version of PostEditChange is called when properties inside structs are modified.
	void	PreEditChange ( FProperty* PropertyAboutToChan... )	This is called when a property is about to be modified externally

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss