PdfWebControlLite Class |
RAD PDF Web Form Control Lite
Inheritance HierarchyNamespace: RadPdf.Web.UI
Assembly: RadPdfStandard (in RadPdfStandard.dll) Version: 4.7.0.0 (4.7.0.0)
SyntaxThe PdfWebControlLite type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | PdfWebControlLite |
Initializes a new instance of the PdfWebControlLite class.
|
Properties| Name | Description | |
|---|---|---|
 | 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 ASP.NET.
|
| 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 PdfWebControlLite 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 PdfWebControlLite viewer.
|
| CspSaferRendering |
Gets or sets a value representing if the PdfWebControlLite 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 PdfWebControlLite.
|
| DisableDatePicker |
Gets or sets a value indicating whether the date picker drop down should be disabled for date formatted form fields in this PdfWebControlLite.
|
| DisableKeyboardShortcuts |
Gets or sets a value indicating whether keyboard shortcuts in this PdfWebControlLite are disabled.
|
| DisableLinks |
Gets or sets a value indicating whether links in the document loaded in this PdfWebControlLite are disabled.
|
| DisableLinkWarning |
Gets or sets a value indicating whether a warning is shown in this PdfWebControlLite when URL links are clicked.
|
| DisableLoadThumbnailsOnDemand |
Gets or sets a value indicating whether thumbnails in this PdfWebControlLite 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 PdfWebControlLite.
|
| DisableMultiAdd |
Gets or sets a value indicating whether mutliple objects can be added in a row using the PdfWebControlLite.
|
| 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 PdfWebControlLite instance.
|
| DisablePdfJavaScript |
Gets or sets a value indicating whether JavaScript from the PDF document loaded in this PdfWebControlLite is disabled.
|
| DisablePreloading |
Gets or sets a value indicating whether the next page should be preloaded in a PdfWebControlLite.
|
| 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 PdfWebControlLite for various devices and screen sizes.
|
| DisableTouchGestures |
Gets or sets a value indicating whether touch gestures (e.g. pinch-to-zoom page) in this PdfWebControlLite is disabled.
|
| DocumentKey |
Gets or sets a value indicating the document key for this PDF document.
|
| DocumentLoaded |
Gets a value indicating whether a document is loaded and ready for use in this PdfWebControlLite 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.
|
| DocumentSession |
Gets a PdfLiteSession class containing session information about the loaded document if DocumentLoaded is true in this PdfWebControlLite instance; otherwise null.
|
| EnableHtmlColorInput |
Gets or sets a value indicating whether a user can input an HTML color directly in the PdfWebControlLite 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 PdfWebControlLite viewer.
|
| EnableRedaction |
Gets or sets a value indicating whether redaction options and tools are enabled in the PdfWebControlLite viewer.
|
| EnableRestoreAllPages |
Gets or sets a value indicating whether the restore all pages button is shown in a PdfWebControlLite viewer.
|
| EnableUnloadWarning |
Gets or sets a value indicating whether a warning is shown when attempt to leave the current page..
|
| 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 PdfWebControlLite 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 PdfWebControlLite viewer is hidden.
|
| HideDownloadButton |
Gets or sets a value indicating whether all download buttons in the PdfWebControlLite viewer are hidden.
|
| HideEditMenu |
Gets or sets a value indicating whether the edit menu in the PdfWebControlLite viewer is hidden.
|
| HideEmbeddedFiles |
Gets or sets a value indicating whether the left embedded files side panel in the PdfWebControlLite viewer is disabled and hidden.
|
| HideFileMenu |
Gets or sets a value indicating whether the file menu in the PdfWebControlLite 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 PdfWebControlLite 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 PdfWebControlLite viewer is hidden.
|
| 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 PdfWebControlLite viewer.
|
| HidePrintButton |
Gets or sets a value indicating whether all print buttons in the PdfWebControlLite viewer are hidden.
|
| HideRightClickMenu |
Gets or sets a value indicating whether or not the PdfWebControlLite's custom drop down menu is shown when an element is right clicked.
|
| HideSaveButton |
Gets or sets a value indicating whether all save buttons in the PdfWebControlLite viewer are hidden.
|
| HideSearchText |
Gets or sets a value indicating whether the search box and buttons in the PdfWebControlLite viewer is hidden.
|
| HideSelectText |
Gets or sets a value indicating whether the text selection button in the PdfWebControlLite viewer is hidden.
|
| HideSideBar |
Gets or sets a value indicating whether the left tool sidebar in the PdfWebControlLite viewer is hidden.
|
| HideThumbnails |
Gets or sets a value indicating whether the left thumbnail side panel in the PdfWebControlLite viewer is disabled and hidden.
|
| HideTips |
Gets or sets a value indicating whether tips in the PdfWebControlLite viewer are hidden.
|
| HideToggleHighlightsButton |
Gets or sets a value indicating whether buttons which toggle form / annotation highlights in the PdfWebControlLite viewer are hidden.
|
| HideToolsAnnotateTab |
Gets or sets a value indicating whether the "Annotate" tools tab in the PdfWebControlLite viewer is hidden.
|
| HideToolsInsertTab |
Gets or sets a value indicating whether the "Insert" tools tab in the PdfWebControlLite viewer is hidden.
|
| HideToolsMenu |
Gets or sets a value indicating whether the tools menu in the PdfWebControlLite viewer is hidden.
|
| HideToolsPageTab |
Gets or sets a value indicating whether the "Page" tools tab in the PdfWebControlLite viewer is hidden.
|
| HideToolsTabs |
Gets or sets a value indicating whether all the tools tabs (HideToolsInsertTab, HideToolsAnnotateTab, & HideToolsPageTab tabs) in the PdfWebControlLite 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 PdfWebControlLite viewer is hidden.
|
| ID |
Gets or sets the programmatic identifier assigned to the server control.
|
| 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.
|
| ShowSignatureShapeTool |
Gets or sets a value indicating whether the signatures shape tool should be shown in the PdfWebControlLite 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 PdfWebControlLite instance.
|
| UndoLevels |
Gets or sets a value indicating the number of undo levels in this PdfWebControlLite.
|
| 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 PdfWebControlLite instance.
|
| ViewerNamedDestinationDefault |
Gets or sets a value indicating the default document named destination which a PdfWebControlLite instance should initially navigate to.
|
| ViewerPageDefault |
Gets or sets a value indicating the default document page which a PdfWebControlLite instance should initially open.
|
| ViewerPageLayoutDefault |
Gets or sets a value indicating the default document page layout which a PdfWebControlLite instance should initially use.
|
| ViewerScrollXDefault |
Gets or sets a value indicating the horizontal scroll position on ViewerPageDefault which a PdfWebControlLite instance should initially be shown.
|
| ViewerScrollYDefault |
Gets or sets a value indicating the vertical scroll position on ViewerPageDefault which a PdfWebControlLite instance should initially be shown.
|
| ViewerSideDefault |
Gets or sets a value indicating whether the side panel (if any) which a PdfWebControlLite instance should initially be shown.
|
| ViewerZoomDefault |
Gets or sets a value indicating the default zoom level which a PdfWebControlLite 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 DocumentKey.
|
 | CopyDocument |
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, PdfLiteSettings) |
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, PdfLiteSettings) |
Create and load new document from stream and document settings.
|
| CreateDocument(String, Byte, PdfLiteSettings, String) |
Create and load new document from binary data and document settings.
|
| CreateDocument(String, Int32, PdfPageSize, PdfLiteSettings) |
Create and load a new blank PDF document.
|
| CreateDocument(String, Stream, PdfLiteSettings, String) |
Create and load new document from stream and document settings.
|
| CreateEmptyDocument |
Create empty document container to which the user can upload any PDF document, using the file name as uploaded
|
| CreateEmptyDocument(String) |
Create empty document container to which the user can upload any PDF document
|
| CreateEmptyDocument(PdfLiteSettings) |
Create empty document container to which the user can upload any PDF document, using the file name as uploaded
|
| CreateEmptyDocument(String, PdfLiteSettings) |
Create empty document container to which the user can upload any PDF document
|
| EditDocument |
Edit a PDF document before it is displayed in a PdfWebControlLite 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(Byte) |
Import a previously exported PDF document to a new document instance and load it.
|
| ImportDocument(Byte, PdfLiteSettings) |
Import a previously exported PDF document to a new document instance and load it.
|
| LoadDocument |
Load document using the session info of a previously loaded Lite Document.
|
| RenderControl |
Renders the PdfWebControlLite 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 PdfWebControlLite 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.
|
| RenderFrameUrl |
Gets a value representing the URL of the IFRAME which RAD PDF is using internally to display the document instance.
|
 | RenderHead |
Renders the PdfWebControlLite 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 PdfWebControlLite 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 pages, ASP.NET MVC view rendering, HttpHandlers, or Web Application APIs
|
| 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 | |
|---|---|---|
 | Version |
Represents the assembly version of this build, as a string.
|
| ViewerPageDefaultValue |
Represents the default page to be shown in a PdfWebControlLite (the document's default should be used).
|
| ViewerPageLayoutDefaultValue |
Represents the default page layout to be shown in a PdfWebControlLite (the document's default should be used).
|
| ViewerScrollDefaultValue |
Represents the default scroll position for a PdfWebControlLite (the document's default should be used).
|
RemarksThis class and its members should only be used in a web application setup for a PdfWebControlLite instance.
When using the PdfWebControlLite, either the RAD PDF System Service Storage must be enabled or a custom PdfLiteStorageProvider implemented.
See Also