Micro Focus Content Manager SDK 10.1
TRIM.SDK.MenuPopup Class Reference

MenuPopup : This class is a derived MenuItem class that represents a popup submenu within in a context menu More...

Inheritance diagram for TRIM.SDK.MenuPopup:
TRIM.SDK.MenuItem TRIM.SDK.TrimSDKObject

Public Member Functions

System.Collections.IEnumerator GetEnumerator ()
 
 MenuPopup (Database forDatabase, MenuPopupIds standardPopupId)
 constructs a simple popup definition to allow it to be saved as part of a WebClientCommandBarUserOptions config setting More...
 
MenuItem getItem (int idx)
 
void AddItem (MenuItem newItem)
 
void InsertItem (MenuItem newItem, int atIndex)
 
- Public Member Functions inherited from TRIM.SDK.TrimSDKObject
 TrimSDKObject ()
 

Static Public Member Functions

static MenuPopup GetMenuForTrimObject (Database forDatabase, BaseObjectTypes objectType)
 Gets a MenuPopup for the specified TRIM Object, using the supplied database for captioning/licensing More...
 
static MenuPopup GetMenuForTrimObject (Database forDatabase, BaseObjectTypes objectType, MenuPopupCommandEnabler pEnablerDelegate)
 Gets a MenuPopup for the specified TRIM Object, using the supplied database for captioning/licensing More...
 
static MenuPopup CreateCustomPopupMenu (Database forDatabase, BaseObjectTypes forObjectType, string popupId, string popupCaption)
 

Properties

override MenuItem.MenuItemTypes MenuItemType [get]
 
MenuPopupIds PopupId [get]
 Gets a MenuPopupIds enumerated value defining one of the standard popup menus defined in TRIM. More...
 
string CustomPopupId [get]
 Gets a string defining a custom-defined popup More...
 
string MenuText [get]
 
int ItemCount [get]
 
- Properties inherited from TRIM.SDK.MenuItem
virtual MenuItem.MenuItemTypes MenuItemType [get]
 
virtual Icons Icon [get]
 Gets the identifier of the TRIM icon associated with this command. More...
 
- Properties inherited from TRIM.SDK.TrimSDKObject
string ErrorMessage [get]
 All TRIM SDK objects have an ErrorMessage property which can be used to examine any error that may have occurred in the most recent method call. More...
 
TrimException Error [get]
 All TRIM SDK objects have an Error property which can be used to examine any error that may have occurred in the most recent method call. More...
 

Additional Inherited Members

- Public Types inherited from TRIM.SDK.MenuItem
enum class  MenuItemTypes { MenuItemCommand , MenuItemPopup , MenuItemCustomPopup , MenuItemSeparator }
 

Detailed Description

MenuPopup : This class is a derived MenuItem class that represents a popup submenu within in a context menu

Constructor & Destructor Documentation

◆ MenuPopup()

TRIM.SDK.MenuPopup.MenuPopup ( Database  forDatabase,
MenuPopupIds  standardPopupId 
)

constructs a simple popup definition to allow it to be saved as part of a WebClientCommandBarUserOptions config setting

Member Function Documentation

◆ AddItem()

void TRIM.SDK.MenuPopup.AddItem ( MenuItem  newItem)

◆ CreateCustomPopupMenu()

static MenuPopup TRIM.SDK.MenuPopup.CreateCustomPopupMenu ( Database  forDatabase,
BaseObjectTypes  forObjectType,
string  popupId,
string  popupCaption 
)
static

◆ GetEnumerator()

System.Collections.IEnumerator TRIM.SDK.MenuPopup.GetEnumerator ( )

◆ getItem()

MenuItem TRIM.SDK.MenuPopup.getItem ( int  idx)

◆ GetMenuForTrimObject() [1/2]

static MenuPopup TRIM.SDK.MenuPopup.GetMenuForTrimObject ( Database  forDatabase,
BaseObjectTypes  objectType 
)
static

Gets a MenuPopup for the specified TRIM Object, using the supplied database for captioning/licensing

◆ GetMenuForTrimObject() [2/2]

static MenuPopup TRIM.SDK.MenuPopup.GetMenuForTrimObject ( Database  forDatabase,
BaseObjectTypes  objectType,
MenuPopupCommandEnabler  pEnablerDelegate 
)
static

Gets a MenuPopup for the specified TRIM Object, using the supplied database for captioning/licensing

◆ InsertItem()

void TRIM.SDK.MenuPopup.InsertItem ( MenuItem  newItem,
int  atIndex 
)

Property Documentation

◆ CustomPopupId

string TRIM.SDK.MenuPopup.CustomPopupId
get

Gets a string defining a custom-defined popup

◆ ItemCount

int TRIM.SDK.MenuPopup.ItemCount
get

◆ MenuItemType

override MenuItem.MenuItemTypes TRIM.SDK.MenuPopup.MenuItemType
get

◆ MenuText

string TRIM.SDK.MenuPopup.MenuText
get

◆ PopupId

MenuPopupIds TRIM.SDK.MenuPopup.PopupId
get

Gets a MenuPopupIds enumerated value defining one of the standard popup menus defined in TRIM.