Click or drag to resize

PdfWebControl Properties

The PdfWebControl type exposes the following members.

Properties
  NameDescription
Public propertyAccessKey
Gets or sets the access key that allows you to quickly navigate to the Web server control.
(Inherited from WebControl.)
Protected propertyAdapter
Gets the browser-specific adapter for the control.
(Inherited from Control.)
Public propertyAllowFindMatchingPdf
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.
Public propertyAppRelativeTemplateSourceDirectory
Gets or sets the application-relative virtual directory of the Page or UserControl object that contains this control.
(Inherited from Control.)
Public propertyAttributes
Gets the collection of arbitrary attributes (for rendering only) that do not correspond to properties on the control.
(Inherited from WebControl.)
Public propertyBackColor
Gets or sets the background color of the Web server control.
(Overrides WebControlBackColor.)
Public propertyBasePath
Gets or sets a value representing the base path added to RAD PDF Http Handler requests made by this PdfWebControlLite.
Public propertyBindingContainer
Gets the control that contains this control's data binding.
(Inherited from Control.)
Public propertyBorderColor
Gets or sets the border color of the Web control.
(Inherited from WebControl.)
Public propertyBorderStyle
Gets or sets the border style of the Web server control.
(Inherited from WebControl.)
Public propertyBorderWidth
Gets or sets the border width of the Web server control.
(Inherited from WebControl.)
Protected propertyChildControlsCreated
Gets a value that indicates whether the server control's child controls have been created.
(Inherited from Control.)
Public propertyClientID
Gets the control ID for HTML markup that is generated by ASP.NET.
(Inherited from Control.)
Public propertyClientIDMode
Gets or sets the algorithm that is used to generate the value of the ClientID property.
(Inherited from Control.)
Protected propertyClientIDSeparator
Gets a character value representing the separator character used in the ClientID property.
(Inherited from Control.)
Public propertyCollapseTools
Gets or sets a value indicating whether the tools dialog can collapse and drop down when in use in the PdfWebControl viewer.
Public propertyCollapsibleViewerSide
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.
Protected propertyContext
Gets the HttpContext object associated with the server control for the current Web request.
(Inherited from Control.)
Public propertyControls
Gets a ControlCollection object that represents the child controls for a specified server control in the UI hierarchy.
(Inherited from Control.)
Public propertyControlStyle
Gets the style of the Web server control. This property is used primarily by control developers.
(Inherited from WebControl.)
Public propertyControlStyleCreated
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.)
Public propertyConvertImageToPdf
Gets or sets a value indicating whether a PdfWebControl instance should convert supported image types to PDF automatically if used with CreateDocument(String, Byte).
Public propertyConvertMeaninglessCollections
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).
Public propertyConvertXfaForm
Gets or sets a value indicating whether a PdfWebControl instance should convert XFA PDF forms to the more commonly used AcroForms standard.
Public propertyCspSaferRendering
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).
Public propertyCssClass
Gets or sets the Cascading Style Sheet (CSS) class rendered by the Web server control on the client.
(Inherited from WebControl.)
Public propertyCultureName
Gets or sets a value representing the culture name of the language used by this PdfWebControl.
Public propertyDataItemContainer
Gets a reference to the naming container if the naming container implements IDataItemContainer.
(Inherited from Control.)
Public propertyDataKeysContainer
Gets a reference to the naming container if the naming container implements IDataKeysControl.
(Inherited from Control.)
Protected propertyDesignMode
Gets a value indicating whether a control is being used on a design surface.
(Inherited from Control.)
Public propertyDisableDatePicker
Gets or sets a value indicating whether the date picker drop down should be disabled for date formatted form fields in this PdfWebControl.
Public propertyDisableKeyboardShortcuts
Gets or sets a value indicating whether keyboard shortcuts in this PdfWebControl are disabled.
Public propertyDisableLinks
Gets or sets a value indicating whether links in the document loaded in this PdfWebControl are disabled.
Public propertyDisableLinkWarning
Gets or sets a value indicating whether a warning is shown in this PdfWebControl when URL links are clicked.
Public propertyDisableLoadThumbnailsOnDemand
Gets or sets a value indicating whether thumbnails in this PdfWebControl are loaded as needed (on demand) or all at once.
Public propertyDisableMoreButton
Gets or sets a value indicating whether the "More" button should be disabled and hidden in this PdfWebControl.
Public propertyDisablePageLabels
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.
Public propertyDisablePdfJavaScript
Gets or sets a value indicating whether JavaScript from the PDF document loaded in this PdfWebControl is disabled.
Public propertyDisablePreloading
Gets or sets a value indicating whether the next page should be preloaded in a PdfWebControl.
Public propertyDisableResponsive
Gets or sets a value indicating whether the responsive features should be used in PdfWebControl for various devices and screen sizes.
Public propertyDisableTouchGestures
Gets or sets a value indicating whether touch gestures (e.g. pinch-to-zoom page) in this PdfWebControl is disabled.
Public propertyDocumentFileName
Document file name of the currently loaded document.
Public propertyDocumentID
Document ID of the currently loaded document. This Document ID can be used with the LoadDocument(Int32) or CopyDocument(Int32, Boolean) functions.
Public propertyDocumentKey
Gets or sets a value indicating the document key for this PDF document.
Public propertyDocumentKeyMaxAge
Gets or sets a value indicating the maximum age which a document key is valid before it expires
Public propertyDocumentLoaded
Gets a value indicating whether a document is loaded and ready for use in this PdfWebControl instance.
Public propertyDocumentPasswordPending
Gets a value indicating whether the current document is not yet loaded because a password is needed.
Public propertyDocumentProperties
Gets a PdfDocumentProperties class containing common properties describing the document currently loaded.
Public propertyEnabled
Gets or sets a value indicating whether the Web server control is enabled.
(Inherited from WebControl.)
Public propertyEnableHtmlColorInput
Gets or sets a value indicating whether a user can input an HTML color directly in the PdfWebControl color picker.
Public propertyEnablePrintSettingsDialog
Gets or sets a value indicating whether the print settings dialog is shown, instead of directly printing a document in a PdfWebControl viewer.
Public propertyEnableRedaction
Gets or sets a value indicating whether redaction options and tools are enabled in the PdfWebControl viewer.
Public propertyEnableRestoreAllPages
Gets or sets a value indicating whether the restore all pages button is shown in a PdfWebControl viewer.
Public propertyEnableTheming
Gets or sets a value indicating whether themes apply to this control.
(Inherited from WebControl.)
Public propertyEnableUnloadWarning
Gets or sets a value indicating whether a warning is shown when attempt to leave the current page..
Public propertyEnableViewState
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.)
Protected propertyEvents
Gets a list of event handler delegates for the control. This property is read-only.
(Inherited from Control.)
Public propertyFlattenInput
Gets or sets a value indicating whether a PdfWebControl instance should flatten the input PDF.
Public propertyFont
Gets the font properties associated with the Web server control.
(Inherited from WebControl.)
Public propertyForeColor
Gets or sets the foreground color (typically the color of the text) of the Web server control.
(Inherited from WebControl.)
Public propertyGroupThumbnails
Gets or sets a value indicating whether the server should render PDF thumbnails in a group for PdfWebControl instances.
Public propertyHasAttributes
Gets a value indicating whether the control has attributes set.
(Inherited from WebControl.)
Protected propertyHasChildViewState
Gets a value indicating whether the current server control's child controls have any saved view-state settings.
(Inherited from Control.)
Public propertyHeight
Gets or sets the height of the Web server control.
(Inherited from WebControl.)
Public propertyHideBookmarks
Gets or sets a value indicating whether the left bookmark side panel in the PdfWebControl viewer is disabled and hidden.
Public propertyHideBottomBar
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.
Public propertyHideDownloadButton
Gets or sets a value indicating whether all download buttons in the PdfWebControl viewer are hidden.
Public propertyHideEditMenu
Gets or sets a value indicating whether the edit menu in the PdfWebControl viewer is hidden.
Public propertyHideEmbeddedFiles
Gets or sets a value indicating whether the left embedded files side panel in the PdfWebControl viewer is disabled and hidden.
Public propertyHideFileMenu
Gets or sets a value indicating whether the file menu in the PdfWebControl viewer is hidden.
Public propertyHideFocusOutline
Gets or sets a value indicating whether an outline is hidden when an object is in focus.
Public propertyHideHandScroll
Gets or sets a value indicating whether the hand scroll button in the PdfWebControl viewer is hidden.
Public propertyHideObjectPropertiesBar
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.
Public propertyHidePrintButton
Gets or sets a value indicating whether all print buttons in the PdfWebControl viewer are hidden.
Public propertyHideRightClickMenu
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).
Public propertyHideSaveButton
Gets or sets a value indicating whether all save buttons in the PdfWebControl viewer are hidden.
Public propertyHideSearchText
Gets or sets a value indicating whether the search box and buttons in the PdfWebControl viewer is hidden.
Public propertyHideSelectText
Gets or sets a value indicating whether the text selection button in the PdfWebControl viewer is hidden.
Public propertyHideSideBar
Gets or sets a value indicating whether the left tool sidebar in the PdfWebControl viewer is hidden.
Public propertyHideThumbnails
Gets or sets a value indicating whether the left thumbnail side panel in the PdfWebControl viewer is disabled and hidden.
Public propertyHideTips
Gets or sets a value indicating whether tips in the PdfWebControl viewer are hidden.
Public propertyHideToggleHighlightsButton
Gets or sets a value indicating whether buttons which toggle form / annotation highlights in the PdfWebControl viewer are hidden.
Public propertyHideToolsAnnotateTab
Gets or sets a value indicating whether the "Annotate" tools tab in the PdfWebControl viewer is hidden.
Public propertyHideToolsInsertTab
Gets or sets a value indicating whether the "Insert" tools tab in the PdfWebControl viewer is hidden.
Public propertyHideToolsMenu
Gets or sets a value indicating whether the tools menu in the PdfWebControl viewer is hidden.
Public propertyHideToolsPageTab
Gets or sets a value indicating whether the "Page" tools tab in the PdfWebControl viewer is hidden.
Public propertyHideToolsTabs
Gets or sets a value indicating whether all the tools tabs (HideToolsInsertTab, HideToolsAnnotateTab, & HideToolsPageTab tabs) in the PdfWebControl viewer are hidden.
Public propertyHideTopBar
Gets or sets a value indicating whether the top tool bar in the PdfWebControl viewer is hidden.
Public propertyHideTopMenus
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.
Public propertyHideViewMenu
Gets or sets a value indicating whether the view menu in the PdfWebControl viewer is hidden.
Public propertyID
Gets or sets the programmatic identifier assigned to the server control.
(Inherited from Control.)
Protected propertyIdSeparator
Gets the character used to separate control identifiers.
(Inherited from Control.)
Protected propertyIsChildControlStateCleared
Gets a value indicating whether controls contained within this control have control state.
(Inherited from Control.)
Protected propertyIsEnabled
Gets a value indicating whether the control is enabled.
(Inherited from WebControl.)
Protected propertyIsTrackingViewState
Gets a value that indicates whether the server control is saving changes to its view state.
(Inherited from Control.)
Protected propertyIsViewStateEnabled
Gets a value indicating whether view state is enabled for this control.
(Inherited from Control.)
Protected propertyLoadViewStateByID
Gets a value indicating whether the control participates in loading its view state by ID instead of index.
(Inherited from Control.)
Public propertyMaxPdfPageHeight
Public propertyMaxPdfPages
Public propertyMaxPdfPageWidth
Public propertyNamingContainer
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.)
Public propertyOnClientLoad
Gets or sets a value indicating a client side script to execute on load.
Public propertyPage
Gets a reference to the Page instance that contains the server control.
(Inherited from Control.)
Public propertyParent
Gets a reference to the server control's parent control in the page control hierarchy.
(Inherited from Control.)
Public propertyRenderAtClient
Gets or sets a value indicating whether RAD PDF should render all PDF resources client side.
Public propertyRenderAtClientForPrinting
Gets or sets a value indicating whether RAD PDF should render pages for printing client side.
Public propertyRenderAtClientForViewing
Gets or sets a value indicating whether RAD PDF should render pages and text for the viewer client side.
Public propertyRenderDpi
Gets or sets a value indicating the resolution in dots per inch (DPI) with which a new PDF document should be rendered.
Public propertyRenderingCompatibility
Gets a value that specifies the ASP.NET version that rendered HTML will be compatible with.
(Inherited from Control.)
Public propertyRenderOnDemand
Gets or sets a value indicating whether the server should render PDF pages as they are needed by PdfWebControl instances.
Public propertyRenderTextOnDemand
Gets or sets a value indicating whether the server should extract and render PDF text as needed by PdfWebControl instances.
Public propertyRenderThumbnailsOnDemand
Gets or sets a value indicating whether the server should render PDF thumbnails as they are needed by PdfWebControl instances.
Public propertyRenderUnsupportedPdfFeatures
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.
Public propertyShowPreferences
Gets or sets a value indicating whether the preferences option in the PdfWebControl viewer is shown in the file menu dropdown.
Public propertyShowSignatureShapeTool
Gets or sets a value indicating whether the signatures shape tool should be shown in the PdfWebControl viewer.
Public propertySite
Gets information about the container that hosts the current control when rendered on a design surface.
(Inherited from Control.)
Public propertySkinID
Gets or sets the skin to apply to the control.
(Inherited from WebControl.)
Public propertyStyle
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.)
Public propertySupportsDisabledAttribute
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.
(Inherited from WebControl.)
Public propertyTabIndex
Gets or sets the tab index of the Web server control.
(Inherited from WebControl.)
Public propertyTabToNextPage
Gets or sets a value indicating whether a user can tab from one page to the next.
Public propertyTabTopToBottom
Gets or sets a value indicating whether the document specified form field tab order is overridden in favor of top to bottom.
Protected propertyTagKey
Gets the HtmlTextWriterTag value that corresponds to this Web server control. This property is used primarily by control developers.
(Inherited from WebControl.)
Protected propertyTagName
Gets the name of the control tag. This property is used primarily by control developers.
(Inherited from WebControl.)
Public propertyTemplateControl
Gets or sets a reference to the template that contains this control.
(Inherited from Control.)
Public propertyTemplateSourceDirectory
Gets the virtual directory of the Page or UserControl that contains the current server control.
(Inherited from Control.)
Public propertyThrowMaxPagesException
Public propertyThrowPasswordException
Public propertyThrowXfaFormException
Public propertyToolTip
Gets or sets the text displayed when the mouse pointer hovers over the Web server control.
(Inherited from WebControl.)
Public propertyUndoLevels
Gets or sets a value indicating the number of undo levels in this PdfWebControl.
Public propertyUniqueID
Gets the unique, hierarchically qualified identifier for the server control.
(Inherited from Control.)
Public propertyViewerHighlightsDefault
Gets or sets a value indicating whether form field and link highlights will initially be shown in the PdfWebControl instance.
Public propertyViewerNamedDestinationDefault
Gets or sets a value indicating the default document named destination which a PdfWebControl instance should initially navigate to.
Public propertyViewerPageDefault
Gets or sets a value indicating the default document page which a PdfWebControl instance should initially open.
Public propertyViewerPageLayoutDefault
Gets or sets a value indicating the default document page layout which a PdfWebControl instance should initially use.
Public propertyViewerScrollXDefault
Gets or sets a value indicating the horizontal scroll position on ViewerPageDefault which a PdfWebControl instance should initially be shown.
Public propertyViewerScrollYDefault
Gets or sets a value indicating the vertical scroll position on ViewerPageDefault which a PdfWebControl instance should initially be shown.
Public propertyViewerSideDefault
Gets or sets a value indicating whether the side panel (if any) which a PdfWebControl instance should initially be shown.
Public propertyViewerZoomDefault
Gets or sets a value indicating the default zoom level which a PdfWebControl instance should initially use.
Protected propertyViewState
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.)
Protected propertyViewStateIgnoresCase
Gets a value that indicates whether the StateBag object is case-insensitive.
(Inherited from Control.)
Public propertyViewStateMode
Gets or sets the view-state mode of this control.
(Inherited from Control.)
Public propertyVisible
Gets or sets a value that indicates whether a server control is rendered as UI on the page.
(Inherited from Control.)
Public propertyWidth
Gets or sets the width of the Web server control.
(Inherited from WebControl.)
Top
See Also