Version: Unity 6.7 Alpha (6000.7)
LanguageEnglish
  • C#

SmartFormatter.Format

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

Declaration

public string Format(string format, params Object[] args);

Parameters

Parameter Description
format A composite format string.
args The object to format.

Returns

string Returns the formatted input with items replaced with their string representation.

Description

Replaces one or more format items in a specified string with the string representation of a specific object.

Declaration

public string Format(string format, IList<Object> args);

Parameters

Parameter Description
format A composite format string.
args The object to format.

Returns

string Returns the formatted input with items replaced with their string representation.

Description

Replaces one or more format items in a specified string with the string representation of a specific object.

Declaration

public string Format(IFormatProvider provider, string format, params Object[] args);

Parameters

Parameter Description
provider The IFormatProvider to use.
format A composite format string.
args The object to format.

Returns

string Returns the formatted input with items replaced with their string representation.

Description

Replaces one or more format items in a specified string with the string representation of a specific object.

Declaration

public string Format(IFormatProvider provider, string format, IList<Object> args);

Parameters

Parameter Description
provider The IFormatProvider to use.
format A composite format string.
args The object to format.

Returns

string Returns the formatted input with items replaced with their string representation.

Description

Replaces one or more format items in a specified string with the string representation of a specific object.

Declaration

public string Format(Format formatParsed, params Object[] args);

Parameters

Parameter Description
formatParsed An instance of Format that was returned by Parser.ParseFormat.
args The object to format.

Returns

string Returns the formatted input with items replaced with their string representation.

Description

Replaces one or more format items in a specified string with the string representation of a specific object.

Declaration

public string Format(Format formatParsed, IList<Object> args);

Parameters

Parameter Description
formatParsed An instance of Format that was returned by Parser.ParseFormat.
args The object to format.

Returns

string Returns the formatted input with items replaced with their string representation.

Description

Replaces one or more format items in a specified string with the string representation of a specific object.

Declaration

public string Format(IFormatProvider provider, Format formatParsed, params Object[] args);

Parameters

Parameter Description
provider The IFormatProvider to use.
formatParsed An instance of Format that was returned by Parser.ParseFormat.
args The object to format.

Returns

string Returns the formatted input with items replaced with their string representation.

Description

Replaces one or more format items in a specified string with the string representation of a specific object.

Declaration

public string Format(IFormatProvider provider, Format formatParsed, IList<Object> args);

Parameters

Parameter Description
provider The IFormatProvider to use.
formatParsed An instance of Format that was returned by Parser.ParseFormat.
args The object to format.

Returns

string Returns the formatted input with items replaced with their string representation.

Description

Replaces one or more format items in a specified string with the string representation of a specific object.

Declaration

public void Format(FormattingInfo formattingInfo);

Parameters

Parameter Description
formattingInfo Formatting context to process.

Description

Formats the specified FormattingInfo.

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 ©2005-2026 Unity Technologies. All rights reserved. Built from job ID 72205858. Built on: 2026-07-24.
Tutorials Community Answers Knowledge Base Forums Asset Store Terms of use Legal Privacy Policy Cookies Do Not Sell or Share My Personal Information