Skip to main content
A newer version of this page is available. .

MVCxDocumentViewer Properties

An ASP.NET MVC equivalent of the ASPxDocumentViewer control.
Name Description
AccessibilityCompliant Enables support for Section 508. Inherited from ASPxDocumentViewer.
AccessKey Gets or sets the access key that allows you to quickly navigate to the Web server control. Inherited from WebControl.
Adapter protected 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.
AssociatedRibbonID Specifies the ID of a Ribbon toolbar associated with the Document Viewer. Inherited from ASPxDocumentViewer.
Attributes Gets the collection of arbitrary attributes (for rendering only) that do not correspond to properties on the control. Inherited from WebControl.
AutoHeight Specifies whether the Document Viewer’s height is adjusted automatically to fit its panels. Inherited from ASPxDocumentViewer.
BackColor Gets or sets the background color of the Web server control. Inherited from WebControl.
BackgroundImage Gets the web control’s background image. Inherited from ASPxWebControl.
BackwardCompatibility static Provides access to the control’s backward compatibility settings. Inherited from ASPxWebControl.
BindingContainer For internal use only. Inherited from ASPxWebControl.
Border Gets the web control’s border settings. Inherited from ASPxWebControl.
BorderBottom Gets the settings of the web control’s bottom border. Inherited from ASPxWebControl.
BorderColor Gets or sets the border color of the web control. Use the BorderWrapper.BorderColor property instead. Inherited from ASPxWebControl.
BorderLeft Gets the settings of the web control’s left border. Inherited from ASPxWebControl.
BorderRight Gets the settings of the web control’s right border. Inherited from ASPxWebControl.
BorderStyle Gets or sets the border style of the web control. Use the BorderWrapper.BorderStyle property instead. Inherited from ASPxWebControl.
BorderTop Gets the settings of the web control’s top border. Inherited from ASPxWebControl.
BorderWidth Gets or sets the border width of the web control. Use the BorderWrapper.BorderWidth property instead. Inherited from ASPxWebControl.
CallbackRouteValues

This member supports the internal infrastructure and is not intended to be used directly from your code.

To set up the extension routing logic, use the DocumentViewerSettings.CallbackRouteValues property at the extension settings level.

ChildControlsCreated protected Gets a value that indicates whether the server control’s child controls have been created. Inherited from Control.
ClientID Gets the control’s identifier generated by ASP.NET. Inherited from ASPxWebControlBase.
ClientIDMode Gets or sets the algorithm that is used to generate the value of the ClientID property. Inherited from Control.
ClientIDSeparator protected Gets a character value representing the separator character used in the ClientID property. Inherited from Control.
ClientInstanceName Specifies the name of a client-side instance of the ASPxDocumentViewer. Inherited from ASPxDocumentViewer.
ClientSideEvents Provides access to the client-side events specific to the MVCxDocumentViewer.
ConfigurationRemoteSource Specifies the settings of a Document Viewer‘s remote document source. Inherited from ASPxDocumentViewer.
Context protected Gets the HttpContext object associated with the server control for the current Web request. Inherited from Control.
Controls Gets the web control’s collection of child controls. Inherited from ASPxWebControlBase.
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.
CssFilePath Gets or sets the path to a CSS file that defines the web control’s appearance. Inherited from ASPxWebControl.
CssPostfix Gets or sets a CSS class name postfix that identifies style settings to be applied to the control. Inherited from ASPxWebControl.
Cursor Gets or sets the type of cursor to display when the mouse pointer is over the web control. Inherited from ASPxWebControl.
DataItemContainer Gets a reference to the naming container if the naming container implements IDataItemContainer. Inherited from Control.
DataKeysContainer Gets a reference to the naming container if the naming container implements IDataKeysControl. Inherited from Control.
DesignMode For internal use only. Inherited from ASPxWebControl.
DisabledCssClass static Gets or sets the CSS class to apply to the rendered HTML element when the control is disabled. Inherited from WebControl.
DisabledStyle Gets the style settings which define a control’s appearance in the disabled state. Inherited from ASPxWebControl.
DocumentViewerInternal For internal use. Inherited from ASPxDocumentViewer.
EmptyImage static Obsolete. Gets the settings of an image which is displayed by the control if the control’s value is null. Inherited from ASPxWebControl.
Enabled Gets or sets a value that indicates whether a web control is enabled, allowing it to respond to end-user interactions. Inherited from ASPxWebControl.
EnableDefaultAppearance Obsolete. Specifies whether to enable the control’s default appearance. Inherited from ASPxWebControl.
EnableTheming Gets or sets a value indicating whether themes apply to this control. Inherited from WebControl.
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.
EncodeHtml Gets or sets a value that specifies whether the web control’s value and element content are rendered as pure HTML, or HTML markers are stripped out. Inherited from ASPxWebControl.
Events protected Gets a list of event handler delegates for the control. This property is read-only. Inherited from Control.
ExportRouteValues

This member supports the internal infrastructure and is not intended to be used directly from your code.

To set up the extension routing logic, use the DocumentViewerSettings.ExportRouteValues property at the extension settings level.

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.
GlobalAccessibilityCompliant static Gets or sets whether accessibility support is globally enabled for all DevExpress web controls across the web page or the entire web site. Inherited from ASPxWebControl.
GlobalCheckReferencesToExternalScripts static Gets or sets whether the availability and correctness of references to external client scripts (such as jQuery, jQuery UI, Knockout, etc.), which are used by certain DevExpress web controls, are checked. Inherited from ASPxWebControl.
GlobalEmbedRequiredClientLibraries static Obsolete. Gets or sets whether external client libraries (including scripts and CSS files) are automatically embedded in the DevExpress.Web assembly as resources. Inherited from ASPxWebControl.
GlobalRightToLeft static Gets or sets that the right-to-left orientation shall be globally applied to all DevExpress web controls across the web page or the entire web site. Inherited from ASPxWebControl.
GlobalStyleSheetTheme static Gets or sets the name of the style sheet theme to be globally applied to all DevExpress web controls across the entire web site. Inherited from ASPxWebControl.
GlobalTheme static Gets or sets the name of the Theme to be globally applied to all DevExpress web controls across the entire web site. Inherited from ASPxWebControl.
GlobalThemeBaseColor static Gets or sets the base color for the theme to be globally applied to all DevExpress web controls across a web page or entire web site. Inherited from ASPxWebControl.
GlobalThemeFont static Gets or sets the font settings of the theme to be globally applied to all DevExpress web controls across a web page or entire web site. Inherited from ASPxWebControl.
HasAttributes Gets a value indicating whether the control has attributes set. Inherited from WebControl.
HasChildViewState protected 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 ASPxWebControl.
ID Gets or sets the programmatic identifier assigned to the server control. Inherited from Control.
IdSeparator protected Gets the character used to separate control identifiers. Inherited from Control.
ImageFolder Specifies the path to the folder that contains images used by the control. Inherited from ASPxDocumentViewer.
Initialized Gets a value indicating whether the web control has been initialized. Inherited from ASPxWebControlBase.
IsCallback This member supports the internal infrastructure and is not intended to be used directly from your code.
IsChildControlStateCleared protected Gets a value indicating whether controls contained within this control have control state. Inherited from Control.
IsRendering For internal use only. Inherited from ASPxWebControlBase.
IsTrackingViewState protected Gets a value that indicates whether the server control is saving changes to its view state. Inherited from Control.
IsViewStateEnabled protected Gets a value indicating whether view state is enabled for this control. Inherited from Control.
JSProperties Enables you to supply any server data that can then be parsed on the client. Inherited from ASPxDocumentViewer.
Loaded Indicates whether a web control has been loaded into the Page object. Inherited from ASPxWebControlBase.
LoadingPanelImage Gets the image settings of the Loading Panel. Inherited from ASPxDocumentViewer.
LoadingPanelStyle Gets the style settings of the Loading Panel. Inherited from ASPxDocumentViewer.
LoadViewStateByID protected 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.
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.
ParentImages This property is not in effect for the ASPxWebControl class. Inherited from ASPxWebControl.
ParentSkinOwner For internal use only. Inherited from ASPxWebControl.
ParentStyles This property is not in effect for the ASPxWebControl class. Inherited from ASPxWebControl.
PostDataLoading For internal use only. Inherited from ASPxWebControl.
PreRendered For internal use only. Inherited from ASPxWebControlBase.
RenderingCompatibility Gets a value that specifies the ASP.NET version that rendered HTML will be compatible with. Inherited from Control.
Report Specifies the report to display in the ASPxDocumentViewer. Inherited from ASPxDocumentViewer.
ReportTypeName Specifies the name of the class of the report to display in the ASPxDocumentViewer. Inherited from ASPxDocumentViewer.
Request For internal use only. Inherited from ASPxWebControl.
Response For internal use only. Inherited from ASPxWebControl.
SettingsDocumentMap Provides access to the ASPxDocumentViewer‘s document map settings. Inherited from ASPxDocumentViewer.
SettingsDropDownEditButton Gets the settings of the Edit drop-down button in the Parameters panel. Inherited from ASPxDocumentViewer.
SettingsLoadingPanel Gets the Loading Panel settings of an ASPxDocumentViewer. Inherited from ASPxDocumentViewer.
SettingsParametersPanelCaption Gets the caption settings of an ASPxDocumentViewer‘s Parameters panel. Inherited from ASPxDocumentViewer.
SettingsRemoteSource Provides access to the ASPxDocumentViewer‘s remote document source settings. Inherited from ASPxDocumentViewer.
SettingsReportViewer Provides access to the ASPxDocumentViewer‘s ReportViewer settings. Inherited from ASPxDocumentViewer.
SettingsRibbon Provides access to the ASPxDocumentViewer‘s Ribbon settings. Inherited from ASPxDocumentViewer.
SettingsSplitter Provides access to the ASPxDocumentViewer‘s splitter settings. Inherited from ASPxDocumentViewer.
SettingsToolbar Provides access to the ASPxDocumentViewer‘s toolbar settings. Inherited from ASPxDocumentViewer.
ShadowImage static Obsolete. Gets the shadow image properties. Inherited from ASPxWebControl.
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.
SpriteCssFilePath Gets or sets the path to a CSS file that defines the control’s sprite image settings. Inherited from ASPxDocumentViewer.
SpriteImageUrl Gets or sets the path to a sprite image. Inherited from ASPxDocumentViewer.
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.
StylesDocumentMap Provides access to the style settings that control the appearance of the Document Viewer‘s document map. Inherited from ASPxDocumentViewer.
StylesEditors Gets the editor style settings of an ASPxDocumentViewer. Inherited from ASPxDocumentViewer.
StylesParametersPanelButtons Gets the style settings of the Parameters panel buttons. Inherited from ASPxDocumentViewer.
StylesParametersPanelEditors Gets the style settings of the Parameters panel’s value editors. Inherited from ASPxDocumentViewer.
StylesParametersPanelParameterEditors Obsolete. Gets the editor style settings of an ASPxDocumentViewer‘s Parameters panel. Inherited from ASPxDocumentViewer.
StylesReportViewer Provides access to the style settings that control the appearance of the Document Viewer‘s report viewer. Inherited from ASPxDocumentViewer.
StylesRibbon Gets the style settings of an ASPxDocumentViewer‘s Ribbon. Inherited from ASPxDocumentViewer.
StylesSplitter Provides access to the style settings that control the appearance of splitters in the Document Viewer. Inherited from ASPxDocumentViewer.
StylesToolbar Provides access to the style settings that control the appearance of the Document Viewer‘s toolbar. Inherited from ASPxDocumentViewer.
SupportsDisabledAttribute 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.
IControlBuilderAccessor.ControlBuilder For a description of this member, see ControlBuilder. Inherited from Control.
IControlDesignerAccessor.UserData For a description of this member, see UserData. Inherited from Control.
IDataBindingsAccessor.DataBindings For a description of this member, see DataBindings. Inherited from Control.
IDataBindingsAccessor.HasDataBindings For a description of this member, see HasDataBindings. Inherited from Control.
IExpressionsAccessor.Expressions For a description of this member, see Expressions. Inherited from Control.
IExpressionsAccessor.HasExpressions For a description of this member, see HasExpressions. Inherited from Control.
TabIndex Gets or sets the tab index of the Web server control. Inherited from WebControl.
TagKey protected Gets the HtmlTextWriterTag value that corresponds to this Web server control. This property is used primarily by control developers. Inherited from WebControl.
TagName protected 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.
Theme Gets or sets the name of the Theme to be applied to the control. Inherited from ASPxWebControl.
ToolbarItems Provides access to the collection of the ASPxDocumentViewer report toolbar’s items. Inherited from ASPxDocumentViewer.
ToolbarMode Specifies the toolbar mode of an ASPxDocumentViewer. Inherited from ASPxDocumentViewer.
ToolTip Gets or sets the text displayed when the mouse pointer hovers over the Web server control. Inherited from WebControl.
UniqueID Gets the unique, hierarchically qualified identifier for the server control. Inherited from Control.
ValidateRequestMode Gets or sets a value that indicates whether the control checks client input from the browser for potentially dangerous values. Inherited from Control.
ViewState protected 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 protected Gets a value that indicates whether the StateBag object is case-insensitive. Inherited from Control.
ViewStateLoading For internal use only. Inherited from ASPxWebControl.
ViewStateMode Gets or sets the view-state mode of this control. 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 ASPxWebControl.
See Also