Document.BeforeRightClick Event
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Occurs when the editing area of the document window is right-clicked, before the default right-click action.
public:
event Microsoft::Office::Tools::Word::ClickEventHandler ^ BeforeRightClick;event Microsoft.Office.Tools.Word.ClickEventHandler BeforeRightClick;member this.BeforeRightClick : Microsoft.Office.Tools.Word.ClickEventHandler Event BeforeRightClick As ClickEventHandler Event Type
Examples
The following code example displays a message when you right-click the document. This example is for an application-level add-in.
private void DocumentBeforeRightClick()
{
Document vstoDoc = Globals.Factory.GetVstoObject(this.Application.ActiveDocument);
vstoDoc.BeforeRightClick += new Microsoft.Office.Tools.Word.ClickEventHandler(ThisDocument_BeforeRightClick);
}
void ThisDocument_BeforeRightClick(object sender, Microsoft.Office.Tools.Word.ClickEventArgs e)
{
Document vstoDoc = Globals.Factory.GetVstoObject(this.Application.ActiveDocument);
System.Windows.Forms.MessageBox.Show(vstoDoc.Name + " was right-clicked.");
e.Cancel = true;
}
Private Sub DocumentBeforeRightClick()
Dim vstoDoc As Document = Globals.Factory.GetVstoObject(Me.Application.ActiveDocument)
AddHandler vstoDoc.BeforeRightClick, AddressOf ThisDocument_BeforeRightClick
End Sub
Private Sub ThisDocument_BeforeRightClick(ByVal sender As Object, ByVal e _
As Microsoft.Office.Tools.Word.ClickEventArgs)
Dim vstoDoc As Document = Globals.Factory.GetVstoObject(Me.Application.ActiveDocument)
System.Windows.Forms.MessageBox.Show(vstoDoc.Name & " was right-clicked.")
e.Cancel = True
End Sub
Remarks
To prevent the default right-click action from occurring, set the Cancel argument of the provided CancelEventArgs object to true.