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.SetFieldToolTip(Field as Integer, Value as string) as Boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 7.6 Yes Yes Yes Yes No
Function: The function set or changes the tool tip or description string of an interactive form field.
Notes:
The value parameter is converted to unicode.
Also check the dynapdf manual on the pdfSetFieldToolTipW function.

See also SetFieldToolTip function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.SetFieldToolTipAnsi(Field as Integer, Value as string) as Boolean
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 set or changes the tool tip or description string of an interactive form field.
Notes:
The value parameter is converted to ANSI.
Also check the dynapdf manual on the pdfSetFieldToolTipA function.

Feedback, Comments & Corrections

DynaPDFMBS.SetFillColor(ColorValue as Color) as Boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 14.0 Yes Yes Yes Yes No
Function: The function sets the fill color.
Notes:
Raises an exception if current color space is CMYK or Gray and not RGB.
The parameter Color must be defined in the current color space.
Also check the dynapdf manual on the pdfSetFillColor function.

See also:

See also SetFillColor function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.SetFillColor(ColorValue as Integer) as Boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 7.6 Yes Yes Yes Yes No
Function: The function sets the fill color.
Example:
// new DynaPDF Object. Use your own subclass to catch errors in error event
dim pdf as new DynaPDFMBS

// For this example you can use a Starter, Lite, Pro or Enterprise License
pdf.SetLicenseKey "Starter"

// destination pdf file
dim f as FolderItem = SpecialFolder.Desktop.Child("test.pdf")

// create new pdf document
call pdf.CreateNewPDF f

// add new page
call pdf.append

// set red text color
call pdf.SetFillColor pdf.RGB(255,0,0)

// set font
call pdf.SetFont "Times", pdf.kfsItalic, 40.0, true, pdf.kcp1252

// write some text
call pdf.WriteFText pdf.ktaCenter, "My first PDF!"

// close page
call pdf.EndPage

// close file
call pdf.CloseFile

// open in users preferred PDF viewer application
f.Launch
Notes:
The parameter Color must be defined in the current color space.
Also check the dynapdf manual on the pdfSetFillColor function.

See also:

See also SetFillColor function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.SetFillColor(values() as Double) as boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 11.2 Yes Yes Yes Yes No
Function: Sets fill color based on an array of floats.
Example:
// new DynaPDF Object. Use your own subclass to catch errors in error event
dim pdf as new DynaPDFMBS

// For this example you can use a Starter, Lite, Pro or Enterprise License
pdf.SetLicenseKey "Starter"

// destination pdf file
dim f as FolderItem = SpecialFolder.Desktop.Child("test.pdf")

// create new pdf document
call pdf.CreateNewPDF f

// add new page
call pdf.append

// set blue text color with values in memoryblock
dim colorvalues() as Double = array(0.0, 1.0, 0.0)
call pdf.SetFillColor colorvalues

// set font
call pdf.SetFont "Times", pdf.kfsItalic, 40.0, true, pdf.kcp1252

// write some text
call pdf.WriteFText pdf.ktaCenter, "My first PDF!"

// close page
call pdf.EndPage

// close file
call pdf.CloseFile

// open in users preferred PDF viewer application
f.Launch
Notes:
The number of components must match.
Also check the dynapdf manual on the pdfSetFillColorF function.

See also:

See also SetFillColor function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.SetFillColor(values() as single) as boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 11.2 Yes Yes Yes Yes No
Function: Sets fill color based on an array of floats.
Notes:
The number of components must match.
Also check the dynapdf manual on the pdfSetFillColorF function.

See also:

See also SetFillColor function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.SetFillColorEx(colorvalues as memoryblock, count as Integer) as Boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 9.1 Yes Yes Yes Yes No
Function: Sets the fill color using the values in parameters.
Example:
// new DynaPDF Object. Use your own subclass to catch errors in error event
dim pdf as new DynaPDFMBS

// For this example you can use a Starter, Lite, Pro or Enterprise License
pdf.SetLicenseKey "Starter"

// destination pdf file
dim f as FolderItem = SpecialFolder.Desktop.Child("test.pdf")

// create new pdf document
call pdf.CreateNewPDF f

// add new page
call pdf.append

// set blue text color with values in memoryblock
dim m as new MemoryBlock(3)
m.Byte(0) = 0
m.Byte(1) = 0
m.Byte(2) = 255
call pdf.SetFillColorEx m,3

// set font
call pdf.SetFont "Times", pdf.kfsItalic, 40.0, true, pdf.kcp1252

// write some text
call pdf.WriteFText pdf.ktaCenter, "My first PDF!"

// close page
call pdf.EndPage

// close file
call pdf.CloseFile

// open in users preferred PDF viewer application
f.Launch
Notes: 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 SetFillColorEx function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.SetFillColorEx(ParamArray colorvalue as Integer) as Boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 9.1 Yes Yes Yes Yes No
Function: Sets the fill color using the values in parameters.
Example:
// new DynaPDF Object. Use your own subclass to catch errors in error event
dim pdf as new DynaPDFMBS

// For this example you can use a Starter, Lite, Pro or Enterprise License
pdf.SetLicenseKey "Starter"

// destination pdf file
dim f as FolderItem = SpecialFolder.Desktop.Child("test.pdf")

// create new pdf document
call pdf.CreateNewPDF f

// add new page
call pdf.append

// set red text color
call pdf.SetFillColorEx 255,0,0

// set font
call pdf.SetFont "Times", pdf.kfsItalic, 40.0, true, pdf.kcp1252

// write some text
call pdf.WriteFText pdf.ktaCenter, "My first PDF!"

// close page
call pdf.EndPage

// close file
call pdf.CloseFile

// open in users preferred PDF viewer application
f.Launch
Notes: 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 SetFillColorEx function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.SetFillColorSpace(Colorspace as Integer) as Boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 7.6 Yes Yes Yes Yes No
Function: The function changes the fill color space.
Notes: Also check the dynapdf manual on the pdfSetFillColorSpace function.

See also SetFillColorSpace function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.SetFloatPrecision(NumTextDecDigits as UInt32, NumVectDecDigits as UInt32) as boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 16.5 Yes Yes Yes Yes No
Function: The function changes the output precision of text and vector coordinates.
Notes:
The default precision for text and vector graphics is two decimal digits. This corresponds to 7200 DPI. The output precision of bezier curves is one higher as for vector graphics. The maximum output precision is 5 decimal digits.
Note that higher values increase the resulting file size.

NumTextDecDigits: Number decimal digits for text object.
NumVectDecDigits: Number of decimal digits for vector objects.

Returns boolean, true for success.

See also SetFloatPrecision function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.SetFont(Name as string, Style as Integer = 0, Size as Double = 12, Embed as boolean = true, CP as Integer = &h27) as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 7.6 Yes Yes Yes Yes No
Function: The function loads a font that can be used for text output and interactive form fields.
Notes:
The name parameter is converted to unicode.
Also check the dynapdf manual on the pdfSetFontExW function.

If font is not found by name, please check SetFontSelMode function.

See also SetFont function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.SetFontAnsi(Name as string, Style as Integer = 0, Size as Double = 12, Embed as boolean = true, CP as Integer = &h27) 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 loads a font that can be used for text output and interactive form fields.
Example:
dim pdf as DynaPDFMBS // your PDF object
call pdf.SetFontAnsi("Helvetica", pdf.kfsNone, 10.0, true, pdf.kcp1252)
Notes:
The name parameter is converted to ANSI.
Also check the dynapdf manual on the pdfSetFontExA function.

If font is not found by name, please check SetFontSelMode function.

Feedback, Comments & Corrections

DynaPDFMBS.SetFontEx(Name as string, Style as Integer = 0, Size as Double = 12, Embed as boolean = true, CP as Integer = &h27) 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 loads a font that can be used for text output and interactive form fields.
Notes:
The name parameter is converted to unicode.
Also check the dynapdf manual on the pdfSetFontEx function.

If font is not found by name, please check SetFontSelMode function.

See also SetFontEx function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.SetFontExAnsi(Name as string, Style as Integer = 0, Size as Double = 12, Embed as boolean = true, CP as Integer = &h27) 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 loads a font that can be used for text output and interactive form fields.
Notes:
The name parameter is converted to ANSI.
Also check the dynapdf manual on the pdfSetFontExA function.

If font is not found by name, please check SetFontSelMode function.

Feedback, Comments & Corrections

DynaPDFMBS.SetFontOrigin(Origin as Integer) as Boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 7.6 Yes Yes Yes Yes No
Function: The function sets the current font origin that is used to position text strings.
Notes: Also check the dynapdf manual on the pdfSetFontOrigin function.

See also SetFontOrigin function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.SetFontSearchOrder(Order() as Integer)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 10.1 Yes Yes Yes Yes No
Function: Sets the font search order.
Notes:
The values in the array use this constants:
kfbtTrueTypeTrueType, TrueType Collections, or OpenType fonts with TrueType outlines
kfbtType1Type1 font
kfbtOpenTypeOpenType font with Postscript outlines
kfbtStdFontPDF Standard font
kfbtDisabled This value can be used to disable a specific font format.

The array has 4 values.

See also SetFontSearchOrder function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.SetFontSearchOrderEx(Order1 as Integer, Order2 as Integer, Order3 as Integer, Order4 as Integer)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 11.1 Yes Yes Yes Yes No
Function: The function changes the font search order in the same way as SetFontSearchOrder() but it does not use an array to set the search order to improve compatibility to programming languages with limited array support.
Notes:
Also check the dynapdf manual on the pdfSetFontSearchOrderEx function.
use the font base constants.

See also SetFontSearchOrderEx function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.SetFontSelMode(Mode as Integer) as Boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 7.6 Yes Yes Yes Yes No
Function: The function changes the font selection mode.
Notes: Also check the dynapdf manual on the pdfSetFontSelMode function.

See also SetFontSelMode function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.SetFontWeight(Weight as Integer) as Boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 7.6 Yes Yes Yes Yes No
Function: The font weight specifies the thickness or boldness of a font.
Notes: Also check the dynapdf manual on the pdfSetFontWeight function.

See also SetFontWeight function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.SetGStateFlags(Flags as Integer, Reset as boolean)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 7.6 Yes Yes Yes Yes No
Function: The function sets optional flags affecting the graphics state and coordinate handling.
Notes: Also check the dynapdf manual on the pdfSetGStateFlags function.

See also SetGStateFlags function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.SetIconColor(ColorValue as Integer) as Boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 7.6 Yes Yes Yes Yes No
Function: The icon color is used for the closed state of a text annotation.
Notes: Also check the dynapdf manual on the pdfSetIconColor function.

See also SetIconColor function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.SetImportFlags(Flags as Integer) as Boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 7.6 Yes Yes Yes Yes No
Function: The function sets optional flags to control the import of external PDF files.
Notes: Also check the dynapdf manual on the pdfSetImportFlags function.

See also SetImportFlags function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.SetImportFlags2(Flags as Integer) as Boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 8.2 Yes Yes Yes Yes No
Function: The function sets optional flags to control the import of external PDF files.
Notes: Also check the dynapdf manual on the pdfSetImportFlags2 function.

See also SetImportFlags2 function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.SetItalicAngle(value as Double) as Boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 7.6 Yes Yes Yes Yes No
Function: The property ItalicAngle is used to emulate an italic font if the font is not available in an italic style.
Notes: Also check the dynapdf manual on the pdfSetItalicAngle function.

See also SetItalicAngle function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.SetJPEGQuality(Value as Integer) as Boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 7.6 Yes Yes Yes Yes No
Function: The function sets the quality of JPEG compressed images in percent if JPEG compression is used.
Notes: Also check the dynapdf manual on the pdfSetJPEGQuality function.

See also SetJPEGQuality function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.SetLanguage(ISOTag as string) as Boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 7.6 Yes Yes Yes Yes No
Function: The property specifies the language of the document.
Notes: Also check the dynapdf manual on the pdfSetLanguage function.

See also SetLanguage function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.SetLeading(value as Double) as Boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 7.6 Yes Yes Yes Yes No
Function: The function sets the leading that will be used by the functions AddContinueText() and WriteFText() to calculate the distance between two text lines.
Notes:
Also check the dynapdf manual on the pdfSetLeading function.
This is for setting the line height.

See also SetLeading function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.SetLicenseKey(Value as string)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 7.6 Yes Yes Yes Yes No
Function: Use this function to enter your license key.
Example:
dim pdf as DynaPDFMBS // your DynaPDF object
pdf.SetLicenseKey("1234567890") // enter your code here
Notes:
If the value represents a correct license key the demo string does not longer appear on PDF pages. Once a correct key was set, it will be active until the library is unloaded or the current PDF object is released. Note that the key must be entered for each PDF object or process of a multi-threading application separately.

The license key must not be stored in the registry or other files in an unencrypted form.

You need to buy a license key from MBS.
The key will unlock the library to not run in demo mode.

Pro license is required for the following functions:
  • BeginTransparencyGroup
  • ConvertColors
  • Create3DAnnot
  • CreateSoftMask
  • FlattenForm
  • GetPageText
  • ImportPage and ImportPageEx
  • ParseContent
  • RenderAnnotOrField
  • RenderPage
  • SetCMapDir
  • SetExtColorSpace, SetExtFillColorSpace and SetExtStrokeColorSpace.
  • SetUseGlobalImpFiles

Lite is required for:
  • AddRenderingIntent and AddRenderingIntentEx
  • CreateFormFields
  • CloseFileEx
  • ConvertEMFSpool
  • CreateCollection
  • CreateExtGState
  • InsertMetafile and InsertMetafileEx
  • OpenImportBuffer, OpenImportFile and OpenImportStream
  • SetPDFVersion for PDF/A and PDF/X

And all functions relaying on those functions internally.

See also SetLicenseKey function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.SetLineAnnotParms(Handle as UInt32, FontHandle as Integer, FontSize as Double, Params as DynaPDFLineAnnotParameterMBS) as boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 14.0 Yes Yes Yes Yes No
Function: The function sets or changes the properties of a line annotation relating to measure lines.
Notes:
The parameter Parms can be set to nil to delete all measure line specific values. The parameters FontHandle and FontSize will be ignored in this case.
The member Caption specifies whether the parameter Content of the function LineAnnot should be used as caption of the measure line. Although a measure line can display the string in a PopUp annotation like ordinary line annotations, this is not recommended and not fully supported in Adobe's Acrobat or Reader.
If Caption is true (recommended), the caption is drawn horizontally centered either on top or inside the measure line. The text position can be changed from its normal position with the members CaptionOffsetX and CaptionOffsetY.
The parameter FontHandle can be used to specify an arbitrary font that should be used to draw the caption. Although it is possible to use any font or font size greater 0 with DynaPDF, a PDF viewer will change the font and font size to it's default values when the annotation will be edited since line annotations support no property to specify the font or font size.
Function Reference

The default font to draw the caption is Helvetica and the default font size is 9 units. In order to use the default font set the parameter FontHandle to -1. The default font size is used if the parameter FontSize is set to to zero.

Returns true on success or false on failure.

See also SetLineAnnotParms function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.SetLineCapStyle(Style as Integer) as Boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 7.6 Yes Yes Yes Yes No
Function: The function sets the line cap style that specifies how the endpoint of a line will be drawn.
Notes: Also check the dynapdf manual on the pdfSetLineCapStyle function.

See also SetLineCapStyle 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 Plugins