Platforms to show: All Mac Windows Linux Cross-Platform

Back to DynaPDFMBS class.

Previous items Next items

DynaPDFMBS.CreateGoToRActionExU(File as folderitem, DestName as String, NewWindow as boolean) as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 11.1 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
The function creates a go-to-remote action that opens a named destination in an external PDF file.

See also:

DynaPDFMBS.CreateGoToRActionExU(FilePath as String, DestName as String, NewWindow as boolean) as integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 18.1 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
The function creates a go-to-remote action that opens a named destination in an external PDF file.

See also:

DynaPDFMBS.CreateGroupField(Name as string, Parent as Integer) as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 8.0 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
This function creates a group field.

See also CreateGroupField function in DynaPDF manual.

DynaPDFMBS.CreateHideAction(Field as Integer, Hide 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
A hide action hides or shows one or more interactive form fields on screen by setting or clearing their hidden flags.

See also CreateHideAction function in DynaPDF manual.

DynaPDFMBS.CreateICCBasedColorSpace(File as folderitem) as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 10.1 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
The function creates an ICC based color space.

Use the value returned for the SetExtColorSpace method.

See also:

See also CreateICCBasedColorSpace function in DynaPDF manual.

DynaPDFMBS.CreateICCBasedColorSpace(Path as String) as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 19.5 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
The function creates an ICC based color space.

Use the value returned for the SetExtColorSpace method.

See also:

See also CreateICCBasedColorSpace function in DynaPDF manual.

DynaPDFMBS.CreateICCBasedColorSpaceEx(Buffer as Memoryblock) as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 13.0 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Creates a new ICC based color space from ICC file content in a string buffer.

Returns the color space handle.

See also:

Some examples using this method:

See also CreateICCBasedColorSpaceEx function in DynaPDF manual.

DynaPDFMBS.CreateICCBasedColorSpaceEx(Buffer as string) as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDf MBS DynaPDF Plugin 12.3 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Creates a new ICC based color space from ICC file content in a string buffer.

Returns the color space handle.

See also:

See also CreateICCBasedColorSpaceEx function in DynaPDF manual.

DynaPDFMBS.CreateImage(file as folderitem, format as Integer) as boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 8.6 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Creates an image file with the given image format.

For the format parameter use the kifm* constants.

If file parameter is nil for CreateImage, you create image in memory and can pick it up with GetImageBuffer function later after you closed it.

See also CreateImage function in DynaPDF manual.

DynaPDFMBS.CreateImpDataAction(DataFile as folderitem) as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 8.0 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
An import data action imports FDF data into the document s interactive form.

Also check the dynapdf manual on the pdfCreateImpDataActionA function (pdfCreateImpDataActionW on Windows).

DynaPDFMBS.CreateIndexedColorSpace(Base as Integer, Handle as Integer, ColorTable as memoryblock, NumColors 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 creates an indexed color space which can be used for vector graphics and text output.

Use the value returned for the SetExtColorSpace method.

See also CreateIndexedColorSpace function in DynaPDF manual.

DynaPDFMBS.CreateJSAction(Script 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
This function creates a JavaScript action.

The script parameter is converted to unicode.

Some examples using this method:

See also CreateJSAction function in DynaPDF manual.

DynaPDFMBS.CreateJSActionAnsi(Script 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.
This function creates a JavaScript action.

The script parameter is converted to ANSI.

See also CreateJSAction function in DynaPDF manual.

DynaPDFMBS.CreateLaunchAction(OP as Integer, FileName as folderitem, DefDir as string, Param as string, NewWindow 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
A launch action launches an application or opens or prints a document.

See also CreateLaunchAction function in DynaPDF manual.

DynaPDFMBS.CreateLaunchActionEx(FileName as folderitem, NewWindow as boolean) as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 11.1 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Creates a launch link.

See also CreateLaunchActionEx function in DynaPDF manual.

DynaPDFMBS.CreateListBox(Name as string, Sort as boolean, Parent as Integer, 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 8.0 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
This function creates a list box.

See also CreateListBox function in DynaPDF manual.

DynaPDFMBS.CreateNamedAction(Action as Integer) as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 8.0 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
This function creates a named action.

See also CreateNamedAction function in DynaPDF manual.

DynaPDFMBS.CreateNamedDest(Name as string, DestPage as Integer, DestType as Integer, a as Double, b as Double, c as Double, d as Double) 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 named destination that can be accessed from external PDF files.

The name parameter is converted to unicode.

Some examples using this method:

See also CreateNamedDest function in DynaPDF manual.

DynaPDFMBS.CreateNamedDestAnsi(Name as string, DestPage as Integer, DestType as Integer, a as Double, b as Double, c as Double, d as Double) 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 named destination that can be accessed from external PDF files.

The name parameter is converted to ANSI.

See also CreateNamedDest function in DynaPDF manual.

DynaPDFMBS.CreateNewPDF(OutPDF as folderitem = nil) 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 creates a new PDF file.
Example
dim dest as folderitem // where to save?
dim pdf as DynaPDFMBS // your DynaPDF object
dim bBool as Boolean

// create new pdf
bBool=pdf.CreateNewPDF(dest)
if bBool=False then
MsgBox "Failed to create pdf file "+dest.NativePath
Return
end if

Some examples using this method:

See also CreateNewPDF function in DynaPDF manual.

DynaPDFMBS.CreateOCG(name as string, DisplayInUI as boolean, Visible as boolean, Intent as Integer) as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 10.5 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
The function creates an Optional Content Group (OCG).

CreateOCG stores the name in unicode encoding and CreateOCGAnsi in Windows ANSI encoding.

Some examples using this method:

See also CreateOCG function in DynaPDF manual.

DynaPDFMBS.CreateOCGAnsi(name as string, DisplayInUI as boolean, Visible as boolean, Intent as Integer) as Integer   Deprecated

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 10.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 creates an Optional Content Group (OCG).

CreateOCG stores the name in unicode encoding and CreateOCGAnsi in Windows ANSI encoding.

See also CreateOCG function in DynaPDF manual.

DynaPDFMBS.CreateOCMD(Visibility as Integer, OCGs() as Integer) as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 10.5 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
The function creates an Optional Content Membership Dictionary (OCMD).

For Visibility use the constants kovAllOff, kovAllOn, kovAnyOff, kovAnyOn and kovNotSet.

Some examples using this method:

See also CreateOCMD function in DynaPDF manual.

DynaPDFMBS.CreateRadialShading(sX as Double, sY as Double, R1 as Double, eX as Double, eY as Double, R2 as Double, SCenter as Double, SColor as Integer, EColor as Integer, Extend1 as boolean, Extend2 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
Radial shadings define a color blend that varies between two circles.

Useful to draw gradients.

See also CreateRadialShading function in DynaPDF manual.

DynaPDFMBS.CreateRadioButton(Name as string, ExpValue as string, Checked as boolean, Parent as Integer, 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 8.0 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
A radio button field is a set of related toggle controls (check boxes), at most one of which may be on at any given time; selecting any one of the button automatically deselects all others.

Some examples using this method:

See also CreateRadioButton function in DynaPDF manual.

DynaPDFMBS.CreateRectilinearMeasure(ViewPort as Integer, Scale as Double, UnitDescription as String, LabelDistance as String, LabelArea as String) as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 19.5 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Creates a rectilinear measure dictionary.

This kind of measure dictionary can be used to convert PDF units to an arbitrary other unit like millimeters, meters, feets, and so on.
A measure dictionary is used by the measure tool of Adobe's Acrobat and by other PDF viewers which contain a PDF compatible measure tool.
The parameter Viewport must be a viewport handle that was returned by CreateViewport(). Scale is the required scaling factor to convert a PDF unit (1/72 inch) to the wished destination unit. The parameters UnitDescription, LabelDistance, and LabelArea are all required and cannot be NULL.
UnitDescription is a description of the coordinate conversion, e.g. "Inch to mm". LabelDistance is the label for the distance tool, e.g. "mm".
LabelArea is the label for the area tool, e.g. "mm2".

If the function succeds the return value is a measure handle, a value greater or equal zero. If the function fails the return value is a negative error code.

See also CreateRectilinearMeasure function in DynaPDF manual.

DynaPDFMBS.CreateRectilinearMeasureAnsi(ViewPort as Integer, Scale as Double, UnitDescription as String, LabelDistance as String, LabelArea as String) as Integer   Deprecated

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 19.5 ✅ 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 rectilinear measure dictionary.

This kind of measure dictionary can be used to convert PDF units to an arbitrary other unit like millimeters, meters, feets, and so on.
A measure dictionary is used by the measure tool of Adobe's Acrobat and by other PDF viewers which contain a PDF compatible measure tool.
The parameter Viewport must be a viewport handle that was returned by CreateViewport(). Scale is the required scaling factor to convert a PDF unit (1/72 inch) to the wished destination unit. The parameters UnitDescription, LabelDistance, and LabelArea are all required and cannot be NULL.
UnitDescription is a description of the coordinate conversion, e.g. "Inch to mm". LabelDistance is the label for the distance tool, e.g. "mm".
LabelArea is the label for the area tool, e.g. "mm2".

If the function succeds the return value is a measure handle, a value greater or equal zero. If the function fails the return value is a negative error code.

This is ANSI version, so all strings are converted to ANSI encoding.

See also CreateRectilinearMeasure function in DynaPDF manual.

DynaPDFMBS.CreateResetAction as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 8.0 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
A reset form action resets all or specific fields of an interactive form to their default values.

Some examples using this method:

See also CreateResetAction function in DynaPDF manual.

DynaPDFMBS.CreateSeparationCS(Colorant as string, Alternate as Integer, Handle as Integer, ColorValue 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 creates a Separation color space.

This function passes colorant string in UTF-8 encoding to the library.

Some examples using this method:

See also CreateSeparationCS function in DynaPDF manual.

DynaPDFMBS.CreateSeparationCSAnsi(Colorant as string, Alternate as Integer, Handle as Integer, ColorValue as Integer) as Integer   Deprecated

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 10.1 ✅ 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 Separation color space.

This function passes colorant string in Windows ANSI encoding to the library.

See also CreateSeparationCS function in DynaPDF manual.

DynaPDFMBS.CreateSetOCGStateAction(On() as UInt32, Off() as UInt32, Toggle() as UInt32, PreserveRB as boolean) as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 10.5 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
The function creates a SetOCGState action that can be used to change the visibility state of certain Optional Content Groups (OCGs).

Some examples using this method:

See also CreateSetOCGStateAction function in DynaPDF manual.

DynaPDFMBS.CreateSigField(Name as string, Parent as Integer, 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 8.0 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
This function creates an empty signature field which can be used to digitally sign the PDF file.

If you see errors in Acrobat Reader with signing multiple fields, please try DynaPDF.CreateStructureTree function and test whether it works then.

Some examples using this method:

See also CreateSigField function in DynaPDF manual.

DynaPDFMBS.CreateSigFieldAP(SigField as Integer) 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 signature appearance template in the exact size of the base signature field.

Some examples using this method:

See also CreateSigFieldAP function in DynaPDF manual.

DynaPDFMBS.CreateSoftMask(TranspGroup as UInt32, MaskType as Integer, BackColor as UInt32) as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 11.3 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Creates a new soft mask.

MaskType: pass ksmtAlpha or ksmtLuminosity constants.
Requires DynaPDF Pro license.

See also CreateSoftMask function in DynaPDF manual.

DynaPDFMBS.CreateStdPattern(Pattern as Integer, LineWidth as Double, Distance as Double, LineColor as Integer, BackColor as Integer) as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 8.0 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
This function creates a hatch pattern.

See also CreateStdPattern function in DynaPDF manual.

DynaPDFMBS.CreateStructureTree as boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 8.2 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Creates a global structure tree that is required to create Tagged PDF files.

Tagged PDF files require a root node of type Art, Div, Document, Part, or Sect. This function creates a root node of type Document if nothing else was already imported. Other types can be created with the function CreateStructureTreeEx.

Notice:
DynaPDF is able to extend an existing structure tree that was imported from an external PDF file. However, when editing external PDF files the following rules must be considered:

  • The structure information of a PDF file will only be imported when the entire PDF file is imported with ImportPDFFile(). When importing single pages with ImportPage() or ImportPageEx() of a PDF file that contains structure information then tagging will be disabled because DynaPDF is not able to import the structure information of a PDF file on a per page basis.
  • Import first the PDF file and call then CreateStructureTree(). The reverse order causes that the structure tree will not be imported and tagging will be disabled!
  • Only one PDF file with structure information can be imported without invalidating the structure information.
  • Keep in mind that the structure tree of a PDF file is a complex global structure that is difficult to edit. Because of this, probably millions of PDF files exist that contain damages in the structure tree, mostly due to editing actions in certain viewer applications. When opening an existing page with EditPage() the function tries to find the corresonding StructParents array of the page in the ParentTree of the document's Structure Tree. When this action fails then tagging will be disabled for this page. OpenTag() and CloseTag() do not produce further warnings in this case. The function GetIsTaggingEnabled() can be used to determine whether tagging is still enabled after an existing page was opened for editing.

When creating Tagged PDF files it is important to create the PDF file in the logical reading order.

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

Some examples using this method:

See also CreateStructureTree function in DynaPDF manual.

DynaPDFMBS.CreateStructureTreeEx(Tag as Integer) as Boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 23.1 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Creates the global structure tree as described at CreateStructureTree().

The only difference is that the type of the root node can be specified.

Returns true on success and false on failure.

See also CreateStructureTreeEx function in DynaPDF manual.

DynaPDFMBS.CreateSubmitAction(Flags as Integer, URL 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
A submit form action submits the field values of an interactive form to a web server.

Some examples using this method:

See also CreateSubmitAction function in DynaPDF manual.

DynaPDFMBS.CreateTable(AllocRows as UInt32, NumCols as UInt32, width as Double, DefRowHeight as Double) as DynaPDFTableMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 12.4 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Creates a table with the given size.

Returns a new table object.

See also CreateTable function in DynaPDF manual.

DynaPDFMBS.CreateTextField(Name as string, Parent as Integer, Multiline as boolean, MaxLen as Integer, 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 8.0 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
This function creates a text 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)

Some examples using this method:

See also CreateTextField function in DynaPDF manual.

DynaPDFMBS.CreateTraceFile(File as FolderItem) as Boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 21.4 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Creates a trace file.

The plugin writes debug messages to this file so you can check what functions you called.

Improved with 16.2 plugin to really cover over 99% of all calls with parameters and result. Please report if you miss something.

While assignment to TraceFile property or CreateTraceFile() always overwrites existing log file, the AppendTraceFile method can append to it.

DynaPDFMBS.CreateURIAction(URL 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

A uniform resource identifier (URI) is a string that identifies (resolves to) a resource on the internet - typically a file that is the destination of a hyperlink, although it can also resolve to a query or other
entity.

A URI action causes a URI to be resolved. The parameter URL must be 7Å]bit ASCII string.

See also CreateURIAction function in DynaPDF manual.

DynaPDFMBS.CreateViewport(Name as String, X1 as Double, Y1 as Double, X2 as Double, Y2 as Double) as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 19.5 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Creates a viewport.

A viewport is a rectangular region of a page that can be associated with a measure dictionary. A measure dictionary achieves a coordinate conversion so that the distance and area can be calculated in other units like meters, feets, or millimeters, for example.
This is especially useful for CAD drawings which are not defined in PDF units. A PDF unit represents 1/72 inch.
A page can contain an arbitrary number of viewports and every viewport can be assigned with its own measure dictionary, e.g. to calculate coordinates in different units on the same page.
Viewports should be created in drawing order. Since viewports might overlap a PDF viewer examines the array starting with the last one and itereates in reverse order. The first one whose bounding box contains the point or cursor coordiante is chosen.
See also CreateRectilinearMeasure().

See also CreateViewport function in DynaPDF manual.

DynaPDFMBS.CreateViewportAnsi(Name as String, X1 as Double, Y1 as Double, X2 as Double, Y2 as Double) as Integer   Deprecated

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 19.5 ✅ 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 viewport.

A viewport is a rectangular region of a page that can be associated with a measure dictionary. A measure dictionary achieves a coordinate conversion so that the distance and area can be calculated in other units like meters, feets, or millimeters, for example.
This is especially useful for CAD drawings which are not defined in PDF units. A PDF unit represents 1/72 inch.
A page can contain an arbitrary number of viewports and every viewport can be assigned with its own measure dictionary, e.g. to calculate coordinates in different units on the same page.
Viewports should be created in drawing order. Since viewports might overlap a PDF viewer examines the array starting with the last one and itereates in reverse order. The first one whose bounding box contains the point or cursor coordiante is chosen.
See also CreateRectilinearMeasure().

This is ANSI version, so all strings are converted to ANSI encoding.

See also CreateViewport function in DynaPDF manual.

DynaPDFMBS.CreateXFAStream(Name as String, Buffer as String) as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 19.5 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
The function creates an XFA stream and adds it to the global XFA resource array.

The parameter Name must be the name of the XFA resource. Buffer must be a valid XFA stream buffer or "", if the buffer should be set later with SetXFAStream().

If the function succeeds the return value is the stream handle, a value greater or equal zero. If the function fails the return value is a negative error code.

See also CreateXFAStream function in DynaPDF manual.

DynaPDFMBS.DecryptPDF(File as folderitem, PwdType as Integer, Password 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
This function decrypts a PDF file by using the supplied password to decrypt the file.

Some examples using this method:

See also DecryptPDF function in DynaPDF manual.

DynaPDFMBS.DecryptPDFAnsi(Path as string, PwdType as Integer, Password as string) as Integer   Deprecated

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 12.2 ✅ 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 decrypts a PDF file by using the supplied password to decrypt the file.

Same as DecryptPDF, but takes path name in Windows ANSI encoding.

See also DecryptPDF function in DynaPDF manual.

DynaPDFMBS.DeleteAcroForm

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 9.8 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Deletes an acrobat reader form.

See also DeleteAcroForm function in DynaPDF manual.

DynaPDFMBS.DeleteActionFromObj(ObjType as Integer, ActHandle as Integer, ObjHandle 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 deletes an action from a PDF object.

See also DeleteActionFromObj function in DynaPDF manual.

DynaPDFMBS.DeleteActionFromObjEx(ObjType as Integer, ObjHandle as Integer, ActIndex 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 delete an action from an object without using an action handle.

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