Platforms to show: All Mac Windows Linux Cross-Platform
Back to DynaPDFMBS class.
DynaPDFMBS.GetTextHeightExAnsi(Width as Double, Align as Integer, aText as string) as Double Deprecated
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | DynaPDF | MBS DynaPDF Plugin | 13.3 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
GetTextHeightExAnsi does escape backslashes so no formatting commands are taken from the string.
The text parameter is converted to ANSI.
DynaPDFMBS.GetTextRect(byref PosX as Double, byref PosY as Double, byref Width as Double, byref Height as Double) as Boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | DynaPDF | MBS DynaPDF Plugin | 8.0 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
Some examples using this method:
See also GetTextRect function in DynaPDF manual.
DynaPDFMBS.GetTextRise as Double
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | DynaPDF | MBS DynaPDF Plugin | 8.0 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
See also GetTextRise function in DynaPDF manual.
DynaPDFMBS.GetTextScaling as Double
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | DynaPDF | MBS DynaPDF Plugin | 8.0 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
See also GetTextScaling function in DynaPDF manual.
DynaPDFMBS.GetTextWidth(aText as string) as Double
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | DynaPDF | MBS DynaPDF Plugin | 8.0 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
The text parameter is converted to unicode.
See also:
Some examples using this method:
- /Barcode/generate/Create PDF with Barcodes
- /DynaPDF/Create PDF with Angle Rectangles
- /DynaPDF/Create PDF with Bookmarks
- /DynaPDF/Create PDF with Circle Text
- /DynaPDF/Create PDF with demo string
- /DynaPDF/Create PDF with Layers
- /DynaPDF/DynaPDF Database Invoice Example
- /DynaPDF/Font Test
- /DynaPDF/Million pages test/DynaPDF Database Invoice Example with 1000000 pages
- /DynaPDF/Table with Listbox auto width
See also GetTextWidth function in DynaPDF manual.
DynaPDFMBS.GetTextWidthAnsi(aText as string) as Double Deprecated
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | DynaPDF | MBS DynaPDF Plugin | 8.3 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
The text parameter is converted to ANSI.
See also GetTextWidth function in DynaPDF manual.
DynaPDFMBS.GetTransparentColor as Integer
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | DynaPDF | MBS DynaPDF Plugin | 8.0 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
See also GetTransparentColor function in DynaPDF manual.
DynaPDFMBS.GetTrapped as Boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | DynaPDF | MBS DynaPDF Plugin | 8.0 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
See also GetTrapped function in DynaPDF manual.
DynaPDFMBS.GetTypoLeading as double
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | DynaPDF | MBS DynaPDF Plugin | 21.0 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
This is sTypoAscender – sTypoDescender + sTypoLineGap of the OS/2 table of TrueType and OpenType fonts. The value is scaled to the current font size. Type1 fonts do not support these metrics.
The function can be called after a font was activated in the graphics state, e.g. with SetFont(), SetFontEx(), SetCIDFont(), or ChangeFont().
If typographic metrics are not available the return value is Ascent – Descent. If the value is smaller than the font size then the font size is returned.
If the function succeeds the return value is the typographic leading of the active font, this is a value greater zero. If the function fails the return value is a negative error code.
Some examples using this method:
See also GetTypoLeading function in DynaPDF manual.
DynaPDFMBS.GetURIAction(index as Integer) as DynaPDFURIActionMBS
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | DynaPDF | MBS DynaPDF Plugin | 17.0 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
Index is from 0 to GetActionCount-1.
See also GetURIAction function in DynaPDF manual.
DynaPDFMBS.GetUseExactPwd as Boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | DynaPDF | MBS DynaPDF Plugin | 8.0 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
See also GetUseExactPwd function in DynaPDF manual.
DynaPDFMBS.GetUseGlobalImpFiles as Boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | DynaPDF | MBS DynaPDF Plugin | 8.0 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
See also GetUseGlobalImpFiles function in DynaPDF manual.
DynaPDFMBS.GetUserRights as Integer
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | DynaPDF | MBS DynaPDF Plugin | 8.0 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
See also GetUserRights function in DynaPDF manual.
DynaPDFMBS.GetUserUnit as single
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | DynaPDF | MBS DynaPDF Plugin | 11.3 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
A user unit acts like a scaling factor. The page format and all page coordinates are multiplied with this factor in a viewer application. The default size of a PDF unit is 1/72 inch and the default user unit is 1.0. User units can be useful if the page format would be too large to be expressed in standard PDF units. The largest page format in PDF is limited to 14400 units or 200 inches. This limit can be extended with the user unit.
The largest value that is supported is 75.0 which results in a maximum page format of 15,000 x 15,000 inches or 1,800,000 units.
See also GetUserUnit function in DynaPDF manual.
DynaPDFMBS.GetUseStdFonts as Boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | DynaPDF | MBS DynaPDF Plugin | 8.0 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
See also GetUseStdFonts function in DynaPDF manual.
DynaPDFMBS.GetUsesTransparency(Page as Integer = -1) as Boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | DynaPDF | MBS DynaPDF Plugin | 18.2 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
This is no quick check as GetDocUsesTransparency() applies. The function parses the page or pages to determine whether transparent objects are relly used.
To check whether a specific page uses transparency set the parameter PageNum to the wished page number. The first page is denoted by 1. To check the entire PDF file set PageNum to -1.
The return value is a bit mask on success (a positive integer value), or a negative error code on failure.
The following flags are defined:
- 0: The page or document uses no transparency.
- 1: The content stream of a page contains transparent objects.
- 2: A page defines the blending color space (Group dictionary).
- 4: A page contains transparent annotations or form fields.
The above values can occur in any combination. To check whether a specific flag was set use a binary and operator: BitwiseAnd(value, flag)
See also GetUsesTransparency function in DynaPDF manual.
DynaPDFMBS.GetUseSystemFonts as Boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | DynaPDF | MBS DynaPDF Plugin | 8.0 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
See also GetUseSystemFonts function in DynaPDF manual.
DynaPDFMBS.GetUseTransparency as Boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | DynaPDF | MBS DynaPDF Plugin | 8.0 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
See also GetUseTransparency function in DynaPDF manual.
DynaPDFMBS.GetUseVisibleCoords as Boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | DynaPDF | MBS DynaPDF Plugin | 8.0 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
See also GetUseVisibleCoords function in DynaPDF manual.
DynaPDFMBS.GetViewerPreferences(byref Preference as Integer, byref AddVal as Integer) as Boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | DynaPDF | MBS DynaPDF Plugin | 8.0 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
See also GetViewerPreferences function in DynaPDF manual.
DynaPDFMBS.GetViewport(Page as UInt32, index as Integer) as DynaPDFViewportMBS
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | DynaPDF | MBS DynaPDF Plugin | 15.0 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
A viewport is a rectangular region of a page, that specifies usually a measure coordinate system or points in a geospatical coordinate system.
Since viewports might overlap, to determine the viewport to use for any point on a page, the viewports in the array shall be examined, starting with the last one and iterating in reverse, and the first one whose BBox entry contains the point shall be chosen.
To determine how viewports and measure dictionaries can be used, please have a look into the PDF Reference 2.0, ISO/DIS 32000-2, Section Measurement properties.
Returns nil on any error.
See also GetViewport function in DynaPDF manual.
DynaPDFMBS.GetViewportCount(Page as UInt32) as Integer
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | DynaPDF | MBS DynaPDF Plugin | 15.0 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
The first page has the page number 1.
If the function succeeds the return value is the number of viewports, a number greater or equal zero. If the function fails the return value is a negative error code. The function can only fail if the page number is invalid.
See also GetViewportCount function in DynaPDF manual.
DynaPDFMBS.GetWMFDefExtent(byref width as Integer, byref height as Integer) as Boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | DynaPDF | MBS DynaPDF Plugin | 8.0 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
See also GetWMFDefExtent function in DynaPDF manual.
DynaPDFMBS.GetWMFPixelPerInch as Integer
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | DynaPDF | MBS DynaPDF Plugin | 8.0 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
See also GetWMFPixelPerInch function in DynaPDF manual.
DynaPDFMBS.GetWordSpacing as Double
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | DynaPDF | MBS DynaPDF Plugin | 8.0 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
See also GetWordSpacing function in DynaPDF manual.
DynaPDFMBS.GetXFAStream(Handle as UInt32) as DynaPDFXFAStreamMBS
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | DynaPDF | MBS DynaPDF Plugin | 16.5 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
The parameter Index is the array index. The function GetXFAStreamCount() returns the number of available streams.
An XFA form consist of several XML streams. The stream name must be used to determine which stream was returned.
If the function succeeds the return value is 1. If the function fails the return value is 0.
See also GetXFAStream function in DynaPDF manual.
DynaPDFMBS.GetXFAStreamCount as Integer
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | DynaPDF | MBS DynaPDF Plugin | 16.5 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
XFA streams are available after a PDF file was imported.
If the function succeeds the return value is the number of available XFA streams. If the function fails the return value is a negative error code.
See also GetXFAStreamCount function in DynaPDF manual.
DynaPDFMBS.HaveDPartRoot as Boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | DynaPDF | MBS DynaPDF Plugin | 23.3 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
DPart stands for Document Parts. DParts are a feature of PDF/VT, a PDF format for the printing
industry.
The function should be used to determine whether a DPart structure is already in memory, before calling CreateDPartRoot() since the function would fail if this is the case.
An existing DPart structure can be extended with additional DPart nodes, but it is not yet possible to edit existing nodes.
If the document contains a DPartRoot dictionary, the return value is true or false otherwise.
See also HaveDPartRoot function in DynaPDF manual.
DynaPDFMBS.HaveOpenDoc as Boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | DynaPDF | MBS DynaPDF Plugin | 8.0 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
Some examples using this method:
- /DynaPDF/Create PDF with Signature on Windows
- /DynaPDF/Hello World
- /DynaPDF/metafiles/metafiles
- /DynaPDF/signed pdfa/signed pdfa
- /DynaPDF/Table with Listbox auto width
- /DynaPDF/Tables/Table Images
- /DynaPDF/Tables/Table Text
- /DynaPDF/Tables/Table with Listbox
- /DynaPDF/text formatting/text formatting parallel
- /DynaPDF/text formatting/text formatting Unicode
See also HaveOpenDoc function in DynaPDF manual.
DynaPDFMBS.HaveOpenPage as Boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | DynaPDF | MBS DynaPDF Plugin | 11.1 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
See also HaveOpenPage function in DynaPDF manual.
DynaPDFMBS.HighlightAnnot(SubType as Integer, PosX as Double, PosY as Double, Width as Double, Height as Double, ColorValue as Integer, Author as string, Subject as string, Comment as string) as Integer
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | DynaPDF | MBS DynaPDF Plugin | 8.7 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
Some examples using this method:
See also HighlightAnnot function in DynaPDF manual.
DynaPDFMBS.HighlightAnnotAnsi(SubType as Integer, PosX as Double, PosY as Double, Width as Double, Height as Double, ColorValue as Integer, Author as string, Subject as string, Comment as string) as Integer Deprecated
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | DynaPDF | MBS DynaPDF Plugin | 8.7 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
See also HighlightAnnot function in DynaPDF manual.
DynaPDFMBS.HighlightOnAllPages(SearchText as string, ColorValue as Color, CaseInsenitive as boolean = false) as Integer
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | DynaPDF | MBS DynaPDF Plugin | 14.0 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
If CaseInsenitive is true, the case of letters is ignored (also umlauts and accents)
Searches on all pages in the document.
Returns number of times the text was found.
Some examples using this method:
DynaPDFMBS.HighlightOnCurrentPage(SearchText as string, ColorValue as Color, CaseInsenitive as boolean = false) as Integer
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | DynaPDF | MBS DynaPDF Plugin | 14.0 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
If CaseInsenitive is true, the case of letters is ignored (also umlauts and accents)
Use EditPage function to open the page before you search on it.
Returns number of times the text was found.
Some examples using this method:
DynaPDFMBS.ImportBookmarks as Integer
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | DynaPDF | MBS DynaPDF Plugin | 8.0 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
See also ImportBookmarks function in DynaPDF manual.
DynaPDFMBS.ImportCatalogObjects as Boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | DynaPDF | MBS DynaPDF Plugin | 8.0 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
See also ImportCatalogObjects function in DynaPDF manual.
DynaPDFMBS.ImportDocInfo as Boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | DynaPDF | MBS DynaPDF Plugin | 8.0 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
See also ImportDocInfo function in DynaPDF manual.
DynaPDFMBS.ImportEncryptionSettings as Boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | DynaPDF | MBS DynaPDF Plugin | 17.0 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
If the PDF file is not encrypted, the function does nothing. To determine whether the open PDF file is encrypted call GetInIsEncrypted().
The encryption settings should be imported to make sure that the PDF file can be saved with the same settings after it was edited. The user rights should be considered if the file was opened with the open password, also if the password was just an empty string. See GetUserRights() for further information.
If the file was opened with the owner password, then all editing rights should be grated. The PDF file must be closed with CloseFile() or CloseAndSignFile() for example. Don't use
CloseFileEx() for example since this function would override the encryption settings.
If the file should be saved unencrypted call ResetEncryptionSettings() before closing the file. Return values:
If the function succeeds the return value is true. If the function fails the return value is false.
See also ImportEncryptionSettings function in DynaPDF manual.
DynaPDFMBS.ImportOCProperties as Boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | DynaPDF | MBS DynaPDF Plugin | 17.5 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
OC properties are normally automatically imported by functions like ImportPDFFile() or when importing a page that contains layers. However, a viewer application must be able to access the OC properties right after the PDF file was opened so that the layer configuration and the layer tree can be loaded (see LoadLayerConfig() and GetOCUINode() for further information).
The function can be called multiple times without causing unwanted side effects.
If the function succeeds the return value is true. If the function fails the return value is false.
See also ImportOCProperties function in DynaPDF manual.
DynaPDFMBS.ImportPage(PageNum as Integer) as Integer
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | DynaPDF | MBS DynaPDF Plugin | 8.0 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
Requires DynaPDF Pro license.
Some examples using this method:
- /DynaPDF/Create numbered pages
- /DynaPDF/DynaPDF Database Invoice Example
- /DynaPDF/DynaPDF Merge 2 to 1
- /DynaPDF/Letter/Letter with writeftext
- /DynaPDF/Million pages test/Import page 1000000
- /DynaPDF/PDF Color Analyze per Page
- /DynaPDF/place centered/place centered
- /DynaPDF/place centered/place centered and rotate
- /DynaPDF/Rotate rotated PDF back
- /DynaPDF/Tables/Dynamic Table/DynaPDF Table Multi Page
See also ImportPage function in DynaPDF manual.
DynaPDFMBS.ImportPageEx(PageNum as Integer, ScaleX as Double = 1.0, ScaleY as Double = 1.0) as Integer
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | DynaPDF | MBS DynaPDF Plugin | 8.0 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
Requires DynaPDF Pro license.
Some examples using this method:
- /DynaPDF/Letter/Letter with AddContinueText and two pages template
- /DynaPDF/Letter/Letter with writeftext and two pages template
- /DynaPDF/List fonts in PDF
- /DynaPDF/Parse PDF Content
- /DynaPDF/Raster/RenderPageToImage variants
- /DynaPDF/Raster/Search and show PDF files
- /DynaPDF/Show Differences
- /DynaPDF/Split PDF
- /DynaPDF/Split PDF in memory
- /DynaPDF/Web Edition/WebPicture from PDF Page Web
See also ImportPageEx function in DynaPDF manual.
DynaPDFMBS.ImportPDFFile(DestPage as Integer, ScaleX as Double = 1.0, ScaleY as Double = 1.0) as Integer
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | DynaPDF | MBS DynaPDF Plugin | 8.0 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
Scaling factor is ignored if importing as pages (not templates).
This function returns the page number of the last page imported. It does not return how many pages are imported. If you need number of imported pages, please use returned value minus DestPage.
Some examples using this method:
- /DynaPDF/DynaPDF Graphics/Create numbered pages
- /DynaPDF/Font Infos
- /DynaPDF/List Images
- /DynaPDF/OptimizePDF tool
- /DynaPDF/Parse PDF Content
- /DynaPDF/PDF-A/Combine PDF files to PDFA
- /DynaPDF/PDFPreview Window
- /DynaPDF/Show ColorSpaces
- /DynaPDF/text editing/edit text
- /DynaPDF/Watermark PDF
See also ImportPDFFile function in DynaPDF manual.
DynaPDFMBS.ImportPDFPage(PageNum as Integer, ScaleX as Double = 1.0, ScaleY as Double = 1.0) as Integer
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | DynaPDF | MBS DynaPDF Plugin | 15.1 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
If a page is open, this function calls EndPage.
Than it appends a new page, calls ImportPageEx and Endpage.
On success the return value is zero. If the function fails the return value is a negative error code.
Some examples using this method:
- /DynaPDF/Create Previews for folder
- /DynaPDF/DynaPDF Graphics/ListBoxReport
- /DynaPDF/DynaPDF Graphics/Reporting/List Of Orders with Background
- /DynaPDF/DynaPDF Merge 2 to 1
- /DynaPDF/Extract image objects
- /DynaPDF/Extract images
- /DynaPDF/Interlace PDFs
- /DynaPDF/JBig Test
- /DynaPDF/Merge PDF documents with page numbers
- /DynaPDF/Split PDF
See also ImportPDFPage function in DynaPDF manual.
DynaPDFMBS.InitColorManagement(profiles as DynaPDFColorProfilesMBS, DestSpace as Integer, Flags as Integer) as boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | DynaPDF | MBS DynaPDF Plugin | 11.3 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
Pass nil for profiles to disable color management.
DestSpace can be kcsDeviceRGB, kcsDeviceCMYK or kcsDeviceGray.
Flags can be kicmDefault or kicmBPCompensation for:
Black point compensation preserves the black point when converting CMYK colors to different color spaces.
Some examples using this method:
- /DynaPDF/DynaPDF PDF Viewer
- /DynaPDF/PDF Viewer Example
- /DynaPDF/Raster/RenderPageToImage with color management
- /DynaPDF/Raster/RenderPDFFile Test with Color Management
- /DynaPDF/Web Edition/WebPDF Web
See also InitColorManagement function in DynaPDF manual.
DynaPDFMBS.InitColorManagementEx(profiles as DynaPDFColorProfilesExMBS, DestSpace as Integer, Flags as Integer) as boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | DynaPDF | MBS DynaPDF Plugin | 16.0 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
The function enables color management in the functions RenderPage(), RenderPageEx(), RenderPageToImage(), and RenderPDFFile() exactly like InitColorManagement() but accepts ICC profile buffers instead of file paths. See InitColorManagement() for further information.
To disable color management set the parameter Profiles to nil.
Initializing the color management requires a considerable amount of processing time. It is strongly recommended to use one PDF instance as long as possible so that it must not be initialized again when another PDF file will be rendered.
The color management can be initialized right after the PDF instance was created.
Returns true on succes or false on failure.
See also InitColorManagementEx function in DynaPDF manual.
DynaPDFMBS.InitStack(byref stack as DynaPDFStackMBS) as boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | DynaPDF | MBS DynaPDF Plugin | 7.7 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
If stack is nil, a new one will be created and stored in the variable.
Return values:
If the function succeeds the return value is true. If the function fails the return value is false.
Some examples using this method:
- /DynaPDF/Extract text
- /DynaPDF/text editing/delete text
- /DynaPDF/text editing/replace text
- /DynaPDF/Text extraction
See also InitStack function in DynaPDF manual.
DynaPDFMBS.InkAnnot(points() as DynaPDFPointMBS, LineWidth as Double, ColorValue as UInt32, ColorSpace as Integer, Author as string, Subject as string, Content as string) as Integer
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | DynaPDF | MBS DynaPDF Plugin | 15.3 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
An ink annotation (PDF 1.3) represents a freehand "scribble" composed of one or more disjoint paths. The parameter Points represents a stroked path. More paths can be added with AddInkList.
The points are interpreted in currect user space. Any transformation that was applied on the coordinate system will be taken into account.
The points are connected with bezier curves to achieve a smooth transition between points. If the points should be connected with straight lines, then create a PolyLine annotation instead (see PolyLineAnnot).
This annotation type has an associated PopUp annotation that displays the string Content in a floating window. The initial window state of the associated PopUp annotation is closed by default but the state can be changed with SetAnnotOpenState() if necessary.
If the function succeeds the return value is the annotation handle, a value greater or equal zero. If the function fails the return value is a negative error code.
Some examples using this method:
See also InkAnnot function in DynaPDF manual.
DynaPDFMBS.InkAnnotAnsi(points() as DynaPDFPointMBS, LineWidth as Double, ColorValue as UInt32, ColorSpace as Integer, Author as string, Subject as string, Content as string) as Integer Deprecated
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | DynaPDF | MBS DynaPDF Plugin | 15.3 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
An ink annotation (PDF 1.3) represents a freehand "scribble" composed of one or more disjoint paths. The parameter Points represents a stroked path. More paths can be added with AddInkList.
The points are interpreted in currect user space. Any transformation that was applied on the coordinate system will be taken into account.
The points are connected with bezier curves to achieve a smooth transition between points. If the points should be connected with straight lines, then create a PolyLine annotation instead (see PolyLineAnnot).
This annotation type has an associated PopUp annotation that displays the string Content in a floating window. The initial window state of the associated PopUp annotation is closed by default but the state can be changed with SetAnnotOpenState() if necessary.
If the function succeeds the return value is the annotation handle, a value greater or equal zero. If the function fails the return value is a negative error code.
See also InkAnnot function in DynaPDF manual.
DynaPDFMBS.InsertBarcode(PosX as double, PosY as double, Width as double, Height as double, HAlign as Integer, VAlign as Integer, Barcode as DynaPDFBarcode2MBS) as Integer
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | DynaPDF | MBS DynaPDF Plugin | 20.5 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
See the kbct* constants for the types supported.
Options are very similar to what we have in our BarcodeGeneratorMBS class as both use the same zint library.
Some examples using this method:
See also InsertBarcode function in DynaPDF manual.
DynaPDFMBS.InsertBMPFromBuffer(PosX as Double, PosY as Double, ScaleWidth as Double, ScaleHeight as Double, Buffer as memoryblock) as Integer Deprecated
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | DynaPDF | MBS DynaPDF Plugin | 13.0 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
See also:
- InsertBMPFromBuffer(PosX as Double, PosY as Double, ScaleWidth as Double, ScaleHeight as Double, Buffer as string) as Integer
- InsertBMPFromBuffer(PosX as Double, PosY as Double, ScaleWidth as Double, ScaleHeight as Double, BufferAddress as Integer) as Integer
See also InsertBMPFromBuffer function in DynaPDF manual.
The items on this page are in the following plugins: MBS DynaPDF Plugin.