PdfWebControl Class

Initializes a new instance of the PdfWebControl class.

Gets or sets the access key that allows you to quickly navigate to the Web server control.

Gets the browser-specific adapter for the control.

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.

Gets or sets the application-relative virtual directory of the Page or UserControl object that contains this control.

Gets the collection of arbitrary attributes (for rendering only) that do not correspond to properties on the control.

Gets or sets the background color of the Web server control.

Gets or sets a value representing the base path added to RAD PDF Http Handler requests made by this PdfWebControlLite.

Gets the control that contains this control's data binding.

Gets or sets the border color of the Web control.

Gets or sets the border style of the Web server control.

Gets or sets the border width of the Web server control.

Gets a value that indicates whether the server control's child controls have been created.

Gets the control ID for HTML markup that is generated by ASP.NET.

Gets or sets the algorithm that is used to generate the value of the ClientID property.

Gets a character value representing the separator character used in the ClientID property.

Gets or sets a value indicating whether the tools dialog can collapse and drop down when in use in the PdfWebControl viewer.

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.

Gets the HttpContext object associated with the server control for the current Web request.

Gets a ControlCollection object that represents the child controls for a specified server control in the UI hierarchy.

Gets the style of the Web server control. This property is used primarily by control developers.

Gets a value indicating whether a Style object has been created for the ControlStyle property. This property is primarily used by control developers.

Gets or sets a value indicating whether a PdfWebControl instance should convert supported image types to PDF automatically if used with CreateDocument(String, Byte).

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).

Gets or sets a value indicating whether a PdfWebControl instance should convert XFA PDF forms to the more commonly used AcroForms standard.

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).

Gets or sets the Cascading Style Sheet (CSS) class rendered by the Web server control on the client.

Gets or sets a value representing the culture name of the language used by this PdfWebControl.

Gets a reference to the naming container if the naming container implements IDataItemContainer.

Gets a reference to the naming container if the naming container implements IDataKeysControl.

Gets a value indicating whether a control is being used on a design surface.

Gets or sets a value indicating whether the date picker drop down should be disabled for date formatted form fields in this PdfWebControl.

Gets or sets a value indicating whether keyboard shortcuts in this PdfWebControl are disabled.

Gets or sets a value indicating whether links in the document loaded in this PdfWebControl are disabled.

Gets or sets a value indicating whether a warning is shown in this PdfWebControl when URL links are clicked.

Gets or sets a value indicating whether thumbnails in this PdfWebControl are loaded as needed (on demand) or all at once.

Gets or sets a value indicating whether the "More" button should be disabled and hidden in this PdfWebControl.

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.

Gets or sets a value indicating whether JavaScript from the PDF document loaded in this PdfWebControl is disabled.

Gets or sets a value indicating whether the next page should be preloaded in a PdfWebControl.

Gets or sets a value indicating whether the responsive features should be used in PdfWebControl for various devices and screen sizes.

Gets or sets a value indicating whether touch gestures (e.g. pinch-to-zoom page) in this PdfWebControl is disabled.

Document file name of the currently loaded document.

Document ID of the currently loaded document. This Document ID can be used with the LoadDocument(Int32) or CopyDocument(Int32, Boolean) functions.

Gets or sets a value indicating the document key for this PDF document.

Gets or sets a value indicating the maximum age which a document key is valid before it expires

Gets a value indicating whether a document is loaded and ready for use in this PdfWebControl instance.

Gets a value indicating whether the current document is not yet loaded because a password is needed.

Gets a PdfDocumentProperties class containing common properties describing the document currently loaded.

Gets or sets a value indicating whether the Web server control is enabled.

Gets or sets a value indicating whether a user can input an HTML color directly in the PdfWebControl color picker.

Gets or sets a value indicating whether the print settings dialog is shown, instead of directly printing a document in a PdfWebControl viewer.

Gets or sets a value indicating whether redaction options and tools are enabled in the PdfWebControl viewer.

Gets or sets a value indicating whether the restore all pages button is shown in a PdfWebControl viewer.

Gets or sets a value indicating whether themes apply to this control.

Gets or sets a value indicating whether a warning is shown when attempt to leave the current page..

Gets or sets a value indicating whether the server control persists its view state, and the view state of any child controls it contains, to the requesting client.

Gets a list of event handler delegates for the control. This property is read-only.

Gets or sets a value indicating whether a PdfWebControl instance should flatten the input PDF.

Gets the font properties associated with the Web server control.

Gets or sets the foreground color (typically the color of the text) of the Web server control.

Gets or sets a value indicating whether the server should render PDF thumbnails in a group for PdfWebControl instances.

Gets a value indicating whether the control has attributes set.

Gets a value indicating whether the current server control's child controls have any saved view-state settings.

Gets or sets the height of the Web server control.

Gets or sets a value indicating whether the left bookmark side panel in the PdfWebControl viewer is disabled and hidden.

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.

Gets or sets a value indicating whether all download buttons in the PdfWebControl viewer are hidden.

Gets or sets a value indicating whether the edit menu in the PdfWebControl viewer is hidden.

Gets or sets a value indicating whether the left embedded files side panel in the PdfWebControl viewer is disabled and hidden.

Gets or sets a value indicating whether the file menu in the PdfWebControl viewer is hidden.

Gets or sets a value indicating whether an outline is hidden when an object is in focus.

Gets or sets a value indicating whether the hand scroll button in the PdfWebControl viewer is hidden.

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.

Gets or sets a value indicating whether all print buttons in the PdfWebControl viewer are hidden.

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).

Gets or sets a value indicating whether all save buttons in the PdfWebControl viewer are hidden.

Gets or sets a value indicating whether the search box and buttons in the PdfWebControl viewer is hidden.

Gets or sets a value indicating whether the text selection button in the PdfWebControl viewer is hidden.

Gets or sets a value indicating whether the left tool sidebar in the PdfWebControl viewer is hidden.

Gets or sets a value indicating whether the left thumbnail side panel in the PdfWebControl viewer is disabled and hidden.

Gets or sets a value indicating whether tips in the PdfWebControl viewer are hidden.

Gets or sets a value indicating whether buttons which toggle form / annotation highlights in the PdfWebControl viewer are hidden.

Gets or sets a value indicating whether the "Annotate" tools tab in the PdfWebControl viewer is hidden.

Gets or sets a value indicating whether the "Insert" tools tab in the PdfWebControl viewer is hidden.

Gets or sets a value indicating whether the tools menu in the PdfWebControl viewer is hidden.

Gets or sets a value indicating whether the "Page" tools tab in the PdfWebControl viewer is hidden.

Gets or sets a value indicating whether all the tools tabs (HideToolsInsertTab, HideToolsAnnotateTab, & HideToolsPageTab tabs) in the PdfWebControl viewer are hidden.

Gets or sets a value indicating whether the top tool bar in the PdfWebControl viewer is hidden.

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.

Gets or sets a value indicating whether the view menu in the PdfWebControl viewer is hidden.

Gets or sets the programmatic identifier assigned to the server control.

Gets the character used to separate control identifiers.

Gets a value indicating whether controls contained within this control have control state.

Gets a value indicating whether the control is enabled.

Gets a value that indicates whether the server control is saving changes to its view state.

Gets a value indicating whether view state is enabled for this control.

Gets a value indicating whether the control participates in loading its view state by ID instead of index.

Gets or sets a value indicating the maximum height of a page which a PDF can contain when loaded with CreateDocument(String, Byte).

Gets or sets a value indicating the maximum number of pages which a PDF can contain when loaded with CreateDocument(String, Byte).

Gets or sets a value indicating the maximum width of a page which a PDF can contain when loaded with CreateDocument(String, Byte).

Gets a reference to the server control's naming container, which creates a unique namespace for differentiating between server controls with the same ID property value.

Gets or sets a value indicating a client side script to execute on load.

Gets a reference to the Page instance that contains the server control.

Gets a reference to the server control's parent control in the page control hierarchy.

Gets or sets a value indicating whether RAD PDF should render all PDF resources client side.

Gets or sets a value indicating whether RAD PDF should render pages for printing client side.

Gets or sets a value indicating whether RAD PDF should render pages and text for the viewer client side.

Gets or sets a value indicating the resolution in dots per inch (DPI) with which a new PDF document should be rendered.

Gets a value that specifies the ASP.NET version that rendered HTML will be compatible with.

Gets or sets a value indicating whether the server should render PDF pages as they are needed by PdfWebControl instances.

Gets or sets a value indicating whether the server should extract and render PDF text as needed by PdfWebControl instances.

Gets or sets a value indicating whether the server should render PDF thumbnails as they are needed by PdfWebControl instances.

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.

Gets or sets a value indicating whether the preferences option in the PdfWebControl viewer is shown in the file menu dropdown.

Gets or sets a value indicating whether the signatures shape tool should be shown in the PdfWebControl viewer.

Gets information about the container that hosts the current control when rendered on a design surface.

Gets or sets the skin to apply to the control.

Gets a collection of text attributes that will be rendered as a style attribute on the outer tag of the Web server control.

Gets a value that indicates whether the control should set the disabled attribute of the rendered HTML element to "disabled" when the control's IsEnabled property is false.

Gets or sets the tab index of the Web server control.

Gets or sets a value indicating whether a user can tab from one page to the next.

Gets or sets a value indicating whether the document specified form field tab order is overridden in favor of top to bottom.

Gets the HtmlTextWriterTag value that corresponds to this Web server control. This property is used primarily by control developers.

Gets the name of the control tag. This property is used primarily by control developers.

Gets or sets a reference to the template that contains this control.

Gets the virtual directory of the Page or UserControl that contains the current server control.

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.

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.

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.

Gets or sets the text displayed when the mouse pointer hovers over the Web server control.

Gets or sets a value indicating the number of undo levels in this PdfWebControl.

Gets the unique, hierarchically qualified identifier for the server control.

Gets or sets a value indicating whether form field and link highlights will initially be shown in the PdfWebControl instance.

Gets or sets a value indicating the default document named destination which a PdfWebControl instance should initially navigate to.

Gets or sets a value indicating the default document page which a PdfWebControl instance should initially open.

Gets or sets a value indicating the default document page layout which a PdfWebControl instance should initially use.

Gets or sets a value indicating the horizontal scroll position on ViewerPageDefault which a PdfWebControl instance should initially be shown.

Gets or sets a value indicating the vertical scroll position on ViewerPageDefault which a PdfWebControl instance should initially be shown.

Gets or sets a value indicating whether the side panel (if any) which a PdfWebControl instance should initially be shown.

Gets or sets a value indicating the default zoom level which a PdfWebControl instance should initially use.

Gets a dictionary of state information that allows you to save and restore the view state of a server control across multiple requests for the same page.

Gets a value that indicates whether the StateBag object is case-insensitive.

Gets or sets the view-state mode of this control.

Gets or sets a value that indicates whether a server control is rendered as UI on the page.

Gets or sets the width of the Web server control.

Adds HTML attributes and styles that need to be rendered to the specified HtmlTextWriterTag. This method is used primarily by control developers.

Called after a child control is added to the Controls collection of the Control object.

Notifies the server control that an element, either XML or HTML, was parsed, and adds the element to the server control's ControlCollection object.

Copies any nonblank elements of the specified style to the Web control, overwriting any existing style elements of the control. This method is primarily used by control developers.

Applies the style properties defined in the page style sheet to the control.

Gathers information about the server control and delivers it to the Trace property to be displayed when tracing is enabled for the page.

Sets the cached ClientID value to null.

Deletes the control-state information for the server control's child controls.

Deletes the view-state and control-state information for all the server control's child controls.

Deletes the view-state information for all the server control's child controls.

Sets the ClientIDMode property of the current control instance and of any child controls to Inherit.

Close document (if any was created or loaded) reseting the DocumentID and DocumentKey.

Copies the properties not encapsulated by the Style object from the specified Web server control to the Web server control that this method is called from. This method is used primarily by control developers.

Copy an existing a previously loaded PDF document to a new document instance and load it

Copy an existing a previously loaded PDF document to a new document instance and load it

Copy an existing a previously loaded PDF document to a new document instance and load it

Called by the ASP.NET page framework to notify server controls that use composition-based implementation to create any child controls they contain in preparation for posting back or rendering.

Creates a new ControlCollection object to hold the child controls (both literal and server) of the server control.

Creates the style object that is used internally by the WebControl class to implement all style related properties. This method is used primarily by control developers.

Create and load new document from binary data.

Create and load new document from stream.

Create and load new document from binary data and document settings.

Create and load a new blank PDF document.

Create and load new document from stream and document settings.

Create and load new document from binary data and document settings.

Create and load a new blank PDF document.

Create and load new document from stream and document settings.

Binds a data source to the invoked server control and all its child controls.

Binds a data source to the invoked server control and all its child controls with an option to raise the DataBinding event.

Binds a data source to the server control's child controls.

Enables a server control to perform final clean up before it is released from memory.

Edit a PDF document before it is displayed in a PdfWebControl instance.

Determines whether the server control contains child controls. If it does not, it creates child controls.

Creates an identifier for controls that do not have an identifier assigned.

Determines whether the specified Object is equal to the current Object.

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.

Searches the current naming container for a server control with the specified id parameter.

Searches the current naming container for a server control with the specified id and an integer, specified in the pathOffset parameter, which aids in the search. You should not override this version of the FindControl method.

Sets input focus to a control.

Returns the results of a callback event that targets a control.

Gets design-time data for a control.

Serves as a hash function for a particular type.

Retrieves the previously loaded PDF document with no modifications, as a PDF.

Retrieves a previously loaded PDF document with all saved modifications, as a PDF.

Gets the URL that corresponds to a set of route parameters.

Gets the URL that corresponds to a set of route parameters.

Gets the URL that corresponds to a set of route parameters and a route name.

Gets the URL that corresponds to a set of route parameters and a route name.

Gets the Type of the current instance.

Returns the prefixed portion of the UniqueID property of the specified control.

Determines if the server control contains any child controls.

Returns a value indicating whether events are registered for the control or any child controls.

Import a previously exported PDF document to a new document instance and load it.

Determines if the server control holds only literal content.

Restores control-state information from a previous page request that was saved by the SaveControlState method.

Load document using the document ID of a previously loaded PDF document

Restores view-state information from a previous page request that was saved by the SaveViewState method.

Retrieves the physical path that a virtual path, either absolute or relative, maps to.

Creates a shallow copy of the current Object.

Copies any nonblank elements of the specified style to the Web control, but will not overwrite any existing style elements of the control. This method is used primarily by control developers.

Determines whether the event for the server control is passed up the page's UI server control hierarchy.

Raises the DataBinding event.

Raises the Init event.

Raises the Load event.

Raises the PreRender event.

Raises the Unload event.

Gets a Stream used to read a file.

Assigns any sources of the event and its information to the control's parent.

Processes a callback event that targets a control.

Called after a child control is removed from the Controls collection of the Control object.

Renders the PdfWebControl to the specified HTML writer.

Renders the HTML opening tag of the control to the specified writer.

Outputs the content of a server control's children to a provided HtmlTextWriter object, which writes the content to be rendered on the client.

Renders the contents of the control to the specified writer.

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.

Outputs server control content to a provided HtmlTextWriter object and stores tracing information about the control if tracing is enabled.

Renders the PdfWebControl to the specified text writer, for use in advanced applications such as a Custom HttpHandler or ASP.NET MVC view rendering.

Outputs server control content to a provided HtmlTextWriter object using a provided ControlAdapter object.

Renders the HTML closing tag of the control into the specified writer.

Gets a value representing the URL of the IFRAME which RAD PDF is using internally to display the document instance.

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.

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.

Gets a value representing the URL of the HEAD SCRIPT which RAD PDF generates for Client API usage.

Gets a value representing the viewstate of a RAD PDF instance.

Gets the control adapter responsible for rendering the specified control.

Gets a URL that can be used by the browser.

Converts a URL into one that is usable on the requesting client.

Saves any server control state changes that have occurred since the time the page was posted back to the server.

Saves any server control view-state changes that have occurred since the time the page was posted back to the server.

Sets design-time data for a control.

Assigns an event handler delegate to render the server control and its content into its parent control.

Returns a string that represents the current object rendered to HTML.

Causes the control to track changes to its view state so they can be stored in the object's ViewState property.

Occurs when the server control binds to a data source.

Occurs when a server control is released from memory, which is the last stage of the server control lifecycle when an ASP.NET page is requested.

Occurs when the server control is initialized, which is the first step in its lifecycle.

Occurs when the server control is loaded into the Page object.

Occurs after the Control object is loaded but prior to rendering.

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.

Occurs when the server control is unloaded from memory.

Represents a value indicating that no limit should be set on the maximum page height of pages in a document.

Represents a value indicating that no limit should be set on the maximum number of pages in a document.

Represents a value indicating that no limit should be set on the maximum page width of pages in a document.

Represents the assembly version of this build, as a string.

Represents the default page to be shown in a PdfWebControl (the document's default should be used).

Represents the default page layout to be shown in a PdfWebControl (the document's default should be used).

Represents the default scroll position for a PdfWebControl (the document's default should be used).