SolidFramework.PageRange Class Reference

Represents a page range More...

Inheritance diagram for SolidFramework.PageRange:

Public Member Functions
virtual void	Dispose ()
	PageRange (SolidFramework.PagesArray range)
	Initializes a new instance of the PageRange class. More...
	PageRange (SolidFramework.Plumbing.Document document)
	Initializes a new instance of the PageRange class. More...
	PageRange (SolidFramework.Plumbing.Document document, SolidFramework.Plumbing.PageRanges pageRangeSet)
	Initializes a new instance of the PageRange class. More...
SolidFramework.PagesArray	ToArray (int maxPagesInDocument)
	Return the complete array of integer page numbers after Parse is called. More...
bool	ContainsPage (int page, int maxPagesInDocument)
bool	ContainsPage (int page)
override string	ToString ()
bool	Equals (SolidFramework.PageRange other)
override bool	Equals (object obj)
override int	GetHashCode ()

Static Public Member Functions
static SolidFramework.PageRange	Parse (string range)
	Parses a PageRange from the specified string or throws an exception if it can't be parsed. More...
static bool	TryParse (string range, out PageRange result)
	Attempts to parse a PageRange from the specified string. More...
static bool	operator== (SolidFramework.PageRange obj1, SolidFramework.PageRange obj2)
static bool	operator!= (SolidFramework.PageRange obj1, SolidFramework.PageRange obj2)

Properties
int	Count [get]
	Gets the page count
int	First [get]
	Gets the first number of page More...
int	Last [get]
	Gets the last number of page

Detailed Description

Represents a page range

Constructor & Destructor Documentation

PageRange() [1/3]

SolidFramework.PageRange.PageRange

(

SolidFramework.PagesArray

range

)

Initializes a new instance of the PageRange class.

Parameters

range

The range.

PageRange() [2/3]

SolidFramework.PageRange.PageRange

(

SolidFramework.Plumbing.Document

document

)

Initializes a new instance of the PageRange class.

Parameters

document

The document.

PageRange() [3/3]

SolidFramework.PageRange.PageRange	(	SolidFramework.Plumbing.Document	document,
		SolidFramework.Plumbing.PageRanges	pageRangeSet
	)

Initializes a new instance of the PageRange class.

Parameters

document	The document.
pageRangeSet	The page range set.

Member Function Documentation

Parse()

static SolidFramework.PageRange SolidFramework.PageRange.Parse ( string  range )

static

Parses a PageRange from the specified string or throws an exception if it can't be parsed.

Parameters

range

The string to parse.

Returns

The PageRange that was parsed from the string.

ToArray()

SolidFramework.PagesArray SolidFramework.PageRange.ToArray

(

int

maxPagesInDocument

)

Return the complete array of integer page numbers after Parse is called.

NOTE: This is a stop gap to allow multiple page ranges like 1-3,4,6-10 used by a couple sample apps like PDFtoImage.

Parameters

maxPagesInDocument

Max page in the document. Uses if page range set to "all", "even", "odd" or "3-" for bounding of array. Set it to -1 if array already bounded (set "1-5").

Returns

int[] of page numbers.

TryParse()

static bool SolidFramework.PageRange.TryParse ( string  range, out PageRange  result  )

static

Attempts to parse a PageRange from the specified string.

Parameters

range	The string to parse.
result	A PageRange to store the result into. This will be set to null if range couldn't be parsed.

Returns

true if range was parsed successfully; otherwise, false.

Property Documentation

First

int SolidFramework.PageRange.First

get

Gets the first number of page

Returns

The number of the first page in the range.