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

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:

• SetTemplBBox(TemplateHandle as Integer, PageBoundary as Integer, BBoxRect as DynaPDFRectMBS) as Boolean

See also SetTemplBBox function in DynaPDF manual.

DynaPDFMBS.SetTextDrawMode(Mode as Integer) as Boolean

See also SetTextDrawMode function in DynaPDF manual.

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

The Value and the DefValue strings are converted to unicode.

Some examples using this method:

• /DynaPDF/acroform/Fill value
• /DynaPDF/Create PDF with sum form field
• /DynaPDF/PDF Form with HTTP POST

See also SetTextFieldValue function in DynaPDF manual.

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

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

DynaPDFMBS.SetTextFieldValueEx(Field as Integer, Value as string) as Boolean

See also SetTextFieldValueEx function in DynaPDF manual.

DynaPDFMBS.SetTextRect(PosX as Double, PosY as Double, Width as Double, Height as Double) as Boolean

Some examples using this method:

• /DynaPDF/Create PDF UA
• /DynaPDF/Create PDF with Image FileLink
• /DynaPDF/Create PDF with text block2
• /DynaPDF/Create PDF with text styles
• /DynaPDF/Create PDF with vertical text
• /DynaPDF/Letter/Letter with writeftext and two pages template
• /DynaPDF/StyledText Editor
• /DynaPDF/text formatting/text formatting parallel
• /DynaPDF/Web Edition/Cards Web
• /DynaPDF/Web Edition/Web RTF to PDF Web

See also SetTextRect function in DynaPDF manual.

DynaPDFMBS.SetTextRise(value as Double) as Boolean

See also SetTextRise function in DynaPDF manual.

DynaPDFMBS.SetTextScaling(value as Double) as Boolean

Some examples using this method:

• /DynaPDF/Font Test

See also SetTextScaling function in DynaPDF manual.

DynaPDFMBS.SetTransparentColor(ColorValue as Integer) as Boolean

Var pdf as DynaPDFMBS

call pdf.SetTransparentColor pdf.kNO_COLOR

See also SetTransparentColor function in DynaPDF manual.

DynaPDFMBS.SetTrapped(value as boolean)

See also SetTrapped function in DynaPDF manual.

DynaPDFMBS.SetUseExactPwd(value as Boolean) as Boolean

See also SetUseExactPwd function in DynaPDF manual.

DynaPDFMBS.SetUseGlobalImpFiles(value as Boolean) as Boolean

Requires DynaPDF Pro license.

Some examples using this method:

• /DynaPDF/Interlace PDFs
• /DynaPDF/Split PDF
• /DynaPDF/Split PDF in memory

See also SetUseGlobalImpFiles function in DynaPDF manual.

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

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

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

See also SetUseStdFonts function in DynaPDF manual.

DynaPDFMBS.SetUseSwapFile(SwapContents as Boolean, SwapLimit as Integer) as Boolean   Deprecated

Var pdf as DynaPDFMBS // your DynaPDF object

// define a swap file in case memory is low
Var 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

See also SetUseSwapFileEx function in DynaPDF manual.

DynaPDFMBS.SetUseSystemFonts(value as Boolean) as Boolean

See also SetUseSystemFonts function in DynaPDF manual.

DynaPDFMBS.SetUseTransparency(value as Boolean) as Boolean

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

// allow transparency for images
bBool=pdf.SetUseTransparency(False)

Some examples using this method:

• /DynaPDF/Create PDF with object2d
• /DynaPDF/Create PDF with Picture file
• /DynaPDF/Create PDF with Picture files
• /DynaPDF/DynaPDF Transparency Color Test
• /DynaPDF/DynaPDF transparent images/DynaPDF transparent images
• /DynaPDF/DynaPDF transparent images/DynaPDF transparent images console
• /DynaPDF/Image to PDF/Image to pdf
• /DynaPDF/Image to PDF/Multi Tiff to PDF
• /DynaPDF/JBig Test
• /DynaPDF/Raster/DynaPDF Threaded Render Job

See also SetUseTransparency function in DynaPDF manual.

DynaPDFMBS.SetUseVisibleCoords(value as Boolean) as Boolean

Some examples using this method:

• /DynaPDF/Create numbered pages
• /DynaPDF/DynaPDF Graphics/Create numbered pages

See also SetUseVisibleCoords function in DynaPDF manual.

DynaPDFMBS.SetViewerPreferences(Value as Integer, AddVal as Integer) as Boolean

call pdf.SetViewerPreferences pdf.kvpDisplayDocTitle,pdf.kavNone

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

Some examples using this method:

• /DynaPDF/acroform/acroform
• /DynaPDF/acroform/Fill value
• /DynaPDF/Create PDF with LAB color
• /DynaPDF/Create PDF with object2d
• /DynaPDF/Create PDF with paths
• /DynaPDF/Create PDF with text block
• /DynaPDF/Create PDF with text block fonts
• /DynaPDF/Create PDF with text styles
• /DynaPDF/Create PDF with transparency
• /DynaPDF/Font Test

See also SetViewerPreferences function in DynaPDF manual.

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

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

See also SetWMFDefExtent function in DynaPDF manual.

DynaPDFMBS.SetWMFPixelPerInch(Value as Integer) as Boolean

See also SetWMFPixelPerInch function in DynaPDF manual.

DynaPDFMBS.SetWordSpacing(value as Double) as Boolean

See also SetWordSpacing function in DynaPDF manual.

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

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

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:

• /DynaPDF/Show Differences

DynaPDFMBS.SkewCoords(alpha as Double, beta as Double, OriginX as Double, OriginY as Double) as Boolean

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

See also SortFieldsByIndex function in DynaPDF manual.

DynaPDFMBS.SortFieldsByName as Boolean

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

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:

• /DynaPDF/Create PDF with Annotations

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

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

Some examples using this method:

• /DynaPDF/Create PDF with Annotations

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

See also StampAnnot function in DynaPDF manual.

DynaPDFMBS.StrokePath as Boolean

See also StrokePath function in DynaPDF manual.

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

// create dummy PDF with one page
Var d as new myDynaPDFMBS

call d.CreateNewPDF
call d.Append

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

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

Var 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

Var 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:

• /DynaPDF/Create PDF with Arabic and Ligatures
• /DynaPDF/Create PDF with Glyphs
• /DynaPDF/Create PDF with text styles

See also TestGlyphs function in DynaPDF manual.

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

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.TestPassword(PwdType as Integer, Value as String) as Boolean

The main purpose of the function is to test the file against the owner password if the encryption settings should be changed by the user. It is not meaningful to call this function for non-encrypted files. To determine whether a PDF file is encrypted call DynaPDF.GetInIsEncrypted.

See also TestPassword 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

The text and the author parameters are converted to unicode.

Some examples using this method:

• /DynaPDF/Create PDF with Annotations

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

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

Some examples using this method:

• /DynaPDF/Create PDF with object2d
• /DynaPDF/Create PDF with vertical text

See also TranslateCoords function in DynaPDF manual.

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

Some examples using this method:

• /DynaPDF/Create PDF with gradients, overprint and device N colorspace
• /DynaPDF/Create PDF with LAB color
• /DynaPDF/Create PDF with paths
• /DynaPDF/Create PDF with transparency
• /DynaPDF/Font Test
• /DynaPDF/Million pages test/DynaPDF Database Invoice Example with 1000000 pages

See also Triangle function in DynaPDF manual.

DynaPDFMBS.UnLockLayer(layer as UInt32) as boolean

See also UnLockLayer function in DynaPDF manual.

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

// create watermark annotation
Var AnnotHandle As Integer = pdf.WatermarkAnnot(100, 100, 300, 200)

// it's empty initially

// so we create an annotation appearance stream
Var 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:

• /DynaPDF/Create PDF with WatermarkAnnot

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

The text parameter is converted to unicode.

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

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

The text parameter is converted to unicode.

See also:

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

Some examples using this method:

• /DynaPDF/Create PDF with Angle Rectangles
• /DynaPDF/Create PDF with Angle Text
• /DynaPDF/Create PDF with Circle Text

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

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:

• WriteAngleText(aText as string, Angle as Double, PosX as Double, PosY as Double, Radius as Double, YOrigin as Double) as Boolean

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

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

See also WriteAngleText function in DynaPDF manual.