DataAwareEventArgsBase.DocumentRow Property

Gets the index of the row in the export output to which the current cell is exported.

Namespace: DevExpress.Export

Assembly: DevExpress.Printing.v24.2.Core.dll

NuGet Package: DevExpress.Printing.Core

Declaration

C#

public int DocumentRow { get; set; }

VB.NET

Public Property DocumentRow As Integer

Property Value

Type	Description
Int32	A zero-based integer value that specifies the index of the row in the export output.

Remarks

The topmost row in the export output has a DocumentRow index of 0. For each subsequent row, the DocumentRow property is incremented by 1.

Note that the top rows in the export output may be occupied by column headers, group rows and other elements. The topmost data cells will be displayed below these elements. The column “Document Row” in the following image demonstrates DocumentRow property values for exported data cells when column headers are exported.

Related GitHub Examples

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

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#

winforms-grid-customize-data-aware-export-output/CS/GridDataAwareExportCustomization/Form1.cs#L63

if(e.DataSourceRowIndex < 0) {
    e.ExportContext.MergeCells(new XlCellRange(new XlCellPosition(0, e.DocumentRow - 1), new XlCellPosition(5, e.DocumentRow - 1)));
}

VB.NET

winforms-grid-customize-data-aware-export-output/VB/GridDataAwareExportCustomization/Form1.vb#L66

If e.DataSourceRowIndex < 0 Then
    e.ExportContext.MergeCells(New XlCellRange(New XlCellPosition(0, e.DocumentRow - 1), New XlCellPosition(5, e.DocumentRow - 1)))
End If