Snap Commands

• Oct 29, 2020
• 6 minutes to read

This document describes Snap commands that correspond to actions performed by end-users in a Snap control.

The document consists of the following sections.

• Executing Commands
• List of Commands

Executing Commands

Any action that an end-user can perform in a Snap control corresponds to a specific command that can be executed by calling the Command.Execute method.

Each Snap command is inherited from the Command class and provides properties that define its visual presentation in the application toolbar (e.g., Command.Image, Command.Description and Command.MenuCaption).

The following code illustrates the execution of a Snap command. When executed, this command will convert the selected Snap list to paragraphs.

C#

using System;
using System.Windows.Forms;
using DevExpress.Snap.Core.Commands;
// ... 

private void ExecuteConvertToParagraphsCommand(SnapControl snapControl1) {
    ConvertToParagraphsCommand command = 
        new ConvertToParagraphsCommand(snapControl1);
    command.Execute();
}

VB.NET

Imports System
Imports System.Windows.Forms
Imports DevExpress.Snap.Core.Commands
' ... 

Private Sub ExecuteConvertToParagraphsCommand(ByVal snapControl1 As SnapControl)
    Dim command As New ConvertToParagraphsCommand(snapControl1)
    command.Execute()
End Sub

List of Commands

This section of the document describes the available Snap commands.

Command	Description
ChangeEditorRowLimitCommand	Specifies the number of data records displayed by a Snap document while editing it in the Design Surface.
ChangeMailMergeCurrentRecordCommand	Specifies the record number that is currently displayed by a mail merge report in the Design Surface.
ChangeMailMergeDataSourceCommand	Specifies the data source assigned to a mail merge report.
ChangeSelectionIntervalCommand	Specifies the start and end points of the selected range in the document content.
ChangeTableCellStyleCommand	Changes the style settings of the currently selected table cell.
ChangeThemeCommand	Changes the document theme that defines the appearance of the Snap list.
ConvertToParagraphsCommand	Converts the Snap list to paragraphs. Note that this command is specific to Snap and does not affect common bulleted and numbered lists in the document.
CreateFieldForTemplate	Inserts an empty Snap field into the carriage position.
DeleteListCommand	Deletes the selected Snap list from the document.
ExportDocumentCommand	Exports the current Snap document to the specified file.
FilterFieldCommand	Adds a criterion to the filter field values.
FilterListCommand	Invokes the Filter String Editor for a list.
GroupByFieldCommand	Enables/disables the data grouping in a Snap list by the value of the selected field.
GroupFieldsCollectionCommand	Invokes a dialog to manage the grouping criteria of the selected Snap list.
HighlightActiveElementCommand	Highlights the bounds of a selected element and displays its type.
InsertBarCodeCommand	Inserts a bar code into the carriage position.
InsertChartCommand	Inserts a chart into the carriage position.
InsertCheckBoxCommand	Inserts a check box into the carriage position.
InsertEmptyParagraphDataRowSeparatorCommand	Inserts an empty paragraph to separate data rows in a Snap list.
InsertEmptyRowDataRowSeparatorCommand	Inserts an empty row to separate data rows in a Snap list.
InsertEmptyRowGroupSeparatorCommand	Inserts an empty row to separate groups in a Snap list.
InsertGroupFooterCommand	Adds a group footer to a Snap list.
InsertGroupHeaderCommand	Adds a group header to a Snap list.
InsertGroupSeparatorCommand	Inserts a separator between groups of a Snap list.
InsertIndexCommand	Inserts a row index into the carriage position.
InsertListFooterCommand	Adds a footer to a Snap list.
InsertListHeaderCommand	Adds a header to a Snap list.
InsertNoneDataRowSeparatorCommand	Deletes the separator between data rows of a Snap list.
InsertNoneGroupSeparatorCommand	Deletes the separator between groups of a Snap list.
InsertPageBreakDataRowSeparatorCommand	Inserts a page break to separate the data rows of a Snap list.
InsertPageBreakGroupSeparatorCommand	Inserts a page break to separate the groups of a Snap list.
InsertSectionBreakEvenPageDataRowSeparatorCommand	Inserts an even page section break to separate the data rows of a Snap list.
InsertSectionBreakEvenPageGroupSeparatorCommand	Inserts an even page section break to separate the groups of a Snap list.
InsertSectionBreakNextPageDataRowSeparatorCommand	Inserts the next page section break to separate the data rows of a Snap list.
InsertSectionBreakNextPageGroupSeparatorCommand	Inserts the next page section break to separate the groups of a Snap list.
InsertSectionBreakOddPageDataRowSeparatorCommand	Inserts an odd page section break to separate the data rows of a Snap list.
InsertSectionBreakOddPageGroupSeparatorCommand	Inserts an odd page section break to separate the groups of a Snap list.
InsertSparklineCommand	Inserts a sparkline in the carriage position.
LoadThemeCommand	Inserts a separator between groups.
MailMergeFilterFieldCommand	Filters the data records of a selected field in a mail merge document.
MailMergeFiltersCommand	Invokes the Filter String Editor for a mail merge document.
MailMergeSortFieldAscendingCommand	Sorts the selected mail merge field in ascending order.
MailMergeSortFieldDescendingCommand	Sorts the selected mail merge field in descending order.
MailMergeSortingCommand	Invokes the Sort dialog for a mail merge document.
NewDataSourceCommand	Invokes the Create Data Source Wizard.
PropertiesCommand	Enables the customization of a field‘s properties, specific to its type.
RemoveGroupFooterCommand	Removes the footer of the selected group.
RemoveGroupHeaderCommand	Removes the header of the selected group.
RemoveListFooterCommand	Removes the footer of the selected Snap list.
RemoveListHeaderCommand	Removes the header of the selected Snap list.
RunChartWizardCommand	Invokes the Chart Wizard for the selected chart.
SaveThemeCommand	Invokes the Save As dialog, to save the current appearance settings of a Snap document to a file.
ShowReportStructureEditorFormCommand	Invokes the Groups Order Editor for the selected Snap list.
SnapChangeTableRowHeightCommand	Changes the height of the currently selected table row.
SnapDeleteTableCellsWithShiftToTheHorizontallyCommand	Deletes the selected table cells.
SnapDeleteTableColumnsCommand	Deletes the selected table columns.
SnapDeleteTableCommand	Deletes the selected table.
SnapDeleteTableRowsCommand	Deletes the selected table rows.
SnapFilterFieldCommand	Applies quick filtering to a mail merge field or a regular Snap field.
SnapInsertTableColumnToTheLeftCommand	Inserts a new column to the left of the selected table column.
SnapInsertTableColumnToTheRightCommand	Inserts a new column to the right of the selected table column.
SnapMailMergeExportDocumentCommand	Finishes a mail merge document and exports it to a third-party format.
SnapMailMergePrintCommand	Finishes a mail merge document and sends it to a printer.
SnapMailMergePrintPreviewCommand	Finishes a mail merge document and displays it in the Print Preview window.
SnapMailMergeQuickPrintCommand	Finishes a mail merge document and sends it to a printer, without displaying the Print dialog.
SnapMergeTableCellsCommand	Merges the selected table cells into a single cell.
SnapShowDeleteTableCellsFormCommand	Invokes the Delete Cells dialog for the selected table cells.
SnapShowTableStyleFormCommand	Invokes the Modify Style dialog for the selected table.
SnapSortFieldAscendingCommand	Sorts the selected Snap field in ascending order. This command is also suitable for sorting mail merge fields.
SnapSortFieldDescendingCommand	Sorts the selected Snap field in descending order. This command is also suitable for sorting mail merge fields.
SnapSplitTableCellsCommand	Splits the selected table cells.
SnapToggleTableFixedColumnWidthCommand	Toggles the fixed column width mode for the selected table.
SortFieldAscendingCommand	Sorts the selected Snap field in ascending order. To sort mail merge fields, use the SnapSortFieldAscendingCommand.
SortFieldDescendingCommand	Sorts the selected Snap field in descending order. To sort mail merge fields, use the SnapSortFieldDescendingCommand.
SummaryAverageCommand	Calculates the average value across the data records of a selected Snap field.
SummaryCountCommand	Counts the data records in the selected Snap field.
SummaryMaxCommand	Displays the maximum value across the data records of a selected Snap field.
SummaryMinCommand	Displays the minimum value across the data records of a selected Snap field.
SummarySumCommand	Calculates the total value across the data records of a selected Snap field.
ToggleFieldHighlightingCommand	Highlights all Snap fields in a document, to distinguish them from static content.