Platforms to show: All Mac Windows Linux Cross-Platform
Back to PDFAnnotationMBS class.
PDFAnnotationMBS.Action as PDFActionMBS
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| property | PDFKit | MBS PDFKit Plugin | 21.1 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
PDF readers ignore actions except for those associated with Link or button Widget annotations.
Available in macOS 10.5 or newer
(Read and Write property)
PDFAnnotationMBS.alignment as Integer
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| property | PDFKit | MBS PDFKit Plugin | 21.1 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
Used by annotations type(s): /FreeText, /Widget (field type(s): /Tx).
(Read and Write property)
PDFAnnotationMBS.allowsToggleToOff as Boolean
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| property | PDFKit | MBS PDFKit Plugin | 21.1 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
Used by annotations type(s): /Widget (field type(s): /Btn).
(Read and Write property)
PDFAnnotationMBS.annotationKeyValues as Dictionary
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| property | PDFKit | MBS PDFKit Plugin | 21.1 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop, Console & Web |
Note that this method will not include a copy of the value for /Parent. This is by design as to avoid introducing a memory cycle. If you would like to get the /Parent propery, use valueForAnnotationKey with key PDFAnnotationKeyParent.
(Read only property)
PDFAnnotationMBS.backgroundColor as NSColorMBS
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| property | PDFKit | MBS PDFKit Plugin | 21.1 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
Used by annotations type(s): /Widget (field type(s): /Btn, /Ch, /Tx).
(Read and Write property)
PDFAnnotationMBS.border as PDFBorderMBS
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| property | PDFKit | MBS PDFKit Plugin | 8.0 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
(Read and Write property)
PDFAnnotationMBS.bounds as NSRectMBS
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| property | PDFKit | MBS PDFKit Plugin | 9.6 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
Page space is a 72-dpi coordinate system with the origin at the lower-left corner of the current page.
Available in Mac OS X v10.4 and later.
(Read and Write property)
PDFAnnotationMBS.buttonWidgetState as Integer
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| property | PDFKit | MBS PDFKit Plugin | 21.1 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
Used by annotations type(s): /Widget (field type(s): /Btn).
(Read and Write property)
PDFAnnotationMBS.buttonWidgetStateString as String
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| property | PDFKit | MBS PDFKit Plugin | 21.1 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
This should be set when trying to, for example, group together a set of radio buttons with the same field name.
When buttons share the same field name, their individual state strings set them apart from one another.
Used by annotations type(s): /Widget (field type(s): /Btn).
(Read and Write property)
PDFAnnotationMBS.caption as String
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| property | PDFKit | MBS PDFKit Plugin | 21.1 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
Used by annotations type(s): /Widget (field type(s): /Btn).
(Read and Write property)
PDFAnnotationMBS.colorValue as NSColorMBS
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| property | PDFKit | MBS PDFKit Plugin | 8.0 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
Used for other annotations as well.
(Read and Write property)
PDFAnnotationMBS.comb as Boolean
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| property | PDFKit | MBS PDFKit Plugin | 21.1 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
If set, the field is automatically divided into as many equally spaced positions, or combs, as the value of the maximum length of the field. To get the maximum length, use annotaiton key: PDFAnnotationKeyWidgetMaxLen.
Used by annotations type(s): /Widget (field type(s): /Tx).
(Read and Write property)
PDFAnnotationMBS.contents as string
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| property | PDFKit | MBS PDFKit Plugin | 8.0 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
Often to be displayed in a pop-up when the annotation is clicked on ("FreeText" and "Text" especially).
(Read and Write property)
PDFAnnotationMBS.destination as PDFDestinationMBS
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| property | PDFKit | MBS PDFKit Plugin | 21.1 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
The preferred way though is to use action property.
Used by annotations type(s): /Link.
(Read and Write property)
PDFAnnotationMBS.endLineStyle as Integer
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| property | PDFKit | MBS PDFKit Plugin | 21.1 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
Used by annotations type(s): /Line.
(Read and Write property)
PDFAnnotationMBS.endPoint as NSPointMBS
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| property | PDFKit | MBS PDFKit Plugin | 21.1 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
Points are specified in annotation space.
Used by annotations type(s): /Line.
(Read and Write property)
PDFAnnotationMBS.fieldName as String
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| property | PDFKit | MBS PDFKit Plugin | 21.1 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
Can also be used for ResetForm actions.
Used by annotations type(s): /Widget (field type(s): /Btn, /Ch, /Tx).
(Read and Write property)
PDFAnnotationMBS.font as NSFontMBS
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| property | PDFKit | MBS PDFKit Plugin | 21.1 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
Used by annotations type(s): /FreeText, /Popup, /Widget (field type(s): /Btn, /Ch, and /Tx).
(Read and Write property)
PDFAnnotationMBS.fontColor as NSColorMBS
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| property | PDFKit | MBS PDFKit Plugin | 21.1 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
Used by annotations type(s): /FreeText, /Widget (field type(s): /Btn, /Ch, and /Tx).
(Read and Write property)
PDFAnnotationMBS.Handle as Integer
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| property | PDFKit | MBS PDFKit Plugin | 8.0 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
(Read and Write property)
PDFAnnotationMBS.hasAppearanceStream as boolean
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| property | PDFKit | MBS PDFKit Plugin | 8.0 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
Annotations with appearance streams are drawn using their stream. As a result, setting many parameters (like 'setColor' above), will have no visible effect.
(Read only property)
PDFAnnotationMBS.iconType as Integer
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| property | PDFKit | MBS PDFKit Plugin | 21.1 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
Used by annotations type(s): /Text.
(Read and Write property)
PDFAnnotationMBS.interiorColor as NSColorMBS
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| property | PDFKit | MBS PDFKit Plugin | 21.1 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
Used by annotations type(s): /Circle, /Line, /Square.
(Read and Write property)
PDFAnnotationMBS.isHighlighted as Boolean
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| property | PDFKit | MBS PDFKit Plugin | 21.1 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
For example, if a user has clicked on a "Link" annotation, you should set highlighted to YES and redraw it. When the user lets up, set highlighted to false and redraw again.
Available in macOS 10.13 or newer or iOS 11.0 or newer.
(Read and Write property)
PDFAnnotationMBS.isPasswordField as Boolean
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| property | PDFKit | MBS PDFKit Plugin | 21.1 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
Used by annotations type(s): /Widget (field type(s): /Tx).
(Read only property)
PDFAnnotationMBS.ListChoice as Boolean
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| property | PDFKit | MBS PDFKit Plugin | 21.1 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
Used by annotations type(s): /Widget (field type(s): /Ch).
(Read and Write property)
PDFAnnotationMBS.markupType as Integer
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| property | PDFKit | MBS PDFKit Plugin | 21.1 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
Used by annotations type(s): /Highlight, /StrikeOut, /Underline.
(Read and Write property)
PDFAnnotationMBS.maximumLength as Integer
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| property | PDFKit | MBS PDFKit Plugin | 21.1 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
Used by annotations type(s): /Widget (field type(s): /Tx).
(Read and Write property)
PDFAnnotationMBS.modificationDate as date
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| property | PDFKit | MBS PDFKit Plugin | 9.6 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop, Console & Web |
Available in Mac OS X v10.5 and later.
(Read and Write property)
PDFAnnotationMBS.modificationDateTime as DateTime
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| property | PDFKit | MBS PDFKit Plugin | 20.5 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
Available in Mac OS X v10.5 and later.
(Read and Write property)
PDFAnnotationMBS.mouseUpAction as PDFActionMBS
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| property | PDFKit | MBS PDFKit Plugin | 9.6 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
Available in Mac OS X v10.5 and later.
(Read and Write property)
PDFAnnotationMBS.multiline as Boolean
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| property | PDFKit | MBS PDFKit Plugin | 21.1 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
Used by annotations type(s): /Widget (field type(s): /Tx).
(Read and Write property)
PDFAnnotationMBS.Open as Boolean
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| property | PDFKit | MBS PDFKit Plugin | 21.1 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
Used by annotations type(s): /Popup.
(Read and Write property)
PDFAnnotationMBS.page as PDFPageMBS
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| property | PDFKit | MBS PDFKit Plugin | 8.0 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
(Read only property)
PDFAnnotationMBS.popup as Variant
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| property | PDFKit | MBS PDFKit Plugin | 9.6 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop, Console & Web |
The variant is a PDFAnnotationPopupMBS.
Pop-up annotations are not used with links or widgets. The bounds and open state of the pop-up annotation indicate the placement and open state of the pop-up window.
Available in Mac OS X v10.5 and later.
(Read and Write property)
PDFAnnotationMBS.radiosInUnison as Boolean
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| property | PDFKit | MBS PDFKit Plugin | 21.1 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
Used by annotations type(s): /Widget (field type(s): /Btn).
(Read and Write property)
PDFAnnotationMBS.ReadOnly as Boolean
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| property | PDFKit | MBS PDFKit Plugin | 21.1 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
Used by annotations type(s): /Widget (field type(s): /Btn, /Ch, /Tx).
(Read and Write property)
PDFAnnotationMBS.shouldDisplay as boolean
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| property | PDFKit | MBS PDFKit Plugin | 8.0 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
(Read and Write property)
PDFAnnotationMBS.shouldPrint as boolean
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| property | PDFKit | MBS PDFKit Plugin | 8.0 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
(Read and Write property)
PDFAnnotationMBS.stampName as String
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| property | PDFKit | MBS PDFKit Plugin | 21.1 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
Standard stamps include names like, "Approved", "Draft", "TopSecret", etc.
The name must be representable as ASCII. Very little is rendered if the annotation has no appearance stream.
Used by annotations type(s): /Stamp
(Read and Write property)
PDFAnnotationMBS.startLineStyle as Integer
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| property | PDFKit | MBS PDFKit Plugin | 21.1 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
Used by annotations type(s): /Line.
(Read and Write property)
PDFAnnotationMBS.startPoint as NSPointMBS
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| property | PDFKit | MBS PDFKit Plugin | 21.1 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
Points are specified in annotation space.
Used by annotations type(s): /Line.
(Read and Write property)
PDFAnnotationMBS.toolTip as string
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| property | PDFKit | MBS PDFKit Plugin | 8.0 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop, Console & Web |
The base class returns contents, sub-classes may override as appropriate.
(Read only property)
PDFAnnotationMBS.type as string
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| property | PDFKit | MBS PDFKit Plugin | 8.0 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
Examples include: "Text", "Link", "Line", etc.
(Read and Write property)
PDFAnnotationMBS.URL as String
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| property | PDFKit | MBS PDFKit Plugin | 21.1 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
The preferred way though is to via action property.
Used by annotations type(s): /Link.
(Read and Write property)
PDFAnnotationMBS.userName as string
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| property | PDFKit | MBS PDFKit Plugin | 9.6 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
Available in Mac OS X v10.5 and later.
(Read and Write property)
PDFAnnotationMBS.widgetControlType as Integer
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| property | PDFKit | MBS PDFKit Plugin | 21.1 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
Used by annotations type(s): /Widget (field type(s): /Btn).
(Read and Write property)
PDFAnnotationMBS.widgetDefaultStringValue as String
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| property | PDFKit | MBS PDFKit Plugin | 21.1 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
Used by annotations type(s): /Widget (field type(s): /Btn, /Ch, /Tx).
(Read and Write property)
PDFAnnotationMBS.widgetFieldType as String
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| property | PDFKit | MBS PDFKit Plugin | 21.1 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
Used by annotations type(s): /Widget (field type(s): /Btn, /Ch, /Tx).
(Read and Write property)
The items on this page are in the following plugins: MBS PDFKit Plugin.