Platforms to show: All Mac Windows Linux Cross-Platform

PDFAnnotationMBS.addBezierPath(path as NSBezierPathMBS)
Type Topic Plugin Version macOS Windows Linux iOS Targets
method PDFKit MBS MacControls Plugin 21.1 ✅ Yes ❌ No ❌ No ❌ No Desktop, Console & Web
Function: Add paths from the annotation.
Notes:
Path points are specified in annotation space.
Used by annotations type(s): /Ink.

Feedback, Comments & Corrections

PDFAnnotationMBS.choices as string()
Type Topic Plugin Version macOS Windows Linux iOS Targets
method PDFKit MBS MacControls Plugin 21.1 ✅ Yes ❌ No ❌ No ❌ No Desktop, Console & Web
Function: The choices are an array of strings indicating the options (items) in either a list or pop-up menu.
Notes: Used by annotations type(s): /Widget (field type(s): /Ch).

Feedback, Comments & Corrections

PDFAnnotationMBS.Constructor
Type Topic Plugin Version macOS Windows Linux iOS Targets
method PDFKit MBS MacControls Plugin 10.4 ✅ Yes ❌ No ❌ No ❌ No Desktop, Console & Web
Function: The private constructor.
Notes:
This class is the base class for a number of annotations. So this constructor is private to make sure you don't create instances of PDFAnnotationMBS. But you can still create instances of the subclasses.
This constructor is private to make sure you don't create an object from this class by error. Please use designated functions to create objects.

See also:

Feedback, Comments & Corrections

PDFAnnotationMBS.Constructor(Handle as Integer)
Type Topic Plugin Version macOS Windows Linux iOS Targets
method PDFKit MBS MacControls Plugin 20.2 ✅ Yes ❌ No ❌ No ❌ No Desktop, Console & Web
Function: Creates a new object based on a given PDFAnnotation handle.
Notes:
Please pass in a non zero handle which points to a PDFAnnotation object.
For use with declares.

See also:

Feedback, Comments & Corrections

PDFAnnotationMBS.Constructor(left as Double, top as Double, width as Double, height as Double)
Type Topic Plugin Version macOS Windows Linux iOS Targets
method PDFKit MBS MacControls Plugin 21.1 ✅ Yes ❌ No ❌ No ❌ No Desktop, Console & Web
Function: Creates a new annotation.
Notes: You need to set type once.

See also:

Feedback, Comments & Corrections

PDFAnnotationMBS.Constructor(left as Double, top as Double, width as Double, height as Double, annotationType as String, properties as Dictionary = nil)
Type Topic Plugin Version macOS Windows Linux iOS Targets
method PDFKit MBS MacControls Plugin 21.1 ✅ Yes ❌ No ❌ No ❌ No Desktop, Console & Web
Function: Creates a new annotation of given type.

See also:

Feedback, Comments & Corrections

PDFAnnotationMBS.copy as PDFAnnotationMBS
Type Topic Plugin Version macOS Windows Linux iOS Targets
method PDFKit MBS MacControls Plugin 13.1 ✅ Yes ❌ No ❌ No ❌ No Desktop, Console & Web
Function: Creates a copy of the annotation object.
Notes:
For Mac OS X 10.7 and newer this function uses the framework function.
For Mac OS X 10.6 and older this function uses our own copy function to duplicate the annotation.

Feedback, Comments & Corrections

PDFAnnotationMBS.Destructor
Type Topic Plugin Version macOS Windows Linux iOS Targets
method PDFKit MBS MacControls Plugin 12.5 ✅ Yes ❌ No ❌ No ❌ No Desktop, Console & Web
Function: The destructor.

Feedback, Comments & Corrections

PDFAnnotationMBS.drawWithBox(box as Integer)
Type Topic Plugin Version macOS Windows Linux iOS Targets
method PDFKit MBS MacControls Plugin 9.6 ✅ Yes ❌ No ❌ No ❌ No Desktop, Console & Web
Function: Draws the annotation on its associated page.
Notes:
The annotation is drawn relative to the origin of box in page space.

Page space is a 72 dpi coordinate system with the origin at the lower-left corner of the current page.

For additional information see the "Constants" section in the PDFPage class.

Available in Mac OS X v10.4 and later.

Feedback, Comments & Corrections

PDFAnnotationMBS.paths as NSBezierPathMBS()
Type Topic Plugin Version macOS Windows Linux iOS Targets
method PDFKit MBS MacControls Plugin 21.1 ✅ Yes ❌ No ❌ No ❌ No Desktop, Console & Web
Function: Array of NSBezierPathsMBS that comprise the annotation.
Notes:
Paths are specified in annotation space.
Used by annotations type(s): /Ink.

Feedback, Comments & Corrections

PDFAnnotationMBS.quadrilateralPoints as NSPointMBS()
Type Topic Plugin Version macOS Windows Linux iOS Targets
method PDFKit MBS MacControls Plugin 21.1 ✅ Yes ❌ No ❌ No ❌ No Desktop, Console & Web
Function: Array of n * 4 points, packed as NSValue pointValue / CGPointValue, defining n quadrilaterals in page space where n is the number of quad points.
Notes:
The points for each quad are ordered in a 'Z' pattern. That is, the first point should represent the upper left point representing the start of the marked-up text, the next point will be the upper right, the third point will represent the lower left of the text and the last point the lower right.
Points are specified relative to the annotation's bound's origin.

Feedback, Comments & Corrections

PDFAnnotationMBS.removeAllAppearanceStreams
Type Topic Plugin Version macOS Windows Linux iOS Targets
method PDFKit MBS MacControls Plugin 9.6 ✅ Yes ❌ No ❌ No ❌ No Desktop, Console & Web
Function: All appearance streams for the target annotation are removed.
Notes:
Without an appearance stream, annotations are drawn strictly according to their parameters (color, border, font, etc.). When a PDF is saved, PDF Kit will always write out an appearance stream(s) for each annotation. If the PDF is reloaded, you will need to remove the appearance streams in order to continue to edit the annotations parameters.

Requires Mac OS X 10.5.

Feedback, Comments & Corrections

PDFAnnotationMBS.removeBezierPath(path as NSBezierPathMBS)
Type Topic Plugin Version macOS Windows Linux iOS Targets
method PDFKit MBS MacControls Plugin 21.1 ✅ Yes ❌ No ❌ No ❌ No Desktop, Console & Web
Function: Remove paths from the annotation.

Feedback, Comments & Corrections

PDFAnnotationMBS.removeValueForAnnotationKey(Key as String)
Type Topic Plugin Version macOS Windows Linux iOS Targets
method PDFKit MBS MacControls Plugin 21.1 ✅ Yes ❌ No ❌ No ❌ No Desktop, Console & Web
Function: Remove the key-value pair from the annotation dictionary. Returns true on successful removal.

Feedback, Comments & Corrections

PDFAnnotationMBS.setBooleanValue(Key as String, value as Boolean) as Boolean
Type Topic Plugin Version macOS Windows Linux iOS Targets
method PDFKit MBS MacControls Plugin 21.1 ✅ Yes ❌ No ❌ No ❌ No Desktop, Console & Web
Function: Sets a boolean value.
Notes: See also setValue.

Feedback, Comments & Corrections

PDFAnnotationMBS.setChoices(choices() as string)
Type Topic Plugin Version macOS Windows Linux iOS Targets
method PDFKit MBS MacControls Plugin 21.1 ✅ Yes ❌ No ❌ No ❌ No Desktop, Console & Web
Function: The choices are an array of strings indicating the options (items) in either a list or pop-up menu.
Notes: Used by annotations type(s): /Widget (field type(s): /Ch).

Feedback, Comments & Corrections

PDFAnnotationMBS.setQuadrilateralPoints(points() as NSPointMBS)
Type Topic Plugin Version macOS Windows Linux iOS Targets
method PDFKit MBS MacControls Plugin 21.1 ✅ Yes ❌ No ❌ No ❌ No Desktop, Console & Web
Function: Array of n * 4 points, packed as NSValue pointValue / CGPointValue, defining n quadrilaterals in page space where n is the number of quad points.
Notes:
The points for each quad are ordered in a 'Z' pattern. That is, the first point should represent the upper left point representing the start of the marked-up text, the next point will be the upper right, the third point will represent the lower left of the text and the last point the lower right.
Points are specified relative to the annotation's bound's origin.

Feedback, Comments & Corrections

PDFAnnotationMBS.setRectValue(Key as String, value as NSRectMBS) as Boolean
Type Topic Plugin Version macOS Windows Linux iOS Targets
method PDFKit MBS MacControls Plugin 21.1 ✅ Yes ❌ No ❌ No ❌ No Desktop, Console & Web
Function: Sets a rectangle value.
Notes: See also setValue.

Feedback, Comments & Corrections

PDFAnnotationMBS.setValue(Key as String, value as Variant) as Boolean
Type Topic Plugin Version macOS Windows Linux iOS Targets
method PDFKit MBS MacControls Plugin 21.1 ✅ Yes ❌ No ❌ No ❌ No Desktop, Console & Web
Function: Allows you to set a key-value pair in this annotation's dictionary.
Notes: Returns true on successful assignment, false on error. Key must be valid for a PDF annotation's object type, and must have a value that is acceptable for the key type. These values can either be a string, number, array of strings or numbers, or an dictionary of the previously listed types. Some keys expect a complex type, for example the key "/C" expects a color in the format of an array of 0, 1, 3, or 4 elements, with each element being a floating-point number in the range of 0.0 - 1.0 ). As a convenience, these kind of keys will directly accept NSColorMBS values. Other convenience functions provide similar support can be found in PDFAnnotationUtilities header file. Note that you can set the environment variable "PDFKIT_LOG_ANNOTATIONS" to log any key-value assignment failures.

Feedback, Comments & Corrections

PDFAnnotationMBS.setValues(values() as string)
Type Topic Plugin Version macOS Windows Linux iOS Targets
method PDFKit MBS MacControls Plugin 21.1 ✅ Yes ❌ No ❌ No ❌ No Desktop, Console & Web
Function: The choices are an array of strings indicating the option’s export values in either a list or pop-up menu.
Notes: Used by annotations type(s): /Widget (field type(s): /Ch).

Feedback, Comments & Corrections

PDFAnnotationMBS.valueForAnnotationKey(Key as String) as Variant
Type Topic Plugin Version macOS Windows Linux iOS Targets
method PDFKit MBS MacControls Plugin 21.1 ✅ Yes ❌ No ❌ No ❌ No Desktop, Console & Web
Function: Retrieves a deep copy of the key-value pair based on the given key; key can either be from the keys PDFAnnotationKey, or an appropriate string from the PDF specification.

Feedback, Comments & Corrections

PDFAnnotationMBS.values as string()
Type Topic Plugin Version macOS Windows Linux iOS Targets
method PDFKit MBS MacControls Plugin 21.1 ✅ Yes ❌ No ❌ No ❌ No Desktop, Console & Web
Function: The choices are an array of strings indicating the option’s export values in either a list or pop-up menu.
Notes: Used by annotations type(s): /Widget (field type(s): /Ch).

Feedback, Comments & Corrections

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

The biggest plugin in space...




Links
MBS FileMaker Plugins

Start Chat