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

FormatItem

class in Unity.SmartStrings.Core.Parsing

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

Description

Base class that represents a substring of text from a parsed format string.

Properties

Property Description
BaseString Gets the base format string.
EndIndex The end index is pointing to ONE POSITION AFTER the last character of item.
Length Gets the result of FormatItem.EndIndex minus FormatItem.StartIndex.
ParentFormatItem The parent FormatItem of this instance, null if no parent exists.
RawText Retrieves the raw text that this item represents.
SmartSettings The settings for formatter and parser.
StartIndex The start index is pointing to the first character of item.

Public Methods

Method Description
AsSpan Gets the ReadOnlySpan_1 representation of this FormatItem.
Clear Clears the FormatItem or the derived class.
ToString Gets the string representation of this FormatItem.

Protected Methods

Method Description
Initialize Initializes the FormatItem or the derived class.