Platforms to show: All Mac Windows Linux Cross-Platform
DynaPDFMBS.CreateViewportAnsi(Name as String, X1 as Double, Y1 as Double, X2 as Double, Y2 as Double) as Integer
Function:
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.
| 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 Non ANSI function. instead.
Notes:
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
Function:
The function creates an XFA stream and adds it to the global XFA resource array.
Notes:
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.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 19.5 | Yes | Yes | Yes | Yes | All |
Notes:
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
Function:
This function decrypts a PDF file by using the supplied password to decrypt the file.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 8.0 | Yes | Yes | Yes | Yes | All |
See also DecryptPDF function in DynaPDF manual.
DynaPDFMBS.DecryptPDFAnsi(Path as string, PwdType as Integer, Password as string) as Integer
Function:
This function decrypts a PDF file by using the supplied password to decrypt the file.
| 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 Non ANSI function. instead.
Notes:
Same as DecryptPDF, but takes path name in Windows ANSI encoding.See also DecryptPDF function in DynaPDF manual.
DynaPDFMBS.DeleteAcroForm
Function:
Deletes an acrobat reader form.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 9.8 | Yes | Yes | Yes | Yes | All |
See also DeleteAcroForm function in DynaPDF manual.
DynaPDFMBS.DeleteActionFromObj(ObjType as Integer, ActHandle as Integer, ObjHandle as Integer) as Boolean
Function:
This function deletes an action from a PDF object.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 8.0 | Yes | Yes | Yes | Yes | All |
See also DeleteActionFromObj function in DynaPDF manual.
DynaPDFMBS.DeleteActionFromObjEx(ObjType as Integer, ObjHandle as Integer, ActIndex as Integer) as Boolean
Function:
This function can be used to delete an action from an object without using an action handle.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 8.0 | Yes | Yes | Yes | Yes | All |
See also DeleteActionFromObjEx function in DynaPDF manual.
DynaPDFMBS.DeleteAnnotation(Handle as Integer) as Boolean
Function:
This function deletes an annotation.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 8.0 | Yes | Yes | Yes | Yes | All |
See also DeleteAnnotation function in DynaPDF manual.
DynaPDFMBS.DeleteAnnotationFromPage(PageNum as UInt32, Handle as UInt32) as boolean
Function:
Deletes an annotation from a page.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 17.0 | Yes | Yes | Yes | Yes | All |
See also DeleteAnnotationFromPage function in DynaPDF manual.
DynaPDFMBS.DeleteAppEvents(ApplyEvent as Boolean, TOCAppEvent as Integer) as Integer
Function:
The function deletes all application events if any.
Notes:
The function can optionally apply the visibility state of an event before the application events will be deleted. The new visibility state will be stored in the PDF file. To apply the visibility state of a specific event without deletion call ApplyAppEvent() instead.
If the function succeeds and if application events were deleted the return value is 1. If the no application events were defined the return value is 0. If the function fails the return value is a negative error code.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 16.0 | Yes | Yes | Yes | Yes | All |
Notes:
The function can optionally apply the visibility state of an event before the application events will be deleted. The new visibility state will be stored in the PDF file. To apply the visibility state of a specific event without deletion call ApplyAppEvent() instead.
If the function succeeds and if application events were deleted the return value is 1. If the no application events were defined the return value is 0. If the function fails the return value is a negative error code.
See also DeleteAppEvents function in DynaPDF manual.
DynaPDFMBS.DeleteBookmark(ABmk as Integer) as Integer
Function:
This function deletes a bookmark.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 8.0 | Yes | Yes | Yes | Yes | All |
See also DeleteBookmark function in DynaPDF manual.
DynaPDFMBS.DeleteEmbeddedFile(handle as Integer) as boolean
Function:
Deletes the embedded file with the given handle.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 8.4 | Yes | Yes | Yes | Yes | All |
See also DeleteEmbeddedFile function in DynaPDF manual.
DynaPDFMBS.DeleteField(Field as Integer) as Boolean
Function:
This function deletes an interactive form field.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 8.0 | Yes | Yes | Yes | Yes | All |
See also DeleteField function in DynaPDF manual.
DynaPDFMBS.DeleteFieldEx(URL as string) as Boolean
Function:
This function deletes an interactive form field by using its full qualified name, that is the name of any parent group field separated by a period (.) plus the field name.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 8.0 | Yes | Yes | Yes | Yes | All |
See also DeleteFieldEx function in DynaPDF manual.
DynaPDFMBS.DeleteJavaScripts(DelJavaScriptActions as boolean)
Function:
Deletes java scripts.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 9.8 | Yes | Yes | Yes | Yes | All |
See also DeleteJavaScripts function in DynaPDF manual.
DynaPDFMBS.DeleteOCGFromAppEvent(Handle as UInt32, Events as Integer, Categories as Integer, DelCategoryOnly as Boolean) as Boolean
Function:
Deletes an OCG or layer from one or more application events, or it deletes only one or more categories from an application event in which the OCG was found (if DelCategoryOnly is true).
Notes:
If DelCategoryOnly is true, and if no more categories are left in the application event, then the event will be deleted. See also AddOCGToAppEvent() and SetOCGContUsage() for further information.
If the function succeeds the return value is true. If the function fails the return value is false.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 15.0 | Yes | Yes | Yes | Yes | All |
Notes:
If DelCategoryOnly is true, and if no more categories are left in the application event, then the event will be deleted. See also AddOCGToAppEvent() and SetOCGContUsage() for further information.
If the function succeeds the return value is true. If the function fails the return value is false.
See also DeleteOCGFromAppEvent function in DynaPDF manual.
DynaPDFMBS.DeleteOutputIntent(Index as Integer) as Integer
Function:
Can be used to delete a specific or all output intents.
Notes:
A PDF file can contain more than one output intent. Call GetOutputIntentCount to determine the number of available output intents. If the parameter Index is set to -1 all output intents will be deleted.
If the function succeeds the return value is the remaining number of output intents. If the function fails the return value is a negative error code.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 14.2 | Yes | Yes | Yes | Yes | All |
Notes:
A PDF file can contain more than one output intent. Call GetOutputIntentCount to determine the number of available output intents. If the parameter Index is set to -1 all output intents will be deleted.
If the function succeeds the return value is the remaining number of output intents. If the function fails the return value is a negative error code.
See also DeleteOutputIntent function in DynaPDF manual.
DynaPDFMBS.DeletePage(PageNum as Integer) as Boolean
Function:
This function deletes a page.
Example:
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 8.0 | Yes | Yes | Yes | Yes | All |
Example:
// new PDF
Dim pdf As New MyDynapdfMBS
pdf.SetLicenseKey "Lite" // For this example you can use a Lite, Pro or Enterprise License
// create output file
Dim outFile As folderitem = SpecialFolder.Desktop.Child("NewPDF.pdf")
Call pdf.CreateNewPDF(outFile)
// set flags to import all
Dim flags As Integer = Bitwise.BitOr(pdf.kifImportAsPage, pdf.kifImportAll)
Call pdf.SetImportFlags(flags)
// import PDF
Dim inFile As folderitem = SpecialFolder.Desktop.Child("test.pdf")
Call pdf.OpenImportFile(inFile)
Call pdf.ImportPDFFile(1)
// now delete one page
Call pdf.DeletePage(2)
// close output file
Call pdf.closefile
See also DeletePage function in DynaPDF manual.
DynaPDFMBS.DeletePageLabels
Function:
The function deletes all page labels contained in the current open document, if any.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 8.0 | Yes | Yes | Yes | Yes | All |
See also DeletePageLabels function in DynaPDF manual.
DynaPDFMBS.DeleteSeparationInfo(AllPages as boolean) as boolean
Function:
The function deleted the separation of the current open page or of all pages if the parameter AllPages is set to true.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 8.0 | Yes | Yes | Yes | Yes | All |
See also DeleteSeparationInfo function in DynaPDF manual.
DynaPDFMBS.DeleteTemplate(handle as Integer) as Boolean
Function:
This function deletes a template.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 8.0 | Yes | Yes | Yes | Yes | All |
See also DeleteTemplate function in DynaPDF manual.
DynaPDFMBS.DeleteTemplateEx(index as Integer) as Boolean
Function:
This function deletes a template by using an index instead of a template handle.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 8.0 | Yes | Yes | Yes | Yes | All |
See also DeleteTemplateEx function in DynaPDF manual.
DynaPDFMBS.DeleteXFAForm
Function:
Deletes XFA Form.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 9.8 | Yes | Yes | Yes | Yes | All |
See also DeleteXFAForm function in DynaPDF manual.
DynaPDFMBS.DrawArc(PosX as Double, PosY as Double, Radius as Double, StartAngle as Double, EndAngle as Double) as Boolean
Function:
This function draws an arc by using a start and end angle.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 8.0 | Yes | Yes | Yes | Yes | All |
See also DrawArc function in DynaPDF manual.
DynaPDFMBS.DrawArcEx(PosX as Double, PosY as Double, Width as Double, Height as Double, StartAngle as Double, EndAngle as Double) as Boolean
Function:
This function draws an elliptical arc.
Example:
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 8.0 | Yes | Yes | Yes | Yes | All |
Example:
dim pdf as new DynaPDFMBS
dim f as FolderItem = SpecialFolder.Desktop.Child("Create PDF.pdf")
pdf.SetLicenseKey "Starter" // For this example you can use a Starter, Lite, Pro or Enterprise License
// create new PDF
call pdf.CreateNewPDF f
// We want to use top-down coordinates
call pdf.SetPageCoords pdf.kpcTopDown
// new page
call pdf.Append
// black
call pdf.SetStrokeColor 0
// draw an arc
call pdf.DrawArcEx 100,100,100,100, 90,180
call pdf.StrokePath
// and a second one
call pdf.DrawArcEx 200,200,100,100, 0,90
call pdf.StrokePath
// and a third one. 0 to 0 gives a full circle
call pdf.DrawArcEx 300,300,100,100, 0,0
call pdf.StrokePath
// finish page
call pdf.EndPage
// Close file
call pdf.CloseFile
// open PDF
f.Launch
See also DrawArcEx function in DynaPDF manual.
DynaPDFMBS.DrawChord(PosX as Double, PosY as Double, Width as Double, Height as Double, StartAngle as Double, EndAngle as Double, FillMode as Integer) as Boolean
Function:
This function draws an elliptical chord (a region bounded by the intersection of an ellipse and a line segment, called a secant).
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 8.0 | Yes | Yes | Yes | Yes | All |
See also DrawChord function in DynaPDF manual.
DynaPDFMBS.DrawCircle(PosX as Double, PosY as Double, Radius as Double, FillMode as Integer) as Boolean
Function:
This function draws a circle.
Example:
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 8.0 | Yes | Yes | Yes | Yes | All |
Example:
dim pdf as new DynaPDFMBS
dim f as FolderItem = SpecialFolder.Desktop.Child("Create PDF with Line.pdf")
pdf.SetLicenseKey "Starter" // For this example you can use a Starter, Lite, Pro or Enterprise License
// Create a new PDF
call pdf.CreateNewPDF f
// We want to use top-down coordinates
call pdf.SetPageCoords pdf.kpcTopDown
// Add a page
call pdf.Append
// a circle, filled
call pdf.SetFillColor pdf.RGB(0,255,0) // green
call pdf.DrawCircle(100, 100, 100, pdf.kfmFill)
// a circle, stoked
call pdf.SetStrokeColor pdf.RGB(255,0,0) // red
call pdf.DrawCircle(200, 200, 100, pdf.kfmStroke)
// end page
call pdf.EndPage
// Close page
call pdf.CloseFile
// Open PDF
f.Launch
See also DrawCircle function in DynaPDF manual.
DynaPDFMBS.DrawNGon(PosX as double, PosY as double, Radius as double, Alpha as double, NumSides as Integer, FillMode as integer) as Boolean
Function:
Draws a n-gon.
Notes:
PosX: X-Coordinate of the midpoint of the ngon
PosY: Y-Coordinate of the midpoint of the ngon
Radius: The radius.
Alpha: Rotation angle in degrees
NumSides: Number of sides. Must be greater 2.
FillMode: Fill mode, e.g. kfmFillStroke
The function A n-gon is a polygon with "n" number of sides. The minimum number of sides is three.
A n-gon is a closed path that can be filled, stroked or both. It is also possible to draw a n-gon invisible to apply the filling rules nonzero winding number or even-odd. The filling rules are described at ClipPath(). The parameter FillMode is ignored if the circle is drawn inside a clipping path. The fill modes are described at ClosePath().
If the function succeeds the return value is true. If the function fails the return value is false.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 20.5 | Yes | Yes | Yes | Yes | All |
Notes:
PosX: X-Coordinate of the midpoint of the ngon
PosY: Y-Coordinate of the midpoint of the ngon
Radius: The radius.
Alpha: Rotation angle in degrees
NumSides: Number of sides. Must be greater 2.
FillMode: Fill mode, e.g. kfmFillStroke
The function A n-gon is a polygon with "n" number of sides. The minimum number of sides is three.
A n-gon is a closed path that can be filled, stroked or both. It is also possible to draw a n-gon invisible to apply the filling rules nonzero winding number or even-odd. The filling rules are described at ClipPath(). The parameter FillMode is ignored if the circle is drawn inside a clipping path. The fill modes are described at ClosePath().
If the function succeeds the return value is true. If the function fails the return value is false.
See also DrawNGon function in DynaPDF manual.
DynaPDFMBS.DrawPie(PosX as Double, PosY as Double, Width as Double, Height as Double, StartAngle as Double, EndAngle as Double, FillMode as Integer) as Boolean
Function:
The function draws a pie-shaped wedge bounded by the intersection of an ellipse and two angles.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 8.0 | Yes | Yes | Yes | Yes | All |
See also DrawPie function in DynaPDF manual.
DynaPDFMBS.EditPage(PageNum as Integer) as Boolean
Function:
This function prepares a page for editing.
Example:
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 8.0 | Yes | Yes | Yes | Yes | All |
Example:
dim pdf as DynaPDFMBS // your dynapdf instance
// edit page 1
call pdf.EditPage(1)
// set a font
call pdf.SetFont( "Times New Roman",pdf.kfsNone,46,True,pdf.kcp1252 )
// set a color
call pdf.SetFillColor(0)
// now add a text annotation
call pdf.FreeTextAnnot( 100, 100, 100, 100, "author", "test", 0 )
// end page
call pdf.EndPage
See also EditPage function in DynaPDF manual.
The items on this page are in the following plugins: MBS DynaPDF Plugin.
Links
MBS Xojo Plugins
