Share via


DocumentBase.BeforeRightClick Event

Occurs when the editing area of the document window is right-clicked, before the default right-click action.

Namespace:  Microsoft.Office.Tools.Word
Assembly:  Microsoft.Office.Tools.Word.v4.0.Utilities (in Microsoft.Office.Tools.Word.v4.0.Utilities.dll)

Syntax

'Declaration
Public Event BeforeRightClick As ClickEventHandler
public event ClickEventHandler BeforeRightClick

Remarks

To prevent the default right-click action from occurring, set the Cancel argument of the provided CancelEventArgs object to true.

Examples

The following code example displays a message when you right-click the document. To use this example, run it from the ThisDocument class in a document-level project.

Private Sub DocumentBeforeRightClick()
    AddHandler Me.BeforeRightClick, AddressOf ThisDocument_BeforeRightClick
End Sub

Private Sub ThisDocument_BeforeRightClick(ByVal sender As Object, ByVal e _
    As Microsoft.Office.Tools.Word.ClickEventArgs)
    MessageBox.Show(Me.Name & " was right-clicked.")
    e.Cancel = True
End Sub
private void DocumentBeforeRightClick()
{
    this.BeforeRightClick += new Microsoft.Office.Tools.Word.ClickEventHandler(ThisDocument_BeforeRightClick);
}

void ThisDocument_BeforeRightClick(object sender, Microsoft.Office.Tools.Word.ClickEventArgs e)
{
    MessageBox.Show(this.Name + " was right-clicked.");
    e.Cancel = true;
}

.NET Framework Security

See Also

Reference

DocumentBase Class

Microsoft.Office.Tools.Word Namespace