SimpleLink.CreateDetail Event

Occurs every time the detail area of a SimpleLink is created.

Namespace: DevExpress.Xpf.Printing

Assembly: DevExpress.Xpf.Printing.v20.2.dll

NuGet Packages: DevExpress.WindowsDesktop.Wpf.Printing, DevExpress.Wpf.Printing

Declaration

C#

public event EventHandler<CreateAreaEventArgs> CreateDetail

VB.NET

Public Event CreateDetail As EventHandler(Of CreateAreaEventArgs)

Event Data

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

Property	Description
Data	Gets or sets the object, which represents data for the area creation event.
DetailIndex	Gets or sets the index of a detail row for which the area creation event was called.

Remarks

The CreateDetail event is raised after the LinkBase.CreateDocument method is called for the SimpleLink object. This event is raised as many times as specified by the SimpleLink.DetailCount property value.

Handle the CreateDetail event to provide data for the detail area. An object containing data should be assigned to the CreateAreaEventArgs.Data property, and it will be represented using the template provided by the SimpleLink.DetailTemplate property.

Note

Do not pass visual objects (such as TextBox, Canvas, etc.) as detail area data, or the printing engine will not work as expected.

Example

This example demonstrates how to use SimpleLink to print data from a non-hierarchical datasource.

To do this, perform the following steps.

• Create a DataTemplate for a single detail row and assign it to the SimpleLink.DetailTemplate property;
• Set the SimpleLink.DetailCount property to the total count of data rows in a data source;
• Handle the SimpleLink.CreateDetail event, and provide data for its CreateAreaEventArgs.Data parameter;
• Call the LinkBase.CreateDocument method to generate report pages.

View Example

Window1.xaml.cs

using System;
using System.Globalization;
using System.Windows;
using DevExpress.Xpf.Printing;
// ...
string[] data;

private void button1_Click(object sender, RoutedEventArgs e) {
    // Create an array of strings.
    data = CultureInfo.CurrentCulture.DateTimeFormat.DayNames;

    // Create a link and specify a template and detail count for it.
    SimpleLink link = new SimpleLink();
    link.DetailTemplate = (DataTemplate)Resources["dayNameTemplate"];
    link.DetailCount = data.Length;

    // Create a document.
    link.CreateDetail += new EventHandler<CreateAreaEventArgs>(link_CreateDetail);

    // Show a Print Preview window.
    PrintHelper.ShowPrintPreviewDialog(this, link);
}

void link_CreateDetail(object sender, CreateAreaEventArgs e) {
    e.Data = data[e.DetailIndex];
}

Window1.xaml.vb

Imports System
Imports System.Globalization
Imports System.Windows
Imports DevExpress.Xpf.Printing
' ...
Private data() As String

Private Sub button1_Click(ByVal sender As Object, ByVal e As RoutedEventArgs)
    ' Create an array of strings.
    data = CultureInfo.CurrentCulture.DateTimeFormat.DayNames

    ' Create a link and specify a template and detail count for it.
    Dim link As New SimpleLink()
    link.DetailTemplate = DirectCast(Resources("dayNameTemplate"), DataTemplate)
    link.DetailCount = data.Length

    ' Create a document.
    AddHandler link.CreateDetail, AddressOf link_CreateDetail

    ' Show a Print Preview window.
    PrintHelper.ShowPrintPreviewDialog(Me, link)
End Sub

Private Sub link_CreateDetail(ByVal sender As Object, ByVal e As CreateAreaEventArgs)
    e.Data = data(e.DetailIndex)
End Sub

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the CreateDetail 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_ribbondocumentpreview-how-to-customize-the-ribbon-toolbar-and-status-bar-e4589/CS/E4589/ViewModel.cs#L61

link.DetailCount = data.Length;
link.CreateDetail += link_CreateDetail;
return link;

Reporting_how-to-create-a-document-sections-based-on-the-values-entered-by-an-end-user-e2942/CS/MainWindow.xaml.cs#L49

link.CreateDetail += link_CreateDetail;
link.ShowPrintPreviewDialog(this);

Reporting_how-to-remove-standard-bar-items-and-add-custom-ones-to-the-documentviewer-toolbar-e2974/CS/WpfApplication1/MainWindow.xaml.cs#L27

};
link.CreateDetail += (s, e) => e.Data = data[e.DetailIndex];

how-to-resize-gaugecontrol-on-printing-exporting-t274220/CS/WpfApplication72/MainWindow.xaml.cs#L21

sl.DetailTemplate = (DataTemplate)Resources["Data"];
sl.CreateDetail += new EventHandler<CreateAreaEventArgs>(sl_CreateDetail);
sl.CreateDocument(true);

Reporting_how-to-hide-specific-export-formats-from-the-document-preview-control-t279119/CS/HideExportFormats/MainWindow.xaml.cs#L35

};
link.CreateDetail += (s, args) => args.Data = data[args.DetailIndex];

VB.NET

Reporting_ribbondocumentpreview-how-to-customize-the-ribbon-toolbar-and-status-bar-e4589/VB/E4589/ViewModel.vb#L65

link.DetailCount = data.Length
AddHandler link.CreateDetail, AddressOf link_CreateDetail
Return link

Reporting_how-to-create-a-document-sections-based-on-the-values-entered-by-an-end-user-e2942/VB/MainWindow.xaml.vb#L48

AddHandler link.CreateDetail, AddressOf link_CreateDetail

Reporting_how-to-remove-standard-bar-items-and-add-custom-ones-to-the-documentviewer-toolbar-e2974/VB/WpfApplication1/MainWindow.xaml.vb#L28

Dim link As SimpleLink = New SimpleLink With {.DetailTemplate = CType(Resources("dayNameTemplate"), DataTemplate), .DetailCount = data.Length}
AddHandler link.CreateDetail, Function(s, e) e.Data = data(e.DetailIndex)

how-to-resize-gaugecontrol-on-printing-exporting-t274220/VB/WpfApplication72/MainWindow.xaml.vb#L23

sl.DetailTemplate = DirectCast(Resources("Data"), DataTemplate)
AddHandler sl.CreateDetail, AddressOf sl_CreateDetail
sl.CreateDocument(True)

Reporting_how-to-hide-specific-export-formats-from-the-document-preview-control-t279119/VB/HideExportFormats/MainWindow.xaml.vb#L34

link = New SimpleLink With {.DetailTemplate = DirectCast(Resources("dayNameTemplate"), DataTemplate), .DetailCount = data.Length}
AddHandler link.CreateDetail, Sub(s, args) args.Data = data(args.DetailIndex)