Xojo Developer Conference
25/27th April 2018 in Denver.
MBS Xojo Conference
6/7th September 2018 in Munich, Germany.

Platforms to show: All Mac Windows Linux Cross-Platform

Previous items Next items

DynaPDFMBS.SetTrapped(value as boolean)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 8.0 Yes Yes Yes Yes No
Function: The function sets the trapped key of the document.
Notes: Also check the dynapdf manual on the pdfSetTrapped function.

See also SetTrapped function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.SetUseExactPwd(value as Boolean) as Boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 8.0 Yes Yes Yes Yes No
Function: 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.
Notes: Also check the dynapdf manual on the pdfSetUseExactPwd function.

See also SetUseExactPwd function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.SetUseGlobalImpFiles(value as Boolean) as Boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 8.0 Yes Yes Yes Yes No
Function: 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.
Notes:
Also check the dynapdf manual on the pdfSetUseGlobalImpFiles function.
Requires DynaPDF Pro license.

See also SetUseGlobalImpFiles function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.SetUseImageInterpolation(Index as Integer, Value as Boolean) as Boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 17.5 Yes Yes Yes Yes No
Function: Enables or disables image interpolation explictely for a given image.
Notes:
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.

Feedback, Comments & Corrections

DynaPDFMBS.SetUserUnit(value as single) as boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 11.3 Yes Yes Yes Yes No
Function: The function sets the user unit of the current open page.
Notes:
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.

Feedback, Comments & Corrections

DynaPDFMBS.SetUseStdFonts(value as Boolean) as Boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 8.0 Yes Yes Yes Yes No
Function: The function can be used to disable the 14 standard fonts temporarily.
Notes: Also check the dynapdf manual on the pdfSetUseStdFonts function.

See also SetUseStdFonts function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.SetUseSwapFile(SwapContents as Boolean, SwapLimit as Integer) as Boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 8.0 Yes Yes Yes Yes No
Function: 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
This item is deprecated and should no longer be used.
Notes:
Also check the dynapdf manual on the pdfSetUseSwapFile function.

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

Feedback, Comments & Corrections

DynaPDFMBS.SetUseSwapFileEx(SwapContents as Boolean, SwapLimit as Integer, SwapDir as Folderitem) as Boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 8.0 Yes Yes Yes Yes No
Function: This function enables paging out of large objects to restrict the memory usage in the same way as SetUseSwapFile().
This item is deprecated and should no longer be used.
Notes: Also check the dynapdf manual on the pdfSetUseSwapFileEx function.

Feedback, Comments & Corrections

DynaPDFMBS.SetUseSystemFonts(value as Boolean) as Boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 8.0 Yes Yes Yes Yes No
Function: The property specifies whether the Windows/Fonts directory should be added automatically to the list of available font search paths.
Notes: Also check the dynapdf manual on the pdfSetUseSystemFonts function.

See also SetUseSystemFonts function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.SetUseTransparency(value as Boolean) as Boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 8.0 Yes Yes Yes Yes No
Function: The property specifies whether images should get a transparent background.
Example:
dim pdf as DynaPDFMBS // your DynaPDF object
dim bBool as Boolean

// allow transparency for images
bBool=pdf.SetUseTransparency(False)
Notes: Also check the dynapdf manual on the pdfSetUseTransparency function.

See also SetUseTransparency function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.SetUseVisibleCoords(value as Boolean) as Boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 8.0 Yes Yes Yes Yes No
Function: The property specifies whether DynaPDF should consider the crop box to calculate to position of an object.
Notes: Also check the dynapdf manual on the pdfSetUseVisibleCoords function.

See also SetUseVisibleCoords function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.SetViewerPreferences(Value as Integer, AddVal as Integer) as Boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 8.0 Yes Yes Yes Yes No
Function: The function sets the viewer preferences which can be used to control a few parameter of Adobe's Acrobat, such as hide the toolbar or men bar.
Notes: Also check the dynapdf manual on the pdfSetViewerPreferences function.

See also SetViewerPreferences function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.SetWMFDefExtent(Width as Integer, Height as Integer) as Boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 8.0 Yes Yes Yes Yes No
Function: The function sets the default size which is used to convert non-portable WMF files to EMF. See InsertMetafile() for further information.
Notes: Also check the dynapdf manual on the pdfSetWMFDefExtent function.

See also SetWMFDefExtent function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.SetWMFPixelPerInch(Value as Integer) as Boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 8.0 Yes Yes Yes Yes No
Function: The function sets the default pixels per inch of the y-axis which are used to convert portable WMF files to EMF.
Notes: Also check the dynapdf manual on the pdfSetWMFPixelPerInch function.

See also SetWMFPixelPerInch function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.SetWordSpacing(value as Double) as Boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 8.0 Yes Yes Yes Yes No
Function: The function sets the word spacing.
Notes: Also check the dynapdf manual on the pdfSetWordSpacing function.

See also SetWordSpacing function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.ShowDifferences(PageIndex1 as Integer, OtherPDF as DynaPDFMBS, PageIndex2 as Integer, CheckMoving as boolean, HighlightColor as UInt32 = &hFFFF, ScaleFactor as Integer = 1, ColorTolerance as Integer = 3, debug as boolean = false) as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 15.3 Yes Yes Yes Yes No
Function: Shows differences on two PDF pages by adding highlight annotations.
Notes:
Please pass page indexes for both pages. OtherPDF can be same as the current instance you call this method on.

CheckMoving: Whether to check for moving parts, e.g. the big part of the page shifted up one line.

Returns number of annotations on success which means that highlight annotations have been added to both pages.
Or returns negative value in case of error.
You can than render a page to show differences to user.
Requires a DynaPDF Pro license. Without a license, the DynaPDF watermark will reduce the accuracy.

Scale: When comparison, scales up the pictures used for comparison. Default is 1 for 72dpi, but you can use 2 for double.
ColorTolerance: The tolerance for color comparison.
Colors where red, green or blue components are within given tolerance are considered equal. So FFFFFF and FFFFFD are equal.
Default is 3.

Debug Parameter: Whether to write debug images to temp folder.
If true, we write png files to temp folder. One image is before the check, one with all similar lines removed and one with result of comparison. Red pixels show you the raster, green equal pixels.

Feedback, Comments & Corrections

DynaPDFMBS.SkewCoords(alpha as Double, beta as Double, OriginX as Double, OriginY as Double) as Boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 8.0 Yes Yes Yes Yes No
Function: The function skews the coordinate system and sets the coordinate origin to the point OriginX, OriginY.
Notes:
Also check the dynapdf manual on the pdfSkewCoords function.
Please do not try to scale/skew/translate back later. use SaveGraphicState and RestoreGraphicState.

See also SkewCoords function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.SortFieldsByIndex as Boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 8.0 Yes Yes Yes Yes No
Function: The function sorts the interactive form fields of a page by comparing the internal indices which can be set for each field separately (see SetFieldIndex() for further information).
Notes: Also check the dynapdf manual on the pdfSortFieldsByIndex function.

See also SortFieldsByIndex function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.SortFieldsByName as Boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 8.0 Yes Yes Yes Yes No
Function: The function sorts the interactive form fields of a page in ascending order by field name.
Notes: Also check the dynapdf manual on the pdfSortFieldsByName function.

See also SortFieldsByName function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.SquareAnnot(PosX as Double, PosY as Double, Width as Double, Height as Double, LineWidth as Double, FillColor as UInt32, StrokeColor as UInt32, ColorSpace as Integer, Author as string, Subject as string, Comment as string) as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 13.5 Yes Yes Yes Yes No
Function: The function draws a square annotation on the current open page.
Notes:
If the parameters Width and Height are equal the function draws a square, a rectangle otherwise. If the annotation should bedrawn without a border, set the parameter LineWidth zo zero or StrokeColor to the special constant kNO_COLOR.
If the interior should be transparent set FillColor to the special constant kNO_COLOR.
Although the line width can be set to any positive floating point value, Adobe's Acrobat or Reader restrict the line width to 0 through 12 units. The line width should be restricted in the same way to avoid issues in Adobe viewer products.

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 SquareAnnot function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.SquareAnnotAnsi(PosX as Double, PosY as Double, Width as Double, Height as Double, LineWidth as Double, FillColor as UInt32, StrokeColor as UInt32, ColorSpace as Integer, Author as string, Subject as string, Comment as string) as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 13.5 Yes Yes Yes Yes No
Function: The function draws a square annotation on the current open page.
Notes:
If the parameters Width and Height are equal the function draws a square, a rectangle otherwise. If the annotation should bedrawn without a border, set the parameter LineWidth zo zero or StrokeColor to the special constant kNO_COLOR.
If the interior should be transparent set FillColor to the special constant kNO_COLOR.
Although the line width can be set to any positive floating point value, Adobe's Acrobat or Reader restrict the line width to 0 through 12 units. The line width should be restricted in the same way to avoid issues in Adobe viewer products.

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.

Feedback, Comments & Corrections

DynaPDFMBS.StampAnnot(SubType as Integer, PosX as Double, PosY as Double, Width as Double, Height as Double, Author as string, Subject as string, Comment as string) as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 8.7 Yes Yes Yes Yes No
Function: Creates a stamp annotation.

See also StampAnnot function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.StampAnnotAnsi(SubType as Integer, PosX as Double, PosY as Double, Width as Double, Height as Double, Author as string, Subject as string, Comment as string) as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 8.7 Yes Yes Yes Yes No
Function: Creates a stamp annotation with ANSI encoded texts.

Feedback, Comments & Corrections

DynaPDFMBS.StrokePath as Boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 8.0 Yes Yes Yes Yes No
Function: The function strokes the current path without closing it.
Notes: Also check the dynapdf manual on the pdfStrokePath function.

See also StrokePath function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.TestGlyphs(FontHandle as Integer, Text as string) as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 15.0 Yes Yes Yes Yes No
Function: The function checks whether all glyphs of the text are available in the specified font.
Example:
// create dummy PDF with one page
dim d as new myDynaPDFMBS

call d.CreateNewPDF
call d.Append

// check this text
dim x as string = "您好" // Hello in Chinese

// load 2 fonts to check
dim FontHandle1 as Integer = d.SetFont("Times", 12)
dim FontHandle2 as Integer = d.SetFont("Arial Unicode MS", 12)

dim r1 as Integer = d.TestGlyphs(FontHandle1, x)

if r1 = -1 then
MsgBox "Times supports chinese characters"
else
MsgBox "Times does not support chinese characters"
end if

dim r2 as Integer = d.TestGlyphs(FontHandle2, x)

if r2 = -1 then
MsgBox "Arial Unicode MS supports chinese characters"
else
MsgBox "Arial Unicode MS does not support chinese characters"
end if
Notes:
The return value is the position of the first missing glyph, or -1 if all glyphs are available.
If the font uses a mixed 8/16 bit CJK code page that requires a conversion to Unicode (a code page that ends with "_Uni"), then the return value corresponds to the converted Unicode string and not to the CJK input string.

See also TestGlyphs function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.TestGlyphsAnsi(FontHandle as Integer, Text as string) as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 15.0 Yes Yes Yes Yes No
Function: The function checks whether all glyphs of the text are available in the specified font.
Notes:
The return value is the position of the first missing glyph, or -1 if all glyphs are available.
If the font uses a mixed 8/16 bit CJK code page that requires a conversion to Unicode (a code page that ends with "_Uni"), then the return value corresponds to the converted Unicode string and not to the CJK input string.
The text parameter is converted to ANSI.

Feedback, Comments & Corrections

DynaPDFMBS.TextAnnot(PosX as Double, PosY as Double, Width as Double, Height as Double, Author as string, Text as string, Icon as Integer, Open as boolean) as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 8.0 Yes Yes Yes Yes No
Function: The function creates a text annotation.
Notes:
The text and the author parameters are converted to unicode.
Also check the dynapdf manual on the pdfTextAnnotW function.

See also TextAnnot function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.TextAnnotAnsi(PosX as Double, PosY as Double, Width as Double, Height as Double, Author as string, Text as string, Icon as Integer, Open as boolean) as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 8.3 Yes Yes Yes Yes No
Function: The function creates a text annotation.
Notes:
The text and the author parameters are converted to ANSI.
Also check the dynapdf manual on the pdfTextAnnotA function.

Feedback, Comments & Corrections

DynaPDFMBS.TranslateCoords(OriginX as Double, OriginY as Double) as Boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 8.0 Yes Yes Yes Yes No
Function: The function translates the coordinate system to the new origin OriginX, OriginY.
Notes: Also check the dynapdf manual on the pdfTranslateCoords function.

See also TranslateCoords function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.Triangle(x1 as Double, y1 as Double, x2 as Double, y2 as Double, x3 as Double, y3 as Double, FillMode as Integer) as Boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 8.0 Yes Yes Yes Yes No
Function: The function draws a triangle.
Notes: Also check the dynapdf manual on the pdfTriangle function.

See also Triangle function in DynaPDF manual.

Feedback, Comments & Corrections

Previous items Next items

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




Links
MBS Xojo Chart Plugins