DynaPDFMBS.DecryptPDF(File as folderitem, PwdType as Integer, Password as string) as Integer

Some examples using this method:

• /DynaPDF/Encrypt existing PDF

See also DecryptPDF function in DynaPDF manual.

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

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

See also DecryptPDF function in DynaPDF manual.

DynaPDFMBS.DeleteAcroForm

See also DeleteAcroForm function in DynaPDF manual.

DynaPDFMBS.DeleteActionFromObj(ObjType as Integer, ActHandle as Integer, ObjHandle as Integer) as Boolean

See also DeleteActionFromObj function in DynaPDF manual.

DynaPDFMBS.DeleteActionFromObjEx(ObjType as Integer, ObjHandle as Integer, ActIndex as Integer) as Boolean

See also DeleteActionFromObjEx function in DynaPDF manual.

DynaPDFMBS.DeleteAltFontList(FontListHandle as Integer) as Boolean

If the parameter Handle was set to -1 all available lists will be deleted.
Returns true on success.

See also DeleteAltFontList function in DynaPDF manual.

DynaPDFMBS.DeleteAnnotation(Handle as Integer) as Boolean

See also DeleteAnnotation function in DynaPDF manual.

DynaPDFMBS.DeleteAnnotationFromPage(PageNum as UInt32, Handle as UInt32) as boolean

See also DeleteAnnotationFromPage function in DynaPDF manual.

DynaPDFMBS.DeleteAppEvents(ApplyEvent as Boolean, TOCAppEvent as Integer) as Integer

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

See also DeleteBookmark function in DynaPDF manual.

DynaPDFMBS.DeleteDPartNode(Handle as Integer) as Boolean

The deletes a dpart node or the entire dpart structure if Handle was set to -1. DPart stands for Document Parts, a feature of PDF/VT. If the dpart node contains children then all child nodes will be deleted too.

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

See also DeleteDPartNode function in DynaPDF manual.

DynaPDFMBS.DeleteEmbeddedFile(handle as Integer) as boolean

See also DeleteEmbeddedFile function in DynaPDF manual.

DynaPDFMBS.DeleteField(Field as Integer) as Boolean

See also DeleteField function in DynaPDF manual.

DynaPDFMBS.DeleteFieldEx(URL as string) as Boolean

See also DeleteFieldEx function in DynaPDF manual.

DynaPDFMBS.DeleteJavaScripts(DelJavaScriptActions as boolean)

See also DeleteJavaScripts function in DynaPDF manual.

DynaPDFMBS.DeleteNamedDest(Name as String) as Boolean

If Name is an empty string all named destinations will be deleted.

See also DeleteNamedDest function in DynaPDF manual.

DynaPDFMBS.DeleteNamedDestByIndex(Index as integer) as Boolean

If Index is set to a negative value all named destinations will be deleted.

See also DeleteNamedDestByIndex function in DynaPDF manual.

DynaPDFMBS.DeleteOCGFromAppEvent(Handle as UInt32, Events as Integer, Categories as Integer, DelCategoryOnly as Boolean) as Boolean

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.DeleteOCGFromDisplayTree(OCGHandle as UInt32, Recursive as Boolean) as Boolean

Notice:
If the PDF file was not imported with ImportPDFFile() the function ImportOCProperties() must be called in order to import the global Optional Content Properties.
It is also required to load a layer configuration with LoadLayerConfig() before the function can be called.

The display tree is a linked list that contains UI nodes. UI stands for User Interface. Every node in this tree can contain an OCG or an array of OCGs with an optional label.
This function can be used to delete an OCG from the display tree without traversing every node of it with GetOCUINode() beforehand. Therefore, the function is suitable for console applications but GUI based applications should use DeleteOCUINode() instead. DeleteOCUINode() can also be used to delete the entire display tree with just one function call.

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

See also DeleteOCGFromDisplayTree function in DynaPDF manual.

DynaPDFMBS.DeleteOCUINode(OCGNodeHandle as Integer) as Boolean

Deletes an OCUINode (Optional Content User Interface Node) from the display tree of the currently active layer configuration or the entire tree if Node is set to 0.

If the PDF file was not imported with ImportPDFFile() the function ImportOCProperties() must be called in order to import the global Optional Content Properties.
It is also required to load a layer configuration with LoadLayerConfig() before the function can be called.

Note that the deletion of the display tree does not delete any layer or OCG (Optional Content Group). All OCGs still exists and are fully functional. However, users are not able to change the visibility state of OCGs which are not included in the display tree of the corresponding layer configuration.

If the parameter Node is set then it must be a valid pointer of an OCUINode that was returned by GetOCUINode(). Note that the deletion of a node invalidates all pointers which were previously returned by GetOCUINode().

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

See also DeleteOCUINode function in DynaPDF manual.

DynaPDFMBS.DeleteOutputIntent(Index as Integer) as Integer

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 Integer

// new PDF
Var pdf As New MyDynapdfMBS

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

// create output file
Var outFile As folderitem = SpecialFolder.Desktop.Child("NewPDF.pdf")
Call pdf.CreateNewPDF(outFile)

// set flags to import all
Var flags As Integer = Bitwise.BitOr(pdf.kifImportAsPage, pdf.kifImportAll)
Call pdf.SetImportFlags(flags)

// import PDF
Var 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

Used to return boolean value up to version 24.2.
Changed in version 24.3 to return integer. Negative number for errors or positive number with the number of pages left.

See also DeletePage function in DynaPDF manual.

DynaPDFMBS.DeletePageLabels

See also DeletePageLabels function in DynaPDF manual.

DynaPDFMBS.DeleteSeparationInfo(AllPages as boolean) as boolean

See also DeleteSeparationInfo function in DynaPDF manual.

DynaPDFMBS.DeleteTemplate(handle as Integer) as Boolean

See also DeleteTemplate function in DynaPDF manual.

DynaPDFMBS.DeleteTemplateEx(index as Integer) as Boolean

See also DeleteTemplateEx function in DynaPDF manual.

DynaPDFMBS.DeleteWatermark(PageNum as Integer, InclAnnots as Boolean) as Integer

The function can be used to delete watermarks from a single page or from the entire document if PageNum is set to -1. If InclAnnots is true, watermark annotations will be deleted too, if any.
A watermark in PDF terms is a regular template that has a ADBE_CompoundType property of type Watermark. Such templates can be created with the Watermark tool of Adobes Acrobat, or with DynaPDF, for example. See MarkTemplateAsWatermark() for further information.
Return values:
If the function succeeds the return value is the number of deleted watermarks. Note that deleted watermark annotations do not increment the return value. If the function fails, the return value is a negative error code.

See also DeleteWatermark function in DynaPDF manual.

DynaPDFMBS.DeleteXFAForm

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

Some examples using this method:

• /DynaPDF/Font Test

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

Var pdf as new DynaPDFMBS
Var 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

Some examples using this method:

• /DynaPDF/Create PDF with Arc
• /DynaPDF/Font Test

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

Some examples using this method:

• /DynaPDF/Font Test

See also DrawChord function in DynaPDF manual.

DynaPDFMBS.DrawCircle(PosX as Double, PosY as Double, Radius as Double, FillMode as Integer) as Boolean

Var pdf as new DynaPDFMBS
Var 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

Some examples using this method:

• /DynaPDF/Create PDF with Circle
• /DynaPDF/Create PDF with Circle Text
• /DynaPDF/Create PDF with Colors
• /DynaPDF/Create PDF with object2d
• /DynaPDF/Font Test
• /DynaPDF/separation color

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

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

Some examples using this method:

• /DynaPDF/Font Test

See also DrawPie function in DynaPDF manual.