SmartFormatter

Constructs formatted strings by invoking each registered source and formatter extension.

Read time 1 minute

Last updated 6 days ago

Definition


public class SmartFormatter : ISerializationCallbackReceiver

Constructor	Description
SmartFormatter(Unity.SmartStrings.Core.Settings.SmartSettings)	Creates a formatter that uses the specified settings.

Property	Description
Parser	The Parser this formatter uses to parse format strings.
Settings	The SmartSettings that control parsing and formatting for this formatter.

Method	Description
AddExtensions	Adds IFormatter extensions to the SmartFormatter.GetFormatterExtensions list of this formatter, if the Type has not been added before. Formatters are inserted at the recommended position, all others are added at the end of the list.
Format	Replaces one or more format items in a specified string with the string representation of a specific object.
FormatInto	Writes the formatting result into an IOutput instance.
GetFormatterExtension	Searches for a Formatter Extension of the given type, and returns it. Returns `null` if the type cannot be found.
GetFormatterExtensions	Gets the IFormatter formatter extensions registered with this formatter.
GetSourceExtension	Searches for a Source Extension of the given type, and returns it. Returns `null` if the type cannot be found.
GetSourceExtensions	Gets the ISource source extensions registered with this formatter.
InsertExtension	Adds the IFormatter extension at the `position` of the SmartFormatter.GetFormatterExtensions list of this formatter, if the Type has not been added before. If the extension implements IInitializer, IInitializer.Initialize will be invoked.
RemoveFormatterExtension	Removes the Formatter Extension of the given type.
RemoveSourceExtension	Removes Source Extension of the given type.

Member	Description
OnFormattingFailure	Raised when an error occurs during formatting.