Namespace: | Sirenix.OdinInspector |
Assembly: | Sirenix.OdinInspector.Attributes |
[AttributeUsage(AttributeTargets.Assembly | AttributeTargets.Module | AttributeTargets.Class | AttributeTargets.Struct | AttributeTargets.Enum | AttributeTargets.Constructor | AttributeTargets.Method | AttributeTargets.Property | AttributeTargets.Field | AttributeTargets.Event | AttributeTargets.Interface | AttributeTargets.Parameter | AttributeTargets.Delegate | AttributeTargets.ReturnValue | AttributeTargets.GenericParameter | AttributeTargets.All, AllowMultiple = false, Inherited = true)]
[Conditional("UNITY_EDITOR")]
public sealed class DisplayAsStringAttribute : Attribute, _Attribute
DisplayAsString is used on any property, and displays a string in the inspector as text.
Use this for when you want to show a string in the inspector, but not allow for any editing.
DisplayAsString uses the property's ToString method to display the property as a string.
The following example shows how DisplayAsString is used to display a string property as text in the inspector.
public class MyComponent : MonoBehaviour
{
[DisplayAsString]
public string MyInt = 5;
// You can combine with HideLabelAttribute to display a message in the inspector.
[DisplayAsString, HideLabel]
public string MyMessage = "This string will be displayed as text in the inspector";
[DisplayAsString(false)]
public string InlineMessage = "This string is very long, but has been configured to not overflow.";
}
public DisplayAsStringAttribute()
public DisplayAsStringAttribute(bool overflow)
System.Boolean | overflow | Value indicating if the string should overflow past the available space, or expand to multiple lines when there's not enough horizontal space. |
true
, the string will overflow past the drawn space and be clipped when there's not enough space for the text.
If false
the string will expand to multiple lines, if there's not enough space when drawn.
public bool Overflow