Platforms to show: All Mac Windows Linux Cross-Platform

Back to PDFAnnotationMBS class.

Next items

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
Optional action performed when a user clicks / taps an annotation.

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
Alignment of text within annotation bounds. Supported: NSLeftTextAlignment, NSRightTextAlignment and NSCenterTextAlignment.

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
For radio buttons, indicates whether clicking on widget whose state is already On toggles it Off.

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
List all key-value pairs for this annotation; returns a deep copy of all pairs.

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
Background color characteristics.

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
Optional border or border style that describes how to draw the annoation border (if any).
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

(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
The bounding box for the annotation in page space.

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
The current state of a button widget annotation.

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
The string that represents the ON state of a button widget annotation.

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
Label for the button. Applies to kPDFWidgetPushButtonControl only.

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
For many annotations ("Circle", "Square") the stroke color.
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

Type Topic Plugin Version macOS Windows Linux iOS Targets
property PDFKit MBS PDFKit Plugin 21.1 ✅ Yes ❌ No ❌ No ✅ Yes All
Used to configure combing for PDF text fields.

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
A string of text associated with an annotation.
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

Type Topic Plugin Version macOS Windows Linux iOS Targets
property PDFKit MBS PDFKit Plugin 21.1 ✅ Yes ❌ No ❌ No ✅ Yes All
Destination for the link. May be nil if no destination associated with link; in this case the URL may be valid.

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
Style used for ornaments at the lines end (optional, PDF 1.4).

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 specifying end points for line annotation (required).

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
Widget annotations backed by form data have (internal) field names with which to associate a value or data.

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
Font and font color associated with the text field.

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
Width of line used to stroke border.

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
The handle used internally for the object reference.

(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
Returns true if the annotation has an appearance stream.

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
The type of icon displayed in the PDF. Supported icons: "Comment", "Key", "Note", "Help", "NewParagraph", "Paragraph" and "Insert".

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
Interior color of the annotation.

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
The highlight state dictates how the annotation is drawn.

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 to determine if a PDF text field is a password field.

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
There are two flavors of Choice widget annotations, lists and pop-up menus. This method allow you to differentiate.

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
Type of mark-up (highlight, strike-out or underline). Changing the markup type also changes the annotations type.

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
Maximum characters allowed (optional, zero indicates no specified maximum).

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
The modification date of the annotation.

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
The modification date of the annotation.

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
The action performed when a user releases the mouse button within an annotation.

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 to configure multiline PDF text fields.

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 to tell if an annotation is open or closed.

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
Returns the page the annotation is associated with.

(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 pop-up annotation associated with an annotation.

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
For radio buttons, indicates whether a group of radio buttons will turn on and off in unison; that is if one is checked, they are all checked. If clear, the buttons are mutually exclusive.

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
Determines if a text field should be editable or not.

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
Specifies whether it should be drawn to the display or not.

(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
Specifies whether it should be printed or not.

(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
Name of stamp annotation.

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
Style used for ornaments at the lines start (optional, PDF 1.4).

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 specifying start points for line annotation (required).

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
String used for tooltips.

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
Returns the annotation type (called "Subtype" in the PDF specification since "Annot" is the type).
Example
dim a as new PDFAnnotationTextMBS(100,100,100,100)
MsgBox a.type // Text

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
URL for the link. May be nil if no URL action associated with link; in this case the destination may be valid.

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
The name of the user who created the annotation.

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
The type of button widget control type (radio button, push button, or checkbox).

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
The string value for a widget annotation.

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
The specific field type of a widget annotation (button, choice, or text).

Used by annotations type(s): /Widget (field type(s): /Btn, /Ch, /Tx).
(Read and Write property)

Next items

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


The biggest plugin in space...