Xojo Conferences
MBSOct2019CologneDE

Platforms to show: All Mac Windows Linux Cross-Platform

PDFAnnotationMBS.border as PDFBorderMBS
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property PDFKit MBS MacControls Plugin 8.0 Yes No No Yes, macOS only No
Function: 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
Notes: (Read and Write property)

Feedback, Comments & Corrections

PDFAnnotationMBS.bounds as NSRectMBS
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property PDFKit MBS MacControls Plugin 9.6 Yes No No Yes, macOS only No
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)

Feedback, Comments & Corrections

PDFAnnotationMBS.colorValue as NSColorMBS
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property PDFKit MBS MacControls Plugin 8.0 Yes No No Yes, macOS only No
Function: 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)
Notes:
Used for other annotations as well.
(Read and Write property)

Feedback, Comments & Corrections

PDFAnnotationMBS.contents as string
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property PDFKit MBS MacControls Plugin 8.0 Yes No No Yes, macOS only No
Function: 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
Notes:
Often to be displayed in a pop-up when the annotation is clicked on ("FreeText" and "Text" especially).
(Read and Write property)

Feedback, Comments & Corrections

PDFAnnotationMBS.Handle as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property PDFKit MBS MacControls Plugin 8.0 Yes No No Yes, macOS only No
Function: The handle used internally for the object reference.
Notes: (Read and Write property)

Feedback, Comments & Corrections

PDFAnnotationMBS.hasAppearanceStream as boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property PDFKit MBS MacControls Plugin 8.0 Yes No No Yes, macOS only No
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)

Feedback, Comments & Corrections

PDFAnnotationMBS.modificationDate as date
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property PDFKit MBS MacControls Plugin 9.6 Yes No No Yes, macOS only No
Function: The modification date of the annotation.
Notes:
Available in Mac OS X v10.5 and later.
(Read and Write property)

Feedback, Comments & Corrections

PDFAnnotationMBS.mouseUpAction as PDFActionMBS
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property PDFKit MBS MacControls Plugin 9.6 Yes No No Yes, macOS only No
Function: The action performed when a user releases the mouse button within an annotation.
Notes:
Available in Mac OS X v10.5 and later.
(Read and Write property)

Feedback, Comments & Corrections

PDFAnnotationMBS.page as PDFPageMBS
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property PDFKit MBS MacControls Plugin 8.0 Yes No No Yes, macOS only No
Function: Returns the page the annotation is associated with.
Notes: (Read only property)

Feedback, Comments & Corrections

PDFAnnotationMBS.popup as Variant
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property PDFKit MBS MacControls Plugin 9.6 Yes No No Yes, macOS only No
Function: The pop-up annotation associated with an annotation.
Notes:
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)

Feedback, Comments & Corrections

PDFAnnotationMBS.shouldDisplay as boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property PDFKit MBS MacControls Plugin 8.0 Yes No No Yes, macOS only No
Function: Specifies whether it should be drawn to the display or not.
Notes: (Read and Write property)

Feedback, Comments & Corrections

PDFAnnotationMBS.shouldPrint as boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property PDFKit MBS MacControls Plugin 8.0 Yes No No Yes, macOS only No
Function: Specifies whether it should be printed or not.
Notes: (Read and Write property)

Feedback, Comments & Corrections

PDFAnnotationMBS.toolTip as string
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property PDFKit MBS MacControls Plugin 8.0 Yes No No Yes, macOS only No
Function: String used for tooltips.
Notes:
The base class returns contents, sub-classes may override as appropriate.
(Read only property)

Feedback, Comments & Corrections

PDFAnnotationMBS.type as string
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property PDFKit MBS MacControls Plugin 8.0 Yes No No Yes, macOS only No
Function: 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
Notes:
Examples include: "Text", "Link", "Line", etc.
(Read only property)

Feedback, Comments & Corrections

PDFAnnotationMBS.userName as string
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property PDFKit MBS MacControls Plugin 9.6 Yes No No Yes, macOS only No
Function: The name of the user who created the annotation.
Notes:
Available in Mac OS X v10.5 and later.
(Read and Write property)

Feedback, Comments & Corrections

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

The biggest plugin in space...




Links
MBS Xojo Plugins