DescriptionSet.SetProperties(String, String[]) Method

Sets the specified favorite properties for the specified report element.

Namespace : DevExpress.XtraReports.FavoriteProperties

Assembly : DevExpress.XtraReports.v25.2.dll

NuGet Package : DevExpress.Reporting.Core

Declaration

C#
VB.NET

csharp

public void SetProperties(
    string component,
    string[] properties
)

Public Sub SetProperties(
    component As String,
    properties As String()
)

Parameters

Name	Type	Description
component	String

A String that specifies the report element name.

| | properties | String[] |

An array of String objects that specify property names to add to 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 properties to display in the Properties panel’s favorite list. Create a DescriptionSet 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.

C#
VB.NET

csharp

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: