Platforms to show: All Mac Windows Linux Cross-Platform

Back to DynaPDFMBS class.

Previous items Next items

DynaPDFMBS.SetUseTransparency(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 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)

Some examples using this method:

See also SetUseTransparency function in DynaPDF manual.

DynaPDFMBS.SetUseVisibleCoords(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 DynaPDF should consider the crop box to calculate to position of an object.

Some examples using this method:

See also SetUseVisibleCoords function in DynaPDF manual.

DynaPDFMBS.SetViewerPreferences(Value as Integer, 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
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 menu bar.
Example

call pdf.SetViewerPreferences pdf.kvpDisplayDocTitle,pdf.kavNone

See kvp* constants and *kav constants.
See also SetPageLayout and SetPageMode functions.

Some examples using this method:

See also SetViewerPreferences function in DynaPDF manual.

DynaPDFMBS.SetWhite(FillColor as Boolean, StrokeColor as Boolean) as Boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 19.2 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Sets white color.

This function is a bit optimized to check the current color space.
Depending on whether it's RGB, Gray, CMYK or Lab, it will set different color values.
And if other color space is active, it switches to Gray colorspace to set white.

DynaPDFMBS.SetWMFDefExtent(Width as Integer, 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
The function sets the default size which is used to convert non-portable WMF files to EMF. See InsertMetafile() for further information.

See also SetWMFDefExtent function in DynaPDF manual.

DynaPDFMBS.SetWMFPixelPerInch(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 default pixels per inch of the y-axis which are used to convert portable WMF files to EMF.

See also SetWMFPixelPerInch function in DynaPDF manual.

DynaPDFMBS.SetWordSpacing(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 word spacing.

See also SetWordSpacing function in DynaPDF manual.

DynaPDFMBS.SetXFAStream(Index as UInt32, Buffer as String) as Boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 19.5 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
The function replaces the contents of an XFA stream with new contents.

Index must be a valid XFA resource index. XFA streams can be enumerated with GetXFAStream() / GetXFAStreamCount().
The function does not check whether the provided XFA buffer is valid. The buffer is written to the stream as is.

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

See also SetXFAStream function in DynaPDF manual.

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 iOS Targets
method DynaPDF MBS DynaPDF Plugin 15.3 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Shows differences on two PDF pages by adding highlight annotations.

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.

Some examples using this method:

DynaPDFMBS.SkewCoords(alpha as Double, beta as Double, OriginX as Double, OriginY 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 skews the coordinate system and sets the coordinate origin to the point OriginX, OriginY.

Please do not try to scale/skew/translate back later. use SaveGraphicState and RestoreGraphicState.

See also SkewCoords function in DynaPDF manual.

DynaPDFMBS.SortFieldsByIndex 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 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).

See also SortFieldsByIndex function in DynaPDF manual.

DynaPDFMBS.SortFieldsByName 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 sorts the interactive form fields of a page in ascending order by field name.

See also SortFieldsByName function in DynaPDF manual.

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 iOS Targets
method DynaPDF MBS DynaPDF Plugin 13.5 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
The function draws a square annotation on the current open page.

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.

Some examples using this method:

See also SquareAnnot function in DynaPDF manual.

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   Deprecated

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 13.5 ✅ 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 draws a square annotation on the current open page.

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.

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 iOS Targets
method DynaPDF MBS DynaPDF Plugin 8.7 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Creates a stamp annotation.

Some examples using this method:

See also StampAnnot function in DynaPDF manual.

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   Deprecated

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 8.7 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
This item is deprecated and should no longer be used. You can use the non ANSI function instead.
Creates a stamp annotation with ANSI encoded texts.

See also StampAnnot function in DynaPDF manual.

DynaPDFMBS.StrokePath 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 strokes the current path without closing it.

See also StrokePath function in DynaPDF manual.

DynaPDFMBS.TestGlyphs(FontHandle as Integer, Text as string) as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 15.0 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
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

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.

Some examples using this method:

See also TestGlyphs function in DynaPDF manual.

DynaPDFMBS.TestGlyphsAnsi(FontHandle as Integer, Text as string) as Integer   Deprecated

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 15.0 ✅ 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 checks whether all glyphs of the text are available in the specified font.

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.

See also TestGlyphs function in DynaPDF manual.

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 iOS Targets
method DynaPDF MBS DynaPDF Plugin 8.0 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
The function creates a text annotation.

The text and the author parameters are converted to unicode.

Some examples using this method:

See also TextAnnot function in DynaPDF manual.

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   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 creates a text annotation.

The text and the author parameters are converted to ANSI.

See also TextAnnot function in DynaPDF manual.

DynaPDFMBS.TranslateCoords(OriginX as Double, OriginY 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 translates the coordinate system to the new origin OriginX, OriginY.

Some examples using this method:

See also TranslateCoords function in DynaPDF manual.

DynaPDFMBS.UnLockLayer(layer as UInt32) as boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 12.4 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Locks a layer.

See also UnLockLayer function in DynaPDF manual.

DynaPDFMBS.WatermarkAnnot(PosX as Double, PosY as Double, Width as Double, Height as Double) as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 17.0 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Creates a Watermark annotation.
Example
// create watermark annotation
Dim AnnotHandle As Integer = pdf.WatermarkAnnot(100, 100, 300, 200)

// it's empty initially

// so we create an annotation appearance stream
Dim x As Integer = pdf.CreateAnnotAP(AnnotHandle)

// set a color and draw rectangle
Call pdf.SetFillColor(&cFF7777)
Call pdf.Rectangle 0, 0, 300, 200, pdf.kfmFill

Call pdf.SetStrokeColor(&c000000)
Call pdf.SetFillColor(&c000000)
Call pdf.SetFont("Helvetica", pdf.kfsBold, 30)
Call pdf.WriteText(20, 20, "Hello World")

// close template
Call pdf.EndTemplate

Watermark annotations have no interactive elements like other annotation types. This property is useful in many cases because it is usually not possible to select or change the contents of a watermark annotation in viewer applications.
The annotation has no appearance after it was created. Call CreateAnnotAP to create an appearance template for the annotation. After the appearance template was created you can draw text, images or vector graphics into it. The template must be closed with EndTemplate when finished. It is also possible to import an external page or EMF contents into the template.
Watermark annotations can be shared on multiple pages. To place the annotation on other pages call AddAnnotToPage.

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

DynaPDFMBS.WebLink(PosX as Double, PosY as Double, Width as Double, Height as Double, aText as string) as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 8.0 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
The function inserts a web link onto the current open page.

The text parameter is converted to unicode.

Some examples using this method:

See also WebLink function in DynaPDF manual.

DynaPDFMBS.WebLinkAnsi(PosX as Double, PosY as Double, Width as Double, Height as Double, aText as string) as Integer   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 inserts a web link onto the current open page.

The text parameter is converted to ANSI.

See also WebLink function in DynaPDF manual.

DynaPDFMBS.WriteAngleText(aText as string, Angle as Double, PosX as Double, PosY as Double, Radius as Double, YOrigin 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 prints a string in a user defined angle around a radius.

The text parameter is converted to unicode.

See also:

Some examples using this method:

See also WriteAngleText function in DynaPDF manual.

DynaPDFMBS.WriteAngleText(glyphs() as Integer, Angle as Double, PosX as Double, PosY as Double, Radius as Double, YOrigin as Double) as Boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 10.4 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
The function prints a string in a user defined angle around a radius.

This version takes an array of integers. So if you are using the kcpUnicode on SetFont, please pass an array of unicode codepoints. If you use kcpGlyphIndexes, please pass an array of glyph values.

See also:

See also WriteAngleText function in DynaPDF manual.

DynaPDFMBS.WriteAngleTextAnsi(aText as string, Angle as Double, PosX as Double, PosY as Double, Radius as Double, YOrigin as Double) 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 prints a string in a user defined angle around a radius.

The text parameter is converted to ANSI, so use only with SetFont with kcp1252.

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