PdfWebControl Class |
RAD PDF Web Form Control
Inheritance HierarchyNamespace: RadPdf.Web.UI
Assembly: RadPdfStandard (in RadPdfStandard.dll) Version: 4.7.0.0 (4.7.0.0)
SyntaxThe PdfWebControl type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | PdfWebControl |
Initializes a new instance of the PdfWebControl class.
|
Properties| Name | Description | |
|---|---|---|
 | AllowFindMatchingPdf |
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.
|
| BackColor |
Gets or sets the background color of the Web server control.
|
| BasePath |
Gets or sets a value representing the base path added to RAD PDF Http Handler requests made by this PdfWebControlLite.
|
| ClientID |
Gets the control ID for HTML markup that is generated by RAD PDF (similar to ASP.NET Web Forms).
|
| ClientIDSeparator |
Gets a character value representing the separator character used in the ClientID property.
|
| CollapseTools |
Gets or sets a value indicating whether the tools dialog can collapse and drop down when in use in the PdfWebControl viewer.
|
| CollapsibleViewerSide |
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.
|
| ConvertImageToPdf |
Gets or sets a value indicating whether a PdfWebControl instance should convert supported image types to PDF automatically if used with CreateDocument(String, Byte).
|
| ConvertMeaninglessCollections |
Gets or sets a value indicating whether a PdfWebControl instance should convert meaningless PDF collections (where the base PDF is asking for a reader "upgrade") to a single PDF (with pages appended) automatically if used with CreateDocument(String, Byte).
|
| ConvertSignatureFieldsToShapes |
Gets or sets a value indicating whether a PdfWebControl instance should convert signature fields to natively signable signature shapes.
|
| ConvertXfaForm |
Gets or sets a value indicating whether a PdfWebControl instance should convert XFA PDF forms to the more commonly used AcroForms standard.
|
| CspSaferRendering |
Gets or sets a value representing if the PdfWebControl control should be rendered without inline scripts or styles, allowing for safer compliance with a CSP (Content Security Policy).
|
| CultureName |
Gets or sets a value representing the culture name of the language used by this PdfWebControl.
|
| DisableDatePicker |
Gets or sets a value indicating whether the date picker drop down should be disabled for date formatted form fields in this PdfWebControl.
|
| DisableKeyboardShortcuts |
Gets or sets a value indicating whether keyboard shortcuts in this PdfWebControl are disabled.
|
| DisableLinks |
Gets or sets a value indicating whether links in the document loaded in this PdfWebControl are disabled.
|
| DisableLinkWarning |
Gets or sets a value indicating whether a warning is shown in this PdfWebControl when URL links are clicked.
|
| DisableLoadThumbnailsOnDemand |
Gets or sets a value indicating whether thumbnails in this PdfWebControl are loaded as needed (on demand) or all at once.
|
| DisableMoreButton |
Gets or sets a value indicating whether the "More" button should be disabled and hidden in this PdfWebControl.
|
| DisableMultiAdd |
Gets or sets a value indicating whether mutliple objects can be added in a row using the PdfWebControl.
|
| DisablePageLabels |
Gets or sets a value indicating whether page labels embedded in the PDF file should be used instead of the default "# of #" format for page labels in a PdfWebControl instance.
|
| DisablePdfJavaScript |
Gets or sets a value indicating whether JavaScript from the PDF document loaded in this PdfWebControl is disabled.
|
| DisablePreloading |
Gets or sets a value indicating whether the next page should be preloaded in a PdfWebControl.
|
| DisableResponsive |
Gets or sets a value indicating whether the responsive features should be used in PdfWebControl for various devices and screen sizes.
|
| DisableResponsiveAdditions |
Gets or sets a value indicating whether the responsive features specific to adding objects should be used in PdfWebControl for various devices and screen sizes.
|
| DisableTouchGestures |
Gets or sets a value indicating whether touch gestures (e.g. pinch-to-zoom page) in this PdfWebControl is disabled.
|
| DocumentFileName |
Document file name of the currently loaded document.
|
| DocumentID |
Document ID of the currently loaded document. This Document ID can be used with the LoadDocument(Int32) or CopyDocument(Int32, Boolean) functions.
|
| DocumentKey |
Gets or sets a value indicating the document key for this PDF document.
|
| DocumentKeyMaxAge |
Gets or sets a value indicating the maximum age which a document key is valid before it expires
|
| DocumentLoaded |
Gets a value indicating whether a document is loaded and ready for use in this PdfWebControl instance.
|
| DocumentPasswordPending |
Gets a value indicating whether the current document is not yet loaded because a password is needed.
|
| DocumentProperties |
Gets a PdfDocumentProperties class containing common properties describing the document currently loaded.
|
| EnableHtmlColorInput |
Gets or sets a value indicating whether a user can input an HTML color directly in the PdfWebControl color picker.
|
| EnablePathMerging |
Gets or sets a value indicating whether a user drawn paths are merged into a single object when added in the PdfWebControl.
|
| EnablePrintSettingsDialog |
Gets or sets a value indicating whether the print settings dialog is shown, instead of directly printing a document in a PdfWebControl viewer.
|
| EnableRedaction |
Gets or sets a value indicating whether redaction options and tools are enabled in the PdfWebControl viewer.
|
| EnableRestoreAllPages |
Gets or sets a value indicating whether the restore all pages button is shown in a PdfWebControl viewer.
|
| EnableUnloadWarning |
Gets or sets a value indicating whether a warning is shown when attempt to leave the current page..
|
| FlattenInput |
Gets or sets a value indicating whether a PdfWebControl instance should flatten the input PDF.
|
| GroupThumbnails |
Gets or sets a value indicating whether the server should render PDF thumbnails in a group for PdfWebControl instances.
|
| Height |
Gets or sets the height of the Web server control.
|
| HideBookmarks |
Gets or sets a value indicating whether the left bookmark side panel in the PdfWebControl viewer is disabled and hidden.
|
| HideBottomBar |
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.
|
| HideDownloadButton |
Gets or sets a value indicating whether all download buttons in the PdfWebControl viewer are hidden.
|
| HideEditMenu |
Gets or sets a value indicating whether the edit menu in the PdfWebControl viewer is hidden.
|
| HideEmbeddedFiles |
Gets or sets a value indicating whether the left embedded files side panel in the PdfWebControl viewer is disabled and hidden.
|
| HideFileMenu |
Gets or sets a value indicating whether the file menu in the PdfWebControl viewer is hidden.
|
| HideFocusOutline |
Gets or sets a value indicating whether an outline is hidden when an object is in focus.
|
| HideHandScroll |
Gets or sets a value indicating whether the hand scroll button in the PdfWebControl viewer is hidden.
|
| HideObjectPropertiesBar |
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.
|
| HideObjectPropertiesBarExtended |
Gets or sets a value indicating whether the extended (e.g font, color, etc) object property bar should always be hidden (even when an object is selected) in the PdfWebControl viewer.
|
| HidePrintButton |
Gets or sets a value indicating whether all print buttons in the PdfWebControl viewer are hidden.
|
| HideRightClickMenu |
Gets or sets a value indicating whether or not the PdfWebControl's custom drop down menu is shown when an element is right clicked (or long pressed / long touched).
|
| HideSaveButton |
Gets or sets a value indicating whether all save buttons in the PdfWebControl viewer are hidden.
|
| HideSearchText |
Gets or sets a value indicating whether the search box and buttons in the PdfWebControl viewer is hidden.
|
| HideSelectText |
Gets or sets a value indicating whether the text selection button in the PdfWebControl viewer is hidden.
|
| HideSideBar |
Gets or sets a value indicating whether the left tool sidebar in the PdfWebControl viewer is hidden.
|
| HideThumbnails |
Gets or sets a value indicating whether the left thumbnail side panel in the PdfWebControl viewer is disabled and hidden.
|
| HideTips |
Gets or sets a value indicating whether tips in the PdfWebControl viewer are hidden.
|
| HideToggleHighlightsButton |
Gets or sets a value indicating whether buttons which toggle form / annotation highlights in the PdfWebControl viewer are hidden.
|
| HideToolsAnnotateTab |
Gets or sets a value indicating whether the "Annotate" tools tab in the PdfWebControl viewer is hidden.
|
| HideToolsInsertTab |
Gets or sets a value indicating whether the "Insert" tools tab in the PdfWebControl viewer is hidden.
|
| HideToolsMenu |
Gets or sets a value indicating whether the tools menu in the PdfWebControl viewer is hidden.
|
| HideToolsPageTab |
Gets or sets a value indicating whether the "Page" tools tab in the PdfWebControl viewer is hidden.
|
| HideToolsTabs |
Gets or sets a value indicating whether all the tools tabs (HideToolsInsertTab, HideToolsAnnotateTab, & HideToolsPageTab tabs) in the PdfWebControl viewer are hidden.
|
| HideTopBar |
Gets or sets a value indicating whether the top tool bar in the PdfWebControl viewer is hidden.
|
| HideTopMenus |
Gets or sets a value indicating whether the top tool menu in the PdfWebControl viewer is hidden, allowing for view and text tools to be slimmed down.
|
| HideViewMenu |
Gets or sets a value indicating whether the view menu in the PdfWebControl viewer is hidden.
|
| ID |
Gets or sets the programmatic identifier assigned to the server control.
|
| MaxPdfPageHeight |
Gets or sets a value indicating the maximum height of a page which a PDF can contain when loaded with CreateDocument(String, Byte).
|
| MaxPdfPages |
Gets or sets a value indicating the maximum number of pages which a PDF can contain when loaded with CreateDocument(String, Byte).
|
| MaxPdfPageWidth |
Gets or sets a value indicating the maximum width of a page which a PDF can contain when loaded with CreateDocument(String, Byte).
|
| OnClientLoad |
Gets or sets a value indicating a client side script to execute on load.
|
| RenderAtClient |
Gets or sets a value indicating whether RAD PDF should render all PDF resources client side.
|
| RenderAtClientForPrinting |
Gets or sets a value indicating whether RAD PDF should render pages for printing client side.
|
| RenderAtClientForViewing |
Gets or sets a value indicating whether RAD PDF should render pages and text for the viewer client side.
|
| RenderDpi |
Gets or sets a value indicating the resolution in dots per inch (DPI) with which a new PDF document should be rendered.
|
| RenderOnDemand |
Gets or sets a value indicating whether the server should render PDF pages as they are needed by PdfWebControl instances.
|
| RenderTextOnDemand |
Gets or sets a value indicating whether the server should extract and render PDF text as needed by PdfWebControl instances.
|
| RenderThumbnailsOnDemand |
Gets or sets a value indicating whether the server should render PDF thumbnails as they are needed by PdfWebControl instances.
|
| RenderUnsupportedPdfFeatures |
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.
|
| ShowPreferences |
Gets or sets a value indicating whether the preferences option in the PdfWebControl viewer is shown in the file menu dropdown.
|
| ShowSignatureShapeTool |
Gets or sets a value indicating whether the signatures shape tool should be shown in the PdfWebControl viewer.
|
| TabToNextPage |
Gets or sets a value indicating whether a user can tab from one page to the next.
|
| TabTopToBottom |
Gets or sets a value indicating whether the document specified form field tab order is overridden in favor of top to bottom.
|
| Theme |
Gets or sets a value indicating which theme should be used in a PdfWebControl instance.
|
| ThrowMaxPagesException |
Gets or sets a value indicating whether a RadPdfPdfProcessingMaxPagesException should be thrown when CreateDocument(String, Byte) attempts to load a PDF containing more pages than allowed by MaxPdfPages.
|
| ThrowPasswordException |
Gets or sets a value indicating whether a RadPdfPdfProcessingPasswordException should be thrown when CreateDocument(String, Byte, PdfDocumentSettings, String) is called on an encrypted PDF and the password is missing or invalid.
|
| ThrowXfaFormException |
Gets or sets a value indicating whether a RadPdfPdfProcessingXfaFormException should be thrown when CreateDocument(String, Byte, PdfDocumentSettings, String) is called on an PDF containing an XFA form and ConvertXfaForm is false.
|
| UndoLevels |
Gets or sets a value indicating the number of undo levels in this PdfWebControl.
|
| UniqueID |
Gets the unique, hierarchically qualified identifier for the server control.
|
| ViewerHighlightsDefault |
Gets or sets a value indicating whether form field and link highlights will initially be shown in the PdfWebControl instance.
|
| ViewerNamedDestinationDefault |
Gets or sets a value indicating the default document named destination which a PdfWebControl instance should initially navigate to.
|
| ViewerPageDefault |
Gets or sets a value indicating the default document page which a PdfWebControl instance should initially open.
|
| ViewerPageLayoutDefault |
Gets or sets a value indicating the default document page layout which a PdfWebControl instance should initially use.
|
| ViewerScrollXDefault |
Gets or sets a value indicating the horizontal scroll position on ViewerPageDefault which a PdfWebControl instance should initially be shown.
|
| ViewerScrollYDefault |
Gets or sets a value indicating the vertical scroll position on ViewerPageDefault which a PdfWebControl instance should initially be shown.
|
| ViewerSideDefault |
Gets or sets a value indicating whether the side panel (if any) which a PdfWebControl instance should initially be shown.
|
| ViewerZoomDefault |
Gets or sets a value indicating the default zoom level which a PdfWebControl instance should initially use.
|
| Width |
Gets or sets the width of the Web server control.
|
Methods| Name | Description | |
|---|---|---|
| CloseDocument |
Close document (if any was created or loaded) reseting the DocumentID and DocumentKey.
|
 | CopyDocument(Int32) |
Copy an existing a previously loaded PDF document to a new document instance and load it
|
| CopyDocument(Int32, Boolean) |
Copy an existing a previously loaded PDF document to a new document instance and load it
|
| CopyDocument(Int32, Boolean, PdfDocumentSettings) |
Copy an existing a previously loaded PDF document to a new document instance and load it
|
| CreateDocument(String, Byte) |
Create and load new document from binary data.
|
| CreateDocument(String, Stream) |
Create and load new document from stream.
|
| CreateDocument(String, Byte, PdfDocumentSettings) |
Create and load new document from binary data and document settings.
|
| CreateDocument(String, Int32, PdfPageSize) |
Create and load a new blank PDF document.
|
| CreateDocument(String, Stream, PdfDocumentSettings) |
Create and load new document from stream and document settings.
|
| CreateDocument(String, Byte, PdfDocumentSettings, String) |
Create and load new document from binary data and document settings.
|
| CreateDocument(String, Int32, PdfPageSize, PdfDocumentSettings) |
Create and load a new blank PDF document.
|
| CreateDocument(String, Stream, PdfDocumentSettings, String) |
Create and load new document from stream and document settings.
|
| EditDocument |
Edit a PDF document before it is displayed in a PdfWebControl instance.
|
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetOriginalPdf |
Retrieves the previously loaded PDF document with no modifications, as a PDF.
|
| GetPdf |
Retrieves a previously loaded PDF document with all saved modifications, as a PDF.
|
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| ImportDocument |
Import a previously exported PDF document to a new document instance and load it.
|
| LoadDocument |
Load document using the document ID of a previously loaded PDF document
|
| RenderControl |
Renders the PdfWebControl to a string, for use in advanced applications such as a custom Middleware, inline ASPX page, ASP.NET MVC view rendering, a HttpHandler, or Web Application API.
|
| RenderControl(TextWriter) |
Renders the PdfWebControl to the specified text writer, for use in advanced applications such as a custom Middleware, inline ASPX page, ASP.NET MVC view rendering, a HttpHandler, or Web Application API.
|
| RenderFrameUrl |
Gets a value representing the URL of the IFRAME which RAD PDF is using internally to display the document instance.
|
 | RenderHead |
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 Middleware, inline ASPX page, ASP.NET MVC view rendering, a HttpHandler, or Web API.
|
| RenderHead(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 Middleware, inline ASPX page, ASP.NET MVC view rendering, a HttpHandler, or Web API.
|
| RenderHeadUrl |
Gets a value representing the URL of the HEAD SCRIPT which RAD PDF generates for Client API usage.
|
| RenderViewStateJson |
Gets a value representing the viewstate of a RAD PDF instance.
|
| ToString |
Returns a string that represents the current object rendered to HTML.
(Overrides ObjectToString.) |
Fields| Name | Description | |
|---|---|---|
 | NoMaxPdfPageHeight |
Represents a value indicating that no limit should be set on the maximum page height of pages in a document.
|
| NoMaxPdfPages |
Represents a value indicating that no limit should be set on the maximum number of pages in a document.
|
| NoMaxPdfPageWidth |
Represents a value indicating that no limit should be set on the maximum page width of pages in a document.
|
| Version |
Represents the assembly version of this build, as a string.
|
| ViewerPageDefaultValue |
Represents the default page to be shown in a PdfWebControl (the document's default should be used).
|
| ViewerPageLayoutDefaultValue |
Represents the default page layout to be shown in a PdfWebControl (the document's default should be used).
|
| ViewerScrollDefaultValue |
Represents the default scroll position for a PdfWebControl (the document's default should be used).
|
RemarksThis class and its members should only be used in a web application setup for a PdfWebControl instance.
See Also