How to add a custom tool to the standard toolbar of WPF PDF Viewer?
Currently, we do not have an API for adding custom tools to the standard toolbar of WPF PDF Viewer. However, you can use your custom toolbar by setting the ShowToolbar property of PDF Viewer to false and hiding the standard toolbar. If you do not need to change the entire toolbar and simply need to make a few changes in the toolbar, such as adding your control, you can edit the standard toolbar template. From 21.1.0.x version onwards, PDFViewer toolbar design was changed for better user interface and visual.
The following code example demonstrates how to edit the toolbar template to add an “Unload” button to the standard toolbar and how to handle the buttons’ click event to unload the PDF document currently displayed in the PDF Viewer for both old toolbar (before 20.4.x.x) and new toolbar(21.1.0.x).
Before v20.4.0.x (Old Toolbar)
C#
/// <summary>
/// Add unload tool in the toolbar.
/// </summary>
private void AddUnloadToolInOldToolbar()
{
// Access the toolbar from PDF Viewer template.
DocumentToolbar toolbar = pdfViewer.Template.FindName("“PART_Toolbar"”, pdfViewer) as DocumentToolbar;
// Create the custom unload button.
Button unloadButton = new Button();
unloadButton.Content = "“Unload"”;
// wire the click event.
unloadButton.Click += UnloadButton_Click;
// Get the wrap panel from the toolbar.
WrapPanel wrapPanel = (WrapPanel)toolbar.Template.FindName("“toolBartoolBar"”, toolbar);
// Add the unload button in the toolbar.
wrapPanel.Children.Add(unloadButton);
}
/// <summary>
/// Click event handler for unload button.
/// </summary>
private void UnloadButton_Click(object sender, RoutedEventArgs e)
{
// unload the PDF document.
pdfViewer.Unload(true);
}
In 20.4.x.x versions, the wrap panel of the toolbar is changed to stack panel to provide the support for scroll helper buttons. So, in the above code sample, change the wrap panel to stack panel in 20.4.x.x versions.
After 21.1.0.x version (New toolbar)
C#
/// <summary>
/// Add unload tool in the toolbar.
/// </summary>
private void AddUnloadToolInNewToolbar()
{
// Access the toolbar from PDF Viewer template.
DocumentToolbar toolbar = pdfViewer.Template.FindName("PART_Toolbar", pdfViewer) as DocumentToolbar;
// Create the custom unload button.
Button unloadButton = new Button();
unloadButton.Content = "Unload";
// wire the click event.
unloadButton.Click += UnloadButton_Click;
// Get the stack panel from the toolbar.
// The template “PART_ToolbarStack” is used to add items in the toolbar stack.
StackPanel stackPanel = (StackPanel)toolbar.Template.FindName("PART_ToolbarStack", toolbar);
// The template “PART_AnnotationsStack” is used to add items in the annotation toolbar.
StackPanel annotationPanel = (StackPanel)toolbar.Template.FindName("PART_AnnotationsStack", toolbar);
// Add the unload button in the toolbar.
stackPanel.Children.Add(unloadButton);
}
/// <summary>
/// Click event handler for unload button.
/// </summary>
private void UnloadButton_Click(object sender, RoutedEventArgs e)
{
// unload the PDF document.
pdfViewer.Unload(true);
}
See also
Toggle visibility of the toolbar
Conclusion
I hope you enjoyed learning about how to add a custom tool to the standard toolbar of WPF PDF Viewer.
You can refer to our WPF PDFViewer’s feature tour page to know about its other groundbreaking feature representations. You can also explore our WPF PDFViewer documentation to understand how to present and manipulate data.
