Reflection .NET API
Attachmate.Reflection.Emulation.OpenSystems Assembly / Attachmate.Reflection.Emulation.OpenSystems Namespace / ContextMenus Class / Remove Method
The descriptive name of the menu to remove


In This Topic
    Remove Method (ContextMenus)
    In This Topic
    Removes a context menu from this session document
    Syntax
    'Declaration
     
    
    <SuppressMessageAttribute("Microsoft.Performance", 
       "CA1820:TestForEmptyStringsUsingStringLength", 
       Justification="Need only check for empty, not null. Different exceptions thrown for each case.")>
    Public Function Remove( _
       ByVal name As String _
    ) As Boolean
    'Usage
     
    
    Dim instance As ContextMenus
    Dim name As String
    Dim value As Boolean
     
    value = instance.Remove(name)
    [SuppressMessage("Microsoft.Performance", 
       "CA1820:TestForEmptyStringsUsingStringLength", 
       Justification="Need only check for empty, not null. Different exceptions thrown for each case.")]
    public bool Remove( 
       string name
    )

    Parameters

    name
    The descriptive name of the menu to remove

    Return Value

    True if the remove was successful, false if the menu name could not be found or an error occurred
    Exceptions
    ExceptionDescription
    If the name passed is null
    If the name passed corresponds to the default menu, which cannot be deleted. This can be represented by an empty string, or the ContextMenu.DefaultMenuName constant
    If the ContextMenus object is not available or in an error state
    See Also