Platforms to show: All Mac Windows Linux Cross-Platform

Back to DynaPDFMBS class.

Previous items Next items

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
This item is deprecated and should no longer be used. You can use SetLineDashPattern2 instead.
The function sets a line dash pattern in the same way as SetLineDashPattern().

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
This item is deprecated and should no longer be used. You can use SetLineDashPattern2 instead.
Sets a line dash pattern with a given array.

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
The function sets the line join style which specifies how two line segments are connected.

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
The function sets the line width used to stroke paths.

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
The function sets the highlight mode that is used by link annotations.

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
The function marks an arbitrary font as list font.

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
The function left multiplies the current transformation matrix with the new one.

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
Sets the maximum number of error log messages kept in memory.

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
The function changes the maximum count of characters which can be entered into a text field.

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
The function sets specific flags to control the conversion of metafiles.

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 sets or replaces the XMP metadata stream of a specific object.

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 sets or replaces the XMP metadata stream of a specific object.

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
Sets the miter limit.

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
Sets the appearance flag.

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
The function restricts the allowed input characters of a text field to numbers and formats the resulting string as specified.

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
Creates or changes the Content Usage dictionary of an OCG.

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
Changes the visibility state of an OCG or layer.

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
The function sets the opacity value which is used to render the appearance of a text annotation.

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
The function sets the orientation of a page.

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
The function changes the orientation of a page, incl. important page properties such as the width and height, and the coordinate system.

Some examples using this method:

See also SetOrientationEx 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
The function sets a predefined page or paper format.


Common paper formats and sizes in points:

FormatSize in units (Width x Height)
DIN A3842.0 x 1191.0
DIN A4595.0 x 842.0
DIN A5419.0 x 595.0
DIN B4709.0 x 1001.0
DIN B5499.0 x 709.0
DIN B6354.0 x 499.0
DIN C3918.0 x 1298.0
DIN C4649.0 x 918.0
DIN C5459.0 x 649.0
DIN C6323.0 x 459.0
DIN C65323.0 x 649.0
DIN DL312.0 x 624.0
DIN E4623.0 x 879.0
DIN E5439.0 x 624.0
DIN E6312.0 x 439.0
DIN E65312.0 x 624.0
DIN M5439.0 x 632.0
DIN M65317.0 x 632.0
US Legal612.0 x 1008.0
US Letter612.0 x 792.0

Some examples using this method:

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
The function changes the height of the currently open page if any, or the default height for newly created pages.
Example
dim pdf as DynaPDFMBS // your DynaPDF object
dim bBool as Boolean
dim dWidth as Double = 800 // new width
dim dHeight as Double = 600 // new heihht

// define page size
bBool=pdf.SetPageWidth(dWidth)
bBool=pdf.SetPageHeight(dHeight)


Common paper formats and sizes in points:

FormatSize in units (Width x Height)
DIN A3842.0 x 1191.0
DIN A4595.0 x 842.0
DIN A5419.0 x 595.0
DIN B4709.0 x 1001.0
DIN B5499.0 x 709.0
DIN B6354.0 x 499.0
DIN C3918.0 x 1298.0
DIN C4649.0 x 918.0
DIN C5459.0 x 649.0
DIN C6323.0 x 459.0
DIN C65323.0 x 649.0
DIN DL312.0 x 624.0
DIN E4623.0 x 879.0
DIN E5439.0 x 624.0
DIN E6312.0 x 439.0
DIN E65312.0 x 624.0
DIN M5439.0 x 632.0
DIN M65317.0 x 632.0
US Legal612.0 x 1008.0
US Letter612.0 x 792.0

Some examples using this method:

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
The function sets the page layout that is used when opening the document with Adobe's Acrobat.
Example
dim pdf as DynaPDFMBS // your DynaPDF object
dim bBool as Boolean

// define page view
'plSinglePage = 0, // Show one page at time
'plOneColumn = 1, // Show the pages continous
'plTwoColumnLeft = 2, // Two columns, start with left column
'plTwoColumnRight = 3 // Two columns, start with right column
bBool=pdf.SetPageLayout(0)

See kpl* constants.
see also SetPageMode and SetViewerPreferences functions.

Some examples using this method:

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
The function sets the page mode that is used when opening the document with Adobe's Acrobat.
Example
dim pdf as DynaPDFMBS // your DynaPDF object
dim bBool as Boolean

// define page mode
'pmUseNone = 0, // Default
'pmUseOutlines = 1, // Show the outline tree
'pmUseThumbs = 2, // Show the thumb nails
'pmFullScreen = 3 // Open the document in full-screen mode
bBool=pdf.SetPageMode(0)

see also SetPageLayout and SetViewerPreferences functions.

Some examples using this method:

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
The function changes the width of the currently open page if any, or the default width for newly created pages.
Example
dim pdf as DynaPDFMBS // your DynaPDF object
dim bBool as Boolean
dim dWidth as Double = 800 // new width
dim dHeight as Double = 600 // new heihht

// define page size
bBool=pdf.SetPageWidth(dWidth)
bBool=pdf.SetPageHeight(dHeight)


Common paper formats and sizes in points:

FormatSize in units (Width x Height)
DIN A3842.0 x 1191.0
DIN A4595.0 x 842.0
DIN A5419.0 x 595.0
DIN B4709.0 x 1001.0
DIN B5499.0 x 709.0
DIN B6354.0 x 499.0
DIN C3918.0 x 1298.0
DIN C4649.0 x 918.0
DIN C5459.0 x 649.0
DIN C6323.0 x 459.0
DIN C65323.0 x 649.0
DIN DL312.0 x 624.0
DIN E4623.0 x 879.0
DIN E5439.0 x 624.0
DIN E6312.0 x 439.0
DIN E65312.0 x 624.0
DIN M5439.0 x 632.0
DIN M65317.0 x 632.0
US Legal612.0 x 1008.0
US Letter612.0 x 792.0

Some examples using this method:

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
The function changes the output PDF file version.
Example
const pvPDF_1_3=3

dim pdf as DynaPDFMBS // your DynaPDF object
dim bBool as Boolean

// ask to create a pdf in version 1.3
bBool=pdf.SetPDFVersion(DynaPDFMBS.kpvPDFA_2005)

Requires DynaPDF Lite license for PDF/A and PDF/X versions.

Some examples using this method:

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
Sets the print settings.

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
Set function sets the rendering intent of an image.

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
The function sets the resolution in DPI (Dots per Inch), in which images are stored by DynaPDF.
Example
dim pdf as DynaPDFMBS // your DynaPDF object
dim bBool as Boolean

// set maximum resolution
bBool = pdf.SetResolution(150)

See also SetResolution function in DynaPDF manual.

Previous items Next items

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


💬 Ask a question or report a problem
The biggest plugin in space...