SnapControl Class

The Rich Text Editor-based report designer that allows end-users to create, modify and preview reports using a familiar Microsoft Word-inspired interface. Supports a variety of document formats for importing or exporting, including an original native document format that stores the layout without actual data.

Namespace: DevExpress.Snap

Assembly: DevExpress.Snap.v18.1.dll

Declaration

C#

[ToolboxBitmap(typeof(ResFinder), "Bitmaps256.SnapControl.bmp")]
[ToolboxTabName("DX.18.1: Reporting")]
public class SnapControl :
    RichEditControl,
    ISnapControl,
    ISnapInnerControlOwner,
    IInnerRichEditControlOwner,
    IInnerRichEditDocumentServerOwner,
    IRichEditControl,
    IBatchUpdateable,
    IServiceContainer,
    IServiceProvider,
    ICommandAwareControl<RichEditCommandId>,
    IWin32Window,
    ISupportSpellCheckerNotifications

VB.NET

<ToolboxBitmap(GetType(ResFinder), "Bitmaps256.SnapControl.bmp")>
<ToolboxTabName("DX.18.1: Reporting")>
Public Class SnapControl
    Inherits RichEditControl
    Implements ISnapControl,
               ISnapInnerControlOwner,
               IInnerRichEditControlOwner,
               IInnerRichEditDocumentServerOwner,
               IRichEditControl,
               IBatchUpdateable,
               IServiceContainer,
               IServiceProvider,
               ICommandAwareControl(Of RichEditCommandId),
               IWin32Window,
               ISupportSpellCheckerNotifications

Related API Members

The following members accept/return SnapControl objects:

• SnapDockManager.SnapControl

Remarks

The SnapControl control shows a report document and provides all the necessary functionality for loading, printing, editing and saving it.

Related GitHub Examples

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

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/SnapReportFormGenerator.cs#L11

public static class SnapReportFormGenerator {
    public static RibbonForm CreateReportPreviewForm(this SnapControl snapControl) {
        RibbonForm reportForm = new RibbonForm();

how-to-add-a-custom-progress-indicator-to-a-snap-application-e5074/CS/CustomProgressIndicator/MyProgressIndicationService.cs#L12

class MyProgressIndicationService : ISnapMailMergeProgressIndicationService, IDisposable {
    readonly SnapControl snapControl;
    MyProgressIndicationForm frm;

how-to-prevent-loading-untrusted-custom-assembly-in-ef-data-model-t408545/CS/EFDataTest/MyHelper.cs#L15

public static void CreateAndSaveReportTemplate(SnapControl control) {
    GenerateLayout(control.Document);

snap-how-to-customize-the-data-explorer-panel-t535534/CS/CustomDataExplorer/MyMenuCommandHandler.cs#L5

public class MyMenuCommandHandler : MenuCommandHandler {
    public MyMenuCommandHandler(SnapControl snap) : base(snap) {
    }

VB.NET

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

<System.Runtime.CompilerServices.Extension> _
Public Function CreateReportPreviewForm(ByVal snapControl As SnapControl) As RibbonForm
    Dim reportForm As New RibbonForm()

how-to-add-a-custom-progress-indicator-to-a-snap-application-e5074/VB/CustomProgressIndicator/MyProgressIndicationService.vb#L14

Implements ISnapMailMergeProgressIndicationService, IDisposable
Private ReadOnly snapControl As SnapControl
Private frm As MyProgressIndicationForm

how-to-prevent-loading-untrusted-custom-assembly-in-ef-data-model-t408545/VB/EFDataTest/MyHelper.vb#L19

Public Shared Sub CreateAndSaveReportTemplate(ByVal control As SnapControl)
    GenerateLayout(control.Document)

snap-how-to-customize-the-data-explorer-panel-t535534/VB/CustomDataExplorer/MyMenuCommandHandler.vb#L7

Public Sub New(ByVal snap As SnapControl)
    MyBase.New(snap)

Implements

ISnapControl

Inheritance

Object

MarshalByRefObject

Component

Control

RichEditControl

SnapControl