Platforms to show: All Mac Windows Linux Cross-Platform
DynaPDFMBS.ReplaceImage(ImageToReplace as DynaPDFImageMBS, ImageFile as FolderItem, Index as Integer = 1, ColorSpace as Integer = 0, CSHandle as Integer = -1, Flags as Integer = 0) as Boolean
Function:
Replaces an image with another image.
Notes:
The parameter ImageToReplace must be a valid pointer of an image object which is retrieved by functions like GetImageObj() or ParseContent().
The resolution, aspect ratio, color space and so on can be freely chosen. However, note that this function does not change the output position or size. If the aspect ratio of the new image is different, then it will be stretched or shrinked to fit into the output rectangle.
The parameter ColorSpace specifies the destination color space into which the image should be converted or saved, if the image is already defined in that color space. CSHandle must be the handle of that color space if a non-device space is used. The will be ignored for devices spaces.
The function works in the very same way as InsertImageEx() with the following differences:
• The color of an image mask cannot be set or changed because this would require changes on the content stream in which the image is used. An image mask will be created if the image color depth is 1 bit and if color key masking is enabled (see SetUseTransparency()). SetUseTransparency() should normally be set to false before calling this function.
• The image will never be downscaled, independent of the current resolution, because the size of the output rectangle is not known.
If the image that should be replaced is a soft mask of another base image, then make sure that the destination color space is set to kesDeviceGray, kesCalGray, or to a one channel ICC based color space because a soft mask must not contain more than one color channel.
The flags kgfUseImageColorSpace, kgfIgnoreICCProfiles, kgfRealPassThrough, and kfNoBitmapAlpha are all supported. See SetGStateFlags() for further information.
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 | 17.5 | Yes | Yes | Yes | Yes | All |
Notes:
The parameter ImageToReplace must be a valid pointer of an image object which is retrieved by functions like GetImageObj() or ParseContent().
The resolution, aspect ratio, color space and so on can be freely chosen. However, note that this function does not change the output position or size. If the aspect ratio of the new image is different, then it will be stretched or shrinked to fit into the output rectangle.
The parameter ColorSpace specifies the destination color space into which the image should be converted or saved, if the image is already defined in that color space. CSHandle must be the handle of that color space if a non-device space is used. The will be ignored for devices spaces.
The function works in the very same way as InsertImageEx() with the following differences:
• The color of an image mask cannot be set or changed because this would require changes on the content stream in which the image is used. An image mask will be created if the image color depth is 1 bit and if color key masking is enabled (see SetUseTransparency()). SetUseTransparency() should normally be set to false before calling this function.
• The image will never be downscaled, independent of the current resolution, because the size of the output rectangle is not known.
If the image that should be replaced is a soft mask of another base image, then make sure that the destination color space is set to kesDeviceGray, kesCalGray, or to a one channel ICC based color space because a soft mask must not contain more than one color channel.
The flags kgfUseImageColorSpace, kgfIgnoreICCProfiles, kgfRealPassThrough, and kfNoBitmapAlpha are all supported. See SetGStateFlags() for further information.
If the function succeeds the return value is true. If the function fails the return value is false.
See also ReplaceImage function in DynaPDF manual.
DynaPDFMBS.ReplaceImageEx(ImageToReplace as DynaPDFImageMBS, ImageData as MemoryBlock, Index as Integer = 1, ColorSpace as Integer = 0, CSHandle as Integer = -1, Flags as Integer = 0) as Boolean
Function:
Replaces an image with a new image exactly like ReplaceImage() but accepts a file buffer as input.
Notes:
See ReplaceImage() for further information.
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 | 17.5 | Yes | Yes | Yes | Yes | All |
Notes:
See ReplaceImage() for further information.
If the function succeeds the return value is 1. If the function fails the return value is 0.
See also:
See also ReplaceImageEx function in DynaPDF manual.
DynaPDFMBS.ReplaceImageEx(ImageToReplace as DynaPDFImageMBS, ImageData as String, Index as Integer = 1, ColorSpace as Integer = 0, CSHandle as Integer = -1, Flags as Integer = 0) as Boolean
Function:
Replaces an image with a new image exactly like ReplaceImage() but accepts a file buffer as input.
Notes:
See ReplaceImage() for further information.
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 | 17.5 | Yes | Yes | Yes | Yes | All |
Notes:
See ReplaceImage() for further information.
If the function succeeds the return value is 1. If the function fails the return value is 0.
See also:
See also ReplaceImageEx function in DynaPDF manual.
DynaPDFMBS.ReplacePageText(text as string, stack as DynaPDFStackMBS) as boolean
Function:
The function deletes or replaces a text string of a content stream that was found by the function GetPageText() beforehand.
Notes:
Be aware that ReplacePageText can't always replace text as encoding must match and fonts may not have the characters for the new text. For that better use ReplacePageTextEx.
If you have problems with asian characters, please make sure you use SetCMapDir and load the CMAPs.
Requires DynaPDF Pro license.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 7.7 | Yes | Yes | Yes | Yes | All |
Notes:
Be aware that ReplacePageText can't always replace text as encoding must match and fonts may not have the characters for the new text. For that better use ReplacePageTextEx.
If you have problems with asian characters, please make sure you use SetCMapDir and load the CMAPs.
Requires DynaPDF Pro license.
See also ReplacePageText function in DynaPDF manual.
DynaPDFMBS.ReplacePageTextEx(text as string, stack as DynaPDFStackMBS) as boolean
Function:
The function deletes or replaces a text string of a content stream that was found by the function GetPageText() beforehand.
Notes:
The text parameter is converted to unicode.
If you have problems with asian characters, please make sure you use SetCMapDir and load the CMAPs.
Requires DynaPDF Pro license.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 7.7 | Yes | Yes | Yes | Yes | All |
Notes:
The text parameter is converted to unicode.
If you have problems with asian characters, please make sure you use SetCMapDir and load the CMAPs.
Requires DynaPDF Pro license.
See also ReplacePageTextEx function in DynaPDF manual.
DynaPDFMBS.ReplacePageTextExAnsi(text as string, stack as DynaPDFStackMBS) as boolean
Function:
The function deletes or replaces a text string of a content stream that was found by the function GetPageText() beforehand.
The text parameter is converted to ANSI.
Requires DynaPDF Pro license.
| 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 text parameter is converted to ANSI.
Requires DynaPDF Pro license.
See also ReplacePageTextEx function in DynaPDF manual.
DynaPDFMBS.ResetAnnotAP(Handle as integer = -1) as Boolean
Function:
Forces a rebuild of the appearance stream of the specified annotation.
Notes: If Handle is set to -1 all annotation appearances will be rebuild. This function be useful if an imported annotation has an invalid or empty appearance stream.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 20.3 | Yes | Yes | Yes | Yes | All |
Notes: If Handle is set to -1 all annotation appearances will be rebuild. This function be useful if an imported annotation has an invalid or empty appearance stream.
See also ResetAnnotAP function in DynaPDF manual.
DynaPDFMBS.ResetEncryptionSettings as Boolean
Function:
Resets the encryption settings which were imported from an external PDF file so that the PDF file in memory can be saved unencrypted.
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 | 17.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 ResetEncryptionSettings function in DynaPDF manual.
DynaPDFMBS.ResetLineDashPattern as Boolean
Function:
The function resets a previously defined line dash pattern to its default value (straight line).
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 8.0 | Yes | Yes | Yes | Yes | All |
See also ResetLineDashPattern function in DynaPDF manual.
DynaPDFMBS.RestoreGraphicState as Boolean
Function:
The function restores a previously saved graphics state.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 8.0 | Yes | Yes | Yes | Yes | All |
See also RestoreGraphicState function in DynaPDF manual.
DynaPDFMBS.RotateCoords(alpha as Double, OriginX as Double, OriginY as Double) as Boolean
Function:
The function rotates the coordinate system at the point OriginX, OriginY by applying a transformation matrix.
Notes: Please do not try to scale/skew/translate back later. use SaveGraphicState and RestoreGraphicState.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 8.0 | Yes | Yes | Yes | Yes | All |
Notes: Please do not try to scale/skew/translate back later. use SaveGraphicState and RestoreGraphicState.
See also RotateCoords function in DynaPDF manual.
DynaPDFMBS.RotateTemplate(OldTemplate as Integer, Rotation as Integer, RotateCoords as boolean = true) as Integer
Function:
Rotates a template.
Notes:
Returns a new template handle.
This is a convenience function which creates a new template and draws the existing template there with rotation.
Returns negative number for errors. The plugin uses -1 for plugin errors like wrong rotation angle.
RotateCoords: Whether to rotate coordinate system.
This is now done by DynaPDF automatically, so for current version of the library, this must be false. But older versions need the true.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 17.0 | Yes | Yes | Yes | Yes | All |
Notes:
Returns a new template handle.
This is a convenience function which creates a new template and draws the existing template there with rotation.
Returns negative number for errors. The plugin uses -1 for plugin errors like wrong rotation angle.
RotateCoords: Whether to rotate coordinate system.
This is now done by DynaPDF automatically, so for current version of the library, this must be false. But older versions need the true.
DynaPDFMBS.RoundRect(PosX as Double, PosY as Double, Width as Double, Height as Double, Radius as Double, FillMode as Integer) as Boolean
Function:
The function draws a rectangle with rounded corners.
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 new DynaPDFMBS
dim f as FolderItem = SpecialFolder.Desktop.Child("Create PDF with Round Rectangles.pdf")
pdf.SetLicenseKey "Starter" // For this example you can use a Starter, Lite, Pro or Enterprise License
call pdf.CreateNewPDF f
call pdf.Append
dim PosX as Double = 100.0
dim PosY as Double = 100.0
dim Width as Double = 100.0
dim Height as Double = 100.0
dim Radius as Double = 20.0
dim FillMode as Integer = pdf.kfmFill
call pdf.RoundRect(PosX, PosY, Width, Height, Radius, FillMode)
PosX = 300.0
dim RadiusX as Double = 30.0
dim RadiusY as Double = 30.0
call pdf.RoundRectEx(PosX, PosY, Width, Height, RadiusX, RadiusY, FillMode)
call pdf.EndPage
call pdf.CloseFile
f.Launch
See also RoundRect function in DynaPDF manual.
DynaPDFMBS.RoundRectEx(PosX as Double, PosY as Double, Width as Double, Height as Double, rWidth as Double, rHeight as Double, FillMode as Integer) as Boolean
Function:
The function draws a rectangle with elliptical corners.
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 new DynaPDFMBS
dim f as FolderItem = SpecialFolder.Desktop.Child("Create PDF with Round Rectangles.pdf")
pdf.SetLicenseKey "Starter" // For this example you can use a Starter, Lite, Pro or Enterprise License
call pdf.CreateNewPDF f
call pdf.Append
dim PosX as Double = 100.0
dim PosY as Double = 100.0
dim Width as Double = 100.0
dim Height as Double = 100.0
dim Radius as Double = 20.0
dim FillMode as Integer = pdf.kfmFill
call pdf.RoundRect(PosX, PosY, Width, Height, Radius, FillMode)
PosX = 300.0
dim RadiusX as Double = 30.0
dim RadiusY as Double = 30.0
call pdf.RoundRectEx(PosX, PosY, Width, Height, RadiusX, RadiusY, FillMode)
call pdf.EndPage
call pdf.CloseFile
f.Launch
See also RoundRectEx function in DynaPDF manual.
DynaPDFMBS.SaveGraphicState as Boolean
Function:
The function saves the current graphics state.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 8.0 | Yes | Yes | Yes | Yes | All |
See also SaveGraphicState function in DynaPDF manual.
DynaPDFMBS.ScaleCoords(sx as Double, sy as Double) as Boolean
Function:
The function scales the coordinate system by applying a transformation matrix.
Notes: Please do not try to scale/skew/translate back later. use SaveGraphicState and RestoreGraphicState.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 8.0 | Yes | Yes | Yes | Yes | All |
Notes: Please do not try to scale/skew/translate back later. use SaveGraphicState and RestoreGraphicState.
See also ScaleCoords function in DynaPDF manual.
DynaPDFMBS.SelfTest as Boolean
Function:
The function checks the size of all required data types and checks whether the endian configuration of the library is correct.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 8.0 | Yes | Yes | Yes | Yes | All |
See also SelfTest function in DynaPDF manual.
DynaPDFMBS.Set3DAnnotProps(Annot as Integer, ActType as Integer, DeActType as Integer, InstType as Integer, DeInstType as Integer, DisplayToolbar as boolean, DisplayModelTree as boolean) as boolean
Function:
Sets the properties of a 3D Annotation.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 9.8 | Yes | Yes | Yes | Yes | All |
See also Set3DAnnotProps function in DynaPDF manual.
DynaPDFMBS.Set3DAnnotScriptAnsi(Annot as Integer, Value as string) as boolean
Function:
Sets the 3D Annoation Script.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 9.8 | Yes | Yes | Yes | Yes | All |
This item is deprecated and should no longer be used.
You can use Non ANSI function. instead.
See also Set3DAnnotScript function in DynaPDF manual.
DynaPDFMBS.SetAllocBy(Value as Integer) as Integer
Function:
The function sets the size of the memory blocks in kilo bytes, which will be allocated if memory must be allocated for page content streams.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 8.0 | Yes | Yes | Yes | Yes | All |
See also SetAllocBy function in DynaPDF manual.
DynaPDFMBS.SetAnnotBorderEffect(Handle as Integer, BorderEffect as Integer) as Boolean
Function:
Sets the border effect for an annotation.
Notes:
Returns true on success.
Handle is in range of 0 to number of annotations - 1.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 15.2 | Yes | Yes | Yes | Yes | All |
Notes:
Returns true on success.
Handle is in range of 0 to number of annotations - 1.
See also SetAnnotBorderEffect function in DynaPDF manual.
DynaPDFMBS.SetAnnotBorderStyle(Handle as Integer, BorderStyle as Integer) as boolean
Function:
Sets the annotation border style.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 10.4 | Yes | Yes | Yes | Yes | All |
See also SetAnnotBorderStyle function in DynaPDF manual.
DynaPDFMBS.SetAnnotBorderWidth(Handle as Integer, LineWidth as Double) as boolean
Function:
Sets the annotation border width.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 10.4 | Yes | Yes | Yes | Yes | All |
See also SetAnnotBorderWidth function in DynaPDF manual.
DynaPDFMBS.SetAnnotColor(Handle as Integer, ColorType as Integer, PDFColorSpace as Integer, ColorValue as Integer) as boolean
Function:
Sets the annotation color.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 10.4 | Yes | Yes | Yes | Yes | All |
See also SetAnnotColor function in DynaPDF manual.
DynaPDFMBS.SetAnnotFlags(Flags as Integer) as Boolean
Function:
The function sets the default flags used for newly created annotations.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 8.0 | Yes | Yes | Yes | Yes | All |
See also SetAnnotFlags function in DynaPDF manual.
DynaPDFMBS.SetAnnotFlagsEx(Handle as Integer, Flags as Integer) as boolean
Function:
Sets the annotation flags.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 10.4 | Yes | Yes | Yes | Yes | All |
See also SetAnnotFlagsEx function in DynaPDF manual.
DynaPDFMBS.SetAnnotHighlightMode(Handle as Integer, HighlightMode as Integer) as boolean
Function:
Sets the annotation highlight mode.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 10.4 | Yes | Yes | Yes | Yes | All |
See also SetAnnotHighlightMode function in DynaPDF manual.
DynaPDFMBS.SetAnnotIcon(Handle as Integer, AnnotIcon as Integer) as boolean
Function:
Sets the annotation icon.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 10.4 | Yes | Yes | Yes | Yes | All |
See also SetAnnotIcon function in DynaPDF manual.
DynaPDFMBS.SetAnnotLineDashPattern(Handle as UInt32, dash as memoryblock, NumValues as integer) as Boolean
Function:
Sets or deletes the line dash pattern of an annotation.
Notes:
The following annotation types support line dash patterns:
Memoryblock must contain floating point values (Single).
Returns true on success.
If array is nil, the pattern is removed.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 17.2 | Yes | Yes | Yes | Yes | All |
Notes:
The following annotation types support line dash patterns:
- atCircle
- atInk
- atLine
- atPolygon
- atPolyLine
- atSquare
Memoryblock must contain floating point values (Single).
Returns true on success.
If array is nil, the pattern is removed.
See also:
See also SetAnnotLineDashPattern function in DynaPDF manual.
DynaPDFMBS.SetAnnotLineDashPattern(Handle as UInt32, dash() as single) as Boolean
Function:
Sets or deletes the line dash pattern of an annotation.
Notes:
The following annotation types support line dash patterns:
Returns true on success.
If array is nil, the pattern is removed.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 17.2 | Yes | Yes | Yes | Yes | All |
Notes:
The following annotation types support line dash patterns:
- atCircle
- atInk
- atLine
- atPolygon
- atPolyLine
- atSquare
Returns true on success.
If array is nil, the pattern is removed.
See also:
See also SetAnnotLineDashPattern function in DynaPDF manual.
The items on this page are in the following plugins: MBS DynaPDF Plugin.
Links
MBS Xojo Plugins
