# SubStringFormatter

> Outputs part of an input string.

## Definition

* **Type:** Class
* **Namespace:** [Unity.SmartStrings.Extensions](/engine/6000.7/script-reference/unity/smartstrings/extensions.md)
* **Assembly:** UnityEngine.SmartStringsModule
* **Inherits from:** [FormatterBase](/engine/6000.7/script-reference/unity/smartstrings/core/extensions/formatterbase.md)
* **Implements:** [IFormatter](/engine/6000.7/script-reference/unity/smartstrings/core/extensions/iformatter.md)

```csharp
public class SubStringFormatter : FormatterBase, IFormatter
```

## Properties

| Property                                                                                                                     | Description                                                                                                                                                                                                                                                                 |
| ---------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [NullDisplayString](/engine/6000.7/script-reference/unity/smartstrings/extensions/substringformatter/nulldisplaystring.md)   | The string to display for NULL values, defaults to `(null)`.                                                                                                                                                                                                                |
| [OutOfRangeBehavior](/engine/6000.7/script-reference/unity/smartstrings/extensions/substringformatter/outofrangebehavior.md) | The behavior when start index and/or length are too big, defaults to [SubStringFormatter.SubStringOutOfRangeBehavior.ReturnEmptyString](/engine/6000.7/script-reference/unity/smartstrings/extensions/substringformatter/substringoutofrangebehavior/returnemptystring.md). |
| [SplitChar](/engine/6000.7/script-reference/unity/smartstrings/extensions/substringformatter/splitchar.md)                   | The character used to split the option text literals. Valid characters are: \| (pipe) , (comma)  \~ (tilde)                                                                                                                                                                 |

## Enums

| Enum                                                                                                                                                              | Description                                                        |
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------ |
| [SubStringFormatter.SubStringOutOfRangeBehavior](/engine/6000.7/script-reference/unity/smartstrings/extensions/substringformatter/substringoutofrangebehavior.md) | Specifies behavior when start index and/or length is out of range. |

## Inheritance

**Inherited Members:**

* [FormatterBase.DefaultName()](/engine/6000.7/script-reference/unity/smartstrings/core/extensions/formatterbase/defaultname.md)