MaxCustomControls::ICuiAction Interface Reference

---

Detailed Description

This base interface should be implemented if the user wants to expose a new CUI action whose entry-point is a .NET assembly.

This is actually the root interface of two other important interfaces - ICuiActionExecuteNotifier and ICuiDockableContent. By implementing those interfaces in a DLL that targets the bin folder of a 3ds Max install, you will see them appear in the standard CUI dialog under the category specified below.

See also:

CuiActionCommandAdapter, ICuiDockableContent

Inheritance diagram for MaxCustomControls::ICuiAction:

List of all members.

Properties
String	ActionText [get]
	The name of the action - to be used when browsing a list of actions.
String	Category [get]
	The name of the category to which this action should belong.
String	InternalActionText [get]
	This is internal text that is not used in the user interface anywhere, but is used to uniquely identify the action.
String	InternalCategory [get]
	This is internal text that is not used in the user interface anywhere, but is used to uniquely identify the action category.
String	ButtonText [get]
	The text that will be used if the action is instantiated in a toolbar button.
String	MenuText [get]
	The text that will be used if the action is instantiated in the application menu or a quad-menu.
bool	IsVisible [get]
	Marks whether this action should appear in a menu.
bool	IsEnabled [get]
	Marks when this action should be available for use.
bool	IsChecked [get]
	Implement this method if the action is "checked" (which means that the UI will show the button as pressed, or the menu item as checked.)

---

Property Documentation

String MaxCustomControls::ICuiAction::ActionText [get]

The name of the action - to be used when browsing a list of actions.

This is equivalent to DescriptionText in the ActionItem C++ SDK class. This property should be localized.

Implemented in MaxCustomControls::CuiActionCommandAdapter, and MaxCustomControls::CuiDockableContentAdapter.

String MaxCustomControls::ICuiAction::Category [get]

The name of the category to which this action should belong.

When dynamically loading actions, a category will be created if an action is declared to be part of a, as of yet, undeclared category. This property should be localized.

Implemented in MaxCustomControls::CuiActionCommandAdapter, and MaxCustomControls::CuiDockableContentAdapter.

String MaxCustomControls::ICuiAction::InternalActionText [get]

This is internal text that is not used in the user interface anywhere, but is used to uniquely identify the action.

This text should be identical across all localized versions of the product.

Normally you would have the ActionText property refer to a localized resource entry, while this text can and should be hardcoded into the code.

Implemented in MaxCustomControls::CuiActionCommandAdapter, and MaxCustomControls::CuiDockableContentAdapter.

String MaxCustomControls::ICuiAction::InternalCategory [get]

This is internal text that is not used in the user interface anywhere, but is used to uniquely identify the action category.

This text should be identical across all localized versions of the product.

Normally you would have the Category property refer to a localized resource entry, while this text can and should be hardcoded into the code.

Implemented in MaxCustomControls::CuiActionCommandAdapter, and MaxCustomControls::CuiDockableContentAdapter.

String MaxCustomControls::ICuiAction::ButtonText [get]

The text that will be used if the action is instantiated in a toolbar button.

Equivalent to ActionItem::ButtonText() in the C++ SDK. This property should be localized.

Implemented in MaxCustomControls::CuiActionCommandAdapter, and MaxCustomControls::CuiDockableContentAdapter.

String MaxCustomControls::ICuiAction::MenuText [get]

The text that will be used if the action is instantiated in the application menu or a quad-menu.

Equivalent to ActionItem::MenuText() in the C++ SDK. This property should be localized.

Implemented in MaxCustomControls::CuiActionCommandAdapter, and MaxCustomControls::CuiDockableContentAdapter.

bool MaxCustomControls::ICuiAction::IsVisible [get]

Marks whether this action should appear in a menu.

This condition is evaluated whenever a menu is shown - meaning the result can be dynamic.

Implemented in MaxCustomControls::CuiActionCommandAdapter, and MaxCustomControls::CuiDockableContentAdapter.

bool MaxCustomControls::ICuiAction::IsEnabled [get]

Marks when this action should be available for use.

This condition is evaluated whenever a menu is shown - meaning the result can be dynamic. If False, an item will appear "grayed out".

Implemented in MaxCustomControls::CuiActionCommandAdapter, and MaxCustomControls::CuiDockableContentAdapter.

bool MaxCustomControls::ICuiAction::IsChecked [get]

Implement this method if the action is "checked" (which means that the UI will show the button as pressed, or the menu item as checked.)

Implemented in MaxCustomControls::CuiActionCommandAdapter, and MaxCustomControls::CuiDockableContentAdapter.