Platforms to show: All Mac Windows Linux Cross-Platform

Back to DynaPDFMBS class.

Previous items Next items

DynaPDFMBS.SetDocInfo(DInfo as Integer, Text as string) 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 set or changes a document info entry.
Example
dim pdf as DynaPDFMBS // your DynaPDF object
dim bBool as Boolean
dim source as FolderItem // source pdf file?

const diAuthor=0
const diCreator=1
const diKeywords=2
const diProducer=3
const diSubject=4
const diTitle=5

// Define some pdf properties:
bBool=pdf.SetDocInfo(diAuthor, SystemInformationMBS.Username)
bBool=pdf.SetDocInfo(diCreator, "SysProgName"+" - "+"MetSysProgVer")
bBool=pdf.SetDocInfo(diKeywords, "")
bBool=pdf.SetDocInfo(diProducer, "SysProgName"+" - "+"MetSysProgVer")
bBool=pdf.SetDocInfo(diSubject, "")
bBool=pdf.SetDocInfo(diTitle, source.name)

The text parameter is converted to unicode.

Some examples using this method:

See also SetDocInfo function in DynaPDF manual.

DynaPDFMBS.SetDocInfoAnsi(DInfo as Integer, Text as string) 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 set or changes a document info entry.
Example
dim pdf as DynaPDFMBS // your DynaPDF object
dim bBool as Boolean
dim source as FolderItem // source pdf file?

const diAuthor=0
const diCreator=1
const diKeywords=2
const diProducer=3
const diSubject=4
const diTitle=5

// Define some pdf properties:
bBool=pdf.SetDocInfoAnsi(diAuthor, SystemInformationMBS.Username)
bBool=pdf.SetDocInfoAnsi(diCreator, "SysProgName"+" - "+"MetSysProgVer")
bBool=pdf.SetDocInfoAnsi(diKeywords, "")
bBool=pdf.SetDocInfoAnsi(diProducer, "SysProgName"+" - "+"MetSysProgVer")
bBool=pdf.SetDocInfoAnsi(diSubject, "")
bBool=pdf.SetDocInfoAnsi(diTitle, source.name)

The text parameter is converted to ANSI.

See also SetDocInfo function in DynaPDF manual.

DynaPDFMBS.SetDocInfoEx(DInfo as Integer, Key as string, Text as string) 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 set or changes a document info entry.

The Text parameter is converted to unicode.

See also SetDocInfoEx function in DynaPDF manual.

DynaPDFMBS.SetDocInfoExAnsi(DInfo as Integer, Key as string, Text as string) 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 set or changes a document info entry.

The Text parameter is converted to ANSI.

See also SetDocInfoEx function in DynaPDF manual.

DynaPDFMBS.SetDrawDirection(Direction 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 draw direction of closed vector graphics such as rectangles, ellipses, triangles and so on.

Some examples using this method:

See also SetDrawDirection function in DynaPDF manual.

DynaPDFMBS.SetEMFFrameDPI(DPIX as Integer, DPIY 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
This function can be used to adjust DPI value which is used to calculate the picture size of an EMF file.

See also SetEMFFrameDPI function in DynaPDF manual.

DynaPDFMBS.SetEMFPatternDistance(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 changes the default distance between lines of standard patterns during EMF conversion.

See also SetEMFPatternDistance function in DynaPDF manual.

DynaPDFMBS.SetErrorMode(ErrMode 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 error mode specifies which error types should be treated as fatal error.

See also SetErrorMode function in DynaPDF manual.

DynaPDFMBS.SetExtColorSpace(Handle as Integer) as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 8.2 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
The function activates an extended color space in the graphics state.

Requires DynaPDF Pro license.

Some examples using this method:

See also SetExtColorSpace function in DynaPDF manual.

DynaPDFMBS.SetExtFillColorSpace(Handle as UInt32) as boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 11.2 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Set the colorspace for filling.

Pass Colorspace handle like for SetExtColorSpace.
Requires DynaPDF Pro license.

Some examples using this method:

See also SetExtFillColorSpace function in DynaPDF manual.

DynaPDFMBS.SetExtGState(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 applies an extended graphics state.

See also SetExtGState function in DynaPDF manual.

DynaPDFMBS.SetExtStrokeColorSpace(Handle as UInt32) as boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 11.2 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Set the colorspace for filling.

Pass Colorspace handle like for SetExtColorSpace.
Requires DynaPDF Pro license.

See also SetExtStrokeColorSpace function in DynaPDF manual.

DynaPDFMBS.SetFieldBackColor(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 background color used for newly created interactive form fields and annotations.

Some examples using this method:

See also SetFieldBackColor function in DynaPDF manual.

DynaPDFMBS.SetFieldBBox(Handle as Integer, rect as DynaPDFRectMBS) 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 bounding box of a field.

See also SetFieldBBox function in DynaPDF manual.

DynaPDFMBS.SetFieldBorderColor(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 border color used for newly created interactive form fields and annotations.

Some examples using this method:

See also SetFieldBorderColor function in DynaPDF manual.

DynaPDFMBS.SetFieldBorderStyle(Field as Integer, Style 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 border style of a specific Interactive Form field.

Some examples using this method:

See also SetFieldBorderStyle function in DynaPDF manual.

DynaPDFMBS.SetFieldBorderWidth(Field as Integer, LineWidth 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
This function can be used to change the border width of a field.

Some examples using this method:

See also SetFieldBorderWidth function in DynaPDF manual.

DynaPDFMBS.SetFieldCalcOrder(CurrIndex as UInt32, NewIndex as UInt32) as Boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 19.5 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Moves a field in the global calc order array.

This is the order in which field values will be recalculated when the value of any field changes.
The current calc order can be accessed with GetFieldCalcOrder(). The calc order array contains field handles. A field handle is a simple array index.

Returns true on success.

See also SetFieldCalcOrder function in DynaPDF manual.

DynaPDFMBS.SetFieldColor(Field as Integer, ColorType as Integer, ColorSpace as Integer, 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 a specific color of an interactive form field.

Some examples using this method:

See also SetFieldColor function in DynaPDF manual.

DynaPDFMBS.SetFieldExpValue(Field as Integer, ValIndex as Integer, Value as string, ExpValue as string, Selected 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
This function can be used to change the choice values of a combo box, list box, or radio button.

Some examples using this method:

See also SetFieldExpValue function in DynaPDF manual.

DynaPDFMBS.SetFieldExpValueAnsi(Field as Integer, ValIndex as Integer, Value as string, ExpValue as string, Selected as boolean) as Boolean   Deprecated

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 16.1 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
This item is deprecated and should no longer be used. You can use the non ANSI function instead.
This function can be used to change the choice values of a combo box, list box, or radio button.

See also SetFieldExpValue function in DynaPDF manual.

DynaPDFMBS.SetFieldExpValueEx(Field as Integer, ValIndex as Integer, Selected as boolean, DefSelected as boolean) as Boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 12.1 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
The function marks a choice value of a combo or list box as selected or unselected.

It can also be used to change the state of check boxes or the children of a radio button. The parameter ValIndex will be ignored if the field is a normal check box (no child of a redio button or field group).

To enumerate the choice values of a combo box, list box or radio button use the function GetFieldExpValueEx().

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

See also SetFieldExpValueEx function in DynaPDF manual.

DynaPDFMBS.SetFieldFlags(Field as Integer, Flags as Integer, Reset 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 sets the flags of a specific interactive form field.
Example

Dim pdf As DynapdfMBS // your PDF environment with open page

// create field on current page
Dim Field1 As Integer = pdf.CreateTextField("Field1", -1, True, 0, 50.0, 100, 200.0, 100.0)

// and fill value
Call pdf.SetTextFieldValue(Field1, "Hello", "", pdf.ktaLeft)

// make a field the user should not mess up with
Dim Flags As Integer
flags = Bitwise.BitOr(pdf.kffNoView, pdf.kffInvisible, pdf.kffHidden, pdf.kffReadOnly)
Call pdf.SetFieldFlags(field1, flags, False)

Some examples using this method:

See also SetFieldFlags function in DynaPDF manual.

DynaPDFMBS.SetFieldFont(Field as Integer, Name as string, Style as Integer = 0, Size as double = 12, Embed as boolean = true, CodePage as integer = &h27) 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 sets or changes the font of a form field.

See documentation of SetFieldFont function in dynapdf_help manual file for details.

See also SetFieldFont function in DynaPDF manual.

DynaPDFMBS.SetFieldFontAnsi(Field as Integer, Name as string, Style as Integer = 0, Size as Double = 12, Embed as boolean = true, CodePage as Integer = &h27) 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 sets or changes the font of a form field.

See documentation of SetFieldFont function in dynapdf_help manual file for details.

See also SetFieldFont function in DynaPDF manual.

DynaPDFMBS.SetFieldFontEx(Field as UInt32, Handle as UInt32, FontSize as Double) as Boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 15.0 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
The function sets or replaces the font of a field.

The function requires a font handle that was returned by SetFieldFont.
Returns true on success and false on failure.

See also SetFieldFontEx function in DynaPDF manual.

DynaPDFMBS.SetFieldFontSize(aField as Integer, FontSize 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 changes the font size of a specific field.

See also SetFieldFontSize function in DynaPDF manual.

DynaPDFMBS.SetFieldHighlightMode(Field as Integer, HighlightMode 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 highlight mode of a specific field.

See also SetFieldHighlightMode function in DynaPDF manual.

DynaPDFMBS.SetFieldIndex(Field as Integer, Index 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
This function can be used to set the tab order of interactive form fields.

See also SetFieldIndex function in DynaPDF manual.

DynaPDFMBS.SetFieldMapName(Field as Integer, Name as string) 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 mapping name of a field.

The parameter name is converted to unicode.

See also SetFieldMapName function in DynaPDF manual.

DynaPDFMBS.SetFieldMapNameAnsi(Field as Integer, Name as string) 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 mapping name of a field.

The parameter name is converted to ANSI.

See also SetFieldMapName function in DynaPDF manual.

DynaPDFMBS.SetFieldName(Field as Integer, NewName as string) 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 name of an interactive form field.

See also SetFieldName function in DynaPDF manual.

DynaPDFMBS.SetFieldNameAnsi(Field as Integer, NewName as string) as Boolean   Deprecated

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 16.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 changes the name of an interactive form field.

The text parameter is converted to ANSI.

See also SetFieldName function in DynaPDF manual.

DynaPDFMBS.SetFieldOrientation(Field as Integer, 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 or changes the orientation of a field.

See also SetFieldOrientation function in DynaPDF manual.

DynaPDFMBS.SetFieldTextAlign(Field as Integer, 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 set or changes the text alignment of a text or button field.

See also SetFieldTextAlign function in DynaPDF manual.

DynaPDFMBS.SetFieldTextColor(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 text color which is used for newly created interactive form fields.

See also SetFieldTextColor function in DynaPDF manual.

DynaPDFMBS.SetFieldToolTip(Field as Integer, Value as string) 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 set or changes the tool tip or description string of an interactive form field.

The value parameter is converted to unicode.

See also SetFieldToolTip function in DynaPDF manual.

DynaPDFMBS.SetFieldToolTipAnsi(Field as Integer, Value as string) 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 set or changes the tool tip or description string of an interactive form field.

The value parameter is converted to ANSI.

See also SetFieldToolTip function in DynaPDF manual.

DynaPDFMBS.SetFillColor(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 fill color.

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.

See also:

See also SetFillColor function in DynaPDF manual.

DynaPDFMBS.SetFillColor(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 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

The parameter Color must be defined in the current color space.

See also:

See also SetFillColor function in DynaPDF manual.

DynaPDFMBS.SetFillColor(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 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

The number of components must match.

See also:

See also SetFillColor function in DynaPDF manual.

DynaPDFMBS.SetFillColor(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 fill color based on an array of floats.

The number of components must match.

See also:

See also SetFillColor function in DynaPDF manual.

DynaPDFMBS.SetFillColorEx(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 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

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:

Some examples using this method:

See also SetFillColorEx function in DynaPDF manual.

Previous items Next items

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


The biggest plugin in space...