Platforms to show: All Mac Windows Linux Cross-Platform
Back to PDFAnnotationMBS class.
PDFAnnotationMBS.Action as PDFActionMBS
Function:
Optional action performed when a user clicks / taps an annotation.
Notes:
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)
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| property | PDFKit | MBS MacControls Plugin | 21.1 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop, Console & Web |
Notes:
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
Function:
Alignment of text within annotation bounds. Supported: NSLeftTextAlignment, NSRightTextAlignment and NSCenterTextAlignment.
Notes:
Used by annotations type(s): /FreeText, /Widget (field type(s): /Tx).
(Read and Write property)
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| property | PDFKit | MBS MacControls Plugin | 21.1 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop, Console & Web |
Notes:
Used by annotations type(s): /FreeText, /Widget (field type(s): /Tx).
(Read and Write property)
PDFAnnotationMBS.allowsToggleToOff as Boolean
Function:
For radio buttons, indicates whether clicking on widget whose state is already On toggles it Off.
Notes:
Used by annotations type(s): /Widget (field type(s): /Btn).
(Read and Write property)
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| property | PDFKit | MBS MacControls Plugin | 21.1 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop, Console & Web |
Notes:
Used by annotations type(s): /Widget (field type(s): /Btn).
(Read and Write property)
PDFAnnotationMBS.annotationKeyValues as Dictionary
Function:
List all key-value pairs for this annotation; returns a deep copy of all pairs.
Notes:
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)
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| property | PDFKit | MBS MacControls Plugin | 21.1 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop, Console & Web |
Notes:
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
Function:
Background color characteristics.
Notes:
Used by annotations type(s): /Widget (field type(s): /Btn, /Ch, /Tx).
(Read and Write property)
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| property | PDFKit | MBS MacControls Plugin | 21.1 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop, Console & Web |
Notes:
Used by annotations type(s): /Widget (field type(s): /Btn, /Ch, /Tx).
(Read and Write property)
PDFAnnotationMBS.border as PDFBorderMBS
Function:
Optional border or border style that describes how to draw the annoation border (if any).
Example:
Notes:
(Read and Write property)
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| property | PDFKit | MBS MacControls Plugin | 8.0 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop, Console & Web |
Example:
dim f as FolderItem = SpecialFolder.Desktop.Child("test.pdf")
dim doc as new PDFDocumentMBS(f)
dim page as PDFPageMBS = doc.pageAtIndex(0)
dim a as new PDFAnnotationSquareMBS(100,100,100,100)
a.interiorColor = NSColorMBS.greenColor
a.colorValue = NSColorMBS.redColor
a.border.lineWidth=5
page.addAnnotation(a)
dim o as FolderItem = SpecialFolder.Desktop.Child("testout.pdf")
call doc.write(o)
o.Launch
PDFAnnotationMBS.bounds as NSRectMBS
Function:
The bounding box for the annotation in page space.
Notes:
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)
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| property | PDFKit | MBS MacControls Plugin | 9.6 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop, Console & Web |
Notes:
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
Function:
The current state of a button widget annotation.
Notes:
Used by annotations type(s): /Widget (field type(s): /Btn).
(Read and Write property)
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| property | PDFKit | MBS MacControls Plugin | 21.1 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop, Console & Web |
Notes:
Used by annotations type(s): /Widget (field type(s): /Btn).
(Read and Write property)
PDFAnnotationMBS.buttonWidgetStateString as String
Function:
The string that represents the ON state of a button widget annotation.
Notes:
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)
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| property | PDFKit | MBS MacControls Plugin | 21.1 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop, Console & Web |
Notes:
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
Function:
Label for the button. Applies to kPDFWidgetPushButtonControl only.
Notes:
Used by annotations type(s): /Widget (field type(s): /Btn).
(Read and Write property)
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| property | PDFKit | MBS MacControls Plugin | 21.1 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop, Console & Web |
Notes:
Used by annotations type(s): /Widget (field type(s): /Btn).
(Read and Write property)
PDFAnnotationMBS.colorValue as NSColorMBS
Function:
For many annotations ("Circle", "Square") the stroke color.
Example:
Notes:
Used for other annotations as well.
(Read and Write property)
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| property | PDFKit | MBS MacControls Plugin | 8.0 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop, Console & Web |
Example:
dim f as FolderItem = SpecialFolder.Desktop.Child("test.pdf")
dim doc as new PDFDocumentMBS(f)
dim page as PDFPageMBS = doc.pageAtIndex(0)
dim a as new PDFAnnotationLineMBS(100,100,100,100)
a.colorValue = NSColorMBS.redColor
a.endLineStyle = a.kPDFLineStyleOpenArrow
page.addAnnotation(a)
dim o as FolderItem = SpecialFolder.Desktop.Child("testout.pdf")
call doc.write(o)
Used for other annotations as well.
(Read and Write property)
PDFAnnotationMBS.comb as Boolean
Function:
Used to configure combing for PDF text fields.
Notes:
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)
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| property | PDFKit | MBS MacControls Plugin | 21.1 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop, Console & Web |
Notes:
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
Function:
A string of text associated with an annotation.
Example:
Notes:
Often to be displayed in a pop-up when the annotation is clicked on ("FreeText" and "Text" especially).
(Read and Write property)
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| property | PDFKit | MBS MacControls Plugin | 8.0 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop, Console & Web |
Example:
dim f as FolderItem = SpecialFolder.Desktop.Child("test.pdf")
dim doc as new PDFDocumentMBS(f)
dim page as PDFPageMBS = doc.pageAtIndex(0)
dim a as new PDFAnnotationTextMBS(100,100,100,100)
a.contents="Hello"
a.colorValue = NSColorMBS.redColor
page.addAnnotation(a)
dim o as FolderItem = SpecialFolder.Desktop.Child("testout.pdf")
call doc.write(o)
o.Launch
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
Function:
Destination for the link. May be nil if no destination associated with link; in this case the URL may be valid.
Notes:
The preferred way though is to use action property.
Used by annotations type(s): /Link.
(Read and Write property)
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| property | PDFKit | MBS MacControls Plugin | 21.1 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop, Console & Web |
Notes:
The preferred way though is to use action property.
Used by annotations type(s): /Link.
(Read and Write property)
PDFAnnotationMBS.endLineStyle as Integer
Function:
Style used for ornaments at the lines end (optional, PDF 1.4).
Notes:
Used by annotations type(s): /Line.
(Read and Write property)
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| property | PDFKit | MBS MacControls Plugin | 21.1 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop, Console & Web |
Notes:
Used by annotations type(s): /Line.
(Read and Write property)
PDFAnnotationMBS.endPoint as NSPointMBS
Function:
Points specifying end points for line annotation (required).
Notes:
Points are specified in annotation space.
Used by annotations type(s): /Line.
(Read and Write property)
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| property | PDFKit | MBS MacControls Plugin | 21.1 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop, Console & Web |
Notes:
Points are specified in annotation space.
Used by annotations type(s): /Line.
(Read and Write property)
PDFAnnotationMBS.fieldName as String
Function:
Widget annotations backed by form data have (internal) field names with which to associate a value or data.
Notes:
Can also be used for ResetForm actions.
Used by annotations type(s): /Widget (field type(s): /Btn, /Ch, /Tx).
(Read and Write property)
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| property | PDFKit | MBS MacControls Plugin | 21.1 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop, Console & Web |
Notes:
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
Function:
Font and font color associated with the text field.
Notes:
Used by annotations type(s): /FreeText, /Popup, /Widget (field type(s): /Btn, /Ch, and /Tx).
(Read and Write property)
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| property | PDFKit | MBS MacControls Plugin | 21.1 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop, Console & Web |
Notes:
Used by annotations type(s): /FreeText, /Popup, /Widget (field type(s): /Btn, /Ch, and /Tx).
(Read and Write property)
PDFAnnotationMBS.fontColor as NSColorMBS
Function:
Width of line used to stroke border.
Notes:
Used by annotations type(s): /FreeText, /Widget (field type(s): /Btn, /Ch, and /Tx).
(Read and Write property)
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| property | PDFKit | MBS MacControls Plugin | 21.1 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop, Console & Web |
Notes:
Used by annotations type(s): /FreeText, /Widget (field type(s): /Btn, /Ch, and /Tx).
(Read and Write property)
PDFAnnotationMBS.Handle as Integer
Function:
The handle used internally for the object reference.
Notes: (Read and Write property)
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| property | PDFKit | MBS MacControls Plugin | 8.0 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop, Console & Web |
Notes: (Read and Write property)
PDFAnnotationMBS.hasAppearanceStream as boolean
Function:
Returns true if the annotation has an appearance stream.
Notes:
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)
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| property | PDFKit | MBS MacControls Plugin | 8.0 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop, Console & Web |
Notes:
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
Function:
The type of icon displayed in the PDF. Supported icons: "Comment", "Key", "Note", "Help", "NewParagraph", "Paragraph" and "Insert".
Notes:
Used by annotations type(s): /Text.
(Read and Write property)
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| property | PDFKit | MBS MacControls Plugin | 21.1 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop, Console & Web |
Notes:
Used by annotations type(s): /Text.
(Read and Write property)
PDFAnnotationMBS.interiorColor as NSColorMBS
Function:
Interior color of the annotation.
Notes:
Used by annotations type(s): /Circle, /Line, /Square.
(Read and Write property)
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| property | PDFKit | MBS MacControls Plugin | 21.1 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop, Console & Web |
Notes:
Used by annotations type(s): /Circle, /Line, /Square.
(Read and Write property)
PDFAnnotationMBS.isHighlighted as Boolean
Function:
The highlight state dictates how the annotation is drawn.
Notes:
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)
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| property | PDFKit | MBS MacControls Plugin | 21.1 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop, Console & Web |
Notes:
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
Function:
Used to determine if a PDF text field is a password field.
Notes:
Used by annotations type(s): /Widget (field type(s): /Tx).
(Read only property)
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| property | PDFKit | MBS MacControls Plugin | 21.1 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop, Console & Web |
Notes:
Used by annotations type(s): /Widget (field type(s): /Tx).
(Read only property)
PDFAnnotationMBS.ListChoice as Boolean
Function:
There are two flavors of Choice widget annotations, lists and pop-up menus. This method allow you to differentiate.
Notes:
Used by annotations type(s): /Widget (field type(s): /Ch).
(Read and Write property)
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| property | PDFKit | MBS MacControls Plugin | 21.1 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop, Console & Web |
Notes:
Used by annotations type(s): /Widget (field type(s): /Ch).
(Read and Write property)
PDFAnnotationMBS.markupType as Integer
Function:
Type of mark-up (highlight, strike-out or underline). Changing the markup type also changes the annotations type.
Notes:
Used by annotations type(s): /Highlight, /StrikeOut, /Underline.
(Read and Write property)
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| property | PDFKit | MBS MacControls Plugin | 21.1 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop, Console & Web |
Notes:
Used by annotations type(s): /Highlight, /StrikeOut, /Underline.
(Read and Write property)
PDFAnnotationMBS.maximumLength as Integer
Function:
Maximum characters allowed (optional, zero indicates no specified maximum).
Notes:
Used by annotations type(s): /Widget (field type(s): /Tx).
(Read and Write property)
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| property | PDFKit | MBS MacControls Plugin | 21.1 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop, Console & Web |
Notes:
Used by annotations type(s): /Widget (field type(s): /Tx).
(Read and Write property)
PDFAnnotationMBS.modificationDate as date
Function:
The modification date of the annotation.
Notes:
Available in Mac OS X v10.5 and later.
(Read and Write property)
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| property | PDFKit | MBS MacControls Plugin | 9.6 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop, Console & Web |
Notes:
Available in Mac OS X v10.5 and later.
(Read and Write property)
The items on this page are in the following plugins: MBS MacControls Plugin.
