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

DashboardExtensionSettings Members

Contains specific settings of the Web Dashboard.

Constructors

Name Description
DashboardExtensionSettings() Initializes a new instance of the DashboardExtensionSettings class.

Properties

Name Description
AccessKey Gets or sets the access key that allows you to quickly navigate to the ASP.NET MVC extension. Inherited from SettingsBase.
AllowCreateNewDashboard Gets or sets whether an end-user can create new dashboards.
AllowExportDashboard Gets or sets whether end-users can export a dashboard.
AllowExportDashboardItems Gets or sets whether end-users can export dashboard items.
AllowMaximizeItems Gets or sets whether end users can maximize dashboard items.
AllowOpenDashboard Gets or sets whether an end-user can open existing dashboards.
Attributes Gets the collection of arbitrary attributes (for rendering only) that do not correspond to properties on the control. Inherited from SettingsBase.
BackendOptions Provides access to the Web Dashboard’s back-end options.
ClientInstanceName Gets or sets the Web Dashboard ‘s client programmatic identifier.
ClientSideEvents Gets an object that lists the client-side events specific to the DashboardExtension.
ControllerName Gets or sets the controller name.
ControlStyle Provides access to the style settings declared at the root level of the extension’s wrapped web server control. Inherited from SettingsBase.
DashboardId Gets or sets the dashboard identifier.
DashboardState Gets or sets the dashboard state (such as the master filtering state) for the Web Dashboard.
DataRequestOptions Provides access to the Web Dashboard’s data request options.
EnableCustomSql Enables a user to specify a custom SQL string in the Data Source wizard.
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.
EncodeHtml Inherited from SettingsBase.
ExcelExportOptions Provides access to options related to exporting a dashboard item to the Excel format.
ExportOptions Obsolete. Provides access to dashboard options specific to export.
Height Gets or sets the height of the extension. Inherited from SettingsBase.
ImageExportOptions Provides access to options related to exporting a dashboard/dashboard item to an image.
IncludeDashboardIdToUrl Gets or sets whether the DashboardExtensionSettings.DashboardId will be included in the Web Dashboard’s URL.
IncludeDashboardStateToUrl Gets or sets whether the dashboard state (such as the master filtering state) will be included in the Web Dashboard’s URL.
Init Enables you to perform custom actions when an extension is initialized. Inherited from SettingsBase.
InitialDashboardId Gets or sets the identifier of the dashboard to be loaded to the ASP.NET MVC Dashboard extension.
InitialDashboardState Gets or sets the initial dashboard state when loading a dashboard.
LimitVisibleDataMode Gets or sets a data limitation mode that allows you to display a reduced form of visible data.
LoadDefaultDashboard Gets or sets whether the default dashboard should be loaded from the dashboard storage.
MobileLayoutEnabled Gets or sets a mobile layout mode for the Web Dashboard.
Name Gets or sets the unique identifier name for the extension. Inherited from SettingsBase.
PdfExportOptions Provides access to options related to exporting a dashboard/dashboard item to the PDF format.
PreRender Allows custom processing to be implemented before the extension is rendered to the page. Inherited from SettingsBase.
ResizeByTimer
ShowConfirmationOnBrowserClosing Gets or sets whether the web browser displays a confirmation message when an-end user closes a page containing the Web Dashboard.
Style Gets a collection of all cascading style sheet (CSS) properties applied to an extension. Inherited from SettingsBase.
TabIndex Gets or sets the tab index of the control element of the web page. Inherited from SettingsBase.
ToolTip Gets or sets a UI element’s tooltip text. Inherited from SettingsBase.
UseCardLegacyLayout Gets or sets whether to enable the legacy card layout used prior to v17.1.
UseNeutralFilterMode Gets or sets whether to show all items in the filter elements deselected by default.
Width Gets or sets the width of the extension. Inherited from SettingsBase.
WorkingMode Gets or sets the working mode of the Web Dashboard.

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.
ToString() Returns a string that represents the current object. Inherited from Object.
See Also