Click or drag to resize

PdfWebControl Methods

The PdfWebControl type exposes the following members.

Methods
  NameDescription
Protected methodAddAttributesToRender
Adds HTML attributes and styles that need to be rendered to the specified HtmlTextWriterTag. This method is used primarily by control developers.
(Inherited from WebControl.)
Protected methodAddedControl
Called after a child control is added to the Controls collection of the Control object.
(Inherited from Control.)
Protected methodAddParsedSubObject
Notifies the server control that an element, either XML or HTML, was parsed, and adds the element to the server control's ControlCollection object.
(Inherited from Control.)
Public methodApplyStyle
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.
(Inherited from WebControl.)
Public methodApplyStyleSheetSkin
Applies the style properties defined in the page style sheet to the control.
(Inherited from Control.)
Protected methodBuildProfileTree
Gathers information about the server control and delivers it to the Trace property to be displayed when tracing is enabled for the page.
(Inherited from Control.)
Protected methodClearCachedClientID
Sets the cached ClientID value to null.
(Inherited from Control.)
Protected methodClearChildControlState
Deletes the control-state information for the server control's child controls.
(Inherited from Control.)
Protected methodClearChildState
Deletes the view-state and control-state information for all the server control's child controls.
(Inherited from Control.)
Protected methodClearChildViewState
Deletes the view-state information for all the server control's child controls.
(Inherited from Control.)
Protected methodClearEffectiveClientIDMode
Sets the ClientIDMode property of the current control instance and of any child controls to Inherit.
(Inherited from Control.)
Public methodCloseDocument
Close document (if any was created or loaded) reseting the DocumentID and DocumentKey.
Public methodCopyBaseAttributes
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.
(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
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.
(Inherited from Control.)
Protected methodCreateControlCollection
Creates a new ControlCollection object to hold the child controls (both literal and server) of the server control.
(Inherited from Control.)
Protected methodCreateControlStyle
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.
(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
Binds a data source to the invoked server control and all its child controls.
(Inherited from Control.)
Protected methodDataBind(Boolean)
Binds a data source to the invoked server control and all its child controls with an option to raise the DataBinding event.
(Inherited from Control.)
Protected methodDataBindChildren
Binds a data source to the server control's child controls.
(Inherited from Control.)
Public methodDispose
Enables a server control to perform final clean up before it is released from memory.
(Inherited from Control.)
Public methodCode exampleEditDocument
Edit a PDF document before it is displayed in a PdfWebControl instance.
Protected methodEnsureChildControls
Determines whether the server control contains child controls. If it does not, it creates child controls.
(Inherited from Control.)
Protected methodEnsureID
Creates an identifier for controls that do not have an identifier assigned.
(Inherited from Control.)
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodFindControl(String)
Searches the current naming container for a server control with the specified id parameter.
(Inherited from Control.)
Protected methodFindControl(String, Int32)
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.
(Inherited from Control.)
Public methodFocus
Sets input focus to a control.
(Inherited from Control.)
Public methodGetCallbackResult
Returns the results of a callback event that targets a control.
Protected methodGetDesignModeState
Gets design-time data for a control.
(Inherited from Control.)
Public methodGetHashCode
Serves as a hash function for a particular type.
(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 methodGetRouteUrl(Object)
Gets the URL that corresponds to a set of route parameters.
(Inherited from Control.)
Public methodGetRouteUrl(RouteValueDictionary)
Gets the URL that corresponds to a set of route parameters.
(Inherited from Control.)
Public methodGetRouteUrl(String, Object)
Gets the URL that corresponds to a set of route parameters and a route name.
(Inherited from Control.)
Public methodGetRouteUrl(String, RouteValueDictionary)
Gets the URL that corresponds to a set of route parameters and a route name.
(Inherited from Control.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodGetUniqueIDRelativeTo
Returns the prefixed portion of the UniqueID property of the specified control.
(Inherited from Control.)
Public methodHasControls
Determines if the server control contains any child controls.
(Inherited from Control.)
Protected methodHasEvents
Returns a value indicating whether events are registered for the control or any child controls.
(Inherited from Control.)
Public methodImportDocument
Import a previously exported PDF document to a new document instance and load it.
Protected methodIsLiteralContent
Determines if the server control holds only literal content.
(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
Retrieves the physical path that a virtual path, either absolute or relative, maps to.
(Inherited from Control.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodMergeStyle
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.
(Inherited from WebControl.)
Protected methodOnBubbleEvent
Determines whether the event for the server control is passed up the page's UI server control hierarchy.
(Inherited from Control.)
Protected methodOnDataBinding
Raises the DataBinding event.
(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
Raises the Unload event.
(Inherited from Control.)
Protected methodOpenFile
Gets a Stream used to read a file.
(Inherited from Control.)
Protected methodRaiseBubbleEvent
Assigns any sources of the event and its information to the control's parent.
(Inherited from Control.)
Public methodRaiseCallbackEvent
Processes a callback event that targets a control.
Protected methodRemovedControl
Called after a child control is removed from the Controls collection of the Control object.
(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)
Outputs server control content to a provided HtmlTextWriter object and stores tracing information about the control if tracing is enabled.
(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)
Outputs server control content to a provided HtmlTextWriter object using a provided ControlAdapter object.
(Inherited from Control.)
Public methodRenderEndTag
Renders the HTML closing tag of the control into the specified writer.
(Overrides WebControlRenderEndTag(HtmlTextWriter).)
Public methodRenderFrameUrl
Gets a value representing the URL of the IFRAME which RAD PDF is using internally to display the document instance.
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.
Public methodStatic memberRenderHeadUrl
Gets a value representing the URL of the HEAD SCRIPT which RAD PDF generates for Client API usage.
Public methodRenderViewStateJson
Gets a value representing the viewstate of a RAD PDF instance.
Protected methodResolveAdapter
Gets the control adapter responsible for rendering the specified control.
(Inherited from Control.)
Public methodResolveClientUrl
Gets a URL that can be used by the browser.
(Inherited from Control.)
Public methodResolveUrl
Converts a URL into one that is usable on the requesting client.
(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
Sets design-time data for a control.
(Inherited from Control.)
Public methodSetRenderMethodDelegate
Assigns an event handler delegate to render the server control and its content into its parent control.
(Inherited from Control.)
Public methodToString
Returns a string that represents the current object rendered to HTML.
(Overrides ObjectToString.)
Protected methodTrackViewState
Causes the control to track changes to its view state so they can be stored in the object's ViewState property.
(Inherited from WebControl.)
Top
See Also