Version: 2017.4
LanguageEnglish
  • C#
  • JS

Script language

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

Experimental: this API is experimental and might be changed or removed in the future.

ICustomStyle.ApplyCustomProperty

Leave feedback
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 ApplyCustomProperty(propertyName: string, ref target: StyleValue<float>): void;
public void ApplyCustomProperty(string propertyName, ref StyleValue<float> target);
public method ApplyCustomProperty(propertyName: string, ref target: StyleValue<int>): void;
public void ApplyCustomProperty(string propertyName, ref StyleValue<int> target);
public method ApplyCustomProperty(propertyName: string, ref target: StyleValue<bool>): void;
public void ApplyCustomProperty(string propertyName, ref StyleValue<bool> target);
public method ApplyCustomProperty(propertyName: string, ref target: StyleValue<Color>): void;
public void ApplyCustomProperty(string propertyName, ref StyleValue<Color> target);
public method ApplyCustomProperty(propertyName: string, ref target: StyleValue<T>): void;
public void ApplyCustomProperty(string propertyName, ref StyleValue<T> target);
public method ApplyCustomProperty(propertyName: string, ref target: StyleValue<string>): void;
public void ApplyCustomProperty(string propertyName, ref StyleValue<string> target);

Parameters

propertyNameName of the property in USS.
targetTarget StyleValue<T> field or variable to write to.

Description

Read a style property value into the specified StyleValue<T>.

If the parsed type of the property in USS corresponds to the specificied target value, a simple copy will occur. Otherwise some automatic conversion will happen. If the property value is quoted in USS, the property can be read into a StyleValue<string>, leaving you full control on how to parse the value.

Is something described here not working as you expect it to? It might be a Known Issue. Please check with the Issue Tracker at issuetracker.unity3d.com.

Copyright © 2020 Unity Technologies. Publication Date: 2020-06-05.
TutorialsCommunity AnswersKnowledge BaseForumsAsset StoreLegalPrivacy PolicyCookiesDo Not Sell or Share My Personal Information