Platforms to show: All Mac Windows Linux Cross-Platform

Back to DynaPDFMBS class.

Previous items Next items

DynaPDFMBS.SetSaveNewImageFormat(value 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 property SaveNewImageFormat specifies whether images should be downscaled if the original resolution of the image is higher than the value of the property resolution (see also SetResolution()).
Example
dim pdf as DynaPDFMBS // your DynaPDF object
dim bBool as Boolean

// whether you want image to be recompressed
bBool=pdf.SetSaveNewImageFormat(False)

Some examples using this method:

See also SetSaveNewImageFormat function in DynaPDF manual.

DynaPDFMBS.SetSeparationInfo(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 sets the separation info of the current open page.

See also SetSeparationInfo function in DynaPDF manual.

DynaPDFMBS.SetStrokeColor(ColorValue as color) as Boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 14.0 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
The function sets the color used for stroked graphics objects.

Raises an exception if current color space is CMYK or Gray and not RGB.

See also:

See also SetStrokeColor function in DynaPDF manual.

DynaPDFMBS.SetStrokeColor(ColorValue 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 color used for stroked graphics objects.

See also:

See also SetStrokeColor function in DynaPDF manual.

DynaPDFMBS.SetStrokeColor(values() as Double) as boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 11.2 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Sets stroke color based on an array of floats.

The number of components must match.

See also:

See also SetStrokeColor function in DynaPDF manual.

DynaPDFMBS.SetStrokeColor(values() as single) as boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 11.2 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Sets stroke color based on an array of floats.

The number of components must match.

See also:

See also SetStrokeColor function in DynaPDF manual.

DynaPDFMBS.SetStrokeColorEx(colorvalues as memoryblock, count as Integer) as Boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 9.1 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Sets the stroke color using the values in parameters.
Example
dim p as DynaPDFMBS // get a pdf object

dim colorvalues as memoryblock

colorvalues=NewMemoryBlock(3)
colorvalues.Byte(0)=255
colorvalues.Byte(1)=128
colorvalues.Byte(2)=0

if p.SetStrokeColorEx(colorvalues, 3) then
' ok
else
' failed
end if

Pass as many color values as needed for the current color space. 3 for RGB, 4 for CMYK. All values must be in the range of 0 to 255.

See also:

See also SetStrokeColorEx function in DynaPDF manual.

DynaPDFMBS.SetStrokeColorEx(ParamArray colorvalue as Integer) as Boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 9.1 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Sets the stroke color using the values in parameters.
Example
dim p as DynaPDFMBS // get a pdf object

if p.SetStrokeColorEx(255,128,0) then
' ok
else
' failed
end if

Pass as many color values as needed for the current color space. 3 for RGB, 4 for CMYK. All values must be in the range of 0 to 255.

See also:

See also SetStrokeColorEx function in DynaPDF manual.

DynaPDFMBS.SetStrokeColorSpace(Colorspace 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 stroke color space. In PDF, fill and stroke colors use both their own color spaces.

See also SetStrokeColorSpace function in DynaPDF manual.

DynaPDFMBS.SetTabLen(TabLen 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 tabulator length, specified in number of spaces, which will be used to emulate tabulators during text formatting (see WriteFText() for further information).

See also SetTabLen function in DynaPDF manual.

DynaPDFMBS.SetTemplBBox(TemplateHandle as Integer, PageBoundary as Integer, BBoxRect as DynaPDFRectMBS) as Boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 22.3 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Sets or changes a bounding box of a template.

Templates support the bounding boxes kpbMediaBox and kpbCropBox only. The latter one is considered by PlaceTemplateEx() only.

A crop box can be set to clip the contents of a template without changing its bounding box. This can be useful when placing imported pages on another page.
If BBox is set to nil, the bounding box is deleted. Note that only the crop box can be deleted.

Returns true on success or false in case of an error.

See also:

See also SetTemplBBox function in DynaPDF manual.

DynaPDFMBS.SetTemplBBox(TemplateHandle as Integer, PageBoundary as Integer, Left as Double, Top as Double, Right as Double, Bottom as Double) as Boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 22.3 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Sets or changes a bounding box of a template.

Templates support the bounding boxes kpbMediaBox and kpbCropBox only. The latter one is considered by PlaceTemplateEx() only.

A crop box can be set to clip the contents of a template without changing its bounding box. This can be useful when placing imported pages on another page.
If BBox is set to nil, the bounding box is deleted. Note that only the crop box can be deleted.

Returns true on success or false in case of an error.

See also:

See also SetTemplBBox function in DynaPDF manual.

DynaPDFMBS.SetTextDrawMode(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 text draw mode specifies how text should be rendered.

See also SetTextDrawMode function in DynaPDF manual.

DynaPDFMBS.SetTextFieldValue(Field as Integer, Value as string, DefValue as string, Align 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 or changes the value and default value of a text field.

The Value and the DefValue strings are converted to unicode.

Some examples using this method:

See also SetTextFieldValue function in DynaPDF manual.

DynaPDFMBS.SetTextFieldValueAnsi(Field as Integer, Value as string, DefValue as string, Align as Integer) as Boolean   Deprecated

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 the non ANSI function instead.
The function sets or changes the value and default value of a text field.

The Value and the DefValue strings are converted to ANSI.

See also SetTextFieldValue function in DynaPDF manual.

DynaPDFMBS.SetTextFieldValueAnsiEx(Field as Integer, Value as string) as Boolean   Deprecated

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 9.3 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
This item is deprecated and should no longer be used. You can use the non ANSI function instead.
Sets the text field value.

DynaPDFMBS.SetTextFieldValueEx(Field as Integer, Value as string) 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 text field value.

See also SetTextFieldValueEx function in DynaPDF manual.

DynaPDFMBS.SetTextRise(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
Text rise specifies the distance, to move the baseline up or down from its default location.

See also SetTextRise function in DynaPDF manual.

DynaPDFMBS.SetTextScaling(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 scaling value adjusts the width of glyphs by stretching or compressing them in the horizontal direction.

Some examples using this method:

See also SetTextScaling function in DynaPDF manual.

DynaPDFMBS.SetTransparentColor(ColorValue 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 transparent color which is used for newly inserted images.
Example
dim pdf as DynaPDFMBS

call pdf.SetTransparentColor pdf.kNO_COLOR

See also SetTransparentColor function in DynaPDF manual.

DynaPDFMBS.SetTrapped(value 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 trapped key of the document.

See also SetTrapped function in DynaPDF manual.

DynaPDFMBS.SetUseExactPwd(value 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
If the property UseExactPwd is false, an encrypted PDF file can always be decrypted, if either the open or owner password in the file is an empty string.

See also SetUseExactPwd function in DynaPDF manual.

DynaPDFMBS.SetUseGlobalImpFiles(value 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 property can be used to load an external PDF file permanent into memory, e.g. to split a large PDF file into smaller pieces.

Requires DynaPDF Pro license.

Some examples using this method:

See also SetUseGlobalImpFiles function in DynaPDF manual.

DynaPDFMBS.SetUseImageInterpolation(Index as Integer, Value as Boolean) as Boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 17.5 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Enables or disables image interpolation explictely for a given image.

If nothing was specified (this is the default), a viewer applications can only use a heuristic to determine whether image interpolation should be enabled or not. The result is then of course application specific.
The parameter Handle must be a valid image handle that was returned by a DynaPDF function like InsertImage(), InsertImageEx(), or InsertImageFromBuffer(), for example.

If the function succeeds the return value is true. If the function fails the return value is false.

See also SetUseImageInterpolation function in DynaPDF manual.

DynaPDFMBS.SetUserUnit(value as single) as boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 11.3 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
The function sets the user unit of the current open page.

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. 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. Note that all functions which return page coordinates or page properties do not consider the user unit.
The page format must still be in the range 3..14400 units. It is also strongly recommended to set the user unit only if necessary. This is only the case if the required page format is larger 14400 units.
Default value = 1.0

Return values:
If the function succeeds the return value is true. If the function fails the return value is false.

See also SetUserUnit function in DynaPDF manual.

DynaPDFMBS.SetUseStdFonts(value 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 can be used to disable the 14 standard fonts temporarily.

See also SetUseStdFonts function in DynaPDF manual.

DynaPDFMBS.SetUseSwapFile(SwapContents as Boolean, SwapLimit 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.
When creating large PDF files with many or large images it is sometimes recommended to page out large objects to a temp file to restrict the memory usage.
Example
dim pdf as DynaPDFMBS // your DynaPDF object

// define a swap file in case memory is low
dim b as Boolean=pdf.SetUseSwapFile(False, 256*1024*1024)
if b=False then
MsgBox "Failed to create swap file."
Return
end if


Do not use FlushPages and SetUseSwapFile together. Use one function.

See also SetUseSwapFile function in DynaPDF manual.

DynaPDFMBS.SetUseSwapFileEx(SwapContents as Boolean, SwapLimit as Integer, SwapDir as FolderItem) 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.
This function enables paging out of large objects to restrict the memory usage in the same way as SetUseSwapFile().

See also SetUseSwapFileEx function in DynaPDF manual.

DynaPDFMBS.SetUseSystemFonts(value 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 property specifies whether the Windows/Fonts directory should be added automatically to the list of available font search paths.

See also SetUseSystemFonts 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...