PDFViewerControl ClassByteScout PDF Viewer SDK
PDF visualization control.
Inheritance Hierarchy

SystemObject
  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

public sealed class PDFViewerControl : UserControl

The PDFViewerControl type exposes the following members.

Constructors

  NameDescription
Public methodPDFViewerControl
Initializes a new instance of the PDFViewerControl class.
Top
Properties

  NameDescription
Public propertyAccessibilityObject (Inherited from Control.)
Public propertyAccessibleDefaultActionDescription (Inherited from Control.)
Public propertyAccessibleDescription (Inherited from Control.)
Public propertyAccessibleName (Inherited from Control.)
Public propertyAccessibleRole (Inherited from Control.)
Public propertyActiveControl (Inherited from ContainerControl.)
Public propertyActiveSelectionIndex
Index of active selection when multi-select mode is enabled (MultiSelectMode).
Public propertyAllowDrop (Inherited from Control.)
Public propertyAllowResizeSelectionRectangles
Gets or sets whether the component allows resizing of selection rectangles using mouse.
Public propertyAnchor (Inherited from Control.)
Public propertyAutoScaleDimensions (Inherited from ContainerControl.)
Public propertyAutoScaleMode (Inherited from ContainerControl.)
Public propertyAutoScroll (Inherited from ScrollableControl.)
Public propertyAutoScrollMargin (Inherited from ScrollableControl.)
Public propertyAutoScrollMinSize (Inherited from ScrollableControl.)
Public propertyAutoScrollOffset (Inherited from Control.)
Public propertyAutoScrollPosition (Inherited from ScrollableControl.)
Public propertyAutoSize (Inherited from UserControl.)
Public propertyAutoSizeMode (Inherited from UserControl.)
Public propertyAutoValidate (Inherited from UserControl.)
Public propertyBackColor (Inherited from Control.)
Public propertyBackgroundImage (Inherited from Control.)
Public propertyBackgroundImageLayout (Inherited from Control.)
Public propertyBindingContext (Inherited from ContainerControl.)
Public propertyBorderStyle (Inherited from UserControl.)
Public propertyBottom (Inherited from Control.)
Public propertyBounds (Inherited from Control.)
Public propertyCacheVisitedPages
Gets or sets whether to keep rendered pages for faster switching to visited pages. Default is true.
Public propertyCanFocus (Inherited from Control.)
Public propertyCanSelect (Inherited from Control.)
Public propertyCapture (Inherited from Control.)
Public propertyCausesValidation (Inherited from Control.)
Public propertyClearSelectionOnClick
If True, the component will clear selection on mouse click out of selection rectangle.
Public propertyClientRectangle (Inherited from Control.)
Public propertyClientSize (Inherited from Control.)
Public propertyCompanyName (Inherited from Control.)
Public propertyContainer (Inherited from Component.)
Public propertyContainsFocus (Inherited from Control.)
Public propertyContextMenu (Inherited from Control.)
Public propertyContextMenuStrip (Inherited from Control.)
Public propertyControls (Inherited from Control.)
Public propertyCreated (Inherited from Control.)
Public propertyCurrentAutoScaleDimensions (Inherited from ContainerControl.)
Public propertyCurrentPageIndex
Gets or sets the index of the document page to display.
Public propertyCursor (Inherited from Control.)
Public propertyDataBindings (Inherited from Control.)
Public propertyDisplayRectangle (Inherited from ScrollableControl.)
Public propertyDisposing (Inherited from Control.)
Public propertyDock (Inherited from Control.)
Public propertyDockPadding (Inherited from ScrollableControl.)
Public propertyDocumentPassword
Gets or sets the PDF document password.
Public propertyEnabled (Inherited from Control.)
Public propertyFocused (Inherited from Control.)
Public propertyFont (Inherited from Control.)
Public propertyForeColor (Inherited from Control.)
Public propertyHandle (Inherited from Control.)
Public propertyHasChildren (Inherited from Control.)
Public propertyHeight (Inherited from Control.)
Public propertyHorizontalScroll (Inherited from ScrollableControl.)
Public propertyImageInterpolationMode
Gets or sets the image interpolation mode.
Public propertyImeMode (Inherited from Control.)
Public propertyInactiveSelectionColor
Gets or sets the color of inactive selection rectangles in multi-select mode.
Public propertyInputFile
Gets or sets the input file. Supported formats: PDF, PNG, JPEG, BMP and TIFF (single-page).
Public propertyInputStream
Gets or sets the stream containing the input file. Supported formats: PDF, PNG, JPEG, BMP and TIFF (single-page).
Public propertyInvokeRequired (Inherited from Control.)
Public propertyIsAccessible (Inherited from Control.)
Public propertyIsDisposed (Inherited from Control.)
Public propertyIsDocumentLoaded
Gets the document loaded state.
Public propertyIsHandleCreated (Inherited from Control.)
Public propertyIsMirrored (Inherited from Control.)
Public propertyKeepAspectRatio
Defines whether to keep the aspect ratio during the selection resizing.
Public propertyLayoutEngine (Inherited from Control.)
Public propertyLeft (Inherited from Control.)
Public propertyLicenseInfo
Gets license information.
Public propertyLocation (Inherited from Control.)
Public propertyLockSelection
Locks the current selection ignoring user's mouse clicks and page index changes.
Public propertyMargin (Inherited from Control.)
Public propertyMaximumSize (Inherited from Control.)
Public propertyMinimumSize (Inherited from Control.)
Public propertyMouseMode
Gets or sets the mouse mode: hand tool or select tool.
Public propertyMultiSelectMode
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.
Public propertyName (Inherited from Control.)
Public propertyNightMode
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.
Public propertyPadding (Inherited from Control.)
Public propertyPageCount
Gets the document page count.
Public propertyParent (Inherited from Control.)
Public propertyParentForm (Inherited from ContainerControl.)
Public propertyPreferredSize (Inherited from Control.)
Public propertyProductName (Inherited from Control.)
Public propertyProductVersion (Inherited from Control.)
Public propertyRecreatingHandle (Inherited from Control.)
Public propertyRegion (Inherited from Control.)
Public propertyRegistrationKey
Registration key.
Public propertyRegistrationName
Registration name.
Public propertyResetRotationOnPageChange
Gets or sets whether to reset the rotation on page change.
Public propertyRight (Inherited from Control.)
Public propertyRightToLeft (Inherited from Control.)
Public propertyRotation
Visible document page rotation.
Public propertyScale
Gets or sets the document scale in percents.
Public propertyScrollBarsAlwaysVisible
Gets or sets a value indicating whether scroll bars should be always visible.
Public propertySelection
Gets or sets selection rectangles in pixels. In single-select mode always contains one rectangle.
Public propertySelectionColor
Gets or sets the color of selection rectangles.
Public propertySelectionCursor
Kind of the selection cursor.
Public propertySelectionInPoints
Gets or sets selection rectangles in PDF Points (1 Point = 1/72 in.)
Public propertySelectionModifierKey
Defines modifier key to start new selection rectangle on left mouse button click.
Public propertyShowImageObjects
Gets or sets whether to show image PDF objects.
Public propertyShowResizeHandlesForActiveSelectionOnly
Gets or sets whether to show resize handles for active selection only (in multi-select mode).
Public propertyShowTextObjects
Gets or sets whether to show text PDF objects.
Public propertyShowToolbar
Gets or sets a value indicating whether to show the toolbar.
Public propertyShowToolbarFind
Gets or sets a value indicating whether to show text search items on the toolbar.
Public propertyShowToolbarRotate
Gets or sets a value indicating whether to show rotation buttons on the toolbar.
Public propertyShowVectorObjects
Gets or sets whether to show vector PDF objects.
Public propertySite (Inherited from Control.)
Public propertySize (Inherited from Control.)
Public propertyTabIndex (Inherited from Control.)
Public propertyTabStop (Inherited from Control.)
Public propertyTag (Inherited from Control.)
Public propertyText (Inherited from UserControl.)
Public propertyTextSmoothingMode
Gets or sets the text smoothing mode.
Public propertyToolStripRenderMode
Gets or sets the tool strip render mode.
Public propertyTop (Inherited from Control.)
Public propertyTopLevelControl (Inherited from Control.)
Public propertyUseWaitCursor (Inherited from Control.)
Public propertyVectorSmoothingMode
Gets or sets the vector smoothing mode.
Public propertyVersion
Gets the component version number.
Public propertyVerticalScroll (Inherited from ScrollableControl.)
Public propertyVisible (Inherited from Control.)
Public propertyWidth (Inherited from Control.)
Public propertyWindowTarget (Inherited from Control.)
Top
Methods

  NameDescription
Public methodAddSelection
Adds selection rectangle in pixels.
Public methodAddSelectionAndUserData(SelectionData)
Adds selection and associated user object as SelectionData object.
Public methodAddSelectionAndUserData(IListSelectionData)
Adds selection and associated user object as list of SelectionData objects.
Public methodAddSelectionInPoints
Adds selection rectangle in PDF Points (1 Point = 1/72 in.).
Public methodBeginInvoke(Delegate) (Inherited from Control.)
Public methodBeginInvoke(Delegate, Object) (Inherited from Control.)
Public methodBringToFront (Inherited from Control.)
Public methodClear
Clears the content of PDFViewerControl and releases resources.
Public methodClearSelection
Clears the selection rectangle.
Public methodContains (Inherited from Control.)
Public methodCopy
Copies selected text to the clipboard.
Public methodCreateControl (Inherited from Control.)
Public methodCreateGraphics (Inherited from Control.)
Public methodCreateObjRef (Inherited from MarshalByRefObject.)
Public methodDispose (Inherited from Component.)
Public methodDoDragDrop (Inherited from Control.)
Public methodDrawToBitmap (Inherited from Control.)
Public methodEndInvoke (Inherited from Control.)
Public methodEquals (Inherited from Object.)
Public methodFind(String)
Finds the specified text in the document starting from currently selected page.
Public methodFind(String, TextSearchFeedbackType)
Finds the specified text in the document starting from currently selected page.
Public methodFindForm (Inherited from Control.)
Public methodFirstPage
Shows first page.
Public methodFitPage
Fits the document into window.
Public methodFitWidth
Fits the document into window by width.
Public methodFocus (Inherited from Control.)
Public methodGetChildAtPoint(Point) (Inherited from Control.)
Public methodGetChildAtPoint(Point, GetChildAtPointSkip) (Inherited from Control.)
Public methodGetContainerControl (Inherited from Control.)
Public methodGetHashCode (Inherited from Object.)
Public methodGetLifetimeService (Inherited from MarshalByRefObject.)
Public methodGetNextControl (Inherited from Control.)
Public methodGetPageRectangle
Returns size of current document page in PDF documents point units (1/72").
Public methodGetPreferredSize (Inherited from Control.)
Public methodGetSelectedText
Returns text from selection rectangle.
Public methodGetSelection
Returns array of selection rectangles in pixels. In single-select mode the array always contains one rectangle.
Public methodGetSelectionAndUserData
Returns selection rectangles and associated user objects as array of SelectionData objects.
Public methodGetSelectionInPoints
Returns array of selection rectangles in PDF Points (1 Point = 1/72 in.)
Public methodGetType (Inherited from Object.)
Public methodHide (Inherited from Control.)
Public methodInitializeLifetimeService (Inherited from MarshalByRefObject.)
Public methodInvalidate (Inherited from Control.)
Public methodInvalidate(Region) (Inherited from Control.)
Public methodInvalidate(Boolean) (Inherited from Control.)
Public methodInvalidate(Rectangle) (Inherited from Control.)
Public methodInvalidate(Region, Boolean) (Inherited from Control.)
Public methodInvalidate(Rectangle, Boolean) (Inherited from Control.)
Public methodInvoke(Delegate) (Inherited from Control.)
Public methodInvoke(Delegate, Object) (Inherited from Control.)
Public methodLastPage
Shows last page.
Public methodNextPage
Shows next page.
Public methodPerformAutoScale (Inherited from ContainerControl.)
Public methodPerformLayout (Inherited from Control.)
Public methodPerformLayout(Control, String) (Inherited from Control.)
Public methodPointToClient (Inherited from Control.)
Public methodPointToScreen (Inherited from Control.)
Public methodPreProcessControlMessage (Inherited from Control.)
Public methodPreProcessMessage (Inherited from Control.)
Public methodPrevPage
Shows previous page.
Public methodRectangleToClient (Inherited from Control.)
Public methodRectangleToScreen (Inherited from Control.)
Public methodRefresh (Inherited from Control.)
Public methodRemoveSelectionAt
Removes selection at specified index.
Public methodResetBackColor
Resets the BackColor property to its default value.
(Overrides ControlResetBackColor.)
Public methodResetBindings (Inherited from Control.)
Public methodResetCursor (Inherited from Control.)
Public methodResetFont (Inherited from Control.)
Public methodResetForeColor (Inherited from Control.)
Public methodResetImeMode (Inherited from Control.)
Public methodResetRightToLeft (Inherited from Control.)
Public methodResetRotation
Reset rotation to default.
Public methodResetText (Inherited from Control.)
Public methodResumeLayout (Inherited from Control.)
Public methodResumeLayout(Boolean) (Inherited from Control.)
Public methodRotate180
Rotate the document 180 degrees.
Public methodRotateLeft
Rotate the document 90 degrees to the left.
Public methodRotateRight
Rotate the document 90 degrees to the right.
Public methodScale(Single) Obsolete. (Inherited from Control.)
Public methodScale(SizeF) (Inherited from Control.)
Public methodScale(Single, Single) Obsolete. (Inherited from Control.)
Public methodScrollControlIntoView (Inherited from ScrollableControl.)
Public methodSelect (Inherited from Control.)
Public methodSelectNextControl (Inherited from Control.)
Public methodSendToBack (Inherited from Control.)
Public methodSetAutoScrollMargin (Inherited from ScrollableControl.)
Public methodSetBounds(Int32, Int32, Int32, Int32) (Inherited from Control.)
Public methodSetBounds(Int32, Int32, Int32, Int32, BoundsSpecified) (Inherited from Control.)
Public methodSetScale
Sets the document scale.
Public methodSetSelection
Sets selection rectangles in pixels. In single-select mode the control will take only the first rectangle in the list.
Public methodSetSelectionAndUserData
Sets selection rectangles and associated user objects.
Public methodSetSelectionInPoints
Sets the selection rectangles in PDF Points (1 Point = 1/72 in.)
Public methodShow (Inherited from Control.)
Public methodSuspendLayout (Inherited from Control.)
Public methodToString (Inherited from Component.)
Public methodTranslatePointFromPointsToPixels
Translates point coordinates from PDF documents point units (1/72") to display pixels.
Public methodTranslatePointToDocumentPoints
Translates point coordinates to PDF document's coordinates (Points, 1 Point = 1/72 in.).
Public methodTranslatePointToViewport
Translates point coordinates to component's canvas coordinates. Might be useful in CustomPaint event.
Public methodTranslateRectangleFromPointsToPixels
Translates rectangle from PDF documents points (1/72") to display pixels.
Public methodTranslateRectangleToDocumentPoints
Translates rectangle coordinates to PDF document's coordinates (Points, 1 Point = 1/72 in.).
Public methodTranslateRectangleToViewport
Translates coordinates of rectangle to component's canvas coordinates. Might be useful in CustomPaint event.
Public methodUpdate (Inherited from Control.)
Public methodUpdateSelectionUserData
Updates user object associated with the selection at the specified index.
Public methodValidate (Inherited from ContainerControl.)
Public methodValidate(Boolean) (Inherited from ContainerControl.)
Public methodValidateChildren (Inherited from UserControl.)
Public methodValidateChildren(ValidationConstraints) (Inherited from UserControl.)
Public methodZoomIn
Zooms the document in by 10%.
Public methodZoomOut
Zooms the document out by 10%.
Public methodZoomOut(Int32)
Top
Events

  NameDescription
Public eventAutoSizeChanged (Inherited from UserControl.)
Public eventAutoValidateChanged (Inherited from UserControl.)
Public eventBackColorChanged (Inherited from Control.)
Public eventBackgroundImageChanged (Inherited from Control.)
Public eventBackgroundImageLayoutChanged (Inherited from Control.)
Public eventBindingContextChanged (Inherited from Control.)
Public eventCausesValidationChanged (Inherited from Control.)
Public eventChangeUICues (Inherited from Control.)
Public eventClick (Inherited from Control.)
Public eventClientSizeChanged (Inherited from Control.)
Public eventContextMenuChanged (Inherited from Control.)
Public eventContextMenuStripChanged (Inherited from Control.)
Public eventControlAdded (Inherited from Control.)
Public eventControlRemoved (Inherited from Control.)
Public eventCurrentPageIndexChanged
Occurs when current page index changed.
Public eventCursorChanged (Inherited from Control.)
Public eventCustomPaint
Occurs after the control has pained its content and allows you to add some custom painting.
Public eventDisposed (Inherited from Component.)
Public eventDockChanged (Inherited from Control.)
Public eventDocumentChanged
Occurs when document is changed.
Public eventDoubleClick (Inherited from Control.)
Public eventDragDrop (Inherited from Control.)
Public eventDragEnter (Inherited from Control.)
Public eventDragLeave (Inherited from Control.)
Public eventDragOver (Inherited from Control.)
Public eventEnabledChanged (Inherited from Control.)
Public eventEnter (Inherited from Control.)
Public eventFontChanged (Inherited from Control.)
Public eventForeColorChanged (Inherited from Control.)
Public eventGiveFeedback (Inherited from Control.)
Public eventGotFocus (Inherited from Control.)
Public eventHandleCreated (Inherited from Control.)
Public eventHandleDestroyed (Inherited from Control.)
Public eventHelpRequested (Inherited from Control.)
Public eventImeModeChanged (Inherited from Control.)
Public eventInvalidated (Inherited from Control.)
Public eventKeyDown (Inherited from Control.)
Public eventKeyPress (Inherited from Control.)
Public eventKeyUp (Inherited from Control.)
Public eventLayout (Inherited from Control.)
Public eventLeave (Inherited from Control.)
Public eventLoad (Inherited from UserControl.)
Public eventLocationChanged (Inherited from Control.)
Public eventLostFocus (Inherited from Control.)
Public eventMarginChanged (Inherited from Control.)
Public eventMouseCaptureChanged (Inherited from Control.)
Public eventMouseClick (Inherited from Control.)
Public eventMouseDoubleClick (Inherited from Control.)
Public eventMouseDown (Inherited from Control.)
Public eventMouseEnter (Inherited from Control.)
Public eventMouseHover (Inherited from Control.)
Public eventMouseLeave (Inherited from Control.)
Public eventMouseMove (Inherited from Control.)
Public eventMouseUp (Inherited from Control.)
Public eventMouseWheel (Inherited from Control.)
Public eventMove (Inherited from Control.)
Public eventPaddingChanged (Inherited from Control.)
Public eventPaint (Inherited from Control.)
Public eventParentChanged (Inherited from Control.)
Public eventPasswordRequired
Occurs when password required to open PDF document.
Public eventPostProcessKey
Allows to process key after it was processed by the control.
Public eventPreProcessKey
Allows to process key before it will be processed by the control.
Public eventPreProcessMouseDown
Allows to process MouseDown event before it will be processed by the control.
Public eventPreProcessMouseMove
Allows to process MouseMove event before it will be processed by the control.
Public eventPreProcessMouseUp
Allows to process MouseUp event before it will be processed by the control.
Public eventPreviewKeyDown (Inherited from Control.)
Public eventProgressChanged
Raised for each reported progress value. Allows to cancel the processing.
Public eventQueryAccessibilityHelp (Inherited from Control.)
Public eventQueryContinueDrag (Inherited from Control.)
Public eventRegionChanged (Inherited from Control.)
Public eventResize (Inherited from Control.)
Public eventRightToLeftChanged (Inherited from Control.)
Public eventScroll (Inherited from ScrollableControl.)
Public eventSelectionChanged
Occurs when user changes selection with mouse.
Public eventSizeChanged (Inherited from Control.)
Public eventStyleChanged (Inherited from Control.)
Public eventSystemColorsChanged (Inherited from Control.)
Public eventTabIndexChanged (Inherited from Control.)
Public eventTabStopChanged (Inherited from Control.)
Public eventTextChanged (Inherited from UserControl.)
Public eventValidateContextMenu
Allows to modify control's context menu.
Public eventValidated (Inherited from Control.)
Public eventValidating (Inherited from Control.)
Public eventVisibleChanged (Inherited from Control.)
Top
See Also

Reference