The requested page is not available for the requested platform. You are viewing the content for Default platform.

FavoritePropertyDirectoryExtension.SaveProperties(DescriptionSet) Method

Saves the specified favorite list to the storage.

Namespace: DevExpress.XtraReports.Extensions

Assembly: DevExpress.XtraReports.v18.2.dll

Declaration

public override void SaveProperties(
    DescriptionSet descriptions
)
Public Overrides Sub SaveProperties(
    descriptions As DescriptionSet
)

Parameters

Name Type Description
descriptions DescriptionSet

An object that specifies the favorite list.

Remarks

By default, the End-User Report Designer's favorite list includes element properties marked with the Favorite attribute. You can specify your own default set of favorite properties to display in the Properties panel using the SaveProperties method.

Create a DescriptionSet class instance and use its DescriptionSet.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);
    }
}

See the following topics for more information:

See Also