Platforms to show: All Mac Windows Linux Cross-Platform
DynaPDFMBS.SetAnnotLineEndStyle(Handle as UInt32, StartLineStyle as Integer, EndLineStyle as Integer) as boolean
Function:
The function sets or changes the line end styles of a Line or PolyLine Annotation.
Notes: If the function succeeds the return value is true. If the function fails the return value is false.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 14.0 | Yes | Yes | Yes | Yes | All |
Notes: If the function succeeds the return value is true. If the function fails the return value is false.
See also SetAnnotLineEndStyle function in DynaPDF manual.
DynaPDFMBS.SetAnnotMigrationState(Handle as Integer, State as Integer, Name as string) as Integer
Function:
Adds a migration state to a markup annotation.
Notes:
All annotation types with exception of 3D, Link, Movie, Screen, PrinterMark, TrapNet, and Watermark are markup annotations.
Migration states are stored in text annotations as reply to the base annotation. Further states are stored as reply to the last reply; the result is a single linked list. Because the base annotation contains no reference to the last reply or migration state the function must search for it. To speed upprocessing the function returns the handle of the text annotation so that the next state can directly be added to this annotation.
The migration state is defined since PDF 1.5. The function adjusts the PDF version automatically if it is lower than PDF 1.5.
If the function succeeds the return value is the handle of the text annotation, a value greater or equal zero. If the function fails the return value is a negative error code.
State can be kasNone, kasAccepted, kasRejected, kasCancelled, kasCompleted.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 15.4 | Yes | Yes | Yes | Yes | All |
Notes:
All annotation types with exception of 3D, Link, Movie, Screen, PrinterMark, TrapNet, and Watermark are markup annotations.
Migration states are stored in text annotations as reply to the base annotation. Further states are stored as reply to the last reply; the result is a single linked list. Because the base annotation contains no reference to the last reply or migration state the function must search for it. To speed upprocessing the function returns the handle of the text annotation so that the next state can directly be added to this annotation.
The migration state is defined since PDF 1.5. The function adjusts the PDF version automatically if it is lower than PDF 1.5.
If the function succeeds the return value is the handle of the text annotation, a value greater or equal zero. If the function fails the return value is a negative error code.
State can be kasNone, kasAccepted, kasRejected, kasCancelled, kasCompleted.
See also SetAnnotMigrationState function in DynaPDF manual.
DynaPDFMBS.SetAnnotMigrationStateAnsi(Handle as Integer, State as Integer, Name as string) as Integer
Function:
Adds a migration state to a markup annotation.
All annotation types with exception of 3D, Link, Movie, Screen, PrinterMark, TrapNet, and Watermark are markup annotations.
Migration states are stored in text annotations as reply to the base annotation. Further states are stored as reply to the last reply; the result is a single linked list. Because the base annotation contains no reference to the last reply or migration state the function must search for it. To speed upprocessing the function returns the handle of the text annotation so that the next state can directly be added to this annotation.
The migration state is defined since PDF 1.5. The function adjusts the PDF version automatically if it is lower than PDF 1.5.
If the function succeeds the return value is the handle of the text annotation, a value greater or equal zero. If the function fails the return value is a negative error code.
State can be kasNone, kasAccepted, kasRejected, kasCancelled, kasCompleted.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 15.4 | Yes | Yes | Yes | Yes | All |
This item is deprecated and should no longer be used.
You can use Non ANSI function. instead.
Notes:
All annotation types with exception of 3D, Link, Movie, Screen, PrinterMark, TrapNet, and Watermark are markup annotations.
Migration states are stored in text annotations as reply to the base annotation. Further states are stored as reply to the last reply; the result is a single linked list. Because the base annotation contains no reference to the last reply or migration state the function must search for it. To speed upprocessing the function returns the handle of the text annotation so that the next state can directly be added to this annotation.
The migration state is defined since PDF 1.5. The function adjusts the PDF version automatically if it is lower than PDF 1.5.
If the function succeeds the return value is the handle of the text annotation, a value greater or equal zero. If the function fails the return value is a negative error code.
State can be kasNone, kasAccepted, kasRejected, kasCancelled, kasCompleted.
See also SetAnnotMigrationState function in DynaPDF manual.
DynaPDFMBS.SetAnnotOpacity(Handle as Integer, opacity as Double) as Boolean
Function:
The function changes the opacity of a markup annotation.
Notes:
The function GetAnnotEx() or GetPageAnnotEx() can be used to determine whether an annotation is a markup annotation.
Returns true on succes or false on failure.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 16.0 | Yes | Yes | Yes | Yes | All |
Notes:
The function GetAnnotEx() or GetPageAnnotEx() can be used to determine whether an annotation is a markup annotation.
Returns true on succes or false on failure.
See also SetAnnotOpacity function in DynaPDF manual.
DynaPDFMBS.SetAnnotOpenState(Handle as Integer, Open as Boolean) as boolean
Function:
Sets the annotation open state.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 10.4 | Yes | Yes | Yes | Yes | All |
See also SetAnnotOpenState function in DynaPDF manual.
DynaPDFMBS.SetAnnotOrFieldDate(CSHandle as UInt32, IsField as Boolean, Type as Integer, DateTime as UInt32) as boolean
Function:
The function sets or changes the creation or modification date of an annotation or form field.
Notes:
If the parameter IsField is set to true, a valid field handle must be passed to the parameter Handle. An annotation handle is expected otherwise.
Annotations and form fields support a modification date but a creation date is supported by markup annotations only.
The following annotation types are markup annotations:
If the function succeeds the return value is 1. If the function fails the return value is 0.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 13.5 | Yes | Yes | Yes | Yes | All |
Notes:
If the parameter IsField is set to true, a valid field handle must be passed to the parameter Handle. An annotation handle is expected otherwise.
Annotations and form fields support a modification date but a creation date is supported by markup annotations only.
The following annotation types are markup annotations:
- Care
- Circle
- FileAttach
- FreeText
- Highlight, Squiggly, Strikeout, Underline
- Ink
- Line
- Polygon
- Projection
- Redact
- Sound
- Square
- Stamp
- Text
If the function succeeds the return value is 1. If the function fails the return value is 0.
See also SetAnnotOrFieldDate function in DynaPDF manual.
DynaPDFMBS.SetAnnotQuadPoints(Handle as UInt32, points() as DynaPDFPointMBS) as boolean
Function:
Sets or changes the quad points defintion of a Highlight, Link, Redakt, Squiggly, atStrikeOut, or Underline annotation.
Notes:
The function must be called within an open page.
Independent of the used coordinate system (bottom up or top down), the points must be defined in the following order:
x1,y1 x3,y3
x2,y2 x4,y4

The coordinates of the vertices are interpreted in current user space. Any transformation that was applied on the coordinate system will be taken into account.
The number of points must be 4 or a multiple of 4.
Returns true on success.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 15.3 | Yes | Yes | Yes | Yes | All |
Notes:
The function must be called within an open page.
Independent of the used coordinate system (bottom up or top down), the points must be defined in the following order:
x1,y1 x3,y3
x2,y2 x4,y4

The coordinates of the vertices are interpreted in current user space. Any transformation that was applied on the coordinate system will be taken into account.
The number of points must be 4 or a multiple of 4.
Returns true on success.
See also SetAnnotQuadPoints function in DynaPDF manual.
DynaPDFMBS.SetAnnotString(Handle as Integer, StringType as Integer, Value as string) as boolean
Function:
Creates a stamp annotation.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 9.7 | Yes | Yes | Yes | Yes | All |
See also SetAnnotString function in DynaPDF manual.
DynaPDFMBS.SetAnnotStringAnsi(Handle as Integer, StringType as Integer, Value as string) as boolean
Function:
Creates a stamp annotation.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 9.7 | Yes | Yes | Yes | Yes | All |
This item is deprecated and should no longer be used.
You can use Non ANSI function. instead.
See also SetAnnotString function in DynaPDF manual.
DynaPDFMBS.SetAnnotSubject(Handle as Integer, Value as string) as Boolean
Function:
The function sets or changes the optional subject string of an annotation.
Notes: The value parameter is converted to unicode.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 8.0 | Yes | Yes | Yes | Yes | All |
Notes: The value parameter is converted to unicode.
See also SetAnnotSubject function in DynaPDF manual.
DynaPDFMBS.SetAnnotSubjectAnsi(Handle as Integer, Value as string) as Boolean
Function:
The function sets or changes the optional subject string of an annotation.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 8.3 | Yes | Yes | Yes | Yes | All |
This item is deprecated and should no longer be used.
You can use Non ANSI function. instead.
Notes:
The value parameter is converted to ANSI.See also SetAnnotSubject function in DynaPDF manual.
DynaPDFMBS.SetBBox(Boundary as Integer, LeftX as Double, LeftY as Double, RightX as Double, RightY as Double) as Boolean
Function:
The function sets a specific bounding box of the current open PDF page.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 8.0 | Yes | Yes | Yes | Yes | All |
See also SetBBox function in DynaPDF manual.
DynaPDFMBS.SetBidiMode(BidiMode as Integer) as Boolean
Function:
The function sets or changes the bidirectional mode.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 8.0 | Yes | Yes | Yes | Yes | All |
See also SetBidiMode function in DynaPDF manual.
DynaPDFMBS.SetBlack(FillColor as Boolean, StrokeColor as Boolean) as Boolean
Function:
Sets black color.
Notes:
This function is a bit optimized to check the current color space.
Depending on whether it's RGB, Gray, CMYK or Lab, it will set different color values.
And if other color space is active, it switches to Gray colorspace to set black.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 19.2 | Yes | Yes | Yes | Yes | All |
Notes:
This function is a bit optimized to check the current color space.
Depending on whether it's RGB, Gray, CMYK or Lab, it will set different color values.
And if other color space is active, it switches to Gray colorspace to set black.
DynaPDFMBS.SetBookmarkDest(ABmk as Integer, DestType as Integer, a as Double, b as Double, c as Double, d as Double) as Boolean
Function:
The function sets or changes the destination of a bookmark.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 8.0 | Yes | Yes | Yes | Yes | All |
See also SetBookmarkDest function in DynaPDF manual.
DynaPDFMBS.SetBookmarkStyle(ABmk as Integer, Style as Integer, RGBColor as Integer) as Boolean
Function:
Sets the bookmark style.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 8.0 | Yes | Yes | Yes | Yes | All |
See also SetBookmarkStyle function in DynaPDF manual.
DynaPDFMBS.SetBorderStyle(Style as Integer) as Boolean
Function:
The function set the global border style which is used for newly created form fields.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 8.0 | Yes | Yes | Yes | Yes | All |
See also SetBorderStyle function in DynaPDF manual.
DynaPDFMBS.SetCharacterSpacing(value as Double) as Boolean
Function:
The function sets the current character spacing. The function requires an open page, template or pattern.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 8.0 | Yes | Yes | Yes | Yes | All |
See also SetCharacterSpacing function in DynaPDF manual.
DynaPDFMBS.SetCheckBoxChar(CheckBoxChar as Integer) as Boolean
Function:
The function sets the character which should be used for newly created check boxes.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 8.0 | Yes | Yes | Yes | Yes | All |
See also SetCheckBoxChar function in DynaPDF manual.
DynaPDFMBS.SetCheckBoxDefState(Field as Integer, Checked as Boolean) as Boolean
Function:
This function changes the default state of a check box; it can differ from the current visible state of the check box.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 8.0 | Yes | Yes | Yes | Yes | All |
See also SetCheckBoxDefState function in DynaPDF manual.
DynaPDFMBS.SetCheckBoxState(Field as Integer, Checked as Boolean) as Boolean
Function:
The function changes the state of a check box. The parameter Field must be a valid check box handle.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 8.0 | Yes | Yes | Yes | Yes | All |
See also SetCheckBoxState function in DynaPDF manual.
DynaPDFMBS.SetCIDFont(CMapHandle as Integer, Name as string, Style as Integer, Size as Double, Embed as boolean) as Integer
Function:
Sets a CID Font.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 10.1 | Yes | Yes | Yes | Yes | All |
See also SetCIDFont function in DynaPDF manual.
DynaPDFMBS.SetCMapDir(path as folderitem, flags as Integer) as Integer
Function:
Sets the character map directory.
Example:
Notes:
Takes an integer instead of a boolean starting with plugin version 11.2pr6.
See klcmDefault, klcmDelayed and klcmRecursive constants.
Requires DynaPDF Pro license.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 11.2 | Yes | Yes | Yes | Yes | All |
Example:
dim pdf as DynaPDFMBS // your dynapdf instance
call pdf.SetCMapDir SpecialFolder.Desktop.Child("CMAP"), 3
Takes an integer instead of a boolean starting with plugin version 11.2pr6.
See klcmDefault, klcmDelayed and klcmRecursive constants.
Requires DynaPDF Pro license.
See also:
See also SetCMapDir function in DynaPDF manual.
DynaPDFMBS.SetCMapDir(path as string, flags as Integer) as Integer
Function:
Sets the character map directory.
Example:
Notes:
Takes an integer instead of a boolean starting with plugin version 11.2pr6.
See klcmDefault, klcmDelayed and klcmRecursive constants.
Requires DynaPDF Pro license.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 11.2 | Yes | Yes | Yes | Yes | All |
Example:
dim pdf as DynaPDFMBS // your dynapdf instance
call pdf.SetCMapDir SpecialFolder.Desktop.Child("CMAP"), pdf.klcmRecursive
Takes an integer instead of a boolean starting with plugin version 11.2pr6.
See klcmDefault, klcmDelayed and klcmRecursive constants.
Requires DynaPDF Pro license.
See also:
See also SetCMapDir function in DynaPDF manual.
DynaPDFMBS.SetColDefFile(EmbFile as Integer) as boolean
Function:
The function sets the initial document of a portable collection that should be opened in the viewer application. See also CreateCollection().
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 8.0 | Yes | Yes | Yes | Yes | All |
See also SetColDefFile function in DynaPDF manual.
DynaPDFMBS.SetColorMask(ImageHandle as Integer, Mask as Ptr, Count as UInt32) as boolean
Function:
The functions sets or overrides the color mask of an image.
Notes: See also SetColorMask function in dynapdf_help.pdf manual.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 13.3 | Yes | Yes | Yes | Yes | All |
Notes: See also SetColorMask function in dynapdf_help.pdf manual.
See also:
See also SetColorMask function in DynaPDF manual.
DynaPDFMBS.SetColorMask(ImageHandle as Integer, Mask() as Integer) as boolean
Function:
The functions sets or overrides the color mask of an image.
Notes:
Same as other SetColorMask function, but values are taken from array.
See also SetColorMask function in dynapdf_help.pdf manual.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 13.3 | Yes | Yes | Yes | Yes | All |
Notes:
Same as other SetColorMask function, but values are taken from array.
See also SetColorMask function in dynapdf_help.pdf manual.
See also:
See also SetColorMask function in DynaPDF manual.
DynaPDFMBS.SetColors(ColorValue as Integer) as Boolean
Function:
The function sets the fill and stroke color.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 8.0 | Yes | Yes | Yes | Yes | All |
See also SetColors function in DynaPDF manual.
DynaPDFMBS.SetColorSpace(ColorSpace as Integer) as Boolean
Function:
The function sets the color space.
Example:
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 8.0 | Yes | Yes | Yes | Yes | All |
Example:
dim pdf as DynaPDFMBS // your DynaPDF object
dim bBool as Boolean
// get the colorspace of the image file
const DP_csDeviceRGB=0
const DP_csDeviceCMYK=1
const DP_csDeviceGray=2
dim iColorSpace as Integer
iColorSpace=DP_csDeviceRGB
// define color space
bBool=pdf.SetColorSpace(iColorSpace)
See also SetColorSpace function in DynaPDF manual.
DynaPDFMBS.SetColSortField(ColField as Integer, AscendingOrder as boolean) as boolean
Function:
The function sets the collection field that should be used to sort the list of embedded files.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 8.0 | Yes | Yes | Yes | Yes | All |
See also SetColSortField function in DynaPDF manual.
The items on this page are in the following plugins: MBS DynaPDF Plugin.
Links
MBS Xojo tutorial videos
