Skip to main content

DocumentViewerSettings Members

Stores settings of the DocumentViewerExtension.

Constructors

Name Description
DocumentViewerSettings() Initializes a new instance of the DocumentViewerSettings class with default settings.

Properties

Name Description
AccessibilityCompliant Enables support for Section 508.
AccessKey Gets or sets the access key that allows you to quickly navigate to the ASP.NET MVC extension. Inherited from SettingsBase.
AssociatedRibbonName Specifies the name of a Ribbon associated with the ASP.NET Document Viewer.
Attributes Gets the collection of arbitrary attributes (for rendering only) that do not correspond to properties on the control. Inherited from SettingsBase.
AutoHeight Specifies whether the Document Viewer’s height is adjusted automatically to fit its panels.
CacheReportDocument Occurs when a report document is created and it’s possible to store it in the cache.
CallbackRouteValues Defines the callback routing logic by specifying the names of a Controller and an Action which should handle callbacks.
ClientSideEvents Provides access to the client-side events specific to the DocumentViewerSettings.
ConfigurationRemoteSource Specifies the configuration of a remote document source of a ASP.NET Document Viewer.
ControlStyle Provides access to the style settings declared at the root level of the extension’s wrapped web server control. Inherited from SettingsBase.
CustomJSProperties Enables you to supply any server data that can then be parsed on the client.
Enabled Gets or sets a value that indicates whether the MVC Extension is enabled, allowing it to respond to end-user interactions. Inherited from SettingsBase.
EnableTheming Gets or sets a value indicating whether themes apply to this extension. Inherited from SettingsBase.
EncodeHtml Gets or sets whether to encode editor value and content. Inherited from SettingsBase.
ExportRouteValues Defines the callback routing logic by specifying the names of a Controller and an Action which should handle callbacks related to exporting content.
Height Gets or sets the height of the extension. Inherited from SettingsBase.
Init Enables you to perform custom actions when an extension is initialized. Inherited from SettingsBase.
LoadingPanelImage Specifies the settings of an image displayed within a Loading Panel of the Document Viewer.
LoadingPanelStyle Gets the style settings of a specific loading panel displayed while waiting for a callback response.
Name Specifies the unique identifier name for the extension. Inherited from SettingsBase.
PreRender Allows custom processing to be implemented before the extension is rendered to the page. Inherited from SettingsBase.
Report Specifies the report to display in a Document Viewer.
ReportTypeName Specifies the name of the class of the report to display in a Document Viewer.
RestoreReportDocumentFromCache Occurs when an Document Viewer requires a report for display, and it’s possible to restore an existing report document from the cache.
SettingsDocumentMap Provides access to the document map settings.
SettingsLoadingPanel Provides access to the loading panel settings.
SettingsParametersPanelCaption Provides access to the Parameters panel caption settings.
SettingsRemoteSource Provides access to the remote document source settings.
SettingsReportViewer Provides access to the obsolete ReportViewer control.
SettingsRibbon Provides access to the Ribbon settings.
SettingsSplitter Provides access to the splitter settings.
SettingsToolbar Provides access to the toolbar settings.
SkinID Gets or sets the skin to apply to the control. Inherited from SettingsBase.
Style Gets a collection of all cascading style sheet (CSS) properties applied to an extension. Inherited from SettingsBase.
StylesDocumentMap Provides access to the style settings that control the appearance of the Document Viewer’s document map.
StylesEditors Provides access to the editor style settings.
StylesParametersPanelButtons Provides access to the style settings that control the appearance of buttons located in the Document Viewer’s Parameters panel.
StylesParametersPanelEditors Provides access to the style settings that control the appearance of value editors located in the Document Viewer’s Parameters panel.
StylesParametersPanelParameterEditors Obsolete. Provides access to the style settings that control the appearance of the Parameters panel.
StylesReportViewer Provides access to the style settings that control the appearance of the Document Viewer’s report viewer.
StylesRibbon Provides access to the style settings that control the appearance of the Ribbon.
StylesSplitter Provides access to the style settings that control the appearance of a Document Vewer’s splitters.
StylesToolbar Provides access to the style settings that control the appearance of the Document Viewer’s toolbar.
TabIndex Gets or sets the tab index of the control element of the web page. Inherited from SettingsBase.
Theme Gets or sets the name of the theme to be applied to the extension. Inherited from SettingsBase.
ToolbarItems Provides access to the collection of the Document Viewer toolbar’s items.
ToolbarMode Specifies the Document Viewer toolbar.
ToolTip Gets or sets a UI element’s tooltip text. Inherited from SettingsBase.
Width Gets or sets the width of the extension. Inherited from SettingsBase.

Methods

Name Description
Equals(Object, Object) static Determines whether the specified object instances are considered equal. Inherited from Object.
Equals(Object) Determines whether the specified object is equal to the current object. Inherited from Object.
GetHashCode() Serves as the default hash function. Inherited from Object.
GetType() Gets the Type of the current instance. Inherited from Object.
MemberwiseClone() protected Creates a shallow copy of the current Object. Inherited from Object.
ReferenceEquals(Object, Object) static Determines whether the specified Object instances are the same instance. Inherited from Object.
SetCustomParameter(Action<MVCxDocumentViewerParameter>) Specifies settings of a report parameter.
SetCustomParameter(String, Action<MVCxDocumentViewerParameter>) Specifies settings of a report parameter.
SetRemoteSourceConfiguration(Action<DocumentViewerRemoteSourceConfiguration>) Applies the specified action to the Document Viewer’s DocumentViewerRemoteSourceConfiguration property.
SetRemoteSourceSettings(Action<DocumentViewerRemoteSourceSettings>) Applies the specified action to the Document Viewer’s DocumentViewerSettings.SettingsRemoteSource property.
ToString() Returns a string that represents the current object. Inherited from Object.
See Also