Show / Hide Table of Contents

Class Paginator

Navigation controls for pages or listed items.

Inheritance
Object
BaseScreenComponent
Panel
Paginator
Inherited Members
Panel.Components
Panel.EnableBorder
Panel.HasFocusOutlineColor
Panel.LostFocusOutlineColor
Panel.Outline
Panel.Update()
Panel.Draw()
Panel.SetBorderTextures(Texture2D, Texture2D, Texture2D, Texture2D, Texture2D, Texture2D, Texture2D, Texture2D, Texture2D, FilterMode, Nullable<Border<Vector2Int>>)
Panel.GotFocus()
Panel.LostFocus()
Panel.ProcessHotkeySequences(HotkeySequence.KeyModifiers)
BaseScreenComponent.rectRestrictedRenderArea
BaseScreenComponent.restrictedRenderAreaCustomParent
BaseScreenComponent.restrictedRenderAreaCoordinateType
BaseScreenComponent.backgroundTexture
BaseScreenComponent.animatedBackgroundTextures
BaseScreenComponent.backgroundTextureLayout
BaseScreenComponent.OnKeyboardEvent
BaseScreenComponent.OnMouseEnter
BaseScreenComponent.OnMouseLeave
BaseScreenComponent.OnMouseMove
BaseScreenComponent.OnMouseDown
BaseScreenComponent.OnMouseUp
BaseScreenComponent.OnMouseClick
BaseScreenComponent.OnMouseDoubleClick
BaseScreenComponent.OnRightMouseDown
BaseScreenComponent.OnRightMouseUp
BaseScreenComponent.OnRightMouseClick
BaseScreenComponent.OnRightMouseDoubleClick
BaseScreenComponent.OnMiddleMouseDown
BaseScreenComponent.OnMiddleMouseUp
BaseScreenComponent.OnMiddleMouseClick
BaseScreenComponent.OnMiddleMouseDoubleClick
BaseScreenComponent.OnMouseScrollUp
BaseScreenComponent.OnMouseScrollDown
BaseScreenComponent.Enabled
BaseScreenComponent.UseFocus
BaseScreenComponent.OverridesHotkeySequences
BaseScreenComponent.Name
BaseScreenComponent.Tag
BaseScreenComponent.Position
BaseScreenComponent.Size
BaseScreenComponent.RootSize
BaseScreenComponent.Parent
BaseScreenComponent.Rectangle
BaseScreenComponent.HorizontalAlignment
BaseScreenComponent.VerticalAlignment
BaseScreenComponent.RestrictedRenderAreaCoordinateType
BaseScreenComponent.RectRestrictedRenderArea
BaseScreenComponent.RestrictedRenderAreaCustomParent
BaseScreenComponent.UseRestrictedRenderArea
BaseScreenComponent.CustomMousePosition
BaseScreenComponent.MousePosition
BaseScreenComponent.LastMousePosition
BaseScreenComponent.ScaledMousePosition
BaseScreenComponent.BackgroundColor
BaseScreenComponent.MouseOverBackgroundColor
BaseScreenComponent.BackgroundColorTexture
BaseScreenComponent.BackgroundTexture
BaseScreenComponent.BackgroundCroppedRect
BaseScreenComponent.AnimatedBackgroundTextures
BaseScreenComponent.AnimationDelayInSeconds
BaseScreenComponent.BackgroundTextureLayout
BaseScreenComponent.InteriorWidth
BaseScreenComponent.InteriorHeight
BaseScreenComponent.Scale
BaseScreenComponent.AutoSize
BaseScreenComponent.LocalScale
BaseScreenComponent.ToolTip
BaseScreenComponent.ToolTipText
BaseScreenComponent.SuppressToolTip
BaseScreenComponent.MinAutoScale
BaseScreenComponent.MaxAutoScale
BaseScreenComponent.MouseOverComponent
BaseScreenComponent.TopMargin
BaseScreenComponent.BottomMargin
BaseScreenComponent.LeftMargin
BaseScreenComponent.RightMargin
BaseScreenComponent.ScreenToLocal(Vector2)
BaseScreenComponent.ScreenToLocal(Rect)
BaseScreenComponent.TriggerMouseClick()
BaseScreenComponent.KeyboardEvent(Event)
BaseScreenComponent.MouseClick(Vector2)
BaseScreenComponent.RightMouseClick(Vector2)
BaseScreenComponent.MiddleMouseClick(Vector2)
BaseScreenComponent.MouseDoubleClick(Vector2)
BaseScreenComponent.RightMouseDoubleClick(Vector2)
BaseScreenComponent.MiddleMouseDoubleClick(Vector2)
BaseScreenComponent.MouseEnter()
BaseScreenComponent.MouseLeave(BaseScreenComponent)
BaseScreenComponent.MouseMove(Int32, Int32)
BaseScreenComponent.MouseScrollUp()
BaseScreenComponent.MouseScrollDown()
BaseScreenComponent.Dispose()
BaseScreenComponent.SetMargins(Margins, Int32)
BaseScreenComponent.OffsetFrom(BaseScreenComponent, Sides, Int32)
BaseScreenComponent.SetFocus()
BaseScreenComponent.HasFocus()
Namespace: DaggerfallWorkshop.Game.UserInterface
Assembly: Assembly-CSharp.dll
Syntax
public class Paginator : Panel, IDisposable

Constructors

| Improve this Doc View Source

Paginator(Int32)

Create a control for pages or listed items.

Declaration
public Paginator(int total = 1)
Parameters
Type Name Description
Int32 total

Properties

| Improve this Doc View Source

ArrowColor

Color of previous/next arrows.

Declaration
public Color ArrowColor { get; set; }
Property Value
Type Description
Color
| Improve this Doc View Source

DisabledArrowColor

Color of previous/next arrows on first/last position.

Declaration
public Color DisabledArrowColor { get; set; }
Property Value
Type Description
Color
| Improve this Doc View Source

IsFirst

Is first selected?

Declaration
public bool IsFirst { get; }
Property Value
Type Description
Boolean
| Improve this Doc View Source

IsLast

Is last selected?

Declaration
public bool IsLast { get; }
Property Value
Type Description
Boolean
| Improve this Doc View Source

Selected

Selected index.

Declaration
public int Selected { get; set; }
Property Value
Type Description
Int32
| Improve this Doc View Source

TextColor

Color of index label.

Declaration
public Color TextColor { get; set; }
Property Value
Type Description
Color
| Improve this Doc View Source

Total

Number of positions.

Declaration
public int Total { get; set; }
Property Value
Type Description
Int32

Methods

| Improve this Doc View Source

First()

Move to first position.

Declaration
public void First()
| Improve this Doc View Source

Last()

Move to last position.

Declaration
public void Last()
| Improve this Doc View Source

Next()

Move to next position.

Declaration
public void Next()
| Improve this Doc View Source

Previous()

Move to previous position.

Declaration
public void Previous()
| Improve this Doc View Source

SetScale(Single, Single)

Set text scale and distance between arrows.

Declaration
public void SetScale(float textScale = 1F, float arrowSpacing = 30F)
Parameters
Type Name Description
Single textScale

Scale factor of text.

Single arrowSpacing

Distance between arrows.

| Improve this Doc View Source

Sync(Int32)

Select position without raising events.

Declaration
public void Sync(int selected)
Parameters
Type Name Description
Int32 selected

Events

| Improve this Doc View Source

OnSelected

Declaration
public event Paginator.OnSelectedHandler OnSelected
Event Type
Type Description
Paginator.OnSelectedHandler
  • Improve this Doc
  • View Source
In This Article
Back to top Generated by DocFX