XtraReport.SaveComponents Event

Occurs when a report is saved to an REPX file and allows you to manually decide which components should be stored into a report definition file, and which aren’t.

Namespace: DevExpress.XtraReports.UI

Assembly: DevExpress.XtraReports.v19.1.dll

NuGet Packages: DevExpress.Reporting.Core, DevExpress.WindowsDesktop.Core

Declaration

C#

public event EventHandler<SaveComponentsEventArgs> SaveComponents

VB.NET

Public Event SaveComponents As EventHandler(Of SaveComponentsEventArgs)

Event Data

The SaveComponents event's data class is SaveComponentsEventArgs. The following properties provide information specific to this event:

Property	Description
Components	Provides access to the list of components that will be saved along with a report’s layout into a REPX file.

Remarks

Handle the SaveComponents event to customize the list of components to be saved along with a report to an REPX report definition file. To do this, use the SaveComponentsEventArgs.Components property. Adding a particular component to this list will force its serialization to an REPX file, while to prevent a particular component from being saved, you simply need to remove it from the Components list.

The SaveComponents event fires only when a report is saved to a report definition file (REPX) using the CodeDOM serialization (e.g., on calling the XtraReport.SaveLayout method). This is why, this event is not raised on saving a report in the End-User Report Designer where XML serialization is used by default.

For more information on handling events, see Events and Delegates in MSDN.

Example

This example demonstrates how to exclude a DataSet, along with its TableAdapter, when saving a report definition to an REPX file. To do this, it is necessary to handle the XtraReport.SaveComponents event, and customize its SaveComponentsEventArgs.Components collection.

Tip

Online Example: How to exclude a DataSet and a TableAdapter from a report layout when saving it

C#

using System;
using System.ComponentModel;
using System.Data;
using System.Windows.Forms;
using System.Collections;
using DevExpress.XtraReports.UI;
// ...

private void Form1_Load(object sender, EventArgs e) {
    XtraReport1 report = new XtraReport1();
    report.SaveComponents += new 
        EventHandler<SaveComponentsEventArgs>(report_SaveComponents);
    report.ShowDesignerDialog();
}

void report_SaveComponents(object sender, SaveComponentsEventArgs e) {
    int tableAdapterIdx = GetItemIndex(e.Components, typeof(Component));
    if (tableAdapterIdx >= 0)
        e.Components.RemoveAt(tableAdapterIdx);
    int dsIdx = GetItemIndex(e.Components, typeof(DataSet));
    if (dsIdx >= 0)
        e.Components.RemoveAt(dsIdx);
}

private static int GetItemIndex(IList components, Type targetType) {
    int idx = -1;
    for (int i = 0; i < components.Count; i++) {
        if (components[i].GetType().BaseType == targetType) {
            idx = i;
            break;
        } 
    }

    return idx;
}

VB.NET

Imports System
Imports System.ComponentModel
Imports System.Data
Imports System.Windows.Forms
Imports System.Collections
Imports DevExpress.XtraReports.UI
' ...

Private Sub Form1_Load(ByVal sender As Object, ByVal e As EventArgs) _
Handles MyBase.Load
    Dim report As New XtraReport1()
    AddHandler report.SaveComponents, AddressOf report_SaveComponents
    report.ShowDesignerDialog()
End Sub

Private Sub report_SaveComponents(ByVal sender As Object, _
ByVal e As SaveComponentsEventArgs)

    Dim tableAdapterIdx As Integer = GetItemIndex(e.Components, _
    GetType(Component))
    If tableAdapterIdx >= 0 Then
        e.Components.RemoveAt(tableAdapterIdx)
    End If
    Dim dsIdx As Integer = GetItemIndex(e.Components, GetType(DataSet))
    If dsIdx >= 0 Then
        e.Components.RemoveAt(dsIdx)
    End If

End Sub

Private Shared Function GetItemIndex(ByVal components As IList, _
ByVal targetType As Type) As Integer

    Dim idx As Integer = -1
    For i As Integer = 0 To components.Count - 1
        If components(i).GetType().BaseType Is targetType Then
            idx = i
            Exit For
        End If
    Next i

    Return idx
End Function

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the SaveComponents event.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

Reporting_how-to-exclude-a-dataset-and-a-tableadapter-from-a-report-layout-when-saving-it-e1453/CS/SaveComponents/Form1.cs#L16

XtraReport1 report = new XtraReport1();
report.SaveComponents += new
    EventHandler<SaveComponentsEventArgs>(report_SaveComponents);

VB.NET

Reporting_how-to-exclude-a-dataset-and-a-tableadapter-from-a-report-layout-when-saving-it-e1453/VB/SaveComponents/Form1.vb#L18

Dim report As New XtraReport1()
AddHandler report.SaveComponents, AddressOf report_SaveComponents
Dim tool As New ReportDesignTool(report)