Class PageIndicator
PageIndicator UI element. This element is used to display a list of dots that can be used to navigate between pages.
Implements
Inherited Members
VisualElement.ExecuteDefaultAction(EventBase)
VisualElement.Focus()
VisualElement.Overlaps(Rect)
VisualElement.ToString()
VisualElement.GetFirstOfType<T>()
VisualElement.GetFirstAncestorOfType<T>()
VisualElement.canGrabFocus
VisualElement.focusController
VisualElement.cacheAsBitmap
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)
Namespace: Unity.AppUI.UI
Assembly: Unity.AppUI.dll
Syntax
public class PageIndicator : BaseVisualElement, IEventHandler, ITransform, ITransitionAnimations, IExperimentalFeatures, IVisualElementScheduler, IResolvedStyle, IContextOverrideElement, INotifyValueChanged<int>Constructors
PageIndicator()
Default constructor.
Declaration
public PageIndicator()Fields
dotBackgroundUssClassName
The PageIndicator dot background styling class.
Declaration
public const string dotBackgroundUssClassName = "appui-page-indicator__dot-background"Field Value
| Type | Description |
|---|---|
| string |
dotContentUssClassName
The PageIndicator dot content styling class.
Declaration
public const string dotContentUssClassName = "appui-page-indicator__dot-content"Field Value
| Type | Description |
|---|---|
| string |
dotUssClassName
The PageIndicator dot styling class.
Declaration
public const string dotUssClassName = "appui-page-indicator__dot"Field Value
| Type | Description |
|---|---|
| string |
ussClassName
The PageIndicator main styling class.
Declaration
public const string ussClassName = "appui-page-indicator"Field Value
| Type | Description |
|---|---|
| string |
variantUssClassName
The PageIndicator direction styling class.
Declaration
public const string variantUssClassName = "appui-page-indicator--"Field Value
| Type | Description |
|---|---|
| string |
Properties
contentContainer
The content container of the PageIndicator. This is always null.
Declaration
public override VisualElement contentContainer { get; }Property Value
| Type | Description |
|---|---|
| VisualElement |
Overrides
count
The number of dots.
Declaration
public int count { get; set; }Property Value
| Type | Description |
|---|---|
| int |
direction
The PageIndicator direction (horizontal or vertical).
Declaration
public Direction direction { get; set; }Property Value
| Type | Description |
|---|---|
| Direction |
value
The currently selected dot index.
Declaration
public int value { get; set; }Property Value
| Type | Description |
|---|---|
| int |
Methods
GetDirectionUssClassName(Direction)
Declaration
public static string GetDirectionUssClassName(Direction enumValue)Parameters
| Type | Name | Description |
|---|---|---|
| Direction | enumValue |
Returns
| Type | Description |
|---|---|
| string |
GoToNext()
Go to the next dot.
Declaration
public bool GoToNext()Returns
| Type | Description |
|---|---|
| bool | True if the dot has been changed. |
GoToPrevious()
Go to the previous dot.
Declaration
public bool GoToPrevious()Returns
| Type | Description |
|---|---|
| bool | True if the dot has been changed. |
SetValueWithoutNotify(int)
Set the value of the PageIndicator without notifying the listeners.
Declaration
public void SetValueWithoutNotify(int newValue)Parameters
| Type | Name | Description |
|---|---|---|
| int | newValue | The new value. |