Platforms to show: All Mac Windows Linux Cross-Platform
DynaPDFMBS.GetFieldType(Field as Integer) as Integer
Function:
The function returns the field type.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 8.0 | Yes | Yes | Yes | Yes | All |
See also GetFieldType function in DynaPDF manual.
DynaPDFMBS.GetFillColor as Integer
Function:
The function returns the current color used for fillings.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 8.0 | Yes | Yes | Yes | Yes | All |
See also GetFillColor function in DynaPDF manual.
DynaPDFMBS.GetFontCount as Integer
Function:
Queries the font count.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 8.5 | Yes | Yes | Yes | Yes | All |
See also GetFontCount function in DynaPDF manual.
DynaPDFMBS.GetFontEx(index as Integer) as DynaPDFFontMBS
Function:
Queries the font information for the font specified by the index value.
Example:
Returns nil on any error.
Index from 0 to GetFontCount-1.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 8.5 | Yes | Yes | Yes | Yes | All |
Example:
// create PDF object with page
dim pdf as new DynaPDFMBS
call pdf.CreateNewPDF(nil)
call pdf.Append
// draw some text
call pdf.SetFont "Times", pdf.kfsItalic, 40.0, true, pdf.kcp1252
call pdf.WriteFText pdf.ktaCenter, "My first Xojo output!"
// and list all fonts:
dim n as Integer = pdf.GetFontCount-1
for i as Integer = 0 to n
MsgBox pdf.GetFontEx(i).FontName
next
This item is deprecated and should no longer be used.
You can use GetFontInfo instead.
Notes:
Returns nil on any error.
Index from 0 to GetFontCount-1.
DynaPDFMBS.GetFontInfoEx(index as Integer) as DynaPDFFontInfoMBS
Function:
Retrieves the most important properties of a font.
Notes:
This function accepts a font handle instead. A font handle is a simple array index. To enumerate all fonts of a document execute the function in a loop from zero to GetFontCount - 1.
If the function succeeds the return value is font info object. If the function fails the return value is nil.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 14.3 | Yes | Yes | Yes | Yes | All |
Notes:
This function accepts a font handle instead. A font handle is a simple array index. To enumerate all fonts of a document execute the function in a loop from zero to GetFontCount - 1.
If the function succeeds the return value is font info object. If the function fails the return value is nil.
See also GetFontInfoEx function in DynaPDF manual.
DynaPDFMBS.GetFontMetrics(FontHandle as Integer) as DynaPDFFontMetricsMBS
Function:
Queries font metrics for a font handle.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 19.2 | Yes | Yes | Yes | Yes | All |
See also GetFontMetrics function in DynaPDF manual.
DynaPDFMBS.GetFontOrigin as Integer
Function:
The function returns the current font origin.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 8.0 | Yes | Yes | Yes | Yes | All |
See also GetFontOrigin function in DynaPDF manual.
DynaPDFMBS.GetFontSearchOrder as Integer()
Function:
Returns the font search order.
Notes:
The values in the array use this constants:
The array has 4 values.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 10.1 | Yes | Yes | Yes | Yes | All |
Notes:
The values in the array use this constants:
| kfbtTrueType | TrueType, TrueType Collections, or OpenType fonts with TrueType outlines |
| kfbtType1 | Type1 font |
| kfbtOpenType | OpenType font with Postscript outlines |
| kfbtStdFont | PDF Standard font |
| kfbtDisabled | This value can be used to disable a specific font format. |
The array has 4 values.
See also GetFontSearchOrder function in DynaPDF manual.
DynaPDFMBS.GetFontSelMode as Integer
Function:
The function returns the current font selection mode.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 8.0 | Yes | Yes | Yes | Yes | All |
See also GetFontSelMode function in DynaPDF manual.
DynaPDFMBS.GetFontWeight as Integer
Function:
The function returns the weight that will be used to emulate a bold font style.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 8.0 | Yes | Yes | Yes | Yes | All |
See also GetFontWeight function in DynaPDF manual.
DynaPDFMBS.GetFTextHeight(Align as Integer, aText as string) as Double
Function:
The function measures the height of a formatted text block.
Notes: The text parameter is converted to unicode.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 8.0 | Yes | Yes | Yes | Yes | All |
Notes: The text parameter is converted to unicode.
See also GetFTextHeight function in DynaPDF manual.
DynaPDFMBS.GetFTextHeightAnsi(Align as Integer, aText as string) as Double
Function:
The function measures the height of a formatted text block.
| 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 Non ANSI function. instead.
Notes:
The text parameter is converted to ANSI.See also GetFTextHeight function in DynaPDF manual.
DynaPDFMBS.GetFTextHeightEx(Width as Double, Align as Integer, aText as string) as Double
Function:
The function measures the height of a formatted text block.
Notes: The text parameter is converted to unicode.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 8.0 | Yes | Yes | Yes | Yes | All |
Notes: The text parameter is converted to unicode.
See also GetFTextHeightEx function in DynaPDF manual.
DynaPDFMBS.GetFTextHeightExAnsi(Width as Double, Align as Integer, aText as string) as Double
Function:
The function measures the height of a formatted text block.
| 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 Non ANSI function. instead.
Notes:
The text parameter is converted to ANSI.See also GetFTextHeightEx function in DynaPDF manual.
DynaPDFMBS.GetGlyphIndex(Index as UInt32) as Integer
Function:
The function returns the glyph index of the given code page or Unicode index.
Notes:
How Index must be defined depends on the code page with which the font was loaded. For example, if the font was loaded with a 8 bit code page, then indexes below 256 are treated as index into the code page table. Higher indexes are treated as Unicode value in this case. Note that all Unicode encoded glyphs of the font are accessible in this case, also if the font was loaded with a 8 bit code page!
At time of publication the function does not support CJK code pages which require a conversion to Unicode, e.g. cpCJK_Big5_Uni, cpCJK_EUC_JP_Uni, and so on.
If the function succeeds the return value is 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 | 16.2 | Yes | Yes | Yes | Yes | All |
Notes:
How Index must be defined depends on the code page with which the font was loaded. For example, if the font was loaded with a 8 bit code page, then indexes below 256 are treated as index into the code page table. Higher indexes are treated as Unicode value in this case. Note that all Unicode encoded glyphs of the font are accessible in this case, also if the font was loaded with a 8 bit code page!
At time of publication the function does not support CJK code pages which require a conversion to Unicode, e.g. cpCJK_Big5_Uni, cpCJK_EUC_JP_Uni, and so on.
If the function succeeds the return value is greater or equal zero. If the function fails the return value is a negative error code.
See also GetGlyphIndex function in DynaPDF manual.
DynaPDFMBS.GetGlyphOutline(Index as UInt32) as DynaPDFGlyphOutlineMBS
Function:
The function returns the outline of a glyph of the active font.
Notes:
Note that not all glyphs have an outline. A space character, for example, has no outline and therefore the size can be zero. The function returns normalized outlines scaled to a font size of 1000 units.
Please see dynapdf_help.pdf and our example project on how to process the outline data.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 16.2 | Yes | Yes | Yes | Yes | All |
Notes:
Note that not all glyphs have an outline. A space character, for example, has no outline and therefore the size can be zero. The function returns normalized outlines scaled to a font size of 1000 units.
Please see dynapdf_help.pdf and our example project on how to process the outline data.
See also GetGlyphOutline function in DynaPDF manual.
DynaPDFMBS.GetGoToAction(index as Integer, Decompress as Boolean = false, ImageParseFlags as Integer = &h00000080) as DynaPDFGoToActionMBS
Function:
Queries details for a GoToR action.
Notes:
Index is from 0 to GetActionCount-1.
If Decompress is true, all file specification containing compressed data are uncompressed.
And ImageParseFlags defines how GetImageObj is called internally to decompress image. Default is to only get image info, but you can pass other values to actually get image data.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 17.0 | Yes | Yes | Yes | Yes | All |
Notes:
Index is from 0 to GetActionCount-1.
If Decompress is true, all file specification containing compressed data are uncompressed.
And ImageParseFlags defines how GetImageObj is called internally to decompress image. Default is to only get image info, but you can pass other values to actually get image data.
See also GetGoToAction function in DynaPDF manual.
DynaPDFMBS.GetGoToRAction(index as Integer, Decompress as Boolean = false, ImageParseFlags as Integer = &h00000080) as DynaPDFGoToActionMBS
Function:
Queries details for a GoTo action.
Notes:
Index is from 0 to GetActionCount-1.
If Decompress is true, all file specification containing compressed data are uncompressed.
And ImageParseFlags defines how GetImageObj is called internally to decompress image. Default is to only get image info, but you can pass other values to actually get image data.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 17.0 | Yes | Yes | Yes | Yes | All |
Notes:
Index is from 0 to GetActionCount-1.
If Decompress is true, all file specification containing compressed data are uncompressed.
And ImageParseFlags defines how GetImageObj is called internally to decompress image. Default is to only get image info, but you can pass other values to actually get image data.
See also GetGoToRAction function in DynaPDF manual.
DynaPDFMBS.GetGStateFlags as Integer
Function:
The function returns the current graphics state flags.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 8.0 | Yes | Yes | Yes | Yes | All |
See also GetGStateFlags function in DynaPDF manual.
DynaPDFMBS.GetHideAction(index as Integer) as DynaPDFHideActionMBS
Function:
Queries details for a hide action.
Notes: Index is from 0 to GetActionCount-1.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 17.0 | Yes | Yes | Yes | Yes | All |
Notes: Index is from 0 to GetActionCount-1.
See also GetHideAction function in DynaPDF manual.
DynaPDFMBS.GetIconColor as Integer
Function:
The function returns the icon color used for newly created text annotations.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 8.0 | Yes | Yes | Yes | Yes | All |
See also GetIconColor function in DynaPDF manual.
DynaPDFMBS.GetImageBuffer as string
Function:
Returns the image buffer.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 8.6 | Yes | Yes | Yes | Yes | All |
See also GetImageBuffer function in DynaPDF manual.
DynaPDFMBS.GetImageBufferMemory as memoryblock
Function:
Returns the image buffer.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 13.0 | Yes | Yes | Yes | Yes | All |
DynaPDFMBS.GetImageCount(File as folderitem) as Integer
Function:
The function returns the number of images contained in a multi page image.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 8.0 | Yes | Yes | Yes | Yes | All |
See also:
See also GetImageCount function in DynaPDF manual.
DynaPDFMBS.GetImageCount(Path as string) as Integer
Function:
The function returns the number of images contained in a multi page image.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 12.4 | Yes | Yes | Yes | Yes | All |
See also:
See also GetImageCount function in DynaPDF manual.
DynaPDFMBS.GetImageCountEx(Buffer as Memoryblock) as Integer
Function:
The function determines the number of images in a multi-page image in the same way as GetImageCount(), but accepts a file buffer as input.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 13.0 | Yes | Yes | Yes | Yes | All |
See also:
See also GetImageCountEx function in DynaPDF manual.
DynaPDFMBS.GetImageCountEx(Buffer as string) as Integer
Function:
The function determines the number of images in a multi-page image in the same way as GetImageCount(), but accepts a file buffer as input.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 8.0 | Yes | Yes | Yes | Yes | All |
See also:
See also GetImageCountEx function in DynaPDF manual.
DynaPDFMBS.GetImageHeight(Handle as Integer) as Integer
Function:
The function returns the height of an image in pixel.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 8.0 | Yes | Yes | Yes | Yes | All |
See also GetImageHeight function in DynaPDF manual.
DynaPDFMBS.GetImageObj(Handle as UInt32, Flags as Integer) as DynaPDFImageMBS
Function:
The function retrieves the properties of an image as well as the decompressed image buffer if needed.
Notes:
For the flags use the constants: kpfNone, kpfDecomprAllImages, kpfNoJPXDecode, kpfDitherImagesToBW, kpfConvImagesToGray, kpfConvImagesToRGB, kpfConvImagesToCMYK or kpfImageInfoOnly.
By default all images are returned decompressed, with exception of image types which are already stored in a valid file format like JPEG and JPEG 2000 images.
If all image types should be decompressed set the flag kpfDecompressAllImages.
This function allocates memory that should be released with FreeImageObj when finish.
Image handles are simple array indexes. The number of image objects can be determined with GetImageObjCount. Note that this array does not include inline images which are stored in content streams. Such images can only be accessed with ParseContent().
Returns 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 | 14.0 | Yes | Yes | Yes | Yes | All |
Notes:
For the flags use the constants: kpfNone, kpfDecomprAllImages, kpfNoJPXDecode, kpfDitherImagesToBW, kpfConvImagesToGray, kpfConvImagesToRGB, kpfConvImagesToCMYK or kpfImageInfoOnly.
By default all images are returned decompressed, with exception of image types which are already stored in a valid file format like JPEG and JPEG 2000 images.
If all image types should be decompressed set the flag kpfDecompressAllImages.
This function allocates memory that should be released with FreeImageObj when finish.
Image handles are simple array indexes. The number of image objects can be determined with GetImageObjCount. Note that this array does not include inline images which are stored in content streams. Such images can only be accessed with ParseContent().
Returns the function succeeds the return value is true. If the function fails the return value is false.
See also GetImageObj function in DynaPDF manual.
DynaPDFMBS.GetImageObjCount as Integer
Function:
Returns the number of image objects which were loaded with DynaPDF functions or imported from external PDF files.
Notes:
The images can be accessed with GetImageObj().
The return value is the number of image objects. This function cannot fail.
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| method | DynaPDF | MBS DynaPDF Plugin | 14.0 | Yes | Yes | Yes | Yes | All |
Notes:
The images can be accessed with GetImageObj().
The return value is the number of image objects. This function cannot fail.
See also GetImageObjCount function in DynaPDF manual.
The items on this page are in the following plugins: MBS DynaPDF Plugin.
Links
MBS Xojo Chart Plugins
