SnapList.ListHeader Property

Provides access to the SnapList‘s header.

Namespace: DevExpress.Snap.Core.API

Assembly: DevExpress.Snap.v21.2.Core.dll

NuGet Package: DevExpress.Snap.Core

Declaration

C#

SnapDocument ListHeader { get; }

VB.NET

ReadOnly Property ListHeader As SnapDocument

Property Value

Type	Description
SnapDocument	A SnapDocument object.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the ListHeader 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#

spreadsheet-document-api-use-worksheet-table-as-data-source/CS/SpreadsheetDocumentServerAsDataSourceExample/Form1.cs#L33

SnapDocument listHeader = list.ListHeader;
Table listHeaderTable = listHeader.Tables.Create(listHeader.Range.End, 1, 3);

snap-report-api-examples/CS/SnapServerExamples/CodeExamples/DataShapingActions.cs#L22

// Add a header to the Snap list.
SnapDocument listHeader = list.ListHeader;
Table listHeaderTable = listHeader.Tables[0];

snap-convert-snx-to-repx/CS/SnxToRepx/Converter/SnapListProcessor.cs#L149

//Get the list header
SnapDocument listHeader = list.ListHeader;
//Process the inner document and add its content to the ReportHeader band

VB.NET

snap-report-api-examples/VB/SnapServerExamples/CodeExamples/DataShapingActions.vb#L20

' Add a header to the Snap list.
Dim listHeader As DevExpress.Snap.Core.API.SnapDocument = list.ListHeader
Dim listHeaderTable As DevExpress.XtraRichEdit.API.Native.Table = listHeader.Tables(0)

spreadsheet-document-api-use-worksheet-table-as-data-source/VB/SpreadsheetDocumentServerAsDataSourceExample/Form1.vb#L33

Dim listHeader As SnapDocument = list.ListHeader
Dim listHeaderTable As Table = listHeader.Tables.Create(listHeader.Range.End, 1, 3)

snap-convert-snx-to-repx/VB/SnxToRepx/Converter/SnapListProcessor.vb#L134

'Get the list header
Dim listHeader As DevExpress.Snap.Core.API.SnapDocument = Me.list.ListHeader
'Process the inner document and add its content to the ReportHeader band