VectSharp.Page Class Reference

Represents a Graphics object with a width and height. More...

Public Member Functions
	Page (double width, double height)
	Create a new page. More...
void	Crop (Rectangle region, bool removeClippedGraphics=false, string tag=null)
	Translate and resize the Page so that it displays the specified region . More...
void	Crop (Point topLeft, Size size, bool removeClippedGraphics=false, string tag=null)
	Translate and resize the Page so that it displays the rectangle defined by topLeft and size . More...
void	Crop (string tag=null)
	Translate and resize the Page so that it displays the rectangle corresponding to the bounding box of its contents. More...

Properties
double	Width [get, set]
	Width of the page. More...
double	Height [get, set]
	Height of the page. More...
Graphics	Graphics [get, set]
	Graphics surface of the page. More...
Colour	Background = Colour.FromRgba(255, 255, 255, 0) [get, set]
	Background colour of the page. More...

Detailed Description

Represents a Graphics object with a width and height.

Definition at line 47 of file Document.cs.

Constructor & Destructor Documentation

Page()

VectSharp.Page.Page	(	double	width,
		double	height
	)

Create a new page.

Parameters

width	The width of the page.
height	The height of the page.

Definition at line 74 of file Document.cs.

Member Function Documentation

Crop() [1/3]

void VectSharp.Page.Crop	(	Point	topLeft,
		Size	size,
		bool	removeClippedGraphics = false,
		string	tag = null
	)

Translate and resize the Page so that it displays the rectangle defined by topLeft and size .

Parameters

topLeft	The top left corner of the area to include in the page.
size	The size of the area to include in the page.
removeClippedGraphics	If this is true, graphics actions that fall outside of the specified region are completely removed from the plot, otherwise they are just hidden.
tag	A tag to identify the transform.

Definition at line 101 of file Document.cs.

Crop() [2/3]

void VectSharp.Page.Crop	(	Rectangle	region,
		bool	removeClippedGraphics = false,
		string	tag = null
	)

Translate and resize the Page so that it displays the specified region .

Parameters

region	The area to include in the page.
removeClippedGraphics	If this is true, graphics actions that fall outside of the specified region are completely removed from the plot, otherwise they are just hidden.
tag	A tag to identify the transform.

Definition at line 89 of file Document.cs.

Crop() [3/3]

void VectSharp.Page.Crop

(

string

tag = null

)

Translate and resize the Page so that it displays the rectangle corresponding to the bounding box of its contents.

Parameters

tag	A tag to identify the transform.

Definition at line 129 of file Document.cs.

Property Documentation

Background

Colour VectSharp.Page.Background = Colour.FromRgba(255, 255, 255, 0)

getset

Background colour of the page.

Definition at line 67 of file Document.cs.

Graphics

Graphics VectSharp.Page.Graphics

getset

Graphics surface of the page.

Definition at line 62 of file Document.cs.

Height

double VectSharp.Page.Height

getset

Height of the page.

Definition at line 57 of file Document.cs.

Width

double VectSharp.Page.Width

getset

Width of the page.

Definition at line 52 of file Document.cs.

---

The documentation for this class was generated from the following file:

• VectSharp/Document.cs