xtrareports-devexpress-dot-xtrareports-dot-favoriteproperties.md
Provides information about favorite properties for report elements.
Namespace : DevExpress.XtraReports.FavoriteProperties
Assembly : DevExpress.XtraReports.v25.2.dll
NuGet Package : DevExpress.Reporting.Core
public class DescriptionSet
Public Class DescriptionSet
The following members return DescriptionSet objects:
The End-User Report Designer’s Properties panel provides the Favorite view that allows end-users to display only their favorite or most frequently used properties. By default, the favorite list includes element properties marked with the Favorite attribute.
You can use the DescriptionSet class to specify your own default set of properties to display in the Properties panel’s favorite list.
Create this class instance and use its SetProperties method that accepts the report element name and an array of property names. Then, assign this instance to the storage extension class using the FavoritePropertyDirectoryExtension.SaveProperties method.
The following example illustrates how to define favorite properties for the Label control and the report itself. All other report elements will include the predefined favorite list.
using System.Windows.Forms;
using System.IO;
using DevExpress.XtraReports.Extensions;
using DevExpress.XtraReports.FavoriteProperties;
using DevExpress.XtraReports.UI;
static class Program {
static void Main() {
string path = Path.Combine(Application.StartupPath, "FavoriteProperties.xml");
FavoritePropertyDirectoryExtension extension = new FavoritePropertyDirectoryExtension(path);
DescriptionSet set;
if (!extension.TryLoadProperties(out set)) {
set = new DescriptionSet();
set.SetProperties(typeof(XRLabel).Name, new string[] { "BackColor", "ForeColor" });
set.SetProperties(typeof(XtraReport).Name, new string[] { "DataSource", "DataMember" });
extension.SaveProperties(set);
}
FavoritePropertyExtension.RegisterExtensionGlobal(extension);
}
}
Imports System.Windows.Forms
Imports System.IO
Imports DevExpress.XtraReports.Extensions
Imports DevExpress.XtraReports.FavoriteProperties
Imports DevExpress.XtraReports.UI
Module Program
Private Sub Main()
Dim path As String = Path.Combine(Application.StartupPath, "FavoriteProperties.xml")
Dim extension As FavoritePropertyDirectoryExtension = New FavoritePropertyDirectoryExtension(path)
Dim [set] As DescriptionSet
If Not extension.TryLoadProperties([set]) Then
[set] = New DescriptionSet()
[set].SetProperties(GetType(XRLabel).Name, New String() {"BackColor", "ForeColor"})
[set].SetProperties(GetType(XtraReport).Name, New String() {"DataSource", "DataMember"})
extension.SaveProperties([set])
End If
FavoritePropertyExtension.RegisterExtensionGlobal(extension)
End Sub
End Module
See the following topics for more information about using and customizing favorite properties:
Object DescriptionSet
See Also