PrintingSystemBase.ExecCommand(PrintingSystemCommand, Object[]) Method

Executes the specified printing system command and passes the specified parameters.

Namespace: DevExpress.XtraPrinting

Assembly: DevExpress.Printing.v18.2.Core.dll

Declaration

C#

public void ExecCommand(
    PrintingSystemCommand command,
    object[] args
)

VB.NET

Public Sub ExecCommand(
    command As PrintingSystemCommand,
    args As Object()
)

Parameters

Name	Type	Description
command	PrintingSystemCommand	A PrintingSystemCommand enumeration value representing the command to be executed.
args	Object[]	A collection of Object objects, representing the parameters to be passed to the executing command.

Remarks

Note

The ExecCommand method takes effect only in Windows Forms applications, where it must be called after the DocumentViewer.DocumentSource property has been assigned a value.

Use the ExecCommand method to perform the same actions performed when the toolbar button or a menu item associated with the specified printing system command is clicked. The PrintingSystemCommand enumeration lists all the available printing system commands.

To execute a printing system command without any parameters, use the overloaded PrintControl.ExecCommand method.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the ExecCommand(PrintingSystemCommand, Object[]) method.

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#

Reporting_how-to-execute-commands-in-print-preview-e2304/CS/ExecuteCommandsPreview/Form1.cs#L27

// Invoke the Hand tool.
ps.ExecCommand(PrintingSystemCommand.HandTool, new object[] { true });

Reporting_how-to-use-a-stored-procedure-as-a-report-data-source-systemdatadataset-e1740/CS/Form1.cs#L16

    new ReportPrintTool(report).ShowPreview();
    report.PrintingSystem.ExecCommand(DevExpress.XtraPrinting.PrintingSystemCommand.Parameters, new object[] { true });
}

Reporting_how-to-implement-a-separate-document-map-using-the-xtratreelist-control-e4516/CS/WindowsFormsApplication1/Form1.cs#L29

report.CreateDocument();
printControl1.PrintingSystem.ExecCommand(DevExpress.XtraPrinting.PrintingSystemCommand.DocumentMap, new object[] { false } );

Reporting_how-to-programmatically-decrease-the-scale-factor-of-a-document-in-print-preview-e1440/CS/AutoScaling/Form1.cs#L23

    PrintPreviewFormEx frm = (PrintPreviewFormEx)sender;
    frm.PrintingSystem.ExecCommand(PrintingSystemCommand.Scale, new object[] { 0.7f });
}

VB.NET

Reporting_how-to-execute-commands-in-print-preview-e2304/VB/ExecuteCommandsPreview/Form1.vb#L29

' Invoke the Hand tool.
ps.ExecCommand(PrintingSystemCommand.HandTool, New Object() { True })

Reporting_how-to-use-a-stored-procedure-as-a-report-data-source-systemdatadataset-e1740/VB/Form1.vb#L18

    CType(New ReportPrintTool(report), ReportPrintTool).ShowPreview()
    report.PrintingSystem.ExecCommand(DevExpress.XtraPrinting.PrintingSystemCommand.Parameters, New Object() { True })
End Sub

Reporting_how-to-programmatically-decrease-the-scale-factor-of-a-document-in-print-preview-e1440/VB/AutoScaling/Form1.vb#L25

    Dim frm As PrintPreviewFormEx = DirectCast(sender, PrintPreviewFormEx)
    frm.PrintingSystem.ExecCommand(PrintingSystemCommand.Scale, New Object() { 0.7F })
End Sub