Documentation

Unity Engine


User Manual

Script Reference

Unity Engine


FormattingInfo

The class contains the fields and methods which are necessary for formatting.
Read time 1 minuteLast updated 12 days ago

Definition

public class FormattingInfo : IFormattingInfo, ISelectorInfo

Properties

Property

Description

AlignmentThe alignment of the current Placeholder, or, if that is
null
, the alignment inherited from the nearest parent IFormattingInfo whose alignment is not zero.
CurrentValueThe current value being formatted.
FormatThe parsed format that specifies how to output the current value.
FormatDetailsExtra details shared across the current formatting operation.
FormatterOptionsThe formatter options of the current Placeholder.
ParentThe parent FormattingInfo that created this instance.
PlaceholderThe Placeholder currently being formatted.
ResultThe result after an ISource has assigned a value.
SelectorThe Selector currently being evaluated.
SelectorIndexThe index of the current Selector in the selector list.
SelectorOperatorThe operator string of the current Selector, for example a comma or dot.
SelectorTextThe raw text of the current Selector.

Methods

Method

Description

CreateChildCreates a child IFormattingInfo from the current IFormattingInfo instance for a FormattingInfo.Placeholder.
FormatAsChildCreates a child IFormattingInfo from the current IFormattingInfo instance and invokes formatting with SmartFormatter and with the child as parameter.
FormattingExceptionCreates a new FormattingInfo.FormattingException.
InitializeInitializes this formatting info with the details required for formatting.
ReturnToPoolReturns this instance and its FormattingInfo children to the object pool. This method gets called by FormattingInfoPool when it releases an instance.
WriteWrites the ReadOnlySpan_1 text parameter to the IOutput and takes care of alignment.