Platforms to show: All Mac Windows Linux Cross-Platform

Back to DynaPDFMBS class.

Previous items Next items

DynaPDFMBS.IterateBookmarks as DynaPDFIteratorMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 23.5 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Iterate over bookmarks.
Example 
Var d As New DynaPDFMBS

For Each Bookmark As DynaPDFBookmarkMBS In d.IterateBookmarks
  
  Var Name As String = Bookmark.Title
  
  Break
Next

The value is a DynaPDFBookmarkMBS object.

DynaPDFMBS.IterateCMaps as DynaPDFIteratorMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 23.5 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Iterate over character maps.
Example 
Var d As New DynaPDFMBS

For Each CMap As DynaPDFCMapMBS In d.IterateCMaps
  
  Var Name As String = CMap.CMapName
  
  Break
Next

The value is a DynaPDFCMapMBS object.

DynaPDFMBS.IterateColorSpaces as DynaPDFIteratorMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 23.5 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Iterate over Colorspaces.
Example 
Var d As New DynaPDFMBS

For Each ColorSpace As DynaPDFColorSpaceMBS In d.IterateColorSpaces
  
  Var Name As String = ColorSpace.Name
  
  Break
Next

The value is a DynaPDFColorSpaceMBS object.

DynaPDFMBS.IterateEmbeddedFiles(Decompress as boolean = false) as DynaPDFIteratorMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 23.5 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Iterate over embedded files.
Example 
Var d As New DynaPDFMBS

For Each fileSpace As DynaPDFFileSpecMBS In d.IterateEmbeddedFiles
  
  Var Name As String = fileSpace.Name
  
  Break
Next

The value is a DynaPDFFileSpecMBS object.

DynaPDFMBS.IterateErrLogMessages as DynaPDFIteratorMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 23.5 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Iterate over error log messages.
Example 
Var d As New DynaPDFMBS

For Each Error As DynaPDFErrorMBS In d.IterateErrLogMessages
  
  Var Name As String = Error.Message
  
  Break
Next

The value is a DynaPDFErrorMBS object.

DynaPDFMBS.IterateFields as DynaPDFIteratorMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 23.5 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Iterate over fields.
Example 
Var d As New DynaPDFMBS

For Each Field As DynaPDFFieldExMBS In d.IterateFields
  
  Var Name As String = Field.FieldName
  
  Break
Next

The value is a DynaPDFFieldExMBS object.

DynaPDFMBS.IterateFonts as DynaPDFIteratorMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 23.5 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Iterate over fonts.
Example 
Var d As New DynaPDFMBS

Call d.CreateNewPDF

Call d.Append
Call d.SetFont("Geneva")

// now we can find fonts like Helvetica (default) and our Geneva
For Each Font As DynaPDFFontMBS In d.IterateFonts
  
  Var Name As String = Font.FontName
  
  Break
Next

The value is a DynaPDFFontMBS object.

DynaPDFMBS.IterateImages(ImageFlags as Integer = 0) as DynaPDFIteratorMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 23.5 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Iterate over images.
Example 
Var d As New DynaPDFMBS

// load a PDF here or add pages with images

For Each Image As DynaPDFImageMBS In d.IterateImages
  
  Var Buffer As String = Image.Buffer
  
  Break
Next

The value is a DynaPDFImageMBS object.

DynaPDFMBS.IterateLayerConfigurations as DynaPDFIteratorMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 23.5 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Iterate over layer configurations.
Example 
Var d As New DynaPDFMBS

// load a PDF here or add pages with layers

For Each layer As DynaPDFOCLayerConfigMBS In d.IterateLayerConfigurations
  
  Var Name As String = layer.Name
  
  Break
Next

The value is a DynaPDFOCLayerConfigMBS object.

DynaPDFMBS.IterateNamedDestinations as DynaPDFIteratorMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 23.5 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Iterate over named destinations.
Example 
Var d As New DynaPDFMBS

// load a PDF here or add pages with named destinations

For Each dest As DynaPDFNamedDestMBS In d.IterateNamedDestinations
  
  Var Name As String = dest.Name
  
  Break
Next

The value is a DynaPDFNamedDestMBS object.

DynaPDFMBS.IterateOCGs as DynaPDFIteratorMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 23.5 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Iterate over OCGs.
Example 
Var d As New DynaPDFMBS

// load a PDF here or add pages with layers

For Each layer As DynaPDFOCGMBS In d.IterateOCGs
  
  Var IsVisible As Boolean = layer.IsVisible
  
  Break
Next

The value is a DynaPDFOCGMBS object.

DynaPDFMBS.IterateOutputIntents as DynaPDFIteratorMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 23.5 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Iterate over output intents.
Example 
Var d As New DynaPDFMBS

// load a PDF here or add output intent

For Each OutputIntent As DynaPDFOutputIntentMBS In d.IterateOutputIntents
  
  Var RegistryName As String = OutputIntent.RegistryName
  
  Break
Next

The value is a DynaPDFOutputIntentMBS object.

DynaPDFMBS.IteratePageAnnotations as DynaPDFIteratorMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 23.5 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Iterate over page annotations.
Example 
Var d As New DynaPDFMBS

// load a PDF here or add annotation

For Each Annotation As DynaPDFAnnotationExMBS In d.IteratePageAnnotations
  
  Var Name As String = Annotation.Name
  
  Break
Next

The value is a DynaPDFAnnotationExMBS object.

DynaPDFMBS.IteratePageLabels as DynaPDFIteratorMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 23.5 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Iterate over page labels.
Example 
Var d As New DynaPDFMBS

// load a PDF here or add page labels

For Each PageLabel As DynaPDFPageLabelMBS In d.IteratePageAnnotations
  
  Var Prefix As String = PageLabel.Prefix
  
  Break
Next

The value is a DynaPDFPageLabelMBS object.

DynaPDFMBS.IterateSysFonts as DynaPDFIteratorMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 23.5 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Iterate over system fonts.
Example 
Var d As New DynaPDFMBS

For Each Font As DynaPDFSysFontMBS In d.IterateSysFonts
  
  Var Name As String = Font.FullName
  
  Break
Next

The value is a DynaPDFSysFontMBS object.

DynaPDFMBS.IterateXFAStreams as DynaPDFIteratorMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 23.5 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Iterate over XFA Streams.
Example 
Var d As New DynaPDFMBS

// load a PDF here or add a XFAStream

For Each XFAStream As DynaPDFXFAStreamMBS In d.IterateXFAStreams
  
  Var Nmae As String = XFAStream.Name
  
  Break
Next

The value is a DynaPDFXFAStreamMBS object.

DynaPDFMBS.LineAnnot(x1 as Double, y1 as Double, x2 as Double, y2 as Double, LineWidth as Double, StartLineEndStyle as Integer, EndLineEndStyle as Integer, FillColor as UInt32, StrokeColor as UInt32, ColorSpace as Integer, Author as string, Subject as string, Content as string) as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 14.0 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Adds a line annotation.

Some examples using this method:

See also LineAnnot function in DynaPDF manual.

DynaPDFMBS.LineAnnotAnsi(x1 as Double, y1 as Double, x2 as Double, y2 as Double, LineWidth as Double, StartLineEndStyle as Integer, EndLineEndStyle as Integer, FillColor as UInt32, StrokeColor as UInt32, ColorSpace as Integer, Author as string, Subject as string, Content as string) as Integer   Deprecated

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 14.0 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
This item is deprecated and should no longer be used. You can use the non ANSI function instead.
Adds a line annotation.

See also LineAnnot function in DynaPDF manual.

DynaPDFMBS.LineTo(PosX as Double, PosY 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 draws a path from the current position up to the specified point.
Example 
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

// black
call pdf.SetStrokeColor 0

// line down
call pdf.MoveTo(100,100)
call pdf.LineTo(200,200)
call pdf.StrokePath

// line up
call pdf.MoveTo(200,200)
call pdf.LineTo(300,100)
call pdf.StrokePath

// end page
call pdf.EndPage

// Close page
call pdf.CloseFile

// Open PDF
f.Launch

See also LineTo function in DynaPDF manual.

DynaPDFMBS.LoadCMap(CMapName as string, Embed as Boolean) as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 10.1 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Loads a character map.

See also LoadCMap function in DynaPDF manual.

DynaPDFMBS.LoadFDFData(FileName as folderitem, Password as string, Flags as Integer) as Boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 9.4 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Loads PDF form data from the given PDF file.

See also LoadFDFData function in DynaPDF manual.

DynaPDFMBS.LoadFDFDataEx(Buffer as memoryblock, Password as string, Flags as Integer) as Boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 13.0 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Loads PDF form data from the given PDF file in the buffer.

See also:

See also LoadFDFDataEx function in DynaPDF manual.

DynaPDFMBS.LoadFDFDataEx(Buffer as string, Password as string, Flags as Integer) as Boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 9.4 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Loads PDF form data from the given PDF file in the buffer.

See also:

See also LoadFDFDataEx function in DynaPDF manual.

DynaPDFMBS.LoadFont(Buffer as memoryblock, Style as Integer, size as Double, Embed as Boolean = false, CodePage as Integer = 2, CollectionIndex as UInt32 = 0) as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 13.0 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
The function loads a font from a file buffer.

Added CollectionIndex parameter in 12.1 plugin version.

See also:

See also LoadFont function in DynaPDF manual.

DynaPDFMBS.LoadFont(Buffer as string, Style as Integer, size as Double, Embed as Boolean = false, CodePage as Integer = 2, CollectionIndex as UInt32 = 0) as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 12.1 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
The function loads a font from a file buffer.

Added CollectionIndex parameter in 12.1 plugin version.

See also:

See also LoadFont function in DynaPDF manual.

DynaPDFMBS.LoadFontEx(File as folderitem, Style as Integer, size as Double, Embed as Boolean = false, CodePage as Integer = 2, CollectionIndex as UInt32 = 0) as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 12.1 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
The function loads a font from a font file and activates it in the graphics state if the function was called within an open page or template.

See also:

See also LoadFontEx function in DynaPDF manual.

DynaPDFMBS.LoadFontEx(Filepath as string, Style as Integer, size as Double, Embed as Boolean = false, CodePage as Integer = 2, CollectionIndex as UInt32 = 0) as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 12.1 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
The function loads a font from a font file and activates it in the graphics state if the function was called within an open page or template.

See also:

See also LoadFontEx function in DynaPDF manual.

DynaPDFMBS.LoadLayerConfig(Index as Integer) as Boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 17.5 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Loads the specified layer configuration.

A PDF file that contains layers (Optional Content Groups in PDF syntax) contains usually at least a default configuration dictionary. This configuration is loaded by default when the visibility state of a layer or optional content group must be determined, e.g. when rendering a page.
Use this function to load another configuration if available. To determine the number of available configurations call GetLayerConfigCount().

The paramter Index can be one of the following:

  • -1: Load the default configuration.
  • -2: If a configuration was already loaded, leave it unchanged. Load
  • the default configuration otherwise.
  • 0..Count -1: Load the specified configuration.

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

See also LoadLayerConfig function in DynaPDF manual.

DynaPDFMBS.LockLayer(layer as UInt32) as boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 12.4 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Unlocks a layer.

See also LockLayer function in DynaPDF manual.

DynaPDFMBS.MarkTemplateAsWatermark(TemplateHandle as Integer) as Boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 23.3 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Marks template as watermark.

The function adds additional metadata to a template (XObject type Form in PDF terms, see BeginTemplate() or BeginTransparencyGroup() for further information) so that PDF editors like Adobe Acrobat are able to identify the template as watermark.

Watermarks can be deleted with Acrobat and many other PDF editors. DynaPDF can delete such watermarks too with DeleteWatermark() or Optimize().

Returns true on success or false on failure.

See also MarkTemplateAsWatermark function in DynaPDF manual.

DynaPDFMBS.MovePage(source as Integer, dest 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 moves a page to another position in the document.

See also MovePage function in DynaPDF manual.

DynaPDFMBS.MoveTo(PosX as Double, PosY 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 moves the current position to the point specified by PosX, PosY.
Example 
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

// black
call pdf.SetStrokeColor 0

// line down
call pdf.MoveTo(100,100)
call pdf.LineTo(200,200)
call pdf.StrokePath

// line up
call pdf.MoveTo(200,200)
call pdf.LineTo(300,100)
call pdf.StrokePath

// end page
call pdf.EndPage

// Close page
call pdf.CloseFile

// Open PDF
f.Launch

See also MoveTo function in DynaPDF manual.

DynaPDFMBS.OpenImportBuffer(Buffer as Memoryblock, PwdType as Integer = 0, Password as string = "") as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
method DynaPDF MBS DynaPDF Plugin 13.0 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
The function reads an external PDF from a file buffer so that it can be imported entirely or parts of it.

Requires DynaPDF Lite license.

See also:

Some examples using this method:

See also OpenImportBuffer function in DynaPDF manual.

DynaPDFMBS.OpenImportBuffer(Buffer as string, PwdType as Integer = 0, 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
The function reads an external PDF from a file buffer so that it can be imported entirely or parts of it.

Requires DynaPDF Lite license.

See also:

See also OpenImportBuffer function in DynaPDF manual.

DynaPDFMBS.OpenImportFile(File as folderitem, PwdType as Integer = 0, 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
The function opens an external PDF file so that it can be imported entirely or parts of it.

Requires DynaPDF Lite license.

See also:

Some examples using this method:

See also OpenImportFile function in DynaPDF manual.

DynaPDFMBS.OpenImportFile(Path as String, PwdType as integer = 0, Password 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 opens an external PDF file so that it can be imported entirely or parts of it.

Requires DynaPDF Lite license.

See also:

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