QatPlaceholderTool Class

A placeholder used to represent tools or RibbonGroup instances that have been placed on the QuickAccessToolbar. This tool is intended for use on the QuickAccessToolbar only. The TargetType property is used to determine whether the TargetId represents a tool or a RibbonGroup.

Syntax

Visual Basic

'Declaration
 
Public Class QatPlaceholderTool 
   Inherits System.Windows.FrameworkElement

C#

public class QatPlaceholderTool : System.Windows.FrameworkElement 

Example

QatPlaceholderTool ToString method

Visual Basic

' Creating ButtonTool 
Dim btnToolCopy As New ButtonTool() 
btnToolCopy.Id = "copyTool" 
AddHandler btnToolCopy.Click, AddressOf btnToolCopy_Click 

' Adding ButtonTool to the QAT 
Dim qatToolCopy As New QatPlaceholderTool() 
qatToolCopy.TargetId = "copyTool" ' btnToolCopy.Id 
qatToolCopy.TargetType = QatPlaceholderToolType.Tool 
xamRibbon.QuickAccessToolbar.Items.Add(qatToolCopy) 
...
Private Sub btnToolCopy_Click(ByVal sender As Object, ByVal e As RoutedEventArgs) 
    Dim btnTool As ButtonTool = TryCast(sender, ButtonTool) 
    Dim qatTool As QatPlaceholderTool = TryCast(btnTool.Parent, QatPlaceholderTool) 
    
    If qatTool Is Nothing Then 
        Debug.Write("The tool is not on the QuickAccessToolbar") 
    Else 
        Debug.Write("QatPlaceholderTool.ToString(): " + qatTool.ToString()) 
    End If 
End Sub

C#

// Creating ButtonTool
ButtonTool btnToolCopy = new ButtonTool();
btnToolCopy.Id = "copyTool";
btnToolCopy.Click += new RoutedEventHandler(btnToolCopy_Click);

// Adding ButtonTool to the QAT
QatPlaceholderTool qatToolCopy = new QatPlaceholderTool();
qatToolCopy.TargetId = "copyTool"; // btnToolCopy.Id
qatToolCopy.TargetType = QatPlaceholderToolType.Tool;
xamRibbon.QuickAccessToolbar.Items.Add(qatToolCopy);
...

void btnToolCopy_Click(object sender, RoutedEventArgs e)
{
    ButtonTool btnTool = sender as ButtonTool;
    QatPlaceholderTool qatTool = btnTool.Parent as QatPlaceholderTool;

    if (qatTool == null)
        Debug.Write("The tool is not on the QuickAccessToolbar");
    else
        Debug.Write("QatPlaceholderTool.ToString(): "+qatTool.ToString());
}

Requirements

Target Platforms: Windows 10, Windows 8.1, Windows 8, Windows 7, Windows Server 2012, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2