Show / Hide Table of Contents

Class PDFDocGenerator

A collection of static methods to create blank documents

Inheritance
object
PDFDocGenerator
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: pdftron.PDF
Assembly: PDFTronDotNet.dll
Syntax
public static class PDFDocGenerator

Methods

GenerateBlankPaperDoc(double, double, double, double, double)

Create a new document with one page of blank paper.

Declaration
public static PDFDoc GenerateBlankPaperDoc(double width, double height, double background_red, double background_green, double background_blue)
Parameters
Type Name Description
double width

The page width in inches

double height

The page height in inches

double background_red

The red component of the background color

double background_green

The green component of the background color

double background_blue

The blue component of the background color

Returns
Type Description
PDFDoc

GenerateGraphPaperDoc(double, double, double, double, double, int, double, double, double, double, double, double)

Create a new document with one page of graph paper.

Declaration
public static PDFDoc GenerateGraphPaperDoc(double width, double height, double grid_spacing, double line_thickness, double weighted_line_thickness, int weighted_line_freq, double red, double green, double blue, double background_red, double background_green, double background_blue)
Parameters
Type Name Description
double width

The page width in inches

double height

The page height in inches

double grid_spacing

The grid spacing in inches

double line_thickness

The line thickness in points

double weighted_line_thickness

The weighted line thickness in points

int weighted_line_freq

Ratio of weighted lines to normal lines

double red

The red component of the line color

double green

The green component of the line color

double blue

The blue component of the line color

double background_red

The red component of the background color

double background_green

The green component of the background color

double background_blue

The blue component of the background color

Returns
Type Description
PDFDoc

GenerateGridPaperDoc(double, double, double, double, double, double, double, double, double, double)

Create a new document with one page of grid paper.

Declaration
public static PDFDoc GenerateGridPaperDoc(double width, double height, double grid_spacing, double line_thickness, double red, double green, double blue, double background_red, double background_green, double background_blue)
Parameters
Type Name Description
double width

The page width in inches

double height

The page height in inches

double grid_spacing

The grid spacing in inches

double line_thickness

The line thickness in points

double red

The red component of the line color

double green

The green component of the line color

double blue

The blue component of the line color

double background_red

The red component of the background color

double background_green

The green component of the background color

double background_blue

The blue component of the background color

Returns
Type Description
PDFDoc

GenerateLinedPaperDoc(double, double, double, double, double, double, double, double, double, double, double, double, double, double, double, double, double, double, double)

Create a new document with one page of lined paper.

Declaration
public static PDFDoc GenerateLinedPaperDoc(double width, double height, double line_spacing, double line_thickness, double red, double green, double blue, double left_margin_distance, double left_margin_red, double left_margin_green, double left_margin_blue, double right_margin_red, double right_margin_green, double right_margin_blue, double background_red, double background_green, double background_blue, double top_margin_distance, double bottom_margin_distance)
Parameters
Type Name Description
double width

The page width in inches

double height

The page height in inches

double line_spacing

The line spacing in inches

double line_thickness

The line thickness in points

double red

The red component of the line color

double green

The green component of the line color

double blue

The blue component of the line color

double left_margin_distance

Distance of the margin from the left side of the page

double left_margin_red

The red component of the left margin color

double left_margin_green

The green component of the left margin color

double left_margin_blue

The blue component of the left margin color

double right_margin_red

The red component of the right margin color

double right_margin_green

The green component of the right margin color

double right_margin_blue

The blue component of the right margin color

double background_red

The red component of the background color

double background_green

The green component of the background color

double background_blue

The blue component of the background color

double top_margin_distance

Distance of the margin from the top of the page

double bottom_margin_distance

Distance of the margin from the bottom of the page

Returns
Type Description
PDFDoc

GenerateMusicPaperDoc(double, double, double, int, double, double, double, double, double, double, double, double)

Create a new document with one page of music paper.

Declaration
public static PDFDoc GenerateMusicPaperDoc(double width, double height, double margin, int staves, double linespace_size_pts, double line_thickness, double red, double green, double blue, double background_red, double background_green, double background_blue)
Parameters
Type Name Description
double width

The page width in inches

double height

The page height in inches

double margin

The page margin in inches

int staves

Amount of staves on the page.

double linespace_size_pts

The space between lines in points

double line_thickness

The line thickness in points

double red

The red component of the line color

double green

The green component of the line color

double blue

The blue component of the line color

double background_red

The red component of the background color

double background_green

The green component of the background color

double background_blue

The blue component of the background color

Returns
Type Description
PDFDoc
In This Article
Back to top Generated by DocFX