Class PdfDocumentView

PdfDocumentView helps to view and print PDF files.

Inheritance

System.Object

PdfDocumentView

Implements

IThemeProvider

IVisualStyle

Namespace: Syncfusion.Windows.Forms.PdfViewer

Assembly: Syncfusion.PdfViewer.Windows.dll

Syntax

public class PdfDocumentView : UserControl, IPdfDocumentView, IThemeProvider, IVisualStyle

Constructors

PdfDocumentView()

Initializes PdfDocumentView class.

Declaration

public PdfDocumentView()

Properties

BackgroundImage

Gets and Sets the background image for PdfDocumentView

Declaration

public Image BackgroundImage { get; set; }

Property Value

Type
System.Drawing.Image

CanApplyTheme

Gets or sets a value indicating whether a SkinManager theme settings can be applied to the control.

Declaration

public bool CanApplyTheme { get; set; }

Property Value

Type	Description
System.Boolean	The default value is true.

Remarks

This property must be initialized before applying the VisualTheme />

CanGoToFirstPage

Gets a boolean value indicating whether the control can navigate to the first page.

Declaration

public bool CanGoToFirstPage { get; }

Property Value

Type
System.Boolean

CanGoToLastPage

Gets a boolean value indicating whether the control can navigate to the last page.

Declaration

public bool CanGoToLastPage { get; }

Property Value

Type
System.Boolean

CanGoToNextPage

Gets a boolean value indicating whether the control can navigate to the next page.

Declaration

public bool CanGoToNextPage { get; }

Property Value

Type
System.Boolean

CanGoToPreviousPage

Gets a boolean value indicating whether the control can navigate to the previous page.

Declaration

public bool CanGoToPreviousPage { get; }

Property Value

Type
System.Boolean

CanOverrideStyle

Gets or sets a value indicating whether control elements styles can be overridden by theme style settings.

Declaration

public bool CanOverrideStyle { get; set; }

Property Value

Type	Description
System.Boolean	Default value is false.

Remarks

By default, the control's element styles will not be overridden by theme style settings if the style is set in sample level. If this property is enabled, element style will be overridden by theme style settings event if it is set in sample level. This property should be enabled or disabled before calling the ThemeName property of the control.

CurrentPageIndex

Gets the current page index which is currently in view.

Declaration

public int CurrentPageIndex { get; }

Property Value

Type
System.Int32

CursorMode

Gets and sets the Cursor Mode

Declaration

public PdfViewerCursorMode CursorMode { get; set; }

Property Value

Type
PdfViewerCursorMode

DocumentInformation

Gets the information of the PDF document loaded

Declaration

public DocumentInformation DocumentInformation { get; }

Property Value

Type
DocumentInformation

EnableContextMenu

Enables or disables the context menu.

Declaration

public bool EnableContextMenu { get; set; }

Property Value

Type
System.Boolean

HorizontalScrollOffset

Gets or sets the horizontal scroll offset of the control.

Declaration

public int HorizontalScrollOffset { get; set; }

Property Value

Type
System.Int32

IsDocumentLoaded

Returns true, if the PDF document is loaded in PDF viewer control. Default value is false.

Declaration

public bool IsDocumentLoaded { get; }

Property Value

Type
System.Boolean

IsTextSearchEnabled

Gets or sets a value indicating whether text search is enabled. Default value is true.

Declaration

public bool IsTextSearchEnabled { get; set; }

Property Value

Type
System.Boolean

IsTextSelectionEnabled

Gets or sets a value indicating whether text selection is enabled. Default value is true.

Declaration

public bool IsTextSelectionEnabled { get; set; }

Property Value

Type
System.Boolean

IsVisualStyleEnabled

Gets a value indicating whether the visual style based theme is applied to the control and also indicates whether the theme files are referred from external assemblies or not.

Declaration

public bool IsVisualStyleEnabled { get; }

Property Value

Type	Description
System.Boolean	Return true, if the visual style based theme is applied to the control. Otherwise returns false.

LoadedDocument

Returns the loaded document of the PdfDocumentView

Declaration

public PdfLoadedDocument LoadedDocument { get; }

Property Value

Type
PdfLoadedDocument

MessageBoxSettings

Gets and sets the message box settings.

Declaration

public MessageBoxSettings MessageBoxSettings { get; set; }

Property Value

Type
MessageBoxSettings

MinimumZoomPercentage

Gets and sets the minimum zoom percentage. The value should be in between 10 and 400. The default value is 50.

Declaration

public int MinimumZoomPercentage { get; set; }

Property Value

Type
System.Int32

PageBorderThickness

Get or set thickness of the page border. Default value is 1.

Declaration

public int PageBorderThickness { get; set; }

Property Value

Type
System.Int32

PageCount

Gets the page count.

Declaration

public int PageCount { get; }

Property Value

Type
System.Int32

PrintDocument

Gets the print document

Declaration

public PrintDocument PrintDocument { get; }

Property Value

Type
System.Drawing.Printing.PrintDocument

PrinterSettings

Represents printer settings for the document to be printed.

Declaration

public PdfViewerPrinterSettings PrinterSettings { get; set; }

Property Value

Type
PdfViewerPrinterSettings

ReferencePath

Specifes the Pdfium path in PDF Viewer control

Declaration

public string ReferencePath { get; set; }

Property Value

Type
System.String

RenderingEngine

Specifies the renderingMode for PdfViewer.

Declaration

[Obsolete("The SfPdf engine is no longer supported. By default, PDFium engine will be used. So avoid setting the Rendering engine for the PDF Viewer control")]
public PdfRenderingEngine RenderingEngine { get; set; }

Property Value

Type
PdfRenderingEngine

ScrollDisplacementValue

Gets or sets the displacement value for scrolling.

Declaration

public int ScrollDisplacementValue { get; set; }

Property Value

Type
System.Int32

ShowHorizontalScrollBar

Gets and sets the boolean value to show and hide horizontal scrollbar in PdfDocumentView

Declaration

public bool ShowHorizontalScrollBar { get; set; }

Property Value

Type
System.Boolean

ShowVerticalScrollBar

Gets and sets the boolean value to show and hide the vertical scrollbar in PdfDocumentView

Declaration

public bool ShowVerticalScrollBar { get; set; }

Property Value

Type
System.Boolean

SpaceBetweenPages

Defines the page gap between the pages. The minimum value of ‘SpaceBetweenPages’ is 0.

Declaration

public int SpaceBetweenPages { get; set; }

Property Value

Type
System.Int32

Remarks

Default value is 8. The unit of ‘SpaceBetweenPages’ is pixel.

TextSearchSettings

Defines the textsearch settings when searching the text in the document

Declaration

public TextSearchSettings TextSearchSettings { get; set; }

Property Value

Type
TextSearchSettings

ThemeName

Gets or sets the theme name of the control.

Declaration

public string ThemeName { get; set; }

Property Value

Type	Description
System.String	The default value is null.

Remarks

This ThemeStyle settings will be applied only when the VisualStyleBased theme has been applied to the control.

ThemeStyle

Gets or sets the PdfDocumentViewVisualStyle value used to customize the appearance of the PdfDocumentViewControl.

Declaration

public PdfDocumentViewVisualStyle ThemeStyle { get; set; }

Property Value

Type
PdfDocumentViewVisualStyle

VerticalScrollOffset

Gets or sets the vertical scroll offset of the control.

Declaration

public int VerticalScrollOffset { get; set; }

Property Value

Type
System.Int32

VisualStyle

Visual style of the PdfViewerControl.

Declaration

public VisualStyle VisualStyle { get; set; }

Property Value

Type
VisualStyle

ZoomMode

Gets/Sets the Zoom mode.

Declaration

public ZoomMode ZoomMode { get; set; }

Property Value

Type
ZoomMode

ZoomPercentage

Gets the current zoom percentage.

Declaration

public int ZoomPercentage { get; }

Property Value

Type
System.Int32

Methods

Dispose()

Clean up any resources being used.

Declaration

public void Dispose()

Dispose(Boolean)

Clean up any resources being used.

Declaration

protected override void Dispose(bool disposing)

Parameters

Type	Name	Description
System.Boolean	disposing	true if managed resources should be disposed; otherwise, false.

ExportAsImage(Int32)

Exports the specified page as Image

Declaration

public Bitmap ExportAsImage(int pageIndex)

Parameters

Type	Name	Description
System.Int32	pageIndex	The page index to be converted into image

Returns

Type	Description
System.Drawing.Bitmap	Returns the specified page as Image

ExportAsImage(Int32, SizeF, Boolean)

Exports the specified page as Image

Declaration

public Bitmap ExportAsImage(int pageIndex, SizeF customSize, bool keepAspectRatio)

Parameters

Type	Name	Description
System.Int32	pageIndex	The page index to be converted into image
System.Drawing.SizeF	customSize	The custom size of the converted image
System.Boolean	keepAspectRatio	Whether need to keep the aspect ratio of the page

Returns

Type	Description
System.Drawing.Bitmap	Returns the image with custom size

ExportAsImage(Int32, SizeF, Single, Single, Boolean)

Exports the specified page as Image

Declaration

public Bitmap ExportAsImage(int pageIndex, SizeF customSize, float dpiX, float dpiY, bool keepAspectRatio)

Parameters

Type	Name	Description
System.Int32	pageIndex	The page index to be converted into image
System.Drawing.SizeF	customSize	The custom size of the converted image
System.Single	dpiX	The horizontal DPI of the resultant image.
System.Single	dpiY	The vertical DPI of the resultant image.
System.Boolean	keepAspectRatio	Whether need to keep the aspect ratio of the page

Returns

Type	Description
System.Drawing.Bitmap	Returns the specified page as image with custom size and resolution

ExportAsImage(Int32, Int32)

Exports the specified pages as Images

Declaration

public Bitmap[] ExportAsImage(int startIndex, int endIndex)

Parameters

Type	Name	Description
System.Int32	startIndex	The starting page index
System.Int32	endIndex	The ending page index

Returns

Type	Description
System.Drawing.Bitmap[]	Returns the specified pages as Images

ExportAsImage(Int32, Int32, SizeF, Boolean)

Exports the specified pages as Images

Declaration

public Bitmap[] ExportAsImage(int startIndex, int endIndex, SizeF customSize, bool keepAspectRatio)

Parameters

Type	Name	Description
System.Int32	startIndex	The starting page index
System.Int32	endIndex	The ending page index
System.Drawing.SizeF	customSize	The custom size of the converted image
System.Boolean	keepAspectRatio	Whether need to keep the aspect raio of the page

Returns

Type	Description
System.Drawing.Bitmap[]	Returns the specified pages as images with custom size

ExportAsImage(Int32, Int32, SizeF, Single, Single, Boolean)

Exports the specified pages as Images

Declaration

public Bitmap[] ExportAsImage(int startIndex, int endIndex, SizeF customSize, float dpiX, float dpiY, bool keepAspectRatio)

Parameters

Type	Name	Description
System.Int32	startIndex	The starting page index
System.Int32	endIndex	The ending page index
System.Drawing.SizeF	customSize	The custom size of the converted image
System.Single	dpiX	The horizontal DPI of the resultant image.
System.Single	dpiY	The vertical DPI of the resultant image.
System.Boolean	keepAspectRatio	Whether need to keep the aspect ratio of the page

Returns

Type	Description
System.Drawing.Bitmap[]	Returns the specified pages as images with custom size and resolution

ExportAsMetafile(Int32)

Exports the specified page as System.Drawing.Imaging.Metafile

Declaration

public Metafile ExportAsMetafile(int pageIndex)

Parameters

Type	Name	Description
System.Int32	pageIndex	The index of the PDF page.

Returns

Type	Description
System.Drawing.Imaging.Metafile	Metafile

ExportAsMetafile(Int32, Int32)

Exports the specified pages as System.Drawing.Imaging.Metafile

Declaration

public Metafile[] ExportAsMetafile(int startIndex, int endIndex)

Parameters

Type	Name	Description
System.Int32	startIndex	The start index of the PDF page
System.Int32	endIndex	The end index of the PDF page

Returns

Type	Description
System.Drawing.Imaging.Metafile[]	Array of Metafile

ExtractText(Int32, out TextLines)

Extracts text from the page of PDF document with lines and words collection.

Declaration

public string ExtractText(int index, out TextLines textLines)

Parameters

Type	Name	Description
System.Int32	index
TextLines	textLines	Holds the lines with bounds in the page.

Returns

Type	Description
System.String	The Extracted Text.

ExtractText(Int32, out List<TextData>)

Extracts text along with its format from the PDF Page.

Declaration

public string ExtractText(int index, out List<TextData> textDataCollection)

Parameters

Type	Name	Description
System.Int32	index
System.Collections.Generic.List<TextData>	textDataCollection	Provides the text data collection

Returns

Type	Description
System.String	Returns the extracted text.

FindText(String, out Dictionary<Int32, List<RectangleF>>)

Returns the page number and rectangle positions of the text matchs

Declaration

public bool FindText(string text, out Dictionary<int, List<RectangleF>> matchTextPosition)

Parameters

Type	Name	Description
System.String	text	The text to be searched
System.Collections.Generic.Dictionary<System.Int32, System.Collections.Generic.List<System.Drawing.RectangleF>>	matchTextPosition	Holds the page number and rectangle positions of the text matches

Returns

Type
System.Boolean

GetActiveThemeName()

Gets the active theme name of the control.

Declaration

public string GetActiveThemeName()

Returns

Type	Description
System.String	Returns the active theme name.

GoToBookmark(PdfBookmark)

Navigates to the location of the bookmark.

Declaration

public void GoToBookmark(PdfBookmark bookmark)

Parameters

Type	Name	Description
PdfBookmark	bookmark	The PdfBookmark object that contains the details of the bookmark to which the viewer has to navigate.

Examples

PdfBookmarkBase bookmark = pdfDocumentView1.LoadedDocument.Bookmarks;
if (bookmark.Count > 0)
pdfDocumentView1.GoToBookmark(bookmark[0]);

GoToFirstPage()

Navigates to the first page of the document.

Declaration

public void GoToFirstPage()

GoToLastPage()

Navigates to the last page of the document

Declaration

public void GoToLastPage()

GoToNextPage()

Navigates to the next page of the document.

Declaration

public void GoToNextPage()

GoToPageAtIndex(Int32)

Navigates to the specified page.

Declaration

public void GoToPageAtIndex(int index)

Parameters

Type	Name	Description
System.Int32	index	The page index

GoToPageAtIndexForTextSearch(Int32)

Navigates to the specified page.

Declaration

public void GoToPageAtIndexForTextSearch(int index)

Parameters

Type	Name	Description
System.Int32	index	The page index

GoToPreviousPage()

Navigates to the previous page of the document.

Declaration

public void GoToPreviousPage()

Load(PdfLoadedDocument)

Loads a pdf document in the Pdf viewer from the specified PdfLoadedDocuemnt.

Declaration

public void Load(PdfLoadedDocument loadedDocument)

Parameters

Type	Name	Description
PdfLoadedDocument	loadedDocument	The PdfLoadedDocument to be viewed in the PdfViewer

Load(Stream)

Loads a Pdf document in the Pdf viewer from the specified stream.

Declaration

public void Load(Stream stream)

Parameters

Type	Name	Description
System.IO.Stream	stream	A stream that contains the data for the Pdf document

Load(Stream, String)

Loads a Pdf document in the Pdf viewer from the specified stream.

Declaration

public void Load(Stream stream, string password)

Parameters

Type	Name	Description
System.IO.Stream	stream	A stream that contains the data for the Pdf document
System.String	password	The password for opening the document.

Load(String)

Loads a Pdf document in the Pdf viewer

Declaration

public void Load(string filePath)

Parameters

Type	Name	Description
System.String	filePath	The path for the Pdf document to display in the pdf viewer

Load(String, String)

Loads a Pdf document in the Pdf viewer

Declaration

public void Load(string filePath, string password)

Parameters

Type	Name	Description
System.String	filePath	The path for the Pdf document to display in the pdf viewer
System.String	password	The password for opening the document.

OnPaint(PaintEventArgs)

Declaration

protected override void OnPaint(PaintEventArgs e)

Parameters

Type	Name	Description
System.Windows.Forms.PaintEventArgs	e

OnPrintPage(Object, PrintPageEventArgs)

Declaration

protected virtual void OnPrintPage(object sender, PrintPageEventArgs e)

Parameters

Type	Name	Description
System.Object	sender
System.Drawing.Printing.PrintPageEventArgs	e

OnSizeChanged(EventArgs)

Declaration

protected override void OnSizeChanged(EventArgs e)

Parameters

Type	Name	Description
System.EventArgs	e

Print(String)

Prints the document on the specified printer.

Declaration

public void Print(string printerName)

Parameters

Type	Name	Description
System.String	printerName	The name of the destination printer to print the PDF document.

ProcessCmdKey(ref Message, Keys)

Declaration

protected override bool ProcessCmdKey(ref Message msg, Keys keyData)

Parameters

Type	Name	Description
System.Windows.Forms.Message	msg
System.Windows.Forms.Keys	keyData

Returns

Type
System.Boolean

SearchNextText(String)

Search the next occurrence of the text.

Declaration

public void SearchNextText(string targetString)

Parameters

Type	Name	Description
System.String	targetString	The text to be searched

SearchPreviousText(String)

Search the previous occurrence of the text.

Declaration

public void SearchPreviousText(string targetString)

Parameters

Type	Name	Description
System.String	targetString	The text to be searched

SearchText(String)

Searches the text

Declaration

public void SearchText(string targetText)

Parameters

Type	Name	Description
System.String	targetText

Unload()

Unloads the Pdf document

Declaration

public void Unload()

Unload(Boolean)

Unloads the PDF document.

Declaration

public void Unload(bool isDisposeCompletely)

Parameters

Type	Name	Description
System.Boolean	isDisposeCompletely	Setting this parameter to true will dispose the loaded document completely. By default this parameter is set to true

ZoomTo(ZoomMode)

Magnifies the page of the document to the provided zoom mode.

Declaration

public void ZoomTo(ZoomMode mode)

Parameters

Type	Name	Description
ZoomMode	mode	zoom mode

ZoomTo(Int32)

Magnifies the page of the document to the provided zoom percentage.

Declaration

public void ZoomTo(int percentage)

Parameters

Type	Name	Description
System.Int32	percentage	Zoom percentage

Events

BeginPrint

Occurs when the print is called and before the first page of the document prints.

Declaration

public event EventHandler<BeginPrintEventArgs> BeginPrint

Event Type

Type
System.EventHandler<BeginPrintEventArgs>

CurrentPageChanged

Occurs when current page is changed.

Declaration

public event PdfDocumentView.CurrentPageChangedEventHandler CurrentPageChanged

Event Type

Type
PdfDocumentView.CurrentPageChangedEventHandler

DocumentLoaded

Occurs when the Pdf document is loaded

Declaration

public event PdfDocumentView.DocumentLoadedEventHandler DocumentLoaded

Event Type

Type
PdfDocumentView.DocumentLoadedEventHandler

DocumentLoading

Occurs when the PDF document is loading.

Declaration

public event EventHandler<DocumentLoadingEventArgs> DocumentLoading

Event Type

Type
System.EventHandler<DocumentLoadingEventArgs>

DocumentUnloaded

Occurs when the PDF document is unloaded

Declaration

public event EventHandler<DocumentUnloadedEventArgs> DocumentUnloaded

Event Type

Type
System.EventHandler<DocumentUnloadedEventArgs>

EndPrint

Occurs when the last page of the document has printed. This event also occurs if the printing process is canceled or an exception occurs during the printing process.

Declaration

public event EventHandler<EndPrintEventArgs> EndPrint

Event Type

Type
System.EventHandler<EndPrintEventArgs>

ErrorOccurred

Occurs when the error occurred in PdfViewerControl

Declaration

public event EventHandler<ErrorOccurredEventArgs> ErrorOccurred

Event Type

Type
System.EventHandler<ErrorOccurredEventArgs>

HyperlinkClicked

Occurs when the Hyperlink is clicked in a page of

Declaration

public event EventHandler<HyperlinkClickedEventArgs> HyperlinkClicked

Event Type

Type
System.EventHandler<HyperlinkClickedEventArgs>

HyperlinkMouseOver

Occurs when the mouse is moved over the hyperlink.

Declaration

public event EventHandler<HyperlinkMouseOverEventArgs> HyperlinkMouseOver

Event Type

Type
System.EventHandler<HyperlinkMouseOverEventArgs>

KeyPressed

Occurs when a key is pressed

Declaration

public event PdfDocumentView.KeyPressedEventHandler KeyPressed

Event Type

Type
PdfDocumentView.KeyPressedEventHandler

NavigationButtonStatesChanged

Occurs when state of the navigation button is changed.

Declaration

public event PdfDocumentView.NavigationButtonStatesChangedEventHandler NavigationButtonStatesChanged

Event Type

Type
PdfDocumentView.NavigationButtonStatesChangedEventHandler

PageClicked

Occurs when a page is clicked in PdfDocumentView

Declaration

public event EventHandler<PageClickedEventArgs> PageClicked

Event Type

Type
System.EventHandler<PageClickedEventArgs>

PageMouseMove

Occurs when the mouse pointer moves over the page in PdfDocumentView

Declaration

public event EventHandler<PageMouseMoveEventArgs> PageMouseMove

Event Type

Type
System.EventHandler<PageMouseMoveEventArgs>

PrintProgress

Occurs to provide information on how much of printing content were submitted to printing subsystem

Declaration

public event EventHandler<PrintProgressEventArgs> PrintProgress

Event Type

Type
System.EventHandler<PrintProgressEventArgs>

ScrollChanged

Occurs when scroll is changed.

Declaration

public event EventHandler<ScrollChangedEventArgs> ScrollChanged

Event Type

Type
System.EventHandler<ScrollChangedEventArgs>

TextMatchFound

Occurs when a match for the searched text found.

Declaration

public event EventHandler<TextMatchFoundEventArgs> TextMatchFound

Event Type

Type
System.EventHandler<TextMatchFoundEventArgs>

TextSearchCompleted

Occurs when a text search operation is completed.

Declaration

public event EventHandler<TextSearchCompletedEventArgs> TextSearchCompleted

Event Type

Type
System.EventHandler<TextSearchCompletedEventArgs>

TextSearchInitiated

Occurs when the text search is initiated.

Declaration

public event EventHandler<TextSearchInitiatedEventArgs> TextSearchInitiated

Event Type

Type
System.EventHandler<TextSearchInitiatedEventArgs>

TextSelectionCompleted

Event triggered once the text selection was completed

Declaration

public event PdfDocumentView.TextSelectionCompletedEventHandler TextSelectionCompleted

Event Type

Type
PdfDocumentView.TextSelectionCompletedEventHandler

ThemeNameChanged

Occurs when theme name of the control has changed.

Declaration

public event ThemeChangedEventHandler ThemeNameChanged

Event Type

Type
ThemeChangedEventHandler

ZoomChanged

Occurs when zoom value is changed.

Declaration

public event PdfDocumentView.ZoomChangedEventHandler ZoomChanged

Event Type

Type
PdfDocumentView.ZoomChangedEventHandler

Explicit Interface Implementations

IVisualStyle.VisualTheme

Gets or sets the VisualTheme of the control.

Declaration

string IVisualStyle.VisualTheme { get; set; }

Returns

Type
System.String

IThemeProvider.BaseThemeName

Gets or sets the Base Theme name of the theme

Declaration

string IThemeProvider.BaseThemeName { get; set; }

Returns

Type
System.String

IThemeProvider.ControlName

Gets the name of the control.

Declaration

string IThemeProvider.ControlName { get; }

Returns

Type
System.String

Implements

IThemeProvider

IVisualStyle