Version: 2018.4
LanguageEnglish
  • C#
Experimental: this API is experimental and might be changed or removed in the future.

TextElement.MeasureTextSize

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

Declaration

public Vector2 MeasureTextSize(string textToMeasure, float width, Experimental.UIElements.VisualElement.MeasureMode widthMode, float height, Experimental.UIElements.VisualElement.MeasureMode heightMode);

Parameters

textToMeasure The text to measure.
width Suggested width. Can be zero.
widthMode Width restrictions.
height Suggested height.
heightMode Height restrictions.

Returns

Vector2 Returns the horizontal and vertical size needed to display the text string.

Description

Computes the size needed to display a text string based on element style values such as font, font-size, word-wrap, and so on.