docs.unity3d.com
    Show / Hide Table of Contents

    Class ScrollView

    Displays its contents inside a scrollable frame.

    Inheritance
    Object
    CallbackEventHandler
    Focusable
    VisualElement
    ScrollView
    Inherited Members
    VisualElement.disabledUssClassName
    VisualElement.viewDataKey
    VisualElement.userData
    VisualElement.canGrabFocus
    VisualElement.focusController
    VisualElement.usageHints
    VisualElement.transform
    VisualElement.ITransform.position
    VisualElement.ITransform.rotation
    VisualElement.ITransform.scale
    VisualElement.ITransform.matrix
    VisualElement.layout
    VisualElement.contentRect
    VisualElement.paddingRect
    VisualElement.worldBound
    VisualElement.localBound
    VisualElement.worldTransform
    VisualElement.pickingMode
    VisualElement.name
    VisualElement.ExecuteDefaultAction(EventBase)
    VisualElement.Focus()
    VisualElement.SendEvent(EventBase)
    VisualElement.SetEnabledFromHierarchy(Boolean)
    VisualElement.enabledInHierarchy
    VisualElement.enabledSelf
    VisualElement.SetEnabled(Boolean)
    VisualElement.visible
    VisualElement.MarkDirtyRepaint()
    VisualElement.generateVisualContent
    VisualElement.ContainsPoint(Vector2)
    VisualElement.Overlaps(Rect)
    VisualElement.DoMeasure(Single, VisualElement.MeasureMode, Single, VisualElement.MeasureMode)
    VisualElement.ToString()
    VisualElement.GetClasses()
    VisualElement.ClearClassList()
    VisualElement.AddToClassList(String)
    VisualElement.RemoveFromClassList(String)
    VisualElement.ToggleInClassList(String)
    VisualElement.EnableInClassList(String, Boolean)
    VisualElement.ClassListContains(String)
    VisualElement.FindAncestorUserData()
    VisualElement.ITransitionAnimations.Start(Single, Single, Int32, Action<VisualElement, Single>)
    VisualElement.ITransitionAnimations.Start(Rect, Rect, Int32, Action<VisualElement, Rect>)
    VisualElement.ITransitionAnimations.Start(Color, Color, Int32, Action<VisualElement, Color>)
    VisualElement.ITransitionAnimations.Start(Vector3, Vector3, Int32, Action<VisualElement, Vector3>)
    VisualElement.ITransitionAnimations.Start(Vector2, Vector2, Int32, Action<VisualElement, Vector2>)
    VisualElement.ITransitionAnimations.Start(Quaternion, Quaternion, Int32, Action<VisualElement, Quaternion>)
    VisualElement.ITransitionAnimations.Start(StyleValues, StyleValues, Int32)
    VisualElement.ITransitionAnimations.Start(Func<VisualElement, Single>, Single, Int32, Action<VisualElement, Single>)
    VisualElement.ITransitionAnimations.Start(Func<VisualElement, Rect>, Rect, Int32, Action<VisualElement, Rect>)
    VisualElement.ITransitionAnimations.Start(Func<VisualElement, Color>, Color, Int32, Action<VisualElement, Color>)
    VisualElement.ITransitionAnimations.Start(Func<VisualElement, Vector3>, Vector3, Int32, Action<VisualElement, Vector3>)
    VisualElement.ITransitionAnimations.Start(Func<VisualElement, Vector2>, Vector2, Int32, Action<VisualElement, Vector2>)
    VisualElement.ITransitionAnimations.Start(Func<VisualElement, Quaternion>, Quaternion, Int32, Action<VisualElement, Quaternion>)
    VisualElement.ITransitionAnimations.Start(StyleValues, Int32)
    VisualElement.ITransitionAnimations.Layout(Rect, Int32)
    VisualElement.ITransitionAnimations.TopLeft(Vector2, Int32)
    VisualElement.ITransitionAnimations.Size(Vector2, Int32)
    VisualElement.ITransitionAnimations.Scale(Single, Int32)
    VisualElement.ITransitionAnimations.Position(Vector3, Int32)
    VisualElement.ITransitionAnimations.Rotation(Quaternion, Int32)
    VisualElement.experimental
    VisualElement.IExperimentalFeatures.animation
    VisualElement.hierarchy
    VisualElement.cacheAsBitmap
    VisualElement.parent
    VisualElement.panel
    VisualElement.visualTreeAssetSource
    VisualElement.Add(VisualElement)
    VisualElement.Insert(Int32, VisualElement)
    VisualElement.Remove(VisualElement)
    VisualElement.RemoveAt(Int32)
    VisualElement.Clear()
    VisualElement.ElementAt(Int32)
    VisualElement.Item[Int32]
    VisualElement.childCount
    VisualElement.IndexOf(VisualElement)
    VisualElement.Children()
    VisualElement.Sort(Comparison<VisualElement>)
    VisualElement.BringToFront()
    VisualElement.SendToBack()
    VisualElement.PlaceBehind(VisualElement)
    VisualElement.PlaceInFront(VisualElement)
    VisualElement.RemoveFromHierarchy()
    VisualElement.GetFirstOfType<T>()
    VisualElement.GetFirstAncestorOfType<T>()
    VisualElement.Contains(VisualElement)
    VisualElement.FindCommonAncestor(VisualElement)
    VisualElement.schedule
    VisualElement.IVisualElementScheduler.Execute(Action<TimerState>)
    VisualElement.IVisualElementScheduler.Execute(Action)
    VisualElement.style
    VisualElement.customStyle
    VisualElement.styleSheets
    VisualElement.tooltip
    VisualElement.resolvedStyle
    VisualElement.IResolvedStyle.alignContent
    VisualElement.IResolvedStyle.alignItems
    VisualElement.IResolvedStyle.alignSelf
    VisualElement.IResolvedStyle.backgroundColor
    VisualElement.IResolvedStyle.backgroundImage
    VisualElement.IResolvedStyle.borderBottomColor
    VisualElement.IResolvedStyle.borderBottomLeftRadius
    VisualElement.IResolvedStyle.borderBottomRightRadius
    VisualElement.IResolvedStyle.borderBottomWidth
    VisualElement.IResolvedStyle.borderLeftColor
    VisualElement.IResolvedStyle.borderLeftWidth
    VisualElement.IResolvedStyle.borderRightColor
    VisualElement.IResolvedStyle.borderRightWidth
    VisualElement.IResolvedStyle.borderTopColor
    VisualElement.IResolvedStyle.borderTopLeftRadius
    VisualElement.IResolvedStyle.borderTopRightRadius
    VisualElement.IResolvedStyle.borderTopWidth
    VisualElement.IResolvedStyle.bottom
    VisualElement.IResolvedStyle.color
    VisualElement.IResolvedStyle.display
    VisualElement.IResolvedStyle.flexBasis
    VisualElement.IResolvedStyle.flexDirection
    VisualElement.IResolvedStyle.flexGrow
    VisualElement.IResolvedStyle.flexShrink
    VisualElement.IResolvedStyle.flexWrap
    VisualElement.IResolvedStyle.fontSize
    VisualElement.IResolvedStyle.height
    VisualElement.IResolvedStyle.justifyContent
    VisualElement.IResolvedStyle.left
    VisualElement.IResolvedStyle.letterSpacing
    VisualElement.IResolvedStyle.marginBottom
    VisualElement.IResolvedStyle.marginLeft
    VisualElement.IResolvedStyle.marginRight
    VisualElement.IResolvedStyle.marginTop
    VisualElement.IResolvedStyle.maxHeight
    VisualElement.IResolvedStyle.maxWidth
    VisualElement.IResolvedStyle.minHeight
    VisualElement.IResolvedStyle.minWidth
    VisualElement.IResolvedStyle.opacity
    VisualElement.IResolvedStyle.paddingBottom
    VisualElement.IResolvedStyle.paddingLeft
    VisualElement.IResolvedStyle.paddingRight
    VisualElement.IResolvedStyle.paddingTop
    VisualElement.IResolvedStyle.position
    VisualElement.IResolvedStyle.right
    VisualElement.IResolvedStyle.textOverflow
    VisualElement.IResolvedStyle.top
    VisualElement.IResolvedStyle.unityBackgroundImageTintColor
    VisualElement.IResolvedStyle.unityBackgroundScaleMode
    VisualElement.IResolvedStyle.unityFont
    VisualElement.IResolvedStyle.unityFontDefinition
    VisualElement.IResolvedStyle.unityFontStyleAndWeight
    VisualElement.IResolvedStyle.unityParagraphSpacing
    VisualElement.IResolvedStyle.unitySliceBottom
    VisualElement.IResolvedStyle.unitySliceLeft
    VisualElement.IResolvedStyle.unitySliceRight
    VisualElement.IResolvedStyle.unitySliceTop
    VisualElement.IResolvedStyle.unityTextAlign
    VisualElement.IResolvedStyle.unityTextOutlineColor
    VisualElement.IResolvedStyle.unityTextOutlineWidth
    VisualElement.IResolvedStyle.unityTextOverflowPosition
    VisualElement.IResolvedStyle.visibility
    VisualElement.IResolvedStyle.whiteSpace
    VisualElement.IResolvedStyle.width
    VisualElement.IResolvedStyle.wordSpacing
    Focusable.focusable
    Focusable.tabIndex
    Focusable.delegatesFocus
    Focusable.Blur()
    CallbackEventHandler.RegisterCallback<TEventType>(EventCallback<TEventType>, TrickleDown)
    CallbackEventHandler.RegisterCallback<TEventType, TUserArgsType>(EventCallback<TEventType, TUserArgsType>, TUserArgsType, TrickleDown)
    CallbackEventHandler.UnregisterCallback<TEventType>(EventCallback<TEventType>, TrickleDown)
    CallbackEventHandler.UnregisterCallback<TEventType, TUserArgsType>(EventCallback<TEventType, TUserArgsType>, TrickleDown)
    CallbackEventHandler.HandleEvent(EventBase)
    CallbackEventHandler.HasTrickleDownHandlers()
    CallbackEventHandler.HasBubbleUpHandlers()
    CallbackEventHandler.ExecuteDefaultActionAtTarget(EventBase)
    Namespace: UnityEngine.UIElements
    Syntax
    public class ScrollView : VisualElement, IEventHandler, ITransform, ITransitionAnimations, IExperimentalFeatures, IVisualElementScheduler, IResolvedStyle

    Constructors

    ScrollView()

    Constructor.

    Declaration
    public ScrollView()

    ScrollView(ScrollViewMode)

    Constructor.

    Declaration
    public ScrollView(ScrollViewMode scrollViewMode)
    Parameters
    Type Name Description
    ScrollViewMode scrollViewMode

    Fields

    contentAndVerticalScrollUssClassName

    USS class name of content elements in elements of this type.

    Declaration
    public static readonly string contentAndVerticalScrollUssClassName
    Field Value
    Type Description
    String

    contentUssClassName

    USS class name of content elements in elements of this type.

    Declaration
    public static readonly string contentUssClassName
    Field Value
    Type Description
    String

    horizontalVariantUssClassName

    USS class name that's added when the ScrollView is in horizontal mode. Horizontal

    Declaration
    public static readonly string horizontalVariantUssClassName
    Field Value
    Type Description
    String

    hScrollerUssClassName

    USS class name of horizontal scrollers in elements of this type.

    Declaration
    public static readonly string hScrollerUssClassName
    Field Value
    Type Description
    String

    scrollVariantUssClassName

    Declaration
    public static readonly string scrollVariantUssClassName
    Field Value
    Type Description
    String

    ussClassName

    USS class name of elements of this type.

    Declaration
    public static readonly string ussClassName
    Field Value
    Type Description
    String

    verticalHorizontalVariantUssClassName

    USS class name that's added when the ScrollView is in both horizontal and vertical mode. VerticalAndHorizontal

    Declaration
    public static readonly string verticalHorizontalVariantUssClassName
    Field Value
    Type Description
    String

    verticalVariantUssClassName

    USS class name that's added when the ScrollView is in vertical mode. Vertical

    Declaration
    public static readonly string verticalVariantUssClassName
    Field Value
    Type Description
    String

    viewportUssClassName

    USS class name of viewport elements in elements of this type.

    Declaration
    public static readonly string viewportUssClassName
    Field Value
    Type Description
    String

    vScrollerUssClassName

    USS class name of vertical scrollers in elements of this type.

    Declaration
    public static readonly string vScrollerUssClassName
    Field Value
    Type Description
    String

    Properties

    contentContainer

    Contains full content, potentially partially visible.

    Declaration
    public override VisualElement contentContainer { get; }
    Property Value
    Type Description
    VisualElement
    Overrides
    VisualElement.contentContainer

    contentViewport

    Represents the visible part of contentContainer.

    Declaration
    public VisualElement contentViewport { get; }
    Property Value
    Type Description
    VisualElement

    elasticity

    The amount of elasticity to use when a user tries to scroll past the boundaries of the scroll view.

    Declaration
    public float elasticity { get; set; }
    Property Value
    Type Description
    Single
    Remarks

    Elasticity is only used when touchScrollBehavior is set to Elastic.

    horizontalPageSize

    This property is controlling the scrolling speed of the horizontal scroller.

    Declaration
    public float horizontalPageSize { get; set; }
    Property Value
    Type Description
    Single

    horizontalScroller

    Horizontal scrollbar.

    Declaration
    public Scroller horizontalScroller { get; }
    Property Value
    Type Description
    Scroller

    horizontalScrollerVisibility

    Specifies whether the horizontal scroll bar is visible.

    Declaration
    public ScrollerVisibility horizontalScrollerVisibility { get; set; }
    Property Value
    Type Description
    ScrollerVisibility

    scrollDecelerationRate

    Controls the rate at which the scrolling movement slows after a user scrolls using a touch interaction.

    Declaration
    public float scrollDecelerationRate { get; set; }
    Property Value
    Type Description
    Single
    Remarks

    The deceleration rate is the speed reduction per second. A value of 0.5 halves the speed each second. A value of 0 stops the scrolling immediately.

    scrollOffset

    The current scrolling position.

    Declaration
    public Vector2 scrollOffset { get; set; }
    Property Value
    Type Description
    Vector2

    showHorizontal

    Obsolete. Use horizontalScrollerVisibility instead.

    Declaration
    public bool showHorizontal { get; set; }
    Property Value
    Type Description
    Boolean

    showVertical

    Obsolete. Use verticalScrollerVisibility instead.

    Declaration
    public bool showVertical { get; set; }
    Property Value
    Type Description
    Boolean

    touchScrollBehavior

    The behavior to use when a user tries to scroll past the boundaries of the ScrollView content using a touch interaction.

    Declaration
    public ScrollView.TouchScrollBehavior touchScrollBehavior { get; set; }
    Property Value
    Type Description
    ScrollView.TouchScrollBehavior

    verticalPageSize

    This property is controlling the scrolling speed of the vertical scroller.

    Declaration
    public float verticalPageSize { get; set; }
    Property Value
    Type Description
    Single

    verticalScroller

    Vertical Scrollbar.

    Declaration
    public Scroller verticalScroller { get; }
    Property Value
    Type Description
    Scroller

    verticalScrollerVisibility

    Specifies whether the vertical scroll bar is visible.

    Declaration
    public ScrollerVisibility verticalScrollerVisibility { get; set; }
    Property Value
    Type Description
    ScrollerVisibility

    Methods

    ScrollTo(VisualElement)

    Scroll to a specific child element.

    Declaration
    public void ScrollTo(VisualElement child)
    Parameters
    Type Name Description
    VisualElement child

    The child to scroll to.

    Extension Methods

    UQueryExtensions.Q<T>(VisualElement, String, String[])
    UQueryExtensions.Q(VisualElement, String, String[])
    UQueryExtensions.Q<T>(VisualElement, String, String)
    UQueryExtensions.Q(VisualElement, String, String)
    UQueryExtensions.Query(VisualElement, String, String[])
    UQueryExtensions.Query(VisualElement, String, String)
    UQueryExtensions.Query<T>(VisualElement, String, String[])
    UQueryExtensions.Query<T>(VisualElement, String, String)
    UQueryExtensions.Query(VisualElement)
    VisualElementExtensions.StretchToParentSize(VisualElement)
    VisualElementExtensions.StretchToParentWidth(VisualElement)
    VisualElementExtensions.AddManipulator(VisualElement, IManipulator)
    VisualElementExtensions.RemoveManipulator(VisualElement, IManipulator)
    VisualElementExtensions.WorldToLocal(VisualElement, Vector2)
    VisualElementExtensions.LocalToWorld(VisualElement, Vector2)
    VisualElementExtensions.WorldToLocal(VisualElement, Rect)
    VisualElementExtensions.LocalToWorld(VisualElement, Rect)
    VisualElementExtensions.ChangeCoordinatesTo(VisualElement, VisualElement, Vector2)
    VisualElementExtensions.ChangeCoordinatesTo(VisualElement, VisualElement, Rect)
    BindingExtensions.Bind(VisualElement, SerializedObject)
    BindingExtensions.Unbind(VisualElement)
    BindingExtensions.TrackPropertyValue(VisualElement, SerializedProperty, Action<SerializedProperty>)
    In This Article
    • Constructors
      • ScrollView()
      • ScrollView(ScrollViewMode)
    • Fields
      • contentAndVerticalScrollUssClassName
      • contentUssClassName
      • horizontalVariantUssClassName
      • hScrollerUssClassName
      • scrollVariantUssClassName
      • ussClassName
      • verticalHorizontalVariantUssClassName
      • verticalVariantUssClassName
      • viewportUssClassName
      • vScrollerUssClassName
    • Properties
      • contentContainer
      • contentViewport
      • elasticity
      • horizontalPageSize
      • horizontalScroller
      • horizontalScrollerVisibility
      • scrollDecelerationRate
      • scrollOffset
      • showHorizontal
      • showVertical
      • touchScrollBehavior
      • verticalPageSize
      • verticalScroller
      • verticalScrollerVisibility
    • Methods
      • ScrollTo(VisualElement)
    • Extension Methods
    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