Platforms to show: All Mac Windows Linux Cross-Platform
Back to DynaPDFMBS class.
DynaPDFMBS.SetLineDashPatternEx(dash as memoryblock, NumValues as Integer, Phase as Integer) as Boolean Deprecated
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | DynaPDF | MBS DynaPDF Plugin | 8.0 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
dash is a memoryblock with doubles.
So dash.size=NumValues*8.
See also:
See also SetLineDashPatternEx function in DynaPDF manual.
DynaPDFMBS.SetLineDashPatternEx(dash() as double, Phase as integer) as Boolean Deprecated
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | DynaPDF | MBS DynaPDF Plugin | 17.2 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
However, this version accepts an array of doubles instead of a string value.
Returns true on success.
See SetLineDashPattern for more details.
If array is nil, the pattern is removed.
See also:
See also SetLineDashPatternEx function in DynaPDF manual.
DynaPDFMBS.SetLineJoinStyle(Style 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 SetLineJoinStyle function in DynaPDF manual.
DynaPDFMBS.SetLineWidth(value 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 |
See also SetLineWidth function in DynaPDF manual.
DynaPDFMBS.SetLinkHighlightMode(Mode 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 |
Some examples using this method:
See also SetLinkHighlightMode function in DynaPDF manual.
DynaPDFMBS.SetListFont(Handle 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 |
Some examples using this method:
See also SetListFont function in DynaPDF manual.
DynaPDFMBS.SetMatrix(Matrix as DynaPDFMatrixMBS) 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 SetMatrix function in DynaPDF manual.
DynaPDFMBS.SetMaxErrLogMsgCount(value as Integer)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | DynaPDF | MBS DynaPDF Plugin | 11.1 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
See also SetMaxErrLogMsgCount function in DynaPDF manual.
DynaPDFMBS.SetMaxFieldLen(TxtField as Integer, MaxLen 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 |
A value of zero determines that the string length should not be restricted.
See also SetMaxFieldLen function in DynaPDF manual.
DynaPDFMBS.SetMetaConvFlags(Flags 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 SetMetaConvFlags function in DynaPDF manual.
DynaPDFMBS.SetMetadata(ObjType as Integer, Handle as Integer, Buffer as Memoryblock) as Boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | DynaPDF | MBS DynaPDF Plugin | 15.1 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
The function deletes the XMP stream if empty buffer will be provided.
If the global XMP stream of the Catalog object should be replaced then proceed as follows:
- Set the wished output PDF version with SetPDFVersion.
- Get a preview of the XMP stream with GetMetadata.
- Modify the returned stream as needed and save it with SetMetadata, finished!
The above steps make sure that the XMP metadata and document info contain the same values. This is especially important for PDF standards like PDF/A or PDF/X. DynaPDF makes sure that the creation and modification date will not be changed when closing the file.
Returns true on success and false on failure.
See also:
See also SetMetadata function in DynaPDF manual.
DynaPDFMBS.SetMetadata(ObjType as Integer, Handle as Integer, Buffer as String) as Boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | DynaPDF | MBS DynaPDF Plugin | 15.1 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
The function deletes the XMP stream if empty buffer will be provided.
If the global XMP stream of the Catalog object should be replaced then proceed as follows:
- Set the wished output PDF version with SetPDFVersion.
- Get a preview of the XMP stream with GetMetadata.
- Modify the returned stream as needed and save it with SetMetadata, finished!
The above steps make sure that the XMP metadata and document info contain the same values. This is especially important for PDF standards like PDF/A or PDF/X. DynaPDF makes sure that the creation and modification date will not be changed when closing the file.
Returns true on success and false on failure.
See also:
See also SetMetadata function in DynaPDF manual.
DynaPDFMBS.SetMiterLimit(value 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 |
See also SetMiterLimit function in DynaPDF manual.
DynaPDFMBS.SetNeedAppearance(value as boolean) as boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | DynaPDF | MBS DynaPDF Plugin | 9.3 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
See also SetNeedAppearance function in DynaPDF manual.
DynaPDFMBS.SetNumberFormat(TxtField as Integer, Sep as Integer, DecPlaces as Integer, NegStyle as Integer, CurrStr as string, Prepend as boolean) 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 SetNumberFormat function in DynaPDF manual.
DynaPDFMBS.SetOCGContUsage(Handle as UInt32, Value as DynaPDFOCGContUsageMBS) as Boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | DynaPDF | MBS DynaPDF Plugin | 15.0 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
See dynapdf_help.pdf manual for details.
If the function succeeds the return value is true. If the function fails the return value is false.
See also SetOCGContUsage function in DynaPDF manual.
DynaPDFMBS.SetOCGState(Handle as UInt32, On as Boolean, SaveState as Boolean) as Boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | DynaPDF | MBS DynaPDF Plugin | 15.0 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
If the parameter SaveState is true, the new state is also saved in the PDF file. Otherwise, the state is only changed temporarily so that the whished state can be rendered with RenderPage or RenderPageToImage for example.
Note that only the new state of the current OCG will be be saved. If the state of other OCGs were changed beforehand, while SaveState was set to false, then these changes will not be considered.
If the function succeeds the return value is true. If the function fails the return value is false.
Some examples using this method:
See also SetOCGState function in DynaPDF manual.
DynaPDFMBS.SetOpacity(value 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 |
See also SetOpacity function in DynaPDF manual.
DynaPDFMBS.SetOrientation(Value 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 |
Some examples using this method:
See also SetOrientation function in DynaPDF manual.
DynaPDFMBS.SetOrientationEx(Value 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 |
Some examples using this method:
- /ChartDirector/Place PDF Chart with DynaPDF
- /DynaPDF/Create PDF UA
- /DynaPDF/Create PDF with DPart Metadata
- /DynaPDF/Create PDF with rotated text
- /DynaPDF/place centered/place centered and rotate
- /DynaPDF/Rotate rotated PDF back
See also SetOrientationEx function in DynaPDF manual.
DynaPDFMBS.SetPageCoords(PageCoords 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 |
Value can be kpcTopDown or kpcBottomUp. Default is kpcBottomUp.
Some examples using this method:
- /DynaPDF/Create PDF with Annotations
- /DynaPDF/Create PDF with Colors
- /DynaPDF/Create PDF with object2d
- /DynaPDF/Create PDF with Round Rectangles
- /DynaPDF/DynaPDF transparent images/DynaPDF transparent images console
- /DynaPDF/Letter/Letter with writeftext
- /DynaPDF/place centered/place centered and rotate
- /DynaPDF/separation color
- /DynaPDF/Tables/Dynamic Table/DynaPDF Table Multi Page
- /DynaPDF/ZUGFeRD 2.0/Create PDF with invoice
See also SetPageCoords function in DynaPDF manual.
DynaPDFMBS.SetPageFormat(Value 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 |
Common paper formats and sizes in points:
Format | Size in units (Width x Height) |
DIN A3 | 842.0 x 1191.0 |
DIN A4 | 595.0 x 842.0 |
DIN A5 | 419.0 x 595.0 |
DIN B4 | 709.0 x 1001.0 |
DIN B5 | 499.0 x 709.0 |
DIN B6 | 354.0 x 499.0 |
DIN C3 | 918.0 x 1298.0 |
DIN C4 | 649.0 x 918.0 |
DIN C5 | 459.0 x 649.0 |
DIN C6 | 323.0 x 459.0 |
DIN C65 | 323.0 x 649.0 |
DIN DL | 312.0 x 624.0 |
DIN E4 | 623.0 x 879.0 |
DIN E5 | 439.0 x 624.0 |
DIN E6 | 312.0 x 439.0 |
DIN E65 | 312.0 x 624.0 |
DIN M5 | 439.0 x 632.0 |
DIN M65 | 317.0 x 632.0 |
US Legal | 612.0 x 1008.0 |
US Letter | 612.0 x 792.0 |
Some examples using this method:
- /DynaPDF/Create PDF with Bookmarks
- /DynaPDF/Create PDF with Picture file
- /DynaPDF/Create PDF with Picture files
- /DynaPDF/JBig Test
- /DynaPDF/Tables/Table Templates
See also SetPageFormat function in DynaPDF manual.
DynaPDFMBS.SetPageHeight(value 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 |
Common paper formats and sizes in points:
Format | Size in units (Width x Height) |
DIN A3 | 842.0 x 1191.0 |
DIN A4 | 595.0 x 842.0 |
DIN A5 | 419.0 x 595.0 |
DIN B4 | 709.0 x 1001.0 |
DIN B5 | 499.0 x 709.0 |
DIN B6 | 354.0 x 499.0 |
DIN C3 | 918.0 x 1298.0 |
DIN C4 | 649.0 x 918.0 |
DIN C5 | 459.0 x 649.0 |
DIN C6 | 323.0 x 459.0 |
DIN C65 | 323.0 x 649.0 |
DIN DL | 312.0 x 624.0 |
DIN E4 | 623.0 x 879.0 |
DIN E5 | 439.0 x 624.0 |
DIN E6 | 312.0 x 439.0 |
DIN E65 | 312.0 x 624.0 |
DIN M5 | 439.0 x 632.0 |
DIN M65 | 317.0 x 632.0 |
US Legal | 612.0 x 1008.0 |
US Letter | 612.0 x 792.0 |
Some examples using this method:
- /DynaPDF/Create PDF with Bookmarks
- /DynaPDF/DynaPDF Graphics/Reporting/List Of Products Preview
- /DynaPDF/DynaPDF Merge 2 to 1
- /DynaPDF/DynaPDF Transparency Color Test
- /DynaPDF/Image to PDF/Image to pdf
- /DynaPDF/Image to PDF/Multi Tiff to PDF
- /DynaPDF/place centered/Clip
- /DynaPDF/Rotate rotated PDF back
- /DynaPDF/StyledText Editor
- /MacCocoa/NSStatusItem/StatusItem with PDF Icon
See also SetPageHeight function in DynaPDF manual.
DynaPDFMBS.SetPageLayout(Layout 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 kpl* constants.
see also SetPageMode and SetViewerPreferences functions.
Some examples using this method:
- /DynaPDF/Create PDF with Bookmarks
- /DynaPDF/DynaPDF Transparency Color Test
- /DynaPDF/Image to PDF/Image to pdf
- /DynaPDF/Image to PDF/Multi Tiff to PDF
See also SetPageLayout function in DynaPDF manual.
DynaPDFMBS.SetPageMode(Mode 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 SetPageLayout and SetViewerPreferences functions.
Some examples using this method:
- /DynaPDF/DynaPDF Transparency Color Test
- /DynaPDF/Image to PDF/Image to pdf
- /DynaPDF/Image to PDF/Multi Tiff to PDF
See also SetPageMode function in DynaPDF manual.
DynaPDFMBS.SetPageWidth(value 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 |
Common paper formats and sizes in points:
Format | Size in units (Width x Height) |
DIN A3 | 842.0 x 1191.0 |
DIN A4 | 595.0 x 842.0 |
DIN A5 | 419.0 x 595.0 |
DIN B4 | 709.0 x 1001.0 |
DIN B5 | 499.0 x 709.0 |
DIN B6 | 354.0 x 499.0 |
DIN C3 | 918.0 x 1298.0 |
DIN C4 | 649.0 x 918.0 |
DIN C5 | 459.0 x 649.0 |
DIN C6 | 323.0 x 459.0 |
DIN C65 | 323.0 x 649.0 |
DIN DL | 312.0 x 624.0 |
DIN E4 | 623.0 x 879.0 |
DIN E5 | 439.0 x 624.0 |
DIN E6 | 312.0 x 439.0 |
DIN E65 | 312.0 x 624.0 |
DIN M5 | 439.0 x 632.0 |
DIN M65 | 317.0 x 632.0 |
US Legal | 612.0 x 1008.0 |
US Letter | 612.0 x 792.0 |
Some examples using this method:
- /DynaPDF/Create PDF with Bookmarks
- /DynaPDF/DynaPDF Graphics/Reporting/List Of Products Preview
- /DynaPDF/DynaPDF Merge 2 to 1
- /DynaPDF/DynaPDF Transparency Color Test
- /DynaPDF/Image to PDF/Image to pdf
- /DynaPDF/Image to PDF/Multi Tiff to PDF
- /DynaPDF/place centered/Clip
- /DynaPDF/Rotate rotated PDF back
- /DynaPDF/StyledText Editor
- /MacCocoa/NSStatusItem/StatusItem with PDF Icon
See also SetPageWidth function in DynaPDF manual.
DynaPDFMBS.SetPDFVersion(Version 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 |
Requires DynaPDF Lite license for PDF/A and PDF/X versions.
Some examples using this method:
- /DynaPDF/Create PDF and modify XMP
- /DynaPDF/Create PDF UA
- /DynaPDF/Create PDF with DPart Metadata
- /DynaPDF/Create PDFX
- /DynaPDF/DynaPDF Transparency Color Test
- /DynaPDF/Image to PDF/Image to pdf
- /DynaPDF/Image to PDF/Multi Tiff to PDF
- /DynaPDF/PDF-A/Combine PDF files to PDFA
- /DynaPDF/PDF-A/Create PDFA
See also SetPDFVersion function in DynaPDF manual.
DynaPDFMBS.SetPrintSettings(Mode as Integer, PickTrayByPDFSize as Integer, NumCopies as Integer, PrintScaling as Integer, PrintRanges() as Integer) as boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | DynaPDF | MBS DynaPDF Plugin | 8.7 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
This is a PDF 1.7 extension.
For the Mode use the kdpm* constants.
For the PrintScaling use the kps* constants.
See also SetPrintSettings function in DynaPDF manual.
DynaPDFMBS.SetRenderingIntent(ImgHandle as Integer, RenderingIntent as Integer) as Boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | DynaPDF | MBS DynaPDF Plugin | 22.4 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
The rendering intent describes how colors should be interpreted.
The parameter ImgHandle must be a valid image handle that was returned by InsertImage or InsertImageFile. Imported images returned in ParseContent, for example, can be changed too.
If the function succeeds the return value is true. If the function fails the return value is false.
See also SetRenderingIntent function in DynaPDF manual.
DynaPDFMBS.SetResolution(Value 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 SetResolution function in DynaPDF manual.
The items on this page are in the following plugins: MBS DynaPDF Plugin.