Version: 2017.4
LanguageEnglish
  • C#
  • JS

Script language

Select your preferred scripting language. All code snippets will be displayed in this language.

TextGenerator.GetPreferredHeight

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

public method GetPreferredHeight(str: string, settings: TextGenerationSettings): float;
public float GetPreferredHeight(string str, TextGenerationSettings settings);

Parameters

strGeneration text.
settingsSettings for generation.

Returns

float Preferred height.

Description

Given a string and settings, returns the preferred height for a container that would hold this text.