SnapList Interface

Provides functionality to manipulate lists in Snap documents.

Namespace: DevExpress.Snap.Core.API

Assembly: DevExpress.Snap.v18.1.Core.dll

Declaration

C#

public interface SnapList :
    SnapEntity,
    IDisposable

VB.NET

Public Interface SnapList
    Inherits SnapEntity,
             IDisposable

Related API Members

The following members accept/return SnapList objects:

• AfterInsertSnListColumnsEventArgs.SnList
• AfterInsertSnListDetailEventArgs.Master
• BeforeInsertSnListColumnsEventArgs.Target
• BeforeInsertSnListDetailEventArgs.Master
• BeforeInsertSnListRecordDataEventArgs.Target
• ISnapFieldOwner.CreateSnList(DocumentPosition, String)
• ISnapFieldOwner.FindListByName(String)

Remarks

For more information, refer to Snap List and Document Template.

Note

Snap list modifications at runtime must be wrapped in the SnapEntity.BeginUpdate and SnapEntity.EndUpdate method calls.

Example

This procedure generates the Snap template in code by executing the following steps.

1. Create a SnapList and start its modification by calling the SnapEntity.BeginUpdate method.
2. Create a SnapList.ListHeader header, add a Table to the header and insert column names.
3. Modify the row template. The row template has the SnapDocument interface accessible using the SnapList.RowTemplate property.
4. Add a table to the template and insert data-bound text fields into its cells using the ISnapFieldOwner.CreateSnText method.
5. Format the table in the list.
6. Apply filter to data in the list.
7. Sort data in the list.
8. Group data in the list
9. Finalize the modification by calling the SnapEntity.EndUpdate method.
10. Update the result by calling the Field.Update method.

Note

A complete sample project is available at https://github.com/DevExpress-Examples/how-to-generate-a-document-layout-in-code-via-the-snap-application-programming-interface-api-e4781

Form1.cs

private void GenerateLayout(SnapDocument doc) {
    // Add a Snap list to the document.
    SnapList list = doc.CreateSnList(doc.Range.End, @"List");
    list.BeginUpdate();
    list.EditorRowLimit = 100;

    // Add a header to the Snap list.                                                                   
    SnapDocument listHeader = list.ListHeader;
    Table listHeaderTable = listHeader.Tables.Create(listHeader.Range.End, 1, 3);
    TableCellCollection listHeaderCells = listHeaderTable.FirstRow.Cells;
    listHeader.InsertText(listHeaderCells[0].ContentRange.End, "Product Name");
    listHeader.InsertText(listHeaderCells[1].ContentRange.End, "Units in Stock");
    listHeader.InsertText(listHeaderCells[2].ContentRange.End, "Unit Price");

    // Customize the row template.
    SnapDocument listRow = list.RowTemplate;
    Table listRowTable = listRow.Tables.Create(listRow.Range.End, 1, 3);
    TableCellCollection listRowCells = listRowTable.FirstRow.Cells;
    listRow.CreateSnText(listRowCells[0].ContentRange.End, @"ProductName");
    listRow.CreateSnText(listRowCells[1].ContentRange.End, @"UnitsInStock");
    listRow.CreateSnText(listRowCells[2].ContentRange.End, @"UnitPrice \$ $0.00");

    // Apply formatting, filtering and sorting to the Snap list. 
    FormatList(list);
    FilterList(list);
    SortList(list);
    GroupList(list);

    list.EndUpdate();
    list.Field.Update();
}

Form1.vb

Private Sub GenerateLayout(ByVal doc As SnapDocument)
    ' Add a Snap list to the document.
    Dim list As SnapList = doc.CreateSnList(doc.Range.End, "List")
    list.BeginUpdate()
    list.EditorRowLimit = 100

    ' Add a header to the Snap list.                                                                   
    Dim listHeader As SnapDocument = list.ListHeader
    Dim listHeaderTable As Table = listHeader.Tables.Create(listHeader.Range.End, 1, 3)
    Dim listHeaderCells As TableCellCollection = listHeaderTable.FirstRow.Cells
    listHeader.InsertText(listHeaderCells(0).ContentRange.End, "Product Name")
    listHeader.InsertText(listHeaderCells(1).ContentRange.End, "Units in Stock")
    listHeader.InsertText(listHeaderCells(2).ContentRange.End, "Unit Price")

    ' Customize the row template.
    Dim listRow As SnapDocument = list.RowTemplate
    Dim listRowTable As Table = listRow.Tables.Create(listRow.Range.End, 1, 3)
    Dim listRowCells As TableCellCollection = listRowTable.FirstRow.Cells
    listRow.CreateSnText(listRowCells(0).ContentRange.End, "ProductName")
    listRow.CreateSnText(listRowCells(1).ContentRange.End, "UnitsInStock")
    listRow.CreateSnText(listRowCells(2).ContentRange.End, "UnitPrice \$ $0.00")

    ' Apply formatting, filtering and sorting to the Snap list. 
    FormatList(list)
    FilterList(list)
    SortList(list)
    GroupList(list)

    list.EndUpdate()
    list.Field.Update()
End Sub

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the SnapList interface.

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#

how-to-generate-a-live-report-based-on-gridcontrol-content-t272175/CS/WindowsFormsApplication1/GridReportExtensions/SnapReportForGridGenerator.cs#L60

SnapList list = document.CreateSnList(document.Range.End, grid.Name);
list.BeginUpdate();

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

server.LoadDocumentTemplate("Template.snx");
SnapList list = server.Document.FindListByName("Data Source 11");
server.Document.ParseField(list.Field);

how-to-use-snapdocument-events-to-customize-the-default-templates-of-snap-lists-and-columns-e4782/CS/Snap_Events/Form1.cs#L133

SnapEntity eTemplateParseField = e.Template.ParseField(field);
SnapList snList = eTemplateParseField as SnapList;
if(snList == null)

how-to-edit-an-existing-snx-template-in-code-t224149/CS/Snap_API/Form1.cs#L56

private SnapList FindList() {
    SnapList list = null;

how-to-generate-a-document-layout-in-code-via-the-snap-application-programming-interface-api-e4781/CS/Snap_API/Form1.cs#L49

// Add a Snap list to the document.
SnapList list = doc.CreateSnList(doc.Range.End, @"List");
list.BeginUpdate();

VB.NET

how-to-generate-a-live-report-based-on-gridcontrol-content-t272175/VB/WindowsFormsApplication1/GridReportExtensions/SnapReportForGridGenerator.vb#L63

Dim list As SnapList = document.CreateSnList(document.Range.End, grid.Name)
list.BeginUpdate()

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

server.LoadDocumentTemplate("Template.snx")
Dim list As SnapList = server.Document.FindListByName("Data Source 11")
server.Document.ParseField(list.Field)

how-to-use-snapdocument-events-to-customize-the-default-templates-of-snap-lists-and-columns-e4782/VB/Snap_Events/Form1.vb#L139

Dim eTemplateParseField As SnapEntity = e.Template.ParseField(field)
Dim snList As SnapList = TryCast(eTemplateParseField, SnapList)
If snList Is Nothing Then

how-to-edit-an-existing-snx-template-in-code-t224149/VB/Snap_API/Form1.vb#L58

Private Function FindList() As SnapList
    Dim list As SnapList = Nothing

how-to-generate-a-document-layout-in-code-via-the-snap-application-programming-interface-api-e4781/VB/Snap_API/Form1.vb#L51

' Add a Snap list to the document.
Dim list As SnapList = doc.CreateSnList(doc.Range.End, "List")
list.BeginUpdate()