PDFKit · IOS API REFERENCE

PDFAnnotation

class · iOS 11.0+ · SDK 27.1

class PDFAnnotation

Members (108)

static

lineStyle

TypeScript

static lineStyle(name: string): PDFLineStyle

Swift declaration

class func lineStyle(fromName name: String) -> PDFLineStyle

static

name

TypeScript

static nameValue(style: PDFLineStyle): string

Swift declaration

class func name(for style: PDFLineStyle) -> String

method

add

TypeScript

add(path: _UIKit_UIBezierPath): void

Swift declaration

func add(_ path: UIBezierPath)

method · iOS 11.0+

draw

TypeScript

draw(box: PDFDisplayBox, context: _CoreGraphics_CGContext): void

Swift declaration

func draw(with box: PDFDisplayBox, in context: CGContext)

init · iOS 11.0+

init

TypeScript

static init(bounds: { x: number; y: number; width: number; height: number }, annotationType: PDFAnnotationSubtype, properties?: (NativeMap<unknown, unknown>) | null): PDFAnnotation

Swift declaration

init(bounds: CGRect, forType annotationType: PDFAnnotationSubtype, withProperties properties: [AnyHashable : Any]?)

method

remove

TypeScript

remove(path: _UIKit_UIBezierPath): void

Swift declaration

func remove(_ path: UIBezierPath)

method · iOS 11.0+

removeValue

TypeScript

removeValue(key: PDFAnnotationKey): void

Swift declaration

func removeValue(forAnnotationKey key: PDFAnnotationKey)

method · iOS 11.0+

setBoolean

TypeScript

setBoolean(value: boolean, key: PDFAnnotationKey): boolean

Swift declaration

func setBoolean(_ value: Bool, forAnnotationKey key: PDFAnnotationKey) -> Bool

method · iOS 11.0+

setRect

TypeScript

setRect(value: { x: number; y: number; width: number; height: number }, key: PDFAnnotationKey): boolean

Swift declaration

func setRect(_ value: CGRect, forAnnotationKey key: PDFAnnotationKey) -> Bool

method · iOS 11.0+

setValue

TypeScript

setValue(value: unknown, key: PDFAnnotationKey): boolean

Swift declaration

func setValue(_ value: Any, forAnnotationKey key: PDFAnnotationKey) -> Bool

method · iOS 11.0+

value

TypeScript

value(key: PDFAnnotationKey): (unknown) | null

Swift declaration

func value(forAnnotationKey key: PDFAnnotationKey) -> Any?

get

url

TypeScript

get url(): (string) | null

Swift declaration

var url: URL? { get set }

set

url

TypeScript

set url(value: (string) | null)

Swift declaration

var url: URL? { get set }

get · iOS 11.0+

action

TypeScript

get action(): (PDFAction) | null

Swift declaration

var action: PDFAction? { get set }

set · iOS 11.0+

action

TypeScript

set action(value: (PDFAction) | null)

Swift declaration

var action: PDFAction? { get set }

get

isActivatableTextField

TypeScript

get isActivatableTextField(): boolean

Swift declaration

var isActivatableTextField: Bool { get }

get

alignment

TypeScript

get alignment(): _UIKit_NSTextAlignment

Swift declaration

var alignment: NSTextAlignment { get set }

set

alignment

TypeScript

set alignment(value: _UIKit_NSTextAlignment)

Swift declaration

var alignment: NSTextAlignment { get set }

get

allowsToggleToOff

TypeScript

get allowsToggleToOff(): boolean

Swift declaration

var allowsToggleToOff: Bool { get set }

set

allowsToggleToOff

TypeScript

set allowsToggleToOff(value: boolean)

Swift declaration

var allowsToggleToOff: Bool { get set }

get · iOS 11.0+

annotationKeyValues

TypeScript

get annotationKeyValues(): NativeMap<unknown, unknown>

Swift declaration

var annotationKeyValues: [AnyHashable : Any] { get }

get

backgroundColor

TypeScript

get backgroundColor(): (_UIKit_UIColor) | null

Swift declaration

@NSCopying var backgroundColor: UIColor? { get set }

set

backgroundColor

TypeScript

set backgroundColor(value: (_UIKit_UIColor) | null)

Swift declaration

@NSCopying var backgroundColor: UIColor? { get set }

get · iOS 11.0+

border

TypeScript

get border(): (PDFBorder) | null

Swift declaration

var border: PDFBorder? { get set }

set · iOS 11.0+

border

TypeScript

set border(value: (PDFBorder) | null)

Swift declaration

var border: PDFBorder? { get set }

get · iOS 11.0+

bounds

TypeScript

get bounds(): { x: number; y: number; width: number; height: number }

Swift declaration

var bounds: CGRect { get set }

set · iOS 11.0+

bounds

TypeScript

set bounds(value: { x: number; y: number; width: number; height: number })

Swift declaration

var bounds: CGRect { get set }

get

buttonWidgetState

TypeScript

get buttonWidgetState(): PDFWidgetCellState

Swift declaration

var buttonWidgetState: PDFWidgetCellState { get set }

set

buttonWidgetState

TypeScript

set buttonWidgetState(value: PDFWidgetCellState)

Swift declaration

var buttonWidgetState: PDFWidgetCellState { get set }

get

buttonWidgetStateString

TypeScript

get buttonWidgetStateString(): string

Swift declaration

var buttonWidgetStateString: String { get set }

set

buttonWidgetStateString

TypeScript

set buttonWidgetStateString(value: string)

Swift declaration

var buttonWidgetStateString: String { get set }

get

caption

TypeScript

get caption(): (string) | null

Swift declaration

var caption: String? { get set }

set

caption

TypeScript

set caption(value: (string) | null)

Swift declaration

var caption: String? { get set }

get

choices

TypeScript

get choices(): (Array<string>) | null

Swift declaration

var choices: [String]? { get set }

set

choices

TypeScript

set choices(value: (Array<string>) | null)

Swift declaration

var choices: [String]? { get set }

get · iOS 11.0+

color

TypeScript

get color(): _UIKit_UIColor

Swift declaration

@NSCopying var color: UIColor { get set }

set · iOS 11.0+

color

TypeScript

set color(value: _UIKit_UIColor)

Swift declaration

@NSCopying var color: UIColor { get set }

get

hasComb

TypeScript

get hasComb(): boolean

Swift declaration

var hasComb: Bool { get set }

set

hasComb

TypeScript

set hasComb(value: boolean)

Swift declaration

var hasComb: Bool { get set }

get · iOS 11.0+

TypeScript

get contents(): (string) | null

Swift declaration

var contents: String? { get set }

set · iOS 11.0+

TypeScript

set contents(value: (string) | null)

Swift declaration

var contents: String? { get set }

get

destination

TypeScript

get destination(): (PDFDestination) | null

Swift declaration

var destination: PDFDestination? { get set }

set

destination

TypeScript

set destination(value: (PDFDestination) | null)

Swift declaration

var destination: PDFDestination? { get set }

get

endLineStyle

TypeScript

get endLineStyle(): PDFLineStyle

Swift declaration

var endLineStyle: PDFLineStyle { get set }

set

endLineStyle

TypeScript

set endLineStyle(value: PDFLineStyle)

Swift declaration

var endLineStyle: PDFLineStyle { get set }

get

endPoint

TypeScript

get endPoint(): { x: number; y: number }

Swift declaration

var endPoint: CGPoint { get set }

set

endPoint

TypeScript

set endPoint(value: { x: number; y: number })

Swift declaration

var endPoint: CGPoint { get set }

get

fieldName

TypeScript

get fieldName(): (string) | null

Swift declaration

var fieldName: String? { get set }

set

fieldName

TypeScript

set fieldName(value: (string) | null)

Swift declaration

var fieldName: String? { get set }

get

font

TypeScript

get font(): (_UIKit_UIFont) | null

Swift declaration

@NSCopying var font: UIFont? { get set }

set

font

TypeScript

set font(value: (_UIKit_UIFont) | null)

Swift declaration

@NSCopying var font: UIFont? { get set }

get

fontColor

TypeScript

get fontColor(): (_UIKit_UIColor) | null

Swift declaration

@NSCopying var fontColor: UIColor? { get set }

set

fontColor

TypeScript

set fontColor(value: (_UIKit_UIColor) | null)

Swift declaration

@NSCopying var fontColor: UIColor? { get set }

get · iOS 11.0+

hasAppearanceStream

TypeScript

get hasAppearanceStream(): boolean

Swift declaration

var hasAppearanceStream: Bool { get }

get · iOS 11.0+

isHighlighted

TypeScript

get isHighlighted(): boolean

Swift declaration

var isHighlighted: Bool { get set }

set · iOS 11.0+

isHighlighted

TypeScript

set isHighlighted(value: boolean)

Swift declaration

var isHighlighted: Bool { get set }

get

iconType

TypeScript

get iconType(): PDFTextAnnotationIconType

Swift declaration

var iconType: PDFTextAnnotationIconType { get set }

set

iconType

TypeScript

set iconType(value: PDFTextAnnotationIconType)

Swift declaration

var iconType: PDFTextAnnotationIconType { get set }

get

interiorColor

TypeScript

get interiorColor(): (_UIKit_UIColor) | null

Swift declaration

@NSCopying var interiorColor: UIColor? { get set }

set

interiorColor

TypeScript

set interiorColor(value: (_UIKit_UIColor) | null)

Swift declaration

@NSCopying var interiorColor: UIColor? { get set }

get

isPasswordField

TypeScript

get isPasswordField(): boolean

Swift declaration

var isPasswordField: Bool { get }

get

isListChoice

TypeScript

get isListChoice(): boolean

Swift declaration

var isListChoice: Bool { get set }

set

isListChoice

TypeScript

set isListChoice(value: boolean)

Swift declaration

var isListChoice: Bool { get set }

get

markupType

TypeScript

get markupType(): PDFMarkupType

Swift declaration

var markupType: PDFMarkupType { get set }

set

markupType

TypeScript

set markupType(value: PDFMarkupType)

Swift declaration

var markupType: PDFMarkupType { get set }

get

maximumLength

TypeScript

get maximumLength(): number

Swift declaration

var maximumLength: Int { get set }

set

maximumLength

TypeScript

set maximumLength(value: number)

Swift declaration

var maximumLength: Int { get set }

get · iOS 11.0+

modificationDate

TypeScript

get modificationDate(): (globalThis.Date) | null

Swift declaration

var modificationDate: Date? { get set }

set · iOS 11.0+

modificationDate

TypeScript

set modificationDate(value: (globalThis.Date) | null)

Swift declaration

var modificationDate: Date? { get set }

get

isMultiline

TypeScript

get isMultiline(): boolean

Swift declaration

var isMultiline: Bool { get set }

set

isMultiline

TypeScript

set isMultiline(value: boolean)

Swift declaration

var isMultiline: Bool { get set }

get

isOpen

TypeScript

get isOpen(): boolean

Swift declaration

var isOpen: Bool { get set }

set

isOpen

TypeScript

set isOpen(value: boolean)

Swift declaration

var isOpen: Bool { get set }

get · iOS 11.0+

page

TypeScript

get page(): (PDFPage) | null

Swift declaration

weak var page: PDFPage? { get set }

set · iOS 11.0+

page

TypeScript

set page(value: (PDFPage) | null)

Swift declaration

weak var page: PDFPage? { get set }

get

paths

TypeScript

get paths(): (Array<_UIKit_UIBezierPath>) | null

Swift declaration

var paths: [UIBezierPath]? { get }

get · iOS 11.0+

popup

TypeScript

get popup(): (PDFAnnotation) | null

Swift declaration

var popup: PDFAnnotation? { get set }

set · iOS 11.0+

popup

TypeScript

set popup(value: (PDFAnnotation) | null)

Swift declaration

var popup: PDFAnnotation? { get set }

get

quadrilateralPoints

TypeScript

get quadrilateralPoints(): (Array<_Foundation_NSValue>) | null

Swift declaration

var quadrilateralPoints: [NSValue]? { get set }

set

quadrilateralPoints

TypeScript

set quadrilateralPoints(value: (Array<_Foundation_NSValue>) | null)

Swift declaration

var quadrilateralPoints: [NSValue]? { get set }

get

radiosInUnison

TypeScript

get radiosInUnison(): boolean

Swift declaration

var radiosInUnison: Bool { get set }

set

radiosInUnison

TypeScript

set radiosInUnison(value: boolean)

Swift declaration

var radiosInUnison: Bool { get set }

get

isReadOnly

TypeScript

get isReadOnly(): boolean

Swift declaration

var isReadOnly: Bool { get set }

set

isReadOnly

TypeScript

set isReadOnly(value: boolean)

Swift declaration

var isReadOnly: Bool { get set }

get · iOS 11.0+

shouldDisplay

TypeScript

get shouldDisplay(): boolean

Swift declaration

var shouldDisplay: Bool { get set }

set · iOS 11.0+

shouldDisplay

TypeScript

set shouldDisplay(value: boolean)

Swift declaration

var shouldDisplay: Bool { get set }

get · iOS 11.0+

shouldPrint

TypeScript

get shouldPrint(): boolean

Swift declaration

var shouldPrint: Bool { get set }

set · iOS 11.0+

shouldPrint

TypeScript

set shouldPrint(value: boolean)

Swift declaration

var shouldPrint: Bool { get set }

get

stampName

TypeScript

get stampName(): (string) | null

Swift declaration

var stampName: String? { get set }

set

stampName

TypeScript

set stampName(value: (string) | null)

Swift declaration

var stampName: String? { get set }

get

startLineStyle

TypeScript

get startLineStyle(): PDFLineStyle

Swift declaration

var startLineStyle: PDFLineStyle { get set }

set

startLineStyle

TypeScript

set startLineStyle(value: PDFLineStyle)

Swift declaration

var startLineStyle: PDFLineStyle { get set }

get

startPoint

TypeScript

get startPoint(): { x: number; y: number }

Swift declaration

var startPoint: CGPoint { get set }

set

startPoint

TypeScript

set startPoint(value: { x: number; y: number })

Swift declaration

var startPoint: CGPoint { get set }

get · iOS 11.0+

type

TypeScript

get type(): (string) | null

Swift declaration

var type: String? { get set }

set · iOS 11.0+

type

TypeScript

set type(value: (string) | null)

Swift declaration

var type: String? { get set }

get · iOS 11.0+

userName

TypeScript

get userName(): (string) | null

Swift declaration

var userName: String? { get set }

set · iOS 11.0+

userName

TypeScript

set userName(value: (string) | null)

Swift declaration

var userName: String? { get set }

get

values

TypeScript

get values(): (Array<string>) | null

Swift declaration

var values: [String]? { get set }

set

values

TypeScript

set values(value: (Array<string>) | null)

Swift declaration

var values: [String]? { get set }

get

widgetControlType

TypeScript

get widgetControlType(): PDFWidgetControlType

Swift declaration

var widgetControlType: PDFWidgetControlType { get set }

set

widgetControlType

TypeScript

set widgetControlType(value: PDFWidgetControlType)

Swift declaration

var widgetControlType: PDFWidgetControlType { get set }

get

widgetDefaultStringValue

TypeScript

get widgetDefaultStringValue(): (string) | null

Swift declaration

var widgetDefaultStringValue: String? { get set }

set

widgetDefaultStringValue

TypeScript

set widgetDefaultStringValue(value: (string) | null)

Swift declaration

var widgetDefaultStringValue: String? { get set }

get

widgetFieldType

TypeScript

get widgetFieldType(): PDFAnnotationWidgetSubtype

Swift declaration

var widgetFieldType: PDFAnnotationWidgetSubtype { get set }

set

widgetFieldType

TypeScript

set widgetFieldType(value: PDFAnnotationWidgetSubtype)

Swift declaration

var widgetFieldType: PDFAnnotationWidgetSubtype { get set }

get

widgetStringValue

TypeScript

get widgetStringValue(): (string) | null

Swift declaration

var widgetStringValue: String? { get set }

set

widgetStringValue

TypeScript

set widgetStringValue(value: (string) | null)

Swift declaration

var widgetStringValue: String? { get set }

Skipped declarations

1 declarations were excluded from these bindings. Each reason comes from the generator or the iOS SDK compiler.

PDFAnnotation.init()

inherited init: cannot prove legal (class declares 1 custom initializer)

All PDFKit types →