pdfkit

type IPDFAction ¶

type IPDFAction interface {
	objectivec.IObject

	// Returns the type of the action.
	Type() string

	// An object that represents an action for a PDF element, such as a link annotation.
	Action() IPDFAction
	SetAction(value IPDFAction)
	// Returns the modification date of the annotation.
	ModificationDate() foundation.INSDate
	SetModificationDate(value foundation.INSDate)
	// Returns the page that the annotation is associated with.
	Page() IPDFPage
	SetPage(value IPDFPage)
	// Returns the name of the user who created the annotation.
	UserName() string
	SetUserName(value string)
}

An interface definition for the PDFAction class.

Getting the Action Type ¶

• [IPDFAction.Type]: Returns the type of the action.

See: https://developer.apple.com/documentation/PDFKit/PDFAction

type IPDFActionGoTo ¶

type IPDFActionGoTo interface {
	IPDFAction

	// Returns the destination associated with the action.
	Destination() IPDFDestination
	SetDestination(value IPDFDestination)

	// Initializes the go-to action.
	InitWithDestination(destination IPDFDestination) PDFActionGoTo
}

An interface definition for the PDFActionGoTo class.

Accessing the Destination ¶

• [IPDFActionGoTo.Destination]: Returns the destination associated with the action.
• [IPDFActionGoTo.SetDestination]

Initializing the Action ¶

• [IPDFActionGoTo.InitWithDestination]: Initializes the go-to action.

See: https://developer.apple.com/documentation/PDFKit/PDFActionGoTo

type IPDFActionNamed ¶

type IPDFActionNamed interface {
	IPDFAction

	// Returns the name of the named action.
	Name() PDFActionNamedName
	SetName(value PDFActionNamedName)

	// Initializes the [PDFActionName] object with the specified named action.
	InitWithName(name PDFActionNamedName) PDFActionNamed
}

An interface definition for the PDFActionNamed class.

Accessing the Name of the Action ¶

• [IPDFActionNamed.Name]: Returns the name of the named action.
• [IPDFActionNamed.SetName]

Initializing the Action ¶

• [IPDFActionNamed.InitWithName]: Initializes the [PDFActionName] object with the specified named action.

See: https://developer.apple.com/documentation/PDFKit/PDFActionNamed

type IPDFActionRemoteGoTo ¶

type IPDFActionRemoteGoTo interface {
	IPDFAction

	// Initializes the remote go-to action with the specified page index, point, and document URL.
	InitWithPageIndexAtPointFileURL(pageIndex uint, point corefoundation.CGPoint, url foundation.INSURL) PDFActionRemoteGoTo

	// Returns the zero-based page index referenced by the remote go-to action.
	PageIndex() uint
	SetPageIndex(value uint)

	// Sets the point, in page space, on the page referenced by the remote go-to action.
	Point() corefoundation.CGPoint
	SetPoint(value corefoundation.CGPoint)

	// Returns the URL of the document referenced by the remote go-to action.
	URL() foundation.INSURL
	SetURL(value foundation.INSURL)
}

An interface definition for the PDFActionRemoteGoTo class.

Initializing the Remote Go-to Action ¶

• [IPDFActionRemoteGoTo.InitWithPageIndexAtPointFileURL]: Initializes the remote go-to action with the specified page index, point, and document URL.

Accessing the Page Index of the Referenced Document ¶

• [IPDFActionRemoteGoTo.PageIndex]: Returns the zero-based page index referenced by the remote go-to action.
• [IPDFActionRemoteGoTo.SetPageIndex]

Accessing a Point on the Referenced Page ¶

• [IPDFActionRemoteGoTo.Point]: Sets the point, in page space, on the page referenced by the remote go-to action.
• [IPDFActionRemoteGoTo.SetPoint]

Accessing the URL of the Referenced Document ¶

• [IPDFActionRemoteGoTo.URL]: Returns the URL of the document referenced by the remote go-to action.
• [IPDFActionRemoteGoTo.SetURL]

See: https://developer.apple.com/documentation/PDFKit/PDFActionRemoteGoTo

type IPDFActionResetForm ¶

type IPDFActionResetForm interface {
	IPDFAction

	// Returns an array of fields associated with the reset action.
	Fields() []string
	SetFields(value []string)

	// Sets whether the fields associated with the reset action are cleared when the action is performed.
	FieldsIncludedAreCleared() bool
	SetFieldsIncludedAreCleared(value bool)
}

An interface definition for the PDFActionResetForm class.

Accessing and Changing Fields ¶

• [IPDFActionResetForm.Fields]: Returns an array of fields associated with the reset action.
• [IPDFActionResetForm.SetFields]

Determining Whether Fields are Cleared When the Action is Performed ¶

• [IPDFActionResetForm.FieldsIncludedAreCleared]: Sets whether the fields associated with the reset action are cleared when the action is performed.
• [IPDFActionResetForm.SetFieldsIncludedAreCleared]

See: https://developer.apple.com/documentation/PDFKit/PDFActionResetForm

type IPDFActionURL ¶

type IPDFActionURL interface {
	IPDFAction

	// Initializes a URL action with the specified URL.
	InitWithURL(url foundation.INSURL) PDFActionURL

	// Returns the URL associated with the URL action.
	URL() foundation.INSURL
	SetURL(value foundation.INSURL)
}

An interface definition for the PDFActionURL class.

Initializing a URL Action ¶

• [IPDFActionURL.InitWithURL]: Initializes a URL action with the specified URL.

Accessing and Changing the URL ¶

• [IPDFActionURL.URL]: Returns the URL associated with the URL action.
• [IPDFActionURL.SetURL]

See: https://developer.apple.com/documentation/PDFKit/PDFActionURL

type IPDFAnnotation ¶

type IPDFAnnotation interface {
	objectivec.IObject

	// Creates a PDF annotation with the specified bounds, type, and optional properties.
	InitWithBoundsForTypeWithProperties(bounds corefoundation.CGRect, annotationType PDFAnnotationSubtype, properties foundation.INSDictionary) PDFAnnotation

	// Returns the page that the annotation is associated with.
	Page() IPDFPage
	SetPage(value IPDFPage)
	// Returns the modification date of the annotation.
	ModificationDate() foundation.INSDate
	SetModificationDate(value foundation.INSDate)
	// Returns the name of the user who created the annotation.
	UserName() string
	SetUserName(value string)
	// Returns the type of the annotation.
	Type() string
	SetType(value string)
	// An object that represents an action for a PDF element, such as a link annotation.
	Action() IPDFAction
	SetAction(value IPDFAction)

	// Draws the annotation in a graphics context using page-space coordinates relative to the origin of the specified box.
	DrawWithBoxInContext(box PDFDisplayBox, context coregraphics.CGContextRef)
	// Returns a Boolean value indicating whether the annotation should be displayed.
	ShouldDisplay() bool
	SetShouldDisplay(value bool)
	// Returns a Boolean value indicating whether the annotation should appear when the document is printed.
	ShouldPrint() bool
	SetShouldPrint(value bool)

	// A dictionary that contains a deep copy of the widget’s properties.
	AnnotationKeyValues() foundation.INSDictionary
	// Returns a deep copy of the key-value pairs of properties for the specified key.
	ValueForAnnotationKey(key PDFAnnotationKey) objectivec.IObject
	// Sets a value in the annotation’s dictionary.
	SetValueForAnnotationKey(value objectivec.IObject, key PDFAnnotationKey) bool
	// Sets a Boolean value in the annotation’s dictionary.
	SetBooleanForAnnotationKey(value bool, key PDFAnnotationKey) bool
	// Sets a rectangle value in the annotation’s dictionary.
	SetRectForAnnotationKey(value corefoundation.CGRect, key PDFAnnotationKey) bool
	// Removes a value from the annotation’s dictionary.
	RemoveValueForAnnotationKey(key PDFAnnotationKey)

	// The alignment of the free text and text widget annotation’s text content.
	Alignment() appkit.NSTextAlignment
	SetAlignment(value appkit.NSTextAlignment)
	// Returns the bounding box for the annotation in page space.
	Bounds() corefoundation.CGRect
	SetBounds(value corefoundation.CGRect)
	// Returns the textual content (if any) associated with the annotation.
	Contents() string
	SetContents(value string)
	// The font the annotation uses to display text.
	Font() objectivec.IObject
	SetFont(value objectivec.IObject)
	// The font color the annotation uses to display text.
	FontColor() objc.ID
	SetFontColor(value objc.ID)
	// Sets the border style for the annotation.
	Border() IPDFBorder
	SetBorder(value IPDFBorder)
	// A Boolean value that indicates whether the annotation is in a highlighted state, such as when the mouse is down on a link annotation.
	Highlighted() bool
	SetHighlighted(value bool)
	// Sets the stroke color for the annotation.
	Color() objc.ID
	SetColor(value objc.ID)
	// Returns a Boolean value that indicates whether the annotation has an appearance stream associated with it.
	HasAppearanceStream() bool

	// The fill color for drawing a circle, line, or square annotation.
	InteriorColor() objc.ID
	SetInteriorColor(value objc.ID)

	// The point where a line begins, in annotation-space coordinates.
	StartPoint() corefoundation.CGPoint
	SetStartPoint(value corefoundation.CGPoint)
	// The point where a line ends, in annotation-space coordinates.
	EndPoint() corefoundation.CGPoint
	SetEndPoint(value corefoundation.CGPoint)
	// The style of the line annotation’s starting point, such as square or filled arrowhead.
	StartLineStyle() PDFLineStyle
	SetStartLineStyle(value PDFLineStyle)
	// The style of the line annotation’s ending point, such as square or filled arrowhead.
	EndLineStyle() PDFLineStyle
	SetEndLineStyle(value PDFLineStyle)

	// The destination for a link annotation.
	Destination() IPDFDestination
	SetDestination(value IPDFDestination)
	// A URL for a link annotation.
	URL() foundation.INSURL
	SetURL(value foundation.INSURL)

	// The type of icon to display for a pop-up text annotation.
	IconType() PDFTextAnnotationIconType
	SetIconType(value PDFTextAnnotationIconType)

	// Returns the pop-up annotation associated with an annotation.
	Popup() IPDFAnnotation
	SetPopup(value IPDFAnnotation)
	// A Boolean value that indicates whether the pop-up annotation is in an opened state, displaying its text content, or in a closed state, displaying an icon.
	Open() bool
	SetOpen(value bool)

	// The markup type that the annotation displays, either highlight, strikethrough, underline, or redact.
	MarkupType() PDFMarkupType
	SetMarkupType(value PDFMarkupType)
	// An array of values that represents the points bounding the marked-up text.
	QuadrilateralPoints() []foundation.NSValue
	SetQuadrilateralPoints(value []foundation.NSValue)

	// The type of widget annotation, such as button, choice, or text.
	WidgetFieldType() PDFAnnotationWidgetSubtype
	SetWidgetFieldType(value PDFAnnotationWidgetSubtype)
	// The string value of the widget annotation.
	WidgetStringValue() string
	SetWidgetStringValue(value string)
	// The string value that the widget reverts to when performing a reset form action.
	WidgetDefaultStringValue() string
	SetWidgetDefaultStringValue(value string)
	// The widget identifier for form annotation actions and behaviors.
	FieldName() string
	SetFieldName(value string)
	// The color of the widget’s background.
	BackgroundColor() objc.ID
	SetBackgroundColor(value objc.ID)
	// A Boolean value that determines whether the widget is editable.
	ReadOnly() bool
	SetReadOnly(value bool)

	// A Boolean value that indicates whether the text widget annotation displays multiple lines.
	Multiline() bool
	SetMultiline(value bool)
	// A Boolean value that indicates whether the text widget annotation displays a password field using bullet characters.
	IsPasswordField() bool
	// The maximum number of characters the text widget annotation allows.
	MaximumLength() int
	SetMaximumLength(value int)
	// A Boolean value that indicates whether the annotation divides the text widget’s bounds into equally spaced segments, such as in a form entry field.
	Comb() bool
	SetComb(value bool)

	// The type of button widget control, either radio button, push button, or checkbox.
	WidgetControlType() PDFWidgetControlType
	SetWidgetControlType(value PDFWidgetControlType)
	// The current state of the button widget annotation.
	ButtonWidgetState() PDFWidgetCellState
	SetButtonWidgetState(value PDFWidgetCellState)
	// A string value that differentiates button widgets in the same group, such as to identify mutually exclusive radio buttons from each other.
	ButtonWidgetStateString() string
	SetButtonWidgetStateString(value string)
	// The title of push button widget annotations.
	Caption() string
	SetCaption(value string)
	// A Boolean value that indicates whether clicking or tapping a selected radio button toggles it to an unselected state.
	AllowsToggleToOff() bool
	SetAllowsToggleToOff(value bool)
	// A Boolean value that indicates whether radio buttons in a group turn on and off in unison.
	RadiosInUnison() bool
	SetRadiosInUnison(value bool)

	// An array of strings that specifies the options in either a list or a pop-up menu.
	Choices() []string
	SetChoices(value []string)
	// A Boolean value that indicates whether the choice widget annotation is a list or a pop-up menu.
	ListChoice() bool
	SetListChoice(value bool)
	// An array of strings that specifies the export values for items in a list or a pop-up menu.
	Values() []string
	SetValues(value []string)

	// An array of bezier paths, in annotation-space coordinates, that compose the annotation.
	Paths() []objc.ID
	// Adds a bezier path to the ink annotation.
	AddBezierPath(path objectivec.IObject)
	// Removes a bezier path from an ink annotation.
	RemoveBezierPath(path objectivec.IObject)

	// The name of the stamp, a text or graphics annotation that emulates a rubber stamp effect.
	StampName() string
	SetStampName(value string)

	ActivatableTextField() bool

	EncodeWithCoder(coder foundation.INSCoder)
}

An interface definition for the PDFAnnotation class.

Creating an Annotation ¶

• [IPDFAnnotation.InitWithBoundsForTypeWithProperties]: Creates a PDF annotation with the specified bounds, type, and optional properties.

Accessing Information About an Annotation ¶

• [IPDFAnnotation.Page]: Returns the page that the annotation is associated with.
• [IPDFAnnotation.SetPage]
• [IPDFAnnotation.ModificationDate]: Returns the modification date of the annotation.
• [IPDFAnnotation.SetModificationDate]
• [IPDFAnnotation.UserName]: Returns the name of the user who created the annotation.
• [IPDFAnnotation.SetUserName]
• [IPDFAnnotation.Type]: Returns the type of the annotation.
• [IPDFAnnotation.SetType]
• [IPDFAnnotation.Action]: An object that represents an action for a PDF element, such as a link annotation.
• [IPDFAnnotation.SetAction]

Managing Annotation Drawing and Output ¶

• [IPDFAnnotation.DrawWithBoxInContext]: Draws the annotation in a graphics context using page-space coordinates relative to the origin of the specified box.
• [IPDFAnnotation.ShouldDisplay]: Returns a Boolean value indicating whether the annotation should be displayed.
• [IPDFAnnotation.SetShouldDisplay]
• [IPDFAnnotation.ShouldPrint]: Returns a Boolean value indicating whether the annotation should appear when the document is printed.
• [IPDFAnnotation.SetShouldPrint]

Modifying Annotation Attributes ¶

• [IPDFAnnotation.AnnotationKeyValues]: A dictionary that contains a deep copy of the widget’s properties.
• [IPDFAnnotation.ValueForAnnotationKey]: Returns a deep copy of the key-value pairs of properties for the specified key.
• [IPDFAnnotation.SetValueForAnnotationKey]: Sets a value in the annotation’s dictionary.
• [IPDFAnnotation.SetBooleanForAnnotationKey]: Sets a Boolean value in the annotation’s dictionary.
• [IPDFAnnotation.SetRectForAnnotationKey]: Sets a rectangle value in the annotation’s dictionary.
• [IPDFAnnotation.RemoveValueForAnnotationKey]: Removes a value from the annotation’s dictionary.

Managing Annotation Display Characteristics ¶

• [IPDFAnnotation.Alignment]: The alignment of the free text and text widget annotation’s text content.
• [IPDFAnnotation.SetAlignment]
• [IPDFAnnotation.Bounds]: Returns the bounding box for the annotation in page space.
• [IPDFAnnotation.SetBounds]
• [IPDFAnnotation.Contents]: Returns the textual content (if any) associated with the annotation.
• [IPDFAnnotation.SetContents]
• [IPDFAnnotation.Font]: The font the annotation uses to display text.
• [IPDFAnnotation.SetFont]
• [IPDFAnnotation.FontColor]: The font color the annotation uses to display text.
• [IPDFAnnotation.SetFontColor]
• [IPDFAnnotation.Border]: Sets the border style for the annotation.
• [IPDFAnnotation.SetBorder]
• [IPDFAnnotation.Highlighted]: A Boolean value that indicates whether the annotation is in a highlighted state, such as when the mouse is down on a link annotation.
• [IPDFAnnotation.SetHighlighted]
• [IPDFAnnotation.Color]: Sets the stroke color for the annotation.
• [IPDFAnnotation.SetColor]
• [IPDFAnnotation.HasAppearanceStream]: Returns a Boolean value that indicates whether the annotation has an appearance stream associated with it.

Configuring Shape Annotations ¶

• [IPDFAnnotation.InteriorColor]: The fill color for drawing a circle, line, or square annotation.
• [IPDFAnnotation.SetInteriorColor]

Configuring Line Annotations ¶

• [IPDFAnnotation.StartPoint]: The point where a line begins, in annotation-space coordinates.
• [IPDFAnnotation.SetStartPoint]
• [IPDFAnnotation.EndPoint]: The point where a line ends, in annotation-space coordinates.
• [IPDFAnnotation.SetEndPoint]
• [IPDFAnnotation.StartLineStyle]: The style of the line annotation’s starting point, such as square or filled arrowhead.
• [IPDFAnnotation.SetStartLineStyle]
• [IPDFAnnotation.EndLineStyle]: The style of the line annotation’s ending point, such as square or filled arrowhead.
• [IPDFAnnotation.SetEndLineStyle]

Configuring Link Annotations ¶

• [IPDFAnnotation.Destination]: The destination for a link annotation.
• [IPDFAnnotation.SetDestination]
• [IPDFAnnotation.URL]: A URL for a link annotation.
• [IPDFAnnotation.SetURL]

Configuring Text Annotations ¶

• [IPDFAnnotation.IconType]: The type of icon to display for a pop-up text annotation.
• [IPDFAnnotation.SetIconType]

Configuring Pop-Up Annotations ¶

• [IPDFAnnotation.Popup]: Returns the pop-up annotation associated with an annotation.
• [IPDFAnnotation.SetPopup]
• [IPDFAnnotation.Open]: A Boolean value that indicates whether the pop-up annotation is in an opened state, displaying its text content, or in a closed state, displaying an icon.
• [IPDFAnnotation.SetOpen]

Configuring Text Markup Annotations ¶

• [IPDFAnnotation.MarkupType]: The markup type that the annotation displays, either highlight, strikethrough, underline, or redact.
• [IPDFAnnotation.SetMarkupType]
• [IPDFAnnotation.QuadrilateralPoints]: An array of values that represents the points bounding the marked-up text.
• [IPDFAnnotation.SetQuadrilateralPoints]

Configuring Widget Annotations ¶

• [IPDFAnnotation.WidgetFieldType]: The type of widget annotation, such as button, choice, or text.
• [IPDFAnnotation.SetWidgetFieldType]
• [IPDFAnnotation.WidgetStringValue]: The string value of the widget annotation.
• [IPDFAnnotation.SetWidgetStringValue]
• [IPDFAnnotation.WidgetDefaultStringValue]: The string value that the widget reverts to when performing a reset form action.
• [IPDFAnnotation.SetWidgetDefaultStringValue]
• [IPDFAnnotation.FieldName]: The widget identifier for form annotation actions and behaviors.
• [IPDFAnnotation.SetFieldName]
• [IPDFAnnotation.BackgroundColor]: The color of the widget’s background.
• [IPDFAnnotation.SetBackgroundColor]
• [IPDFAnnotation.ReadOnly]: A Boolean value that determines whether the widget is editable.
• [IPDFAnnotation.SetReadOnly]

Configuring Text Widget Annotations ¶

• [IPDFAnnotation.Multiline]: A Boolean value that indicates whether the text widget annotation displays multiple lines.
• [IPDFAnnotation.SetMultiline]
• [IPDFAnnotation.IsPasswordField]: A Boolean value that indicates whether the text widget annotation displays a password field using bullet characters.
• [IPDFAnnotation.MaximumLength]: The maximum number of characters the text widget annotation allows.
• [IPDFAnnotation.SetMaximumLength]
• [IPDFAnnotation.Comb]: A Boolean value that indicates whether the annotation divides the text widget’s bounds into equally spaced segments, such as in a form entry field.
• [IPDFAnnotation.SetComb]

Configuring Button Widget Annotations ¶

• [IPDFAnnotation.WidgetControlType]: The type of button widget control, either radio button, push button, or checkbox.
• [IPDFAnnotation.SetWidgetControlType]
• [IPDFAnnotation.ButtonWidgetState]: The current state of the button widget annotation.
• [IPDFAnnotation.SetButtonWidgetState]
• [IPDFAnnotation.ButtonWidgetStateString]: A string value that differentiates button widgets in the same group, such as to identify mutually exclusive radio buttons from each other.
• [IPDFAnnotation.SetButtonWidgetStateString]
• [IPDFAnnotation.Caption]: The title of push button widget annotations.
• [IPDFAnnotation.SetCaption]
• [IPDFAnnotation.AllowsToggleToOff]: A Boolean value that indicates whether clicking or tapping a selected radio button toggles it to an unselected state.
• [IPDFAnnotation.SetAllowsToggleToOff]
• [IPDFAnnotation.RadiosInUnison]: A Boolean value that indicates whether radio buttons in a group turn on and off in unison.
• [IPDFAnnotation.SetRadiosInUnison]

Configuring Choice Widget Annotations ¶

• [IPDFAnnotation.Choices]: An array of strings that specifies the options in either a list or a pop-up menu.
• [IPDFAnnotation.SetChoices]
• [IPDFAnnotation.ListChoice]: A Boolean value that indicates whether the choice widget annotation is a list or a pop-up menu.
• [IPDFAnnotation.SetListChoice]
• [IPDFAnnotation.Values]: An array of strings that specifies the export values for items in a list or a pop-up menu.
• [IPDFAnnotation.SetValues]

Configuring Ink Annotations ¶

• [IPDFAnnotation.Paths]: An array of bezier paths, in annotation-space coordinates, that compose the annotation.
• [IPDFAnnotation.AddBezierPath]: Adds a bezier path to the ink annotation.
• [IPDFAnnotation.RemoveBezierPath]: Removes a bezier path from an ink annotation.

Configuring Stamp Annotations ¶

• [IPDFAnnotation.StampName]: The name of the stamp, a text or graphics annotation that emulates a rubber stamp effect.
• [IPDFAnnotation.SetStampName]

Instance Properties ¶

• [IPDFAnnotation.ActivatableTextField]

See: https://developer.apple.com/documentation/PDFKit/PDFAnnotation

type IPDFAppearanceCharacteristics ¶

type IPDFAppearanceCharacteristics interface {
	objectivec.IObject

	// The background color of the widget annotation.
	BackgroundColor() objc.ID
	SetBackgroundColor(value objc.ID)
	// The border color of the widget annotation.
	BorderColor() objc.ID
	SetBorderColor(value objc.ID)
	// The text that the button widget annotation displays when the user isn’t interacting with it.
	Caption() string
	SetCaption(value string)
	// The type of button widget annotation.
	ControlType() PDFWidgetControlType
	SetControlType(value PDFWidgetControlType)
	// The text that the button widget annotation displays when the user holds down on it.
	DownCaption() string
	SetDownCaption(value string)
	// The text that the widget annotation displays when the user hovers the pointer over it.
	RolloverCaption() string
	SetRolloverCaption(value string)
	// The number of degrees, in multiples of 90, that the widget annotation rotates counterclockwise relative to the page.
	Rotation() int
	SetRotation(value int)
	// A dictionary that contains a deep copy of the appearance characteristic key-value pairs.
	AppearanceCharacteristicsKeyValues() foundation.INSDictionary

	// The widget identifier for form annotation actions and behaviors.
	FieldName() string
	SetFieldName(value string)
	// A Boolean value that determines whether the widget is editable.
	IsReadOnly() bool
	SetIsReadOnly(value bool)
	// The string value that the widget reverts to when performing a reset form action.
	WidgetDefaultStringValue() string
	SetWidgetDefaultStringValue(value string)
	// The type of widget annotation, such as button, choice, or text.
	WidgetFieldType() PDFAnnotationWidgetSubtype
	SetWidgetFieldType(value PDFAnnotationWidgetSubtype)
	// The string value of the widget annotation.
	WidgetStringValue() string
	SetWidgetStringValue(value string)
}

An interface definition for the PDFAppearanceCharacteristics class.

Configuring a Widget’s Appearance ¶

• [IPDFAppearanceCharacteristics.BackgroundColor]: The background color of the widget annotation.
• [IPDFAppearanceCharacteristics.SetBackgroundColor]
• [IPDFAppearanceCharacteristics.BorderColor]: The border color of the widget annotation.
• [IPDFAppearanceCharacteristics.SetBorderColor]
• [IPDFAppearanceCharacteristics.Caption]: The text that the button widget annotation displays when the user isn’t interacting with it.
• [IPDFAppearanceCharacteristics.SetCaption]
• [IPDFAppearanceCharacteristics.ControlType]: The type of button widget annotation.
• [IPDFAppearanceCharacteristics.SetControlType]
• [IPDFAppearanceCharacteristics.DownCaption]: The text that the button widget annotation displays when the user holds down on it.
• [IPDFAppearanceCharacteristics.SetDownCaption]
• [IPDFAppearanceCharacteristics.RolloverCaption]: The text that the widget annotation displays when the user hovers the pointer over it.
• [IPDFAppearanceCharacteristics.SetRolloverCaption]
• [IPDFAppearanceCharacteristics.Rotation]: The number of degrees, in multiples of 90, that the widget annotation rotates counterclockwise relative to the page.
• [IPDFAppearanceCharacteristics.SetRotation]
• [IPDFAppearanceCharacteristics.AppearanceCharacteristicsKeyValues]: A dictionary that contains a deep copy of the appearance characteristic key-value pairs.

See: https://developer.apple.com/documentation/PDFKit/PDFAppearanceCharacteristics

type IPDFBorder ¶

type IPDFBorder interface {
	objectivec.IObject

	// Sets the border style.
	Style() PDFBorderStyle
	SetStyle(value PDFBorderStyle)
	// Sets the line width (in points) for the border.
	LineWidth() float64
	SetLineWidth(value float64)
	// Gets the dash pattern for the border as an array of NSNumber objects.
	DashPattern() foundation.INSArray
	SetDashPattern(value foundation.INSArray)
	// A dictionary that contains a deep copy of all border properties.
	BorderKeyValues() foundation.INSDictionary

	// Draws the border.
	DrawInRect(rect corefoundation.CGRect)

	// The alignment of the free text and text widget annotation’s text content.
	Alignment() appkit.NSTextAlignment
	SetAlignment(value appkit.NSTextAlignment)
	// Sets the border style for the annotation.
	Border() IPDFBorder
	SetBorder(value IPDFBorder)
	// Returns the bounding box for the annotation in page space.
	Bounds() corefoundation.CGRect
	SetBounds(value corefoundation.CGRect)
	// Sets the stroke color for the annotation.
	Color() objc.ID
	SetColor(value objc.ID)
	// Returns the textual content (if any) associated with the annotation.
	Contents() string
	SetContents(value string)
	// The font the annotation uses to display text.
	Font() objectivec.IObject
	SetFont(value objectivec.IObject)
	// The font color the annotation uses to display text.
	FontColor() objc.ID
	SetFontColor(value objc.ID)
	// Returns a Boolean value that indicates whether the annotation has an appearance stream associated with it.
	HasAppearanceStream() bool
	SetHasAppearanceStream(value bool)
	// A Boolean value that indicates whether the annotation is in a highlighted state, such as when the mouse is down on a link annotation.
	IsHighlighted() bool
	SetIsHighlighted(value bool)
	EncodeWithCoder(coder foundation.INSCoder)
}

An interface definition for the PDFBorder class.

Working with Border Styles and Characteristics ¶

• [IPDFBorder.Style]: Sets the border style.
• [IPDFBorder.SetStyle]
• [IPDFBorder.LineWidth]: Sets the line width (in points) for the border.
• [IPDFBorder.SetLineWidth]
• [IPDFBorder.DashPattern]: Gets the dash pattern for the border as an array of NSNumber objects.
• [IPDFBorder.SetDashPattern]
• [IPDFBorder.BorderKeyValues]: A dictionary that contains a deep copy of all border properties.

Drawing Borders ¶

• [IPDFBorder.DrawInRect]: Draws the border.

See: https://developer.apple.com/documentation/PDFKit/PDFBorder

type IPDFDestination ¶

type IPDFDestination interface {
	objectivec.IObject

	// Initializes the destination.
	InitWithPageAtPoint(page IPDFPage, point corefoundation.CGPoint) PDFDestination

	// Returns the page that the destination refers to.
	Page() IPDFPage
	// Returns the point, in page space, that the destination refers to.
	Point() corefoundation.CGPoint
	KPDFDestinationUnspecifiedValue() float64

	// Returns a comparison result that indicates the location of the destination in the document, relative to the current position.
	Compare(destination IPDFDestination) foundation.NSComparisonResult

	Zoom() float64
	SetZoom(value float64)

	// An object that represents an action for a PDF element, such as a link annotation.
	Action() IPDFAction
	SetAction(value IPDFAction)
	// Returns a
	CurrentDestination() IPDFDestination
	SetCurrentDestination(value IPDFDestination)
	// Returns the modification date of the annotation.
	ModificationDate() foundation.INSDate
	SetModificationDate(value foundation.INSDate)
	// Returns the type of the annotation.
	Type() string
	SetType(value string)
	// Returns the name of the user who created the annotation.
	UserName() string
	SetUserName(value string)
}

An interface definition for the PDFDestination class.

Initializing a Destination ¶

• [IPDFDestination.InitWithPageAtPoint]: Initializes the destination.

Getting Pages and Points ¶

• [IPDFDestination.Page]: Returns the page that the destination refers to.
• [IPDFDestination.Point]: Returns the point, in page space, that the destination refers to.
• [IPDFDestination.KPDFDestinationUnspecifiedValue]

Getting a Relative Location ¶

• [IPDFDestination.Compare]: Returns a comparison result that indicates the location of the destination in the document, relative to the current position.

Instance Properties ¶

• [IPDFDestination.Zoom]
• [IPDFDestination.SetZoom]

See: https://developer.apple.com/documentation/PDFKit/PDFDestination

type IPDFDocument ¶

type IPDFDocument interface {
	objectivec.IObject

	// Initializes a [PDFDocument] object with the contents at the specified URL (if the URL is invalid, this method returns [NULL]).
	InitWithURL(url foundation.INSURL) PDFDocument
	// Initializes a [PDFDocument] object with the passed-in data.
	InitWithData(data foundation.INSData) PDFDocument

	// The object acting as the delegate for the [PDFDocument] object.
	Delegate() PDFDocumentDelegate
	SetDelegate(value PDFDocumentDelegate)

	AccessPermissions() PDFAccessPermissions

	SelectionFromPageAtPointToPageAtPointWithGranularity(startPage IPDFPage, startPoint corefoundation.CGPoint, endPage IPDFPage, endPoint corefoundation.CGPoint, granularity PDFSelectionGranularity) IPDFSelection

	// A Boolean value indicating whether you can create or modify document annotations, including form field entries.
	AllowsCommenting() bool
	// A Boolean value indicating whether you can extract content from the document, but only for the purpose of accessibility.
	AllowsContentAccessibility() bool
	// A Boolean value indicating whether the document allows copying of content to the Pasteboard.
	AllowsCopying() bool
	// A Boolean value indicating whether you can manage a document by inserting, deleting, and rotating pages.
	AllowsDocumentAssembly() bool
	// A Boolean value indicating whether you can modify the document contents except for document attributes.
	AllowsDocumentChanges() bool
	// A Boolean value indicating whether you can modify form field entries even if you can’t edit document annotations.
	AllowsFormFieldEntry() bool
	// A Boolean value indicating whether the document allows printing.
	AllowsPrinting() bool
	// A dictionary of document metadata.
	DocumentAttributes() foundation.INSDictionary
	SetDocumentAttributes(value foundation.INSDictionary)
	// The [CGPDFDocument] associated with the [PDFDocument] object.
	DocumentRef() coregraphics.CGPDFDocumentRef
	// The URL for the document.
	DocumentURL() foundation.INSURL
	// A Boolean value specifying whether the document is encrypted.
	IsEncrypted() bool
	// Returns a Boolean value indicating whether an asynchronous find operation is in progress.
	IsFinding() bool
	// A Boolean value indicating whether the document is locked.
	IsLocked() bool
	// The major version of the document.
	MajorVersion() int
	// The minor version of the document.
	MinorVersion() int
	// The document’s root outline to a PDF outline object.
	OutlineRoot() IPDFOutline
	SetOutlineRoot(value IPDFOutline)
	// The class that is allocated and initialized when page objects are created for the document.
	PageClass() objc.Class
	// The number of pages in the document.
	PageCount() uint
	// The permissions status of the PDF document.
	PermissionsStatus() PDFDocumentPermissions
	// Returns a selection representing the textual content of the entire document.
	SelectionForEntireDocument() IPDFSelection
	// A string representing the textual content for the entire document.
	String() string
	// Asynchronously finds all instances of the specified string in the document.
	BeginFindStringWithOptions(string_ string, options foundation.NSStringCompareOptions)
	// Asynchronously finds all instances of the specified array of strings in the document.
	BeginFindStringsWithOptions(strings []string, options foundation.NSStringCompareOptions)
	// Cancels a search initiated with [beginFindString(_:withOptions:)](<doc://com.apple.pdfkit/documentation/PDFKit/PDFDocument/beginFindString(_:withOptions:)>).
	CancelFindString()
	// Returns a representation of the document as an [NSData] object.
	DataRepresentation() foundation.INSData
	// Returns a representation of the document as an [NSData] object with additional options applied, such as filters.
	DataRepresentationWithOptions(options foundation.INSDictionary) foundation.INSData
	// Swaps one page with another.
	ExchangePageAtIndexWithPageAtIndex(indexA uint, indexB uint)
	// Synchronously finds the next occurance of a string after the specified selection (or before the selection if you specified [NSBackwardsSearch] as a search option.
	FindStringFromSelectionWithOptions(string_ string, selection IPDFSelection, options foundation.NSStringCompareOptions) IPDFSelection
	// Synchronously finds all instances of the specified string in the document.
	FindStringWithOptions(string_ string, options foundation.NSStringCompareOptions) []PDFSelection
	// Gets the index number for the specified page.
	IndexForPage(page IPDFPage) uint
	// Inserts a page at the specified index point.
	InsertPageAtIndex(page IPDFPage, index uint)
	// Returns the most likely parent PDF outline object for the selection.
	OutlineItemForSelection(selection IPDFSelection) IPDFOutline
	// Returns the page at the specified index number.
	PageAtIndex(index uint) IPDFPage
	// Returns a print operation suitable for printing the PDF document.
	PrintOperationForPrintInfoScalingModeAutoRotate(printInfo appkit.NSPrintInfo, scaleMode PDFPrintScalingMode, doRotate bool) appkit.NSPrintOperation
	// Removes the page at the specified index point.
	RemovePageAtIndex(index uint)
	// Returns the specified selection based on starting and ending character indexes.
	SelectionFromPageAtCharacterIndexToPageAtCharacterIndex(startPage IPDFPage, startCharacter uint, endPage IPDFPage, endCharacter uint) IPDFSelection
	// Returns the specified selection based on starting and ending points.
	SelectionFromPageAtPointToPageAtPoint(startPage IPDFPage, startPoint corefoundation.CGPoint, endPage IPDFPage, endPoint corefoundation.CGPoint) IPDFSelection
	// Attempts to unlock an encrypted document.
	UnlockWithPassword(password string) bool
	// Writes the document to a file at the specified path.
	WriteToFile(path string) bool
	// Writes the document to a file at the specified path with the specified options.
	WriteToFileWithOptions(path string, options foundation.INSDictionary) bool
	// Writes the document to a location specified by the passed-in URL.
	WriteToURL(url foundation.INSURL) bool
	// Writes the document to the specified URL with the specified options.
	WriteToURLWithOptions(url foundation.INSURL, options foundation.INSDictionary) bool
}

An interface definition for the PDFDocument class.

Initializing Documents ¶

• [IPDFDocument.InitWithURL]: Initializes a PDFDocument object with the contents at the specified URL (if the URL is invalid, this method returns [NULL]).
• [IPDFDocument.InitWithData]: Initializes a PDFDocument object with the passed-in data.

Setting the Delegate ¶

• [IPDFDocument.Delegate]: The object acting as the delegate for the PDFDocument object.
• [IPDFDocument.SetDelegate]

Instance Properties ¶

• [IPDFDocument.AccessPermissions]

Instance Methods ¶

• [IPDFDocument.SelectionFromPageAtPointToPageAtPointWithGranularity]

See: https://developer.apple.com/documentation/PDFKit/PDFDocument

type IPDFOutline ¶

type IPDFOutline interface {
	objectivec.IObject

	// Returns the document with which the outline is associated.
	Document() IPDFDocument
	// Returns the number of child outline objects in the outline.
	NumberOfChildren() uint
	// Returns the parent outline object of the outline (returns [NULL] if called on the root outline object).
	Parent() IPDFOutline
	// Returns the child outline object at the specified index.
	ChildAtIndex(index uint) IPDFOutline
	// Returns the index of the outline.
	Index() uint

	// Returns the label for the outline.
	Label() string
	SetLabel(value string)

	// Returns the destination associated with the outline.
	Destination() IPDFDestination
	SetDestination(value IPDFDestination)
	// Returns the action performed when users click the outline.
	Action() IPDFAction
	SetAction(value IPDFAction)

	// Inserts the specified outline object at the specified index.
	InsertChildAtIndex(child IPDFOutline, index uint)
	// Removes the outline object from its parent (does nothing if outline object is the root outline object).
	RemoveFromParent()

	// Returns a Boolean value that indicates whether the outline object is initially disclosed.
	IsOpen() bool
	SetIsOpen(value bool)
}

An interface definition for the PDFOutline class.

Getting Information About an Outline ¶

• [IPDFOutline.Document]: Returns the document with which the outline is associated.
• [IPDFOutline.NumberOfChildren]: Returns the number of child outline objects in the outline.
• [IPDFOutline.Parent]: Returns the parent outline object of the outline (returns [NULL] if called on the root outline object).
• [IPDFOutline.ChildAtIndex]: Returns the child outline object at the specified index.
• [IPDFOutline.Index]: Returns the index of the outline.

Managing Outline Labels ¶

• [IPDFOutline.Label]: Returns the label for the outline.
• [IPDFOutline.SetLabel]

Managing Actions and Destinations ¶

• [IPDFOutline.Destination]: Returns the destination associated with the outline.
• [IPDFOutline.SetDestination]
• [IPDFOutline.Action]: Returns the action performed when users click the outline.
• [IPDFOutline.SetAction]

Changing an Outline Hierarchy ¶

• [IPDFOutline.InsertChildAtIndex]: Inserts the specified outline object at the specified index.
• [IPDFOutline.RemoveFromParent]: Removes the outline object from its parent (does nothing if outline object is the root outline object).

Managing the Disclosure of an Outline Object ¶

• [IPDFOutline.IsOpen]: Returns a Boolean value that indicates whether the outline object is initially disclosed.
• [IPDFOutline.SetIsOpen]

See: https://developer.apple.com/documentation/PDFKit/PDFOutline

type IPDFPage ¶

type IPDFPage interface {
	objectivec.IObject

	// Creates a new [PDFPage] object and initializes it with the specified [NSImage] object.
	InitWithImage(image objectivec.IObject) PDFPage

	// Returns the [PDFDocument] object with which the page is associated.
	Document() IPDFDocument
	// Returns the label for the page.
	Label() string
	// Returns the bounds for the specified PDF display box.
	BoundsForBox(box PDFDisplayBox) corefoundation.CGRect
	// Sets the bounds for the specified box.
	SetBoundsForBox(bounds corefoundation.CGRect, box PDFDisplayBox)
	// Sets the rotation angle for the page in degrees.
	Rotation() int
	SetRotation(value int)

	// Returns an array containing the page’s annotations.
	Annotations() []PDFAnnotation
	// Returns a Boolean value indicating whether annotations are displayed for the page.
	DisplaysAnnotations() bool
	SetDisplaysAnnotations(value bool)
	// Adds the specified annotation object to the page.
	AddAnnotation(annotation IPDFAnnotation)
	// Removes the specified annotation from the page.
	RemoveAnnotation(annotation IPDFAnnotation)
	// Returns the annotation, if there is one, at the specified point.
	AnnotationAtPoint(point corefoundation.CGPoint) IPDFAnnotation

	// Returns the number of characters on the page, including whitespace characters.
	NumberOfCharacters() uint
	// Returns an [NSString] object representing the text on the page.
	String() string
	// Returns an [NSAttributedString] object representing the text on the page.
	AttributedString() foundation.NSAttributedString
	// Returns the bounds, in page space, of the character at the specified index.
	CharacterBoundsAtIndex(index int) corefoundation.CGRect
	// Returns the character index value for the specified point in page space.
	CharacterIndexAtPoint(point corefoundation.CGPoint) int

	// Returns the text enclosed within the specified rectangle, expressed in page (user) coordinates.
	SelectionForRect(rect corefoundation.CGRect) IPDFSelection
	// Returns the whole word that includes the specified point.
	SelectionForWordAtPoint(point corefoundation.CGPoint) IPDFSelection
	// Returns the whole line of text that includes the specified point.
	SelectionForLineAtPoint(point corefoundation.CGPoint) IPDFSelection
	// Returns the text between the two specified points in page space.
	SelectionFromPointToPoint(startPoint corefoundation.CGPoint, endPoint corefoundation.CGPoint) IPDFSelection
	// Returns the text contained within the specified range.
	SelectionForRange(range_ foundation.NSRange) IPDFSelection

	InitWithImageOptions(image objectivec.IObject, options foundation.INSDictionary) PDFPage

	// Returns the PDF data (that is, a PDF document) representing this page. This method does not preserve external page links.
	DataRepresentation() foundation.INSData
	PageRef() coregraphics.CGPDFPageRef

	DrawWithBoxToContext(box PDFDisplayBox, context coregraphics.CGContextRef)
	ThumbnailOfSizeForBox(size corefoundation.CGSize, box PDFDisplayBox) objc.ID
	TransformContextForBox(context coregraphics.CGContextRef, box PDFDisplayBox)
	TransformForBox(box PDFDisplayBox) corefoundation.CGAffineTransform
}

An interface definition for the PDFPage class.

Initializing a Page ¶

• [IPDFPage.InitWithImage]: Creates a new PDFPage object and initializes it with the specified [NSImage] object.

Getting Information About a Page ¶

• [IPDFPage.Document]: Returns the PDFDocument object with which the page is associated.
• [IPDFPage.Label]: Returns the label for the page.
• [IPDFPage.BoundsForBox]: Returns the bounds for the specified PDF display box.
• [IPDFPage.SetBoundsForBox]: Sets the bounds for the specified box.
• [IPDFPage.Rotation]: Sets the rotation angle for the page in degrees.
• [IPDFPage.SetRotation]

Working with Annotations ¶

• [IPDFPage.Annotations]: Returns an array containing the page’s annotations.
• [IPDFPage.DisplaysAnnotations]: Returns a Boolean value indicating whether annotations are displayed for the page.
• [IPDFPage.SetDisplaysAnnotations]
• [IPDFPage.AddAnnotation]: Adds the specified annotation object to the page.
• [IPDFPage.RemoveAnnotation]: Removes the specified annotation from the page.
• [IPDFPage.AnnotationAtPoint]: Returns the annotation, if there is one, at the specified point.

Working with Textual Content ¶

• [IPDFPage.NumberOfCharacters]: Returns the number of characters on the page, including whitespace characters.
• [IPDFPage.String]: Returns an [NSString] object representing the text on the page.
• [IPDFPage.AttributedString]: Returns an [NSAttributedString] object representing the text on the page.
• [IPDFPage.CharacterBoundsAtIndex]: Returns the bounds, in page space, of the character at the specified index.
• [IPDFPage.CharacterIndexAtPoint]: Returns the character index value for the specified point in page space.

Working with Selections ¶

• [IPDFPage.SelectionForRect]: Returns the text enclosed within the specified rectangle, expressed in page (user) coordinates.
• [IPDFPage.SelectionForWordAtPoint]: Returns the whole word that includes the specified point.
• [IPDFPage.SelectionForLineAtPoint]: Returns the whole line of text that includes the specified point.
• [IPDFPage.SelectionFromPointToPoint]: Returns the text between the two specified points in page space.
• [IPDFPage.SelectionForRange]: Returns the text contained within the specified range.

Initializers ¶

• [IPDFPage.InitWithImageOptions]

Instance Properties ¶

• [IPDFPage.DataRepresentation]: Returns the PDF data (that is, a PDF document) representing this page. This method does not preserve external page links.
• [IPDFPage.PageRef]

Instance Methods ¶

• [IPDFPage.DrawWithBoxToContext]
• [IPDFPage.ThumbnailOfSizeForBox]
• [IPDFPage.TransformContextForBox]
• [IPDFPage.TransformForBox]

See: https://developer.apple.com/documentation/PDFKit/PDFPage

type IPDFSelection ¶

type IPDFSelection interface {
	objectivec.IObject

	// Returns an empty [PDFSelection] object.
	InitWithDocument(document IPDFDocument) PDFSelection

	// Returns the array of pages contained in the selection.
	Pages() []PDFPage
	// Returns an [NSString] object representing the text contained in the selection (may contain linefeed characters).
	String() string
	// Returns an [NSAttributedString] object representing the text contained in the selection (may contain linefeed characters).
	AttributedString() foundation.NSAttributedString
	// Returns the bounds of the selection on the specified page.
	BoundsForPage(page IPDFPage) corefoundation.CGRect
	// Returns an array of selections, one for each line of text covered by the receiver.
	SelectionsByLine() []PDFSelection
	// Sets the color used for the drawing of a selection in both active and inactive states.
	Color() objc.ID
	SetColor(value objc.ID)

	// Adds the specified selection to the receiving selection.
	AddSelection(selection IPDFSelection)
	// Adds the specified array of selections to the receiving selection.
	AddSelections(selections []PDFSelection)
	// Extends the selection from its end toward the end of the document.
	ExtendSelectionAtEnd(succeed int)
	// Extends the selection from its start toward the beginning of the document.
	ExtendSelectionAtStart(precede int)

	// Calls [draw(for:with:active:)](<doc://com.apple.pdfkit/documentation/PDFKit/PDFSelection/draw(for:with:active:)>) with a default value for box parameter.
	DrawForPageActive(page IPDFPage, active bool)
	// Draws the selection relative to the origin of the specified box in page space.
	DrawForPageWithBoxActive(page IPDFPage, box PDFDisplayBox, active bool)

	ExtendSelectionForLineBoundaries()
	NumberOfTextRangesOnPage(page IPDFPage) uint
	RangeAtIndexOnPage(index uint, page IPDFPage) foundation.NSRange
}

An interface definition for the PDFSelection class.

Initializing a Selection ¶

• [IPDFSelection.InitWithDocument]: Returns an empty PDFSelection object.

Getting Information About a Selection ¶

• [IPDFSelection.Pages]: Returns the array of pages contained in the selection.
• [IPDFSelection.String]: Returns an [NSString] object representing the text contained in the selection (may contain linefeed characters).
• [IPDFSelection.AttributedString]: Returns an [NSAttributedString] object representing the text contained in the selection (may contain linefeed characters).
• [IPDFSelection.BoundsForPage]: Returns the bounds of the selection on the specified page.
• [IPDFSelection.SelectionsByLine]: Returns an array of selections, one for each line of text covered by the receiver.
• [IPDFSelection.Color]: Sets the color used for the drawing of a selection in both active and inactive states.
• [IPDFSelection.SetColor]

Modifying a Selection ¶

• [IPDFSelection.AddSelection]: Adds the specified selection to the receiving selection.
• [IPDFSelection.AddSelections]: Adds the specified array of selections to the receiving selection.
• [IPDFSelection.ExtendSelectionAtEnd]: Extends the selection from its end toward the end of the document.
• [IPDFSelection.ExtendSelectionAtStart]: Extends the selection from its start toward the beginning of the document.

Managing Selection Drawing ¶

• [IPDFSelection.DrawForPageActive]: Calls [draw(for:with:active:)](<doc://com.apple.pdfkit/documentation/PDFKit/PDFSelection/draw(for:with:active:)>) with a default value for box parameter.
• [IPDFSelection.DrawForPageWithBoxActive]: Draws the selection relative to the origin of the specified box in page space.

Instance Methods ¶

• [IPDFSelection.ExtendSelectionForLineBoundaries]
• [IPDFSelection.NumberOfTextRangesOnPage]
• [IPDFSelection.RangeAtIndexOnPage]

See: https://developer.apple.com/documentation/PDFKit/PDFSelection

type IPDFThumbnailView ¶

type IPDFThumbnailView interface {
	appkit.INSView

	// Returns the [PDFView] object associated with the thumbnail view.
	PDFView() IPDFView
	SetPDFView(value IPDFView)

	// Returns the maximum width and height of the thumbnails in the thumbnail view.
	ThumbnailSize() corefoundation.CGSize
	SetThumbnailSize(value corefoundation.CGSize)

	// Returns the maximum number of columns of thumbnails the thumbnail view can display.
	MaximumNumberOfColumns() uint
	SetMaximumNumberOfColumns(value uint)
	// Returns the font used to label the thumbnails.
	LabelFont() appkit.NSFont
	SetLabelFont(value appkit.NSFont)
	// Returns the color used in the background of the thumbnail view.
	BackgroundColor() objc.ID
	SetBackgroundColor(value objc.ID)

	// Returns a Boolean value indicating whether users can drag thumbnails (that is, re-order pages in the document) within the thumbnail view.
	AllowsDragging() bool
	SetAllowsDragging(value bool)
	// Returns a Boolean value indicating whether users can select multiple thumbnails in the thumbnail view at one time.
	AllowsMultipleSelection() bool
	SetAllowsMultipleSelection(value bool)
	// Returns an array of PDF pages that correspond to the selected thumbnails in the thumbnail view.
	SelectedPages() []PDFPage
}

An interface definition for the PDFThumbnailView class.

Accessing the Associated PDF View ¶

• [IPDFThumbnailView.PDFView]: Returns the PDFView object associated with the thumbnail view.
• [IPDFThumbnailView.SetPDFView]

Managing the Size of a Thumbnail View ¶

• [IPDFThumbnailView.ThumbnailSize]: Returns the maximum width and height of the thumbnails in the thumbnail view.
• [IPDFThumbnailView.SetThumbnailSize]

Working with Thumbnail View Display Characteristics ¶

• [IPDFThumbnailView.MaximumNumberOfColumns]: Returns the maximum number of columns of thumbnails the thumbnail view can display.
• [IPDFThumbnailView.SetMaximumNumberOfColumns]
• [IPDFThumbnailView.LabelFont]: Returns the font used to label the thumbnails.
• [IPDFThumbnailView.SetLabelFont]
• [IPDFThumbnailView.BackgroundColor]: Returns the color used in the background of the thumbnail view.
• [IPDFThumbnailView.SetBackgroundColor]

Managing the Behavior of a Thumbnail View ¶

• [IPDFThumbnailView.AllowsDragging]: Returns a Boolean value indicating whether users can drag thumbnails (that is, re-order pages in the document) within the thumbnail view.
• [IPDFThumbnailView.SetAllowsDragging]
• [IPDFThumbnailView.AllowsMultipleSelection]: Returns a Boolean value indicating whether users can select multiple thumbnails in the thumbnail view at one time.
• [IPDFThumbnailView.SetAllowsMultipleSelection]
• [IPDFThumbnailView.SelectedPages]: Returns an array of PDF pages that correspond to the selected thumbnails in the thumbnail view.

See: https://developer.apple.com/documentation/PDFKit/PDFThumbnailView

type IPDFView ¶

type IPDFView interface {
	appkit.INSView

	// Returns the document associated with a [PDFView] object.
	Document() IPDFDocument
	SetDocument(value IPDFDocument)

	// Returns the current page.
	CurrentPage() IPDFPage
	// Returns a [PDFDestination] object representing the current page and the current point in the view specified in page space.
	CurrentDestination() IPDFDestination
	// Returns an array of [PDFPage] objects that represent the currently visible pages.
	VisiblePages() []PDFPage

	// Returns the view’s delegate.
	Delegate() PDFViewDelegate
	SetDelegate(value PDFViewDelegate)

	InMarkupMode() bool
	SetInMarkupMode(value bool)
	PageOverlayViewProvider() PDFPageOverlayViewProvider
	SetPageOverlayViewProvider(value PDFPageOverlayViewProvider)
	PageShadowsEnabled() bool
	SetPageShadowsEnabled(value bool)

	// A Boolean value indicating whether you can drag a file into the view.
	AcceptsDraggedFiles() bool
	SetAcceptsDraggedFiles(value bool)
	// A Boolean value indicating whether autoscaling is set.
	AutoScales() bool
	SetAutoScales(value bool)
	// The view’s background color.
	BackgroundColor() objc.ID
	SetBackgroundColor(value objc.ID)
	// Returns a Boolean value indicating whether the user can navigate to the previous page in the page history.
	CanGoBack() bool
	// Returns a Boolean value indicating whether the user can navigate to the next page in the page history.
	CanGoForward() bool
	// Returns a Boolean value indicating whether the user can navigate to the first page of the document.
	CanGoToFirstPage() bool
	// Returns a Boolean value indicating whether the user can navigate to the last page of the document.
	CanGoToLastPage() bool
	// Returns a Boolean value indicating whether the user can navigate to the next page of the document.
	CanGoToNextPage() bool
	// Returns a Boolean value indicating whether the user can navigate to the previous page of the document.
	CanGoToPreviousPage() bool
	// Returns a Boolean value indicating whether the user can magnify the view and zoom in.
	CanZoomIn() bool
	// Returns a Boolean value indicating whether the user can view an expanded area and zoom out.
	CanZoomOut() bool
	// The current selection.
	CurrentSelection() IPDFSelection
	SetCurrentSelection(value IPDFSelection)
	// The current style of display box.
	DisplayBox() PDFDisplayBox
	SetDisplayBox(value PDFDisplayBox)
	// The layout direction, either vertical or horizontal, for the given display mode.
	DisplayDirection() PDFDisplayDirection
	SetDisplayDirection(value PDFDisplayDirection)
	// The current display mode.
	DisplayMode() PDFDisplayMode
	SetDisplayMode(value PDFDisplayMode)
	// A Boolean value indicating whether the view will display the first page as a book cover (meaningful only when the document is in two-up or two-up continuous display mode).
	DisplaysAsBook() bool
	SetDisplaysAsBook(value bool)
	// A Boolean value indicating whether the view is displaying page breaks.
	DisplaysPageBreaks() bool
	SetDisplaysPageBreaks(value bool)
	// The presentation of pages from right-to-left.
	DisplaysRTL() bool
	SetDisplaysRTL(value bool)
	// The innermost view used by [PDFView] or by your [PDFView] subclass.
	DocumentView() objc.ID
	// A Boolean value indicating whether to turns on or off data detection, which adds annotations for detected URLs in a page.
	EnableDataDetectors() bool
	SetEnableDataDetectors(value bool)
	// Returns the array of selections that are highlighted using `setHighlightedSelections`.
	HighlightedSelections() []PDFSelection
	SetHighlightedSelections(value []PDFSelection)
	// The interpolation quality for images drawn into the [PDFView] context.
	InterpolationQuality() PDFInterpolationQuality
	SetInterpolationQuality(value PDFInterpolationQuality)
	// The maximum scaling factor for the PDF document.
	MaxScaleFactor() float64
	SetMaxScaleFactor(value float64)
	// The minimum scaling factor for the PDF document.
	MinScaleFactor() float64
	SetMinScaleFactor(value float64)
	// The spacing between pages as defined by the top, bottom, left, and right margins.
	PageBreakMargins() objectivec.IObject
	SetPageBreakMargins(value objectivec.IObject)
	// The current scale factor for the view.
	ScaleFactor() float64
	SetScaleFactor(value float64)
	// The “size to fit” scale factor that `autoScales` would use for scaling the current document and layout.
	ScaleFactorForSizeToFit() float64
	// Tells the PDF view that an annotation on the specified page has changed.
	AnnotationsChangedOnPage(page IPDFPage)
	// Returns the type of area the mouse cursor is over.
	AreaOfInterestForMouse(event objectivec.IObject) PDFAreaOfInterest
	// Returns the type of area for a specific cursor location point.
	AreaOfInterestForPoint(cursorLocation corefoundation.CGPoint) PDFAreaOfInterest
	// Clears the selection.
	ClearSelection()
	// Converts a point from page space to view space.
	ConvertPointFromPage(point corefoundation.CGPoint, page IPDFPage) corefoundation.CGPoint
	// Converts a point from view space to page space.
	ConvertPointToPage(point corefoundation.CGPoint, page IPDFPage) corefoundation.CGPoint
	// Converts a rectangle from page space to view space.
	ConvertRectFromPage(rect corefoundation.CGRect, page IPDFPage) corefoundation.CGRect
	// Converts a rectangle from view space to page space.
	ConvertRectToPage(rect corefoundation.CGRect, page IPDFPage) corefoundation.CGRect
	// Copies the text in the selection, if any, to the Pasteboard.
	Copy(sender objectivec.IObject)
	// Perform post-page rendering for a page rendered to a context.
	DrawPagePostToContext(page IPDFPage, context coregraphics.CGContextRef)
	// Draw and render a visible page to a context.
	DrawPageToContext(page IPDFPage, context coregraphics.CGContextRef)
	// Navigates back one step in the page history.
	GoBack(sender objectivec.IObject)
	// Navigates forward one step in the page history.
	GoForward(sender objectivec.IObject)
	// Navigates to the specified destination.
	GoToDestination(destination IPDFDestination)
	// Navigates to the first page of the document.
	GoToFirstPage(sender objectivec.IObject)
	// Navigates to the last page of the document.
	GoToLastPage(sender objectivec.IObject)
	// Navigates to the next page of the document.
	GoToNextPage(sender objectivec.IObject)
	// Scrolls to the specified page.
	GoToPage(page IPDFPage)
	// Navigates to the previous page of the document.
	GoToPreviousPage(sender objectivec.IObject)
	// Navigates to the specified rectangle on the specified page.
	GoToRectOnPage(rect corefoundation.CGRect, page IPDFPage)
	// Scrolls to the first character of the specified selection.
	GoToSelection(selection IPDFSelection)
	// Performs layout of the inner views.
	LayoutDocumentView()
	// Returns the page containing a point specified in view coordinates.
	PageForPointNearest(point corefoundation.CGPoint, nearest bool) IPDFPage
	// Performs the specified action.
	PerformAction(action IPDFAction)
	// Prints the document with the specified printer information.
	PrintWithInfoAutoRotate(printInfo appkit.NSPrintInfo, doRotate bool)
	// Prints the document with the specified printer and page-scaling information.
	PrintWithInfoAutoRotatePageScaling(printInfo appkit.NSPrintInfo, doRotate bool, scale PDFPrintScalingMode)
	// Returns the size needed to display a row of the current document page.
	RowSizeForPage(page IPDFPage) corefoundation.CGSize
	// Scrolls the view until the selection is visible.
	ScrollSelectionToVisible(sender objectivec.IObject)
	// Sets the current selection, in an animated way, if desired.
	SetCurrentSelectionAnimate(selection IPDFSelection, animate bool)
	// Sets the type of mouse cursor according to the type of area the mouse cursor is over.
	SetCursorForAreaOfInterest(area PDFAreaOfInterest)
	// Zooms in by increasing the scaling factor.
	ZoomIn(sender objectivec.IObject)
	// Zooms out by decreasing the scaling factor.
	ZoomOut(sender objectivec.IObject)
}

An interface definition for the PDFView class.

Associating a Document with a View ¶

• [IPDFView.Document]: Returns the document associated with a PDFView object.
• [IPDFView.SetDocument]

Navigating Within a Document ¶

• [IPDFView.CurrentPage]: Returns the current page.
• [IPDFView.CurrentDestination]: Returns a PDFDestination object representing the current page and the current point in the view specified in page space.
• [IPDFView.VisiblePages]: Returns an array of PDFPage objects that represent the currently visible pages.

Setting the Delegate ¶

• [IPDFView.Delegate]: Returns the view’s delegate.
• [IPDFView.SetDelegate]

Instance Properties ¶

• [IPDFView.InMarkupMode]
• [IPDFView.SetInMarkupMode]
• [IPDFView.PageOverlayViewProvider]
• [IPDFView.SetPageOverlayViewProvider]
• [IPDFView.PageShadowsEnabled]
• [IPDFView.SetPageShadowsEnabled]

See: https://developer.apple.com/documentation/PDFKit/PDFView

type PDFAccessPermissions ¶

type PDFAccessPermissions uint

See: https://developer.apple.com/documentation/PDFKit/PDFAccessPermissions

const (
	PDFAllowsCommenting           PDFAccessPermissions = 64
	PDFAllowsContentAccessibility PDFAccessPermissions = 32
	PDFAllowsContentCopying       PDFAccessPermissions = 16
	PDFAllowsDocumentAssembly     PDFAccessPermissions = 8
	PDFAllowsDocumentChanges      PDFAccessPermissions = 4
	PDFAllowsFormFieldEntry       PDFAccessPermissions = 128
	PDFAllowsHighQualityPrinting  PDFAccessPermissions = 2
	PDFAllowsLowQualityPrinting   PDFAccessPermissions = 1
)

func (e PDFAccessPermissions) String() string

type PDFAction ¶

type PDFAction struct {
	objectivec.Object
}

An action that is performed when, for example, a PDF annotation is activated or an outline item is clicked.

Overview ¶

A PDFAction object represents an action associated with a PDF element, such as an annotation or a link, that the viewer application can perform. See the Adobe PDF Specification for more about actions and action types.

PDFAction is an abstract superclass of the following concrete classes:

- PDFActionGoTo - PDFActionNamed - PDFActionRemoteGoTo - PDFActionResetForm - PDFActionURL

Getting the Action Type ¶

• PDFAction.Type: Returns the type of the action.

See: https://developer.apple.com/documentation/PDFKit/PDFAction

func NewPDFAction() PDFAction

func PDFActionFromID(id objc.ID) PDFAction

func (p PDFAction) Action() IPDFAction

func (p PDFAction) Autorelease() PDFAction

func (p PDFAction) Init() PDFAction

func (p PDFAction) ModificationDate() foundation.INSDate

func (p PDFAction) Page() IPDFPage

func (p PDFAction) SetAction(value IPDFAction)

func (p PDFAction) SetModificationDate(value foundation.INSDate)

func (p PDFAction) SetPage(value IPDFPage)

func (p PDFAction) SetUserName(value string)

func (p PDFAction) Type() string

func (p PDFAction) UserName() string

type PDFActionClass ¶

type PDFActionClass struct {
	// contains filtered or unexported fields
}

func GetPDFActionClass() PDFActionClass

func (pc PDFActionClass) Alloc() PDFAction

func (pc PDFActionClass) Class() objc.Class

type PDFActionGoTo ¶

type PDFActionGoTo struct {
	PDFAction
}

PDFActionGoTo, a subclass of PDFAction, defines methods for getting and setting the destination of a go-to action.

Overview ¶

A PDFActionGoTo object represents the action of going to a specific location within the PDF document.

Accessing the Destination ¶

• PDFActionGoTo.Destination: Returns the destination associated with the action.
• PDFActionGoTo.SetDestination

Initializing the Action ¶

• PDFActionGoTo.InitWithDestination: Initializes the go-to action.

See: https://developer.apple.com/documentation/PDFKit/PDFActionGoTo

func NewPDFActionGoTo() PDFActionGoTo

func NewPDFActionGoToWithDestination(destination IPDFDestination) PDFActionGoTo

func PDFActionGoToFromID(id objc.ID) PDFActionGoTo

func (p PDFActionGoTo) Autorelease() PDFActionGoTo

func (p PDFActionGoTo) Destination() IPDFDestination

func (p PDFActionGoTo) Init() PDFActionGoTo

func (p PDFActionGoTo) InitWithDestination(destination IPDFDestination) PDFActionGoTo

func (p PDFActionGoTo) SetDestination(value IPDFDestination)

type PDFActionGoToClass ¶

type PDFActionGoToClass struct {
	// contains filtered or unexported fields
}

func GetPDFActionGoToClass() PDFActionGoToClass

func (pc PDFActionGoToClass) Alloc() PDFActionGoTo

func (pc PDFActionGoToClass) Class() objc.Class

type PDFActionNamed ¶

type PDFActionNamed struct {
	PDFAction
}

PDFActionNamed defines methods used to work with actions in PDF documents, some of which are named in the Adobe PDF Specification.

Overview ¶

A PDFActionNamed object represents an action with a defined name, such as “Go back” or “Zoom in.”

Accessing the Name of the Action ¶

• PDFActionNamed.Name: Returns the name of the named action.
• PDFActionNamed.SetName

Initializing the Action ¶

• PDFActionNamed.InitWithName: Initializes the [PDFActionName] object with the specified named action.

See: https://developer.apple.com/documentation/PDFKit/PDFActionNamed

func NewPDFActionNamed() PDFActionNamed

func NewPDFActionNamedWithName(name PDFActionNamedName) PDFActionNamed

func PDFActionNamedFromID(id objc.ID) PDFActionNamed

func (p PDFActionNamed) Autorelease() PDFActionNamed

func (p PDFActionNamed) Init() PDFActionNamed

func (p PDFActionNamed) InitWithName(name PDFActionNamedName) PDFActionNamed

func (p PDFActionNamed) Name() PDFActionNamedName

func (p PDFActionNamed) SetName(value PDFActionNamedName)

type PDFActionNamedClass ¶

type PDFActionNamedClass struct {
	// contains filtered or unexported fields
}

func GetPDFActionNamedClass() PDFActionNamedClass

func (pc PDFActionNamedClass) Alloc() PDFActionNamed

func (pc PDFActionNamedClass) Class() objc.Class

type PDFActionNamedName ¶

type PDFActionNamedName int

See: https://developer.apple.com/documentation/PDFKit/PDFActionNamedName

const (
	// KPDFActionNamedFind: The Find action.
	KPDFActionNamedFind PDFActionNamedName = 8
	// KPDFActionNamedFirstPage: The First Page action.
	KPDFActionNamedFirstPage PDFActionNamedName = 3
	// KPDFActionNamedGoBack: The Go Back action.
	KPDFActionNamedGoBack PDFActionNamedName = 5
	// KPDFActionNamedGoForward: The Go Forward action.
	KPDFActionNamedGoForward PDFActionNamedName = 6
	// KPDFActionNamedGoToPage: The Go to Page action.
	KPDFActionNamedGoToPage PDFActionNamedName = 7
	// KPDFActionNamedLastPage: The Last Page action.
	KPDFActionNamedLastPage PDFActionNamedName = 4
	// KPDFActionNamedNextPage: The Next Page action.
	KPDFActionNamedNextPage PDFActionNamedName = 1
	// KPDFActionNamedNone: The action has no name.
	KPDFActionNamedNone PDFActionNamedName = 0
	// KPDFActionNamedPreviousPage: The Previous Page action.
	KPDFActionNamedPreviousPage PDFActionNamedName = 2
	// KPDFActionNamedPrint: The Print action.
	KPDFActionNamedPrint PDFActionNamedName = 9
	// KPDFActionNamedZoomIn: The Zoom In action.
	KPDFActionNamedZoomIn PDFActionNamedName = 10
	// KPDFActionNamedZoomOut: The Zoom Out action.
	KPDFActionNamedZoomOut PDFActionNamedName = 11
)

func (e PDFActionNamedName) String() string

type PDFActionRemoteGoTo ¶

type PDFActionRemoteGoTo struct {
	PDFAction
}

PDFActionRemoteGoTo, a subclass of PDFAction, defines methods for getting and setting the destination of a go-to action that targets another document.

Initializing the Remote Go-to Action ¶

• PDFActionRemoteGoTo.InitWithPageIndexAtPointFileURL: Initializes the remote go-to action with the specified page index, point, and document URL.

Accessing the Page Index of the Referenced Document ¶

• PDFActionRemoteGoTo.PageIndex: Returns the zero-based page index referenced by the remote go-to action.
• PDFActionRemoteGoTo.SetPageIndex

Accessing a Point on the Referenced Page ¶

• PDFActionRemoteGoTo.Point: Sets the point, in page space, on the page referenced by the remote go-to action.
• PDFActionRemoteGoTo.SetPoint

Accessing the URL of the Referenced Document ¶

• PDFActionRemoteGoTo.URL: Returns the URL of the document referenced by the remote go-to action.
• PDFActionRemoteGoTo.SetURL

See: https://developer.apple.com/documentation/PDFKit/PDFActionRemoteGoTo

func NewPDFActionRemoteGoTo() PDFActionRemoteGoTo

func NewPDFActionRemoteGoToWithPageIndexAtPointFileURL(pageIndex uint, point corefoundation.CGPoint, url foundation.INSURL) PDFActionRemoteGoTo

func PDFActionRemoteGoToFromID(id objc.ID) PDFActionRemoteGoTo

func (p PDFActionRemoteGoTo) Autorelease() PDFActionRemoteGoTo

func (p PDFActionRemoteGoTo) Init() PDFActionRemoteGoTo

func (p PDFActionRemoteGoTo) InitWithPageIndexAtPointFileURL(pageIndex uint, point corefoundation.CGPoint, url foundation.INSURL) PDFActionRemoteGoTo

func (p PDFActionRemoteGoTo) PageIndex() uint

func (p PDFActionRemoteGoTo) Point() corefoundation.CGPoint

func (p PDFActionRemoteGoTo) SetPageIndex(value uint)

func (p PDFActionRemoteGoTo) SetPoint(value corefoundation.CGPoint)

func (p PDFActionRemoteGoTo) SetURL(value foundation.INSURL)

func (p PDFActionRemoteGoTo) URL() foundation.INSURL

type PDFActionRemoteGoToClass ¶

type PDFActionRemoteGoToClass struct {
	// contains filtered or unexported fields
}

func GetPDFActionRemoteGoToClass() PDFActionRemoteGoToClass

func (pc PDFActionRemoteGoToClass) Alloc() PDFActionRemoteGoTo

func (pc PDFActionRemoteGoToClass) Class() objc.Class

type PDFActionResetForm ¶

type PDFActionResetForm struct {
	PDFAction
}

PDFActionResetForm, a subclass of PDFAction, defines methods for getting and clearing fields in a PDF form.

Overview ¶

A PDFActionResetForm object represents an action associated with a PDF form.

Accessing and Changing Fields ¶

• PDFActionResetForm.Fields: Returns an array of fields associated with the reset action.
• PDFActionResetForm.SetFields

Determining Whether Fields are Cleared When the Action is Performed ¶

• PDFActionResetForm.FieldsIncludedAreCleared: Sets whether the fields associated with the reset action are cleared when the action is performed.
• PDFActionResetForm.SetFieldsIncludedAreCleared

See: https://developer.apple.com/documentation/PDFKit/PDFActionResetForm

func NewPDFActionResetForm() PDFActionResetForm

func PDFActionResetFormFromID(id objc.ID) PDFActionResetForm

func (p PDFActionResetForm) Autorelease() PDFActionResetForm

func (p PDFActionResetForm) Fields() []string

func (p PDFActionResetForm) FieldsIncludedAreCleared() bool

func (p PDFActionResetForm) Init() PDFActionResetForm

func (p PDFActionResetForm) SetFields(value []string)

func (p PDFActionResetForm) SetFieldsIncludedAreCleared(value bool)

type PDFActionResetFormClass ¶

type PDFActionResetFormClass struct {
	// contains filtered or unexported fields
}

func GetPDFActionResetFormClass() PDFActionResetFormClass

func (pc PDFActionResetFormClass) Alloc() PDFActionResetForm

func (pc PDFActionResetFormClass) Class() objc.Class

type PDFActionURL ¶

type PDFActionURL struct {
	PDFAction
}

PDFActionURL, a subclass of PDFAction, defines methods for getting and setting the URL associated with a URL action.

Initializing a URL Action ¶

• PDFActionURL.InitWithURL: Initializes a URL action with the specified URL.

Accessing and Changing the URL ¶

• PDFActionURL.URL: Returns the URL associated with the URL action.
• PDFActionURL.SetURL

See: https://developer.apple.com/documentation/PDFKit/PDFActionURL

func NewPDFActionURL() PDFActionURL

func NewPDFActionURLWithURL(url foundation.INSURL) PDFActionURL

func PDFActionURLFromID(id objc.ID) PDFActionURL

func (p PDFActionURL) Autorelease() PDFActionURL

func (p PDFActionURL) Init() PDFActionURL

func (p PDFActionURL) InitWithURL(url foundation.INSURL) PDFActionURL

func (p PDFActionURL) SetURL(value foundation.INSURL)

func (p PDFActionURL) URL() foundation.INSURL

type PDFActionURLClass ¶

type PDFActionURLClass struct {
	// contains filtered or unexported fields
}

func GetPDFActionURLClass() PDFActionURLClass

func (pc PDFActionURLClass) Alloc() PDFActionURL

func (pc PDFActionURLClass) Class() objc.Class

type PDFAnnotation ¶

type PDFAnnotation struct {
	objectivec.Object
}

An annotation in a PDF document.

Overview ¶

In addition to its primary textual content, a PDF file can contain annotations that represent links, form elements, highlighting circles, textual notes, and so on. Each annotation has a specific location on a page and may offer interactivity with the user.

Creating an Annotation ¶

• PDFAnnotation.InitWithBoundsForTypeWithProperties: Creates a PDF annotation with the specified bounds, type, and optional properties.

Accessing Information About an Annotation ¶

• PDFAnnotation.Page: Returns the page that the annotation is associated with.
• PDFAnnotation.SetPage
• PDFAnnotation.ModificationDate: Returns the modification date of the annotation.
• PDFAnnotation.SetModificationDate
• PDFAnnotation.UserName: Returns the name of the user who created the annotation.
• PDFAnnotation.SetUserName
• PDFAnnotation.Type: Returns the type of the annotation.
• PDFAnnotation.SetType
• PDFAnnotation.Action: An object that represents an action for a PDF element, such as a link annotation.
• PDFAnnotation.SetAction

Managing Annotation Drawing and Output ¶

• PDFAnnotation.DrawWithBoxInContext: Draws the annotation in a graphics context using page-space coordinates relative to the origin of the specified box.
• PDFAnnotation.ShouldDisplay: Returns a Boolean value indicating whether the annotation should be displayed.
• PDFAnnotation.SetShouldDisplay
• PDFAnnotation.ShouldPrint: Returns a Boolean value indicating whether the annotation should appear when the document is printed.
• PDFAnnotation.SetShouldPrint

Modifying Annotation Attributes ¶

• PDFAnnotation.AnnotationKeyValues: A dictionary that contains a deep copy of the widget’s properties.
• PDFAnnotation.ValueForAnnotationKey: Returns a deep copy of the key-value pairs of properties for the specified key.
• PDFAnnotation.SetValueForAnnotationKey: Sets a value in the annotation’s dictionary.
• PDFAnnotation.SetBooleanForAnnotationKey: Sets a Boolean value in the annotation’s dictionary.
• PDFAnnotation.SetRectForAnnotationKey: Sets a rectangle value in the annotation’s dictionary.
• PDFAnnotation.RemoveValueForAnnotationKey: Removes a value from the annotation’s dictionary.

Managing Annotation Display Characteristics ¶

• PDFAnnotation.Alignment: The alignment of the free text and text widget annotation’s text content.
• PDFAnnotation.SetAlignment
• PDFAnnotation.Bounds: Returns the bounding box for the annotation in page space.
• PDFAnnotation.SetBounds
• PDFAnnotation.Contents: Returns the textual content (if any) associated with the annotation.
• PDFAnnotation.SetContents
• PDFAnnotation.Font: The font the annotation uses to display text.
• PDFAnnotation.SetFont
• PDFAnnotation.FontColor: The font color the annotation uses to display text.
• PDFAnnotation.SetFontColor
• PDFAnnotation.Border: Sets the border style for the annotation.
• PDFAnnotation.SetBorder
• PDFAnnotation.Highlighted: A Boolean value that indicates whether the annotation is in a highlighted state, such as when the mouse is down on a link annotation.
• PDFAnnotation.SetHighlighted
• PDFAnnotation.Color: Sets the stroke color for the annotation.
• PDFAnnotation.SetColor
• PDFAnnotation.HasAppearanceStream: Returns a Boolean value that indicates whether the annotation has an appearance stream associated with it.

Configuring Shape Annotations ¶

• PDFAnnotation.InteriorColor: The fill color for drawing a circle, line, or square annotation.
• PDFAnnotation.SetInteriorColor

Configuring Line Annotations ¶

• PDFAnnotation.StartPoint: The point where a line begins, in annotation-space coordinates.
• PDFAnnotation.SetStartPoint
• PDFAnnotation.EndPoint: The point where a line ends, in annotation-space coordinates.
• PDFAnnotation.SetEndPoint
• PDFAnnotation.StartLineStyle: The style of the line annotation’s starting point, such as square or filled arrowhead.
• PDFAnnotation.SetStartLineStyle
• PDFAnnotation.EndLineStyle: The style of the line annotation’s ending point, such as square or filled arrowhead.
• PDFAnnotation.SetEndLineStyle

Configuring Link Annotations ¶

• PDFAnnotation.Destination: The destination for a link annotation.
• PDFAnnotation.SetDestination
• PDFAnnotation.URL: A URL for a link annotation.
• PDFAnnotation.SetURL

Configuring Text Annotations ¶

• PDFAnnotation.IconType: The type of icon to display for a pop-up text annotation.
• PDFAnnotation.SetIconType

Configuring Pop-Up Annotations ¶

• PDFAnnotation.Popup: Returns the pop-up annotation associated with an annotation.
• PDFAnnotation.SetPopup
• PDFAnnotation.Open: A Boolean value that indicates whether the pop-up annotation is in an opened state, displaying its text content, or in a closed state, displaying an icon.
• PDFAnnotation.SetOpen

Configuring Text Markup Annotations ¶

• PDFAnnotation.MarkupType: The markup type that the annotation displays, either highlight, strikethrough, underline, or redact.
• PDFAnnotation.SetMarkupType
• PDFAnnotation.QuadrilateralPoints: An array of values that represents the points bounding the marked-up text.
• PDFAnnotation.SetQuadrilateralPoints

Configuring Widget Annotations ¶

• PDFAnnotation.WidgetFieldType: The type of widget annotation, such as button, choice, or text.
• PDFAnnotation.SetWidgetFieldType
• PDFAnnotation.WidgetStringValue: The string value of the widget annotation.
• PDFAnnotation.SetWidgetStringValue
• PDFAnnotation.WidgetDefaultStringValue: The string value that the widget reverts to when performing a reset form action.
• PDFAnnotation.SetWidgetDefaultStringValue
• PDFAnnotation.FieldName: The widget identifier for form annotation actions and behaviors.
• PDFAnnotation.SetFieldName
• PDFAnnotation.BackgroundColor: The color of the widget’s background.
• PDFAnnotation.SetBackgroundColor
• PDFAnnotation.ReadOnly: A Boolean value that determines whether the widget is editable.
• PDFAnnotation.SetReadOnly

Configuring Text Widget Annotations ¶

• PDFAnnotation.Multiline: A Boolean value that indicates whether the text widget annotation displays multiple lines.
• PDFAnnotation.SetMultiline
• PDFAnnotation.IsPasswordField: A Boolean value that indicates whether the text widget annotation displays a password field using bullet characters.
• PDFAnnotation.MaximumLength: The maximum number of characters the text widget annotation allows.
• PDFAnnotation.SetMaximumLength
• PDFAnnotation.Comb: A Boolean value that indicates whether the annotation divides the text widget’s bounds into equally spaced segments, such as in a form entry field.
• PDFAnnotation.SetComb

Configuring Button Widget Annotations ¶

• PDFAnnotation.WidgetControlType: The type of button widget control, either radio button, push button, or checkbox.
• PDFAnnotation.SetWidgetControlType
• PDFAnnotation.ButtonWidgetState: The current state of the button widget annotation.
• PDFAnnotation.SetButtonWidgetState
• PDFAnnotation.ButtonWidgetStateString: A string value that differentiates button widgets in the same group, such as to identify mutually exclusive radio buttons from each other.
• PDFAnnotation.SetButtonWidgetStateString
• PDFAnnotation.Caption: The title of push button widget annotations.
• PDFAnnotation.SetCaption
• PDFAnnotation.AllowsToggleToOff: A Boolean value that indicates whether clicking or tapping a selected radio button toggles it to an unselected state.
• PDFAnnotation.SetAllowsToggleToOff
• PDFAnnotation.RadiosInUnison: A Boolean value that indicates whether radio buttons in a group turn on and off in unison.
• PDFAnnotation.SetRadiosInUnison

Configuring Choice Widget Annotations ¶

• PDFAnnotation.Choices: An array of strings that specifies the options in either a list or a pop-up menu.
• PDFAnnotation.SetChoices
• PDFAnnotation.ListChoice: A Boolean value that indicates whether the choice widget annotation is a list or a pop-up menu.
• PDFAnnotation.SetListChoice
• PDFAnnotation.Values: An array of strings that specifies the export values for items in a list or a pop-up menu.
• PDFAnnotation.SetValues

Configuring Ink Annotations ¶

• PDFAnnotation.Paths: An array of bezier paths, in annotation-space coordinates, that compose the annotation.
• PDFAnnotation.AddBezierPath: Adds a bezier path to the ink annotation.
• PDFAnnotation.RemoveBezierPath: Removes a bezier path from an ink annotation.

Configuring Stamp Annotations ¶

• PDFAnnotation.StampName: The name of the stamp, a text or graphics annotation that emulates a rubber stamp effect.
• PDFAnnotation.SetStampName

Instance Properties ¶

• PDFAnnotation.ActivatableTextField

See: https://developer.apple.com/documentation/PDFKit/PDFAnnotation

func NewPDFAnnotation() PDFAnnotation

func NewPDFAnnotationWithBoundsForTypeWithProperties(bounds corefoundation.CGRect, annotationType PDFAnnotationSubtype, properties foundation.INSDictionary) PDFAnnotation

func PDFAnnotationFromID(id objc.ID) PDFAnnotation

func (p PDFAnnotation) Action() IPDFAction

func (p PDFAnnotation) ActivatableTextField() bool

func (p PDFAnnotation) AddBezierPath(path objectivec.IObject)

func (p PDFAnnotation) Alignment() appkit.NSTextAlignment

func (p PDFAnnotation) AllowsToggleToOff() bool

func (p PDFAnnotation) AnnotationKeyValues() foundation.INSDictionary

func (p PDFAnnotation) Autorelease() PDFAnnotation

func (p PDFAnnotation) BackgroundColor() objc.ID

func (p PDFAnnotation) Border() IPDFBorder

func (p PDFAnnotation) Bounds() corefoundation.CGRect

func (p PDFAnnotation) ButtonWidgetState() PDFWidgetCellState

func (p PDFAnnotation) ButtonWidgetStateString() string

func (p PDFAnnotation) Caption() string

func (p PDFAnnotation) Choices() []string

func (p PDFAnnotation) Color() objc.ID

func (p PDFAnnotation) Comb() bool

func (p PDFAnnotation) Contents() string

func (p PDFAnnotation) Destination() IPDFDestination

func (p PDFAnnotation) DrawWithBoxInContext(box PDFDisplayBox, context coregraphics.CGContextRef)

func (p PDFAnnotation) EncodeWithCoder(coder foundation.INSCoder)

func (p PDFAnnotation) EndLineStyle() PDFLineStyle

func (p PDFAnnotation) EndPoint() corefoundation.CGPoint

func (p PDFAnnotation) FieldName() string

func (p PDFAnnotation) Font() objectivec.IObject

func (p PDFAnnotation) FontColor() objc.ID

func (p PDFAnnotation) HasAppearanceStream() bool

func (p PDFAnnotation) Highlighted() bool

func (p PDFAnnotation) IconType() PDFTextAnnotationIconType

func (p PDFAnnotation) Init() PDFAnnotation

func (p PDFAnnotation) InitWithBoundsForTypeWithProperties(bounds corefoundation.CGRect, annotationType PDFAnnotationSubtype, properties foundation.INSDictionary) PDFAnnotation

func (p PDFAnnotation) InteriorColor() objc.ID

func (p PDFAnnotation) IsPasswordField() bool

func (p PDFAnnotation) ListChoice() bool

func (p PDFAnnotation) MarkupType() PDFMarkupType

func (p PDFAnnotation) MaximumLength() int

func (p PDFAnnotation) ModificationDate() foundation.INSDate

func (p PDFAnnotation) Multiline() bool

func (p PDFAnnotation) Open() bool

func (p PDFAnnotation) Page() IPDFPage

func (p PDFAnnotation) Paths() []objc.ID

func (p PDFAnnotation) Popup() IPDFAnnotation

func (p PDFAnnotation) QuadrilateralPoints() []foundation.NSValue

func (p PDFAnnotation) RadiosInUnison() bool

func (p PDFAnnotation) ReadOnly() bool

func (p PDFAnnotation) RemoveBezierPath(path objectivec.IObject)

func (p PDFAnnotation) RemoveValueForAnnotationKey(key PDFAnnotationKey)

func (p PDFAnnotation) SetAction(value IPDFAction)

func (p PDFAnnotation) SetAlignment(value appkit.NSTextAlignment)

func (p PDFAnnotation) SetAllowsToggleToOff(value bool)

func (p PDFAnnotation) SetBackgroundColor(value objc.ID)

func (p PDFAnnotation) SetBooleanForAnnotationKey(value bool, key PDFAnnotationKey) bool

func (p PDFAnnotation) SetBorder(value IPDFBorder)

func (p PDFAnnotation) SetBounds(value corefoundation.CGRect)

func (p PDFAnnotation) SetButtonWidgetState(value PDFWidgetCellState)

func (p PDFAnnotation) SetButtonWidgetStateString(value string)

func (p PDFAnnotation) SetCaption(value string)

func (p PDFAnnotation) SetChoices(value []string)

func (p PDFAnnotation) SetColor(value objc.ID)

func (p PDFAnnotation) SetComb(value bool)

func (p PDFAnnotation) SetContents(value string)

func (p PDFAnnotation) SetDestination(value IPDFDestination)

func (p PDFAnnotation) SetEndLineStyle(value PDFLineStyle)

func (p PDFAnnotation) SetEndPoint(value corefoundation.CGPoint)

func (p PDFAnnotation) SetFieldName(value string)

func (p PDFAnnotation) SetFont(value objectivec.IObject)

func (p PDFAnnotation) SetFontColor(value objc.ID)

func (p PDFAnnotation) SetHighlighted(value bool)

func (p PDFAnnotation) SetIconType(value PDFTextAnnotationIconType)

func (p PDFAnnotation) SetInteriorColor(value objc.ID)

func (p PDFAnnotation) SetListChoice(value bool)

func (p PDFAnnotation) SetMarkupType(value PDFMarkupType)

func (p PDFAnnotation) SetMaximumLength(value int)

func (p PDFAnnotation) SetModificationDate(value foundation.INSDate)

func (p PDFAnnotation) SetMultiline(value bool)

func (p PDFAnnotation) SetOpen(value bool)

func (p PDFAnnotation) SetPage(value IPDFPage)

func (p PDFAnnotation) SetPopup(value IPDFAnnotation)

func (p PDFAnnotation) SetQuadrilateralPoints(value []foundation.NSValue)

func (p PDFAnnotation) SetRadiosInUnison(value bool)

func (p PDFAnnotation) SetReadOnly(value bool)

func (p PDFAnnotation) SetRectForAnnotationKey(value corefoundation.CGRect, key PDFAnnotationKey) bool

func (p PDFAnnotation) SetShouldDisplay(value bool)

func (p PDFAnnotation) SetShouldPrint(value bool)

func (p PDFAnnotation) SetStampName(value string)

func (p PDFAnnotation) SetStartLineStyle(value PDFLineStyle)

func (p PDFAnnotation) SetStartPoint(value corefoundation.CGPoint)

func (p PDFAnnotation) SetType(value string)

func (p PDFAnnotation) SetURL(value foundation.INSURL)

func (p PDFAnnotation) SetUserName(value string)

func (p PDFAnnotation) SetValueForAnnotationKey(value objectivec.IObject, key PDFAnnotationKey) bool

func (p PDFAnnotation) SetValues(value []string)

func (p PDFAnnotation) SetWidgetControlType(value PDFWidgetControlType)

func (p PDFAnnotation) SetWidgetDefaultStringValue(value string)

func (p PDFAnnotation) SetWidgetFieldType(value PDFAnnotationWidgetSubtype)

func (p PDFAnnotation) SetWidgetStringValue(value string)

func (p PDFAnnotation) ShouldDisplay() bool

func (p PDFAnnotation) ShouldPrint() bool

func (p PDFAnnotation) StampName() string

func (p PDFAnnotation) StartLineStyle() PDFLineStyle

func (p PDFAnnotation) StartPoint() corefoundation.CGPoint

func (p PDFAnnotation) Type() string

func (p PDFAnnotation) URL() foundation.INSURL

func (p PDFAnnotation) UserName() string

func (p PDFAnnotation) ValueForAnnotationKey(key PDFAnnotationKey) objectivec.IObject

func (p PDFAnnotation) Values() []string

func (p PDFAnnotation) WidgetControlType() PDFWidgetControlType

func (p PDFAnnotation) WidgetDefaultStringValue() string

func (p PDFAnnotation) WidgetFieldType() PDFAnnotationWidgetSubtype

func (p PDFAnnotation) WidgetStringValue() string

type PDFAnnotationClass ¶

type PDFAnnotationClass struct {
	// contains filtered or unexported fields
}

func GetPDFAnnotationClass() PDFAnnotationClass

func (pc PDFAnnotationClass) Alloc() PDFAnnotation

func (pc PDFAnnotationClass) Class() objc.Class

func (_PDFAnnotationClass PDFAnnotationClass) LineStyleFromName(name string) PDFLineStyle

func (_PDFAnnotationClass PDFAnnotationClass) NameForLineStyle(style PDFLineStyle) string

type PDFAnnotationHighlightingMode ¶

type PDFAnnotationHighlightingMode = string

See: https://developer.apple.com/documentation/PDFKit/PDFAnnotationHighlightingMode

type PDFAnnotationKey ¶

type PDFAnnotationKey = string

PDFAnnotationKey is keys for setting properties of annotations.

See: https://developer.apple.com/documentation/PDFKit/PDFAnnotationKey

type PDFAnnotationLineEndingStyle ¶

type PDFAnnotationLineEndingStyle = string

See: https://developer.apple.com/documentation/PDFKit/PDFAnnotationLineEndingStyle

type PDFAnnotationSubtype ¶

type PDFAnnotationSubtype = string

PDFAnnotationSubtype is the type of annotation, such as circle, text, or ink.

See: https://developer.apple.com/documentation/PDFKit/PDFAnnotationSubtype

type PDFAnnotationTextIconType ¶

type PDFAnnotationTextIconType = string

PDFAnnotationTextIconType is constants for icon type values in text annotation property dictionaries.

See: https://developer.apple.com/documentation/PDFKit/PDFAnnotationTextIconType

type PDFAnnotationWidgetSubtype ¶

type PDFAnnotationWidgetSubtype = string

See: https://developer.apple.com/documentation/PDFKit/PDFAnnotationWidgetSubtype

type PDFAppearanceCharacteristics ¶

type PDFAppearanceCharacteristics struct {
	objectivec.Object
}

An object that represents appearance characteristics of a widget annotation.

Configuring a Widget’s Appearance ¶

• PDFAppearanceCharacteristics.BackgroundColor: The background color of the widget annotation.
• PDFAppearanceCharacteristics.SetBackgroundColor
• PDFAppearanceCharacteristics.BorderColor: The border color of the widget annotation.
• PDFAppearanceCharacteristics.SetBorderColor
• PDFAppearanceCharacteristics.Caption: The text that the button widget annotation displays when the user isn’t interacting with it.
• PDFAppearanceCharacteristics.SetCaption
• PDFAppearanceCharacteristics.ControlType: The type of button widget annotation.
• PDFAppearanceCharacteristics.SetControlType
• PDFAppearanceCharacteristics.DownCaption: The text that the button widget annotation displays when the user holds down on it.
• PDFAppearanceCharacteristics.SetDownCaption
• PDFAppearanceCharacteristics.RolloverCaption: The text that the widget annotation displays when the user hovers the pointer over it.
• PDFAppearanceCharacteristics.SetRolloverCaption
• PDFAppearanceCharacteristics.Rotation: The number of degrees, in multiples of 90, that the widget annotation rotates counterclockwise relative to the page.
• PDFAppearanceCharacteristics.SetRotation
• PDFAppearanceCharacteristics.AppearanceCharacteristicsKeyValues: A dictionary that contains a deep copy of the appearance characteristic key-value pairs.

See: https://developer.apple.com/documentation/PDFKit/PDFAppearanceCharacteristics

func NewPDFAppearanceCharacteristics() PDFAppearanceCharacteristics

func PDFAppearanceCharacteristicsFromID(id objc.ID) PDFAppearanceCharacteristics

func (p PDFAppearanceCharacteristics) AppearanceCharacteristicsKeyValues() foundation.INSDictionary

func (p PDFAppearanceCharacteristics) Autorelease() PDFAppearanceCharacteristics

func (p PDFAppearanceCharacteristics) BackgroundColor() objc.ID

func (p PDFAppearanceCharacteristics) BorderColor() objc.ID

func (p PDFAppearanceCharacteristics) Caption() string

func (p PDFAppearanceCharacteristics) ControlType() PDFWidgetControlType

func (p PDFAppearanceCharacteristics) DownCaption() string

func (p PDFAppearanceCharacteristics) FieldName() string

func (p PDFAppearanceCharacteristics) Init() PDFAppearanceCharacteristics

func (p PDFAppearanceCharacteristics) IsReadOnly() bool

func (p PDFAppearanceCharacteristics) RolloverCaption() string

func (p PDFAppearanceCharacteristics) Rotation() int

func (p PDFAppearanceCharacteristics) SetBackgroundColor(value objc.ID)

func (p PDFAppearanceCharacteristics) SetBorderColor(value objc.ID)

func (p PDFAppearanceCharacteristics) SetCaption(value string)

func (p PDFAppearanceCharacteristics) SetControlType(value PDFWidgetControlType)

func (p PDFAppearanceCharacteristics) SetDownCaption(value string)

func (p PDFAppearanceCharacteristics) SetFieldName(value string)

func (p PDFAppearanceCharacteristics) SetIsReadOnly(value bool)

func (p PDFAppearanceCharacteristics) SetRolloverCaption(value string)

func (p PDFAppearanceCharacteristics) SetRotation(value int)

func (p PDFAppearanceCharacteristics) SetWidgetDefaultStringValue(value string)

func (p PDFAppearanceCharacteristics) SetWidgetFieldType(value PDFAnnotationWidgetSubtype)

func (p PDFAppearanceCharacteristics) SetWidgetStringValue(value string)

func (p PDFAppearanceCharacteristics) WidgetDefaultStringValue() string

func (p PDFAppearanceCharacteristics) WidgetFieldType() PDFAnnotationWidgetSubtype

func (p PDFAppearanceCharacteristics) WidgetStringValue() string

type PDFAppearanceCharacteristicsClass ¶

type PDFAppearanceCharacteristicsClass struct {
	// contains filtered or unexported fields
}

func GetPDFAppearanceCharacteristicsClass() PDFAppearanceCharacteristicsClass

func (pc PDFAppearanceCharacteristicsClass) Alloc() PDFAppearanceCharacteristics

func (pc PDFAppearanceCharacteristicsClass) Class() objc.Class

type PDFAppearanceCharacteristicsKey ¶

type PDFAppearanceCharacteristicsKey = string

PDFAppearanceCharacteristicsKey is keys to control a widget’s appearance.

See: https://developer.apple.com/documentation/PDFKit/PDFAppearanceCharacteristicsKey

type PDFAreaOfInterest ¶

type PDFAreaOfInterest int

See: https://developer.apple.com/documentation/PDFKit/PDFAreaOfInterest

const (
	// KPDFAnnotationArea: The mouse is over an annotation.
	KPDFAnnotationArea PDFAreaOfInterest = 4
	KPDFAnyArea        PDFAreaOfInterest = 9223372036854775807
	// KPDFControlArea: The mouse is over a control.
	KPDFControlArea PDFAreaOfInterest = 16
	// KPDFIconArea: The mouse is over an icon.
	KPDFIconArea PDFAreaOfInterest = 64
	// KPDFImageArea: The mouse is over an image.
	KPDFImageArea PDFAreaOfInterest = 256
	// KPDFLinkArea: The mouse is over a link.
	KPDFLinkArea PDFAreaOfInterest = 8
	// KPDFNoArea: The mouse is over an undefined area.
	KPDFNoArea PDFAreaOfInterest = 0
	// KPDFPageArea: The mouse is over a page.
	KPDFPageArea PDFAreaOfInterest = 1
	// KPDFPopupArea: The mouse is over a popup menu.
	KPDFPopupArea PDFAreaOfInterest = 128
	// KPDFTextArea: The mouse is over text.
	KPDFTextArea PDFAreaOfInterest = 2
	// KPDFTextFieldArea: The mouse is over a text field.
	KPDFTextFieldArea PDFAreaOfInterest = 32
)

func (e PDFAreaOfInterest) String() string

type PDFBorder ¶

type PDFBorder struct {
	objectivec.Object
}

An optional border for an annotation that lies completely within the annotation rectangle.

Working with Border Styles and Characteristics ¶

• PDFBorder.Style: Sets the border style.
• PDFBorder.SetStyle
• PDFBorder.LineWidth: Sets the line width (in points) for the border.
• PDFBorder.SetLineWidth
• PDFBorder.DashPattern: Gets the dash pattern for the border as an array of NSNumber objects.
• PDFBorder.SetDashPattern
• PDFBorder.BorderKeyValues: A dictionary that contains a deep copy of all border properties.

Drawing Borders ¶

• PDFBorder.DrawInRect: Draws the border.

See: https://developer.apple.com/documentation/PDFKit/PDFBorder

func NewPDFBorder() PDFBorder

func PDFBorderFromID(id objc.ID) PDFBorder

func (p PDFBorder) Alignment() appkit.NSTextAlignment

func (p PDFBorder) Autorelease() PDFBorder

func (p PDFBorder) Border() IPDFBorder

func (p PDFBorder) BorderKeyValues() foundation.INSDictionary