Version: 2022.3
LanguageEnglish
  • C#

RectTransform.SetInsetAndSizeFromParentEdge

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Submission failed

For some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

Switch to Manual

Declaration

public void SetInsetAndSizeFromParentEdge(RectTransform.Edge edge, float inset, float size);

Parameters

edge The edge of the parent rectangle to inset from.
inset The inset distance.
size The size of the rectangle along the same direction of the inset.

Description

Set the distance of this rectangle relative to a specified edge of the parent rectangle, while also setting its size.

Calling this method sets both the anchors, anchoredPosition, and sizeDelta, though only either the horizontal or vertical components, depending on which edge is specified for the inset.

The method can particularly be useful when scripting layout behaviours, since it makes it simple to specify positions relative to the parent edges without needing to be concerned with anchoring functionality.