[Expand]General Information
[Expand]WinForms Controls
[Expand]ASP.NET Controls and MVC Extensions
[Expand]ASP.NET Bootstrap Controls
[Expand]ASP.NET Core Bootstrap Controls
[Expand]WPF Controls
[Expand]Xamarin Controls
[Expand]Windows 10 App Controls
[Expand]Office File API
[Collapse]Reporting
 [Expand]Product Information
 [Expand]Get Started with DevExpress Reporting
 [Expand]Create Popular Reports
 [Expand]Detailed Guide to DevExpress Reporting
 [Expand]Visual Studio Report Designer
 [Collapse]Create End-User Reporting Applications
   Cross-Platform Reporting
  [Collapse]WinForms Reporting
   [Expand]Print API
   [Expand]Print Preview
   [Collapse]End-User Report Designer
    [Expand]Quick Start
    [Expand]GUI
    [Collapse]API and Customization
      Quick Guide to Report Designer Customization
      Add Items to the Report Designer's Standard Toolbar
      Add Items to the Report Designer's Ribbon Toolbar
      Execute Commands in the End-User Report Designer
      Override Commands in the End-User Report Designer (Implement Custom Saving)
      Hide Commands from the End-User Report Designer
      Change the Dock Panel View in the End-User Report Designer
      Customize Dock Panels in the End-User Report Designer
      Remove Dock Panels from the End-User Report Designer
      Set the Input Focus of Dock Panels in the End-User Report Designer
      Refresh the Field List in the End-User Report Designer
      Provide Custom Icons to the Field List Items
      Provide Custom Names to the Field List Items
      Hide Properties from the End-User Report Designer
      Use Favorite Properties in the End-User Report Designer
      Customize the Property Grid in the End-User Report Designer
      Register Custom Report Parameter Types
      Implement a Custom Report Gallery Storage
      Add Controls to the End-User Report Designer's Toolbox
      Make a Custom Control Available Only for a Specific Report
      Rename Toolbox Items in the End-User Report Designer
      Invoke the Report Wizard
      Wizard Customization Overview
      Report Wizard Pages
      Data Source Wizard Pages
      Customize the Report Wizard's Pages
      Remove Data Providers from the Report Wizard
      Remove Data Source Types from the Report Wizard
      Invoke and Customize the Query Builder
   [Expand]Application Security
   [Expand]Application Appearance
    Application Deployment
   [Expand]Localization
    End-User Documentation
  [Expand]WPF Reporting
  [Expand]Web Reporting
  [Expand]WCF Report Service
  [Expand]Discontinued Platforms
   Localization
   Redistribution and Deployment
 [Expand]API Reference
[Expand]Report and Dashboard Server
[Expand]Dashboard
[Expand]eXpressApp Framework
[Expand]eXpress Persistent Objects
[Expand]CodeRush
[Expand]CodeRush Classic
[Expand]Cross-Platform Core Libraries
[Expand]Tools and Utilities
 End-User Documentation
View this topic on docs.devexpress.com (Learn more)

Use Favorite Properties in the End-User Report Designer

The Report Designer's Property Grid allows end users to see the most frequently used properties.

Expanded Overview

The Property Grid displays favorite properties in the Favorites tab.

The Favorites tab includes element properties marked with the Favorite attribute. These properties correspond to those that the element's smart tag contains. End users can click the Edit Favorite Property List... menu item to open the Favorite Properties Editor. This editor lists the current report's controls. Check/uncheck properties to modify these controls' favorite property list.

Expanded Provide Custom Storage for Favorite Properties

The favorite list is stored in the %localappdata%\Developer Express Inc\XtraReports Suite\ComponentProperties.xml file and is available in all the Report Designer instances.

You can specify any custom file to store favorite properties. Create a FavoritePropertyDirectoryExtension class instance and pass the full file path as a parameter. Use the FavoritePropertyExtension.RegisterExtensionGlobal method to register this instance.

The following code snippet allows you to store the favorite list in the directory with the application's executable file:

You can also provide custom storage, such as a database, cloud or any other location. Create a descendant from an abstract FavoritePropertyExtension class and implement its SaveProperties (see FavoritePropertyExtension.SaveProperties) and TryLoadProperties (see FavoritePropertyExtension.TryLoadProperties) methods.

Expanded Specify Your Own Favorite Properties

You can specify your own property set and display it in the Property Grid's Favorites tab. To do this, create a DescriptionSet (see DescriptionSet) class instance and use the SetProperties (see DescriptionSet.SetProperties) method. This method accepts the report element name and an array of property names. Then, use the FavoritePropertyDirectoryExtension.SaveProperties method to assign the created instance to the storage extension class.

The example below illustrates how to define favorite properties for the Label control and the report. All other report elements include the predefined favorite list.

The following image shows the result.

Expanded Customize Predefined Favorite Properties

Use the static FavoritePropertyExtension.GetFavoriteProperties method to get the predefined set of favorite properties for a specific report element type. You can customize the obtained array as required (delete and/or add new properties).

Create a DescriptionSet (see DescriptionSet) class instance and use the SetProperties (see DescriptionSet.SetProperties) method to specify your custom set of favorite properties. Use the FavoritePropertyDirectoryExtension.SaveProperties method to assign this class instance to the storage extension class.

The example below allows you to customize predefined favorites for a report, in particular, remove the FilterString (see XtraReportBase.FilterString) property and add the XtraReport.CalculatedFields property.

The following image illustrates the resulting favorite list:

Is this topic helpful?​​​​​​​