IColorSchemeStorage Interface

If implemented, enables you to create a custom color scheme storage in WinForms and WPF applications.

Namespace: DevExpress.XtraReports.Wizards.ColorSchemes

Assembly: DevExpress.XtraReports.v18.2.dll

Declaration

C#

public interface IColorSchemeStorage

VB.NET

Public Interface IColorSchemeStorage

Remarks

Tip

Online Example:

• How to customize the Choose a Report Color Scheme wizard page in WinForms
• How to customize the Choose a Report Color Scheme wizard page in WPF

This code sample demonstrates how to create a custom color scheme storage and add new color schemes to it.

C#

using System.Collections.Generic;
using System.ComponentModel.Design;
using System.Linq;
using DevExpress.XtraReports.Wizards;
using DevExpress.XtraReports.Wizards.ColorSchemes;
//...
class CustomColorSchemeStorage : IColorSchemeStorage {

    readonly List<ColorScheme> colorSchemes = new List<ColorScheme>();

    public CustomColorSchemeStorage() {
        //Add custom color schemes to the storage.
        AddColorScheme(new ColorScheme("Independence", System.Drawing.Color.FromArgb(80, 75, 102)));
        AddColorScheme(new ColorScheme("Cerulean",
            System.Drawing.Color.FromArgb(0, 109, 167),
            System.Drawing.Color.FromArgb(0, 48, 65),
            System.Drawing.Color.FromArgb(0, 151, 167),
            System.Drawing.Color.FromArgb(205, 232, 242),
            System.Drawing.Color.FromArgb(255, 243, 245, 248),
            System.Drawing.Color.FromArgb(255, 109, 117, 129),
            System.Drawing.Color.FromArgb(255, 182, 186, 192)));
    }

    public bool AddColorScheme(ColorScheme colorScheme) {
        if(colorSchemes.Where(x => x.Name == colorScheme.Name).Any())
            return false;
        colorSchemes.Add(colorScheme);
        return true;
    }

    public bool RemoveColorScheme(string colorSchemeName) {
        ColorScheme colorScheme = colorSchemes.Where(x => x.Name == colorSchemeName).First();
        if(colorScheme != null) {
            colorSchemes.Remove(colorScheme);
            return true;
        }
        return false;
    }

    IEnumerable<ColorScheme> IColorSchemeStorage.GetColorSchemes() {
        return colorSchemes;
    }
}
//...

VB.NET

Imports System.Collections.Generic
Imports System.ComponentModel.Design
Imports System.Linq
Imports DevExpress.XtraReports.Wizards
Imports DevExpress.XtraReports.Wizards.ColorSchemes
'...
Friend Class CustomColorSchemeStorage
    Implements IColorSchemeStorage

    Private ReadOnly colorSchemes As New List(Of ColorScheme)()

  Public Sub New()
        'Add custom color schemes to the storage.
        AddColorScheme(New ColorScheme("Independence", System.Drawing.Color.FromArgb(80, 75, 102)))
        AddColorScheme(New ColorScheme("Cerulean", 
      System.Drawing.Color.FromArgb(0, 109, 167), 
      System.Drawing.Color.FromArgb(0, 48, 65), 
      System.Drawing.Color.FromArgb(0, 151, 167), 
      System.Drawing.Color.FromArgb(205, 232, 242), System.Drawing.Color.FromArgb(255, 243, 245, 248), System.Drawing.Color.FromArgb(255, 109, 117, 129), System.Drawing.Color.FromArgb(255, 182, 186, 192)))
    End Sub

  Public Function AddColorScheme(ByVal colorScheme As ColorScheme) As Boolean
        If colorSchemes.Where(Function(x) x.Name = colorScheme.Name).Any() Then
            Return False
        End If
        colorSchemes.Add(colorScheme)
        Return True
    End Function

  Public Function RemoveColorScheme(ByVal colorSchemeName As String) As Boolean
        Dim colorScheme As ColorScheme = colorSchemes.Where(Function(x) x.Name = colorSchemeName).First()
        If colorScheme IsNot Nothing Then
            colorSchemes.Remove(colorScheme)
            Return True
        End If
        Return False
    End Function

  Private Function IColorSchemeStorage_GetColorSchemes() As IEnumerable(Of ColorScheme) Implements IColorSchemeStorage.GetColorSchemes
        Return colorSchemes
    End Function
End Class
'...

Implement the IWizardCustomizationService interface to register the created custom color scheme storage. Use one of the following code samples depending on the target platform:

• WinForms

  C#

  using System.Collections.Generic;
  using System.ComponentModel.Design;
  using System.Linq;
  using DevExpress.DataAccess.UI.Wizard;
  using DevExpress.DataAccess.Wizard.Model;
  using DevExpress.XtraReports.Wizards;
  using DevExpress.XtraReports.Wizards.ColorSchemes;
  //...
  
  class WizardCustomizationService : IWizardCustomizationService {   
      // Implement other methods here.
      // ...
      // Register the custom color scheme storage.
      void IWizardCustomizationService.CustomizeReportWizard(IWizardCustomization<XtraReportModel> tool) {
          tool.RegisterType<IColorSchemeStorage, CustomColorSchemeStorage>();
      }
  }
  //...
  

  VB.NET

  Imports System.Collections.Generic
  Imports System.ComponentModel.Design
  Imports System.Linq
  Imports DevExpress.DataAccess.UI.Wizard
  Imports DevExpress.DataAccess.Wizard.Model
  Imports DevExpress.XtraReports.Wizards
  Imports DevExpress.XtraReports.Wizards.ColorSchemes
  '...
  
  Friend Class WizardCustomizationService
    Implements IWizardCustomizationService
  
    ' Implement other methods here.
    ' ...
    ' Register the custom color scheme storage.
    Private Sub IWizardCustomizationService_CustomizeReportWizard(ByVal tool As IWizardCustomization(Of XtraReportModel)) Implements IWizardCustomizationService.CustomizeReportWizard
      tool.RegisterType(Of IColorSchemeStorage, CustomColorSchemeStorage)()
    End Sub
  End Class
  '...
  

• WPF

  C#

  using System.Collections.Generic;
  using System.Linq;
  using DevExpress.DataAccess.Wizard.Model;
  using DevExpress.Xpf.DataAccess.DataSourceWizard;
  using DevExpress.Xpf.Reports.UserDesigner.ReportWizard;
  using DevExpress.XtraReports.UI;
  using DevExpress.XtraReports.Wizards;
  using DevExpress.XtraReports.Wizards.ColorSchemes;
  //...
  
  public class WizardCustomization : IWizardCustomizationService {   
      // Implement other methods here.
      // ...
      // Register the custom color scheme storage.
      void IWizardCustomizationService.CustomizeReportWizard(ReportWizardCustomizationModel customization, ViewModelSourceIntegrityContainer container) {
          container.RegisterType<IColorSchemeStorage, CustomColorSchemeStorage>();
      }
  }
  //...
  

  VB.NET

  Imports System.Collections.Generic
  Imports System.Linq
  Imports DevExpress.DataAccess.Wizard.Model
  Imports DevExpress.Xpf.DataAccess.DataSourceWizard
  Imports DevExpress.Xpf.Reports.UserDesigner.ReportWizard
  Imports DevExpress.XtraReports.UI
  Imports DevExpress.XtraReports.Wizards
  Imports DevExpress.XtraReports.Wizards.ColorSchemes
  '...
  
  Public Class WizardCustomization
      Implements IWizardCustomizationService
  
      ' Implement other methods here.
      ' ...
      ' Register the custom color scheme storage.
      Private Sub IWizardCustomizationService_CustomizeReportWizard(ByVal customization As ReportWizardCustomizationModel, ByVal container As ViewModelSourceIntegrityContainer) Implements IWizardCustomizationService.CustomizeReportWizard
          container.RegisterType(Of IColorSchemeStorage, CustomColorSchemeStorage)()
      End Sub
  End Class
  '...
  

Apply the wizard customization logic to the End-User Report Designer.

• WinForms

  C#

  using System.Windows.Forms;
  using DevExpress.XtraReports.Wizards;
  //...
  public partial class Form1 : Form {
      public Form1() {
          //...
          reportDesigner1.AddService(typeof(IWizardCustomizationService), new WizardCustomizationService());
      }
  }
  //...
  

  VB.NET

  Imports System.Windows.Forms
  Imports DevExpress.XtraReports.Wizards
  '...
  Partial Public Class Form1
    Inherits Form
  
    Public Sub New()
        '...
        reportDesigner1.AddService(GetType(IWizardCustomizationService), New WizardCustomizationService())
    End Sub
  End Class
  '...
  

• WPF

  C#

  using DevExpress.Xpf.Reports.UserDesigner.ReportWizard;
  //...
  
  public partial class MainWindow : Window
  {
  //...
      private void Window_Loaded(object sender, RoutedEventArgs e) {
          reportDesigner.ServicesRegistry.Add(new TypeEntry() { ServiceType = typeof(IWizardCustomizationService), ConcreteType = typeof(WizardCustomization) });
      }
  }
  //...
  

  VB.NET

  Imports DevExpress.Xpf.Reports.UserDesigner.ReportWizard
  '...
  
  Partial Public Class MainWindow
      Inherits Window
  
  '...
      Private Sub Window_Loaded(ByVal sender As Object, ByVal e As RoutedEventArgs)
          reportDesigner.ServicesRegistry.Add(New TypeEntry() With {.ServiceType = GetType(IWizardCustomizationService), .ConcreteType = GetType(WizardCustomization)})
      End Sub
  End Class
  '...
  

  Alternatively, you can use the following XAML code.

  XAML

  <Window ...
          xmlns:dxrud="http://schemas.devexpress.com/winfx/2008/xaml/reports/userdesigner"
          xmlns:dxda="http://schemas.devexpress.com/winfx/2008/xaml/dataaccess">
  
      <dxrud:ReportDesigner>
          <dxrud:ReportDesigner.ServicesRegistry>
              <dxda:TypeEntry ServiceType="{x:Type dxrudw:IWizardCustomizationService}" 
                              ConcreteType="{x:Type local:WizardCustomization}" />
          </dxrud:ReportDesigner.ServicesRegistry>
      </dxrud:ReportDesigner>
  </Window>