PrintingSystemBase.SetCommandVisibility(PrintingSystemCommand[], CommandVisibility) Method
Changes the visibility of the specified printing system command.
Namespace: DevExpress.XtraPrinting
Assembly: DevExpress.Printing.v18.2.Core.dll
Declaration
public void SetCommandVisibility(
PrintingSystemCommand[] commands,
CommandVisibility visibility
)Parameters
| Name | Type | Description |
|---|---|---|
| commands | PrintingSystemCommand[] | An array of PrintingSystemCommand enumeration values which specify the commands whose visibility needs to be changed. |
| visibility | CommandVisibility | A CommandVisibility enumeration value which specifies the new visibility state for the commands. |
Remarks
Note
The SetCommandVisibility method takes effect only in Windows Forms applications, where it must be called after the DocumentViewer.DocumentSource property has been assigned a value.
Every report command is represented by either a toolbar button and a menu item, or a context menu item, or a verb in the End-User Designer window. The values of the CommandVisibility enumeration represent the visibility states of the command. So, the SetCommandVisibility method allows the visibility of several report commands to be altered at the same time. To change the visibility of only a single report command at one time, use the overloaded SetCommandVisibility method.
To get the current visibility state of a report command, use the PrintingSystemBase.GetCommandVisibility method.
Example
This example illustrates how to change the visibility of the toolbar buttons and menu items of a print preview by using the PrintingSystemBase.SetCommandVisibility method that defines the availability of commands in print preview.
The following code hides the Watermark button from the toolbar (together with the corresponding menu item), makes the DocumentMap button and menu item visible, and then makes the ExportToCsv and ExportToTxt commands visible (in both the window’s menu, and in the toolbar).
All available commands are listed in the PrintingSystemCommand enumeration.
using DevExpress.XtraPrinting;
// ...
// Get the printing system of the DocumentViewer control.
PrintingSystemBase ps = documentViewer1.PrintingSystem;
// Hide the Watermark toolbar button, and also the Watermark menu item.
if (ps.GetCommandVisibility(PrintingSystemCommand.Watermark) != CommandVisibility.None){
ps.SetCommandVisibility(PrintingSystemCommand.Watermark, CommandVisibility.None);
}
// Show the Document Map toolbar button and menu item.
ps.SetCommandVisibility(PrintingSystemCommand.DocumentMap, CommandVisibility.All);
// Make the "Export to Csv" and "Export to Txt" commands visible.
ps.SetCommandVisibility(new PrintingSystemCommand[]
{PrintingSystemCommand.ExportCsv, PrintingSystemCommand.ExportTxt}, CommandVisibility.All);
Related GitHub Examples
The following code snippet (auto-collected from DevExpress Examples) contains a reference to the SetCommandVisibility(PrintingSystemCommand[], CommandVisibility) 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.