Free Trial
Web API version
Licensing
Request A Quote
HAVE QUESTIONS OR NEED HELP? SUBMIT THE SUPPORT REQUEST FORM or write email to SUPPORT@BYTESCOUT.COM
PDF visualization control.
Inheritance Hierarchy
SystemMarshalByRefObject
System.ComponentModelComponent
System.Windows.FormsControl
System.Windows.FormsScrollableControl
System.Windows.FormsContainerControl
System.Windows.FormsUserControl
Bytescout.PDFViewerPDFViewerControl
Namespace: Bytescout.PDFViewer
Assembly: Bytescout.PDFViewer (in Bytescout.PDFViewer.dll) Version: 12.0.0.4063-master
Syntax
The PDFViewerControl type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
 | PDFViewerControl |
Initializes a new instance of the PDFViewerControl class.
|
Properties
| Name | Description | |
|---|---|---|
 | AccessibilityObject | (Inherited from Control.) |
| AccessibleDefaultActionDescription | (Inherited from Control.) |
| AccessibleDescription | (Inherited from Control.) |
| AccessibleName | (Inherited from Control.) |
| AccessibleRole | (Inherited from Control.) |
| ActiveControl | (Inherited from ContainerControl.) |
| ActiveSelectionIndex |
Index of active selection when multi-select mode is enabled (MultiSelectMode).
|
| AllowDrop | (Inherited from Control.) |
| AllowResizeSelectionRectangles |
Gets or sets whether the component allows resizing of selection rectangles using mouse.
|
| Anchor | (Inherited from Control.) |
| AutoScaleDimensions | (Inherited from ContainerControl.) |
| AutoScaleMode | (Inherited from ContainerControl.) |
| AutoScroll | (Inherited from ScrollableControl.) |
| AutoScrollMargin | (Inherited from ScrollableControl.) |
| AutoScrollMinSize | (Inherited from ScrollableControl.) |
| AutoScrollOffset | (Inherited from Control.) |
| AutoScrollPosition | (Inherited from ScrollableControl.) |
| AutoSize | (Inherited from UserControl.) |
| AutoSizeMode | (Inherited from UserControl.) |
| AutoValidate | (Inherited from UserControl.) |
| BackColor | (Inherited from Control.) |
| BackgroundImage | (Inherited from Control.) |
| BackgroundImageLayout | (Inherited from Control.) |
| BindingContext | (Inherited from ContainerControl.) |
| BorderStyle | (Inherited from UserControl.) |
| Bottom | (Inherited from Control.) |
| Bounds | (Inherited from Control.) |
| CacheVisitedPages |
Gets or sets whether to keep rendered pages for faster switching to visited pages. Default is true.
|
| CanFocus | (Inherited from Control.) |
| CanSelect | (Inherited from Control.) |
| Capture | (Inherited from Control.) |
| CausesValidation | (Inherited from Control.) |
| ClearSelectionOnClick |
If True, the component will clear selection on mouse click out of selection rectangle.
|
| ClientRectangle | (Inherited from Control.) |
| ClientSize | (Inherited from Control.) |
| CompanyName | (Inherited from Control.) |
| Container | (Inherited from Component.) |
| ContainsFocus | (Inherited from Control.) |
| ContextMenu | (Inherited from Control.) |
| ContextMenuStrip | (Inherited from Control.) |
| Controls | (Inherited from Control.) |
| Created | (Inherited from Control.) |
| CurrentAutoScaleDimensions | (Inherited from ContainerControl.) |
| CurrentPageIndex |
Gets or sets the index of the document page to display.
|
| Cursor | (Inherited from Control.) |
| DataBindings | (Inherited from Control.) |
| DisplayRectangle | (Inherited from ScrollableControl.) |
| Disposing | (Inherited from Control.) |
| Dock | (Inherited from Control.) |
| DockPadding | (Inherited from ScrollableControl.) |
| DocumentPassword |
Gets or sets the PDF document password.
|
| Enabled | (Inherited from Control.) |
| Focused | (Inherited from Control.) |
| Font | (Inherited from Control.) |
| ForeColor | (Inherited from Control.) |
| Handle | (Inherited from Control.) |
| HasChildren | (Inherited from Control.) |
| Height | (Inherited from Control.) |
| HorizontalScroll | (Inherited from ScrollableControl.) |
| ImageInterpolationMode |
Gets or sets the image interpolation mode.
|
| ImeMode | (Inherited from Control.) |
| InactiveSelectionColor |
Gets or sets the color of inactive selection rectangles in multi-select mode.
|
| InputFile |
Gets or sets the input file. Supported formats: PDF, PNG, JPEG, BMP and TIFF (single-page).
|
| InputStream |
Gets or sets the stream containing the input file. Supported formats: PDF, PNG, JPEG, BMP and TIFF (single-page).
|
| InvokeRequired | (Inherited from Control.) |
| IsAccessible | (Inherited from Control.) |
| IsDisposed | (Inherited from Control.) |
| IsDocumentLoaded |
Gets the document loaded state.
|
| IsHandleCreated | (Inherited from Control.) |
| IsMirrored | (Inherited from Control.) |
| KeepAspectRatio |
Defines whether to keep the aspect ratio during the selection resizing.
|
| LayoutEngine | (Inherited from Control.) |
| Left | (Inherited from Control.) |
| LicenseInfo |
Gets license information.
|
| Location | (Inherited from Control.) |
| LockSelection |
Locks the current selection ignoring user's mouse clicks and page index changes.
|
| Margin | (Inherited from Control.) |
| MaximumSize | (Inherited from Control.) |
| MinimumSize | (Inherited from Control.) |
| MouseMode |
Gets or sets the mouse mode: hand tool or select tool.
|
| MultiSelectMode |
Determines the selection mode. In true user can select multiple rectangles holding the Shift key
and the Selection property may contain more than one rectangle.
|
| Name | (Inherited from Control.) |
| NightMode |
Gets or sets whether the "Night Mode" is enabled. In the night mode document is rendered
with black background, black text becomes white, images are dimmed.
|
| Padding | (Inherited from Control.) |
| PageCount |
Gets the document page count.
|
| Parent | (Inherited from Control.) |
| ParentForm | (Inherited from ContainerControl.) |
| PreferredSize | (Inherited from Control.) |
| ProductName | (Inherited from Control.) |
| ProductVersion | (Inherited from Control.) |
| RecreatingHandle | (Inherited from Control.) |
| Region | (Inherited from Control.) |
| RegistrationKey |
Registration key.
|
| RegistrationName |
Registration name.
|
| ResetRotationOnPageChange |
Gets or sets whether to reset the rotation on page change.
|
| Right | (Inherited from Control.) |
| RightToLeft | (Inherited from Control.) |
| Rotation |
Visible document page rotation.
|
| Scale |
Gets or sets the document scale in percents.
|
| ScrollBarsAlwaysVisible |
Gets or sets a value indicating whether scroll bars should be always visible.
|
| Selection |
Gets or sets selection rectangles in pixels. In single-select mode always contains one rectangle.
|
| SelectionColor |
Gets or sets the color of selection rectangles.
|
| SelectionCursor |
Kind of the selection cursor.
|
| SelectionInPoints |
Gets or sets selection rectangles in PDF Points (1 Point = 1/72 in.)
|
| SelectionModifierKey |
Defines modifier key to start new selection rectangle on left mouse button click.
|
| ShowImageObjects |
Gets or sets whether to show image PDF objects.
|
| ShowResizeHandlesForActiveSelectionOnly |
Gets or sets whether to show resize handles for active selection only (in multi-select mode).
|
| ShowTextObjects |
Gets or sets whether to show text PDF objects.
|
| ShowToolbar |
Gets or sets a value indicating whether to show the toolbar.
|
| ShowToolbarFind |
Gets or sets a value indicating whether to show text search items on the toolbar.
|
| ShowToolbarRotate |
Gets or sets a value indicating whether to show rotation buttons on the toolbar.
|
| ShowVectorObjects |
Gets or sets whether to show vector PDF objects.
|
| Site | (Inherited from Control.) |
| Size | (Inherited from Control.) |
| TabIndex | (Inherited from Control.) |
| TabStop | (Inherited from Control.) |
| Tag | (Inherited from Control.) |
| Text | (Inherited from UserControl.) |
| TextSmoothingMode |
Gets or sets the text smoothing mode.
|
| ToolStripRenderMode |
Gets or sets the tool strip render mode.
|
| Top | (Inherited from Control.) |
| TopLevelControl | (Inherited from Control.) |
| UseWaitCursor | (Inherited from Control.) |
| VectorSmoothingMode |
Gets or sets the vector smoothing mode.
|
| Version |
Gets the component version number.
|
| VerticalScroll | (Inherited from ScrollableControl.) |
| Visible | (Inherited from Control.) |
| Width | (Inherited from Control.) |
| WindowTarget | (Inherited from Control.) |
Methods
| Name | Description | |
|---|---|---|
| AddSelection |
Adds selection rectangle in pixels.
|
| AddSelectionAndUserData(SelectionData) |
Adds selection and associated user object as SelectionData object.
|
| AddSelectionAndUserData(IListSelectionData) |
Adds selection and associated user object as list of SelectionData objects.
|
| AddSelectionInPoints |
Adds selection rectangle in PDF Points (1 Point = 1/72 in.).
|
| BeginInvoke(Delegate) | (Inherited from Control.) |
| BeginInvoke(Delegate, Object) | (Inherited from Control.) |
| BringToFront | (Inherited from Control.) |
| Clear |
Clears the content of PDFViewerControl and releases resources.
|
| ClearSelection |
Clears the selection rectangle.
|
| Contains | (Inherited from Control.) |
| Copy |
Copies selected text to the clipboard.
|
| CreateControl | (Inherited from Control.) |
| CreateGraphics | (Inherited from Control.) |
| CreateObjRef | (Inherited from MarshalByRefObject.) |
| Dispose | (Inherited from Component.) |
| DoDragDrop | (Inherited from Control.) |
| DrawToBitmap | (Inherited from Control.) |
| EndInvoke | (Inherited from Control.) |
| Equals | (Inherited from Object.) |
| Find(String) |
Finds the specified text in the document starting from currently selected page.
|
| Find(String, TextSearchFeedbackType) |
Finds the specified text in the document starting from currently selected page.
|
| FindForm | (Inherited from Control.) |
| FirstPage |
Shows first page.
|
| FitPage |
Fits the document into window.
|
| FitWidth |
Fits the document into window by width.
|
| Focus | (Inherited from Control.) |
| GetChildAtPoint(Point) | (Inherited from Control.) |
| GetChildAtPoint(Point, GetChildAtPointSkip) | (Inherited from Control.) |
| GetContainerControl | (Inherited from Control.) |
| GetHashCode | (Inherited from Object.) |
| GetLifetimeService | (Inherited from MarshalByRefObject.) |
| GetNextControl | (Inherited from Control.) |
| GetPageRectangle |
Returns size of current document page in PDF documents point units (1/72").
|
| GetPreferredSize | (Inherited from Control.) |
| GetSelectedText |
Returns text from selection rectangle.
|
| GetSelection |
Returns array of selection rectangles in pixels. In single-select mode the array always contains one rectangle.
|
| GetSelectionAndUserData |
Returns selection rectangles and associated user objects as array of SelectionData objects.
|
| GetSelectionInPoints |
Returns array of selection rectangles in PDF Points (1 Point = 1/72 in.)
|
| GetType | (Inherited from Object.) |
| Hide | (Inherited from Control.) |
| InitializeLifetimeService | (Inherited from MarshalByRefObject.) |
| Invalidate | (Inherited from Control.) |
| Invalidate(Region) | (Inherited from Control.) |
| Invalidate(Boolean) | (Inherited from Control.) |
| Invalidate(Rectangle) | (Inherited from Control.) |
| Invalidate(Region, Boolean) | (Inherited from Control.) |
| Invalidate(Rectangle, Boolean) | (Inherited from Control.) |
| Invoke(Delegate) | (Inherited from Control.) |
| Invoke(Delegate, Object) | (Inherited from Control.) |
| LastPage |
Shows last page.
|
| NextPage |
Shows next page.
|
| PerformAutoScale | (Inherited from ContainerControl.) |
| PerformLayout | (Inherited from Control.) |
| PerformLayout(Control, String) | (Inherited from Control.) |
| PointToClient | (Inherited from Control.) |
| PointToScreen | (Inherited from Control.) |
| PreProcessControlMessage | (Inherited from Control.) |
| PreProcessMessage | (Inherited from Control.) |
| PrevPage |
Shows previous page.
|
| RectangleToClient | (Inherited from Control.) |
| RectangleToScreen | (Inherited from Control.) |
| Refresh | (Inherited from Control.) |
| RemoveSelectionAt |
Removes selection at specified index.
|
| ResetBackColor |
Resets the BackColor property to its default value.
(Overrides ControlResetBackColor.) |
| ResetBindings | (Inherited from Control.) |
| ResetCursor | (Inherited from Control.) |
| ResetFont | (Inherited from Control.) |
| ResetForeColor | (Inherited from Control.) |
| ResetImeMode | (Inherited from Control.) |
| ResetRightToLeft | (Inherited from Control.) |
| ResetRotation |
Reset rotation to default.
|
| ResetText | (Inherited from Control.) |
| ResumeLayout | (Inherited from Control.) |
| ResumeLayout(Boolean) | (Inherited from Control.) |
| Rotate180 |
Rotate the document 180 degrees.
|
| RotateLeft |
Rotate the document 90 degrees to the left.
|
| RotateRight |
Rotate the document 90 degrees to the right.
|
| Scale(Single) | Obsolete. (Inherited from Control.) |
| Scale(SizeF) | (Inherited from Control.) |
| Scale(Single, Single) | Obsolete. (Inherited from Control.) |
| ScrollControlIntoView | (Inherited from ScrollableControl.) |
| Select | (Inherited from Control.) |
| SelectNextControl | (Inherited from Control.) |
| SendToBack | (Inherited from Control.) |
| SetAutoScrollMargin | (Inherited from ScrollableControl.) |
| SetBounds(Int32, Int32, Int32, Int32) | (Inherited from Control.) |
| SetBounds(Int32, Int32, Int32, Int32, BoundsSpecified) | (Inherited from Control.) |
| SetScale |
Sets the document scale.
|
| SetSelection |
Sets selection rectangles in pixels. In single-select mode the control
will take only the first rectangle in the list.
|
| SetSelectionAndUserData |
Sets selection rectangles and associated user objects.
|
| SetSelectionInPoints |
Sets the selection rectangles in PDF Points (1 Point = 1/72 in.)
|
| Show | (Inherited from Control.) |
| SuspendLayout | (Inherited from Control.) |
| ToString | (Inherited from Component.) |
| TranslatePointFromPointsToPixels |
Translates point coordinates from PDF documents point units (1/72") to display pixels.
|
| TranslatePointToDocumentPoints |
Translates point coordinates to PDF document's coordinates (Points, 1 Point = 1/72 in.).
|
| TranslatePointToViewport |
Translates point coordinates to component's canvas coordinates. Might be useful in CustomPaint event.
|
| TranslateRectangleFromPointsToPixels |
Translates rectangle from PDF documents points (1/72") to display pixels.
|
| TranslateRectangleToDocumentPoints |
Translates rectangle coordinates to PDF document's coordinates (Points, 1 Point = 1/72 in.).
|
| TranslateRectangleToViewport |
Translates coordinates of rectangle to component's canvas coordinates. Might be useful in CustomPaint event.
|
| Update | (Inherited from Control.) |
| UpdateSelectionUserData |
Updates user object associated with the selection at the specified index.
|
| Validate | (Inherited from ContainerControl.) |
| Validate(Boolean) | (Inherited from ContainerControl.) |
| ValidateChildren | (Inherited from UserControl.) |
| ValidateChildren(ValidationConstraints) | (Inherited from UserControl.) |
| ZoomIn |
Zooms the document in by 10%.
|
| ZoomOut |
Zooms the document out by 10%.
|
| ZoomOut(Int32) |
Events
| Name | Description | |
|---|---|---|
 | AutoSizeChanged | (Inherited from UserControl.) |
| AutoValidateChanged | (Inherited from UserControl.) |
| BackColorChanged | (Inherited from Control.) |
| BackgroundImageChanged | (Inherited from Control.) |
| BackgroundImageLayoutChanged | (Inherited from Control.) |
| BindingContextChanged | (Inherited from Control.) |
| CausesValidationChanged | (Inherited from Control.) |
| ChangeUICues | (Inherited from Control.) |
| Click | (Inherited from Control.) |
| ClientSizeChanged | (Inherited from Control.) |
| ContextMenuChanged | (Inherited from Control.) |
| ContextMenuStripChanged | (Inherited from Control.) |
| ControlAdded | (Inherited from Control.) |
| ControlRemoved | (Inherited from Control.) |
| CurrentPageIndexChanged |
Occurs when current page index changed.
|
| CursorChanged | (Inherited from Control.) |
| CustomPaint |
Occurs after the control has pained its content and allows you to add some custom painting.
|
| Disposed | (Inherited from Component.) |
| DockChanged | (Inherited from Control.) |
| DocumentChanged |
Occurs when document is changed.
|
| DoubleClick | (Inherited from Control.) |
| DragDrop | (Inherited from Control.) |
| DragEnter | (Inherited from Control.) |
| DragLeave | (Inherited from Control.) |
| DragOver | (Inherited from Control.) |
| EnabledChanged | (Inherited from Control.) |
| Enter | (Inherited from Control.) |
| FontChanged | (Inherited from Control.) |
| ForeColorChanged | (Inherited from Control.) |
| GiveFeedback | (Inherited from Control.) |
| GotFocus | (Inherited from Control.) |
| HandleCreated | (Inherited from Control.) |
| HandleDestroyed | (Inherited from Control.) |
| HelpRequested | (Inherited from Control.) |
| ImeModeChanged | (Inherited from Control.) |
| Invalidated | (Inherited from Control.) |
| KeyDown | (Inherited from Control.) |
| KeyPress | (Inherited from Control.) |
| KeyUp | (Inherited from Control.) |
| Layout | (Inherited from Control.) |
| Leave | (Inherited from Control.) |
| Load | (Inherited from UserControl.) |
| LocationChanged | (Inherited from Control.) |
| LostFocus | (Inherited from Control.) |
| MarginChanged | (Inherited from Control.) |
| MouseCaptureChanged | (Inherited from Control.) |
| MouseClick | (Inherited from Control.) |
| MouseDoubleClick | (Inherited from Control.) |
| MouseDown | (Inherited from Control.) |
| MouseEnter | (Inherited from Control.) |
| MouseHover | (Inherited from Control.) |
| MouseLeave | (Inherited from Control.) |
| MouseMove | (Inherited from Control.) |
| MouseUp | (Inherited from Control.) |
| MouseWheel | (Inherited from Control.) |
| Move | (Inherited from Control.) |
| PaddingChanged | (Inherited from Control.) |
| Paint | (Inherited from Control.) |
| ParentChanged | (Inherited from Control.) |
| PasswordRequired |
Occurs when password required to open PDF document.
|
| PostProcessKey |
Allows to process key after it was processed by the control.
|
| PreProcessKey |
Allows to process key before it will be processed by the control.
|
| PreProcessMouseDown |
Allows to process MouseDown event before it will be processed by the control.
|
| PreProcessMouseMove |
Allows to process MouseMove event before it will be processed by the control.
|
| PreProcessMouseUp |
Allows to process MouseUp event before it will be processed by the control.
|
| PreviewKeyDown | (Inherited from Control.) |
| ProgressChanged |
Raised for each reported progress value. Allows to cancel the processing.
|
| QueryAccessibilityHelp | (Inherited from Control.) |
| QueryContinueDrag | (Inherited from Control.) |
| RegionChanged | (Inherited from Control.) |
| Resize | (Inherited from Control.) |
| RightToLeftChanged | (Inherited from Control.) |
| Scroll | (Inherited from ScrollableControl.) |
| SelectionChanged |
Occurs when user changes selection with mouse.
|
| SizeChanged | (Inherited from Control.) |
| StyleChanged | (Inherited from Control.) |
| SystemColorsChanged | (Inherited from Control.) |
| TabIndexChanged | (Inherited from Control.) |
| TabStopChanged | (Inherited from Control.) |
| TextChanged | (Inherited from UserControl.) |
| ValidateContextMenu |
Allows to modify control's context menu.
|
| Validated | (Inherited from Control.) |
| Validating | (Inherited from Control.) |
| VisibleChanged | (Inherited from Control.) |
See Also