6475 lines
239 KiB
XML
6475 lines
239 KiB
XML
<?xml version="1.0"?>
|
|
<doc>
|
|
<assembly>
|
|
<name>DevExpress.Dashboard.v17.2.Web</name>
|
|
</assembly>
|
|
<members>
|
|
<member name="T:DevExpress.DashboardWeb.CustomExportBaseWebEventArgs">
|
|
|
|
<summary>
|
|
<para>Serves as the base for classes providing data for events used to customize exported documents.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.CustomExportBaseWebEventArgs.DashboardId">
|
|
<summary>
|
|
<para>Gets the identifier of the exported dashboard.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:System.String"/> value that is the identifier of the exported dashboard.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.CustomExportBaseWebEventArgs.ExportAction">
|
|
<summary>
|
|
<para>Gets the export action performed by an end-user.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.DashboardCommon.DashboardExportAction"/> object that is the export action performed by an end-user.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.CustomExportBaseWebEventArgs.ExportMode">
|
|
<summary>
|
|
<para>Gets the document export mode.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.DashboardCommon.DashboardExportMode"/> value that is the document export mode.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.CustomExportBaseWebEventArgs.ImageExportOptions">
|
|
<summary>
|
|
<para>Gets export options related to exporting a dashboard/dashboard item to an image.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.DashboardCommon.DashboardImageExportOptions"/> object containing export options related to exporting a dashboard/dashboard item to an image.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.CustomExportBaseWebEventArgs.ImageOptions">
|
|
<summary>
|
|
<para>Gets export options related to exporting a dashboard/dashboard item to an image.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraPrinting.ImageExportOptions"/> object containing export options related to exporting a dashboard/dashboard item to an image.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.CustomExportBaseWebEventArgs.ItemComponentName">
|
|
<summary>
|
|
<para>Gets the component name of the exported dashboard item.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:System.String"/> value that is the component name of the exported dashboard item.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.CustomExportBaseWebEventArgs.PdfExportOptions">
|
|
<summary>
|
|
<para>Gets export options related to exporting a dashboard/dashboard item to PDF format.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.DashboardCommon.DashboardPdfExportOptions"/> object containing options related to exporting a dashboard/dashboard item to PDF format.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.CustomExportBaseWebEventArgs.PdfOptions">
|
|
<summary>
|
|
<para>Gets export options related to exporting a dashboard/dashboard item to PDF format.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.XtraPrinting.PdfExportOptions"/> object containing options related to exporting a dashboard/dashboard item to PDF format.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.DashboardWeb.DashboardInMemoryStorage">
|
|
|
|
<summary>
|
|
<para>An in-memory storage used to hold dashboards.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.DashboardWeb.DashboardInMemoryStorage.#ctor">
|
|
<summary>
|
|
<para>Initializes a new instance of the DashboardInMemoryStorage class.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.DashboardWeb.DashboardInMemoryStorage.DashboardSave">
|
|
<summary>
|
|
<para>Allows you to handle the process of saving a dashboard to the DashboardInMemoryStorage.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.DashboardWeb.DashboardInMemoryStorage.RegisterDashboard(System.String,System.Xml.Linq.XDocument)">
|
|
<summary>
|
|
<para>Adds a new dashboard to the current DashboardInMemoryStorage.
|
|
</para>
|
|
</summary>
|
|
<param name="dashboardID">
|
|
A <see cref="T:System.String"/> that specifies the dashboard identifier.
|
|
|
|
</param>
|
|
<param name="dashboard">
|
|
A <see cref="T:System.Xml.Linq.XDocument"/> object that specifies the dashboard XML definition.
|
|
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.DashboardWeb.SaveDashboardEventArgs">
|
|
|
|
<summary>
|
|
<para>Provides data for the <see cref="E:DevExpress.DashboardWeb.DashboardInMemoryStorage.DashboardSave"/> event.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.DashboardWeb.SaveDashboardEventArgs.#ctor(System.String,System.Xml.Linq.XDocument)">
|
|
<summary>
|
|
<para>Initializes a new instance of the SaveDashboardEventArgs class.
|
|
</para>
|
|
</summary>
|
|
<param name="dashboardId">
|
|
A <see cref="T:System.String"/> value that specifies the dashboard identifier.
|
|
|
|
</param>
|
|
<param name="dashboardXml">
|
|
A <see cref="T:System.Xml.Linq.XDocument"/> object that is the dashboard XML definition.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.SaveDashboardEventArgs.DashboardId">
|
|
<summary>
|
|
<para>Gets the dashboard identifier.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:System.String"/> value that specifies the dashboard identifier.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.SaveDashboardEventArgs.DashboardXml">
|
|
<summary>
|
|
<para>Gets the dashboard XML definition.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:System.Xml.Linq.XDocument"/> object that is the dashboard XML definition.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.DashboardWeb.SetInitialDashboardStateEventArgs">
|
|
|
|
<summary>
|
|
<para>Provides data for the <see cref="E:DevExpress.DashboardWeb.ASPxDashboard.SetInitialDashboardState"/> event.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.DashboardWeb.SetInitialDashboardStateEventArgs.#ctor(System.String,System.Xml.Linq.XDocument)">
|
|
<summary>
|
|
<para>Initializes a new instance of the SetInitialDashboardStateEventArgs class.
|
|
</para>
|
|
</summary>
|
|
<param name="dashboardId">
|
|
A <see cref="T:System.String"/> value that specifies the dashboard identifier.
|
|
|
|
</param>
|
|
<param name="dashboard">
|
|
A <see cref="T:System.Xml.Linq.XDocument"/> object that specifies the XML document containing a dashboard definition.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.SetInitialDashboardStateEventArgs.DashboardId">
|
|
<summary>
|
|
<para>Gets the identifier of the loaded dashboard.
|
|
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:System.String"/> value that is the identifier of the loaded dashboard.
|
|
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.SetInitialDashboardStateEventArgs.DashboardXml">
|
|
<summary>
|
|
<para>Get the XML document containing the definition of the loaded dashboard.
|
|
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:System.Xml.Linq.XDocument"/> object containing the definition of the loaded dashboard.
|
|
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.SetInitialDashboardStateEventArgs.InitialState">
|
|
<summary>
|
|
<para>Gets or sets the initial state of the loaded dashboard.
|
|
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.DashboardCommon.DashboardState"/> object containing the initial state of the loaded dashboard.
|
|
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.DashboardWeb.PivotExportOptions">
|
|
|
|
<summary>
|
|
<para>Contains settings that specify parameters affecting how the Pivot dashboard item is exported.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.DashboardWeb.PivotExportOptions.#ctor">
|
|
<summary>
|
|
<para>Initialize a new instance of the PivotExportOptions class with default settings.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.DashboardWeb.PivotExportOptions.Assign(DevExpress.DashboardWeb.OptionsBase)">
|
|
<summary>
|
|
<para>Copies settings of the specified object to the current object.
|
|
</para>
|
|
</summary>
|
|
<param name="options">
|
|
An <see cref="T:DevExpress.DashboardWeb.OptionsBase"/> descendant whose settings are copied to the current object.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.PivotExportOptions.PrintHeadersOnEveryPage">
|
|
<summary>
|
|
<para>Gets or sets whether to print column headers of the Pivot dashboard item on every page.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b>, to print column headers on every page; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.DashboardWeb.PieExportOptions">
|
|
|
|
<summary>
|
|
<para>Contains settings that specify parameters affecting how the Pie dashboard item is exported.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.DashboardWeb.PieExportOptions.#ctor">
|
|
<summary>
|
|
<para>Initialize a new instance of the PieExportOptions class with default settings.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.DashboardWeb.PieExportOptions.Assign(DevExpress.DashboardWeb.OptionsBase)">
|
|
<summary>
|
|
<para>Copies settings of the specified object to the current object.
|
|
</para>
|
|
</summary>
|
|
<param name="options">
|
|
An <see cref="T:DevExpress.DashboardWeb.OptionsBase"/> descendant whose settings are copied to the current object.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.PieExportOptions.AutoArrangeContent">
|
|
<summary>
|
|
<para>Gets or sets whether dashboard item elements are arranged automatically on the exported page.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b>, to arrange dashboard item elements automatically on the exported page; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.DashboardWeb.GridExportOptions">
|
|
|
|
<summary>
|
|
<para>Contains settings that specify parameters affecting how the Grid dashboard item is exported.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.DashboardWeb.GridExportOptions.#ctor">
|
|
<summary>
|
|
<para>Initialize a new instance of the GridExportOptions class with default settings.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.DashboardWeb.GridExportOptions.Assign(DevExpress.DashboardWeb.OptionsBase)">
|
|
<summary>
|
|
<para>Copies settings of the specified object to the current object.
|
|
</para>
|
|
</summary>
|
|
<param name="options">
|
|
An <see cref="T:DevExpress.DashboardWeb.OptionsBase"/> descendant whose settings are copied to the current object.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.GridExportOptions.FitToPageWidth">
|
|
<summary>
|
|
<para>Gets or sets whether the size of the grid dashboard item is changed according to the width of the exported page.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b>, to change the size of the grid dashboard item according to the width of the exported page; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.GridExportOptions.PrintHeadersOnEveryPage">
|
|
<summary>
|
|
<para>Gets or sets whether to print column headers of the Grid dashboard item on every page.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b>, to print column headers on every page; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.DashboardWeb.ChartExportOptions">
|
|
|
|
<summary>
|
|
<para>Contains settings that specify parameters affecting how the Chart dashboard item is exported.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.DashboardWeb.ChartExportOptions.#ctor">
|
|
<summary>
|
|
<para>Initialize a new instance of the ChartExportOptions class with default settings.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.DashboardWeb.ChartExportOptions.Assign(DevExpress.DashboardWeb.OptionsBase)">
|
|
<summary>
|
|
<para>Copies settings of the specified object to the current object.
|
|
</para>
|
|
</summary>
|
|
<param name="options">
|
|
An <see cref="T:DevExpress.DashboardWeb.OptionsBase"/> descendant whose settings are copied to the current object.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.ChartExportOptions.AutomaticPageLayout">
|
|
<summary>
|
|
<para>Gets or sets whether the page orientation used to export a chart dashboard item is selected automatically.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b>, to automatically select the page orientation used to export a chart dashboard item; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.ChartExportOptions.SizeMode">
|
|
<summary>
|
|
<para>Gets or sets the export size mode for the chart dashboard item.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.DashboardWeb.ChartExportSizeMode"/> enumeration member that specifies the export size mode for the chart dashboard item.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.DashboardWeb.CardExportOptions">
|
|
|
|
<summary>
|
|
<para>Contains settings that specify parameters affecting how the card dashboard item is exported.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.DashboardWeb.CardExportOptions.#ctor">
|
|
<summary>
|
|
<para>Initialize a new instance of the CardExportOptions class with default settings.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.DashboardWeb.CardExportOptions.Assign(DevExpress.DashboardWeb.OptionsBase)">
|
|
<summary>
|
|
<para>Copies settings of the specified object to the current object.
|
|
</para>
|
|
</summary>
|
|
<param name="options">
|
|
A <see cref="T:DevExpress.DashboardWeb.OptionsBase"/> descendant whose settings are copied to the current object.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.CardExportOptions.AutoArrangeContent">
|
|
<summary>
|
|
<para>Gets or sets whether dashboard item elements are arranged automatically on the exported page.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b>, to arrange dashboard item elements automatically on the exported page; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.DashboardWeb.ConfigureDataReloadingTimeoutWebEventHandler">
|
|
|
|
<summary>
|
|
<para>References a method that will handle the <b>ConfigureDataReloadingTimeout</b> events.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.DashboardWeb.ConfigureDataReloadingTimeoutWebEventHandler.Invoke(System.Object,DevExpress.DashboardWeb.ConfigureDataReloadingTimeoutWebEventArgs)">
|
|
<summary>
|
|
<para>References a method that will handle the <b>ConfigureDataReloadingTimeout</b> events.
|
|
</para>
|
|
</summary>
|
|
<param name="sender">
|
|
The event source.
|
|
|
|
</param>
|
|
<param name="e">
|
|
The <see cref="T:DevExpress.DashboardWeb.ConfigureDataReloadingTimeoutWebEventArgs"/> object that contains event data.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.DashboardWeb.ConfigureDataReloadingTimeoutWebEventArgs">
|
|
|
|
<summary>
|
|
<para>Provides data for the <see cref="E:DevExpress.DashboardWeb.ASPxDashboard.ConfigureDataReloadingTimeout"/> and <see cref="E:DevExpress.DashboardWeb.DashboardConfigurator.ConfigureDataReloadingTimeout"/> events.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.DashboardWeb.ConfigureDataReloadingTimeoutWebEventArgs.#ctor(System.String,System.String,System.String,System.TimeSpan)">
|
|
<summary>
|
|
<para>Initializes a new instance of the ConfigureDataReloadingTimeoutWebEventArgs class.
|
|
</para>
|
|
</summary>
|
|
<param name="dashboardId">
|
|
The System.String value that is a dashboard unique identifier.
|
|
|
|
</param>
|
|
<param name="dataSourceName">
|
|
A System.String value that is the data source name.
|
|
|
|
</param>
|
|
<param name="dataMember">
|
|
A System.String value, specifying the data member.
|
|
|
|
</param>
|
|
<param name="dataReloadingTimeout">
|
|
A System.TimeSpan object specifying the data reloading timeout.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.ConfigureDataReloadingTimeoutWebEventArgs.DashboardId">
|
|
<summary>
|
|
<para>Gets the identifier of the current dashboard.
|
|
</para>
|
|
</summary>
|
|
<value>The System.String value that is a dashboard unique identifier.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.ConfigureDataReloadingTimeoutWebEventArgs.DataMember">
|
|
<summary>
|
|
<para>Gets the identifier of a corresponding data member in the data source.
|
|
</para>
|
|
</summary>
|
|
<value>A System.String value, specifying the data member.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.ConfigureDataReloadingTimeoutWebEventArgs.DataReloadingTimeout">
|
|
<summary>
|
|
<para>Gets or sets a time interval that is the data reloading timeout.
|
|
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:System.TimeSpan"/> object specifying the data reloading timeout.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.ConfigureDataReloadingTimeoutWebEventArgs.DataSourceName">
|
|
<summary>
|
|
<para>Gets the data source name for which the event was raised.
|
|
</para>
|
|
</summary>
|
|
<value>A System.String value that is the data source name.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.DashboardWeb.VerifyClientTrustLevelEventHandler">
|
|
|
|
<summary>
|
|
<para>References a method that will handle the <see cref="E:DevExpress.DashboardWeb.DashboardConfigurator.VerifyClientTrustLevel"/> event.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.DashboardWeb.VerifyClientTrustLevelEventHandler.Invoke(System.Object,DevExpress.DashboardWeb.VerifyClientTrustLevelEventArgs)">
|
|
<summary>
|
|
<para>References a method that will handle the <see cref="E:DevExpress.DashboardWeb.DashboardConfigurator.VerifyClientTrustLevel"/> event.
|
|
</para>
|
|
</summary>
|
|
<param name="sender">
|
|
The event source.
|
|
|
|
</param>
|
|
<param name="e">
|
|
A <see cref="T:DevExpress.DashboardWeb.VerifyClientTrustLevelEventArgs"/> object that contains event data.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.DashboardWeb.VerifyClientTrustLevelEventArgs">
|
|
|
|
<summary>
|
|
<para>Provides data for the <see cref="E:DevExpress.DashboardWeb.DashboardConfigurator.VerifyClientTrustLevel"/> event.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.DashboardWeb.VerifyClientTrustLevelEventArgs.#ctor">
|
|
<summary>
|
|
<para>Initializes a new instance of the VerifyClientTrustLevelEventArgs class.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.VerifyClientTrustLevelEventArgs.ClientTrustLevel">
|
|
<summary>
|
|
<para>Gets or sets the trust level that specifies which actions a client can initiate to execute them on a server side.
|
|
|
|
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.DashboardWeb.ClientTrustLevel"/> value that specifies a trust level.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.DashboardWeb.ClientTrustLevel">
|
|
|
|
<summary>
|
|
<para>Lists trust levels that specify which actions a client can initiate to execute them on a server side.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="F:DevExpress.DashboardWeb.ClientTrustLevel.Full">
|
|
<summary>
|
|
<para>A client can initiate any action to execute them on a server side.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.DashboardWeb.ClientTrustLevel.Restricted">
|
|
<summary>
|
|
<para>A client cannot initiate actions that can lead to changing a dashboard stored on a server. This trust level can be used when the <see cref="P:DevExpress.DashboardWeb.ASPxDashboard.WorkingMode"/>/<see cref="P:DevExpress.DashboardWeb.Mvc.DashboardExtensionSettings.WorkingMode"/> is set to <see cref="F:DevExpress.DashboardWeb.WorkingMode.Viewer"/> to prevent inadvertent or unauthorized modifications to dashboards.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.DashboardWeb.DashboardSavingWebEventHandler">
|
|
|
|
<summary>
|
|
<para>References a method that will handle the <see cref="E:DevExpress.DashboardWeb.ASPxDashboard.DashboardSaving"/> event.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.DashboardWeb.DashboardSavingWebEventHandler.Invoke(System.Object,DevExpress.DashboardWeb.DashboardSavingWebEventArgs)">
|
|
<summary>
|
|
<para>References a method that will handle the <see cref="E:DevExpress.DashboardWeb.ASPxDashboard.DashboardSaving"/> event.
|
|
</para>
|
|
</summary>
|
|
<param name="sender">
|
|
The event source.
|
|
|
|
</param>
|
|
<param name="e">
|
|
A <see cref="T:DevExpress.DashboardWeb.DashboardSavingWebEventArgs"/> object that contains event data.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.DashboardWeb.ExportFontInfo">
|
|
|
|
<summary>
|
|
<para>Contains the font settings of the exported document.
|
|
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.DashboardWeb.ExportFontInfo.#ctor">
|
|
<summary>
|
|
<para>Initializes a new instance of the ExportFontInfo class.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.DashboardWeb.ExportFontInfo.Assign(DevExpress.DashboardWeb.OptionsBase)">
|
|
<summary>
|
|
<para>Copies settings of the specified object to the current object.
|
|
</para>
|
|
</summary>
|
|
<param name="options">
|
|
An <see cref="T:DevExpress.DashboardWeb.OptionsBase"/> descendant whose settings are copied to the current object.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.ExportFontInfo.GdiCharSet">
|
|
<summary>
|
|
<para>Gets or sets a value that specifies the GDI character set used by the current font.
|
|
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:System.Byte"/> value that specifies the GDI character set used by the current font.
|
|
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.ExportFontInfo.Name">
|
|
<summary>
|
|
<para>Gets or sets the name of the font used in the exported document.
|
|
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:System.String"/> that specifies the name of the font.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.ExportFontInfo.UseCustomFontInfo">
|
|
<summary>
|
|
<para>Gets or sets whether custom font settings are used in the exported document.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b>, if custom font settings are used in the exported document; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.DashboardWeb.IDataSourceStorage">
|
|
|
|
<summary>
|
|
<para>When implemented by a class, represents a storage of the dashboard data sources.
|
|
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.DashboardWeb.IDataSourceStorage.GetDataSource(System.String)">
|
|
<summary>
|
|
<para>Loads the data source with the specified identifier from the current IDataSourceStorage.
|
|
</para>
|
|
</summary>
|
|
<param name="dataSourceID">
|
|
A <see cref="T:System.String"/> value that specifies the data source identifier.
|
|
|
|
</param>
|
|
<returns>A <see cref="T:System.Xml.Linq.XDocument"/> object that is the XML definition of the loaded data source.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.DashboardWeb.IDataSourceStorage.GetDataSourcesID">
|
|
<summary>
|
|
<para>Gets identifiers of the dashboards stored in the current IDataSourceStorage.
|
|
|
|
</para>
|
|
</summary>
|
|
<returns>A collection of <see cref="T:System.String"/> values that are identifiers of the dashboards stored in the current IDataSourceStorage.
|
|
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.DashboardWeb.IDashboardStorage">
|
|
|
|
<summary>
|
|
<para>When implemented by a class, represents a storage of dashboards.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.DashboardWeb.IDashboardStorage.GetAvailableDashboardsInfo">
|
|
<summary>
|
|
<para>Gets information about dashboards stored in the current IDashboardStorage.
|
|
</para>
|
|
</summary>
|
|
<returns>A collection of <see cref="T:DevExpress.DashboardWeb.DashboardInfo"/> objects that contain information about dashboards stored in the current IDashboardStorage.
|
|
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.DashboardWeb.IDashboardStorage.LoadDashboard(System.String)">
|
|
<summary>
|
|
<para>Loads the dashboard with the specified identifier from the current IDashboardStorage.
|
|
</para>
|
|
</summary>
|
|
<param name="dashboardID">
|
|
A <see cref="T:System.String"/> value that specifies the dashboard identifier.
|
|
|
|
</param>
|
|
<returns>A <see cref="T:System.Xml.Linq.XDocument"/> object that is the XML definition of the loaded dashboard.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.DashboardWeb.IDashboardStorage.SaveDashboard(System.String,System.Xml.Linq.XDocument)">
|
|
<summary>
|
|
<para>Saves the specified dashboard to the current IDashboardStorage.
|
|
</para>
|
|
</summary>
|
|
<param name="dashboardID">
|
|
A <see cref="T:System.String"/> value that specifies the dashboard identifier.
|
|
|
|
</param>
|
|
<param name="dashboard">
|
|
A <see cref="T:System.Xml.Linq.XDocument"/> object that is the XML definition of the dashboard to be saved.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.DashboardWeb.DataApiProvider">
|
|
|
|
<summary>
|
|
<para>Contains an API used to supply the dashboard with data.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="E:DevExpress.DashboardWeb.DataApiProvider.ConfigureDataConnection">
|
|
<summary>
|
|
<para>Allows you to customize connection settings before the Web Dashboard connects to a data store (database, OLAP cube, etc.).
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.DashboardWeb.DataApiProvider.ConnectionError">
|
|
<summary>
|
|
<para>Allows overriding the default behavior when current connection parameters do not allow connecting to a data store.
|
|
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.DashboardWeb.DataApiProvider.CustomAssemblyLoading">
|
|
<summary>
|
|
<para>Occurs before a custom assembly is loaded for use as <see cref="T:DevExpress.DashboardCommon.DashboardEFDataSource"/>.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.DashboardWeb.DataApiProvider.CustomParameters">
|
|
<summary>
|
|
<para>Occurs before data is loaded from the data store and allows you to customize dashboard parameters that are used for data processing.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.DashboardWeb.DataApiProvider.DataLoading">
|
|
<summary>
|
|
<para>Allows you to provide data for the <see cref="T:DevExpress.DashboardCommon.DashboardObjectDataSource"/>.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.DashboardWeb.DataApiProvider.SetConnectionStringsProvider(DevExpress.DataAccess.Web.IDataSourceWizardConnectionStringsProvider)">
|
|
<summary>
|
|
<para>Specifies a provider of data connections that can be used by the Web Dashboard.
|
|
</para>
|
|
</summary>
|
|
<param name="provider">
|
|
An object implementing the <see cref="T:DevExpress.DataAccess.Web.IDataSourceWizardConnectionStringsProvider"/> interface.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.DashboardWeb.DataApiProvider.SetDBSchemaProvider(DevExpress.DataAccess.Sql.IDBSchemaProvider)">
|
|
<summary>
|
|
<para>Specifies a custom data store schema.
|
|
</para>
|
|
</summary>
|
|
<param name="provider">
|
|
An object that implements the <see cref="T:DevExpress.DataAccess.Sql.IDBSchemaProvider"/> interface representing the data store's schema
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.DashboardWeb.DataApiProvider.ValidateCustomSqlQuery">
|
|
<summary>
|
|
<para>Provides the capability to check the validity of the custom SQL query used to supply the dashboard with data.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.DashboardWeb.DashboardSavingWebEventArgs">
|
|
|
|
<summary>
|
|
<para>Provides data for the <see cref="E:DevExpress.DashboardWeb.ASPxDashboard.DashboardSaving"/> event.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.DashboardWeb.DashboardSavingWebEventArgs.#ctor(System.String,System.Xml.Linq.XDocument)">
|
|
<summary>
|
|
<para>Initializes a new instance of the DashboardSavingWebEventArgs class.
|
|
</para>
|
|
</summary>
|
|
<param name="dashboardId">
|
|
A <see cref="T:System.String"/> value that specifies the dashboard identifier.
|
|
|
|
</param>
|
|
<param name="dashboardXml">
|
|
A <see cref="T:System.Xml.Linq.XDocument"/> object that specifies the dashboard XML definition.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.DashboardSavingWebEventArgs.DashboardId">
|
|
<summary>
|
|
<para>Gets the dashboard identifier.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:System.String"/> value that is the dashboard identifier.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.DashboardSavingWebEventArgs.DashboardXml">
|
|
<summary>
|
|
<para>Gets the dashboard XML definition.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:System.Xml.Linq.XDocument"/> object that specifies the dashboard XML definition.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.DashboardSavingWebEventArgs.Handled">
|
|
<summary>
|
|
<para>Gets or sets whether or not default actions are required to save the dashboard.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b>, to specify that no default actions are required to save the dashboard; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.DashboardWeb.DashboardConfigurator">
|
|
|
|
<summary>
|
|
<para>Provides a server side API for the <see cref="T:DevExpress.DashboardWeb.ASPxDashboard"/> control and ASP.NET MVC Dashboard extension.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.DashboardWeb.DashboardConfigurator.#ctor">
|
|
<summary>
|
|
<para>Initializes a new instance of the DashboardConfigurator class.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.DashboardWeb.DashboardConfigurator.BeforeExportDocument">
|
|
<summary>
|
|
<para>Allows you to hide specific dashboard items when exporting the entire dashboard.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.DashboardWeb.DashboardConfigurator.ConfigureDataConnection">
|
|
<summary>
|
|
<para>Allows you to customize connection settings before the Web Dashboard connects to a data store (database, OLAP cube, etc.).
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.DashboardWeb.DashboardConfigurator.ConfigureDataReloadingTimeout">
|
|
<summary>
|
|
<para>Allows you to set a time interval that specifies how frequently the Web Dashboard should refill its in-memory cache when a user sends a data request.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.DashboardWeb.DashboardConfigurator.ConfigureItemDataCalculation">
|
|
<summary>
|
|
<para>Allows you to configure how the dashboard item's client data is calculated.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.DashboardWeb.DashboardConfigurator.ConnectionError">
|
|
<summary>
|
|
<para>Allows overriding the default behavior when current connection parameters do not allow connecting to a data store.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.DashboardWeb.DashboardConfigurator.CustomAssemblyLoading">
|
|
<summary>
|
|
<para>Occurs before a custom assembly is loaded for use as <see cref="T:DevExpress.DashboardCommon.DashboardEFDataSource"/>.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.DashboardWeb.DashboardConfigurator.CustomExport">
|
|
<summary>
|
|
<para>Allows you to customize the exported document.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.DashboardWeb.DashboardConfigurator.CustomFilterExpression">
|
|
<summary>
|
|
<para>Allows you to include WHERE clauses in SQL queries.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.DashboardWeb.DashboardConfigurator.CustomizeExportDocument">
|
|
<summary>
|
|
<para>Allows you to customize the exported document.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.DashboardWeb.DashboardConfigurator.CustomPalette">
|
|
<summary>
|
|
<para>Provides the capability to substitute the default palette containing colors used to paint dashboard item elements.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.DashboardWeb.DashboardConfigurator.CustomParameters">
|
|
<summary>
|
|
<para>Occurs before data is loaded from the data store and allows you to customize dashboard parameters that are used for data processing.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.DashboardConfigurator.DashboardStorage">
|
|
<summary>
|
|
<para>Gets a storage of dashboards for the Web Dashboard.
|
|
</para>
|
|
</summary>
|
|
<value>An object implementing the <see cref="T:DevExpress.DashboardWeb.IDashboardStorage"/> interface that is the storage of dashboards.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.DashboardWeb.DashboardConfigurator.DataLoading">
|
|
<summary>
|
|
<para>Allows you to provide data for the <see cref="T:DevExpress.DashboardCommon.DashboardObjectDataSource"/>.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.DashboardConfigurator.DataSourceStorage">
|
|
<summary>
|
|
<para>Gets the data source storage used by the Web Dashboard.
|
|
</para>
|
|
</summary>
|
|
<value>An object implementing the <see cref="T:DevExpress.DashboardWeb.IDataSourceStorage"/> interface that is a storage of the dashboard data sources.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.DashboardConfigurator.Default">
|
|
<summary>
|
|
<para>Gets the default DashboardConfigurator class instance.
|
|
</para>
|
|
</summary>
|
|
<value>The default DashboardConfigurator class instance.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.DashboardWeb.DashboardConfigurator.ExcelDataSourceBeforeFill">
|
|
<summary>
|
|
<para>Provides the capability to change options used to extract data from Microsoft Excel workbooks (XLS, XLSX or XLSM files) or CSV files.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.DashboardConfigurator.PassCredentials">
|
|
<summary>
|
|
<para>Gets or sets whether or not confidential information (such as user credentials) will be passed to the client side (web browser).
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b>, to pass confidential information to the client side; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.DashboardWeb.DashboardConfigurator.SetConnectionStringsProvider(DevExpress.DataAccess.Web.IDataSourceWizardConnectionStringsProvider)">
|
|
<summary>
|
|
<para>Specifies a provider of data connections that can be used by the Web Dashboard.
|
|
</para>
|
|
</summary>
|
|
<param name="provider">
|
|
An object implementing the <see cref="T:DevExpress.DataAccess.Web.IDataSourceWizardConnectionStringsProvider"/> interface.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.DashboardWeb.DashboardConfigurator.SetDashboardStateService(DevExpress.DashboardWeb.IDashboardStateService)">
|
|
<summary>
|
|
<para>Specifies a service allowing you to manage a dashboard state.
|
|
</para>
|
|
</summary>
|
|
<param name="service">
|
|
An object implementing the <see cref="T:DevExpress.DashboardWeb.IDashboardStateService"/> interface that specifies a service allowing you to manage a dashboard state.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.DashboardWeb.DashboardConfigurator.SetDashboardStorage(DevExpress.DashboardWeb.IEditableDashboardStorage)">
|
|
<summary>
|
|
<para>Specifies an editable storage of dashboards for the Web Dashboard.
|
|
</para>
|
|
</summary>
|
|
<param name="customStorage">
|
|
An object implementing the <see cref="T:DevExpress.DashboardWeb.IEditableDashboardStorage"/> interface that is an editable storage of dashboards.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.DashboardWeb.DashboardConfigurator.SetDashboardStorage(DevExpress.DashboardWeb.IDashboardStorage)">
|
|
<summary>
|
|
<para>Specifies a storage of dashboards for the Web Dashboard.
|
|
</para>
|
|
</summary>
|
|
<param name="customStorage">
|
|
An object implementing the <see cref="T:DevExpress.DashboardWeb.IDashboardStorage"/> interface that is a storage of dashboards.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.DashboardWeb.DashboardConfigurator.SetDashboardStorage(DevExpress.DashboardWeb.DashboardFileStorage)">
|
|
<summary>
|
|
<para>Specifies a file storage of dashboards for the Web Dashboard.
|
|
</para>
|
|
</summary>
|
|
<param name="fileStorage">
|
|
A <see cref="T:DevExpress.DashboardWeb.DashboardFileStorage"/> object that is the file storage of dashboards.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.DashboardWeb.DashboardConfigurator.SetDashboardStorage(DevExpress.DashboardWeb.DashboardInMemoryStorage)">
|
|
<summary>
|
|
<para>Specifies an in-memory storage of dashboards for the Web Dashboard.
|
|
</para>
|
|
</summary>
|
|
<param name="inMemoryStorage">
|
|
A <see cref="T:DevExpress.DashboardWeb.DashboardInMemoryStorage"/> object that is the in-memory storage of dashboards.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.DashboardWeb.DashboardConfigurator.SetDataSourceStorage(DevExpress.DashboardWeb.IDataSourceStorage)">
|
|
<summary>
|
|
<para>Specifies a data source storage for the Web Dashboard.
|
|
</para>
|
|
</summary>
|
|
<param name="customStorage">
|
|
An object implementing the <see cref="T:DevExpress.DashboardWeb.IDataSourceStorage"/> interface that is a storage of the dashboard data sources.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.DashboardWeb.DashboardConfigurator.SetDataSourceStorage(DevExpress.DashboardWeb.DataSourceInMemoryStorage)">
|
|
<summary>
|
|
<para>Specifies a data source storage for the Web Dashboard.
|
|
</para>
|
|
</summary>
|
|
<param name="inMemoryStorage">
|
|
A <see cref="T:DevExpress.DashboardWeb.DataSourceInMemoryStorage"/> object that is a storage of the dashboard data sources.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.DashboardWeb.DashboardConfigurator.SetDBSchemaProvider(DevExpress.DataAccess.Sql.IDBSchemaProvider)">
|
|
<summary>
|
|
<para>Specifies a custom data store schema.
|
|
</para>
|
|
</summary>
|
|
<param name="provider">
|
|
An object that implements the <see cref="T:DevExpress.DataAccess.Sql.IDBSchemaProvider"/> interface representing the data store's schema
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.DashboardWeb.DashboardConfigurator.SetDBSchemaProvider(DevExpress.DataAccess.Sql.IDBSchemaProviderEx)">
|
|
<summary>
|
|
<para>Specifies a custom data store schema.
|
|
</para>
|
|
</summary>
|
|
<param name="provider">
|
|
An object that implements the <see cref="T:DevExpress.DataAccess.Sql.IDBSchemaProviderEx"/> interface representing the data store's schema
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.DashboardWeb.DashboardConfigurator.SetObjectDataSourceCustomFillService(DevExpress.DashboardCommon.IObjectDataSourceCustomFillService)">
|
|
<summary>
|
|
<para>Specifies a custom fill service for the <see cref="T:DevExpress.DashboardCommon.DashboardObjectDataSource"/> that provides data for the Web Dashboard.
|
|
</para>
|
|
</summary>
|
|
<param name="objectDataSourceCustomFillService">
|
|
An object implementing the <see cref="T:DevExpress.DashboardCommon.IObjectDataSourceCustomFillService"/> interface that specifies a custom fill service for the <see cref="T:DevExpress.DashboardCommon.DashboardObjectDataSource"/>.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.DashboardWeb.DashboardConfigurator.ValidateCustomSqlQuery">
|
|
<summary>
|
|
<para>Provides the capability to check the validity of the custom SQL query used to supply the dashboard with data.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.DashboardWeb.DashboardConfigurator.VerifyClientTrustLevel">
|
|
<summary>
|
|
<para>Allows you to verify the trust level used to specify which actions a client can initiate to execute them on a server side.
|
|
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.DashboardWeb.RequestDashboardIDsWebEventHandler">
|
|
|
|
<summary>
|
|
<para>References a method that will handle the <see cref="E:DevExpress.DashboardWeb.ASPxDashboard.RequestDashboardIDs"/> event.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.DashboardWeb.RequestDashboardIDsWebEventHandler.Invoke(System.Object,DevExpress.DashboardWeb.RequestDashboardIDsWebEventArgs)">
|
|
<summary>
|
|
<para>References a method that will handle the <see cref="E:DevExpress.DashboardWeb.ASPxDashboard.RequestDashboardIDs"/> event.
|
|
</para>
|
|
</summary>
|
|
<param name="sender">
|
|
The event source.
|
|
|
|
</param>
|
|
<param name="e">
|
|
A <see cref="T:DevExpress.DashboardWeb.RequestDashboardIDsWebEventArgs"/> object that contains event data.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.DashboardWeb.DashboardLoadingWebEventHandler">
|
|
|
|
<summary>
|
|
<para>References a method that will handle the <see cref="E:DevExpress.DashboardWeb.ASPxDashboard.DashboardLoading"/> event.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.DashboardWeb.DashboardLoadingWebEventHandler.Invoke(System.Object,DevExpress.DashboardWeb.DashboardLoadingWebEventArgs)">
|
|
<summary>
|
|
<para>References a method that will handle the <see cref="E:DevExpress.DashboardWeb.ASPxDashboard.DashboardLoading"/> event.
|
|
</para>
|
|
</summary>
|
|
<param name="sender">
|
|
The event source.
|
|
|
|
</param>
|
|
<param name="e">
|
|
A <see cref="T:DevExpress.DashboardWeb.DashboardLoadingWebEventArgs"/> object that contains event data.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.DashboardWeb.DashboardAddingWebEventArgs">
|
|
|
|
<summary>
|
|
<para>Provides data for the <see cref="E:DevExpress.DashboardWeb.ASPxDashboard.DashboardAdding"/> event.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.DashboardWeb.DashboardAddingWebEventArgs.#ctor(System.Xml.Linq.XDocument,System.String)">
|
|
<summary>
|
|
<para>Initializes a new instance of the DashboardAddingWebEventArgs class.
|
|
</para>
|
|
</summary>
|
|
<param name="dashboard">
|
|
A <see cref="T:System.Xml.Linq.XDocument"/> object that is the dashboard XML definition.
|
|
|
|
</param>
|
|
<param name="dashboardName">
|
|
A <see cref="T:System.String"/> value that is the dashboard name.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.DashboardAddingWebEventArgs.DashboardId">
|
|
<summary>
|
|
<para>Gets or sets the dashboard identifier.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:System.String"/> value that specifies the dashboard identifier.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.DashboardAddingWebEventArgs.DashboardName">
|
|
<summary>
|
|
<para>Gets the name of the dashboard.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:System.String"/> value that is the name of the dashboard.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.DashboardAddingWebEventArgs.DashboardXml">
|
|
<summary>
|
|
<para>Gets the dashboard XML definition.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:System.Xml.Linq.XDocument"/> object that is the dashboard XML definition.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.DashboardAddingWebEventArgs.Handled">
|
|
<summary>
|
|
<para>Gets or sets whether default actions are required to add the dashboard to a storage.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b>, if no default actions are required to save the dashboard to a storage; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.DashboardWeb.ConnectionErrorWebEventHandler">
|
|
|
|
<summary>
|
|
<para>References a method that will handle the <see cref="E:DevExpress.DashboardWeb.ASPxDashboard.ConnectionError"/> and <see cref="E:DevExpress.DashboardWeb.DashboardConfigurator.ConnectionError"/> events.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.DashboardWeb.ConnectionErrorWebEventHandler.Invoke(System.Object,DevExpress.DashboardWeb.ConnectionErrorWebEventArgs)">
|
|
<summary>
|
|
<para>References a method that will handle the <see cref="E:DevExpress.DashboardWeb.ASPxDashboard.ConnectionError"/> and <see cref="E:DevExpress.DashboardWeb.DashboardConfigurator.ConnectionError"/> events.
|
|
</para>
|
|
</summary>
|
|
<param name="sender">
|
|
The event source.
|
|
|
|
</param>
|
|
<param name="e">
|
|
A <see cref="T:DevExpress.DashboardWeb.ConnectionErrorWebEventArgs"/> object that contains event data.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.DashboardWeb.TreemapExportOptions">
|
|
|
|
<summary>
|
|
<para>Contains settings that specify parameters affecting how the Treemap dashboard item is exported.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.DashboardWeb.TreemapExportOptions.#ctor">
|
|
<summary>
|
|
<para>Initializes a new instance of the TreemapExportOptions class.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.DashboardWeb.TreemapExportOptions.Assign(DevExpress.DashboardWeb.OptionsBase)">
|
|
<summary>
|
|
<para>Copies settings of the specified object to the current object.
|
|
</para>
|
|
</summary>
|
|
<param name="options">
|
|
An <see cref="T:DevExpress.DashboardWeb.OptionsBase"/> descendant whose settings are copied to the current object.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.TreemapExportOptions.AutomaticPageLayout">
|
|
<summary>
|
|
<para>Gets or sets whether the page orientation used to export a Treemap dashboard item is selected automatically.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b>, to automatically select the page orientation used to export a Treemap dashboard item; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.TreemapExportOptions.SizeMode">
|
|
<summary>
|
|
<para>Gets or sets the export size mode for the Treemap dashboard item.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.DashboardWeb.TreemapExportSizeMode"/> enumeration member that specifies the print size mode for the Treemap dashboard item.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.DashboardWeb.TreemapExportSizeMode">
|
|
|
|
<summary>
|
|
<para>Lists constants used to specify how the Treemap dashboard item should be resized when being exported.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="F:DevExpress.DashboardWeb.TreemapExportSizeMode.None">
|
|
<summary>
|
|
<para>A Treemap dashboard item is exported in a size identical to that shown on the dashboard.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.DashboardWeb.TreemapExportSizeMode.Zoom">
|
|
<summary>
|
|
<para>A Treemap dashboard item is resized proportionally to best fit the exported page.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.DashboardWeb.ASPxDashboard">
|
|
|
|
<summary>
|
|
<para>A Web Dashboard control, which allows you to create new dashboards from scratch and display them to end-users.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.DashboardWeb.ASPxDashboard.#ctor">
|
|
<summary>
|
|
<para>Initializes a new instance of the ASPxDashboard class.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.ASPxDashboard.AllowCreateNewDashboard">
|
|
<summary>
|
|
<para>Gets or sets whether or not an end-user can create new dashboards in the ASPxDashboard.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b>, to allow an end-user to create new dashboards in the ASPxDashboard; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.ASPxDashboard.AllowExportDashboard">
|
|
<summary>
|
|
<para>Gets or sets whether the entire dashboard can be exported by end-users.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b>, if end-users can export the entire dashboard; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.ASPxDashboard.AllowExportDashboardItems">
|
|
<summary>
|
|
<para>Gets or sets whether the dashboard items can be exported by end-users.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b>, if end-users can export the dashboard items; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.ASPxDashboard.AllowOpenDashboard">
|
|
<summary>
|
|
<para>Gets or sets whether or not an end-user can open existing dashboards in the ASPxDashboard.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b>, to allow an end-user to open existing dashboards in the ASPxDashboard; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.DashboardWeb.ASPxDashboard.BeforeExportDocument">
|
|
<summary>
|
|
<para>Allows you to hide specific dashboard items when exporting the entire dashboard.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.ASPxDashboard.ClientInstanceName">
|
|
<summary>
|
|
<para>Gets or sets the ASPxDashboard's client programmatic identifier.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:System.String"/> that specifies the ASPxDashboard's client identifier.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.ASPxDashboard.ClientSideEvents">
|
|
<summary>
|
|
<para>Gets an object that lists the client-side events specific to the ASPxDashboard control.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.DashboardWeb.DashboardControlClientSideEvents"/> object which allows assigning handlers to the client-side events available to the ASPxDashboard control.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.ASPxDashboard.ColorScheme">
|
|
<summary>
|
|
<para>Gets or sets the name of the color theme to be applied to the control.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:System.String"/> value specifying the color theme name.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.DashboardWeb.ASPxDashboard.ConfigureDataConnection">
|
|
<summary>
|
|
<para>Allows you to customize connection settings before the ASPxDashboard connects to a data store (database, OLAP cube, etc.).
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.DashboardWeb.ASPxDashboard.ConfigureDataReloadingTimeout">
|
|
<summary>
|
|
<para>Allows you to set a time interval that specifies how frequently the Web Dashboard should refill its in-memory cache when a user sends a data request.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.DashboardWeb.ASPxDashboard.ConfigureItemDataCalculation">
|
|
<summary>
|
|
<para>Allows you to configure how the dashboard item's client data is calculated.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.DashboardWeb.ASPxDashboard.ConnectionError">
|
|
<summary>
|
|
<para>Allows overriding the default behavior when current connection parameters do not allow connecting to a data store.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.DashboardWeb.ASPxDashboard.CustomAssemblyLoading">
|
|
<summary>
|
|
<para>Occurs before a custom assembly is loaded for use as <see cref="T:DevExpress.DashboardCommon.DashboardEFDataSource"/>.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.DashboardWeb.ASPxDashboard.CustomDataCallback">
|
|
<summary>
|
|
<para>Fires when a round trip to the server has been initiated by a call to the client <see cref="M:DevExpress.DashboardWeb.Scripts.ASPxClientDashboard.PerformDataCallback"/> method.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.DashboardWeb.ASPxDashboard.CustomExport">
|
|
<summary>
|
|
<para>Allows you to customize the exported document.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.DashboardWeb.ASPxDashboard.CustomFilterExpression">
|
|
<summary>
|
|
<para>Allows you to include WHERE clauses in SQL queries.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.DashboardWeb.ASPxDashboard.CustomizeExportDocument">
|
|
<summary>
|
|
<para>Allows you to customize the exported document.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.DashboardWeb.ASPxDashboard.CustomJSProperties">
|
|
<summary>
|
|
<para>Enables you to supply any server data that can then be parsed on the client.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.DashboardWeb.ASPxDashboard.CustomPalette">
|
|
<summary>
|
|
<para>Provides the capability to substitute the default palette containing colors used to paint dashboard item elements.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.DashboardWeb.ASPxDashboard.CustomParameters">
|
|
<summary>
|
|
<para>Occurs before data is loaded from the data store and allows you to customize dashboard parameters that are used for data processing.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.DashboardWeb.ASPxDashboard.DashboardAdding">
|
|
<summary>
|
|
<para>Allows you to add a new dashboard to the dashboard storage at runtime.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.ASPxDashboard.DashboardId">
|
|
<summary>
|
|
<para>Gets or sets the dashboard identifier.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:System.String"/> that specifies the dashboard identifier.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.DashboardWeb.ASPxDashboard.DashboardLoading">
|
|
<summary>
|
|
<para>Allows you to load a dashboard at runtime.
|
|
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.DashboardWeb.ASPxDashboard.DashboardSaving">
|
|
<summary>
|
|
<para>Allows you to save a dashboard at runtime.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.ASPxDashboard.DashboardState">
|
|
<summary>
|
|
<para>Allows you to specify the default dashboard state (such as the master filtering state) for the ASPxDashboard's.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:System.String"/> value that specifies the dashboard state for the ASPxDashboard's.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.ASPxDashboard.DashboardStorageFolder">
|
|
<summary>
|
|
<para>Gets or sets the path to a folder used to keep dashboards.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:System.String"/> value that specifies the path to a folder used to keep dashboards.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.ASPxDashboard.DashboardType">
|
|
<summary>
|
|
<para>Gets or sets the type of a dashboard to be displayed in the ASPxDashboard.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:System.Type"/> object that is the type of a dashboard to be displayed in the ASPxDashboard.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.ASPxDashboard.DashboardXmlPath">
|
|
<summary>
|
|
<para>Gets or sets the path to the XML definition of a dashboard to be loaded to ASPxDashboard.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:System.String"/> that specifies the path to the XML definition of a dashboard to be loaded to ASPxDashboard.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.DashboardWeb.ASPxDashboard.DataLoading">
|
|
<summary>
|
|
<para>Allows you to provide data for the <see cref="T:DevExpress.DashboardCommon.DashboardObjectDataSource"/>.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.DashboardWeb.ASPxDashboard.Dispose">
|
|
<summary>
|
|
<para>Enables a server control to perform final clean up before it is released from memory.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.ASPxDashboard.EnableCustomSql">
|
|
<summary>
|
|
<para>Enables a user to specify a custom SQL string in the Data Source wizard.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b>, to allow a user to specify a custom SQL string in the <b>Data Source</b> wizard; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.DashboardWeb.ASPxDashboard.ExcelDataSourceBeforeFill">
|
|
<summary>
|
|
<para>Provides the capability to change options used to extract data from Microsoft Excel workbooks (XLS, XLSX or XLSM files) or CSV files.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.ASPxDashboard.ExcelExportOptions">
|
|
<summary>
|
|
<para>Provides access to options related to exporting a dashboard item to the Excel format.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.DashboardCommon.DashboardExcelExportOptions"/> object containing options related to exporting a dashboard item to the Excel format.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.ASPxDashboard.ExportOptions">
|
|
<summary>
|
|
<para>Provides access to dashboard options specific to export.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.DashboardWeb.DashboardExportOptions"/> object that contains settings which specify parameters affecting how the dashboard (dashboard items) is exported.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.ASPxDashboard.HandleServerErrors">
|
|
<summary>
|
|
<para>Gets or sets whether or not callback exceptions are handled on the server.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b>, to handle callback exceptions on the server; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.ASPxDashboard.ImageExportOptions">
|
|
<summary>
|
|
<para>Provides access to options related to exporting a dashboard/dashboard item to an image.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.DashboardCommon.DashboardImageExportOptions"/> object containing options related to exporting a dashboard/dashboard item to an image.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.ASPxDashboard.IncludeDashboardIdToUrl">
|
|
<summary>
|
|
<para>Gets or sets whether or not the <see cref="P:DevExpress.DashboardWeb.ASPxDashboard.DashboardId"/> will be included in the ASPxDashboard's URL.
|
|
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b>, to include the <see cref="P:DevExpress.DashboardWeb.ASPxDashboard.DashboardId"/> in the ASPxDashboard's URL; otherwise, <b>false</b>.
|
|
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.ASPxDashboard.IncludeDashboardStateToUrl">
|
|
<summary>
|
|
<para>Gets or sets whether or not the dashboard state (such as the master filtering state) will be included in the ASPxDashboard's URL.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b>, to include the dashboard state in the ASPxDashboard's URL; otherwise, <b>false</b>.
|
|
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.ASPxDashboard.InitialDashboardId">
|
|
<summary>
|
|
<para>Gets or sets the identifier of the dashboard to be loaded to ASPxDashboard.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:System.String"/> value that specifies the identifier of the dashboard to be loaded to ASPxDashboard.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.ASPxDashboard.InitialDashboardState">
|
|
<summary>
|
|
<para>Gets or sets the initial dashboard state when loading a dashboard.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:System.String"/> value that specifies the initial dashboard state.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.ASPxDashboard.JSProperties">
|
|
<summary>
|
|
<para>Gets a collection of temporary client properties and their values.
|
|
</para>
|
|
</summary>
|
|
<value>A System.Collections.Generic.Dictionary object that represents the collection of properties and their values.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.ASPxDashboard.LimitVisibleDataMode">
|
|
<summary>
|
|
<para>Gets or sets a data limitation mode that allows you to display a reduced form of visible data.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="LimitVisibleDataMode"/> value that is a data limitation mode.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.ASPxDashboard.LoadDefaultDashboard">
|
|
<summary>
|
|
<para>Gets or sets whether or not the default dashboard should be loaded from the dashboard storage.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b>, to load the default dashboard from the dashboard storage; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.DashboardWeb.ASPxDashboard.OpenDashboard(System.String)">
|
|
<summary>
|
|
<para>Loads a dashboard from a string containing a dashboard XML definition.
|
|
</para>
|
|
</summary>
|
|
<param name="xml">
|
|
A <see cref="T:System.String"/> value that specifies a dashboard XML definition.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.DashboardWeb.ASPxDashboard.OpenDashboard(System.Xml.Linq.XDocument)">
|
|
<summary>
|
|
<para>Loads a dashboard from a document containing a dashboard XML definition.
|
|
</para>
|
|
</summary>
|
|
<param name="document">
|
|
A <see cref="T:System.Xml.Linq.XDocument"/> object that is a document containing a dashboard XML definition.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.ASPxDashboard.PdfExportOptions">
|
|
<summary>
|
|
<para>Provides access to options related to exporting a dashboard/dashboard item to the PDF format.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.DashboardCommon.DashboardPdfExportOptions"/> object containing options related to exporting a dashboard/dashboard item to the PDF format.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.DashboardWeb.ASPxDashboard.RequestDashboardIDs">
|
|
<summary>
|
|
<para>Allows you to specify dashboards available in the dashboard storage.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.ASPxDashboard.ServiceContainer">
|
|
<summary>
|
|
<para>For internal use.
|
|
</para>
|
|
</summary>
|
|
<value>
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.DashboardWeb.ASPxDashboard.SetConnectionStringsProvider(DevExpress.DataAccess.Web.IDataSourceWizardConnectionStringsProvider)">
|
|
<summary>
|
|
<para>Specifies a provider of data connections that can be used by the Web Dashboard.
|
|
</para>
|
|
</summary>
|
|
<param name="provider">
|
|
An object implementing the <see cref="T:DevExpress.DataAccess.Web.IDataSourceWizardConnectionStringsProvider"/> interface.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.DashboardWeb.ASPxDashboard.SetDashboardStorage(DevExpress.DashboardWeb.IDashboardStorage)">
|
|
<summary>
|
|
<para>Specifies a custom storage of dashboards for the Web Dashboard.
|
|
</para>
|
|
</summary>
|
|
<param name="dashboardStorage">
|
|
An object implementing the <see cref="T:DevExpress.DashboardWeb.IDashboardStorage"/> interface that is the custom storage of dashboards.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.DashboardWeb.ASPxDashboard.SetDataSourceStorage(DevExpress.DashboardWeb.IDataSourceStorage)">
|
|
<summary>
|
|
<para>Specifies a data source storage for the Web Dashboard.
|
|
</para>
|
|
</summary>
|
|
<param name="dataSourceStorage">
|
|
An object implementing the <see cref="T:DevExpress.DashboardWeb.IDataSourceStorage"/> interface that is a storage of the dashboard data sources.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.DashboardWeb.ASPxDashboard.SetDBSchemaProvider(DevExpress.DataAccess.Sql.IDBSchemaProvider)">
|
|
<summary>
|
|
<para>Specifies a custom data store schema.
|
|
</para>
|
|
</summary>
|
|
<param name="provider">
|
|
An object that implements the <see cref="T:DevExpress.DataAccess.Sql.IDBSchemaProvider"/> interface representing the data store's schema
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.DashboardWeb.ASPxDashboard.SetDBSchemaProvider(DevExpress.DataAccess.Sql.IDBSchemaProviderEx)">
|
|
<summary>
|
|
<para>Specifies a custom data store schema.
|
|
</para>
|
|
</summary>
|
|
<param name="provider">
|
|
An object that implements the <see cref="T:DevExpress.DataAccess.Sql.IDBSchemaProviderEx"/> interface representing the data store's schema
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.DashboardWeb.ASPxDashboard.SetInitialDashboardState">
|
|
<summary>
|
|
<para>Allows you to specify the initial dashboard state when loading a dashboard.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.ASPxDashboard.ShowConfirmationOnBrowserClosing">
|
|
<summary>
|
|
<para>Gets or sets whether or not the web browser displays a confirmation message when an-end user closes a page containing the Web Dashboard.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b>, if the web browser displays a confirmation message when an-end user closes a page containing the Web Dashboard; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.DashboardWeb.ASPxDashboard.StaticInitialize">
|
|
<summary>
|
|
<para>Initializes an HTTP handler module for the ASPxDashboard control.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.ASPxDashboard.UseCardLegacyLayout">
|
|
<summary>
|
|
<para>Gets or sets whether to enable the legacy card layout used prior to v17.1.
|
|
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b>, to enable the legacy card layout used prior to v17.1; otherwise, <b>false</b>.
|
|
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.ASPxDashboard.UseDashboardConfigurator">
|
|
<summary>
|
|
<para>Gets or sets whether or not the ASPxDashboard control uses the server-side API provided by <see cref="T:DevExpress.DashboardWeb.DashboardConfigurator"/>.
|
|
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b>, if the ASPxDashboard control uses the server-side API provided by <see cref="T:DevExpress.DashboardWeb.DashboardConfigurator"/>; otherwise, <b>false</b>.
|
|
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.DashboardWeb.ASPxDashboard.ValidateDashboardCustomSqlQuery">
|
|
<summary>
|
|
<para>Provides the capability to check the validity of the custom SQL query used to supply the dashboard with data.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.ASPxDashboard.WorkingMode">
|
|
<summary>
|
|
<para>Gets or sets a working mode of the ASPxDashboard control.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.DashboardWeb.WorkingMode"/> enumeration value that specifies a working mode of the ASPxDashboard control.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.DashboardWeb.DataLoadingWebEventHandler">
|
|
|
|
<summary>
|
|
<para>References a method that will handle the <b>DataLoading</b> events.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.DashboardWeb.DataLoadingWebEventHandler.Invoke(System.Object,DevExpress.DashboardWeb.DataLoadingWebEventArgs)">
|
|
<summary>
|
|
<para>References a method that will handle the <b>DataLoading</b> events.
|
|
</para>
|
|
</summary>
|
|
<param name="sender">
|
|
The event source.
|
|
|
|
</param>
|
|
<param name="e">
|
|
A <see cref="T:DevExpress.DashboardWeb.DataLoadingWebEventArgs"/> object that contains event data.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.DashboardWeb.DataLoadingWebEventArgs">
|
|
|
|
<summary>
|
|
<para>Provides data for the <b>DataLoading</b> events.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.DataLoadingWebEventArgs.DashboardId">
|
|
<summary>
|
|
<para>Gets the identifier of the current dashboard.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:System.String"/> that identifies the current dashboard.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.DashboardWeb.CustomFilterExpressionWebEventHandler">
|
|
|
|
<summary>
|
|
<para>References a method that will handle the <b>CustomFilterExpression</b> events.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.DashboardWeb.CustomFilterExpressionWebEventHandler.Invoke(System.Object,DevExpress.DashboardWeb.CustomFilterExpressionWebEventArgs)">
|
|
<summary>
|
|
<para>References a method that will handle the <b>CustomFilterExpression</b> events.
|
|
</para>
|
|
</summary>
|
|
<param name="sender">
|
|
The event source.
|
|
|
|
</param>
|
|
<param name="e">
|
|
The <see cref="T:DevExpress.DashboardWeb.CustomFilterExpressionWebEventArgs"/> object that contains event data.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.DashboardWeb.CustomFilterExpressionWebEventArgs">
|
|
|
|
<summary>
|
|
<para>Provides data for the <b>CustomFilterExpression</b> events.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.CustomFilterExpressionWebEventArgs.DashboardId">
|
|
<summary>
|
|
<para>Gets the identifier of the current dashboard.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:System.String"/> that identifies the current dashboard.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.DashboardWeb.CustomPaletteWebEventArgs">
|
|
|
|
<summary>
|
|
<para>Provides data for the <b>CustomPalette</b> events.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.DashboardWeb.CustomPaletteWebEventArgs.#ctor(System.String,DevExpress.DashboardCommon.CustomPaletteEventArgs)">
|
|
<summary>
|
|
<para>Initializes a new instance of the CustomPaletteWebEventArgs class.
|
|
</para>
|
|
</summary>
|
|
<param name="dashboardId">
|
|
A <see cref="T:System.String"/> value that specifies the dashboard identifier.
|
|
|
|
</param>
|
|
<param name="innerArgs">
|
|
A <see cref="T:DevExpress.DashboardCommon.CustomPaletteEventArgs"/> object.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.CustomPaletteWebEventArgs.DashboardId">
|
|
<summary>
|
|
<para>Gets a dashboard identifier.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:System.String"/> value that is the dashboard identifier.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.CustomPaletteWebEventArgs.Palette">
|
|
<summary>
|
|
<para>Gets or sets a palette used to color dashboard item elements.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.DashboardCommon.DashboardPalette"/> object that specifies a palette used to color dashboard item elements.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.DashboardWeb.DashboardStateExtensions">
|
|
|
|
<summary>
|
|
<para>Provides extension methods for the <see cref="T:DevExpress.DashboardCommon.DashboardState"/> class.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.DashboardWeb.DashboardStateExtensions.LoadFromJson(DevExpress.DashboardCommon.DashboardState,System.String)">
|
|
<summary>
|
|
<para>Initializes a <see cref="T:DevExpress.DashboardCommon.DashboardState"/> object using the specified JSON object.
|
|
|
|
</para>
|
|
</summary>
|
|
<param name="dashboardState">
|
|
A <see cref="T:DevExpress.DashboardCommon.DashboardState"/> object to be initialized.
|
|
|
|
</param>
|
|
<param name="json">
|
|
A <see cref="T:System.String"/> value that specifies the JSON object containing a dashboard state.
|
|
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.DashboardWeb.DashboardStateExtensions.SaveToJson(DevExpress.DashboardCommon.DashboardState)">
|
|
<summary>
|
|
<para>Saves a specified <see cref="T:DevExpress.DashboardCommon.DashboardState"/> object to a JSON object.
|
|
</para>
|
|
</summary>
|
|
<param name="dashboardState">
|
|
A <see cref="T:DevExpress.DashboardCommon.DashboardState"/> object.
|
|
|
|
</param>
|
|
<returns>A <see cref="T:System.String"/> value that is the resulting JSON object.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.DashboardWeb.DashboardSaveEventHandler">
|
|
|
|
<summary>
|
|
<para>References a method that will handle the <see cref="E:DevExpress.DashboardWeb.DashboardInMemoryStorage.DashboardSave"/> event.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.DashboardWeb.DashboardSaveEventHandler.Invoke(System.Object,DevExpress.DashboardWeb.SaveDashboardEventArgs)">
|
|
<summary>
|
|
<para>References a method that will handle the <see cref="E:DevExpress.DashboardWeb.DashboardInMemoryStorage.DashboardSave"/> event.
|
|
</para>
|
|
</summary>
|
|
<param name="sender">
|
|
The event source.
|
|
|
|
</param>
|
|
<param name="e">
|
|
A <see cref="T:DevExpress.DashboardWeb.SaveDashboardEventArgs"/> object that contains event data.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.DashboardWeb.IEditableDashboardStorage">
|
|
|
|
<summary>
|
|
<para>When implemented by a class, represents an editable storage of dashboards.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.DashboardWeb.IEditableDashboardStorage.AddDashboard(System.Xml.Linq.XDocument,System.String)">
|
|
<summary>
|
|
<para>Adds a new dashboard to the current IEditableDashboardStorage.
|
|
</para>
|
|
</summary>
|
|
<param name="dashboard">
|
|
A <see cref="T:System.Xml.Linq.XDocument"/> object that is the XML definition of the dashboard to be added.
|
|
|
|
</param>
|
|
<param name="dashboardName">
|
|
A <see cref="T:System.String"/> value that specifies the dashboard name.
|
|
|
|
</param>
|
|
<returns>A <see cref="T:System.String"/> that is the identifier of the newly added dashboard.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.DashboardWeb.DashboardExportOptions">
|
|
|
|
<summary>
|
|
<para>Contains settings that specify default parameters affecting how the dashboard (dashboard item) is exported.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.DashboardWeb.DashboardExportOptions.#ctor">
|
|
<summary>
|
|
<para>Initializes a new instance of the DashboardExportOptions class.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.DashboardWeb.DashboardExportOptions.Assign(DevExpress.DashboardWeb.OptionsBase)">
|
|
<summary>
|
|
<para>Copies settings of the specified object to the current object.
|
|
</para>
|
|
</summary>
|
|
<param name="options">
|
|
An <see cref="T:DevExpress.DashboardWeb.OptionsBase"/> descendant whose settings are copied to the current object.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.DashboardExportOptions.AutoFitPageCount">
|
|
<summary>
|
|
<para>Gets or sets the number of horizontal/vertical pages spanning the total width/height of a dashboard (dashboard item).
|
|
|
|
|
|
|
|
</para>
|
|
</summary>
|
|
<value>An integer value that specifies the number of horizontal/vertical pages spanning the total width/height of a dashboard (dashboard item).
|
|
|
|
|
|
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.DashboardExportOptions.CardOptions">
|
|
<summary>
|
|
<para>Provides access to options for exporting a card dashboard item.
|
|
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.DashboardWeb.CardExportOptions"/> object containing settings that specify parameters affecting how the card dashboard item is exported.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.DashboardExportOptions.ChartOptions">
|
|
<summary>
|
|
<para>Provides access to options for exporting a chart dashboard item.
|
|
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.DashboardWeb.ChartExportOptions"/> object containing settings that specify parameters affecting how a chart dashboard item is exported.
|
|
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.DashboardExportOptions.DashboardItemOptions">
|
|
<summary>
|
|
<para>Provides access to dashboard options specific to export individual dashboard items.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.DashboardWeb.DashboardItemExportOptions"/> object that contains settings specific to export individual dashboard items.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.DashboardExportOptions.DocumentContentOptions">
|
|
<summary>
|
|
<para>Provides access to options specific to exporting additional content.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.DashboardWeb.DocumentContentExportOptions"/> object containing options specific to exporting additional content.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.DashboardExportOptions.ExcelFormatOptions">
|
|
<summary>
|
|
<para>Provides access to options affecting how the dashboard item is exported in Excel format.
|
|
</para>
|
|
</summary>
|
|
<value>An <see cref="ExcelFormatExportOptions"/> containing options affecting how the dashboard item is exported in Excel format.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.DashboardExportOptions.FontInfo">
|
|
<summary>
|
|
<para>Provides access to the font settings of the exported document.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.DashboardWeb.ExportFontInfo"/> object containing the font settings of the exported document.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.DashboardExportOptions.GaugeOptions">
|
|
<summary>
|
|
<para>Provides access to options for exporting a gauge dashboard item.
|
|
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.DashboardWeb.GaugeExportOptions"/> object containing settings that specify parameters affecting how a gauge dashboard item is exported.
|
|
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.DashboardExportOptions.GridOptions">
|
|
<summary>
|
|
<para>Provides access to options for exporting a grid dashboard item.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.DashboardWeb.GridExportOptions"/> object containing settings that specify parameters affecting how a grid dashboard item is exported.
|
|
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.DashboardExportOptions.ImageFormatOptions">
|
|
<summary>
|
|
<para>Provides access to options affecting how the dashboard or dashboard item is exported in Image format.
|
|
</para>
|
|
</summary>
|
|
<value>An <see cref="T:DevExpress.DashboardWeb.ImageFormatExportOptions"/> containing options affecting how the dashboard or dashboard item is exported in Image format.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.DashboardExportOptions.MapOptions">
|
|
<summary>
|
|
<para>Provides access to options for exporting a map dashboard item.
|
|
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.DashboardWeb.MapExportOptions"/> object containing settings that specify parameters affecting how the map dashboard item is exported.
|
|
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.DashboardExportOptions.PageLayout">
|
|
<summary>
|
|
<para>Gets or sets the page orientation used to export a dashboard (dashboard item).
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.DashboardWeb.DashboardExportPageLayout"/> enumeration value that specifies the page orientation used to export a dashboard (dashboard item).
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.DashboardExportOptions.PaperKind">
|
|
<summary>
|
|
<para>Gets or sets the standard paper size.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:System.Drawing.Printing.PaperKind"/> enumeration value that specifies the standard paper size.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.DashboardExportOptions.PieOptions">
|
|
<summary>
|
|
<para>Provides access to options for exporting a pie dashboard item.
|
|
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.DashboardWeb.PieExportOptions"/> object containing settings that specify parameters that affect how pie dashboard items are exported.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.DashboardExportOptions.PivotOptions">
|
|
<summary>
|
|
<para>Provides access to options for exporting a pivot dashboard item.
|
|
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.DashboardWeb.PivotExportOptions"/> object containing settings that specify parameters that affect how pivot dashboard items are exported.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.DashboardExportOptions.RangeFilterOptions">
|
|
<summary>
|
|
<para>Provides access to options for exporting a Range Filter dashboard item.
|
|
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.DashboardWeb.RangeFilterExportOptions"/> object containing settings that specify parameters affecting how the Range Filter dashboard item is exported.
|
|
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.DashboardExportOptions.ScaleFactor">
|
|
<summary>
|
|
<para>Gets or sets the scale factor (in fractions of <b>1</b>), by which a dashboard (dashboard item) is scaled.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:System.Single"/> value that specifies the scale factor, by which a dashboard (dashboard item) is scaled.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.DashboardExportOptions.ScaleMode">
|
|
<summary>
|
|
<para>Gets or sets the mode for scaling when exporting a dashboard (dashboard item).
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.DashboardWeb.DashboardExportScaleMode"/> enumeration value that specifies the mode for scaling when exporting a dashboard (dashboard item).
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.DashboardExportOptions.TreemapOptions">
|
|
<summary>
|
|
<para>Provides access to options for exporting a Treemap dashboard item.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.DashboardWeb.TreemapExportOptions"/> object containing settings that specify parameters affecting how the Treemap dashboard item is exported.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.DashboardWeb.DashboardExportScaleMode">
|
|
|
|
<summary>
|
|
<para>Lists values that specify a scale mode when exporting a dashboard (dashboard item).
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="F:DevExpress.DashboardWeb.DashboardExportScaleMode.AutoFitToPageWidth">
|
|
<summary>
|
|
<para>The size of the dashboard (dashboard item) is changed according to the width of the exported page.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.DashboardWeb.DashboardExportScaleMode.AutoFitWithinOnePage">
|
|
<summary>
|
|
<para>The size of the dashboard (dashboard item) is changed to fit its content on a single page.
|
|
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.DashboardWeb.DashboardExportScaleMode.None">
|
|
<summary>
|
|
<para>The dashboard (dashboard item) on the exported page retains its original size.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.DashboardWeb.DashboardExportScaleMode.UseScaleFactor">
|
|
<summary>
|
|
<para>The size of the dashboard (dashboard item) on the exported page is changed according to the scale factor value.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.DashboardWeb.DashboardExportPageLayout">
|
|
|
|
<summary>
|
|
<para>Lists values that specify the page orientation used to export a dashboard (dashboard item).
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="F:DevExpress.DashboardWeb.DashboardExportPageLayout.Landscape">
|
|
<summary>
|
|
<para>The page orientation used to export a dashboard (dashboard item) is landscape.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.DashboardWeb.DashboardExportPageLayout.Portrait">
|
|
<summary>
|
|
<para>The page orientation used to export a dashboard (dashboard item) is portrait.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.DashboardWeb.ConfigureDataConnectionWebEventHandler">
|
|
|
|
<summary>
|
|
<para>References a method that will handle the <b>ConfigureDataConnection</b> events.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.DashboardWeb.ConfigureDataConnectionWebEventHandler.Invoke(System.Object,DevExpress.DashboardWeb.ConfigureDataConnectionWebEventArgs)">
|
|
<summary>
|
|
<para>References a method that will handle the <b>ConfigureDataConnection</b> events.
|
|
</para>
|
|
</summary>
|
|
<param name="sender">
|
|
The event source.
|
|
|
|
</param>
|
|
<param name="e">
|
|
A <see cref="T:DevExpress.DashboardWeb.ConfigureDataConnectionWebEventArgs"/> object that contains event data.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.DashboardWeb.CustomExportWebEventHandler">
|
|
|
|
<summary>
|
|
<para>References a method that will handle the <b>CustomExport</b> events.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.DashboardWeb.CustomExportWebEventHandler.Invoke(System.Object,DevExpress.DashboardWeb.CustomExportWebEventArgs)">
|
|
<summary>
|
|
<para>References a method that will handle the <b>CustomExport</b> events.
|
|
</para>
|
|
</summary>
|
|
<param name="sender">
|
|
The event source.
|
|
|
|
</param>
|
|
<param name="e">
|
|
A <see cref="T:DevExpress.DashboardWeb.CustomExportWebEventArgs"/> object that contains event data.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.DashboardWeb.CustomExportWebEventArgs">
|
|
|
|
<summary>
|
|
<para>Provides data for the <b>CustomExport</b> events.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.CustomExportWebEventArgs.Report">
|
|
<summary>
|
|
<para>Gets the underlying report of the exported document.
|
|
</para>
|
|
</summary>
|
|
<value>An <see cref="T:DevExpress.XtraReports.UI.XtraReport"/> object that is the underlying report of the exported document.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.DashboardWeb.DashboardControlClientSideEvents">
|
|
|
|
<summary>
|
|
<para>Contains a list of the client-side event handlers available for the <see cref="T:DevExpress.DashboardWeb.ASPxDashboard"/> control and a corresponding MVC extension.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.DashboardWeb.DashboardControlClientSideEvents.#ctor">
|
|
<summary>
|
|
<para>Initializes a new instance of the DashboardControlClientSideEvents class.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.DashboardControlClientSideEvents.ActionAvailabilityChanged">
|
|
<summary>
|
|
<para>Gets or sets the name of the JavaScript function or the entire code which will handle the client <see cref="E:DevExpress.DashboardWeb.Scripts.ASPxClientDashboard.ActionAvailabilityChanged"/> event.
|
|
</para>
|
|
</summary>
|
|
<value>A string that is either the name of a JavaScript function or the entire JavaScript function code used to handle an event.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.DashboardControlClientSideEvents.BeforeRender">
|
|
<summary>
|
|
<para>Gets or sets the name of the JavaScript function or the entire code which will handle the client <see cref="E:DevExpress.DashboardWeb.Scripts.ASPxClientDashboard.BeforeRender"/> event.
|
|
</para>
|
|
</summary>
|
|
<value>A string that is either the name of a JavaScript function or the entire JavaScript function code used to handle an event.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.DashboardControlClientSideEvents.CustomDataCallback">
|
|
<summary>
|
|
<para>Gets or sets the name of the JavaScript function or the entire code which will handle the client <see cref="E:DevExpress.DashboardWeb.Scripts.ASPxClientDashboard.CustomDataCallback"/> event.
|
|
</para>
|
|
</summary>
|
|
<value>A string that is either the name of a JavaScript function or the entire JavaScript function code used to handle an event.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.DashboardControlClientSideEvents.CustomizeMenuItems">
|
|
<summary>
|
|
<para>Gets or sets the name of the JavaScript function or the entire code which will handle the client <see cref="E:DevExpress.DashboardWeb.Scripts.ASPxClientDashboard.CustomizeMenuItems"/> event.
|
|
</para>
|
|
</summary>
|
|
<value>A string that is either the name of a JavaScript function or the entire JavaScript function code used to handle an event.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.DashboardControlClientSideEvents.DashboardBeginUpdate">
|
|
<summary>
|
|
<para>Gets or sets the name of the JavaScript function or the entire code which will handle the client <see cref="E:DevExpress.DashboardWeb.Scripts.ASPxClientDashboard.DashboardBeginUpdate"/> event.
|
|
</para>
|
|
</summary>
|
|
<value>A string that is either the name of a JavaScript function or the entire JavaScript function code used to handle an event.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.DashboardControlClientSideEvents.DashboardChanged">
|
|
<summary>
|
|
<para>Gets or sets the name of the JavaScript function or the entire code which will handle the client <see cref="E:DevExpress.DashboardWeb.Scripts.ASPxClientDashboard.DashboardChanged"/> event.
|
|
</para>
|
|
</summary>
|
|
<value>A string that is either the name of a JavaScript function or the entire JavaScript function code used to handle an event.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.DashboardControlClientSideEvents.DashboardEndUpdate">
|
|
<summary>
|
|
<para>Gets or sets the name of the JavaScript function or the entire code which will handle the client <see cref="E:DevExpress.DashboardWeb.Scripts.ASPxClientDashboard.DashboardEndUpdate"/> event.
|
|
</para>
|
|
</summary>
|
|
<value>A string that is either the name of a JavaScript function or the entire JavaScript function code used to handle an event.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.DashboardControlClientSideEvents.DashboardStateChanged">
|
|
<summary>
|
|
<para>Gets or sets the name of the JavaScript function or the entire code which will handle the client <see cref="E:DevExpress.DashboardWeb.Scripts.ASPxClientDashboard.DashboardStateChanged"/> event.
|
|
</para>
|
|
</summary>
|
|
<value>A string that is either the name of a JavaScript function or the entire JavaScript function code used to handle an event.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.DashboardControlClientSideEvents.DashboardTitleToolbarUpdated">
|
|
<summary>
|
|
<para> </para>
|
|
</summary>
|
|
<value> </value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.DashboardControlClientSideEvents.DynamicLookUpValuesLoaded">
|
|
<summary>
|
|
<para>Gets or sets the name of the JavaScript function or the entire code which will handle the client <see cref="E:DevExpress.DashboardWeb.Scripts.ASPxClientDashboard.DynamicLookUpValuesLoaded"/> event.
|
|
</para>
|
|
</summary>
|
|
<value>A string that is either the name of a JavaScript function or the entire JavaScript function code used to handle an event.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.DashboardControlClientSideEvents.ItemBeginUpdate">
|
|
<summary>
|
|
<para>Gets or sets the name of the JavaScript function or the entire code which will handle the client <see cref="E:DevExpress.DashboardWeb.Scripts.ASPxClientDashboard.ItemBeginUpdate"/> event.
|
|
</para>
|
|
</summary>
|
|
<value>A string that is either the name of a JavaScript function or the entire JavaScript function code used to handle an event.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.DashboardControlClientSideEvents.ItemCaptionToolbarUpdated">
|
|
<summary>
|
|
<para> </para>
|
|
</summary>
|
|
<value> </value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.DashboardControlClientSideEvents.ItemClick">
|
|
<summary>
|
|
<para>Gets or sets the name of the JavaScript function or the entire code which will handle the client <see cref="E:DevExpress.DashboardWeb.Scripts.ASPxClientDashboard.ItemClick"/> event.
|
|
</para>
|
|
</summary>
|
|
<value>A string that is either the name of a JavaScript function or the entire JavaScript function code used to handle an event.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.DashboardControlClientSideEvents.ItemDrillDownStateChanged">
|
|
<summary>
|
|
<para>Gets or sets the name of the JavaScript function or the entire code which will handle the client <see cref="E:DevExpress.DashboardWeb.Scripts.ASPxClientDashboard.ItemDrillDownStateChanged"/> event.
|
|
</para>
|
|
</summary>
|
|
<value>A string that is either the name of a JavaScript function or the entire JavaScript function code used to handle an event.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.DashboardControlClientSideEvents.ItemElementCustomColor">
|
|
<summary>
|
|
<para>Gets or sets the name of the JavaScript function or the entire code which will handle the client <see cref="E:DevExpress.DashboardWeb.Scripts.ASPxClientDashboard.ItemElementCustomColor"/> event.
|
|
</para>
|
|
</summary>
|
|
<value>A string that is either the name of a JavaScript function or the entire JavaScript function code used to handle an event.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.DashboardControlClientSideEvents.ItemEndUpdate">
|
|
<summary>
|
|
<para>Gets or sets the name of the JavaScript function or the entire code which will handle the client <see cref="E:DevExpress.DashboardWeb.Scripts.ASPxClientDashboard.ItemEndUpdate"/> event.
|
|
</para>
|
|
</summary>
|
|
<value>A string that is either the name of a JavaScript function or the entire JavaScript function code used to handle an event.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.DashboardControlClientSideEvents.ItemMasterFilterStateChanged">
|
|
<summary>
|
|
<para>Gets or sets the name of the JavaScript function or the entire code which will handle the client <see cref="E:DevExpress.DashboardWeb.Scripts.ASPxClientDashboard.ItemMasterFilterStateChanged"/> event.
|
|
</para>
|
|
</summary>
|
|
<value>A string that is either the name of a JavaScript function or the entire JavaScript function code used to handle an event.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.DashboardControlClientSideEvents.ItemSelectionChanged">
|
|
<summary>
|
|
<para>Gets or sets the name of the JavaScript function or the entire code which will handle the client <see cref="E:DevExpress.DashboardWeb.Scripts.ASPxClientDashboard.ItemSelectionChanged"/> event.
|
|
</para>
|
|
</summary>
|
|
<value>A string that is either the name of a JavaScript function or the entire JavaScript function code used to handle an event.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.DashboardControlClientSideEvents.ItemVisualInteractivity">
|
|
<summary>
|
|
<para>Gets or sets the name of the JavaScript function or the entire code which will handle the client <see cref="E:DevExpress.DashboardWeb.Scripts.ASPxClientDashboard.ItemVisualInteractivity"/> event.
|
|
</para>
|
|
</summary>
|
|
<value>A string that is either the name of a JavaScript function or the entire JavaScript function code used to handle an event.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.DashboardControlClientSideEvents.ItemWidgetCreated">
|
|
<summary>
|
|
<para>Gets or sets the name of the JavaScript function or the entire code which will handle the client <see cref="E:DevExpress.DashboardWeb.Scripts.ASPxClientDashboard.ItemWidgetCreated"/> event.
|
|
</para>
|
|
</summary>
|
|
<value>A string that is either the name of a JavaScript function or the entire JavaScript function code used to handle an event.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.DashboardControlClientSideEvents.ItemWidgetUpdated">
|
|
<summary>
|
|
<para>Gets or sets the name of the JavaScript function or the entire code which will handle the client <see cref="E:DevExpress.DashboardWeb.Scripts.ASPxClientDashboard.ItemWidgetUpdated"/> event.
|
|
</para>
|
|
</summary>
|
|
<value>A string that is either the name of a JavaScript function or the entire JavaScript function code used to handle an event.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.DashboardControlClientSideEvents.ItemWidgetUpdating">
|
|
<summary>
|
|
<para>Gets or sets the name of the JavaScript function or the entire code which will handle the client <see cref="E:DevExpress.DashboardWeb.Scripts.ASPxClientDashboard.ItemWidgetUpdating"/> event.
|
|
</para>
|
|
</summary>
|
|
<value>A string that is either the name of a JavaScript function or the entire JavaScript function code used to handle an event.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.DashboardWeb.CustomizeExportDocumentWebEventHandler">
|
|
|
|
<summary>
|
|
<para>References a method that will handle the <b>CustomizeExportDocument</b> events.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.DashboardWeb.CustomizeExportDocumentWebEventHandler.Invoke(System.Object,DevExpress.DashboardWeb.CustomizeExportDocumentWebEventArgs)">
|
|
<summary>
|
|
<para>References a method that will handle the <b>CustomizeExportDocument</b> events.
|
|
</para>
|
|
</summary>
|
|
<param name="sender">
|
|
The event source.
|
|
|
|
</param>
|
|
<param name="e">
|
|
A <see cref="T:DevExpress.DashboardWeb.CustomizeExportDocumentWebEventArgs"/> object that contains event data.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.DashboardWeb.CustomPaletteWebEventHandler">
|
|
|
|
<summary>
|
|
<para>References a method that will handle the <b>CustomPalette</b> events.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.DashboardWeb.CustomPaletteWebEventHandler.Invoke(System.Object,DevExpress.DashboardWeb.CustomPaletteWebEventArgs)">
|
|
<summary>
|
|
<para>References a method that will handle the <b>CustomPalette</b> events.
|
|
</para>
|
|
</summary>
|
|
<param name="sender">
|
|
The event source.
|
|
|
|
</param>
|
|
<param name="e">
|
|
A <see cref="T:DevExpress.DashboardWeb.CustomPaletteWebEventArgs"/> object that contains event data.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.DashboardWeb.ASPxDashboardExporter">
|
|
|
|
<summary>
|
|
<para>Provides the capability to perform server-side export of a dashboard/dashboard item displayed in the Web Dashboard.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.DashboardWeb.ASPxDashboardExporter.#ctor(DevExpress.DashboardWeb.ASPxDashboard)">
|
|
<summary>
|
|
<para>Initializes a new instance of the ASPxDashboardExporter class for the specified <see cref="T:DevExpress.DashboardWeb.ASPxDashboard"/> control.
|
|
</para>
|
|
</summary>
|
|
<param name="dashboard">
|
|
An <see cref="T:DevExpress.DashboardWeb.ASPxDashboard"/> control instance whose data will be exported using the ASPxDashboardExporter API.
|
|
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.DashboardWeb.ASPxDashboardExporter.#ctor(DevExpress.DashboardWeb.DashboardConfigurator)">
|
|
<summary>
|
|
<para>Initializes a new instance of the ASPxDashboardExporter class for the specified <see cref="T:DevExpress.DashboardWeb.DashboardConfigurator"/> instance.
|
|
</para>
|
|
</summary>
|
|
<param name="dashboardConfigurator">
|
|
A <see cref="T:DevExpress.DashboardWeb.DashboardConfigurator"/> instance that provides an API for the specified <see cref="T:DevExpress.DashboardWeb.ASPxDashboard"/> control or ASP.NET MVC Dashboard extension.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.DashboardWeb.ASPxDashboardExporter.ExportDashboardItemToExcel(System.String,System.String,System.IO.Stream)">
|
|
<summary>
|
|
<para>Exports the dashboard item to the specified stream in Excel format.
|
|
</para>
|
|
</summary>
|
|
<param name="dashboardId">
|
|
A <see cref="T:System.String"/> that specifies the identifier of a dashboard containing the required dashboard item.
|
|
|
|
</param>
|
|
<param name="dashboardItemName">
|
|
A <see cref="T:System.String"/> that is the component name of the dashboard item to be exported.
|
|
|
|
</param>
|
|
<param name="stream">
|
|
A <see cref="T:System.IO.Stream"/> object to which the created Excel file should be sent.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.DashboardWeb.ASPxDashboardExporter.ExportDashboardItemToExcel(System.String,System.String,System.IO.Stream,DevExpress.DashboardCommon.DashboardState)">
|
|
<summary>
|
|
<para>Exports the dashboard item to the specified stream in Excel format.
|
|
</para>
|
|
</summary>
|
|
<param name="dashboardId">
|
|
A <see cref="T:System.String"/> that specifies the identifier of a dashboard containing the required dashboard item.
|
|
|
|
</param>
|
|
<param name="dashboardItemName">
|
|
A <see cref="T:System.String"/> that is the component name of the dashboard item to be exported.
|
|
|
|
</param>
|
|
<param name="stream">
|
|
A <see cref="T:System.IO.Stream"/> object to which the created Excel file should be sent.
|
|
|
|
</param>
|
|
<param name="state">
|
|
A <see cref="T:DevExpress.DashboardCommon.DashboardState"/> object that specifies the dashboard state to be applied to the resulting document.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.DashboardWeb.ASPxDashboardExporter.ExportDashboardItemToExcel(System.String,System.String,System.IO.Stream,DevExpress.DashboardCommon.DashboardState,DevExpress.DashboardCommon.DashboardExcelExportOptions)">
|
|
<summary>
|
|
<para>Exports the dashboard item to the specified stream in Excel format.
|
|
</para>
|
|
</summary>
|
|
<param name="dashboardId">
|
|
A <see cref="T:System.String"/> that specifies the identifier of a dashboard containing the required dashboard item.
|
|
|
|
</param>
|
|
<param name="dashboardItemName">
|
|
A <see cref="T:System.String"/> that is the component name of the dashboard item to be exported.
|
|
|
|
</param>
|
|
<param name="stream">
|
|
A <see cref="T:System.IO.Stream"/> object to which the created Excel file should be sent.
|
|
|
|
</param>
|
|
<param name="state">
|
|
A <see cref="T:DevExpress.DashboardCommon.DashboardState"/> object that specifies the dashboard state to be applied to the resulting document.
|
|
|
|
</param>
|
|
<param name="options">
|
|
A <see cref="T:DevExpress.DashboardCommon.DashboardExcelExportOptions"/> object containing Excel-specific options.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.DashboardWeb.ASPxDashboardExporter.ExportDashboardItemToImage(System.String,System.String,System.IO.Stream,System.Drawing.Size)">
|
|
<summary>
|
|
<para>Exports a dashboard item to the specified stream in Image format.
|
|
</para>
|
|
</summary>
|
|
<param name="dashboardId">
|
|
A <see cref="T:System.String"/> that specifies the identifier of a dashboard containing the required dashboard item.
|
|
|
|
</param>
|
|
<param name="dashboardItemName">
|
|
A <see cref="T:System.String"/> that is the component name of the dashboard item to be exported.
|
|
|
|
</param>
|
|
<param name="stream">
|
|
A <see cref="T:System.IO.Stream"/> object to which the created image file should be sent.
|
|
|
|
</param>
|
|
<param name="dashboardItemSize">
|
|
A <see cref="T:System.Drawing.Size"/> object that specifies the dashboard item size.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.DashboardWeb.ASPxDashboardExporter.ExportDashboardItemToImage(System.String,System.String,System.IO.Stream,System.Drawing.Size,DevExpress.DashboardCommon.DashboardState,DevExpress.DashboardCommon.DashboardImageExportOptions)">
|
|
<summary>
|
|
<para>Exports a dashboard item to the specified stream in Image format.
|
|
</para>
|
|
</summary>
|
|
<param name="dashboardId">
|
|
A <see cref="T:System.String"/> that specifies the identifier of a dashboard containing the required dashboard item.
|
|
|
|
</param>
|
|
<param name="dashboardItemName">
|
|
A <see cref="T:System.String"/> that is the component name of the dashboard item to be exported.
|
|
|
|
</param>
|
|
<param name="stream">
|
|
A <see cref="T:System.IO.Stream"/> object to which the created image file should be sent.
|
|
|
|
</param>
|
|
<param name="dashboardItemSize">
|
|
A <see cref="T:System.Drawing.Size"/> object that specifies the dashboard item size.
|
|
|
|
</param>
|
|
<param name="state">
|
|
A <see cref="T:DevExpress.DashboardCommon.DashboardState"/> object that specifies the dashboard state to be applied to the resulting document.
|
|
|
|
</param>
|
|
<param name="options">
|
|
A <see cref="T:DevExpress.DashboardCommon.DashboardImageExportOptions"/> object containing Image-specific options.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.DashboardWeb.ASPxDashboardExporter.ExportDashboardItemToImage(System.String,System.String,System.IO.Stream,System.Drawing.Size,DevExpress.DashboardCommon.DashboardState)">
|
|
<summary>
|
|
<para>Exports a dashboard item to the specified stream in Image format.
|
|
</para>
|
|
</summary>
|
|
<param name="dashboardId">
|
|
A <see cref="T:System.String"/> that specifies the identifier of a dashboard containing the required dashboard item.
|
|
|
|
</param>
|
|
<param name="dashboardItemName">
|
|
A <see cref="T:System.String"/> that is the component name of the dashboard item to be exported.
|
|
|
|
</param>
|
|
<param name="stream">
|
|
A <see cref="T:System.IO.Stream"/> object to which the created image file should be sent.
|
|
|
|
</param>
|
|
<param name="dashboardItemSize">
|
|
A <see cref="T:System.Drawing.Size"/> object that specifies the dashboard item size.
|
|
|
|
</param>
|
|
<param name="state">
|
|
A <see cref="T:DevExpress.DashboardCommon.DashboardState"/> object that specifies the dashboard state to be applied to the resulting document.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.DashboardWeb.ASPxDashboardExporter.ExportDashboardItemToImage(System.String,System.String,System.IO.Stream)">
|
|
<summary>
|
|
<para>Exports a dashboard item to the specified stream in Image format.
|
|
</para>
|
|
</summary>
|
|
<param name="dashboardId">
|
|
A <see cref="T:System.String"/> that specifies the identifier of a dashboard containing the required dashboard item.
|
|
|
|
</param>
|
|
<param name="dashboardItemName">
|
|
A <see cref="T:System.String"/> that is the component name of the dashboard item to be exported.
|
|
|
|
</param>
|
|
<param name="stream">
|
|
A <see cref="T:System.IO.Stream"/> object to which the created image file should be sent.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.DashboardWeb.ASPxDashboardExporter.ExportDashboardItemToPdf(System.String,System.String,System.IO.Stream,System.Drawing.Size,DevExpress.DashboardCommon.DashboardState,DevExpress.DashboardCommon.DashboardPdfExportOptions)">
|
|
<summary>
|
|
<para>Exports the dashboard item to the specified stream in PDF format using the specified PDF-specific options.
|
|
</para>
|
|
</summary>
|
|
<param name="dashboardId">
|
|
A <see cref="T:System.String"/> that specifies the identifier of a dashboard containing the required dashboard item.
|
|
|
|
</param>
|
|
<param name="dashboardItemName">
|
|
A <see cref="T:System.String"/> that is the component name of the dashboard item to be exported.
|
|
|
|
</param>
|
|
<param name="stream">
|
|
A <see cref="T:System.IO.Stream"/> object to which the created PDF file should be sent.
|
|
|
|
</param>
|
|
<param name="dashboardItemSize">
|
|
A <see cref="T:System.Drawing.Size"/> object that specifies the dashboard item size.
|
|
|
|
</param>
|
|
<param name="state">
|
|
A <see cref="T:DevExpress.DashboardCommon.DashboardState"/> object that specifies the dashboard state to be applied to the resulting document.
|
|
|
|
</param>
|
|
<param name="options">
|
|
A <see cref="T:DevExpress.DashboardCommon.DashboardPdfExportOptions"/> object containing PDF-specific options.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.DashboardWeb.ASPxDashboardExporter.ExportDashboardItemToPdf(System.String,System.String,System.IO.Stream,System.Drawing.Size)">
|
|
<summary>
|
|
<para>Exports the dashboard item to the specified stream in PDF format using the specified PDF-specific options.
|
|
</para>
|
|
</summary>
|
|
<param name="dashboardId">
|
|
A <see cref="T:System.String"/> that specifies the identifier of a dashboard containing the required dashboard item.
|
|
|
|
</param>
|
|
<param name="dashboardItemName">
|
|
A <see cref="T:System.String"/> that is the component name of the dashboard item to be exported.
|
|
|
|
</param>
|
|
<param name="stream">
|
|
A <see cref="T:System.IO.Stream"/> object to which the created PDF file should be sent.
|
|
|
|
</param>
|
|
<param name="dashboardItemSize">
|
|
A <see cref="T:System.Drawing.Size"/> object that specifies the dashboard item size.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.DashboardWeb.ASPxDashboardExporter.ExportDashboardItemToPdf(System.String,System.String,System.IO.Stream)">
|
|
<summary>
|
|
<para>Exports the dashboard item to the specified stream in PDF format using the specified PDF-specific options.
|
|
</para>
|
|
</summary>
|
|
<param name="dashboardId">
|
|
A <see cref="T:System.String"/> that specifies the identifier of a dashboard containing the required dashboard item.
|
|
|
|
</param>
|
|
<param name="dashboardItemName">
|
|
A <see cref="T:System.String"/> that is the component name of the dashboard item to be exported.
|
|
|
|
</param>
|
|
<param name="stream">
|
|
A <see cref="T:System.IO.Stream"/> object to which the created PDF file should be sent.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.DashboardWeb.ASPxDashboardExporter.ExportDashboardItemToPdf(System.String,System.String,System.IO.Stream,System.Drawing.Size,DevExpress.DashboardCommon.DashboardState)">
|
|
<summary>
|
|
<para>Exports the dashboard item to the specified stream in PDF format using the specified PDF-specific options.
|
|
</para>
|
|
</summary>
|
|
<param name="dashboardId">
|
|
A <see cref="T:System.String"/> that specifies the identifier of a dashboard containing the required dashboard item.
|
|
|
|
</param>
|
|
<param name="dashboardItemName">
|
|
A <see cref="T:System.String"/> that is the component name of the dashboard item to be exported.
|
|
|
|
</param>
|
|
<param name="stream">
|
|
A <see cref="T:System.IO.Stream"/> object to which the created PDF file should be sent.
|
|
|
|
</param>
|
|
<param name="dashboardItemSize">
|
|
A <see cref="T:System.Drawing.Size"/> object that specifies the dashboard item size.
|
|
|
|
</param>
|
|
<param name="state">
|
|
A <see cref="T:DevExpress.DashboardCommon.DashboardState"/> object that specifies the dashboard state to be applied to the resulting document.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.DashboardWeb.ASPxDashboardExporter.ExportToExcel(System.String,System.IO.Stream)">
|
|
<summary>
|
|
<para>Exports dashboard data to the specified file in Excel format.
|
|
|
|
</para>
|
|
</summary>
|
|
<param name="dashboardId">
|
|
A <see cref="T:System.String"/> that specifies the identifier of a dashboard whose data should be exported.
|
|
|
|
</param>
|
|
<param name="stream">
|
|
A <see cref="T:System.IO.Stream"/> object to which the created Excel file should be sent.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.DashboardWeb.ASPxDashboardExporter.ExportToExcel(System.String,System.IO.Stream,DevExpress.DashboardCommon.DashboardState)">
|
|
<summary>
|
|
<para>Exports dashboard data to the specified file in Excel format.
|
|
|
|
</para>
|
|
</summary>
|
|
<param name="dashboardId">
|
|
A <see cref="T:System.String"/> that specifies the identifier of a dashboard whose data should be exported.
|
|
|
|
</param>
|
|
<param name="stream">
|
|
A <see cref="T:System.IO.Stream"/> object to which the created Excel file should be sent.
|
|
|
|
</param>
|
|
<param name="state">
|
|
A <see cref="T:DevExpress.DashboardCommon.DashboardState"/> object that specifies the dashboard state to be applied to the resulting document.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.DashboardWeb.ASPxDashboardExporter.ExportToExcel(System.String,System.IO.Stream,DevExpress.DashboardCommon.DashboardState,DevExpress.DashboardCommon.DashboardExcelExportOptions)">
|
|
<summary>
|
|
<para>Exports dashboard data to the specified file in Excel format.
|
|
|
|
</para>
|
|
</summary>
|
|
<param name="dashboardId">
|
|
A <see cref="T:System.String"/> that specifies the identifier of a dashboard whose data should be exported.
|
|
|
|
</param>
|
|
<param name="stream">
|
|
A <see cref="T:System.IO.Stream"/> object to which the created Excel file should be sent.
|
|
|
|
</param>
|
|
<param name="state">
|
|
A <see cref="T:DevExpress.DashboardCommon.DashboardState"/> object that specifies the dashboard state to be applied to the resulting document.
|
|
|
|
</param>
|
|
<param name="options">
|
|
A <see cref="T:DevExpress.DashboardCommon.DashboardExcelExportOptions"/> object containing Excel-specific options.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.DashboardWeb.ASPxDashboardExporter.ExportToImage(System.String,System.IO.Stream,System.Drawing.Size)">
|
|
<summary>
|
|
<para>Exports a dashboard to the specified file in Image format.
|
|
</para>
|
|
</summary>
|
|
<param name="dashboardId">
|
|
A <see cref="T:System.String"/> that specifies the identifier of a dashboard to be exported.
|
|
|
|
</param>
|
|
<param name="stream">
|
|
A <see cref="T:System.IO.Stream"/> object to which the created Image file should be sent.
|
|
|
|
</param>
|
|
<param name="dashboardSize">
|
|
A <see cref="T:System.Drawing.Size"/> object that specifies the dashboard size.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.DashboardWeb.ASPxDashboardExporter.ExportToImage(System.String,System.IO.Stream,System.Drawing.Size,DevExpress.DashboardCommon.DashboardState)">
|
|
<summary>
|
|
<para>Exports a dashboard to the specified file in Image format.
|
|
</para>
|
|
</summary>
|
|
<param name="dashboardId">
|
|
A <see cref="T:System.String"/> that specifies the identifier of a dashboard to be exported.
|
|
|
|
</param>
|
|
<param name="stream">
|
|
A <see cref="T:System.IO.Stream"/> object to which the created Image file should be sent.
|
|
|
|
</param>
|
|
<param name="dashboardSize">
|
|
A <see cref="T:System.Drawing.Size"/> object that specifies the dashboard size.
|
|
|
|
</param>
|
|
<param name="state">
|
|
A <see cref="T:DevExpress.DashboardCommon.DashboardState"/> object that specifies the dashboard state to be applied to the resulting document.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.DashboardWeb.ASPxDashboardExporter.ExportToImage(System.String,System.IO.Stream,System.Drawing.Size,DevExpress.DashboardCommon.DashboardState,DevExpress.DashboardCommon.DashboardImageExportOptions)">
|
|
<summary>
|
|
<para>Exports a dashboard to the specified file in Image format.
|
|
</para>
|
|
</summary>
|
|
<param name="dashboardId">
|
|
A <see cref="T:System.String"/> that specifies the identifier of a dashboard to be exported.
|
|
|
|
</param>
|
|
<param name="stream">
|
|
A <see cref="T:System.IO.Stream"/> object to which the created Image file should be sent.
|
|
|
|
</param>
|
|
<param name="dashboardSize">
|
|
A <see cref="T:System.Drawing.Size"/> object that specifies the dashboard size.
|
|
|
|
</param>
|
|
<param name="state">
|
|
A <see cref="T:DevExpress.DashboardCommon.DashboardState"/> object that specifies the dashboard state to be applied to the resulting document.
|
|
|
|
</param>
|
|
<param name="options">
|
|
A <see cref="T:DevExpress.DashboardCommon.DashboardImageExportOptions"/> object containing image-specific options.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.DashboardWeb.ASPxDashboardExporter.ExportToImage(System.String,System.IO.Stream)">
|
|
<summary>
|
|
<para>Exports a dashboard to the specified file in Image format.
|
|
</para>
|
|
</summary>
|
|
<param name="dashboardId">
|
|
A <see cref="T:System.String"/> that specifies the identifier of a dashboard to be exported.
|
|
|
|
</param>
|
|
<param name="stream">
|
|
A <see cref="T:System.IO.Stream"/> object to which the created Image file should be sent.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.DashboardWeb.ASPxDashboardExporter.ExportToImage(System.String,System.IO.Stream,System.Drawing.Size,DevExpress.DashboardWeb.Padding)">
|
|
<summary>
|
|
<para>Exports a dashboard to the specified file in Image format.
|
|
</para>
|
|
</summary>
|
|
<param name="dashboardId">
|
|
A <see cref="T:System.String"/> that specifies the identifier of a dashboard to be exported.
|
|
|
|
</param>
|
|
<param name="stream">
|
|
A <see cref="T:System.IO.Stream"/> object to which the created Image file should be sent.
|
|
|
|
</param>
|
|
<param name="dashboardSize">
|
|
A <see cref="T:System.Drawing.Size"/> object that specifies the dashboard size.
|
|
|
|
</param>
|
|
<param name="itemsPadding">
|
|
A <see cref="T:DevExpress.DashboardWeb.Padding"/> object that specifies the dashboard items paddings.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.DashboardWeb.ASPxDashboardExporter.ExportToImage(System.String,System.IO.Stream,System.Drawing.Size,DevExpress.DashboardWeb.Padding,DevExpress.DashboardCommon.DashboardState,DevExpress.DashboardCommon.DashboardImageExportOptions)">
|
|
<summary>
|
|
<para>Exports a dashboard to the specified file in Image format.
|
|
|
|
</para>
|
|
</summary>
|
|
<param name="dashboardId">
|
|
A <see cref="T:System.String"/> that specifies the identifier of a dashboard to be exported.
|
|
|
|
</param>
|
|
<param name="stream">
|
|
A <see cref="T:System.IO.Stream"/> object to which the created image file should be sent.
|
|
|
|
</param>
|
|
<param name="dashboardSize">
|
|
A <see cref="T:System.Drawing.Size"/> object that specifies the dashboard size.
|
|
|
|
</param>
|
|
<param name="itemsPadding">
|
|
A <see cref="T:DevExpress.DashboardWeb.Padding"/> object that specifies the dashboard items paddings.
|
|
|
|
</param>
|
|
<param name="state">
|
|
A <see cref="T:DevExpress.DashboardCommon.DashboardState"/> object that specifies the dashboard state to be applied to the resulting document.
|
|
|
|
</param>
|
|
<param name="options">
|
|
A <see cref="T:DevExpress.DashboardCommon.DashboardImageExportOptions"/> object containing Image-specific options.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.DashboardWeb.ASPxDashboardExporter.ExportToPdf(System.String,System.IO.Stream,System.Drawing.Size)">
|
|
<summary>
|
|
<para>Exports a dashboard to the specified file in PDF format.
|
|
</para>
|
|
</summary>
|
|
<param name="dashboardId">
|
|
A <see cref="T:System.String"/> that specifies the identifier of a dashboard to be exported.
|
|
|
|
</param>
|
|
<param name="stream">
|
|
A <see cref="T:System.IO.Stream"/> object to which the created PDF file should be sent.
|
|
|
|
</param>
|
|
<param name="dashboardSize">
|
|
A <see cref="T:System.Drawing.Size"/> object that specifies the dashboard size.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.DashboardWeb.ASPxDashboardExporter.ExportToPdf(System.String,System.IO.Stream,System.Drawing.Size,DevExpress.DashboardCommon.DashboardState)">
|
|
<summary>
|
|
<para>Exports a dashboard to the specified file in PDF format.
|
|
</para>
|
|
</summary>
|
|
<param name="dashboardId">
|
|
A <see cref="T:System.String"/> that specifies the identifier of a dashboard to be exported.
|
|
|
|
</param>
|
|
<param name="stream">
|
|
A <see cref="T:System.IO.Stream"/> object to which the created PDF file should be sent.
|
|
|
|
</param>
|
|
<param name="dashboardSize">
|
|
A <see cref="T:System.Drawing.Size"/> object that specifies the dashboard size.
|
|
|
|
</param>
|
|
<param name="state">
|
|
A <see cref="T:DevExpress.DashboardCommon.DashboardState"/> object that specifies the dashboard state to be applied to the resulting document.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.DashboardWeb.ASPxDashboardExporter.ExportToPdf(System.String,System.IO.Stream,System.Drawing.Size,DevExpress.DashboardCommon.DashboardState,DevExpress.DashboardCommon.DashboardPdfExportOptions)">
|
|
<summary>
|
|
<para>Exports a dashboard to the specified file in PDF format.
|
|
</para>
|
|
</summary>
|
|
<param name="dashboardId">
|
|
A <see cref="T:System.String"/> that specifies the identifier of a dashboard to be exported.
|
|
|
|
</param>
|
|
<param name="stream">
|
|
A <see cref="T:System.IO.Stream"/> object to which the created PDF file should be sent.
|
|
|
|
</param>
|
|
<param name="dashboardSize">
|
|
A <see cref="T:System.Drawing.Size"/> object that specifies the dashboard size.
|
|
|
|
</param>
|
|
<param name="state">
|
|
A <see cref="T:DevExpress.DashboardCommon.DashboardState"/> object that specifies the dashboard state to be applied to the resulting document.
|
|
|
|
</param>
|
|
<param name="options">
|
|
A <see cref="T:DevExpress.DashboardCommon.DashboardPdfExportOptions"/> object containing PDF-specific options.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.DashboardWeb.ASPxDashboardExporter.ExportToPdf(System.String,System.IO.Stream)">
|
|
<summary>
|
|
<para>Exports a dashboard to the specified file in PDF format.
|
|
</para>
|
|
</summary>
|
|
<param name="dashboardId">
|
|
A <see cref="T:System.String"/> that specifies the identifier of a dashboard to be exported.
|
|
|
|
</param>
|
|
<param name="stream">
|
|
A <see cref="T:System.IO.Stream"/> object to which the created PDF file should be sent.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.DashboardWeb.ASPxDashboardExporter.ExportToPdf(System.String,System.IO.Stream,System.Drawing.Size,DevExpress.DashboardWeb.Padding,DevExpress.DashboardCommon.DashboardState,DevExpress.DashboardCommon.DashboardPdfExportOptions)">
|
|
<summary>
|
|
<para>Exports a dashboard to the specified file in PDF format.
|
|
</para>
|
|
</summary>
|
|
<param name="dashboardId">
|
|
A <see cref="T:System.String"/> that specifies the identifier of a dashboard to be exported.
|
|
|
|
</param>
|
|
<param name="stream">
|
|
A <see cref="T:System.IO.Stream"/> object to which the created PDF file should be sent.
|
|
|
|
</param>
|
|
<param name="dashboardSize">
|
|
A <see cref="T:System.Drawing.Size"/> object that specifies the dashboard size.
|
|
|
|
</param>
|
|
<param name="itemsPadding">
|
|
A <see cref="T:DevExpress.DashboardWeb.Padding"/> object that specifies the dashboard items paddings.
|
|
|
|
</param>
|
|
<param name="state">
|
|
A <see cref="T:DevExpress.DashboardCommon.DashboardState"/> object that specifies the dashboard state to be applied to the resulting document.
|
|
|
|
</param>
|
|
<param name="options">
|
|
A <see cref="T:DevExpress.DashboardCommon.DashboardPdfExportOptions"/> object containing PDF-specific options.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.DashboardWeb.ASPxDashboardExporter.ExportToPdf(System.String,System.IO.Stream,System.Drawing.Size,DevExpress.DashboardWeb.Padding)">
|
|
<summary>
|
|
<para>Exports a dashboard to the specified file in PDF format.
|
|
</para>
|
|
</summary>
|
|
<param name="dashboardId">
|
|
A <see cref="T:System.String"/> that specifies the identifier of a dashboard to be exported.
|
|
|
|
</param>
|
|
<param name="stream">
|
|
A <see cref="T:System.IO.Stream"/> object to which the created PDF file should be sent.
|
|
|
|
</param>
|
|
<param name="dashboardSize">
|
|
A <see cref="T:System.Drawing.Size"/> object that specifies the dashboard size.
|
|
|
|
</param>
|
|
<param name="itemsPadding">
|
|
A <see cref="T:DevExpress.DashboardWeb.Padding"/> object that specifies the dashboard items paddings.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.DashboardWeb.ASPxDashboardExporter.GetPrintableComponent(System.String,System.String)">
|
|
<summary>
|
|
<para>Gets a printable component corresponding to the specified dashboard item.
|
|
</para>
|
|
</summary>
|
|
<param name="dashboardId">
|
|
A <see cref="T:System.String"/> that specifies the identifier of the dashboard containing the required dashboard item.
|
|
|
|
</param>
|
|
<param name="dashboardItemName">
|
|
A <see cref="T:System.String"/> that specifies the component name of the dashboard item.
|
|
|
|
</param>
|
|
<returns>An object that implements the <see cref="T:DevExpress.XtraPrinting.IPrintable"/> interface, specifying a component to be printed/exported.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.DashboardWeb.GaugeExportOptions">
|
|
|
|
<summary>
|
|
<para>Contains settings that specify parameters affecting how the Gauge dashboard item is exported.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.DashboardWeb.GaugeExportOptions.#ctor">
|
|
<summary>
|
|
<para>Initialize a new instance of the GaugeExportOptions class with default settings.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.DashboardWeb.GaugeExportOptions.Assign(DevExpress.DashboardWeb.OptionsBase)">
|
|
<summary>
|
|
<para>Copies settings of the specified object to the current object.
|
|
</para>
|
|
</summary>
|
|
<param name="options">
|
|
An <see cref="T:DevExpress.DashboardWeb.OptionsBase"/> descendant whose settings are copied to the current object.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.GaugeExportOptions.AutoArrangeContent">
|
|
<summary>
|
|
<para>Gets or sets whether dashboard item elements are arranged automatically on the exported page.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b>, to arrange dashboard item elements automatically on the exported page; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.DashboardWeb.LimitVisibleDataMode">
|
|
|
|
<summary>
|
|
<para>Lists values that specify data limitation modes.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="F:DevExpress.DashboardWeb.LimitVisibleDataMode.Designer">
|
|
<summary>
|
|
<para>Visible data will be limited only in the designer mode.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.DashboardWeb.LimitVisibleDataMode.DesignerAndViewer">
|
|
<summary>
|
|
<para>Visible data will be limited both in the designer and viewer modes.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.DashboardWeb.LimitVisibleDataMode.None">
|
|
<summary>
|
|
<para>Visible data will not be reduced.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.DashboardWeb.DashboardJsonConverter">
|
|
|
|
<summary>
|
|
<para>Provides methods that allows you to convert a dashboard XML definition to JSON and vice versa.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.DashboardWeb.DashboardJsonConverter.JsonToXml(System.String)">
|
|
<summary>
|
|
<para>Converts a JSON dashboard model to its XML equivalent.
|
|
</para>
|
|
</summary>
|
|
<param name="json">
|
|
A <see cref="T:System.String"/> value that specifies the JSON dashboard model.
|
|
|
|
</param>
|
|
<returns>A <see cref="T:System.Xml.Linq.XDocument"/> that is the dashboard XML definition.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.DashboardWeb.DashboardJsonConverter.XmlToJson(System.Xml.Linq.XDocument)">
|
|
<summary>
|
|
<para>Converts a dashboard XML definition to the JSON string.
|
|
</para>
|
|
</summary>
|
|
<param name="dashboardDocument">
|
|
A <see cref="T:System.Xml.Linq.XDocument"/> that specifies the dashboard XML definition.
|
|
|
|
</param>
|
|
<returns>A <see cref="T:System.String"/> value that is the JSON dashboard model.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.DashboardWeb.DashboardExportFilterState">
|
|
|
|
<summary>
|
|
<para>Lists values that specify the filter state's location on the exported document.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="F:DevExpress.DashboardWeb.DashboardExportFilterState.Below">
|
|
<summary>
|
|
<para>The filter state is placed below the dashboard (dashboard item) in the exported document.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.DashboardWeb.DashboardExportFilterState.None">
|
|
<summary>
|
|
<para>The filter state is not included in the exported document.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.DashboardWeb.DashboardExportFilterState.SeparatePage">
|
|
<summary>
|
|
<para>The filter state is placed on a separate page in the exported document.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.DashboardWeb.DashboardTypeStorage">
|
|
|
|
<summary>
|
|
<para>A storage of dashboards created at design time within Visual Studio.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.DashboardWeb.DashboardTypeStorage.#ctor">
|
|
<summary>
|
|
<para>Initializes a new instance of the DashboardTypeStorage class.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.DashboardWeb.DashboardTypeStorage.RegisterDashboard(System.Type,System.String,System.String)">
|
|
<summary>
|
|
<para>Adds a new dashboard to the current DashboardTypeStorage.
|
|
</para>
|
|
</summary>
|
|
<param name="dashboardType">
|
|
A <see cref="T:System.Type"/> object that specifies the dashboard type.
|
|
|
|
</param>
|
|
<param name="dashboardName">
|
|
A <see cref="T:System.String"/> value that specifies the dashboard name.
|
|
|
|
</param>
|
|
<param name="dashboardId">
|
|
A <see cref="T:System.String"/> value that specifies the dashboard identifier.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.DashboardWeb.DashboardTypeStorage.RegisterDashboard(System.Type,System.String)">
|
|
<summary>
|
|
<para>Adds a new dashboard to the current DashboardTypeStorage.
|
|
</para>
|
|
</summary>
|
|
<param name="dashboardType">
|
|
A <see cref="T:System.Type"/> object that specifies the dashboard type.
|
|
|
|
</param>
|
|
<param name="dashboardName">
|
|
A <see cref="T:System.String"/> value that specifies the dashboard name.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.DashboardWeb.DashboardTypeStorage.RegisterDashboard(System.Type)">
|
|
<summary>
|
|
<para>Adds a new dashboard to the current DashboardTypeStorage.
|
|
</para>
|
|
</summary>
|
|
<param name="dashboardType">
|
|
A <see cref="T:System.Type"/> object that specifies the dashboard type.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.DashboardWeb.DashboardTypeStorage.SaveDashboard(System.String,System.Xml.Linq.XDocument)">
|
|
<summary>
|
|
<para>Saves the specified dashboard to the current DashboardTypeStorage.
|
|
</para>
|
|
</summary>
|
|
<param name="dashboardID">
|
|
A <see cref="T:System.String"/> value that specifies the dashboard identifier.
|
|
|
|
</param>
|
|
<param name="dashboard">
|
|
A <see cref="T:System.Xml.Linq.XDocument"/> object that is the XML definition of the dashboard to be saved.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.DashboardWeb.ConfigureItemDataCalculationWebEventHandler">
|
|
|
|
<summary>
|
|
<para>References a method that will handle the <see cref="E:DevExpress.DashboardWeb.ASPxDashboard.ConfigureItemDataCalculation"/> and <see cref="E:DevExpress.DashboardWeb.DashboardConfigurator.ConfigureItemDataCalculation"/> events.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.DashboardWeb.ConfigureItemDataCalculationWebEventHandler.Invoke(System.Object,DevExpress.DashboardWeb.ConfigureItemDataCalculationWebEventArgs)">
|
|
<summary>
|
|
<para>References a method that will handle the <b>ConfigureItemDataCalculation</b> events.
|
|
</para>
|
|
</summary>
|
|
<param name="sender">
|
|
The event source.
|
|
|
|
</param>
|
|
<param name="e">
|
|
A <see cref="T:DevExpress.DashboardWeb.ConfigureItemDataCalculationWebEventArgs"/> object that contains event data.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.DashboardWeb.DataSourceInMemoryStorage">
|
|
|
|
<summary>
|
|
<para>An in-memory storage of the dashboard data sources.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.DashboardWeb.DataSourceInMemoryStorage.#ctor">
|
|
<summary>
|
|
<para>Initializes a new instance of the DataSourceInMemoryStorage class.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.DashboardWeb.DataSourceInMemoryStorage.RegisterDataSource(System.String,System.Xml.Linq.XDocument)">
|
|
<summary>
|
|
<para>Registers the specified data source in the current DataSourceInMemoryStorage.
|
|
</para>
|
|
</summary>
|
|
<param name="dataSourceId">
|
|
A <see cref="T:System.String"/> that is the data source identifier.
|
|
|
|
</param>
|
|
<param name="document">
|
|
A <see cref="T:System.Xml.Linq.XDocument"/> object that specifies the XML document containing a data source definition.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.DashboardWeb.DataSourceInMemoryStorage.RegisterDataSource(System.Xml.Linq.XElement)">
|
|
<summary>
|
|
<para>Registers the specified data source in the current DataSourceInMemoryStorage.
|
|
</para>
|
|
</summary>
|
|
<param name="rootElement">
|
|
A <see cref="T:System.Xml.Linq.XElement"/> object that specifies the XML element.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.DashboardWeb.DataSourceInMemoryStorage.RegisterDataSource(System.Xml.Linq.XDocument)">
|
|
<summary>
|
|
<para>Registers the specified data source in the current DataSourceInMemoryStorage.
|
|
</para>
|
|
</summary>
|
|
<param name="document">
|
|
A <see cref="T:System.Xml.Linq.XDocument"/> object that specifies the XML document containing a data source definition.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.DashboardWeb.DataSourceInMemoryStorage.RegisterDataSource(System.String,System.Xml.Linq.XElement)">
|
|
<summary>
|
|
<para>Registers the specified data source in the current DataSourceInMemoryStorage.
|
|
</para>
|
|
</summary>
|
|
<param name="dataSourceId">
|
|
A <see cref="T:System.String"/> that is the data source identifier.
|
|
|
|
</param>
|
|
<param name="rootElement">
|
|
A <see cref="T:System.Xml.Linq.XElement"/> object that specifies the XML element.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.DashboardWeb.DashboardService">
|
|
|
|
<summary>
|
|
<para>Provides a server side API for the <see cref="T:DevExpress.DashboardWeb.ASPxDashboardDesigner"/> control and MVC Designer.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.DashboardService.DashboardStorage">
|
|
<summary>
|
|
<para>Gets a storage of dashboards for the Web Dashboard.
|
|
</para>
|
|
</summary>
|
|
<value>An object implementing the <see cref="T:DevExpress.DashboardWeb.IDashboardStorage"/> interface that is the storage of dashboards.
|
|
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.DashboardService.DataApi">
|
|
<summary>
|
|
<para>Provides access to an API used supply the Web Dashboard with data.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.DashboardWeb.DataApiProvider"/> object providing access to an API used to supply the Web Dashboard with data.
|
|
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.DashboardService.DataSourceStorage">
|
|
<summary>
|
|
<para>Gets the data source storage used by the Web Dashboard.
|
|
</para>
|
|
</summary>
|
|
<value>An object implementing the <see cref="T:DevExpress.DashboardWeb.IDataSourceStorage"/> interface that is a storage of the dashboard data sources.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.DashboardService.PassCredentials">
|
|
<summary>
|
|
<para>Gets or sets whether or not confidential information (such as user credentials) will be passed to the client side (web browser).
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b>, to pass confidential information to the client side; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.DashboardWeb.DashboardService.SetDashboardStorage(DevExpress.DashboardWeb.IDashboardStorage)">
|
|
<summary>
|
|
<para>Specifies a custom storage of dashboards for the Web Dashboard.
|
|
</para>
|
|
</summary>
|
|
<param name="customStorage">
|
|
An object implementing the <see cref="T:DevExpress.DashboardWeb.IDashboardStorage"/> interface that is the custom storage of dashboards.
|
|
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.DashboardWeb.DashboardService.SetDashboardStorage(DevExpress.DashboardWeb.DashboardFileStorage)">
|
|
<summary>
|
|
<para>Specifies a file storage of dashboards for the Web Dashboard.
|
|
</para>
|
|
</summary>
|
|
<param name="fileStorage">
|
|
A <see cref="T:DevExpress.DashboardWeb.DashboardFileStorage"/> object that is the file storage of dashboards.
|
|
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.DashboardWeb.DashboardService.SetDashboardStorage(DevExpress.DashboardWeb.DashboardInMemoryStorage)">
|
|
<summary>
|
|
<para>Specifies an in-memory storage of dashboards for the Web Dashboard.
|
|
</para>
|
|
</summary>
|
|
<param name="inMemoryStorage">
|
|
A <see cref="T:DevExpress.DashboardWeb.DashboardInMemoryStorage"/> object that is the in-memory storage of dashboards.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.DashboardWeb.DashboardService.SetDashboardStorage(DevExpress.DashboardWeb.IEditableDashboardStorage)">
|
|
<summary>
|
|
<para>Specifies an editable storage of dashboards for the Web Dashboard.
|
|
</para>
|
|
</summary>
|
|
<param name="customStorage">
|
|
An object implementing the <see cref="T:DevExpress.DashboardWeb.IEditableDashboardStorage"/> interface that is an editable storage of dashboards.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.DashboardWeb.DashboardService.SetDataSourceStorage(DevExpress.DashboardWeb.DataSourceInMemoryStorage)">
|
|
<summary>
|
|
<para>Specifies a data source storage for the Web Designer.
|
|
</para>
|
|
</summary>
|
|
<param name="inMemoryStorage">
|
|
A <see cref="T:DevExpress.DashboardWeb.DataSourceInMemoryStorage"/> object that is a storage of the dashboard data sources.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.DashboardWeb.DashboardService.SetDataSourceStorage(DevExpress.DashboardWeb.IDataSourceStorage)">
|
|
<summary>
|
|
<para>Specifies a data source storage for the Web Designer.
|
|
</para>
|
|
</summary>
|
|
<param name="customStorage">
|
|
An object implementing the <see cref="T:DevExpress.DashboardWeb.IDataSourceStorage"/> interface that is a storage of the dashboard data sources.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.DashboardWeb.DashboardDesignerClientSideEvents">
|
|
|
|
<summary>
|
|
<para>Contains a list of the client-side events available for the <see cref="T:DevExpress.DashboardWeb.ASPxDashboard"/> control.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.DashboardWeb.DashboardDesignerClientSideEvents.#ctor">
|
|
<summary>
|
|
<para>Initializes a new instance of the DashboardDesignerClientSideEvents class.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.DashboardWeb.WorkingMode">
|
|
|
|
<summary>
|
|
<para>A working mode of the <see cref="T:DevExpress.DashboardWeb.ASPxDashboard"/> control.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="F:DevExpress.DashboardWeb.WorkingMode.Designer">
|
|
<summary>
|
|
<para>The Web Dashboard acts as a Dashboard Designer and allows end-users to create, edit and save dashboards. Note that in this case, you can switch to the <see cref="F:DevExpress.DashboardWeb.WorkingMode.Viewer"/> mode on the client side using the <see cref="M:DevExpress.DashboardWeb.Scripts.ASPxClientDashboard.SwitchToViewer"/> method.
|
|
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.DashboardWeb.WorkingMode.Viewer">
|
|
<summary>
|
|
<para>The Web Dashboard acts as a Dashboard Viewer and allows you to display dashboards to end-users. Note that in this case, you can switch to the <see cref="F:DevExpress.DashboardWeb.WorkingMode.Designer"/> mode on the client side using the <see cref="M:DevExpress.DashboardWeb.Scripts.ASPxClientDashboard.SwitchToDesigner"/> method.
|
|
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.DashboardWeb.WorkingMode.ViewerOnly">
|
|
<summary>
|
|
<para>The Web Dashboard acts as a Dashboard Viewer without the capability to switch to the Designer mode on the client side.
|
|
In this mode, the Web Dashboard does not load the extensions required for designing dashboards.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.DashboardWeb.ASPxDashboardDesigner">
|
|
|
|
<summary>
|
|
<para>The Web Dashboard Designer.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.DashboardWeb.ASPxDashboardDesigner.#ctor">
|
|
<summary>
|
|
<para>Initializes a new instance of the ASPxDashboardDesigner class.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.ASPxDashboardDesigner.UseDashboardConfigurator">
|
|
<summary>
|
|
<para>For internal use.
|
|
</para>
|
|
</summary>
|
|
<value>
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.DashboardWeb.IDashboardStateService">
|
|
|
|
<summary>
|
|
<para>When implemented by a class, provides a service used to manage a dashboard state.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.DashboardWeb.IDashboardStateService.GetState(System.String,System.Xml.Linq.XDocument)">
|
|
<summary>
|
|
<para>Gets the dashboard state for the current state service.
|
|
|
|
</para>
|
|
</summary>
|
|
<param name="dashboardId">
|
|
A <see cref="T:System.String"/> value that specifies the dashboard identifier.
|
|
|
|
</param>
|
|
<param name="dashboard">
|
|
A <see cref="T:System.Xml.Linq.XDocument"/> object that is the XML document containing the dashboard.
|
|
|
|
</param>
|
|
<returns>A <see cref="T:DevExpress.DashboardCommon.DashboardState"/> object containing a dashboard sate.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.DashboardWeb.DashboardTheme">
|
|
|
|
<summary>
|
|
<para>Lists values that specify dashboard themes.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="F:DevExpress.DashboardWeb.DashboardTheme.Dark">
|
|
<summary>
|
|
<para>The Dark theme is used to paint the dashboard.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.DashboardWeb.DashboardTheme.Light">
|
|
<summary>
|
|
<para>The Light theme is used to paint the dashboard.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.DashboardWeb.DashboardAddingWebEventHandler">
|
|
|
|
<summary>
|
|
<para>References a method that will handle the <see cref="E:DevExpress.DashboardWeb.ASPxDashboard.DashboardAdding"/> event.
|
|
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.DashboardWeb.DashboardAddingWebEventHandler.Invoke(System.Object,DevExpress.DashboardWeb.DashboardAddingWebEventArgs)">
|
|
<summary>
|
|
<para>References a method that will handle the <see cref="E:DevExpress.DashboardWeb.ASPxDashboard.DashboardAdding"/> event.
|
|
</para>
|
|
</summary>
|
|
<param name="sender">
|
|
The event source.
|
|
|
|
</param>
|
|
<param name="e">
|
|
A <see cref="T:DevExpress.DashboardWeb.DashboardAddingWebEventArgs"/> object that contains event data.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.DashboardWeb.DashboardLoadingWebEventArgs">
|
|
|
|
<summary>
|
|
<para>Provides data for the <see cref="E:DevExpress.DashboardWeb.ASPxDashboard.DashboardLoading"/> event.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.DashboardWeb.DashboardLoadingWebEventArgs.#ctor(System.String,System.Xml.Linq.XDocument)">
|
|
<summary>
|
|
<para>Initializes a new instance of the DashboardLoadingWebEventArgs class.
|
|
</para>
|
|
</summary>
|
|
<param name="dashboardId">
|
|
A <see cref="T:System.String"/> value that specifies the dashboard identifier.
|
|
|
|
</param>
|
|
<param name="dashboard">
|
|
A <see cref="T:System.Xml.Linq.XDocument"/> object that specifies the dashboard XML definition.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.DashboardLoadingWebEventArgs.DashboardId">
|
|
<summary>
|
|
<para>Gets the dashboard identifier.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:System.String"/> value that is the dashboard identifier.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.DashboardLoadingWebEventArgs.DashboardXml">
|
|
<summary>
|
|
<para>Gets or sets the dashboard XML definition.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:System.Xml.Linq.XDocument"/> object that specifies the dashboard XML definition.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.DashboardWeb.ChartExportSizeMode">
|
|
|
|
<summary>
|
|
<para>Lists values used to specify how a Chart dashboard item should be resized when being exported.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="F:DevExpress.DashboardWeb.ChartExportSizeMode.None">
|
|
<summary>
|
|
<para>A chart dashboard item is exported in a size identical to that shown on the dashboard.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.DashboardWeb.ChartExportSizeMode.Stretch">
|
|
<summary>
|
|
<para>A chart dashboard item is stretched or shrunk to fit the page to which it is exported.
|
|
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.DashboardWeb.ChartExportSizeMode.Zoom">
|
|
<summary>
|
|
<para>A chart dashboard item is resized proportionally to best fit the exported page.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.DashboardWeb.Localization.DashboardWebResLocalizer">
|
|
|
|
<summary>
|
|
<para>Provides localized strings for the <see cref="T:DevExpress.DashboardWeb.ASPxDashboardViewer"/> user interface elements.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.DashboardWeb.Localization.DashboardWebResLocalizer.#ctor(DevExpress.DashboardWeb.Localization.DashboardWebLocalizer)">
|
|
<summary>
|
|
<para>Initializes a new instance of the DashboardWebResLocalizer class.
|
|
</para>
|
|
</summary>
|
|
<param name="localizer">
|
|
A <see cref="T:DevExpress.DashboardWeb.Localization.DashboardWebLocalizer"/> object specifying the default localizer.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.DashboardWeb.Localization.DashboardWebResLocalizer.#ctor">
|
|
<summary>
|
|
<para>Initializes a new instance of the DashboardWebResLocalizer class with default settings.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.DashboardWeb.Localization.DashboardWebLocalizer">
|
|
|
|
<summary>
|
|
<para>Provides localized strings for the <see cref="T:DevExpress.DashboardWeb.ASPxDashboardViewer"/> user interface elements.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.DashboardWeb.Localization.DashboardWebLocalizer.#ctor">
|
|
<summary>
|
|
<para>Initializes a new instance of the DashboardWebLocalizer class.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.DashboardWeb.Localization.DashboardWebLocalizer.CreateResXLocalizer">
|
|
<summary>
|
|
<para>Returns an object representing resources based on the thread's language and regional settings (culture).
|
|
</para>
|
|
</summary>
|
|
<returns>An <see cref="T:DevExpress.Utils.Localization.XtraLocalizer`1"/> object representing resources based on the thread's culture.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.DashboardWeb.Localization.DashboardWebLocalizer.GetString(DevExpress.DashboardWeb.Localization.DashboardWebStringId)">
|
|
<summary>
|
|
<para>Returns a localized string for the specified string identifier.
|
|
</para>
|
|
</summary>
|
|
<param name="id">
|
|
A <see cref="T:DevExpress.DashboardWeb.Localization.DashboardWebStringId"/> enumeration value identifying the string to localize.
|
|
|
|
</param>
|
|
<returns>A <see cref="T:System.String"/> corresponding to the specified identifier.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.DashboardWeb.Localization.DashboardWebStringId">
|
|
|
|
<summary>
|
|
<para>Lists values corresponding to strings that can be localized.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="F:DevExpress.DashboardWeb.Localization.DashboardWebStringId.IncompatibleBrowser">
|
|
<summary>
|
|
<para><b>Default value</b>: Dashboard Viewer: The current browser version is not supported.<br/><br/>Currently, the following browsers are supported: Internet Explorer 9, Chrome, Safari, FireFox, Opera, Android 3+.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.DashboardWeb.DashboardLoadingEventHandler">
|
|
|
|
<summary>
|
|
<para>References a method that will handle the <see cref="E:DevExpress.DashboardWeb.ASPxDashboardViewer.DashboardLoading"/> event.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.DashboardWeb.DashboardLoadingEventHandler.Invoke(System.Object,DevExpress.DashboardWeb.DashboardLoadingEventArgs)">
|
|
<summary>
|
|
<para>References a method that will handle the <see cref="E:DevExpress.DashboardWeb.ASPxDashboardViewer.DashboardLoading"/> event.
|
|
</para>
|
|
</summary>
|
|
<param name="sender">
|
|
The event source.
|
|
|
|
</param>
|
|
<param name="e">
|
|
A <see cref="T:DevExpress.DashboardWeb.DashboardLoadingEventArgs"/> object that contains event data.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.DashboardWeb.DashboardLoadingEventArgs">
|
|
|
|
<summary>
|
|
<para>Provides data for the <see cref="E:DevExpress.DashboardWeb.ASPxDashboardViewer.DashboardLoading"/> event.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.DashboardLoadingEventArgs.DashboardId">
|
|
<summary>
|
|
<para>Gets the identifier of the required dashboard.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:System.String"/> that identifies a dashboard that should be provided via the <see cref="P:DevExpress.DashboardWeb.DashboardLoadingEventArgs.DashboardXml"/> property.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.DashboardLoadingEventArgs.DashboardType">
|
|
<summary>
|
|
<para>Gets or sets the type of the dashboard created at design time.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:System.Type"/> that specifies a type of the dashboard created at design time.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.DashboardLoadingEventArgs.DashboardXml">
|
|
<summary>
|
|
<para>Gets or sets the dashboard XML definition.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:System.String"/> containing XML data that defines the dashboard.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.DashboardWeb.ASPxDashboardViewer">
|
|
|
|
<summary>
|
|
<para>A Web Dashboard Viewer used to embed dashboards created in the Dashboard Designer into a web application.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.DashboardWeb.ASPxDashboardViewer.#ctor">
|
|
<summary>
|
|
<para>Initializes a new instance of the ASPxDashboardViewer class.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.ASPxDashboardViewer.AllowExportDashboard">
|
|
<summary>
|
|
<para>Gets or sets whether end-users can export a dashboard.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b>, if end-users can export a dashboard; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.ASPxDashboardViewer.AllowExportDashboardItems">
|
|
<summary>
|
|
<para>Gets or sets whether end-users can export dashboard items.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b>, if end-users can export dashboard items; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.ASPxDashboardViewer.CalculateHiddenTotals">
|
|
<summary>
|
|
<para>Gets or sets whether to calculate totals that are not displayed in the dashboard item.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b>, to calculate hidden totals; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.ASPxDashboardViewer.ClientInstanceName">
|
|
<summary>
|
|
<para>Gets or sets the Dashboard Viewer's client programmatic identifier.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:System.String"/> that specifies the Dashboard Viewer's client identifier.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.ASPxDashboardViewer.ClientSideEvents">
|
|
<summary>
|
|
<para>Gets an object that lists the client-side events specific to the ASPxDashboardViewer control.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.DashboardWeb.DashboardClientSideEvents"/> object which allows assigning handlers to the client-side events available to the ASPxDashboardViewer control.
|
|
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.ASPxDashboardViewer.ColorScheme">
|
|
<summary>
|
|
<para>Gets or sets the name of the color theme to be applied to the control.
|
|
</para>
|
|
</summary>
|
|
<value>A string value specifying the color theme name.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.DashboardWeb.ASPxDashboardViewer.ConfigureDataConnection">
|
|
<summary>
|
|
<para>Allows you to customize connection settings before the ASPxDashboardViewer connects to a data store (database, OLAP cube, etc.).
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.DashboardWeb.ASPxDashboardViewer.CustomAssemblyLoading">
|
|
<summary>
|
|
<para>Occurs before a custom assembly is loaded for use as <see cref="T:DevExpress.DashboardCommon.DashboardEFDataSource"/>.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.DashboardWeb.ASPxDashboardViewer.CustomExport">
|
|
<summary>
|
|
<para>Allows you to customize the exported document.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.DashboardWeb.ASPxDashboardViewer.CustomFilterExpression">
|
|
<summary>
|
|
<para>Allows you to include WHERE clauses in SQL queries.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.DashboardWeb.ASPxDashboardViewer.CustomizeExportDocument">
|
|
<summary>
|
|
<para>Allows you to customize the exported document.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.DashboardWeb.ASPxDashboardViewer.CustomJSProperties">
|
|
<summary>
|
|
<para>Enables you to supply any server data that can then be parsed on the client.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.DashboardWeb.ASPxDashboardViewer.CustomPalette">
|
|
<summary>
|
|
<para>Provides the capability to substitute the default palette containing colors used to paint dashboard item elements.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.DashboardWeb.ASPxDashboardViewer.CustomParameters">
|
|
<summary>
|
|
<para>Occurs before data is loaded from the data store and allows you to customize dashboard parameters that are used for data processing.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.ASPxDashboardViewer.DashboardId">
|
|
<summary>
|
|
<para>Gets or sets the dashboard identifier.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:System.String"/> that specifies the dashboard identifier.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.DashboardWeb.ASPxDashboardViewer.DashboardLoaded">
|
|
<summary>
|
|
<para>Occurs after the dashboard is loaded to the ASPxDashboardViewer.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.DashboardWeb.ASPxDashboardViewer.DashboardLoading">
|
|
<summary>
|
|
<para>Allows you to load a dashboard at runtime.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.ASPxDashboardViewer.DashboardSource">
|
|
<summary>
|
|
<para>Gets or sets a dashboard supplier for the ASPxDashboardViewer.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:System.Object"/> value specifying a dashboard supplier for the ASPxDashboardViewer.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.ASPxDashboardViewer.DashboardTheme">
|
|
<summary>
|
|
<para>Gets or sets the theme used to paint the dashboard.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.DashboardWeb.DashboardTheme"/> enumeration member that specifies the theme used to paint the dashboard.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.ASPxDashboardViewer.DashboardXmlFile">
|
|
<summary>
|
|
<para>Gets or sets the path to an XML file that contains a dashboard.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:System.String"/> that specifies the path to an XML file that contains the dashboard.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.DashboardWeb.ASPxDashboardViewer.DataLoading">
|
|
<summary>
|
|
<para>Allows you to provide data for the <see cref="T:DevExpress.DashboardCommon.DashboardObjectDataSource"/>.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.ASPxDashboardViewer.DBSchemaProviderEx">
|
|
<summary>
|
|
<para>Allows specifying a custom data store's schema.
|
|
</para>
|
|
</summary>
|
|
<value>An object that implements the <see cref="T:DevExpress.DataAccess.Sql.IDBSchemaProviderEx"/> interface representing the data store's schema.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.DashboardWeb.ASPxDashboardViewer.Dispose">
|
|
<summary>
|
|
<para>Enables a server control to perform final clean up before it is released from memory.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.ASPxDashboardViewer.ExcelExportOptions">
|
|
<summary>
|
|
<para>Provides access to options related to exporting a dashboard item to the Excel format.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.DashboardCommon.DashboardExcelExportOptions"/> object containing options related to exporting a dashboard item to the Excel format.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.ASPxDashboardViewer.ExportOptions">
|
|
<summary>
|
|
<para>Provides access to dashboard options specific to export.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.DashboardWeb.DashboardExportOptions"/> object that contains settings which specify parameters affecting how the dashboard (dashboard items) is exported.
|
|
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.DashboardWeb.ASPxDashboardViewer.FilterElementDefaultValues">
|
|
<summary>
|
|
<para>Provides the capability to apply default filtering to filter elements.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.ASPxDashboardViewer.FullscreenMode">
|
|
<summary>
|
|
<para>Gets or sets whether the ASPxDashboardViewer is in full-screen mode.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b>, if the ASPxDashboardViewer is in the full-screen mode; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.ASPxDashboardViewer.HandleServerErrors">
|
|
<summary>
|
|
<para>Gets or sets whether or not callback exceptions are handled on the server.
|
|
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b>, to handle callback exceptions on the server; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.ASPxDashboardViewer.Height">
|
|
<summary>
|
|
<para>Gets or sets the height of the ASPxDashboardViewer control.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:System.Web.UI.WebControls.Unit"/> that specifies the height of the ASPxDashboardViewer control.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.ASPxDashboardViewer.ImageExportOptions">
|
|
<summary>
|
|
<para>Provides access to options related to exporting a dashboard/dashboard item to an image.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.DashboardCommon.DashboardImageExportOptions"/> object containing options related to exporting a dashboard/dashboard item to an image.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.ASPxDashboardViewer.JSProperties">
|
|
<summary>
|
|
<para>Gets a collection of temporary client properties and their values.
|
|
|
|
</para>
|
|
</summary>
|
|
<value>A System.Collections.Generic.Dictionary object that represents the collection of properties and their values.
|
|
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.DashboardWeb.ASPxDashboardViewer.MasterFilterDefaultValues">
|
|
<summary>
|
|
<para>Allows you to apply default filtering to master filter items.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.ASPxDashboardViewer.PdfExportOptions">
|
|
<summary>
|
|
<para>Provides access to options related to exporting a dashboard/dashboard item to the PDF format.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.DashboardCommon.DashboardPdfExportOptions"/> object containing options related to exporting a dashboard/dashboard item to the PDF format.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.DashboardWeb.ASPxDashboardViewer.RangeFilterDefaultValue">
|
|
<summary>
|
|
<para>Provides the capability to specify the default selected range in the Range Filter dashboard item.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.ASPxDashboardViewer.RedrawOnResize">
|
|
<summary>
|
|
<para>Gets or sets a value indicating whether the ASPxDashboardViewer redraws itself when the browser window is resized.
|
|
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b>, if the ASPxDashboardViewer redraws itself when the browser window is resized; otherwise, <b>false</b>.
|
|
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.ASPxDashboardViewer.RegisterJQuery">
|
|
<summary>
|
|
<para>Gets or sets whether the ASPxDashboardViewer should automatically add the jQuery library to the web application and register it on the current page.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b>, to add the jQuery library to the web application and register it on the current page; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.DashboardWeb.ASPxDashboardViewer.RegisterStyleSheets">
|
|
<summary>
|
|
<para>For internal use.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.ASPxDashboardViewer.SessionTimeout">
|
|
<summary>
|
|
<para>Gets or sets the session time-out (in seconds) specifying how long internal dashboard data are stored on the server.
|
|
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:System.Double"/> value that is the session time-out (in seconds) specifying how long internal dashboard data are stored on the server.
|
|
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.DashboardWeb.ASPxDashboardViewer.SingleFilterDefaultValue">
|
|
<summary>
|
|
<para>Allows you to specify a default filter value for the Single Master Filter.
|
|
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.ASPxDashboardViewer.Theme">
|
|
<summary>
|
|
<para>This member is not in effect for this class. It is overridden only for the purpose of preventing it from appearing in Microsoft Visual Studio designer tools.
|
|
|
|
|
|
</para>
|
|
</summary>
|
|
<value>
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.ASPxDashboardViewer.UseDataAccessApi">
|
|
<summary>
|
|
<para>Gets or sets whether to enable the capability to access the client and underlying data.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b>, to enable the capability to access the client and underlying data; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.DashboardWeb.ASPxDashboardViewer.ValidateCustomSqlQuery">
|
|
<summary>
|
|
<para>Provides the capability to check the validity of the custom SQL query used to supply the dashboard with data.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.ASPxDashboardViewer.Width">
|
|
<summary>
|
|
<para>Gets or sets the width of the ASPxDashboardViewer control.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:System.Web.UI.WebControls.Unit"/> that specifies the width of the ASPxDashboardViewer control.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.DashboardWeb.ConfigureDataConnectionWebEventArgs">
|
|
|
|
<summary>
|
|
<para>Provides data for the <b>ConfigureDataConnection</b> events.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.ConfigureDataConnectionWebEventArgs.DashboardId">
|
|
<summary>
|
|
<para>Gets the identifier of the current dashboard.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:System.String"/> that identifies the current dashboard.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.DashboardWeb.DocumentContentExportOptions">
|
|
|
|
<summary>
|
|
<para>Contains options specific to exporting additional content.
|
|
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.DashboardWeb.DocumentContentExportOptions.#ctor">
|
|
<summary>
|
|
<para>Initializes a new instance of the DocumentContentExportOptions class.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.DashboardWeb.DocumentContentExportOptions.Assign(DevExpress.DashboardWeb.OptionsBase)">
|
|
<summary>
|
|
<para>Copies settings of the specified object to the current object.
|
|
</para>
|
|
</summary>
|
|
<param name="options">
|
|
An <see cref="T:DevExpress.DashboardWeb.OptionsBase"/> descendant whose settings are copied to the current object.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.DocumentContentExportOptions.FilterState">
|
|
<summary>
|
|
<para>Gets or sets the filter state's location on the exported document.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.DashboardWeb.DashboardExportFilterState"/> object that specifies the filter state's location on the exported document.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.DocumentContentExportOptions.ShowTitle">
|
|
<summary>
|
|
<para>Gets or sets whether a dashboard title (or dashboard item's caption) is included as the exported document title.
|
|
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.Utils.DefaultBoolean"/> value that specifies whether a dashboard title (or dashboard item's caption) is included as the exported document title.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.DashboardWeb.CustomAssemblyLoadingWebEventArgs">
|
|
|
|
<summary>
|
|
<para>Provides data for the <b>CustomAssemblyLoading</b> events.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.DashboardWeb.CustomAssemblyLoadingWebEventArgs.#ctor(System.String,System.String,System.String,System.String,System.String,System.Boolean)">
|
|
<summary>
|
|
<para>Initializes a new instance of the CustomAssemblyLoadingWebEventArgs class.
|
|
</para>
|
|
</summary>
|
|
<param name="dashboardId">
|
|
A <see cref="T:System.String"/> that is the dashboard identifier.
|
|
|
|
</param>
|
|
<param name="dataSourceName">
|
|
A <see cref="T:System.String"/> that is the name of the Entity Framework data source.
|
|
|
|
</param>
|
|
<param name="dataSourceComponentName">
|
|
A <see cref="T:System.String"/> that is the component name of the Entity Framework data source.
|
|
|
|
</param>
|
|
<param name="contextName">
|
|
A <see cref="T:System.String"/> that is the name of the Entity Framework context.
|
|
|
|
</param>
|
|
<param name="assemblyPath">
|
|
A <see cref="T:System.String"/> that is the path to the external assembly containing the Entity Framework model.
|
|
|
|
</param>
|
|
<param name="allowLoading">
|
|
A <see cref="T:System.Boolean"/> value that specifies whether to allow loading a custom assembly.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.CustomAssemblyLoadingWebEventArgs.DashboardId">
|
|
<summary>
|
|
<para>Gets the dashboard identifier.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:System.String"/> that is the dashboard identifier.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.DashboardWeb.BeforeExportDocumentWebEventHandler">
|
|
|
|
<summary>
|
|
<para>References a method that will handle the <b>BeforeExportDocument</b> events.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.DashboardWeb.BeforeExportDocumentWebEventHandler.Invoke(System.Object,DevExpress.DashboardWeb.BeforeExportDocumentWebEventArgs)">
|
|
<summary>
|
|
<para>References a method that will handle the <b>BeforeExportDocument</b> events.
|
|
</para>
|
|
</summary>
|
|
<param name="sender">
|
|
The event source.
|
|
|
|
</param>
|
|
<param name="e">
|
|
The <see cref="T:DevExpress.DashboardWeb.BeforeExportDocumentWebEventArgs"/> object that contains event data.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.DashboardWeb.DashboardStorageBase">
|
|
|
|
<summary>
|
|
<para>Serves as the base class for classes that act as dashboard storage.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="T:DevExpress.DashboardWeb.ConfigureItemDataCalculationWebEventArgs">
|
|
|
|
<summary>
|
|
<para>Provides data for the <see cref="E:DevExpress.DashboardWeb.ASPxDashboard.ConfigureItemDataCalculation"/> and <see cref="E:DevExpress.DashboardWeb.DashboardConfigurator.ConfigureItemDataCalculation"/> events.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.DashboardWeb.ConfigureItemDataCalculationWebEventArgs.#ctor(System.String,System.String)">
|
|
<summary>
|
|
<para>Initializes a new instance of the ConfigureItemDataCalculationWebEventArgs class.
|
|
</para>
|
|
</summary>
|
|
<param name="dashboardId">
|
|
A System.String value that specifies a dashboard identifier.
|
|
|
|
</param>
|
|
<param name="ItemComponentName">
|
|
A System.String value that specifies a component name of the dashboard item.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.ConfigureItemDataCalculationWebEventArgs.CalculateAllTotals">
|
|
<summary>
|
|
<para>Gets or sets whether to calculate totals that are not displayed in the dashboard item.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b>, to calculate hidden totals; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.ConfigureItemDataCalculationWebEventArgs.DashboardId">
|
|
<summary>
|
|
<para>Gets a dashboard identifier.
|
|
</para>
|
|
</summary>
|
|
<value>A System.String that specifies the dashboard identifier.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.ConfigureItemDataCalculationWebEventArgs.ItemComponentName">
|
|
<summary>
|
|
<para>Gets the component name of the dashboard item.
|
|
</para>
|
|
</summary>
|
|
<value>A System.String that specifies the component name of the dashboard item.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.DashboardWeb.DashboardLoadedWebEventHandler">
|
|
|
|
<summary>
|
|
<para>References a method that will handle the <see cref="E:DevExpress.DashboardWeb.ASPxDashboardViewer.DashboardLoaded"/> event.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.DashboardWeb.DashboardLoadedWebEventHandler.Invoke(System.Object,DevExpress.DashboardWeb.DashboardLoadedWebEventArgs)">
|
|
<summary>
|
|
<para>References a method that will handle the <see cref="E:DevExpress.DashboardWeb.ASPxDashboardViewer.DashboardLoaded"/> event.
|
|
</para>
|
|
</summary>
|
|
<param name="sender">
|
|
The event source.
|
|
|
|
</param>
|
|
<param name="e">
|
|
A <see cref="T:DevExpress.DashboardWeb.DashboardLoadedWebEventArgs"/> object that contains event data.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.DashboardWeb.DashboardLoadedWebEventArgs">
|
|
|
|
<summary>
|
|
<para>Provides data for the <see cref="E:DevExpress.DashboardWeb.ASPxDashboardViewer.DashboardLoaded"/> event.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.DashboardWeb.DashboardLoadedWebEventArgs.#ctor(System.String,DevExpress.DashboardCommon.Dashboard)">
|
|
<summary>
|
|
<para>Initializes a new instance of the DashboardLoadedWebEventArgs class.
|
|
</para>
|
|
</summary>
|
|
<param name="dashboardId">
|
|
A <see cref="T:System.String"/> that specifies the dashboard identifier.
|
|
|
|
</param>
|
|
<param name="dashboard">
|
|
A <see cref="T:DevExpress.DashboardCommon.Dashboard"/> object that is the loaded dashboard.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.DashboardLoadedWebEventArgs.Dashboard">
|
|
<summary>
|
|
<para>Gets the loaded dashboard.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.DashboardCommon.Dashboard"/> object that is the loaded dashboard.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.DashboardLoadedWebEventArgs.DashboardId">
|
|
<summary>
|
|
<para>Gets the identifier of the loaded dashboard.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:System.String"/> that identifies a loaded dashboard.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.DashboardWeb.ConnectionErrorWebEventArgs">
|
|
|
|
<summary>
|
|
<para>Provides data for the <see cref="E:DevExpress.DashboardWeb.ASPxDashboard.ConnectionError"/> and <see cref="E:DevExpress.DashboardWeb.DashboardConfigurator.ConnectionError"/> events.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.DashboardWeb.ConnectionErrorWebEventArgs.#ctor(System.String,System.String,System.String,DevExpress.DataAccess.ConnectionParameters.DataConnectionParametersBase,System.Exception)">
|
|
<summary>
|
|
<para>Initializes a new instance of the ConnectionErrorWebEventArgs class.
|
|
</para>
|
|
</summary>
|
|
<param name="dashboardId">
|
|
A <see cref="T:System.String"/> that is the dashboard identifier.
|
|
|
|
</param>
|
|
<param name="dataSourceName">
|
|
A <see cref="T:System.String"/> that is the data source name.
|
|
|
|
</param>
|
|
<param name="connectionName">
|
|
A <see cref="T:System.String"/> that is the connection name.
|
|
|
|
</param>
|
|
<param name="connectionParameters">
|
|
A <see cref="T:DevExpress.DataAccess.ConnectionParameters.DataConnectionParametersBase"/> descendant containing connection parameters.
|
|
|
|
</param>
|
|
<param name="exception">
|
|
A <see cref="T:System.Exception"/> object that is the exception that caused the connection error.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.ConnectionErrorWebEventArgs.DashboardId">
|
|
<summary>
|
|
<para>Gets the dashboard identifier.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:System.String"/> that is the dashboard identifier.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.ConnectionErrorWebEventArgs.DataSourceName">
|
|
<summary>
|
|
<para>Gets the data source name.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:System.String"/> that is the data source name.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.DashboardWeb.ExcelDataSourceBeforeFillWebEventHandler">
|
|
|
|
<summary>
|
|
<para>References a method that will handle the <b>ExcelDataSourceBeforeFill</b> events.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.DashboardWeb.ExcelDataSourceBeforeFillWebEventHandler.Invoke(System.Object,DevExpress.DashboardWeb.ExcelDataSourceBeforeFillWebEventArgs)">
|
|
<summary>
|
|
<para>References a method that will handle the <b>ExcelDataSourceBeforeFill</b> events.
|
|
</para>
|
|
</summary>
|
|
<param name="sender">
|
|
The event source.
|
|
|
|
</param>
|
|
<param name="e">
|
|
The <see cref="T:DevExpress.DashboardWeb.ExcelDataSourceBeforeFillWebEventArgs"/> object that contains event data.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.DashboardWeb.ExcelDataSourceBeforeFillWebEventArgs">
|
|
|
|
<summary>
|
|
<para>Provides data for the <b>ExcelDataSourceBeforeFill</b> events.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.DashboardWeb.ExcelDataSourceBeforeFillWebEventArgs.#ctor(System.String,System.String,System.String,DevExpress.DataAccess.Excel.BeforeFillEventArgs)">
|
|
<summary>
|
|
<para>Initializes a new instance of the ExcelDataSourceBeforeFillWebEventArgs class.
|
|
</para>
|
|
</summary>
|
|
<param name="dashboardId">
|
|
A <see cref="T:System.String"/> value that is the dashboard identifier.
|
|
|
|
</param>
|
|
<param name="dataSourceComponentName">
|
|
A <see cref="T:System.String"/> value that is the component name of the Excel data source.
|
|
|
|
</param>
|
|
<param name="dataSourceName">
|
|
A <see cref="T:System.String"/> value that is the Excel data source name.
|
|
|
|
</param>
|
|
<param name="e">
|
|
A <see cref="T:DevExpress.DataAccess.Excel.BeforeFillEventArgs"/> object.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.ExcelDataSourceBeforeFillWebEventArgs.DashboardId">
|
|
<summary>
|
|
<para>Gets the identifier of the dashboard for which the event was raised.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:System.String"/> value that is the identifier of the dashboard for which the event was raised.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.ExcelDataSourceBeforeFillWebEventArgs.DataSourceComponentName">
|
|
<summary>
|
|
<para>Gets the component name of the Excel data source for which the event was raised.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:System.String"/> value that is the component name of the Excel data source for which the event was raised.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.ExcelDataSourceBeforeFillWebEventArgs.DataSourceName">
|
|
<summary>
|
|
<para>Gets the name of the Excel data source for which the event was raised.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:System.String"/> value that is the name of the Excel data source for which the event was raised.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.ExcelDataSourceBeforeFillWebEventArgs.FileName">
|
|
<summary>
|
|
<para>Gets or sets a path to the Microsoft Excel workbook or CSV file.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:System.String"/> that specifies the path to the Microsoft Excel workbook or CSV file.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.ExcelDataSourceBeforeFillWebEventArgs.SourceOptions">
|
|
<summary>
|
|
<para>Gets or sets options used to extract data from Microsoft Excel workbooks (XLS, XLSX or XLSM files) or CSV files.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.DataAccess.Excel.ExcelSourceOptionsBase"/> descendant containing options used to extract data from Microsoft Excel workbooks (XLS, XLSX or XLSM files) or CSV files.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.ExcelDataSourceBeforeFillWebEventArgs.Stream">
|
|
<summary>
|
|
<para>Gets or sets a stream that contains a Microsoft Excel workbook or CSV file.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:System.IO.Stream"/> object containing a Microsoft Excel workbook or CSV file.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.ExcelDataSourceBeforeFillWebEventArgs.StreamDocumentFormat">
|
|
<summary>
|
|
<para>Gets or sets the format of the document contained in the <see cref="P:DevExpress.DashboardWeb.ExcelDataSourceBeforeFillWebEventArgs.Stream"/>.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.DataAccess.Excel.ExcelDocumentFormat"/> enumeration value that specifies the format of the document contained in the <see cref="P:DevExpress.DashboardWeb.ExcelDataSourceBeforeFillWebEventArgs.Stream"/>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.DashboardWeb.DashboardItemExportOptions">
|
|
|
|
<summary>
|
|
<para>Contains settings that specify export parameters related to individual dashboard items.
|
|
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.DashboardWeb.DashboardItemExportOptions.#ctor(DevExpress.DashboardWeb.DocumentContentExportOptions)">
|
|
<summary>
|
|
<para>Initializes a new instance of the DashboardItemExportOptions class.
|
|
</para>
|
|
</summary>
|
|
<param name="options">
|
|
A <see cref="T:DevExpress.DashboardWeb.DocumentContentExportOptions"/> containing options specific to exporting additional content.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.DashboardWeb.DashboardItemExportOptions.Assign(DevExpress.DashboardWeb.OptionsBase)">
|
|
<summary>
|
|
<para>Copies settings of the specified object to the current object.
|
|
</para>
|
|
</summary>
|
|
<param name="options">
|
|
An <see cref="T:DevExpress.DashboardWeb.OptionsBase"/> descendant whose settings are copied to the current object.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.DashboardItemExportOptions.IncludeCaption">
|
|
<summary>
|
|
<para>Gets or sets whether a dashboard item caption(s) is included on the exported page.
|
|
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.Utils.DefaultBoolean"/> value that specifies whether a dashboard item caption(s) is included on the exported page.
|
|
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.DashboardWeb.BeforeExportDocumentWebEventArgs">
|
|
|
|
<summary>
|
|
<para>Provides data for the <b>BeforeExportDocument</b> events.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.BeforeExportDocumentWebEventArgs.DashboardId">
|
|
<summary>
|
|
<para>Gets the identifier of the current dashboard.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:System.String"/> that identifies the current dashboard.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.DashboardWeb.BeforeExportDocumentWebEventArgs.HideItem(System.String)">
|
|
<summary>
|
|
<para>Hides the dashboard item with the specified name in the exported dashboard.
|
|
</para>
|
|
</summary>
|
|
<param name="itemComponentName">
|
|
A <see cref="T:System.String"/> that specifies the component name of the dashboard item to hide.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.DashboardWeb.BeforeExportDocumentWebEventArgs.HideItem(System.Predicate`1)">
|
|
<summary>
|
|
<para>Hides the dashboard item matching the specified predicate in the exported dashboard.
|
|
</para>
|
|
</summary>
|
|
<param name="match">
|
|
A System.Predicate that specifies the condition used to determine whether to hide the dashboard item.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.DashboardWeb.DashboardBootstrapper">
|
|
|
|
<summary>
|
|
<para>Contains the <see cref="T:DevExpress.DashboardWeb.ASPxDashboard"/> control's static settings.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="F:DevExpress.DashboardWeb.DashboardBootstrapper.SessionState">
|
|
<summary>
|
|
<para>Specifies the session state for the <see cref="T:DevExpress.DashboardWeb.ASPxDashboard"/> control.
|
|
</para>
|
|
</summary>
|
|
<returns> </returns>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.DashboardWeb.ImageFormatExportOptions">
|
|
|
|
<summary>
|
|
<para>Contains settings that specify parameters affecting how the dashboard or dashboard item is exported in Image format.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.DashboardWeb.ImageFormatExportOptions.#ctor">
|
|
<summary>
|
|
<para>Initializes a new instance of the ImageFormatExportOptions class.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.DashboardWeb.ImageFormatExportOptions.Assign(DevExpress.DashboardWeb.OptionsBase)">
|
|
<summary>
|
|
<para>Copies settings of the specified object to the current object.
|
|
</para>
|
|
</summary>
|
|
<param name="options">
|
|
An <see cref="T:DevExpress.DashboardWeb.OptionsBase"/> descendant whose settings are copied to the current object.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.ImageFormatExportOptions.Format">
|
|
<summary>
|
|
<para>Gets or sets an image format in which the dashboard (dashboard item) is exported.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.DashboardWeb.DashboardExportImageFormat"/> enumeration member that specifies an image format in which the dashboard (dashboard item) is exported.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.ImageFormatExportOptions.Resolution">
|
|
<summary>
|
|
<para>Gets or sets the resolution (in dpi) used to export a dashboard (dashboard item) in Image format.
|
|
|
|
</para>
|
|
</summary>
|
|
<value>An integer value that specifies the resolution (in dpi) used to export a dashboard (dashboard item) in Image format.
|
|
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.DashboardWeb.OptionsBase">
|
|
|
|
<summary>
|
|
<para>Serves as the base class for classes containing specific export options.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.DashboardWeb.OptionsBase.Assign(DevExpress.DashboardWeb.OptionsBase)">
|
|
<summary>
|
|
<para>Copies settings of the specified object to the current object.
|
|
</para>
|
|
</summary>
|
|
<param name="options">
|
|
An <see cref="T:DevExpress.DashboardWeb.OptionsBase"/> descendant whose settings are copied to the current object.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.DashboardWeb.OptionsBase.ToString">
|
|
<summary>
|
|
<para>Returns the string that represents the current object.
|
|
</para>
|
|
</summary>
|
|
<returns>A <see cref="T:System.String"/> that represents the current object.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.DashboardWeb.RangeFilterExportOptions">
|
|
|
|
<summary>
|
|
<para>Contains settings that specify parameters affecting how the Range Filter dashboard item is exported.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.DashboardWeb.RangeFilterExportOptions.#ctor">
|
|
<summary>
|
|
<para>Initializes a new instance of the RangeFilterExportOptions class.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.DashboardWeb.RangeFilterExportOptions.Assign(DevExpress.DashboardWeb.OptionsBase)">
|
|
<summary>
|
|
<para>Copies settings of the specified object to the current object.
|
|
</para>
|
|
</summary>
|
|
<param name="options">
|
|
An <see cref="T:DevExpress.DashboardWeb.OptionsBase"/> descendant whose settings are copied to the current object.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.RangeFilterExportOptions.AutomaticPageLayout">
|
|
<summary>
|
|
<para>Gets or sets whether the page orientation used to export a Range Filter dashboard item is selected automatically.
|
|
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b>, to automatically select the page orientation used to export a Range Filter dashboard item; otherwise, <b>false</b>.
|
|
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.RangeFilterExportOptions.SizeMode">
|
|
<summary>
|
|
<para>Gets or sets the export size mode for the Range Filter dashboard item.
|
|
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.DashboardWeb.RangeFilterExportSizeMode"/> enumeration member that specifies the export size mode for the Range Filter dashboard item.
|
|
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.DashboardWeb.RangeFilterExportSizeMode">
|
|
|
|
<summary>
|
|
<para>Lists values used to specify how a range filter dashboard item should be resized when being exported.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="F:DevExpress.DashboardWeb.RangeFilterExportSizeMode.None">
|
|
<summary>
|
|
<para>A Range Filter dashboard item is exported in a size identical to that shown on the dashboard.
|
|
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.DashboardWeb.RangeFilterExportSizeMode.Stretch">
|
|
<summary>
|
|
<para>A Range Filter dashboard item is stretched or shrunk to fit the page to which it is exported.
|
|
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.DashboardWeb.RangeFilterExportSizeMode.Zoom">
|
|
<summary>
|
|
<para>A Range Filter dashboard item is resized proportionally to best fit the printed page.
|
|
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.DashboardWeb.MapExportSizeMode">
|
|
|
|
<summary>
|
|
<para>Lists values used to specify how a Map dashboard item should be resized when being exported.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="F:DevExpress.DashboardWeb.MapExportSizeMode.None">
|
|
<summary>
|
|
<para>A map dashboard item is exported in a size identical to that shown on the dashboard
|
|
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.DashboardWeb.MapExportSizeMode.Zoom">
|
|
<summary>
|
|
<para>A map dashboard item is resized proportionally to best fit the exported page.
|
|
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.DashboardWeb.MapExportOptions">
|
|
|
|
<summary>
|
|
<para>Contains settings that specify parameters affecting how Map dashboard items are exported.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.DashboardWeb.MapExportOptions.#ctor">
|
|
<summary>
|
|
<para>Initializes a new instance of the MapExportOptions class.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.DashboardWeb.MapExportOptions.Assign(DevExpress.DashboardWeb.OptionsBase)">
|
|
<summary>
|
|
<para>Copies settings of the specified object to the current object.
|
|
</para>
|
|
</summary>
|
|
<param name="options">
|
|
An <see cref="T:DevExpress.DashboardWeb.OptionsBase"/> descendant whose settings are copied to the current object.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.MapExportOptions.AutomaticPageLayout">
|
|
<summary>
|
|
<para>Gets or sets whether the page orientation used to export a map dashboard item is selected automatically.
|
|
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b>, to automatically select the page orientation used to export a map dashboard item; otherwise, <b>false</b>.
|
|
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.MapExportOptions.SizeMode">
|
|
<summary>
|
|
<para>Gets or sets the export size mode for the map dashboard item.
|
|
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.DashboardWeb.MapExportSizeMode"/> enumeration member that specifies the export size mode for the map dashboard item.
|
|
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.DashboardWeb.DashboardExportImageFormat">
|
|
|
|
<summary>
|
|
<para>Lists values that specify the image format used for exporting a dashboard/dashboard item.
|
|
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="F:DevExpress.DashboardWeb.DashboardExportImageFormat.Gif">
|
|
<summary>
|
|
<para>The GIF image format.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.DashboardWeb.DashboardExportImageFormat.Jpg">
|
|
<summary>
|
|
<para>The JPG image format.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.DashboardWeb.DashboardExportImageFormat.Png">
|
|
<summary>
|
|
<para>The PNG image format.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.DashboardWeb.CustomParametersWebEventHandler">
|
|
|
|
<summary>
|
|
<para>References a method that will handle the <b>CustomParameters</b> events.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.DashboardWeb.CustomParametersWebEventHandler.Invoke(System.Object,DevExpress.DashboardWeb.CustomParametersWebEventArgs)">
|
|
<summary>
|
|
<para>References a method that will handle the <b>CustomParameters</b> events.
|
|
</para>
|
|
</summary>
|
|
<param name="sender">
|
|
The event source.
|
|
|
|
</param>
|
|
<param name="e">
|
|
A <see cref="T:DevExpress.DashboardWeb.CustomParametersWebEventArgs"/> object that contains event data.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.DashboardWeb.CustomParametersWebEventArgs">
|
|
|
|
<summary>
|
|
<para>Provides data for the <b>CustomParameters</b> events.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.CustomParametersWebEventArgs.DashboardId">
|
|
<summary>
|
|
<para>Gets the identifier of the required dashboard.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:System.String"/> that identifies a dashboard.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.DashboardWeb.DashboardInfo">
|
|
|
|
<summary>
|
|
<para>Contains information used to identify a dashboard within the dashboard storage.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.DashboardWeb.DashboardInfo.#ctor">
|
|
<summary>
|
|
<para>Initializes a new instance of the DashboardInfo class.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.DashboardInfo.ID">
|
|
<summary>
|
|
<para>Gets or sets the dashboard identifier.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:System.String"/> that specifies the dashboard identifier.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.DashboardInfo.Name">
|
|
<summary>
|
|
<para>Gets or sets the dashboard name.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:System.String"/> that specifies the dashboard name.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.DashboardWeb.SetInitialDashboardStateEventHandler">
|
|
|
|
<summary>
|
|
<para>References a method that will handle the <see cref="E:DevExpress.DashboardWeb.ASPxDashboard.SetInitialDashboardState"/> event.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.DashboardWeb.SetInitialDashboardStateEventHandler.Invoke(System.Object,DevExpress.DashboardWeb.SetInitialDashboardStateEventArgs)">
|
|
<summary>
|
|
<para>References a method that will handle the <see cref="E:DevExpress.DashboardWeb.ASPxDashboard.SetInitialDashboardState"/> event.
|
|
</para>
|
|
</summary>
|
|
<param name="sender">
|
|
The event source.
|
|
|
|
</param>
|
|
<param name="e">
|
|
A <see cref="T:DevExpress.DashboardWeb.SetInitialDashboardStateEventArgs"/> object that contains event data.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.DashboardWeb.DashboardFileStorage">
|
|
|
|
<summary>
|
|
<para>A file storage used to hold dashboards.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.DashboardWeb.DashboardFileStorage.#ctor">
|
|
<summary>
|
|
<para>Initializes a new instance of the DashboardFileStorage class.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.DashboardWeb.DashboardFileStorage.#ctor(System.String)">
|
|
<summary>
|
|
<para>Initializes a new instance of the DashboardFileStorage class.
|
|
</para>
|
|
</summary>
|
|
<param name="workingDirectory">
|
|
A <see cref="T:System.String"/> that specifies the path to the directory used to store dashboards.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.DashboardFileStorage.WorkingDirectory">
|
|
<summary>
|
|
<para>Gets or sets the path to the directory used to store dashboards.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:System.String"/> that specifies the path to the directory used to store dashboards.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.DashboardWeb.DashboardClientSideEvents">
|
|
|
|
<summary>
|
|
<para>Contains a list of the client-side events available for the <see cref="T:DevExpress.DashboardWeb.ASPxDashboardViewer"/> control.
|
|
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.DashboardWeb.DashboardClientSideEvents.#ctor">
|
|
<summary>
|
|
<para>Initializes a new instance of the DashboardClientSideEvents class.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.DashboardClientSideEvents.ActionAvailabilityChanged">
|
|
<summary>
|
|
<para>Gets or sets the name of the JavaScript function or the entire code which will handle the client <see cref="E:DevExpress.DashboardWeb.Scripts.ASPxClientDashboardViewer.ActionAvailabilityChanged"/> event.
|
|
</para>
|
|
</summary>
|
|
<value>A string that is either the name of a JavaScript function or the entire JavaScript function code used to handle an event.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.DashboardClientSideEvents.DashboardTitleToolbarUpdated">
|
|
<summary>
|
|
<para> </para>
|
|
</summary>
|
|
<value> </value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.DashboardClientSideEvents.DataLoadingError">
|
|
<summary>
|
|
<para>Gets or sets the name of the JavaScript function or the entire code which will handle the client <see cref="E:DevExpress.DashboardWeb.Scripts.ASPxClientDashboardViewer.DataLoadingError"/> event.
|
|
</para>
|
|
</summary>
|
|
<value>A string that is either the name of a JavaScript function or the entire JavaScript function code used to handle an event.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.DashboardClientSideEvents.DrillDownPerformed">
|
|
<summary>
|
|
<para>Gets or sets the name of the JavaScript function or the entire code which will handle the client <see cref="E:DevExpress.DashboardWeb.Scripts.ASPxClientDashboardViewer.DrillDownPerformed"/> event.
|
|
</para>
|
|
</summary>
|
|
<value>A string that is either the name of a JavaScript function or the entire JavaScript function code used to handle an event.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.DashboardClientSideEvents.DrillUpPerformed">
|
|
<summary>
|
|
<para>Gets or sets the name of the JavaScript function or the entire code which will handle the client <see cref="E:DevExpress.DashboardWeb.Scripts.ASPxClientDashboardViewer.DrillUpPerformed"/> event.
|
|
</para>
|
|
</summary>
|
|
<value>A string that is either the name of a JavaScript function or the entire JavaScript function code used to handle an event.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.DashboardClientSideEvents.ItemBeforeWidgetDisposed">
|
|
<summary>
|
|
<para>Gets or sets the name of the JavaScript function or the entire code which will handle the client <see cref="E:DevExpress.DashboardWeb.Scripts.ASPxClientDashboardViewer.ItemBeforeWidgetDisposed"/> event.
|
|
</para>
|
|
</summary>
|
|
<value>A string that is either the name of a JavaScript function or the entire JavaScript function code used to handle an event.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.DashboardClientSideEvents.ItemCaptionToolbarUpdated">
|
|
<summary>
|
|
<para> </para>
|
|
</summary>
|
|
<value> </value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.DashboardClientSideEvents.ItemClick">
|
|
<summary>
|
|
<para>Gets or sets the name of the JavaScript function or the entire code which will handle the client <see cref="E:DevExpress.DashboardWeb.Scripts.ASPxClientDashboardViewer.ItemClick"/> event.
|
|
</para>
|
|
</summary>
|
|
<value>A string that is either the name of a JavaScript function or the entire JavaScript function code used to handle an event.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.DashboardClientSideEvents.ItemElementCustomColor">
|
|
<summary>
|
|
<para>Gets or sets the name of the JavaScript function or the entire code which will handle the client <see cref="E:DevExpress.DashboardWeb.Scripts.ASPxClientDashboardViewer.ItemElementCustomColor"/> event.
|
|
</para>
|
|
</summary>
|
|
<value>A string that is either the name of a JavaScript function or the entire JavaScript function code used to handle an event.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.DashboardClientSideEvents.ItemSelectionChanged">
|
|
<summary>
|
|
<para>Gets or sets the name of the JavaScript function or the entire code which will handle the client <see cref="E:DevExpress.DashboardWeb.Scripts.ASPxClientDashboardViewer.ItemSelectionChanged"/> event.
|
|
</para>
|
|
</summary>
|
|
<value>A string that is either the name of a JavaScript function or the entire JavaScript function code used to handle an event.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.DashboardClientSideEvents.ItemVisualInteractivity">
|
|
<summary>
|
|
<para>Gets or sets the name of the JavaScript function or the entire code which will handle the client <see cref="E:DevExpress.DashboardWeb.Scripts.ASPxClientDashboardViewer.ItemVisualInteractivity"/> event.
|
|
</para>
|
|
</summary>
|
|
<value>A string that is either the name of a JavaScript function or the entire JavaScript function code used to handle an event.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.DashboardClientSideEvents.ItemWidgetCreated">
|
|
<summary>
|
|
<para>Gets or sets the name of the JavaScript function or the entire code which will handle the client <see cref="E:DevExpress.DashboardWeb.Scripts.ASPxClientDashboardViewer.ItemWidgetCreated"/> event.
|
|
</para>
|
|
</summary>
|
|
<value>A string that is either the name of a JavaScript function or the entire JavaScript function code used to handle an event.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.DashboardClientSideEvents.ItemWidgetUpdated">
|
|
<summary>
|
|
<para>Gets or sets the name of the JavaScript function or the entire code which will handle the client <see cref="E:DevExpress.DashboardWeb.Scripts.ASPxClientDashboardViewer.ItemWidgetUpdated"/> event.
|
|
</para>
|
|
</summary>
|
|
<value>A string that is either the name of a JavaScript function or the entire JavaScript function code used to handle an event.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.DashboardClientSideEvents.ItemWidgetUpdating">
|
|
<summary>
|
|
<para>Gets or sets the name of the JavaScript function or the entire code which will handle the client <see cref="E:DevExpress.DashboardWeb.Scripts.ASPxClientDashboardViewer.ItemWidgetUpdating"/> event.
|
|
</para>
|
|
</summary>
|
|
<value>A string that is either the name of a JavaScript function or the entire JavaScript function code used to handle an event.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.DashboardClientSideEvents.Loaded">
|
|
<summary>
|
|
<para>Gets or sets the name of the JavaScript function or the entire code which will handle the client <see cref="E:DevExpress.DashboardWeb.Scripts.ASPxClientDashboardViewer.Loaded"/> event.
|
|
</para>
|
|
</summary>
|
|
<value>A string that is either the name of a JavaScript function or the entire JavaScript function code used to handle an event.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.DashboardClientSideEvents.MasterFilterCleared">
|
|
<summary>
|
|
<para>Gets or sets the name of the JavaScript function or the entire code which will handle the client <see cref="E:DevExpress.DashboardWeb.Scripts.ASPxClientDashboardViewer.MasterFilterCleared"/> event.
|
|
</para>
|
|
</summary>
|
|
<value>A string that is either the name of a JavaScript function or the entire JavaScript function code used to handle an event.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.DashboardClientSideEvents.MasterFilterSet">
|
|
<summary>
|
|
<para>Gets or sets the name of the JavaScript function or the entire code which will handle the client <see cref="E:DevExpress.DashboardWeb.Scripts.ASPxClientDashboardViewer.MasterFilterSet"/> event.
|
|
</para>
|
|
</summary>
|
|
<value>A string that is either the name of a JavaScript function or the entire JavaScript function code used to handle an event.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.DashboardWeb.ValidateDashboardCustomSqlQueryWebEventHandler">
|
|
|
|
<summary>
|
|
<para>References a method that will handle the <b>ValidateCustomSqlQuery</b> events.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.DashboardWeb.ValidateDashboardCustomSqlQueryWebEventHandler.Invoke(System.Object,DevExpress.DashboardWeb.ValidateDashboardCustomSqlQueryWebEventArgs)">
|
|
<summary>
|
|
<para>References a method that will handle the <b>ValidateCustomSqlQuery</b> events.
|
|
</para>
|
|
</summary>
|
|
<param name="sender">
|
|
The event source.
|
|
|
|
</param>
|
|
<param name="e">
|
|
A <see cref="T:DevExpress.DashboardWeb.ValidateDashboardCustomSqlQueryWebEventArgs"/> object that contains event data.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.DashboardWeb.ValidateDashboardCustomSqlQueryWebEventArgs">
|
|
|
|
<summary>
|
|
<para>Provides data for the <b>ValidateDashboardCustomSqlQuery</b> events.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.DashboardWeb.ValidateDashboardCustomSqlQueryWebEventArgs.#ctor(DevExpress.DashboardCommon.ValidateDashboardCustomSqlQueryEventArgs)">
|
|
<summary>
|
|
<para>Initializes a new instance of the ValidateDashboardCustomSqlQueryWebEventArgs class.
|
|
</para>
|
|
</summary>
|
|
<param name="innerArgs">
|
|
A <see cref="T:DevExpress.DashboardCommon.ValidateDashboardCustomSqlQueryEventArgs"/> object.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.ValidateDashboardCustomSqlQueryWebEventArgs.CustomSqlQuery">
|
|
<summary>
|
|
<para>Gets the custom SQL query that should be checked.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.DataAccess.Sql.CustomSqlQuery"/> object that specifies the custom SQL query.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.ValidateDashboardCustomSqlQueryWebEventArgs.DashboardId">
|
|
<summary>
|
|
<para>Gets the identifier of the current dashboard.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:System.String"/> that identifies the current dashboard.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.ValidateDashboardCustomSqlQueryWebEventArgs.DataSourceComponentName">
|
|
<summary>
|
|
<para>Gets or sets the component name of the data source for which the event was raised.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:System.String"/> value that specifies the component name of the data source for which the event was raised.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.ValidateDashboardCustomSqlQueryWebEventArgs.DataSourceName">
|
|
<summary>
|
|
<para>Gets or sets the name of the data source for which the event was raised.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:System.String"/> value that specifies the name of the data source for which the event was raised.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.ValidateDashboardCustomSqlQueryWebEventArgs.ExceptionMessage">
|
|
<summary>
|
|
<para>Gets or sets the exception message returned after custom SQL query validation.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:System.String"/> value that specifies the exception message returned after custom SQL query validation.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.ValidateDashboardCustomSqlQueryWebEventArgs.Valid">
|
|
<summary>
|
|
<para>Gets or sets whether the current custom SQL query is valid.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b>, if the current custom SQL query is valid; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.DashboardWeb.CustomAssemblyLoadingWebEventHandler">
|
|
|
|
<summary>
|
|
<para>References a method that will handle the <b>CustomAssemblyLoading</b> events.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.DashboardWeb.CustomAssemblyLoadingWebEventHandler.Invoke(System.Object,DevExpress.DashboardWeb.CustomAssemblyLoadingWebEventArgs)">
|
|
<summary>
|
|
<para>References a method that will handle the <b>CustomAssemblyLoading</b> events.
|
|
</para>
|
|
</summary>
|
|
<param name="sender">
|
|
The event source.
|
|
|
|
</param>
|
|
<param name="customAssemblyLoading">
|
|
A <see cref="T:DevExpress.DashboardWeb.CustomAssemblyLoadingWebEventArgs"/> object that contains event data.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.DashboardWeb.CustomizeExportDocumentWebEventArgs">
|
|
|
|
<summary>
|
|
<para>Provides data for the <b>CustomizeExportDocument</b> events.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.CustomizeExportDocumentWebEventArgs.ExcelExportOptions">
|
|
<summary>
|
|
<para>Gets options related to exporting a dashboard/dashboard item to the Excel format.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.DashboardCommon.DashboardExcelExportOptions"/> object containing options related to exporting a dashboard/dashboard item to the Excel format.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.CustomizeExportDocumentWebEventArgs.ExcelOptions">
|
|
<summary>
|
|
<para>Gets options related to exporting a dashboard item to the Excel format.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.DashboardCommon.ExcelExportOptions"/> object containing options related to exporting a dashboard item to the Excel format.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.CustomizeExportDocumentWebEventArgs.Stream">
|
|
<summary>
|
|
<para>Gets or sets a stream containing the exported document.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:System.IO.Stream"/> object that specifies a stream containing the exported document.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.DashboardWeb.DashboardExportExcelFormat">
|
|
|
|
<summary>
|
|
<para>Lists values that specify Excel formats available for exporting individual dashboard items.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="F:DevExpress.DashboardWeb.DashboardExportExcelFormat.Csv">
|
|
<summary>
|
|
<para>A comma-separated values (CSV) file format.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.DashboardWeb.DashboardExportExcelFormat.Xls">
|
|
<summary>
|
|
<para>The Excel 97 - Excel 2003 (XLS) file format.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.DashboardWeb.DashboardExportExcelFormat.Xlsx">
|
|
<summary>
|
|
<para>The Office Excel 2007 XML-based (XLSX) file format.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.DashboardWeb.ExcelFormatExportOptions">
|
|
|
|
<summary>
|
|
<para>Contains options which define how the dashboard item is exported to Excel format.
|
|
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.DashboardWeb.ExcelFormatExportOptions.#ctor">
|
|
<summary>
|
|
<para>Initializes a new instance of the ExcelFormatExportOptions class.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.DashboardWeb.ExcelFormatExportOptions.Assign(DevExpress.DashboardWeb.OptionsBase)">
|
|
<summary>
|
|
<para>Copies settings of the specified object to the current object.
|
|
</para>
|
|
</summary>
|
|
<param name="options">
|
|
An <see cref="T:DevExpress.DashboardWeb.OptionsBase"/> descendant whose settings are copied to the current object.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.ExcelFormatExportOptions.CsvValueSeparator">
|
|
<summary>
|
|
<para>Gets or sets a character used to separate values in a CSV document.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:System.String"/> value that specifies the character used to separate values in a CSV document.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.ExcelFormatExportOptions.FilterState">
|
|
<summary>
|
|
<para>Gets or sets the filter state's location on the exported document.
|
|
</para>
|
|
</summary>
|
|
<value>A string value returned by the <see cref="T:DevExpress.DashboardCommon.ExcelExportFilterState"/> class that specifies the filter state's location on the exported document.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.ExcelFormatExportOptions.Format">
|
|
<summary>
|
|
<para>Gets or sets the Excel format in which the dashboard item is exported.
|
|
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="DashboardExportExcelFormat"/> enumeration member that specifies the Excel format in which the dashboard item is exported.
|
|
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.DashboardWeb.MasterFilterDefaultValuesWebEventHandler">
|
|
|
|
<summary>
|
|
<para>References a method that will handle the <see cref="E:DevExpress.DashboardWeb.ASPxDashboardViewer.MasterFilterDefaultValues"/> event.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.DashboardWeb.MasterFilterDefaultValuesWebEventHandler.Invoke(System.Object,DevExpress.DashboardWeb.MasterFilterDefaultValuesWebEventArgs)">
|
|
<summary>
|
|
<para>References a method that will handle the <see cref="E:DevExpress.DashboardWeb.ASPxDashboardViewer.MasterFilterDefaultValues"/> event.
|
|
</para>
|
|
</summary>
|
|
<param name="sender">
|
|
The event source.
|
|
|
|
</param>
|
|
<param name="e">
|
|
A <see cref="T:DevExpress.DashboardWeb.MasterFilterDefaultValuesWebEventArgs"/> object that contains event data.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.DashboardWeb.MasterFilterDefaultValuesWebEventArgs">
|
|
|
|
<summary>
|
|
<para>Provides data for the <see cref="E:DevExpress.DashboardWeb.ASPxDashboardViewer.MasterFilterDefaultValues"/> event.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.DashboardWeb.MasterFilterDefaultValuesWebEventArgs.#ctor(System.String,DevExpress.DashboardCommon.MasterFilterDefaultValuesEventArgs)">
|
|
<summary>
|
|
<para>Initializes a new instance of the MasterFilterDefaultValuesWebEventArgs class.
|
|
</para>
|
|
</summary>
|
|
<param name="dashboardId">
|
|
A <see cref="T:System.String"/> value that specifies the dashboard identifier.
|
|
|
|
</param>
|
|
<param name="innerArgs">
|
|
A <see cref="T:DevExpress.DashboardCommon.MasterFilterDefaultValuesEventArgs"/> object.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.MasterFilterDefaultValuesWebEventArgs.AvailableFilterValues">
|
|
<summary>
|
|
<para>Gets the list of values that can be used to apply filtering.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.DashboardCommon.DashboardDataSet"/> object that is the list of values available for filtering.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.MasterFilterDefaultValuesWebEventArgs.DashboardId">
|
|
<summary>
|
|
<para>Gets the dashboard identifier.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:System.String"/> value that is the dashboard identifier.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.MasterFilterDefaultValuesWebEventArgs.FilterValues">
|
|
<summary>
|
|
<para>Gets or sets values used to apply default filtering.
|
|
</para>
|
|
</summary>
|
|
<value>A collection of <see cref="T:DevExpress.DashboardCommon.DashboardDataRow"/> objects that specify filter values.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.DashboardWeb.MasterFilterDefaultValuesWebEventArgs.GetFilterValues">
|
|
<summary>
|
|
<para>Gets the collection of values that can be used to apply default filtering.
|
|
</para>
|
|
</summary>
|
|
<returns>A collection of values that can be used to apply default filtering.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.MasterFilterDefaultValuesWebEventArgs.ItemComponentName">
|
|
<summary>
|
|
<para>Gets the component name of the dashboard item.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:System.String"/> value that is the component name of the dashboard item.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.MasterFilterDefaultValuesWebEventArgs.ItemName">
|
|
<summary>
|
|
<para>Gets the dashboard item name.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:System.String"/> value that is the dashboard item name.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.DashboardWeb.MasterFilterDefaultValuesWebEventArgs.SetFilterValues(System.Collections.Generic.IEnumerable`1)">
|
|
<summary>
|
|
<para>Specifies values used to apply default filtering.
|
|
</para>
|
|
</summary>
|
|
<param name="values">
|
|
A collection of values that can be used to apply default filtering.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.DashboardWeb.Padding">
|
|
|
|
<summary>
|
|
<para>Contains properties used to set paddings of the Web Dashboard elements.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.DashboardWeb.Padding.#ctor(System.Int32)">
|
|
<summary>
|
|
<para>Initializes a new instance of the Padding class.
|
|
</para>
|
|
</summary>
|
|
<param name="all">
|
|
An integer value that specifies all four paddings of the Web Dashboard element.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.DashboardWeb.Padding.#ctor(System.Int32,System.Int32,System.Int32,System.Int32)">
|
|
<summary>
|
|
<para>Initializes a new instance of the Padding class.
|
|
</para>
|
|
</summary>
|
|
<param name="left">
|
|
An integer value that specifies the left padding of the Web Dashboard element.
|
|
|
|
</param>
|
|
<param name="right">
|
|
An integer value that specifies the right padding of the Web Dashboard element.
|
|
|
|
</param>
|
|
<param name="top">
|
|
An integer value that specifies the top padding of the Web Dashboard element.
|
|
|
|
</param>
|
|
<param name="bottom">
|
|
An integer value that specifies the bottom padding of the Web Dashboard element.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.Padding.Bottom">
|
|
<summary>
|
|
<para>Gets or sets the bottom padding (space) of the Web Dashboard element.
|
|
</para>
|
|
</summary>
|
|
<value>An integer value that specifies the bottom padding of the Web Dashboard element.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.Padding.Left">
|
|
<summary>
|
|
<para>Gets or sets the left padding (space) of the Web Dashboard element.
|
|
</para>
|
|
</summary>
|
|
<value>An integer value that specifies the left padding of the Web Dashboard element.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.Padding.Right">
|
|
<summary>
|
|
<para>Gets or sets the right padding (space) of the Web Dashboard element.
|
|
</para>
|
|
</summary>
|
|
<value>An integer value that specifies the right padding of the Web Dashboard element.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.Padding.Top">
|
|
<summary>
|
|
<para>Gets or sets the top padding (space) of the Web Dashboard element.
|
|
</para>
|
|
</summary>
|
|
<value>An integer value that specifies the top padding of the Web Dashboard element.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.DashboardWeb.RequestDashboardIDsWebEventArgs">
|
|
|
|
<summary>
|
|
<para>Provides data for the <see cref="E:DevExpress.DashboardWeb.ASPxDashboard.RequestDashboardIDs"/> event.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.DashboardWeb.RequestDashboardIDsWebEventArgs.#ctor(System.Collections.Generic.List`1)">
|
|
<summary>
|
|
<para>Initializes a new instance of the RequestDashboardIDsWebEventArgs class.
|
|
</para>
|
|
</summary>
|
|
<param name="dashboardIDs">
|
|
A collection of <see cref="T:DevExpress.DashboardWeb.DashboardInfo"/> objects containing information used to identify dashboards.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.DashboardWeb.RequestDashboardIDsWebEventArgs.DashboardIDs">
|
|
<summary>
|
|
<para>Gets or sets a collection of <see cref="T:DevExpress.DashboardWeb.DashboardInfo"/> objects containing information used to identify dashboards.
|
|
</para>
|
|
</summary>
|
|
<value>A collection of <see cref="T:DevExpress.DashboardWeb.DashboardInfo"/> objects containing information used to identify dashboards.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
</members>
|
|
</doc>
|