FavoritePropertyExtension.TryLoadProperties(out DescriptionSet) Method

Loads favorite properties from the storage.

Namespace: DevExpress.XtraReports.Extensions

Assembly: DevExpress.XtraReports.v24.1.dll

NuGet Package: DevExpress.Reporting.Core

Declaration

C#

public abstract bool TryLoadProperties(
    out DescriptionSet descriptions
)

VB.NET

Public MustOverride Function TryLoadProperties(
    ByRef descriptions As DescriptionSet
) As Boolean

Parameters

Name	Type	Description
descriptions	DescriptionSet	An object that specifies the favorite list.

Returns

Type	Description
Boolean	true, if favorite properties has been successfully restored; otherwise, false.

Remarks

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, these properties are stored in the %localappdata%\Developer Express Inc\XtraReports Suite\ComponentProperties.xml file.

You can implement your custom storage using the FavoritePropertyExtension class. Use the TryLoadProperties method to obtain the favorite list from the storage.

See the following topics for more information:

• WinForms: Use Favorite Properties in the End-User Report Designer
• WPF: Use Favorite Properties in the Report Designer