Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
web:pdf [2020/02/22 02:03]
agcyphers [Notes]
web:pdf [2020/02/22 02:06] (current)
agcyphers [Methods]
Line 27: Line 27:
 ==== Methods ==== ==== Methods ====
 ^ Definition      ^ Description       ^ ^ Definition      ^ Description       ^
-| AddBezier( StartX as Double, StartY as Double, X1 as Double, Y1 as Double, X2 as Double, Y2 as Double, X3 as Double, Y3 as Double ) | Add a bezier curve to the PDF. | +| AddBezier( StartX as Double, StartY as Double, _ \\ X1 as Double, Y1 as Double, _ \\ X2 as Double, Y2 as Double, _ \\ X3 as Double, Y3 as Double ) | Add a bezier curve to the PDF. | 
-| AddCircle( X as Double, Y as Double, Radius as Double, hasFill as Boolean = False, hasStroke as Boolean = False ) | Add a circle to the PDF. | +| AddCircle( X as Double, Y as Double, _ \\ Radius as Double, _ \\ hasFill as Boolean = False, hasStroke as Boolean = False ) | Add a circle to the PDF. | 
-| AddEllipse( X as Double, Y as Double, RadiusX as Double, RadiusY as Double, hasFill as Boolean = False, hasStroke as Boolean = False ) | Add an ellipse to the PDF. |+| AddEllipse( X as Double, Y as Double, _ \\ RadiusX as Double, RadiusY as Double, _ \\ hasFill as Boolean = False, hasStroke as Boolean = False ) | Add an ellipse to the PDF. |
 | AddHTML( HTMLContent as String, W as Integer = 1200 ) | Add HTML to the PDF.  W is the width of the area to render on. | | AddHTML( HTMLContent as String, W as Integer = 1200 ) | Add HTML to the PDF.  W is the width of the area to render on. |
-| AddImage( PictureData as String, Type as String, X as Double, Y as Double, W as Double = - 1, H as Double = - 1 ) | Add an image to the PDF.  PictureData should be a BASE64 compatible URI string. | +| AddImage( PictureData as String, Type as String, _ \\ X as Double, Y as Double, _ \\ W as Double = - 1, H as Double = - 1 ) | Add an image to the PDF.  PictureData should be a BASE64 compatible URI string. | 
-| AddLine( X1 as Double, Y1 as Double, X2 as Double, Y2 as Double, hasFill as Boolean = False, hasStroke as Boolean = False ) | Draws a line on the PDF. |+| AddLine( X1 as Double, Y1 as Double, _ \\ X2 as Double, Y2 as Double, _ \\ hasFill as Boolean = False, hasStroke as Boolean = False ) | Draws a line on the PDF. |
 | AddPage( W as Double = 210, H as Double = 297 ) | Adds a page to the PDF.  W and H are dimensions. | | AddPage( W as Double = 210, H as Double = 297 ) | Adds a page to the PDF.  W and H are dimensions. |
-| AddRect( X as Double, Y as Double, W as Double, H as Double, hasFill as Boolean = False, hasStroke as Boolean = False ) | Draws a rectangle on the PDF. | +| AddRect( X as Double, Y as Double, _ \\ W as Double, H as Double, _ \\ hasFill as Boolean = False, hasStroke as Boolean = False ) | Draws a rectangle on the PDF. | 
-| AddRoundedRect( X as Double, Y as Double, W as Double, H as Double, RadiusX as Double, RadiusY as Double, hasFill as Boolean = False, hasStroke as Boolean = False ) | Draws a rounded rectangle on the PDF. |+| AddRoundedRect( X as Double, Y as Double, _ \\ W as Double, H as Double, _ \\ RadiusX as Double, RadiusY as Double, _ \\ hasFill as Boolean = False, hasStroke as Boolean = False ) | Draws a rounded rectangle on the PDF. |
 | AddTable( Data as GraffitiWebPDFTable ) | Draws a table on the PDF. | | AddTable( Data as GraffitiWebPDFTable ) | Draws a table on the PDF. |
 | AddText( theContent as String, X as Integer, Y as Integer, BlockWidth as Double = -1 ) | Draws text on the PDF. | | AddText( theContent as String, X as Integer, Y as Integer, BlockWidth as Double = -1 ) | Draws text on the PDF. |
-| AddTriangle( X1 as Double, Y1 as Double, X2 as Double, Y2 as Double, X3 as Double, Y3 as Double, hasFill as Boolean = False, hasStroke as Boolean = False ) | Draws a triangle on the PDF. |+| AddTriangle( X1 as Double, Y1 as Double, _ \\ X2 as Double, Y2 as Double, _ \\ X3 as Double, Y3 as Double, _ \\ hasFill as Boolean = False, hasStroke as Boolean = False ) | Draws a triangle on the PDF. |
 | Download( Filename as String ) | Constructs the PDF and sends it to the browser for download. | | Download( Filename as String ) | Constructs the PDF and sends it to the browser for download. |
-| FromHTML( theHTML as String,DocumentOrientation as String = "portrait", DocumentUnits as String = "pt", DocumentFormat as String = "letter", Margin as Double = 0 ) | Creates a PDF from an HTML string. |+| FromHTML( theHTML as String,DocumentOrientation as String = "portrait", _ \\ DocumentUnits as String = "pt", DocumentFormat as String = "letter", _ \\ Margin as Double = 0 ) | Creates a PDF from an HTML string. |
 | GetTable( tableID as String ) As GraffitiWebPDFTable | Gets an added table object. | | GetTable( tableID as String ) As GraffitiWebPDFTable | Gets an added table object. |
 | LoadInViewer( theViewer as WebHTMLViewer, theContent as String ) | Will load the output of the PDFOutput event in to a WebHTMLViewer. | | LoadInViewer( theViewer as WebHTMLViewer, theContent as String ) | Will load the output of the PDFOutput event in to a WebHTMLViewer. |
-| NewDocument( DocumentOrientation as String = "portrait", DocumentUnits as String = "mm", DocumentFormat as String = "A4" ) | Start a new PDF document. |+| NewDocument( DocumentOrientation as String = "portrait", _ \\ DocumentUnits as String = "mm", _ \\ DocumentFormat as String = "A4" ) | Start a new PDF document. |
 | Output() | Tell GraffitiWebPDF to compile and output the data. | | Output() | Tell GraffitiWebPDF to compile and output the data. |
 | Save() ''Deprecated'' | Tells GraffitiWebPDF to compile the PDF data and prompt the user for download. This method has been deprecated as it may not behave properly across all browsers. | | Save() ''Deprecated'' | Tells GraffitiWebPDF to compile the PDF data and prompt the user for download. This method has been deprecated as it may not behave properly across all browsers. |
Line 57: Line 57:
 | SetLineWidth( W as Double ) | Sets the thickness of lines drawn after calling this method. | | SetLineWidth( W as Double ) | Sets the thickness of lines drawn after calling this method. |
 | SetPage( PageNumber as Integer ) | Changes the currently selected page within the document. | | SetPage( PageNumber as Integer ) | Changes the currently selected page within the document. |
-| SetProperties( Title as String, Subject as String = "", Author as String = "", Keywords as String = "", Creator as String = "GraffitiWebPDF" ) | Sets the properties of the current document. |+| SetProperties( Title as String, Subject as String = "", _ \\ Author as String = "", Keywords as String = "", _ \\ Creator as String = "GraffitiWebPDF" ) | Sets the properties of the current document. |
 | SetStrokeColor( theColor as Color ) | Changes the stroke color for items added to the document after this method is called. |  | SetStrokeColor( theColor as Color ) | Changes the stroke color for items added to the document after this method is called. | 
 | SetStrokeColor( Gray as Integer ) | ::: | | SetStrokeColor( Gray as Integer ) | ::: |