Xojo Developer Conference
25/27th April 2018 in Denver.
MBS Xojo Conference
6/7th September 2018 in Munich, Germany.

Platforms to show: All Mac Windows Linux Cross-Platform

Previous items Next items

DynaPDFMBS.RotateCoords(alpha as Double, OriginX as Double, OriginY as Double) as Boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 7.6 Yes Yes Yes Yes No
Function: The function rotates the coordinate system at the point OriginX, OriginY by applying a transformation matrix.
Notes:
Also check the dynapdf manual on the pdfRotateCoords function.
Please do not try to scale/skew/translate back later. use SaveGraphicState and RestoreGraphicState.

See also RotateCoords function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.RotateTemplate(OldTemplate as Integer, Rotation as Integer) as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 17.0 Yes Yes Yes Yes No
Function: Rotates a template.
Notes:
Returns a new template handle.
This is a convenience function which creates a new template and draws the existing template there with rotation.
Returns negative number for errors. The plugin uses -1 for plugin errors like wrong rotation angle.

Feedback, Comments & Corrections

DynaPDFMBS.RoundRect(PosX as Double, PosY as Double, Width as Double, Height as Double, Radius as Double, FillMode as Integer) as Boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 7.6 Yes Yes Yes Yes No
Function: The function draws a rectangle with rounded corners.
Example:
dim pdf as new DynaPDFMBS
dim f as FolderItem = SpecialFolder.Desktop.Child("Create PDF with Round Rectangles.pdf")

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

call pdf.CreateNewPDF f
call pdf.Append

dim PosX as Double = 100.0
dim PosY as Double = 100.0
dim Width as Double = 100.0
dim Height as Double = 100.0
dim Radius as Double = 20.0
dim FillMode as Integer = pdf.kfmFill

call pdf.RoundRect(PosX, PosY, Width, Height, Radius, FillMode)

PosX = 300.0
dim RadiusX as Double = 30.0
dim RadiusY as Double = 30.0

call pdf.RoundRectEx(PosX, PosY, Width, Height, RadiusX, RadiusY, FillMode)

call pdf.EndPage
call pdf.CloseFile

f.Launch
Notes: Also check the dynapdf manual on the pdfRoundRect function.

See also RoundRect function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.RoundRectEx(PosX as Double, PosY as Double, Width as Double, Height as Double, rWidth as Double, rHeight as Double, FillMode as Integer) as Boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 7.6 Yes Yes Yes Yes No
Function: The function draws a rectangle with elliptical corners.
Example:
dim pdf as new DynaPDFMBS
dim f as FolderItem = SpecialFolder.Desktop.Child("Create PDF with Round Rectangles.pdf")

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

call pdf.CreateNewPDF f
call pdf.Append

dim PosX as Double = 100.0
dim PosY as Double = 100.0
dim Width as Double = 100.0
dim Height as Double = 100.0
dim Radius as Double = 20.0
dim FillMode as Integer = pdf.kfmFill

call pdf.RoundRect(PosX, PosY, Width, Height, Radius, FillMode)

PosX = 300.0
dim RadiusX as Double = 30.0
dim RadiusY as Double = 30.0

call pdf.RoundRectEx(PosX, PosY, Width, Height, RadiusX, RadiusY, FillMode)

call pdf.EndPage
call pdf.CloseFile

f.Launch
Notes: Also check the dynapdf manual on the pdfRoundRectEx function.

See also RoundRectEx function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.SaveGraphicState as Boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 7.6 Yes Yes Yes Yes No
Function: The function saves the current graphics state.
Notes: Also check the dynapdf manual on the pdfSaveGraphicState function.

See also SaveGraphicState function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.ScaleCoords(sx as Double, sy as Double) as Boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 7.6 Yes Yes Yes Yes No
Function: The function scales the coordinate system by applying a transformation matrix.
Notes:
Also check the dynapdf manual on the pdfScaleCoords function.
Please do not try to scale/skew/translate back later. use SaveGraphicState and RestoreGraphicState.

See also ScaleCoords function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.SelfTest as Boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 7.6 Yes Yes Yes Yes No
Function: The function checks the size of all required data types and checks whether the endian configuration of the library is correct.
Notes: Also check the dynapdf manual on the pdfSelfTest function.

See also SelfTest function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.Set3DAnnotProps(Annot as Integer, ActType as Integer, DeActType as Integer, InstType as Integer, DeInstType as Integer, DisplayToolbar as boolean, DisplayModelTree as boolean) as boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 9.8 Yes Yes Yes Yes No
Function: Sets the properties of a 3D Annotation.

See also Set3DAnnotProps function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.Set3DAnnotScriptAnsi(Annot as Integer, Value as string) as boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 9.8 Yes Yes Yes Yes No
Function: Sets the 3D Annoation Script.

Feedback, Comments & Corrections

DynaPDFMBS.SetAllocBy(Value as Integer) as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 7.6 Yes Yes Yes Yes No
Function: The function sets the size of the memory blocks in kilo bytes, which will be allocated if memory must be allocated for page content streams.
Notes: Also check the dynapdf manual on the pdfSetAllocBy function.

See also SetAllocBy function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.SetAnnotBorderEffect(Handle as Integer, BorderEffect as Integer) as Boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 15.2 Yes Yes Yes Yes No
Function: Sets the border effect for an annotation.
Notes:
Returns true on success.
Handle is in range of 0 to number of annotations - 1.

See also SetAnnotBorderEffect function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.SetAnnotBorderStyle(Handle as Integer, BorderStyle as Integer) as boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 10.4 Yes Yes Yes Yes No
Function: Sets the annotation border style.
Notes: Also check the dynapdf manual on the pdfSetAnnotBorderStyle function.

See also SetAnnotBorderStyle function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.SetAnnotBorderWidth(Handle as Integer, LineWidth as Double) as boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 10.4 Yes Yes Yes Yes No
Function: Sets the annotation border width.
Notes: Also check the dynapdf manual on the pdfSetAnnotBorderWidth function.

See also SetAnnotBorderWidth function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.SetAnnotColor(Handle as Integer, ColorType as Integer, PDFColorSpace as Integer, ColorValue as Integer) as boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 10.4 Yes Yes Yes Yes No
Function: Sets the annotation color.
Notes: Also check the dynapdf manual on the pdfSetAnnotColor function.

See also SetAnnotColor function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.SetAnnotFlags(Flags as Integer) as Boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 7.6 Yes Yes Yes Yes No
Function: The function sets the default flags used for newly created annotations.
Notes: Also check the dynapdf manual on the pdfSetAnnotFlags function.

See also SetAnnotFlags function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.SetAnnotFlagsEx(Handle as Integer, Flags as Integer) as boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 10.4 Yes Yes Yes Yes No
Function: Sets the annotation flags.
Notes: Also check the dynapdf manual on the pdfSetAnnotFlagsEx function.

See also SetAnnotFlagsEx function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.SetAnnotHighlightMode(Handle as Integer, HighlightMode as Integer) as boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 10.4 Yes Yes Yes Yes No
Function: Sets the annotation highlight mode.
Notes: Also check the dynapdf manual on the pdfSetAnnotHighlightMode function.

See also SetAnnotHighlightMode function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.SetAnnotIcon(Handle as Integer, AnnotIcon as Integer) as boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 10.4 Yes Yes Yes Yes No
Function: Sets the annotation icon.
Notes: Also check the dynapdf manual on the pdfSetAnnotIcon function.

See also SetAnnotIcon function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.SetAnnotLineDashPattern(Handle as UInt32, dash as memoryblock, NumValues as integer) as Boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 17.2 Yes Yes Yes Yes No
Function: Sets or deletes the line dash pattern of an annotation.
Notes:
The following annotation types support line dash patterns:
  • atCircle
  • atInk
  • atLine
  • atPolygon
  • atPolyLine
  • atSquare

Memoryblock must contain floating point values (Single).
Returns true on success.

If array is nil, the pattern is removed.

See also:

See also SetAnnotLineDashPattern function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.SetAnnotLineDashPattern(Handle as UInt32, dash() as single) as Boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 17.2 Yes Yes Yes Yes No
Function: Sets or deletes the line dash pattern of an annotation.
Notes:
The following annotation types support line dash patterns:
  • atCircle
  • atInk
  • atLine
  • atPolygon
  • atPolyLine
  • atSquare

Returns true on success.

If array is nil, the pattern is removed.

See also:

See also SetAnnotLineDashPattern function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.SetAnnotLineEndStyle(Handle as UInt32, StartLineStyle as Integer, EndLineStyle as Integer) as boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 14.0 Yes Yes Yes Yes No
Function: The function sets or changes the line end styles of a Line or PolyLine Annotation.
Notes: If the function succeeds the return value is true. If the function fails the return value is false.

See also SetAnnotLineEndStyle function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.SetAnnotMigrationState(Handle as Integer, State as Integer, Name as string) as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 15.4 Yes Yes Yes Yes No
Function: Adds a migration state to a markup annotation.
Notes:
All annotation types with exception of 3D, Link, Movie, Screen, PrinterMark, TrapNet, and Watermark are markup annotations.
Migration states are stored in text annotations as reply to the base annotation. Further states are stored as reply to the last reply; the result is a single linked list. Because the base annotation contains no reference to the last reply or migration state the function must search for it. To speed upprocessing the function returns the handle of the text annotation so that the next state can directly be added to this annotation.

The migration state is defined since PDF 1.5. The function adjusts the PDF version automatically if it is lower than PDF 1.5.

If the function succeeds the return value is the handle of the text annotation, a value greater or equal zero. If the function fails the return value is a negative error code.

State can be kasNone, kasAccepted, kasRejected, kasCancelled, kasCompleted.

See also SetAnnotMigrationState function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.SetAnnotMigrationStateAnsi(Handle as Integer, State as Integer, Name as string) as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 15.4 Yes Yes Yes Yes No
Function: Adds a migration state to a markup annotation.
Notes:
All annotation types with exception of 3D, Link, Movie, Screen, PrinterMark, TrapNet, and Watermark are markup annotations.
Migration states are stored in text annotations as reply to the base annotation. Further states are stored as reply to the last reply; the result is a single linked list. Because the base annotation contains no reference to the last reply or migration state the function must search for it. To speed upprocessing the function returns the handle of the text annotation so that the next state can directly be added to this annotation.

The migration state is defined since PDF 1.5. The function adjusts the PDF version automatically if it is lower than PDF 1.5.

If the function succeeds the return value is the handle of the text annotation, a value greater or equal zero. If the function fails the return value is a negative error code.

State can be kasNone, kasAccepted, kasRejected, kasCancelled, kasCompleted.

Feedback, Comments & Corrections

DynaPDFMBS.SetAnnotOpacity(Handle as Integer, opacity as Double) as Boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 16.0 Yes Yes Yes Yes No
Function: The function changes the opacity of a markup annotation.
Notes:
The function GetAnnotEx() or GetPageAnnotEx() can be used to determine whether an annotation is a markup annotation.

Returns true on succes or false on failure.

See also SetAnnotOpacity function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.SetAnnotOpenState(Handle as Integer, Open as Boolean) as boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 10.4 Yes Yes Yes Yes No
Function: Sets the annotation open state.
Notes: Also check the dynapdf manual on the pdfSetAnnotOpenState function.

See also SetAnnotOpenState function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.SetAnnotOrFieldDate(CSHandle as UInt32, IsField as Boolean, Type as Integer, DateTime as UInt32) as boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 13.5 Yes Yes Yes Yes No
Function: The function sets or changes the creation or modification date of an annotation or form field.
Notes:
If the parameter IsField is set to true, a valid field handle must be passed to the parameter Handle. An annotation handle is expected otherwise.
Annotations and form fields support a modification date but a creation date is supported by markup annotations only.
The following annotation types are markup annotations:
  • Care
  • Circle
  • FileAttach
  • FreeText
  • Highlight, Squiggly, Strikeout, Underline
  • Ink
  • Line
  • Polygon
  • Projection
  • Redact
  • Sound
  • Square
  • Stamp
  • Text
The function GetAnnotEx() or GetPageAnnotEx() can also be used to determine whether an annotation is a markup annotation.

If the function succeeds the return value is 1. If the function fails the return value is 0.

See also SetAnnotOrFieldDate function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.SetAnnotQuadPoints(Handle as UInt32, points() as DynapdfPointMBS) as boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 15.3 Yes Yes Yes Yes No
Function: Sets or changes the quad points defintion of a Highlight, Link, Redakt, Squiggly, atStrikeOut, or Underline annotation.
Notes:
The function must be called within an open page.
Independent of the used coordinate system (bottom up or top down), the points must be defined in the following order:
x1,y1 x3,y3
x2,y2 x4,y4

The coordinates of the vertices are interpreted in current user space. Any transformation that was applied on the coordinate system will be taken into account.
The number of points must be 4 or a multiple of 4.

Returns true on success.

See also SetAnnotQuadPoints function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.SetAnnotString(Handle as Integer, StringType as Integer, Value as string) as boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 9.7 Yes Yes Yes Yes No
Function: Creates a stamp annotation.
Notes: Also check the dynapdf manual on the pdfSetAnnotStringW function.

See also SetAnnotString function in DynaPDF manual.

Feedback, Comments & Corrections

DynaPDFMBS.SetAnnotStringAnsi(Handle as Integer, StringType as Integer, Value as string) as boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 9.7 Yes Yes Yes Yes No
Function: Creates a stamp annotation.
Notes: Also check the dynapdf manual on the pdfSetAnnotStringA function.

Feedback, Comments & Corrections

DynaPDFMBS.SetAnnotSubject(Handle as Integer, Value as string) as Boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method DynaPDF MBS DynaPDF Plugin 7.6 Yes Yes Yes Yes No
Function: The function sets or changes the optional subject string of an annotation.
Notes:
The value parameter is converted to unicode.
Also check the dynapdf manual on the pdfSetAnnotSubjectW function.

See also SetAnnotSubject function in DynaPDF manual.

Feedback, Comments & Corrections

Previous items Next items

The items on this page are in the following plugins: MBS DynaPDF Plugin.




Links
MBS Xojo Plugins