PrintControl.ExecCommand(PrintingSystemCommand, Object[]) Method

Executes the specified command with custom parameters.

Namespace: DevExpress.XtraPrinting.Control

Assembly: DevExpress.XtraPrinting.v24.2.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, specifying the command to execute.
args	Object[]	A collection of Object values, specifying custom parameters to pass to the executed command.

Remarks

Important

This method takes effect only in Windows Forms applications.

Use this method to perform various actions in Print Preview and maintain the visibility of corresponding UI elements. The PrintingSystemCommand enumeration lists all available actions.

Consider the following before calling this method:

• Print Preview must have a document source assigned to its DocumentViewer.DocumentSource property.
• Call the PrintControl.CanExecCommand to ensure a correct execution of a command prior to the ExecCommand method call.

Example

This example illustrates how to execute commands corresponding to various end-user actions in Print Preview by using the PrintControl.ExecCommand method of the DocumentViewer control.

Some of these commands are called without any parameters, while others require calling an overloaded version of the PrintControl.ExecCommand method accepting custom parameter values.

C#

using DevExpress.XtraPrinting;
// ...

// Zoom a document to fit the entire page into Print Preview dimensions.
documentViewer1.ExecCommand(PrintingSystemCommand.ViewWholePage);

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

// Hide the Hand tool.
documentViewer1.ExecCommand(PrintingSystemCommand.HandTool, new object[] {false});

VB.NET

Imports DevExpress.XtraPrinting
' ...

' Zoom a document to fit the entire page into Print Preview dimensions.
documentViewer1.ExecCommand(PrintingSystemCommand.ViewWholePage)

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

' Hide the Hand tool.
documentViewer1.ExecCommand(PrintingSystemCommand.HandTool, New Object() {False})