GetContextMenuArgs Class

Autodesk.DataManagement.Client.Framework.Vault.Forms›Autodesk.DataManagement.Client.Framework.Vault.Forms.Currency

Event args that are fired when a workflow is requesting a context menu for a particular entity. The responder to this event should populate the MenuContents property in order to supply a custom menu.

Syntax

public class GetContextMenuArgs : System.EventArgs

Public Class GetContextMenuArgs
   Inherits System.EventArgs

Constructors

Name	Description
GetContextMenuArgs

Properties

Name	Description
ClickedEntity	Gets the entity that was clicked on. This may or may not be one of the selected entities
InSelection	Gets whether or not the click that triggered the context menu was a click on an object that was already selected
InWhiteSpace	Gets whether or not the click that triggered the context menu was a click in white space or a part of the control content
MenuContents	Gets or sets the current contents of the context menu. MenuItems can be added or removed from this list to customize the context menu.
MouseLocation	Gets the mouse coordinates of where the right-click occurred
PropDef	Gets the property associated with the column that was clicked on. This can be null
ReplacementMenu	Gets or sets a replacement menu. If a replacement menu is specified, it will be used instead of MenuContents. The replacement menu is only used if the event is not handled.
SelectedEntities	Gets the list of selected entities.
Tag	Custom information to include with the context menu. Used internally by the Autodesk.DataManagement.Client.Framework.Vault.Forms.Controls.VaultTreeControl.

Methods

Name	Description
AddMenu	Adds a new menu item to the end of the current list of menu items
InsertMenu	Adds a new menu item to the top of the current list of menu items

Fields

Name	Description
Handled	Gets or sets whether this event has been handled. If false, then the object that fired the event will perform the default functionality

Returned By

Where you get a GetContextMenuArgs — members that return one.

Inheritance Hierarchy

System.Object
System.EventArgs
Autodesk.DataManagement.Client.Framework.Vault.Forms.Currency.GetContextMenuArgs