Placeholder
A placeholder is the part of a format string between the {braces}.
Read time 2 minutesLast updated 13 days ago
Definition
- Type: Class
- Namespace: Unity.SmartStrings.Core.Parsing
- Assembly: UnityEngine.SmartStringsModule
- Inherits from: FormatItem
public class Placeholder : FormatItem
Remarks
For example, in "{Items.Length,-10:choose(1|2|3):one|two|three}", the Placeholder.Alignments is "-10", the Selectors are "Items" and "Length", separated by the dot "Operator". the Placeholder.FormatterName is "choose", the Placeholder.FormatterOptionsRaw is "1|2|3", and the Placeholder.Format is "one|two|three".
Properties
Property | Description |
|---|---|
| Alignment | Gets or sets the Placeholder.Alignment of the result string, used like with string.Format("{0,-10}"), where -10 is the alignment. |
| Format | Gets or sets the Placeholder.Format of the Placeholder. |
| FormatterName | Gets the name of the formatter. |
| FormatterOptions | Gets the formatter option string unescaped. To get the raw formatter option string, Placeholder.FormatterOptionsRaw. |
| FormatterOptionsRaw | Gets the raw formatter option string as in the input format string (unescaped). |
| NestedDepth | Gets or sets the nesting level of the Placeholder. |
| Parent | Gets the parent Format. |
Methods
Method | Description |
|---|---|
| GetSelectors | Gets an IReadOnlyList_1 of all Selectors within the Placeholder. |
| Initialize | Initializes the instance of Placeholder. |
| ReturnToPool | Return items we own to the object pools. This method gets called by LiteralTextPool when it releases an instance. |
| ToString | Gets the string representation of the Placeholder with all parsed components. |