Click or drag to resize

PdfWebControl Class

RAD PDF Web Form Control
Inheritance Hierarchy

Namespace:  RadPdf.Web.UI
Assembly:  RadPdf (in RadPdf.dll) Version: 3.19.5.0 (3.19.5.0)
Syntax
public sealed class PdfWebControl : WebControl, 
	ICallbackEventHandler

The PdfWebControl type exposes the following members.

Constructors
  NameDescription
Public methodPdfWebControl
Initializes a new instance of the PdfWebControl class.
Top
Properties
  NameDescription
Public propertyAccessKey (Inherited from WebControl.)
Protected propertyAdapter (Inherited from Control.)
Public propertyAllowFindMatchingPdf
Gets or sets a value indicating whether a PdfWebControl instance should use a hashing algorithm to try and find an identical copy of the PDF previously used and re-use its already generated resources.
Public propertyAppRelativeTemplateSourceDirectory (Inherited from Control.)
Public propertyAttributes (Inherited from WebControl.)
Public propertyBackColor
Gets or sets the background color of the Web server control.
(Overrides WebControlBackColor.)
Public propertyBasePath
Gets or sets a value representing the base path added to RAD PDF Http Handler requests made by this PdfWebControlLite.
Public propertyBindingContainer (Inherited from Control.)
Public propertyBorderColor (Inherited from WebControl.)
Public propertyBorderStyle (Inherited from WebControl.)
Public propertyBorderWidth (Inherited from WebControl.)
Protected propertyChildControlsCreated (Inherited from Control.)
Public propertyClientID (Inherited from Control.)
Protected propertyClientIDSeparator (Inherited from Control.)
Public propertyCollapseTools
Gets or sets a value indicating whether the tools dialog can collapse and drop down when in use in the PdfWebControl viewer.
Public propertyCollapsibleViewerSide
Gets or sets a value indicating whether the viewer panel (e.g. Thumbnails, Bookmarks, etc.) can collapse (when the already active icon is clicked) in the PdfWebControl viewer.
Protected propertyContext (Inherited from Control.)
Public propertyControls (Inherited from Control.)
Public propertyControlStyle (Inherited from WebControl.)
Public propertyControlStyleCreated (Inherited from WebControl.)
Public propertyConvertImageToPdf
Gets or sets a value indicating whether a PdfWebControl instance should convert supported image types to PDF automatically if used with CreateDocument(String, Byte).
Public propertyConvertXfaForm
Gets or sets a value indicating whether a PdfWebControl instance should convert XFA PDF forms to the more commonly used AcroForms standard.
Public propertyCssClass (Inherited from WebControl.)
Public propertyCultureName
Gets or sets a value representing the culture name of the language used by this PdfWebControl.
Protected propertyDesignMode (Inherited from Control.)
Public propertyDisableKeyboardShortcuts
Gets or sets a value indicating whether keyboard shortcuts in this PdfWebControl are disabled.
Public propertyDisableLinks
Gets or sets a value indicating whether links in the document loaded in this PdfWebControl are disabled.
Public propertyDisableLinkWarning
Gets or sets a value indicating whether a warning is shown in this PdfWebControl when URL links are clicked.
Public propertyDisableLoadThumbnailsOnDemand
Gets or sets a value indicating whether thumbnails in this PdfWebControl are loaded as needed (on demand) or all at once.
Public propertyDisableMoreButton
Gets or sets a value indicating whether a the "More" button should be disabled and hidden in this PdfWebControl.
Public propertyDisablePdfJavaScript
Gets or sets a value indicating whether JavaScript from the PDF document loaded in this PdfWebControl is disabled.
Public propertyDisableTouchGestures
Gets or sets a value indicating whether touch gestures (e.g. pinch-to-zoom page) in this PdfWebControl is disabled.
Public propertyDocumentFileName
Document file name of the currently loaded document.
Public propertyDocumentID
Document ID of the currently loaded document. This Document ID can be used with the LoadDocument(Int32) or CopyDocument(Int32, Boolean) functions.
Public propertyDocumentKey
Gets or sets a value indicating the document key for this PDF document.
Public propertyDocumentKeyMaxAge
Gets or sets a value indicating the maximum age which a document key is valid before it expires
Public propertyDocumentLoaded
Gets a value indicating whether a document is loaded and ready for use in this PdfWebControl instance.
Public propertyDocumentPasswordPending
Gets a value indicating whether the current document is not yet loaded because a password is needed.
Public propertyDocumentProperties
Gets a PdfDocumentProperties class containing common properties describing the document currently loaded.
Public propertyEnabled (Inherited from WebControl.)
Public propertyEnableHtmlColorInput
Gets or sets a value indicating whether a user can input an HTML color directly in the PdfWebControl color picker.
Public propertyEnablePrintSettingsDialog
Gets or sets a value indicating whether the print settings dialog is shown, instead of directly printing a document in a PdfWebControl viewer.
Public propertyEnableRestoreAllPages
Gets or sets a value indicating whether the restore all pages button is shown in a PdfWebControl viewer.
Public propertyEnableTheming (Inherited from WebControl.)
Public propertyEnableUnloadWarning
Gets or sets a value indicating whether a warning is shown when attempt to leave the current page..
Public propertyEnableViewState (Inherited from Control.)
Protected propertyEvents (Inherited from Control.)
Public propertyFont (Inherited from WebControl.)
Public propertyForeColor (Inherited from WebControl.)
Public propertyGroupThumbnails
Gets or sets a value indicating whether the server should render PDF thumbnails in a group for PdfWebControl instances.
Public propertyHasAttributes (Inherited from WebControl.)
Protected propertyHasChildViewState (Inherited from Control.)
Public propertyHeight (Inherited from WebControl.)
Public propertyHideBookmarks
Gets or sets a value indicating whether the left bookmark side panel in the PdfWebControl viewer is disabled and hidden.
Public propertyHideBottomBar
Gets or sets a value indicating whether the bottom tool bar (which contains the search box and page navigation buttons) in the PdfWebControl viewer is hidden.
Public propertyHideDownloadButton
Gets or sets a value indicating whether all download buttons in the PdfWebControl viewer are hidden.
Public propertyHideEditMenu
Gets or sets a value indicating whether the edit menu in the PdfWebControl viewer is hidden.
Public propertyHideFileMenu
Gets or sets a value indicating whether the file menu in the PdfWebControl viewer is hidden.
Public propertyHideFocusOutline
Gets or sets a value indicating whether an outline is hidden when an object is in focus.
Public propertyHideHandScroll
Gets or sets a value indicating whether the hand scroll button in the PdfWebControl viewer is hidden.
Public propertyHideObjectPropertiesBar
Gets or sets a value indicating whether the object property bar should always be hidden (even when an object is selected) in the PdfWebControl viewer is hidden.
Public propertyHidePrintButton
Gets or sets a value indicating whether all print buttons in the PdfWebControl viewer are hidden.
Public propertyHideRightClickMenu
Gets or sets a value indicating whether or not the PdfWebControl's custom drop down menu is shown when an element is right clicked.
Public propertyHideSaveButton
Gets or sets a value indicating whether all save buttons in the PdfWebControl viewer are hidden.
Public propertyHideSearchText
Gets or sets a value indicating whether the search box and buttons in the PdfWebControl viewer is hidden.
Public propertyHideSelectText
Gets or sets a value indicating whether the text selection button in the PdfWebControl viewer is hidden.
Public propertyHideSideBar
Gets or sets a value indicating whether the left tool sidebar in the PdfWebControl viewer is hidden.
Public propertyHideThumbnails
Gets or sets a value indicating whether the left thumbnail side panel in the PdfWebControl viewer is disabled and hidden.
Public propertyHideTips
Gets or sets a value indicating whether tips in the PdfWebControl viewer are hidden.
Public propertyHideToggleHighlightsButton
Gets or sets a value indicating whether buttons which toggle form / annotation highlights in the PdfWebControl viewer are hidden.
Public propertyHideToolsAnnotateTab
Gets or sets a value indicating whether the "Annotate" tools tab in the PdfWebControl viewer is hidden.
Public propertyHideToolsInsertTab
Gets or sets a value indicating whether the "Insert" tools tab in the PdfWebControl viewer is hidden.
Public propertyHideToolsMenu
Gets or sets a value indicating whether the tools menu in the PdfWebControl viewer is hidden.
Public propertyHideToolsPageTab
Gets or sets a value indicating whether the "Page" tools tab in the PdfWebControl viewer is hidden.
Public propertyHideToolsTabs
Gets or sets a value indicating whether all the tools tabs (HideToolsInsertTab, HideToolsAnnotateTab, & HideToolsPageTab tabs) in the PdfWebControl viewer are hidden.
Public propertyHideTopBar
Gets or sets a value indicating whether the top tool bar in the PdfWebControl viewer is hidden.
Public propertyHideViewMenu
Gets or sets a value indicating whether the view menu in the PdfWebControl viewer is hidden.
Public propertyID (Inherited from Control.)
Protected propertyIdSeparator (Inherited from Control.)
Protected propertyIsChildControlStateCleared (Inherited from Control.)
Protected propertyIsEnabled (Inherited from WebControl.)
Protected propertyIsTrackingViewState (Inherited from Control.)
Protected propertyIsViewStateEnabled (Inherited from Control.)
Protected propertyLoadViewStateByID (Inherited from Control.)
Public propertyMaxPdfPageHeight
Public propertyMaxPdfPages
Public propertyMaxPdfPageWidth
Public propertyNamingContainer (Inherited from Control.)
Public propertyOnClientLoad
Gets or sets a value indicating a client side script to execute on load.
Public propertyPage (Inherited from Control.)
Public propertyParent (Inherited from Control.)
Public propertyRenderAtClient
Gets or sets a value indicating whether RAD PDF should render all PDF resources client side.
Public propertyRenderAtClientForPrinting
Gets or sets a value indicating whether RAD PDF should render pages for printing client side.
Public propertyRenderAtClientForViewing
Gets or sets a value indicating whether RAD PDF should render pages and text for the viewer client side.
Public propertyRenderDpi
Gets or sets a value indicating the resolution in dots per inch (DPI) with which a new PDF document should be rendered.
Public propertyRenderOnDemand
Gets or sets a value indicating whether the server should render PDF pages as they are needed by PdfWebControl instances.
Public propertyRenderTextOnDemand
Gets or sets a value indicating whether the server should extract and render PDF text as needed by PdfWebControl instances.
Public propertyRenderThumbnailsOnDemand
Gets or sets a value indicating whether the server should render PDF thumbnails as they are needed by PdfWebControl instances.
Public propertyRenderUnsupportedPdfFeatures
Gets or sets a value indicating whether the server should attempt to render PDF features to the uneditable background if they are not yet supported in a PdfWebControl instance.
Public propertyShowSignatureShapeTool
Gets or sets a value indicating whether the signatures shape tool should be shown in the PdfWebControl viewer.
Public propertySite (Inherited from Control.)
Public propertySkinID (Inherited from WebControl.)
Public propertyStyle (Inherited from WebControl.)
Public propertyTabIndex (Inherited from WebControl.)
Public propertyTabToNextPage
Gets or sets a value indicating whether a user can tab from one page to the next.
Public propertyTabTopToBottom
Gets or sets a value indicating whether the document specified form field tab order is overridden in favor of top to bottom.
Protected propertyTagKey (Inherited from WebControl.)
Protected propertyTagName (Inherited from WebControl.)
Public propertyTemplateControl (Inherited from Control.)
Public propertyTemplateSourceDirectory (Inherited from Control.)
Public propertyThrowMaxPagesException
Public propertyThrowPasswordException
Public propertyThrowXfaFormException
Public propertyToolTip (Inherited from WebControl.)
Public propertyUndoLevels
Gets or sets a value indicating the number of undo levels in this PdfWebControl.
Public propertyUniqueID (Inherited from Control.)
Public propertyViewerHighlightsDefault
Gets or sets a value indicating whether form field and link highlights will initially be shown in the PdfWebControl instance.
Public propertyViewerNamedDestinationDefault
Gets or sets a value indicating the default document named destination which a PdfWebControl instance should initially navigate to.
Public propertyViewerPageDefault
Gets or sets a value indicating the default document page which a PdfWebControl instance should initially open.
Public propertyViewerPageLayoutDefault
Gets or sets a value indicating the default document page layout which a PdfWebControl instance should initially use.
Public propertyViewerScrollXDefault
Gets or sets a value indicating the horizontal scroll position on ViewerPageDefault which a PdfWebControl instance should initially be shown.
Public propertyViewerScrollYDefault
Gets or sets a value indicating the vertical scroll position on ViewerPageDefault which a PdfWebControl instance should initially be shown.
Public propertyViewerSideDefault
Gets or sets a value indicating whether the side panel (if any) which a PdfWebControl instance should initially be shown.
Public propertyViewerZoomDefault
Gets or sets a value indicating the default zoom level which a PdfWebControl instance should initially use.
Protected propertyViewState (Inherited from Control.)
Protected propertyViewStateIgnoresCase (Inherited from Control.)
Public propertyVisible (Inherited from Control.)
Public propertyWidth (Inherited from WebControl.)
Top
Methods
  NameDescription
Protected methodAddAttributesToRender (Inherited from WebControl.)
Protected methodAddedControl (Inherited from Control.)
Protected methodAddParsedSubObject (Inherited from Control.)
Public methodApplyStyle (Inherited from WebControl.)
Public methodApplyStyleSheetSkin (Inherited from Control.)
Protected methodBuildProfileTree (Inherited from Control.)
Protected methodClearChildControlState (Inherited from Control.)
Protected methodClearChildState (Inherited from Control.)
Protected methodClearChildViewState (Inherited from Control.)
Public methodCloseDocument
Close document (if any was created or loaded) reseting the DocumentID and DocumentKey.
Public methodCopyBaseAttributes (Inherited from WebControl.)
Public methodCode exampleCopyDocument(Int32)
Copy an existing a previously loaded PDF document to a new document instance and load it
Public methodCode exampleCopyDocument(Int32, Boolean)
Copy an existing a previously loaded PDF document to a new document instance and load it
Public methodCode exampleCopyDocument(Int32, Boolean, PdfDocumentSettings)
Copy an existing a previously loaded PDF document to a new document instance and load it
Protected methodCreateChildControls (Inherited from Control.)
Protected methodCreateControlCollection (Inherited from Control.)
Protected methodCreateControlStyle (Inherited from WebControl.)
Public methodCode exampleCreateDocument(String, Byte)
Create and load new document from binary data.
Public methodCode exampleCreateDocument(String, Stream)
Create and load new document from stream.
Public methodCode exampleCreateDocument(String, Byte, PdfDocumentSettings)
Create and load new document from binary data and document settings.
Public methodCode exampleCreateDocument(String, Int32, PdfPageSize)
Create and load a new blank PDF document.
Public methodCode exampleCreateDocument(String, Stream, PdfDocumentSettings)
Create and load new document from stream and document settings.
Public methodCode exampleCreateDocument(String, Byte, PdfDocumentSettings, String)
Create and load new document from binary data and document settings.
Public methodCode exampleCreateDocument(String, Int32, PdfPageSize, PdfDocumentSettings)
Create and load a new blank PDF document.
Public methodCode exampleCreateDocument(String, Stream, PdfDocumentSettings, String)
Create and load new document from stream and document settings.
Public methodDataBind (Inherited from Control.)
Protected methodDataBind(Boolean) (Inherited from Control.)
Protected methodDataBindChildren (Inherited from Control.)
Public methodDispose (Inherited from Control.)
Public methodCode exampleEditDocument
Edit a PDF document before it is displayed in a PdfWebControl instance.
Protected methodEnsureChildControls (Inherited from Control.)
Protected methodEnsureID (Inherited from Control.)
Public methodEquals (Inherited from Object.)
Protected methodFinalize (Inherited from Object.)
Public methodFindControl(String) (Inherited from Control.)
Protected methodFindControl(String, Int32) (Inherited from Control.)
Public methodFocus (Inherited from Control.)
Public methodGetCallbackResult
Returns the results of a callback event that targets a control.
Protected methodGetDesignModeState (Inherited from Control.)
Public methodGetHashCode (Inherited from Object.)
Public methodGetOriginalPdf
Retrieves the previously loaded PDF document with no modifications, as a PDF.
Public methodGetPdf
Retrieves a previously loaded PDF document with all saved modifications, as a PDF.
Public methodGetType (Inherited from Object.)
Public methodHasControls (Inherited from Control.)
Protected methodHasEvents (Inherited from Control.)
Public methodImportDocument
Import a previously exported PDF document to a new document instance and load it.
Protected methodIsLiteralContent (Inherited from Control.)
Protected methodLoadControlState
Restores control-state information from a previous page request that was saved by the SaveControlState method.
(Overrides ControlLoadControlState(Object).)
Public methodCode exampleLoadDocument
Load document using the document ID of a previously loaded PDF document
Protected methodLoadViewState
Restores view-state information from a previous page request that was saved by the SaveViewState method.
(Overrides WebControlLoadViewState(Object).)
Protected methodMapPathSecure (Inherited from Control.)
Protected methodMemberwiseClone (Inherited from Object.)
Public methodMergeStyle (Inherited from WebControl.)
Protected methodOnBubbleEvent (Inherited from Control.)
Protected methodOnDataBinding (Inherited from Control.)
Protected methodOnInit
Raises the Init event.
(Overrides ControlOnInit(EventArgs).)
Protected methodOnLoad
Raises the Load event.
(Overrides ControlOnLoad(EventArgs).)
Protected methodOnPreRender
Raises the PreRender event.
(Overrides ControlOnPreRender(EventArgs).)
Protected methodOnUnload (Inherited from Control.)
Protected methodOpenFile (Inherited from Control.)
Protected methodRaiseBubbleEvent (Inherited from Control.)
Public methodRaiseCallbackEvent
Processes a callback event that targets a control.
Protected methodRemovedControl (Inherited from Control.)
Protected methodRender
Renders the PdfWebControl to the specified HTML writer.
(Overrides WebControlRender(HtmlTextWriter).)
Public methodRenderBeginTag
Renders the HTML opening tag of the control to the specified writer.
(Overrides WebControlRenderBeginTag(HtmlTextWriter).)
Protected methodRenderChildren
Outputs the content of a server control's children to a provided HtmlTextWriter object, which writes the content to be rendered on the client.
(Overrides ControlRenderChildren(HtmlTextWriter).)
Protected methodRenderContents
Renders the contents of the control to the specified writer.
(Overrides WebControlRenderContents(HtmlTextWriter).)
Public methodCode exampleRenderControl
Renders the PdfWebControl to a string, for use in advanced applications such as a Custom HttpHandler, inline ASPX pages, or ASP.NET MVC view rendering.
Public methodRenderControl(HtmlTextWriter) (Inherited from Control.)
Public methodCode exampleRenderControl(TextWriter)
Renders the PdfWebControl to the specified text writer, for use in advanced applications such as a Custom HttpHandler or ASP.NET MVC view rendering.
Protected methodRenderControl(HtmlTextWriter, ControlAdapter) (Inherited from Control.)
Public methodRenderEndTag
Renders the HTML closing tag of the control into the specified writer.
(Overrides WebControlRenderEndTag(HtmlTextWriter).)
Public methodStatic memberCode exampleRenderHead
Renders the PdfWebControl required HTML HEAD elements (e.g. script, style, etc.) to the specified text writer, for use in advanced applications such as a Custom HttpHandler, inline ASPX pages, or ASP.NET MVC view rendering.
Public methodStatic memberCode exampleRenderHead(TextWriter)
Renders the PdfWebControl required HTML HEAD elements (e.g. script, style, etc.) to the specified text writer, for use in advanced applications such as a Custom HttpHandler or ASP.NET MVC view rendering.
Protected methodResolveAdapter (Inherited from Control.)
Public methodResolveClientUrl (Inherited from Control.)
Public methodResolveUrl (Inherited from Control.)
Protected methodSaveControlState
Saves any server control state changes that have occurred since the time the page was posted back to the server.
(Overrides ControlSaveControlState.)
Protected methodSaveViewState
Saves any server control view-state changes that have occurred since the time the page was posted back to the server.
(Overrides WebControlSaveViewState.)
Protected methodSetDesignModeState (Inherited from Control.)
Public methodSetRenderMethodDelegate (Inherited from Control.)
Public methodToString
Returns a string that represents the current object rendered to HTML.
(Overrides ObjectToString.)
Protected methodTrackViewState (Inherited from WebControl.)
Top
Events
  NameDescription
Public eventDataBinding (Inherited from Control.)
Public eventDisposed (Inherited from Control.)
Public eventInit (Inherited from Control.)
Public eventLoad (Inherited from Control.)
Public eventPreRender (Inherited from Control.)
Public eventSaved
Informational event which occurs when a document is saved. This event is called via a client callback from a PdfWebControl and hence will only be raised in an ASP.NET Web Forms application.
Public eventUnload (Inherited from Control.)
Top
Fields
  NameDescription
Public fieldStatic memberNoMaxPdfPageHeight
Represents a value indicating that no limit should be set on the maximum page height of pages in a document.
Public fieldStatic memberNoMaxPdfPages
Represents a value indicating that no limit should be set on the maximum number of pages in a document.
Public fieldStatic memberNoMaxPdfPageWidth
Represents a value indicating that no limit should be set on the maximum page width of pages in a document.
Public fieldStatic memberViewerPageDefaultValue
Represents the default page to be shown in a PdfWebControl (the document's default should be used).
Public fieldStatic memberViewerPageLayoutDefaultValue
Represents the default page layout to be shown in a PdfWebControl (the document's default should be used).
Public fieldStatic memberViewerScrollDefaultValue
Represents the default scroll position for a PdfWebControl (the document's default should be used).
Top
Remarks
This class and its members should only be used in a web application setup for a PdfWebControl instance.
See Also