Platforms to show: All Mac Windows Linux Cross-Platform

Back to PDFAppearanceCharacteristicsMBS class.

PDFAppearanceCharacteristicsMBS.appearanceCharacteristicsKeyValues as Dictionary

Type Topic Plugin Version macOS Windows Linux iOS Targets
property PDFKit MBS PDFKit Plugin 21.1 ✅ Yes ❌ No ❌ No ✅ Yes All
List all appearance characteristics properties as key-value pairs; returns a deep copy of all pairs.

Helpful for debugging.
(Read only property)

PDFAppearanceCharacteristicsMBS.backgroundColor as NSColorMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
property PDFKit MBS PDFKit Plugin 21.1 ✅ Yes ❌ No ❌ No ✅ Yes All
The background color of the widget annotation.

(Read and Write property)

PDFAppearanceCharacteristicsMBS.borderColor as NSColorMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
property PDFKit MBS PDFKit Plugin 21.1 ✅ Yes ❌ No ❌ No ✅ Yes All
The border color of the widget annotation.

(Read and Write property)

PDFAppearanceCharacteristicsMBS.caption as String

Type Topic Plugin Version macOS Windows Linux iOS Targets
property PDFKit MBS PDFKit Plugin 21.1 ✅ Yes ❌ No ❌ No ✅ Yes All
The widget annotation’s normal caption, displayed when it is not interacting with the user.

(Read and Write property)

PDFAppearanceCharacteristicsMBS.controlType as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property PDFKit MBS PDFKit Plugin 21.1 ✅ Yes ❌ No ❌ No ✅ Yes All
For button widget annotations, need to specify the control type for PDFAppearanceCharacteristicsMBS as certain attributes, i.e. captions, are only available for certain flavors.

Control type does not need to be set for text or choice widget annotations.
(Read and Write property)

PDFAppearanceCharacteristicsMBS.downCaption as String

Type Topic Plugin Version macOS Windows Linux iOS Targets
property PDFKit MBS PDFKit Plugin 21.1 ✅ Yes ❌ No ❌ No ✅ Yes All
The widget's caption displayed when the user holds the mouse button while over the annotation.

Applies only to kPDFWidgetPushButtonControl.
(Read and Write property)

PDFAppearanceCharacteristicsMBS.Handle as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property PDFKit MBS PDFKit Plugin 21.1 ✅ Yes ❌ No ❌ No ✅ Yes All
The internal object reference.

(Read and Write property)

PDFAppearanceCharacteristicsMBS.rolloverCaption as String

Type Topic Plugin Version macOS Windows Linux iOS Targets
property PDFKit MBS PDFKit Plugin 21.1 ✅ Yes ❌ No ❌ No ✅ Yes All
The widget's caption displayed when the user moves the mouse over the annotation.

Applies only to kPDFWidgetPushButtonControl.
(Read and Write property)

PDFAppearanceCharacteristicsMBS.rotation as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property PDFKit MBS PDFKit Plugin 21.1 ✅ Yes ❌ No ❌ No ✅ Yes All
The number of *degrees* by which the widget annotation is rotated counterclockwise relative to the page.

The value must be a multiple of 90. Default value: 0.
(Read and Write property)

The items on this page are in the following plugins: MBS PDFKit Plugin.


The biggest plugin in space...