image/svg+xml
docs.unity3d.com
  • Manual
  • Scripting API
  • Changelog
  • License
    Show / Hide Table of Contents
    • Unity​Editor.​UIElements
      • Base​Composite​Field<TValue​Type, TField, TField​Value>
      • Base​Field​Mouse​Dragger
      • Base​Mask​Field<TChoice>
      • Base​Popup​Field<TValue​Type, TValue​Choice>
      • Binding​Extensions
      • Bounds​Field
      • Bounds​Field.​Uxml​Factory
      • Bounds​Field.​Uxml​Traits
      • Bounds​Int​Field
      • Bounds​Int​Field.​Uxml​Factory
      • Bounds​Int​Field.​Uxml​Traits
      • Color​Field
      • Color​Field.​Uxml​Factory
      • Color​Field.​Uxml​Traits
      • Curve​Field
      • Curve​Field.​Render​Mode
      • Curve​Field.​Uxml​Factory
      • Curve​Field.​Uxml​Traits
      • Delta​Speed
      • Double​Field
      • Double​Field.​Uxml​Factory
      • Double​Field.​Uxml​Traits
      • Enum​Field
      • Enum​Field.​Uxml​Factory
      • Enum​Field.​Uxml​Traits
      • Enum​Flags​Field
      • Enum​Flags​Field.​Uxml​Factory
      • Enum​Flags​Field.​Uxml​Traits
      • Field​Mouse​Dragger<T>
      • Float​Field
      • Float​Field.​Uxml​Factory
      • Float​Field.​Uxml​Traits
      • Gradient​Field
      • Gradient​Field.​Uxml​Factory
      • Gradient​Field.​Uxml​Traits
      • Hash128Field
      • Hash128Field.​Uxml​Factory
      • Hash128Field.​Uxml​Traits
      • Inspector​Element
      • Inspector​Element.​Uxml​Factory
      • Inspector​Element.​Uxml​Traits
      • Integer​Field
      • Integer​Field.​Uxml​Factory
      • Integer​Field.​Uxml​Traits
      • IToolbar​Menu​Element
      • IValue​Field<T>
      • Layer​Field
      • Layer​Field.​Uxml​Factory
      • Layer​Field.​Uxml​Traits
      • Layer​Mask​Field
      • Layer​Mask​Field.​Uxml​Factory
      • Layer​Mask​Field.​Uxml​Traits
      • Long​Field
      • Long​Field.​Uxml​Factory
      • Long​Field.​Uxml​Traits
      • Mask​Field
      • Mask​Field.​Uxml​Factory
      • Mask​Field.​Uxml​Traits
      • Object​Field
      • Object​Field.​Uxml​Factory
      • Object​Field.​Uxml​Traits
      • Popup​Field<T>
      • Property​Field
      • Property​Field.​Uxml​Factory
      • Property​Field.​Uxml​Traits
      • Rect​Field
      • Rect​Field.​Uxml​Factory
      • Rect​Field.​Uxml​Traits
      • Rect​Int​Field
      • Rect​Int​Field.​Uxml​Factory
      • Rect​Int​Field.​Uxml​Traits
      • Search​Field​Base<Text​Input​Type, T>
      • Tag​Field
      • Tag​Field.​Uxml​Factory
      • Tag​Field.​Uxml​Traits
      • Text​Value​Field<TValue​Type>
      • Text​Value​Field<TValue​Type>.​Text​Value​Input
      • Text​Value​Field​Traits<TValue​Type, TValue​Uxml​Attribute​Type>
      • Toolbar
      • Toolbar.​Uxml​Factory
      • Toolbar​Breadcrumbs
      • Toolbar​Breadcrumbs.​Uxml​Factory
      • Toolbar​Button
      • Toolbar​Button.​Uxml​Factory
      • Toolbar​Button.​Uxml​Traits
      • Toolbar​Menu
      • Toolbar​Menu.​Uxml​Factory
      • Toolbar​Menu.​Uxml​Traits
      • Toolbar​Menu.​Variant
      • Toolbar​Menu​Element​Extensions
      • Toolbar​Popup​Search​Field
      • Toolbar​Popup​Search​Field.​Uxml​Factory
      • Toolbar​Search​Field
      • Toolbar​Search​Field.​Uxml​Factory
      • Toolbar​Spacer
      • Toolbar​Spacer.​Uxml​Factory
      • Toolbar​Toggle
      • Toolbar​Toggle.​Uxml​Factory
      • Toolbar​Toggle.​Uxml​Traits
      • Uxml​Namespace​Prefix​Attribute
      • Vector2Field
      • Vector2Field.​Uxml​Factory
      • Vector2Field.​Uxml​Traits
      • Vector2Int​Field
      • Vector2Int​Field.​Uxml​Factory
      • Vector2Int​Field.​Uxml​Traits
      • Vector3Field
      • Vector3Field.​Uxml​Factory
      • Vector3Field.​Uxml​Traits
      • Vector3Int​Field
      • Vector3Int​Field.​Uxml​Factory
      • Vector3Int​Field.​Uxml​Traits
      • Vector4Field
      • Vector4Field.​Uxml​Factory
      • Vector4Field.​Uxml​Traits
    • Unity​Engine.​UIElements
      • Abstract​Progress​Bar
      • Abstract​Progress​Bar.​Uxml​Traits
      • Align
      • Alternating​Row​Background
      • Attach​To​Panel​Event
      • Background
      • Base​Bool​Field
      • Base​Field<TValue​Type>
      • Base​Field<TValue​Type>.​Uxml​Traits
      • Base​Field​Traits<TValue​Type, TValue​Uxml​Attribute​Type>
      • Base​Slider<TValue​Type>
      • Bindable​Element
      • Bindable​Element.​Uxml​Factory
      • Bindable​Element.​Uxml​Traits
      • Blur​Event
      • Box
      • Box.​Uxml​Factory
      • Button
      • Button.​Uxml​Factory
      • Button.​Uxml​Traits
      • Callback​Event​Handler
      • Change​Event<T>
      • Clickable
      • Click​Event
      • Command​Event​Base<T>
      • Context​Click​Event
      • Context​Type
      • Contextual​Menu​Manager
      • Contextual​Menu​Manipulator
      • Contextual​Menu​Populate​Event
      • Creation​Context
      • Cursor
      • Custom​Style​Property<T>
      • Custom​Style​Resolved​Event
      • Detach​From​Panel​Event
      • Display​Style
      • Dropdown​Field
      • Dropdown​Field.​Uxml​Factory
      • Dropdown​Field.​Uxml​Traits
      • Dropdown​Menu
      • Dropdown​Menu​Action
      • Dropdown​Menu​Action.​Status
      • Dropdown​Menu​Event​Info
      • Dropdown​Menu​Item
      • Dropdown​Menu​Separator
      • Dynamic​Atlas​Custom​Filter
      • Dynamic​Atlas​Filters
      • Dynamic​Atlas​Settings
      • Event​Base
      • Event​Base<T>
      • Event​Callback<TEvent​Type, TCallback​Args>
      • Event​Callback<TEvent​Type>
      • Event​Dispatcher
      • Event​Dispatcher​Gate
      • Execute​Command​Event
      • Flex​Direction
      • Focusable
      • Focus​Change​Direction
      • Focus​Controller
      • Focus​Event
      • Focus​Event​Base<T>
      • Focus​In​Event
      • Focus​Out​Event
      • Foldout
      • Foldout.​Uxml​Factory
      • Foldout.​Uxml​Traits
      • Font​Definition
      • Generic​Dropdown​Menu
      • Geometry​Changed​Event
      • Group​Box
      • Group​Box.​Uxml​Factory
      • Group​Box.​Uxml​Traits
      • Help​Box
      • Help​Box.​Uxml​Factory
      • Help​Box.​Uxml​Traits
      • Help​Box​Message​Type
      • IBindable
      • IBinding
      • IBinding​Extensions
      • IChange​Event
      • ICommand​Event
      • ICustom​Style
      • IEvent​Handler
      • IExperimental​Features
      • IFocus​Event
      • IFocus​Ring
      • IKeyboard​Event
      • Image
      • Image.​Uxml​Factory
      • Image.​Uxml​Traits
      • IManipulator
      • IMGUIContainer
      • IMGUIContainer.​Uxml​Factory
      • IMGUIContainer.​Uxml​Traits
      • IMGUIEvent
      • IMixed​Value​Support
      • Immediate​Mode​Element
      • IMouse​Capture​Event
      • IMouse​Event
      • INavigation​Event
      • INotify​Value​Changed<T>
      • INotify​Value​Changed​Extensions
      • Input​Event
      • Input​Wrapper
      • IPanel
      • IPanel​Changed​Event
      • IPointer​Capture​Event
      • IPointer​Event
      • IResolved​Style
      • IStyle
      • ITransform
      • IUxml​Attributes
      • IUxml​Factory
      • IVisual​Element​Scheduled​Item
      • IVisual​Element​Scheduler
      • Justify
      • Keyboard​Event​Base<T>
      • Keyboard​Navigation​Manipulator
      • Keyboard​Navigation​Operation
      • Key​Down​Event
      • Key​Up​Event
      • Label
      • Label.​Uxml​Factory
      • Label.​Uxml​Traits
      • Length
      • Length​Unit
      • List​View
      • List​View.​Uxml​Factory
      • List​View.​Uxml​Traits
      • Manipulator
      • Manipulator​Activation​Filter
      • Mesh​Generation​Context
      • Mesh​Write​Data
      • Min​Max​Slider
      • Min​Max​Slider.​Uxml​Factory
      • Min​Max​Slider.​Uxml​Traits
      • Mouse​Button
      • Mouse​Capture​Controller
      • Mouse​Capture​Event
      • Mouse​Capture​Event​Base<T>
      • Mouse​Capture​Out​Event
      • Mouse​Down​Event
      • Mouse​Enter​Event
      • Mouse​Enter​Window​Event
      • Mouse​Event​Base<T>
      • Mouse​Leave​Event
      • Mouse​Leave​Window​Event
      • Mouse​Manipulator
      • Mouse​Move​Event
      • Mouse​Out​Event
      • Mouse​Over​Event
      • Mouse​Up​Event
      • Navigation​Cancel​Event
      • Navigation​Event​Base<T>
      • Navigation​Move​Event
      • Navigation​Move​Event.​Direction
      • Navigation​Submit​Event
      • Overflow
      • Overflow​Clip​Box
      • Panel​Changed​Event​Base<T>
      • Panel​Scale​Mode
      • Panel​Screen​Match​Mode
      • Panel​Settings
      • Panel​Text​Settings
      • Picking​Mode
      • Pointer​Cancel​Event
      • Pointer​Capture​Event
      • Pointer​Capture​Event​Base<T>
      • Pointer​Capture​Helper
      • Pointer​Capture​Out​Event
      • Pointer​Down​Event
      • Pointer​Enter​Event
      • Pointer​Event​Base<T>
      • Pointer​Id
      • Pointer​Leave​Event
      • Pointer​Manipulator
      • Pointer​Move​Event
      • Pointer​Out​Event
      • Pointer​Over​Event
      • Pointer​Stationary​Event
      • Pointer​Type
      • Pointer​Up​Event
      • Popup​Window
      • Popup​Window.​Uxml​Factory
      • Popup​Window.​Uxml​Traits
      • Position
      • Progress​Bar
      • Progress​Bar.​Uxml​Factory
      • Propagation​Phase
      • Radio​Button
      • Radio​Button.​Uxml​Factory
      • Radio​Button.​Uxml​Traits
      • Radio​Button​Group
      • Radio​Button​Group.​Uxml​Factory
      • Radio​Button​Group.​Uxml​Traits
      • Repeat​Button
      • Repeat​Button.​Uxml​Factory
      • Repeat​Button.​Uxml​Traits
      • Runtime​Panel​Utils
      • Scroller
      • Scroller.​Uxml​Factory
      • Scroller.​Uxml​Traits
      • Scroller​Visibility
      • Scroll​View
      • Scroll​View.​Touch​Scroll​Behavior
      • Scroll​View.​Uxml​Factory
      • Scroll​View.​Uxml​Traits
      • Scroll​View​Mode
      • Selection​Type
      • Slider
      • Slider.​Uxml​Factory
      • Slider.​Uxml​Traits
      • Slider​Direction
      • Slider​Int
      • Slider​Int.​Uxml​Factory
      • Slider​Int.​Uxml​Traits
      • Style​Background
      • Style​Color
      • Style​Cursor
      • Style​Enum<T>
      • Style​Float
      • Style​Font
      • Style​Font​Definition
      • Style​Int
      • Style​Keyword
      • Style​Length
      • Style​Sheet
      • Style​Text​Shadow
      • Template​Container
      • Template​Container.​Uxml​Factory
      • Template​Container.​Uxml​Traits
      • Text​Element
      • Text​Element.​Uxml​Factory
      • Text​Element.​Uxml​Traits
      • Text​Field
      • Text​Field.​Uxml​Factory
      • Text​Field.​Uxml​Traits
      • Text​Input​Base​Field<TValue​Type>
      • Text​Input​Base​Field<TValue​Type>.​Text​Input​Base
      • Text​Input​Base​Field<TValue​Type>.​Uxml​Traits
      • Text​Overflow
      • Text​Overflow​Position
      • Text​Shadow
      • Theme​Style​Sheet
      • Timer​State
      • Toggle
      • Toggle.​Uxml​Factory
      • Toggle.​Uxml​Traits
      • Tooltip​Event
      • Trickle​Down
      • Two​Pane​Split​View
      • Two​Pane​Split​View.​Uxml​Factory
      • Two​Pane​Split​View.​Uxml​Traits
      • Two​Pane​Split​View​Orientation
      • Typed​Uxml​Attribute​Description<T>
      • UIDocument
      • UQuery
      • UQuery​Builder<T>
      • UQuery​Extensions
      • UQuery​State<T>
      • UQuery​State<T>.​Enumerator
      • Usage​Hints
      • Uxml​Attribute​Description
      • Uxml​Attribute​Description.​Use
      • Uxml​Attribute​Overrides​Factory
      • Uxml​Attribute​Overrides​Traits
      • Uxml​Bool​Attribute​Description
      • Uxml​Child​Element​Description
      • Uxml​Color​Attribute​Description
      • Uxml​Double​Attribute​Description
      • Uxml​Enum​Attribute​Description<T>
      • Uxml​Enumeration
      • Uxml​Factory<TCreated​Type, TTraits>
      • Uxml​Factory<TCreated​Type>
      • Uxml​Float​Attribute​Description
      • Uxml​Hash128Attribute​Description
      • Uxml​Int​Attribute​Description
      • Uxml​Long​Attribute​Description
      • Uxml​Root​Element​Factory
      • Uxml​Root​Element​Traits
      • Uxml​String​Attribute​Description
      • Uxml​Style​Factory
      • Uxml​Style​Traits
      • Uxml​Template​Factory
      • Uxml​Template​Traits
      • Uxml​Traits
      • Uxml​Type​Attribute​Description<TBase>
      • Uxml​Type​Restriction
      • Uxml​Value​Bounds
      • Uxml​Value​Matches
      • Validate​Command​Event
      • Vector​Image
      • Vertex
      • Visibility
      • Visual​Element
      • Visual​Element.​Hierarchy
      • Visual​Element.​Measure​Mode
      • Visual​Element.​Uxml​Factory
      • Visual​Element.​Uxml​Traits
      • Visual​Element​Extensions
      • Visual​Element​Focus​Change​Direction
      • Visual​Element​Focus​Ring
      • Visual​Element​Focus​Ring.​Default​Focus​Order
      • Visual​Element​Style​Sheet​Set
      • Visual​Tree​Asset
      • Wheel​Event
      • White​Space
      • Wrap
    • Unity​Engine.​UIElements.​Experimental
      • Easing
      • ITransition​Animations
      • IValue​Animation
      • Style​Values
      • Value​Animation<T>
    • Unity​Engine.​UIElements.​Input​System
      • Input​System​Event​System
    • Scripting API
    • Unity​Engine.​UIElements
    • Style​Length

    Struct StyleLength

    Style value that can be either a Length or a StyleKeyword.

    Namespace: UnityEngine.UIElements
    Syntax
    public struct StyleLength : IStyleValue<Length>, IEquatable<StyleLength>

    Constructors

    StyleLength(Single)

    Creates from either a Length or a StyleKeyword.

    Declaration
    public StyleLength(float v)
    Parameters
    Type Name Description
    Single v

    StyleLength(Length)

    Creates from either a Length or a StyleKeyword.

    Declaration
    public StyleLength(Length v)
    Parameters
    Type Name Description
    Length v

    StyleLength(StyleKeyword)

    Creates from either a Length or a StyleKeyword.

    Declaration
    public StyleLength(StyleKeyword keyword)
    Parameters
    Type Name Description
    StyleKeyword keyword

    Properties

    keyword

    The style keyword.

    Declaration
    public StyleKeyword keyword { get; set; }
    Property Value
    Type Description
    StyleKeyword

    value

    The Length value.

    Declaration
    public Length value { get; set; }
    Property Value
    Type Description
    Length

    Methods

    Equals(Object)

    Declaration
    public override bool Equals(object obj)
    Parameters
    Type Name Description
    Object obj
    Returns
    Type Description
    Boolean

    Equals(StyleLength)

    Declaration
    public bool Equals(StyleLength other)
    Parameters
    Type Name Description
    StyleLength other
    Returns
    Type Description
    Boolean

    GetHashCode()

    Declaration
    public override int GetHashCode()
    Returns
    Type Description
    Int32

    ToString()

    Declaration
    public override string ToString()
    Returns
    Type Description
    String

    Operators

    Equality(StyleLength, StyleLength)

    Declaration
    public static bool operator ==(StyleLength lhs, StyleLength rhs)
    Parameters
    Type Name Description
    StyleLength lhs
    StyleLength rhs
    Returns
    Type Description
    Boolean

    Implicit(Single to StyleLength)

    Declaration
    public static implicit operator StyleLength(float v)
    Parameters
    Type Name Description
    Single v
    Returns
    Type Description
    StyleLength

    Implicit(Length to StyleLength)

    Declaration
    public static implicit operator StyleLength(Length v)
    Parameters
    Type Name Description
    Length v
    Returns
    Type Description
    StyleLength

    Implicit(StyleKeyword to StyleLength)

    Declaration
    public static implicit operator StyleLength(StyleKeyword keyword)
    Parameters
    Type Name Description
    StyleKeyword keyword
    Returns
    Type Description
    StyleLength

    Inequality(StyleLength, StyleLength)

    Declaration
    public static bool operator !=(StyleLength lhs, StyleLength rhs)
    Parameters
    Type Name Description
    StyleLength lhs
    StyleLength rhs
    Returns
    Type Description
    Boolean
    In This Article
    • Constructors
      • StyleLength(Single)
      • StyleLength(Length)
      • StyleLength(StyleKeyword)
    • Properties
      • keyword
      • value
    • Methods
      • Equals(Object)
      • Equals(StyleLength)
      • GetHashCode()
      • ToString()
    • Operators
      • Equality(StyleLength, StyleLength)
      • Implicit(Single to StyleLength)
      • Implicit(Length to StyleLength)
      • Implicit(StyleKeyword to StyleLength)
      • Inequality(StyleLength, StyleLength)
    Back to top
    Copyright © 2023 Unity Technologies — Terms of use
    • Legal
    • Privacy Policy
    • Cookies
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)
    "Unity", Unity logos, and other Unity trademarks are trademarks or registered trademarks of Unity Technologies or its affiliates in the U.S. and elsewhere (more info here). Other names or brands are trademarks of their respective owners.
    Generated by DocFX on 18 October 2023