DynaPDFMBS.GetOCG(Handle as UInt32) as DynaPDFOCGMBS

An OCG handle is a simple array index. You can loop over all available OCGs from 0 to GetOCGCount - 1.
If the member HaveContUsage is true, the OCG contains a Content Usage dictionary. The contents of this dictionary can be accessed with the function GetOCGContUsage. A Content Usage dictionary contains additional information about a layer or OCG.

If the OCG is also included in an application event, this is the case if AppEvent is non-zero, then the Content Usage dictionary is used to control the visibility state of the layer. The member Categories specifies which categories control the visibility state.

Returns nil on any error.

Some examples using this method:

• /DynaPDF/OCG/OCG Test

See also GetOCG function in DynaPDF manual.

DynaPDFMBS.GetOCGContUsage(Handle as UInt32) as DynaPDFOCGContUsageMBS

If the OCG is not included in an application event, then the contents in this dictionary serves as pure information.
If the OCG is included in one or more application events, then these settings control also the visibility state of the OCG. The function GetOCG returns the events and categories which control the layer visibility.
If UserNamesCount is greater zero, the dictionary contains also user names. The user names can be accessed with GetOCGUsageUserName.


Returns nil on any error.

See also GetOCGContUsage function in DynaPDF manual.

DynaPDFMBS.GetOCGCount as Integer

This function cannot fail, the return value is always greater or equal zero.

Some examples using this method:

• /DynaPDF/OCG/OCG Test

See also GetOCGCount function in DynaPDF manual.

DynaPDFMBS.GetOCGUsageUserName(Handle as UInt32, Index as UInt32, byref Name as String) as Boolean

The functions a pointer of the original string that is stored in the PDF file.
If the function succeeds the return value is true. If the function fails the return value is false.

See also GetOCGUsageUserName function in DynaPDF manual.

DynaPDFMBS.GetOCUINode(Node as Integer) as DynaPDFOCUINodeMBS

If the PDF file was not already imported with ImportPDFFile() the function ImportOCProperties() must be called to import the global Optional Content Properties.
UI nodes are part of a layer configuration. Therefore, a layer configuration must be loaded with LoadLayerConfig() before the function can be called.

Optional Content Groups (OCGs) which are returned by this function should be visible in the user interface of a viewer application. All other OCGs should not be shown by default.
UI nodes are stored in a single linked list. To get the pointer of the root node set the parameter Node to 0. The parameter OutNode will be ignored in this case but it is required otherwise.
The next node of the root is in the NextItem property. If no further node is available the return value will be 0.
Every node can contain one or more child nodes, an optional label, or a reference to an OCG.

See also GetOCUINode function in DynaPDF manual.

DynaPDFMBS.GetOpacity as Double

See also GetOpacity function in DynaPDF manual.

DynaPDFMBS.GetOrientation as Integer

Some examples using this method:

• /DynaPDF/Rotate PDF Pages

See also GetOrientation function in DynaPDF manual.

DynaPDFMBS.GetOutputIntent(Index as Integer) as DynaPDFOutputIntentMBS

An output intent is an ICC profile that describes the characteristics of the output device. The profile is mostly embedded but certain standards like PDF/X 4p, for example, allow also the usage of non-embedded profiles.

The parameter Index is the array index of the output intent. To determine the number of available intents call GetOutputIntentCount.

Returns nil in case of error.

See also GetOutputIntent function in DynaPDF manual.

DynaPDFMBS.GetOutputIntentCount as Integer

See also GetOutputIntentCount function in DynaPDF manual.

DynaPDFMBS.GetPage(PageNum as UInt32) as DynaPDFPageMBS

If you like to open a page for editing, please use editpage function.

Some examples using this method:

• /DynaPDF/DynaPDF PDF Viewer
• /DynaPDF/Object Actions
• /DynaPDF/PDF Viewer Example
• /DynaPDF/Raster/DynaPDF Display PDF
• /DynaPDF/Raster/DynaPDF Raster to MemoryBlock
• /DynaPDF/Raster/Render Tests/Render Test 4
• /DynaPDF/Raster/updatewindow event/Display PDF
• /DynaPDF/Tables/Dynamic Table/DynaPDF Table Multi Page
• /DynaPDF/Text Positions with parser
• /DynaPDF/Web Edition/WebPDF Web

DynaPDFMBS.GetPageAnnot(index as Integer) as DynaPDFAnnotationMBS   Deprecated

See also GetPageAnnot function in DynaPDF manual.

DynaPDFMBS.GetPageAnnotCount as Integer

See also GetPageAnnotCount function in DynaPDF manual.

DynaPDFMBS.GetPageAnnotEx(index as Integer) as DynaPDFAnnotationExMBS

See also GetPageAnnotEx function in DynaPDF manual.

DynaPDFMBS.GetPageColorSpaces as DynaPDFColorSpaceMBS()

Color spaces used for drawing colors (Stroke and Fill Color) and for image color space.
The list may be empty if for example everything is drawn in standard color spaces like RGB.

Some examples using this method:

• /DynaPDF/Show ColorSpaces

DynaPDFMBS.GetPageCoords as Integer

The native coordinate system of the Portable Document Format is bottom up.

Some examples using this method:

• /DynaPDF/Create PDF with Angle Rectangles

See also GetPageCoords function in DynaPDF manual.

DynaPDFMBS.GetPageCount as Integer

Some examples using this method:

• /DynaPDF/Create PDF with DPart Metadata
• /DynaPDF/Find and Replace
• /DynaPDF/Merge PDF documents with page numbers
• /DynaPDF/Parse PDF Content
• /DynaPDF/Parse PDF Content iOS
• /DynaPDF/PDF Viewer Example
• /DynaPDF/Raster/Batch Convert PDF to JPG
• /DynaPDF/Raster/Search and show PDF files
• /DynaPDF/Rotate PDF Pages
• /DynaPDF/Text extraction

See also GetPageCount function in DynaPDF manual.

DynaPDFMBS.GetPageField(Index as Integer) as DynaPDFFieldMBS   Deprecated

See also GetPageField function in DynaPDF manual.

DynaPDFMBS.GetPageFieldCount as Integer

See also GetPageFieldCount function in DynaPDF manual.

DynaPDFMBS.GetPageFieldEx(Index as Integer) as DynaPDFFieldExMBS

The parameter Index must be a valid index to the page's field array. To enumerate the fields of a page execute the function in a loop from 0 to GetPageFieldCount - 1.

See also GetPageFieldEx function in DynaPDF manual.

DynaPDFMBS.GetPageHeight as Double

Some examples using this method:

• /DynaPDF/ComplexText/Complex Text
• /DynaPDF/Create PDF with centimeters
• /DynaPDF/Create PDF with Layers Languages
• /DynaPDF/Create PDF with PictureMBS
• /DynaPDF/Create PDF with text block fonts
• /DynaPDF/Create PDF with vertical text
• /DynaPDF/Font Test
• /DynaPDF/Million pages test/Import page 1000000
• /DynaPDF/place centered/place centered
• /DynaPDF/StyledText Editor

See also GetPageHeight function in DynaPDF manual.

DynaPDFMBS.GetPageLabel(index as Integer, byref Label as DynaPDFPageLabelMBS) as boolean

See also GetPageLabel function in DynaPDF manual.

DynaPDFMBS.GetPageLabelCount as Integer

See also GetPageLabelCount function in DynaPDF manual.

DynaPDFMBS.GetPageLayout as Integer

See also GetPageLayout function in DynaPDF manual.

DynaPDFMBS.GetPageMode as Integer

See also GetPageMode function in DynaPDF manual.

DynaPDFMBS.GetPageNum as Integer

See also GetPageNum function in DynaPDF manual.

DynaPDFMBS.GetPageText(stack as DynaPDFStackMBS) as boolean

InitStack must be called before you use GetPageText.


If you have problems with asian characters, please make sure you use SetCMapDir and load the CMAPs.
Requires DynaPDF Pro license.

Some examples using this method:

• /DynaPDF/Extract text
• /DynaPDF/text editing/delete text
• /DynaPDF/text editing/replace text
• /DynaPDF/Text extraction

See also GetPageText function in DynaPDF manual.

DynaPDFMBS.GetPageWidth as Double

Some examples using this method:

• /DynaPDF/ComplexText/Font Substitution
• /DynaPDF/Create PDF with Angle Text
• /DynaPDF/Create PDF with Annotations
• /DynaPDF/Create PDF with object2d
• /DynaPDF/Create PDF with Picture file
• /DynaPDF/Letter/Letter with writeftext
• /DynaPDF/Letter/Letter with writeftext and two pages template
• /DynaPDF/Letter/Web Letter
• /DynaPDF/text formatting/text formatting parallel
• /DynaPDF/text formatting/text formatting Unicode

See also GetPageWidth function in DynaPDF manual.

DynaPDFMBS.GetPDFVersion as Integer

Zero stand for PDF 1.0, one for PDF 1.1 and so on.

See also GetPDFVersion function in DynaPDF manual.

DynaPDFMBS.GetPDFVersionEx as DynaPDFVersionInfoMBS

Dim d As New DynaPDFMBS
Dim v As DynaPDFVersionInfoMBS = d.GetPDFVersionEx

Break // check in debugger

Result includes:

Major	PDF major version, e.g. 1
Minor	PDF minor version, e.g. 7
MainVer	Set only if the file conforms to a specific PDF standard, e.g. "PDF/X // 1a:2003", "PDF/A 3b", and so on.
SubVer	e.g. "ZUGFeRD 2.0", "Factur-X", and so on

Returns nil in case of an error.

See also GetPDFVersionEx function in DynaPDF manual.

DynaPDFMBS.GetPrintSettings as DynaPDFPrintSettingsMBS

This is a PDF 1.7 extension.

See also GetPrintSettings function in DynaPDF manual.

DynaPDFMBS.GetResetAction(Handle as UInt32) as DynaPDFResetFormActionMBS

See also GetResetAction function in DynaPDF manual.

DynaPDFMBS.GetResolution as Integer

See also GetResolution function in DynaPDF manual.

DynaPDFMBS.GetSaveNewImageFormat as boolean

See also GetSaveNewImageFormat function in DynaPDF manual.

DynaPDFMBS.GetSeparationInfo(byref Colorant as string, byref ColorSpace as Integer) as boolean

See also GetSeparationInfo function in DynaPDF manual.

DynaPDFMBS.GetStrokeColor as Integer

See also GetStrokeColor function in DynaPDF manual.

DynaPDFMBS.GetSubmitAction(Handle as UInt32) as DynaPDFSubmitFormActionMBS

Returns nil in case of an error.

See also GetSubmitAction function in DynaPDF manual.

DynaPDFMBS.GetSysFontInfo as DynaPDFSysFontMBS

// list all fonts
dim d as new DynaPDFMBS

dim f as DynaPDFSysFontMBS = d.GetSysFontInfo
while f<>nil
  Listbox1.AddRow f.FamilyName
  
  f = f.NextFont
wend

The function returns the fonts in the current font search order. That means if the search order is {fbtTrueType, fbtOpenType, fbtType1, fbtStdFont}, for example, then the function returns first all TrueType fonts sorted in ascending order, then all OpenType fonts, and so on.
Since standard fonts are no system fonts, these fonts are not returned.

See also:

• GetSysFontInfo(PostscriptName as String) as DynaPDFSysFontMBS

Some examples using this method:

• /DynaPDF/Tables/Table showing all fonts

See also GetSysFontInfo function in DynaPDF manual.

DynaPDFMBS.GetSysFontInfo(PostscriptName as String) as DynaPDFSysFontMBS

dim d as new DynaPDFMBS

// find one font with postscript name
dim font as DynaPDFSysFontMBS = d.GetSysFontInfo("Verdana-BoldItalic")

// find all with family name
dim fonts() as DynaPDFSysFontMBS = d.GetSysFontInfos("Verdana")

Break // see in debugger

Returns nil if font is not found.

See also:

• GetSysFontInfo as DynaPDFSysFontMBS

See also GetSysFontInfo function in DynaPDF manual.

DynaPDFMBS.GetSysFontInfos as DynaPDFSysFontMBS()

dim pdf as new MyDynaPDFMBS

// get all fonts
dim fonts() as DynaPDFSysFontMBS = pdf.GetSysFontInfos

// add one row for each font
for each f as DynaPDFSysFontMBS in fonts
  
  dim name as string = f.FamilyName
  
  if f.BaseType = pdf.kfbtOpenType and f.CIDOrdering = "" then
    // This font cannot be used with Unicode
    
  else
    // Anything is ok
  end if
  
next

The function returns the fonts in the current font search order. That means if the search order is {fbtTrueType, fbtOpenType, fbtType1, fbtStdFont}, for example, then the function returns first all TrueType fonts sorted in ascending order, then all OpenType fonts, and so on.
Since standard fonts are no system fonts, these fonts are not returned.

See also:

• GetSysFontInfos(Name as String) as DynaPDFSysFontMBS()

Some examples using this method:

• /DynaPDF/Fonts Mapping
• /DynaPDF/Fonts Mapping with NSFont
• /DynaPDF/Show SysFont Fonts
• /DynaPDF/Tables/Table showing all fonts

DynaPDFMBS.GetSysFontInfos(Name as String) as DynaPDFSysFontMBS()

dim d as new DynaPDFMBS

// find one font with postscript name
dim font as DynaPDFSysFontMBS = d.GetSysFontInfo("Verdana-BoldItalic")

// find all with family name
dim fonts() as DynaPDFSysFontMBS = d.GetSysFontInfos("Verdana")

Break // see in debugger

Matchs fonts by family name, full name or Postscript name.

The function returns the fonts in the current font search order. That means if the search order is {fbtTrueType, fbtOpenType, fbtType1, fbtStdFont}, for example, then the function returns first all TrueType fonts sorted in ascending order, then all OpenType fonts, and so on.
Since standard fonts are no system fonts, these fonts are not returned.

See also:

• GetSysFontInfos as DynaPDFSysFontMBS()

DynaPDFMBS.GetTabLen as Integer

See also GetTabLen function in DynaPDF manual.

DynaPDFMBS.GetTemplCount as Integer

Some examples using this method:

• /DynaPDF/Text extraction

See also GetTemplCount function in DynaPDF manual.

DynaPDFMBS.GetTemplHandle as Integer

Some examples using this method:

• /DynaPDF/Text extraction

See also GetTemplHandle function in DynaPDF manual.

DynaPDFMBS.GetTemplHeight(Handle as Integer) as Double

Some examples using this method:

• /ChartDirector/Place PDF Chart with DynaPDF
• /DynaPDF/DynaPDF Merge 2 to 1
• /DynaPDF/Rotate rotated PDF back

See also GetTemplHeight function in DynaPDF manual.

DynaPDFMBS.GetTemplWidth(Handle as Integer) as Double

If the function succeeds the return value is the width of the template. If the function fails the return value is a negative error code.

Some examples using this method:

• /ChartDirector/Place PDF Chart with DynaPDF
• /DynaPDF/DynaPDF Merge 2 to 1
• /DynaPDF/Rotate rotated PDF back

See also GetTemplWidth function in DynaPDF manual.

DynaPDFMBS.GetTextDrawMode as Integer

See also GetTextDrawMode function in DynaPDF manual.

DynaPDFMBS.GetTextFieldValue(Field as Integer, byref Value as string, byref DefValue as string) as Boolean

The strings may be ANSI or Unicode encoded.

See also GetTextFieldValue function in DynaPDF manual.

DynaPDFMBS.GetTextHeight(Align as Integer, aText as string) as Double

dim pdf as DynaPDFMBS // your PDF instance

dim text as string = "Hello \ul#World"

dim h1 as Integer = pdf.GetTextHeight(pdf.ktaLeft, text)
dim h2 as Integer = pdf.GetFTextHeight(pdf.ktaLeft, text)

dim h3 as Integer = pdf.GetTextHeightEx(150, pdf.ktaLeft, text)
dim h4 as Integer = pdf.GetFTextHeightEx(150, pdf.ktaLeft, text)

// see different heights in debugger.

GetTextHeight does escape backslashes so no formatting commands are taken from the string.
The text parameter is converted to unicode.

DynaPDFMBS.GetTextHeightAnsi(Align as Integer, aText as string) as Double   Deprecated

GetTextHeightAnsi does escape backslashes so no formatting commands are taken from the string.

The text parameter is converted to ANSI.

DynaPDFMBS.GetTextHeightEx(Width as Double, Align as Integer, aText as string) as Double

dim pdf as new MyDynaPDFMBS

call pdf.CreateNewPDF nil
call pdf.Append

call pdf.SetFont("Helvetica", pdf.kfsnone, 12, true, pdf.kcpUnicode)

dim h as Double = pdf.GetTextHeightEx(100, pdf.ktaLeft, "Hello World. Just a test string.")

MsgBox "height: "+str(h)

call pdf.EndPage
call pdf.CloseFile

GetTextHeightEx does escape backslashes so no formatting commands are taken from the string.
The text parameter is converted to unicode.

Some examples using this method:

• /DynaPDF/Create PDF with text block2