SolidFramework.Forms.PageView Class Reference

A Page View is a user control that when loaded with a Page Model will display the PDF document. Scrolling and zooming (using Ctrl plus the mouse wheel). are automatically supported. While it is possible to search within the open pages, this is more easily achieved using the PdfViewer control. More...

Inheritance diagram for SolidFramework.Forms.PageView:

Public Member Functions
void	selection_Changed (object sender, SelectionChangedEvent e)
string	GetSelectedText ()
	Gets whatever text has been selected within the PageView control. This may be located in multiple separate areas within the document. More...
void	SelectText (Rectangle screenSelectionRect)
void	SelectTextWithRect (Rectangle screenSelectionRect)
void	search_Changed (object sender, SearchChangedEvent e)
bool	SetCurrentFoundTextByIndexAbs (int selectedIndex)
	This method is provides suppport for the PdfViewer class. it is not intended that it will be called from end-user code. More...
bool	NextFoundText ()
	Shows the next occurrence of matched text, scrolling the document so that the occurrence is visible. If no match is found then does nothing. More...
bool	PreviousFoundText ()
	Shows the previous occurrence of matched text, scrolling the document so that the occurrence is visible. If no match is found then does nothing. More...
void	SearchText (string str, bool matchCase, bool matchWholeWord)
	Searches the visible pages within the pages model for the specified text. More...
void	StopSearch ()
	Terminats the current search if one is in progress.
void	EnsureVisible (PdfPage pdfCurrentPage, RectangleF pdfVisibleBound)
	Scrolling the document so that the page and rectangle are visible. More...
	PageView ()
	Initializes a new instance of the PageView class.
delegate void	MethodSizeArgument (Size size)
void	SetAutoScrollMinSize (Size size)
delegate void	MethodPointArgument (Point point)
void	SetAutoScrollPosition (Point point)
RectangleF	GetPageRectangle (int targetPageIndex)
void	EnsureVisible (int pageIndex)
void	ClearSelection ()
	Clears the selection.
void	ClearSelection (bool withEvent)
	Clears the selection. More...
void	DrawString (Graphics graphics, float x, float y, float emSize, String text, Color textColor)
	Draws the string. More...
void	SetZoom (float zoom)
float	GetCurrentZoom ()
	Gets the current zoom. More...
bool	ZoomToMarque (RectangleF marque)
	Zooms to marque. More...
delegate void	MethodTabArgument (DocumentPropertiesTab tab)
void	DocumentProperties (DocumentPropertiesTab tab)

Properties
PagesModel	Model [getset]
	Gets or sets the model. More...
PageMagnification?	PageMagnification [getset]
	Gets or sets the page magnification. More...
PageLayout?	PageLayout [getset]
	Gets or sets the page layout. More...
int	CurrentPage [getset]
	Gets or sets the current page. More...
DraggerState	DraggerState [getset]
	Gets or sets the state of the dragger. More...
PointF	Origin [get]
	Gets the origin. More...

Events
EventHandler< SearchChangedEvent >	SearchChanged = null
EventHandler< MarqueEventArgs >	MarqueeSelected
	Occurs when [marquee selected].
EventHandler< EventArgs >	PagesChanged
	Occurs when pages changed.
EventHandler< EventArgs >	PositionChanged
	Occurs when view position changed.

Detailed Description

A Page View is a user control that when loaded with a Page Model will display the PDF document. Scrolling and zooming (using Ctrl plus the mouse wheel). are automatically supported. While it is possible to search within the open pages, this is more easily achieved using the PdfViewer control.

Member Function Documentation

ClearSelection()

void SolidFramework.Forms.PageView.ClearSelection

(

bool

withEvent

)

Clears the selection.

Parameters

withEvent

if set to true with event.

DrawString()

void SolidFramework.Forms.PageView.DrawString	(	Graphics	graphics,
		float	x,
		float	y,
		float	emSize,
		String	text,
		Color	textColor
	)

Draws the string.

Parameters

graphics	The graphics.
x	The x.
y	The y.
emSize	Size of the em.
text	The text.
textColor	Color of the text.

EnsureVisible()

void SolidFramework.Forms.PageView.EnsureVisible	(	PdfPage	pdfCurrentPage,
		RectangleF	pdfVisibleBound
	)

Scrolling the document so that the page and rectangle are visible.

Parameters

pdfCurrentPage
pdfVisibleBound

GetCurrentZoom()

float SolidFramework.Forms.PageView.GetCurrentZoom

(

)

Gets the current zoom.

Returns

GetSelectedText()

string SolidFramework.Forms.PageView.GetSelectedText

(

)

Gets whatever text has been selected within the PageView control. This may be located in multiple separate areas within the document.

Returns

A string containing whatever text has been selected.

NextFoundText()

bool SolidFramework.Forms.PageView.NextFoundText

(

)

Shows the next occurrence of matched text, scrolling the document so that the occurrence is visible. If no match is found then does nothing.

Returns

true if another match was found; otherwise false.

PreviousFoundText()

bool SolidFramework.Forms.PageView.PreviousFoundText

(

)

Shows the previous occurrence of matched text, scrolling the document so that the occurrence is visible. If no match is found then does nothing.

Returns

true if another match was found; otherwise false.

SearchText()

void SolidFramework.Forms.PageView.SearchText	(	string	str,
		bool	matchCase,
		bool	matchWholeWord
	)

Searches the visible pages within the pages model for the specified text.

Parameters

str	Text to search for.
matchCase	Specifies whether matches should be case sensitive.
matchWholeWord	Specifies whether matches should require that the found words exactly match the search string.

SetCurrentFoundTextByIndexAbs()

bool SolidFramework.Forms.PageView.SetCurrentFoundTextByIndexAbs

(

int

selectedIndex

)

This method is provides suppport for the PdfViewer class. it is not intended that it will be called from end-user code.

Parameters

selectedIndex

Index of the match to scroll to.

Returns

ZoomToMarque()

bool SolidFramework.Forms.PageView.ZoomToMarque

(

RectangleF

marque

)

Zooms to marque.

Parameters

marque

The marque.

Returns

Property Documentation

CurrentPage

int SolidFramework.Forms.PageView.CurrentPage

getset

Gets or sets the current page.

The current page.

DraggerState

DraggerState SolidFramework.Forms.PageView.DraggerState

getset

Gets or sets the state of the dragger.

The state of the dragger.

Model

PagesModel SolidFramework.Forms.PageView.Model

getset

Gets or sets the model.

The model.

Origin

PointF SolidFramework.Forms.PageView.Origin

get

Gets the origin.

The origin.

PageLayout

PageLayout? SolidFramework.Forms.PageView.PageLayout

getset

Gets or sets the page layout.

The page layout.

PageMagnification

PageMagnification? SolidFramework.Forms.PageView.PageMagnification

getset

Gets or sets the page magnification.

The page magnification.