IPdfViewerCommandFactoryService.CreateCommand(PdfViewerCommandId) Method
Enables you to create a custom command for use in the PDF Viewer.
Namespace: DevExpress.XtraPdfViewer
Assembly: DevExpress.XtraPdfViewer.v24.1.dll
NuGet Package: DevExpress.Win.PdfViewer
Declaration
Parameters
Name | Type | Description |
---|---|---|
commandId | PdfViewerCommandId | A PdfViewerCommandId member specifying a command to create. |
Returns
Type | Description |
---|---|
PdfViewerCommand | A PdfViewerCommand object that is the PDF Viewer command. |
Example
This example shows how to modify the functionality of an existing PdfViewer command.
The PdfViewer exposes the IPdfViewerCommandFactoryService interface that enables you to substitute the default command with your own custom command.
To accomplish this task:
- Create a custom command class (e.g., a CustomNextPageCommand class), inherited from the command that you wish to replace (e.g., PdfNextPageCommand).
- Override the required method of the command. The main functionality and command specifics are located in the Execute method.
- Create a class (e.g., CustomPdfViewerCommandFactoryService) implementing the IPdfViewerCommandFactoryService. You should override the
IPdfViewerCommandFactoryService.CreateCommand
method to create an instance of a custom command class if an identifier of a certain command is passed as a parameter. So, instead of the default command, a custom command will be used by the PdfViewer. - Use the created class to substitute for the default PdfViewer’s service.
- Form1.cs
- CustomPdfViewerCommandFactoryService.cs
- Program.cs
- CustomNextPageCommand.cs
- Program.vb
- CustomNextPageCommand.vb
- Form1.vb
- CustomPdfViewerCommandFactoryService.vb
using DevExpress.XtraPdfViewer;
using System;
using System.Windows.Forms;
namespace ViewerCustomCommand {
public partial class Form1 : Form {
void ReplacePdfViewerCommandFactoryService(PdfViewer control) {
IPdfViewerCommandFactoryService service = control.GetService<IPdfViewerCommandFactoryService>();
if (service == null)
return;
control.RemoveService(typeof(IPdfViewerCommandFactoryService));
control.AddService(typeof(IPdfViewerCommandFactoryService), new CustomPdfViewerCommandFactoryService(control,service));
}
public Form1() {
InitializeComponent();
pdfViewer1.LoadDocument("..\\..\\Demo.pdf");
ReplacePdfViewerCommandFactoryService(pdfViewer1);
}
}
}
Related GitHub Examples
The following code snippet (auto-collected from DevExpress Examples) contains a reference to the CreateCommand(PdfViewerCommandId) 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.