PdfWebControlLite Class

RAD PDF Web Form Control Lite

Inheritance Hierarchy

SystemObject
  System.Web.UIControl
    System.Web.UI.WebControlsWebControl
      RadPdf.Web.UIPdfWebControlLite

Namespace: RadPdf.Web.UI
Assembly: RadPdf (in RadPdf.dll) Version: 3.22.0.0 (3.22.0.0)

Syntax

Copy

public sealed class PdfWebControlLite : WebControl, 
	ICallbackEventHandler

Public NotInheritable Class PdfWebControlLite
	Inherits WebControl
	Implements ICallbackEventHandler

The PdfWebControlLite type exposes the following members.

Constructors

	Name	Description
	PdfWebControlLite	Initializes a new instance of the PdfWebControlLite class.

Top

Properties

	Name	Description
	AccessKey	Gets or sets the access key that allows you to quickly navigate to the Web server control. (Inherited from WebControl.)
	Adapter	Gets the browser-specific adapter for the control. (Inherited from Control.)
	AppRelativeTemplateSourceDirectory	Gets or sets the application-relative virtual directory of the Page or UserControl object that contains this control. (Inherited from Control.)
	Attributes	Gets the collection of arbitrary attributes (for rendering only) that do not correspond to properties on the control. (Inherited from WebControl.)
	BackColor	Gets or sets the background color of the Web server control. (Overrides WebControlBackColor.)
	BasePath	Gets or sets a value representing the base path added to RAD PDF Http Handler requests made by this PdfWebControlLite.
	BindingContainer	Gets the control that contains this control's data binding. (Inherited from Control.)
	BorderColor	Gets or sets the border color of the Web control. (Inherited from WebControl.)
	BorderStyle	Gets or sets the border style of the Web server control. (Inherited from WebControl.)
	BorderWidth	Gets or sets the border width of the Web server control. (Inherited from WebControl.)
	ChildControlsCreated	Gets a value that indicates whether the server control's child controls have been created. (Inherited from Control.)
	ClientID	Gets the server control identifier generated by ASP.NET. (Inherited from Control.)
	ClientIDSeparator	Gets a character value representing the separator character used in the ClientID property. (Inherited from Control.)
	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.
	Context	Gets the HttpContext object associated with the server control for the current Web request. (Inherited from Control.)
	Controls	Gets a ControlCollection object that represents the child controls for a specified server control in the UI hierarchy. (Inherited from Control.)
	ControlStyle	Gets the style of the Web server control. This property is used primarily by control developers. (Inherited from WebControl.)
	ControlStyleCreated	Gets a value indicating whether a Style object has been created for the ControlStyle property. This property is primarily used by control developers. (Inherited from WebControl.)
	CssClass	Gets or sets the Cascading Style Sheet (CSS) class rendered by the Web server control on the client. (Inherited from WebControl.)
	CultureName	Gets or sets a value representing the culture name of the language used by this PdfWebControlLite.
	DesignMode	Gets a value indicating whether a control is being used on a design surface. (Inherited from Control.)
	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 a the "More" button should be disabled and hidden in this PdfWebControlLite.
	DisablePdfJavaScript	Gets or sets a value indicating whether JavaScript from the PDF document loaded in this PdfWebControlLite is disabled.
	DisableTouchGestures	Gets or sets a value indicating whether touch gestures (e.g. pinch-to-zoom page) in this PdfWebControl 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.
	Enabled	Gets or sets a value indicating whether the Web server control is enabled. (Inherited from WebControl.)
	EnableHtmlColorInput	Gets or sets a value indicating whether a user can input an HTML color directly in the PdfWebControlLite color picker.
	EnablePrintSettingsDialog	Gets or sets a value indicating whether the print settings dialog is shown, instead of directly printing a document in a PdfWebControlLite viewer.
	EnableRestoreAllPages	Gets or sets a value indicating whether the restore all pages button is shown in a PdfWebControlLite viewer.
	EnableTheming	Gets or sets a value indicating whether themes apply to this control. (Inherited from WebControl.)
	EnableUnloadWarning	Gets or sets a value indicating whether a warning is shown when attempt to leave the current page..
	EnableViewState	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. (Inherited from Control.)
	Events	Gets a list of event handler delegates for the control. This property is read-only. (Inherited from Control.)
	Font	Gets the font properties associated with the Web server control. (Inherited from WebControl.)
	ForeColor	Gets or sets the foreground color (typically the color of the text) of the Web server control. (Inherited from WebControl.)
	HasAttributes	Gets a value indicating whether the control has attributes set. (Inherited from WebControl.)
	HasChildViewState	Gets a value indicating whether the current server control's child controls have any saved view-state settings. (Inherited from Control.)
	Height	Gets or sets the height of the Web server control. (Inherited from WebControl.)
	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.
	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.
	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 PdfWebControlLite viewer is hidden.
	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. (Inherited from Control.)
	IdSeparator	Gets the character used to separate control identifiers. (Inherited from Control.)
	IsChildControlStateCleared	Gets a value indicating whether controls contained within this control have control state. (Inherited from Control.)
	IsEnabled	Gets a value indicating whether the control is enabled. (Inherited from WebControl.)
	IsTrackingViewState	Gets a value that indicates whether the server control is saving changes to its view state. (Inherited from Control.)
	IsViewStateEnabled	Gets a value indicating whether view state is enabled for this control. (Inherited from Control.)
	LoadViewStateByID	Gets a value indicating whether the control participates in loading its view state by ID instead of index. (Inherited from Control.)
	NamingContainer	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. (Inherited from Control.)
	OnClientLoad	Gets or sets a value indicating a client side script to execute on load.
	Page	Gets a reference to the Page instance that contains the server control. (Inherited from Control.)
	Parent	Gets a reference to the server control's parent control in the page control hierarchy. (Inherited from Control.)
	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 PdfWebControl viewer.
	Site	Gets information about the container that hosts the current control when rendered on a design surface. (Inherited from Control.)
	SkinID	Gets or sets the skin to apply to the control. (Inherited from WebControl.)
	Style	Gets a collection of text attributes that will be rendered as a style attribute on the outer tag of the Web server control. (Inherited from WebControl.)
	TabIndex	Gets or sets the tab index of the Web server control. (Inherited from WebControl.)
	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.
	TagKey	Gets the HtmlTextWriterTag value that corresponds to this Web server control. This property is used primarily by control developers. (Inherited from WebControl.)
	TagName	Gets the name of the control tag. This property is used primarily by control developers. (Inherited from WebControl.)
	TemplateControl	Gets or sets a reference to the template that contains this control. (Inherited from Control.)
	TemplateSourceDirectory	Gets the virtual directory of the Page or UserControl that contains the current server control. (Inherited from Control.)
	ToolTip	Gets or sets the text displayed when the mouse pointer hovers over the Web server control. (Inherited from WebControl.)
	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. (Inherited from 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.
	ViewState	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. (Inherited from Control.)
	ViewStateIgnoresCase	Gets a value that indicates whether the StateBag object is case-insensitive. (Inherited from Control.)
	Visible	Gets or sets a value that indicates whether a server control is rendered as UI on the page. (Inherited from Control.)
	Width	Gets or sets the width of the Web server control. (Inherited from WebControl.)

Top

Methods

	Name	Description
	AddAttributesToRender	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.)
	AddedControl	Called after a child control is added to the Controls collection of the Control object. (Inherited from Control.)
	AddParsedSubObject	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.)
	ApplyStyle	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.)
	ApplyStyleSheetSkin	Applies the style properties defined in the page style sheet to the control. (Inherited from Control.)
	BuildProfileTree	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.)
	ClearChildControlState	Deletes the control-state information for the server control's child controls. (Inherited from Control.)
	ClearChildState	Deletes the view-state and control-state information for all the server control's child controls. (Inherited from Control.)
	ClearChildViewState	Deletes the view-state information for all the server control's child controls. (Inherited from Control.)
	CloseDocument	Close document (if any was created or loaded) reseting the DocumentKey.
	CopyBaseAttributes	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.)
	CopyDocument	Copy an existing a previously loaded PDF document to a new document instance and load it
	CreateChildControls	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.)
	CreateControlCollection	Creates a new ControlCollection object to hold the child controls (both literal and server) of the server control. (Inherited from Control.)
	CreateControlStyle	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.)
	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(String)	Create empty document container to which the user can upload any PDF document
	CreateEmptyDocument(String, PdfLiteSettings)	Create empty document container to which the user can upload any PDF document
	DataBind	Binds a data source to the invoked server control and all its child controls. (Inherited from Control.)
	DataBind(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.)
	DataBindChildren	Binds a data source to the server control's child controls. (Inherited from Control.)
	Dispose	Enables a server control to perform final clean up before it is released from memory. (Inherited from Control.)
	EditDocument	Edit a PDF document before it is displayed in a PdfWebControlLite instance.
	EnsureChildControls	Determines whether the server control contains child controls. If it does not, it creates child controls. (Inherited from Control.)
	EnsureID	Creates an identifier for controls that do not have an identifier assigned. (Inherited from Control.)
	Equals	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	FindControl(String)	Searches the current naming container for a server control with the specified id parameter. (Inherited from Control.)
	FindControl(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.)
	Focus	Sets input focus to a control. (Inherited from Control.)
	GetCallbackResult	Returns the results of a callback event that targets a control.
	GetDesignModeState	Gets design-time data for a control. (Inherited from Control.)
	GetHashCode	Serves as a hash function for a particular type. (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.)
	HasControls	Determines if the server control contains any child controls. (Inherited from Control.)
	HasEvents	Returns a value indicating whether events are registered for the control or any child controls. (Inherited from Control.)
	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.
	IsLiteralContent	Determines if the server control holds only literal content. (Inherited from Control.)
	LoadControlState	Restores control-state information from a previous page request that was saved by the SaveControlState method. (Overrides ControlLoadControlState(Object).)
	LoadDocument	Load document using the session info of a previously loaded Lite Document.
	LoadViewState	Restores view-state information from a previous page request that was saved by the SaveViewState method. (Overrides WebControlLoadViewState(Object).)
	MapPathSecure	Retrieves the physical path that a virtual path, either absolute or relative, maps to. (Inherited from Control.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	MergeStyle	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.)
	OnBubbleEvent	Determines whether the event for the server control is passed up the page's UI server control hierarchy. (Inherited from Control.)
	OnDataBinding	Raises the DataBinding event. (Inherited from Control.)
	OnInit	Raises the Init event. (Overrides ControlOnInit(EventArgs).)
	OnLoad	Raises the Load event. (Overrides ControlOnLoad(EventArgs).)
	OnPreRender	Raises the PreRender event. (Overrides ControlOnPreRender(EventArgs).)
	OnUnload	Raises the Unload event. (Inherited from Control.)
	OpenFile	Gets a Stream used to read a file. (Inherited from Control.)
	RaiseBubbleEvent	Assigns any sources of the event and its information to the control's parent. (Inherited from Control.)
	RaiseCallbackEvent	Processes a callback event that targets a control.
	RemovedControl	Called after a child control is removed from the Controls collection of the Control object. (Inherited from Control.)
	Render	Renders the PdfWebControlLite to the specified HTML writer. (Overrides WebControlRender(HtmlTextWriter).)
	RenderBeginTag	Renders the HTML opening tag of the control to the specified writer. (Overrides WebControlRenderBeginTag(HtmlTextWriter).)
	RenderChildren	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).)
	RenderContents	Renders the contents of the control to the specified writer. (Overrides WebControlRenderContents(HtmlTextWriter).)
	RenderControl	Renders the PdfWebControlLite to a string, for use in advanced applications such as a Custom HttpHandler, inline ASPX pages, or ASP.NET MVC view rendering.
	RenderControl(HtmlTextWriter)	Outputs server control content to a provided HtmlTextWriter object and stores tracing information about the control if tracing is enabled. (Inherited from Control.)
	RenderControl(TextWriter)	Renders the PdfWebControlLite to the specified text writer, for use in advanced applications such as a Custom HttpHandler or ASP.NET MVC view rendering.
	RenderControl(HtmlTextWriter, ControlAdapter)	Outputs server control content to a provided HtmlTextWriter object using a provided ControlAdapter object. (Inherited from Control.)
	RenderEndTag	Renders the HTML closing tag of the control into the specified writer. (Overrides WebControlRenderEndTag(HtmlTextWriter).)
	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 HttpHandler, inline ASPX pages, or ASP.NET MVC view rendering.
	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 HttpHandler or ASP.NET MVC view rendering.
	ResolveAdapter	Gets the control adapter responsible for rendering the specified control. (Inherited from Control.)
	ResolveClientUrl	Gets a URL that can be used by the browser. (Inherited from Control.)
	ResolveUrl	Converts a URL into one that is usable on the requesting client. (Inherited from Control.)
	SaveControlState	Saves any server control state changes that have occurred since the time the page was posted back to the server. (Overrides ControlSaveControlState.)
	SaveViewState	Saves any server control view-state changes that have occurred since the time the page was posted back to the server. (Overrides WebControlSaveViewState.)
	SetDesignModeState	Sets design-time data for a control. (Inherited from Control.)
	SetRenderMethodDelegate	Assigns an event handler delegate to render the server control and its content into its parent control. (Inherited from Control.)
	ToString	Returns a string that represents the current object rendered to HTML. (Overrides ObjectToString.)
	TrackViewState	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

Events

	Name	Description
	DataBinding	Occurs when the server control binds to a data source. (Inherited from Control.)
	Disposed	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. (Inherited from Control.)
	Init	Occurs when the server control is initialized, which is the first step in its lifecycle. (Inherited from Control.)
	Load	Occurs when the server control is loaded into the Page object. (Inherited from Control.)
	PreRender	Occurs after the Control object is loaded but prior to rendering. (Inherited from Control.)
	Saved	Informational event which occurs when a document is saved. This event is called via a client callback from a PdfWebControlLite and hence will only be raised in an ASP.NET Web Forms application.
	Unload	Occurs when the server control is unloaded from memory. (Inherited from Control.)

Top

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

Top

Remarks

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

Reference

RadPdf.Web.UI Namespace