Class ScrollController | Package Manager UI website
docs.unity3d.com
    Show / Hide Table of Contents

    Class ScrollController

    Inheritance
    System.Object
    ChangeNotifier
    ScrollController
    PageController
    TrackingScrollController
    Inherited Members
    ChangeNotifier.hasListeners
    ChangeNotifier.addListener(VoidCallback)
    ChangeNotifier.removeListener(VoidCallback)
    ChangeNotifier.notifyListeners()
    Namespace: Unity.UIWidgets.widgets
    Syntax
    public class ScrollController : ChangeNotifier, Listenable

    Constructors

    ScrollController(Single, Boolean, String)

    Declaration
    public ScrollController(float initialScrollOffset = 0F, bool keepScrollOffset = true, string debugLabel = null)
    Parameters
    Type Name Description
    System.Single initialScrollOffset
    System.Boolean keepScrollOffset
    System.String debugLabel

    Fields

    debugLabel

    Declaration
    public readonly string debugLabel
    Field Value
    Type Description
    System.String

    keepScrollOffset

    Declaration
    public readonly bool keepScrollOffset
    Field Value
    Type Description
    System.Boolean

    Properties

    hasClients

    Declaration
    public bool hasClients { get; }
    Property Value
    Type Description
    System.Boolean

    initialScrollOffset

    Declaration
    public virtual float initialScrollOffset { get; }
    Property Value
    Type Description
    System.Single

    offset

    Declaration
    public float offset { get; }
    Property Value
    Type Description
    System.Single

    position

    Declaration
    public ScrollPosition position { get; }
    Property Value
    Type Description
    ScrollPosition

    positions

    Declaration
    public ICollection<ScrollPosition> positions { get; }
    Property Value
    Type Description
    System.Collections.Generic.ICollection<ScrollPosition>

    Methods

    animateTo(Single, TimeSpan, Curve)

    Declaration
    public IPromise animateTo(float to, TimeSpan duration, Curve curve)
    Parameters
    Type Name Description
    System.Single to
    System.TimeSpan duration
    Curve curve
    Returns
    Type Description
    IPromise

    attach(ScrollPosition)

    Declaration
    public virtual void attach(ScrollPosition position)
    Parameters
    Type Name Description
    ScrollPosition position

    createScrollPosition(ScrollPhysics, ScrollContext, ScrollPosition)

    Declaration
    public virtual ScrollPosition createScrollPosition(ScrollPhysics physics, ScrollContext context, ScrollPosition oldPosition)
    Parameters
    Type Name Description
    ScrollPhysics physics
    ScrollContext context
    ScrollPosition oldPosition
    Returns
    Type Description
    ScrollPosition

    debugFillDescription(List<String>)

    Declaration
    protected virtual void debugFillDescription(List<string> description)
    Parameters
    Type Name Description
    System.Collections.Generic.List<System.String> description

    detach(ScrollPosition)

    Declaration
    public virtual void detach(ScrollPosition position)
    Parameters
    Type Name Description
    ScrollPosition position

    dispose()

    Declaration
    public override void dispose()
    Overrides
    ChangeNotifier.dispose()

    jumpTo(Single)

    Declaration
    public void jumpTo(float value)
    Parameters
    Type Name Description
    System.Single value

    ToString()

    Declaration
    public override string ToString()
    Returns
    Type Description
    System.String
    Overrides
    System.Object.ToString()
    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