518 lines
19 KiB
XML
518 lines
19 KiB
XML
<?xml version="1.0"?>
|
|
<doc>
|
|
<assembly>
|
|
<name>DevExpress.ExpressApp.Reports.v17.2</name>
|
|
</assembly>
|
|
<members>
|
|
<member name="T:DevExpress.ExpressApp.Reports.IModelNavigationItemsForReports">
|
|
|
|
<summary>
|
|
<para>Used to extend the Application Model's NavigationItems node with properties specific to the Reports Module functionality.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="P:DevExpress.ExpressApp.Reports.IModelNavigationItemsForReports.GenerateRelatedReportsGroup">
|
|
<summary>
|
|
<para>Specifies whether context navigation is enabled for the Reports module.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b>, to enable context navigation for the Reports module; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.ExpressApp.Reports.IModelNavigationItemsForReports.RelatedReportsGroupCaption">
|
|
<summary>
|
|
<para>Specifies the caption for the navigation items generated by the Reports module, when context navigation is enabled.
|
|
</para>
|
|
</summary>
|
|
<value>A string specifying the caption for the navigation items generated by the Reports module, when context navigation is enabled.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.ExpressApp.Reports.ReportFiltering">
|
|
|
|
<summary>
|
|
<para>Provides access to properties that are used to filter the Report data source.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.ExpressApp.Reports.ReportFiltering.#ctor(DevExpress.ExpressApp.Reports.XafReport)">
|
|
<summary>
|
|
<para>Creates an instance of the ReportFiltering class.
|
|
</para>
|
|
</summary>
|
|
<param name="report">
|
|
An XafReport object that is the report to be filtered using the parameters provided by the current instance.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.ExpressApp.Reports.ReportFiltering.Application">
|
|
<summary>
|
|
<para>For internal use only.
|
|
</para>
|
|
</summary>
|
|
<value>
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.ExpressApp.Reports.ReportFiltering.BeginInit">
|
|
<summary>
|
|
<para>For internal use only.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.ExpressApp.Reports.ReportFiltering.EndInit">
|
|
<summary>
|
|
<para>For internal use only.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.ExpressApp.Reports.ReportFiltering.Filter">
|
|
<summary>
|
|
<para>Specifies a criteria for filtering the report data source at the server level.
|
|
</para>
|
|
</summary>
|
|
<value>A string that is the criteria for filtering the current report's data source.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.ExpressApp.Reports.ReportFiltering.FilterDescription">
|
|
<summary>
|
|
<para>Gets or sets a textual description for the filter parameters used in the criteria specified by the Parameters Object.
|
|
</para>
|
|
</summary>
|
|
<value>A string that is the description of the filter parameters used in the criteria specified by the Parameters Object, whose type is set to the <see cref="P:DevExpress.ExpressApp.Reports.ReportFiltering.ParametersObjectType"/> property.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.ExpressApp.Reports.ReportFiltering.FilterForDesignPreview">
|
|
<summary>
|
|
<para>Specifies the criteria that is used to filter the report when it's previewed in the <b>Report Designer</b>.
|
|
</para>
|
|
</summary>
|
|
<value>A string that is the criteria for filtering the report when it's previewed in the <b>Report Designer</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.ExpressApp.Reports.ReportFiltering.ParametersObjectType">
|
|
<summary>
|
|
<para>Specifies the type of the object providing criteria, end-user parameters and sorting information for filtering the current report's data source.
|
|
</para>
|
|
</summary>
|
|
<value>The type of the object that provides criteria, sorting options and end-user parameters for filtering the current report's data source.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.ExpressApp.Reports.ReportFiltering.Report">
|
|
<summary>
|
|
<para>For internal use only.
|
|
</para>
|
|
</summary>
|
|
<value>
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.ExpressApp.Reports.ReportFiltering.SetApplication(DevExpress.ExpressApp.XafApplication)">
|
|
<summary>
|
|
<para>For internal use only.
|
|
</para>
|
|
</summary>
|
|
<param name="application">
|
|
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.ExpressApp.Reports.ReportFiltering.ShouldSerializeFilter">
|
|
<summary>
|
|
<para>For internal use only.
|
|
</para>
|
|
</summary>
|
|
<returns>
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.ExpressApp.Reports.ReportFiltering.ShouldSerializeFilterForDesignPreview">
|
|
<summary>
|
|
<para>For internal use only.
|
|
</para>
|
|
</summary>
|
|
<returns>
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.ExpressApp.Reports.ReportsModule">
|
|
|
|
<summary>
|
|
<para>The module contained in the <i>DevExpress.ExpressApp.Reports.v17.2.dll</i> assembly.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.ExpressApp.Reports.ReportsModule.#ctor">
|
|
<summary>
|
|
<para>Creates an instance of the ReportsModule class.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.ExpressApp.Reports.ReportsModule.ActivateReportController(DevExpress.ExpressApp.ViewController)">
|
|
<summary>
|
|
<para>Activates the ReportsController.
|
|
</para>
|
|
</summary>
|
|
<param name="controller">
|
|
A <b>ReportsController</b> instance to be activated.
|
|
|
|
</param>
|
|
<returns><b>true</b>, if the <b>ReportsController</b> has been successfully activated; otherwise, <b>false</b>.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.ExpressApp.Reports.ReportsModule.ActivateReportController(DevExpress.ExpressApp.ViewController,System.Type@)">
|
|
<summary>
|
|
<para>Activates the ReportsController.
|
|
</para>
|
|
</summary>
|
|
<param name="controller">
|
|
A <b>ReportsController</b> instance to be activated.
|
|
|
|
</param>
|
|
<param name="reportDataType">
|
|
The Report data type used by the <b>ReportsModule</b> in the current application.
|
|
|
|
</param>
|
|
<returns><b>true</b>, if the <b>ReportsController</b> has been successfully activated; otherwise, <b>false</b>.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.ExpressApp.Reports.ReportsModule.AddGeneratorUpdaters(DevExpress.ExpressApp.Model.Core.ModelNodesGeneratorUpdaters)">
|
|
<summary>
|
|
<para>Registers the <b>ReportsModule</b> Generator Updater.
|
|
</para>
|
|
</summary>
|
|
<param name="updaters">
|
|
A <b>ModelNodesGeneratorUpdaters</b> object providing access to the list of Generator Updaters.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.ExpressApp.Reports.ReportsModule.CustomizeTypesInfo(DevExpress.ExpressApp.DC.ITypesInfo)">
|
|
<summary>
|
|
<para>Customizes metadata on business classes specific to the ReportsModule before loading the metadata to the Application Model's <b>BOModel</b> node.
|
|
</para>
|
|
</summary>
|
|
<param name="typesInfo">
|
|
An <see cref="T:DevExpress.ExpressApp.DC.ITypesInfo"/> object which holds metadata information on business classes to be loaded to the Application Model.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.ExpressApp.Reports.ReportsModule.DefaultEnableInplaceReports">
|
|
<summary>
|
|
<para>Specifies the default value for the <see cref="P:DevExpress.ExpressApp.Reports.ReportsModule.EnableInplaceReports"/> property.
|
|
</para>
|
|
</summary>
|
|
<returns> </returns>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.ExpressApp.Reports.ReportsModule.DefaultReportDataCaption">
|
|
<summary>
|
|
<para>Specifies the display caption associated with the class specified by the <see cref="P:DevExpress.ExpressApp.Reports.ReportsModule.ReportDataType"/> property.
|
|
</para>
|
|
</summary>
|
|
<returns> </returns>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.ExpressApp.Reports.ReportsModule.DefaultReportDataImageName">
|
|
<summary>
|
|
<para>Specifies the name of the image associated with the class specified by the <see cref="P:DevExpress.ExpressApp.Reports.ReportsModule.ReportDataType"/> property.
|
|
</para>
|
|
</summary>
|
|
<returns> </returns>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.ExpressApp.Reports.ReportsModule.DefaultReportDataNavigationItemCaption">
|
|
<summary>
|
|
<para>Specifies the default caption for the navigation group created by the Reports module.
|
|
</para>
|
|
</summary>
|
|
<returns> </returns>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.ExpressApp.Reports.ReportsModule.EmptyReportNameErrorMessage">
|
|
<summary>
|
|
<para>For internal use.
|
|
</para>
|
|
</summary>
|
|
<returns> </returns>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.ExpressApp.Reports.ReportsModule.EnableInplaceReports">
|
|
<summary>
|
|
<para>Specifies whether inplace reports are enabled.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b>, to enable inplace reports; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.ExpressApp.Reports.ReportsModule.ExtendModelInterfaces(DevExpress.ExpressApp.Model.ModelInterfaceExtenders)">
|
|
<summary>
|
|
<para>Extends the Application Model with the <see cref="T:DevExpress.ExpressApp.Model.IModelClassReportsVisibility"/> and <see cref="T:DevExpress.ExpressApp.Reports.IModelNavigationItemsForReports"/> interfaces.
|
|
</para>
|
|
</summary>
|
|
<param name="extenders">
|
|
A <b>ModelInterfaceExtenders</b> object that is a collection of Application Model interface extenders.
|
|
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.ExpressApp.Reports.ReportsModule.FindReportsModule(DevExpress.ExpressApp.ModuleList)">
|
|
<summary>
|
|
<para>Searches for a ReportsModule instance in a particular module list.
|
|
</para>
|
|
</summary>
|
|
<param name="modules">
|
|
A <b>ModuleList</b> object, which is a collection of modules.
|
|
|
|
</param>
|
|
<returns>A <see cref="T:DevExpress.ExpressApp.Reports.ReportsModule"/> instance found in the <i>modules</i> module list.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.ExpressApp.Reports.ReportsModule.GetCurrentReportDataType(DevExpress.ExpressApp.ModuleList)">
|
|
<summary>
|
|
<para>Searches for a ReportsModule instance in a particular module list and returns the Report data type used by the found module.
|
|
</para>
|
|
</summary>
|
|
<param name="modules">
|
|
A <b>ModuleList</b> object, which is a collection of modules.
|
|
|
|
</param>
|
|
<returns>The Report data type used by the <b>ReportsModule</b> instance found in the <i>modules</i> module list.
|
|
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.ExpressApp.Reports.ReportsModule.GetIsVisibleInReports(DevExpress.ExpressApp.DC.ITypeInfo,System.Boolean@)">
|
|
<summary>
|
|
<para>Specifies whether a particular class is decorated with the <see cref="T:DevExpress.Persistent.Base.VisibleInReportsAttribute"/> or <see cref="T:DevExpress.Persistent.Base.DefaultClassOptionsAttribute"/>.
|
|
</para>
|
|
</summary>
|
|
<param name="classInfo">
|
|
An <see cref="T:DevExpress.ExpressApp.DC.ITypeInfo"/> object supplying metadata on a class to be checked.
|
|
|
|
</param>
|
|
<param name="isVisible">
|
|
<b>true</b>, if end-users can create reports on objects of the class specified by the <i>classInfo</i> parameter; otherwise, <b>false</b>.
|
|
|
|
</param>
|
|
<returns><b>true</b>, if the class specified by the <i>classInfo</i> parameter is decorated with the <b>VisibleInReportsAttribute</b> or <b>DefaultClassOptionsAttribute</b>; otherwise, <b>false</b>.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.ExpressApp.Reports.ReportsModule.GetModuleUpdaters(DevExpress.ExpressApp.IObjectSpace,System.Version)">
|
|
<summary>
|
|
<para>Returns the list of <see cref="T:DevExpress.ExpressApp.Updating.ModuleUpdater"/> updaters that handle database updates for the ReportsModule module.
|
|
</para>
|
|
</summary>
|
|
<param name="objectSpace">
|
|
An <see cref="T:DevExpress.ExpressApp.IObjectSpace"/> object which represents the Object Space used to update the database.
|
|
|
|
</param>
|
|
<param name="versionFromDB">
|
|
A <b>System.Version</b> object which represents the current database version.
|
|
|
|
</param>
|
|
<returns>An IEnumerable<<see cref="T:DevExpress.ExpressApp.Updating.ModuleUpdater"/>> list of updaters that handle database updates for the ReportsModule module.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.ExpressApp.Reports.ReportsModule.IsInplaceReportMemberName">
|
|
<summary>
|
|
<para>For internal use.
|
|
</para>
|
|
</summary>
|
|
<returns> </returns>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.ExpressApp.Reports.ReportsModule.ReportDataType">
|
|
<summary>
|
|
<para>Specifies the report data type used by the Reports module.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:System.Type"/> object specifying the report data type used by the Reports module.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.ExpressApp.Reports.ReportsModule.ReportStorageCreated">
|
|
<summary>
|
|
<para>For internal use.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.ExpressApp.Reports.ReportsModule.Setup(DevExpress.ExpressApp.XafApplication)">
|
|
<summary>
|
|
<para>Sets up the ReportsModule after it has been added to the <see cref="P:DevExpress.ExpressApp.XafApplication.Modules"/> collection.
|
|
</para>
|
|
</summary>
|
|
<param name="application">
|
|
An <see cref="T:DevExpress.ExpressApp.XafApplication"/> object that provides methods and properties to manage the current application. This parameter value is set for the <see cref="P:DevExpress.ExpressApp.ModuleBase.Application"/> property.
|
|
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.ExpressApp.Reports.ReportsModule.ShowAdditionalNavigation">
|
|
<summary>
|
|
<para>Specifies the default value for the <see cref="P:DevExpress.ExpressApp.Reports.IModelNavigationItemsForReports.GenerateRelatedReportsGroup"/> property.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b>, to enable context navigation for the Reports module, by default; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.ExpressApp.Reports.ReportsModule.XafReportStorageExtension">
|
|
<summary>
|
|
<para>Specifies a <b>ReportStorageExtension</b> instance used by the ReportsModule to persist reports via an end-user report designer.
|
|
</para>
|
|
</summary>
|
|
<value>An <b>XafReportStorageExtension</b> object used to persists reports via an end-user report designer.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.ExpressApp.Reports.ReportServiceController">
|
|
|
|
<summary>
|
|
<para>Provides basic functionality for the <see cref="T:DevExpress.ExpressApp.Reports.Web.WebReportServiceController"/> and <see cref="T:DevExpress.ExpressApp.Reports.Win.WinReportServiceController"/> Controllers.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.ExpressApp.Reports.ReportServiceController.ShowPreview(System.Type,System.Object)">
|
|
<summary>
|
|
<para>Invokes the Preview Report window.
|
|
</para>
|
|
</summary>
|
|
<param name="reportDataType">
|
|
A <see cref="T:System.Type"/> of the report to be displayed in the Preview Report window.
|
|
|
|
</param>
|
|
<param name="reportDataKey">
|
|
An object representing the key property value of the <b>ReportData</b> object to be displayed in the Preview Report window.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.ExpressApp.Reports.ReportServiceController.ShowPreview(DevExpress.Persistent.Base.General.IReportData,System.Boolean)">
|
|
<summary>
|
|
<para>Invokes the Preview Report window.
|
|
</para>
|
|
</summary>
|
|
<param name="reportData">
|
|
An <b>IReportData</b> object which is the report to be displayed in the Preview Report window.
|
|
|
|
</param>
|
|
<param name="reloadReportDataInNewObjectSpace">
|
|
<b>true</b>, to reload <i>reportData</i> into a new Object Space; otherwise, <b>false</b>.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.ExpressApp.Reports.ReportServiceController.ShowPreview(DevExpress.Persistent.Base.General.IReportData,DevExpress.Data.Filtering.CriteriaOperator,System.Boolean)">
|
|
<summary>
|
|
<para>Invokes the Preview Report window.
|
|
</para>
|
|
</summary>
|
|
<param name="reportData">
|
|
An <b>IReportData</b> object which is the report to be displayed in the Preview Report window.
|
|
|
|
</param>
|
|
<param name="criteria">
|
|
A <b>CriteriaOperator</b> object containing report parameter values.
|
|
|
|
</param>
|
|
<param name="reloadReportDataInNewObjectSpace">
|
|
<b>true</b>, to reload <i>reportData</i> into a new Object Space; otherwise, <b>false</b>.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.ExpressApp.Reports.ReportServiceController.ShowPreview(DevExpress.Persistent.Base.General.IReportData)">
|
|
<summary>
|
|
<para>Invokes the Preview Report window.
|
|
</para>
|
|
</summary>
|
|
<param name="reportData">
|
|
An <b>IReportData</b> object which is the report to be displayed in the Preview Report window.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.ExpressApp.Reports.ReportServiceController.ShowPreview(DevExpress.Persistent.Base.General.IReportData,DevExpress.Data.Filtering.CriteriaOperator)">
|
|
<summary>
|
|
<para>Invokes the Preview Report window.
|
|
</para>
|
|
</summary>
|
|
<param name="reportData">
|
|
An <b>IReportData</b> object which is the report to be displayed in the Preview Report window.
|
|
|
|
</param>
|
|
<param name="criteria">
|
|
A <b>CriteriaOperator</b> object containing report parameter values.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
</members>
|
|
</doc>
|