One Logo Pool Ball
UIKit · IOS API REFERENCE

UIPageControl

class · iOS 2.0+ · SDK 27.1

@MainActor class UIPageControl

Members (32)

method · iOS 16.0+

currentPageIndicatorImage

TypeScript
currentPageIndicatorImage(page: number): Promise<(UIImage) | null>
Swift declaration
func currentPageIndicatorImage(forPage page: Int) -> UIImage?
method · iOS 14.0+

indicatorImage

TypeScript
indicatorImage(page: number): Promise<(UIImage) | null>
Swift declaration
func indicatorImage(forPage page: Int) -> UIImage?
init

init

TypeScript
static init(): Promise<UIPageControl>
Swift declaration
init()
method · iOS 16.0+

setCurrentPageIndicatorImage

TypeScript
setCurrentPageIndicatorImage(image: (UIImage) | null, page: number): Promise<void>
Swift declaration
func setCurrentPageIndicatorImage(_ image: UIImage?, forPage page: Int)
method · iOS 14.0+

setIndicatorImage

TypeScript
setIndicatorImage(image: (UIImage) | null, page: number): Promise<void>
Swift declaration
func setIndicatorImage(_ image: UIImage?, forPage page: Int)
method · iOS 2.0+

size

TypeScript
size(pageCount: number): Promise<{ width: number; height: number }>
Swift declaration
func size(forNumberOfPages pageCount: Int) -> CGSize
method · iOS 2.0+ · Deprecated in iOS 14.0

updateCurrentPageDisplay

TypeScript
updateCurrentPageDisplay(): Promise<void>
Swift declaration
func updateCurrentPageDisplay()
get · iOS 14.0+

allowsContinuousInteraction

TypeScript
get allowsContinuousInteraction(): Promise<boolean>
Swift declaration
var allowsContinuousInteraction: Bool { get set }
set · iOS 14.0+

allowsContinuousInteraction

TypeScript
setAllowsContinuousInteraction(value: boolean): Promise<void>
Swift declaration
var allowsContinuousInteraction: Bool { get set }
get · iOS 14.0+

backgroundStyle

TypeScript
get backgroundStyle(): Promise<UIPageControl_BackgroundStyle>
Swift declaration
var backgroundStyle: UIPageControl.BackgroundStyle { get set }
set · iOS 14.0+

backgroundStyle

TypeScript
setBackgroundStyle(value: UIPageControl_BackgroundStyle): Promise<void>
Swift declaration
var backgroundStyle: UIPageControl.BackgroundStyle { get set }
get · iOS 2.0+

currentPage

TypeScript
get currentPage(): Promise<number>
Swift declaration
var currentPage: Int { get set }
set · iOS 2.0+

currentPage

TypeScript
setCurrentPage(value: number): Promise<void>
Swift declaration
var currentPage: Int { get set }
get · iOS 6.0+

currentPageIndicatorTintColor

TypeScript
get currentPageIndicatorTintColor(): Promise<(UIColor) | null>
Swift declaration
var currentPageIndicatorTintColor: UIColor? { get set }
set · iOS 6.0+

currentPageIndicatorTintColor

TypeScript
setCurrentPageIndicatorTintColor(value?: (UIColor) | null): Promise<void>
Swift declaration
var currentPageIndicatorTintColor: UIColor? { get set }
get · iOS 2.0+ · Deprecated in iOS 14.0

defersCurrentPageDisplay

TypeScript
get defersCurrentPageDisplay(): Promise<boolean>
Swift declaration
var defersCurrentPageDisplay: Bool { get set }
set · iOS 2.0+ · Deprecated in iOS 14.0

defersCurrentPageDisplay

TypeScript
setDefersCurrentPageDisplay(value: boolean): Promise<void>
Swift declaration
var defersCurrentPageDisplay: Bool { get set }
get · iOS 16.0+

direction

TypeScript
get direction(): Promise<UIPageControl_Direction>
Swift declaration
var direction: UIPageControl.Direction { get set }
set · iOS 16.0+

direction

TypeScript
setDirection(value: UIPageControl_Direction): Promise<void>
Swift declaration
var direction: UIPageControl.Direction { get set }
get · iOS 2.0+

hidesForSinglePage

TypeScript
get hidesForSinglePage(): Promise<boolean>
Swift declaration
var hidesForSinglePage: Bool { get set }
set · iOS 2.0+

hidesForSinglePage

TypeScript
setHidesForSinglePage(value: boolean): Promise<void>
Swift declaration
var hidesForSinglePage: Bool { get set }
get · iOS 14.0+

interactionState

TypeScript
get interactionState(): Promise<UIPageControl_InteractionState>
Swift declaration
var interactionState: UIPageControl.InteractionState { get }
get · iOS 2.0+

numberOfPages

TypeScript
get numberOfPages(): Promise<number>
Swift declaration
var numberOfPages: Int { get set }
set · iOS 2.0+

numberOfPages

TypeScript
setNumberOfPages(value: number): Promise<void>
Swift declaration
var numberOfPages: Int { get set }
get · iOS 6.0+

pageIndicatorTintColor

TypeScript
get pageIndicatorTintColor(): Promise<(UIColor) | null>
Swift declaration
var pageIndicatorTintColor: UIColor? { get set }
set · iOS 6.0+

pageIndicatorTintColor

TypeScript
setPageIndicatorTintColor(value?: (UIColor) | null): Promise<void>
Swift declaration
var pageIndicatorTintColor: UIColor? { get set }
get · iOS 16.0+

preferredCurrentPageIndicatorImage

TypeScript
get preferredCurrentPageIndicatorImage(): Promise<(UIImage) | null>
Swift declaration
var preferredCurrentPageIndicatorImage: UIImage? { get set }
set · iOS 16.0+

preferredCurrentPageIndicatorImage

TypeScript
setPreferredCurrentPageIndicatorImage(value?: (UIImage) | null): Promise<void>
Swift declaration
var preferredCurrentPageIndicatorImage: UIImage? { get set }
get · iOS 14.0+

preferredIndicatorImage

TypeScript
get preferredIndicatorImage(): Promise<(UIImage) | null>
Swift declaration
var preferredIndicatorImage: UIImage? { get set }
set · iOS 14.0+

preferredIndicatorImage

TypeScript
setPreferredIndicatorImage(value?: (UIImage) | null): Promise<void>
Swift declaration
var preferredIndicatorImage: UIImage? { get set }
get · iOS 17.0+

progress

TypeScript
get progress(): Promise<(UIPageControlProgress) | null>
Swift declaration
var progress: UIPageControlProgress? { get set }
set · iOS 17.0+

progress

TypeScript
setProgress(value?: (UIPageControlProgress) | null): Promise<void>
Swift declaration
var progress: UIPageControlProgress? { get set }

Skipped declarations

No declarations were skipped in this snapshot.

All UIKit types →