SnapDocument Interface

A central element of a Snap application that constitutes a report document and accounts for the creation and editing of a Snap report.

Namespace: DevExpress.Snap.Core.API

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

Declaration

C#

public interface SnapDocument :
    Document,
    SnapSubDocument,
    SubDocument,
    ISnapFieldOwner,
    IDataSourceOwner

VB.NET

Public Interface SnapDocument
    Inherits Document,
             SnapSubDocument,
             SubDocument,
             ISnapFieldOwner,
             IDataSourceOwner

Related API Members

The following members accept/return SnapDocument objects:

Show 25 links

Library	Related API Members
WinForms Controls	BeforeConversionEventArgs.Document
	PrepareSnListColumnsEventArgs.Body
	PrepareSnListColumnsEventArgs.Header
	PrepareSnListDetailEventArgs.Template
	PrepareSnListEventArgs.Template
	SnapControl.Document
	SnapEntity.Document
	SnapList.ListFooter
	SnapList.ListHeader
	SnapList.RowTemplate
	SnapList.Separator
	SnapListGroupInfo.CreateFooter()
	SnapListGroupInfo.CreateHeader()
	SnapListGroupInfo.CreateSeparator()
	SnapListGroupInfo.Footer
	SnapListGroupInfo.Header
	SnapListGroupInfo.Separator
	SnapMailMergeExportOptions.CustomSeparator
	SnapMailMergeFinishedEventArgs.Document
	SnapMailMergeRecordFinishedEventArgs.Document
	SnapMailMergeRecordFinishedEventArgs.RecordDocument
	SnapMailMergeRecordStartedEventArgs.Document
	SnapMailMergeRecordStartedEventArgs.RecordDocument
	SnapMailMergeStartedEventArgs.Document
Office File API	SnapDocumentServer.Document

Remarks

Among the methods, properties and events inherited from its base Document class, the SnapDocument provides the capability to manage a document’s data sources and parameters.

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

Related GitHub Examples

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

AssignDataSourceToSnapControl(SnapReport);
SnapDocument document = SnapReport.Document;
document.BeginUpdate();

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

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

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

#region #GenerateLayout
private void GenerateLayout(SnapDocument doc) {
    // Add a Snap list to the document.

snap-report-api-how-to-bind-a-snap-report-to-worksheet-data-and-export-it-to-pdf-t518437/CS/SnapAndSpreadsheetDocumentServerExample/Program.cs#L11

SnapDocumentServer snap = new SnapDocumentServer();
SnapDocument document = snap.Document;
XTemplateCreator.CreateMailMergeTemplate(document);

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

SnapDocument document = snapControl1.Document;
document.BeginUpdateDataSource();

VB.NET

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

AssignDataSourceToSnapControl(SnapReport)
Dim document As SnapDocument = SnapReport.Document
document.BeginUpdate()

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

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

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

#Region "#GenerateLayout"
Private Sub GenerateLayout(ByVal doc As SnapDocument)
    ' Add a Snap list to the document.

snap-report-api-how-to-bind-a-snap-report-to-worksheet-data-and-export-it-to-pdf-t518437/VB/SnapAndSpreadsheetDocumentServerExample/XTemplateCreator.vb#L17

#Region "#CreateSnListTemplate"
Public Shared Sub CreateSnListTemplate(ByVal document As SnapDocument)
    Dim list As SnapList = document.CreateSnList(document.Range.End, "EmployeeList")

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

Dim document As SnapDocument = snapControl1.Document
document.BeginUpdateDataSource()