XCommand derivative that holds info to activate a delivered IconCmd tool. More...
#include <XCommand.h>
Inheritance diagram for ApplicationRefXCommand:
Public Member Functions | |
| void | SetTreatAsPushButton (bool treatAsPushButton) |
| bool | GetTreatAsPushButton () |
 Public Member Functions inherited from XCommand | |
| void | SetCmdNumber (CommandNumber cmdNumber, WCharCP taskId, WCharCP unparsed) |
| Sets the Command Number. More... | |
| void | SetIsUserDefined (bool isUserDefined=true) |
| Marks the Command as being user created. More... | |
| void | SetJournal (bool journal) |
| Set property to journal the command for macro recording. More... | |
| bool | GetJournal () |
| Return the setting of the property that allows command to be saved for macro recording. More... | |
| Public Member Functions inherited from IXCommand | |
| BentleyStatus | ExecuteCmd (Bentley::ECN::IAUIDataContextCP instance, WCharCP unparsed) |
| Executes the command for this IXCommand. More... | |
| bool | CanExecute () const |
| Determines if the command can be executed. More... | |
| void | SetCanExecute (bool value) |
| Sets a flag for whether the command can be executed. More... | |
| void | CanExecuteChanged (bool newValue) |
| Called when the CanExecute status changes. More... | |
| bool | CanDisplay () const |
| Determines if any UI associated with this command can be displayed. More... | |
| void | SetCanDisplay (bool value) |
| Sets a flag for whether the command's UI can be displayed. More... | |
| void | CanDisplayChanged (bool newValue) |
| Called when the CanDisplay status changes. More... | |
| void | GetIconName (WStringR iconName) const |
| Gets the icon name for any UI associated with this command. More... | |
| void | GetShowExpression (WStringR expression) const |
| Gets the Named Expression controlling Show/Hide for any UI associated with this command. More... | |
| void | SetShowExpression (WCharCP expression) |
| Sets the Named Expression controlling Show/Hide for any UI associated with this command. More... | |
| bool | EvaluateShowExpression (bool defaultValue) const |
| Evaluates the Named Expression controlling Show/Hide for any UI associated with this command. More... | |
| bool | HasShowExpression () const |
| Determines if this command has a Named Expression controlling Show/Hide for any UI associate with this command. More... | |
| void | GetEnableExpression (WStringR expression) const |
| Gets the Named Expression controlling Enable/Disable for any UI associated with this command. More... | |
| void | SetEnableExpression (WCharCP expression) |
| Sets the Named Expression controlling Enable/Disable for any UI associated with this command. More... | |
| bool | EvaluateEnableExpression (bool defaultValue) const |
| Evaluates the Named Expression controlling Enable/Disable for any UI associated with this command. More... | |
| bool | HasEnableExpression () const |
| Determines if this command has a Named Expression controlling Enable/Disable for any UI associate with this command. More... | |
| void | GetToggleExpression (WStringR expression) const |
| Gets the Named Expression controlling Toggle state for any UI associated with this command. More... | |
| void | SetToggleExpression (WCharCP expression) |
| Sets the Named Expression controlling Toggle state for any UI associated with this command. More... | |
| bool | EvaluateToggleExpression (bool defaultValue) const |
| Evaluates the Named Expression controlling Toggle state for any UI associated with this command. More... | |
| bool | HasToggleExpression () const |
| Determines if this command has a Named Expression controlling Toggle state for any UI associate with this command. More... | |
| void | GetMarkExpression (WStringR expression) const |
| Gets the Named Expression controlling Menu Mark state for any UI associated with this command. More... | |
| void | SetMarkExpression (WCharCP expression) |
| Sets the Named Expression controlling Menu Mark state for any UI associated with this command. More... | |
| MenuMarkType | EvaluateMarkExpression (MenuMarkType defaultValue) const |
| Evaluates the Named Expression controlling Menu Mark state for any UI associated with this command. More... | |
| bool | HasMarkExpression () const |
| Determines if this command has a Named Expression controlling Menu Mark state for any UI associate with this command. More... | |
| void | GetUISyncEvents (WStringR expression) const |
| Gets the UISyncEvent associated with this command. More... | |
| void | SetUISyncEvents (WCharCP expression) |
| Sets the UISyncEvent associated with this command. More... | |
| void | GetFeatureTrackingId (WStringR featureTrackingId) const |
| Gets the Feature Tracking GUID associated with this command. More... | |
| void | SetFeatureTrackingId (WCharCP featureTrackingId) |
| Sets the Feature Tracking GUID associated with this command. More... | |
| UInt32 | GetAttributes () const |
| Gets the attributes associated with this command. More... | |
| void | SetAttributes (UInt32 attributes) |
| Sets the attributes associated with this command. More... | |
| UInt32 | GetAccelerator () const |
| Gets the accelerator value associated with this command. More... | |
| void | SetAccelerator (UInt32 accelerator) |
| Sets the accelerator value associated with this command. More... | |
| bool | GetAcceleratorString (WStringR accelStr) const |
| Gets the string representation of the accelerator value associated with this command. More... | |
| bool | IsAllowed () const |
| Determines if this command is allowed to execute in the given product context. More... | |
| bool | IsUserDefined () const |
| Return true if command was loaded via MS_NAMEDCOMMANDSLIST; otherwise, false. More... | |
Static Public Member Functions | |
| static ApplicationRefXCommandP | Create (CommandNumber cmdNumber, WCharCP taskid=NULL, WCharCP unparsed=NULL) |
| Static Public Member Functions inherited from XCommand | |
| static XCommandP | Create (WCharCP commandId) |
| Creates an XCommand with the given command Id. More... | |
Protected Member Functions | |
| ApplicationRefXCommand () | |
| ~ApplicationRefXCommand () | |
| virtual BentleyStatus | _ExecuteCmd (Bentley::ECN::IAUIDataContextCP instance, WCharCP unparsed) override |
| Protected Member Functions inherited from XCommand | |
| XCommand (WCharCP commandId) | |
| Constructor for an XCommand with the given command Id. More... | |
| virtual | ~XCommand () |
| XCommand destructor. More... | |
| virtual void | _SetCmdNumber (CommandNumber cmdNumber, WCharCP taskId, WCharCP unparsed) override |
| Sets the Command Number. More... | |
| virtual bool | _CanExecute () const override |
| Determines if the command can be executed. More... | |
| virtual void | _SetCanExecute (bool value) override |
| Sets a flag for whether the command can be executed. More... | |
| virtual bool | _CanDisplay () const override |
| Determines if any UI associated with this command can be displayed. More... | |
| virtual void | _SetCanDisplay (bool value) override |
| Sets a flag for whether the command's UI can be displayed. More... | |
| virtual void | _GetIconName (WStringR iconName) const override |
| Gets the icon name for any UI associated with this command. More... | |
| virtual void | _GetFeatureTrackingId (WStringR featureTrackingId) const override |
| Gets the Feature Tracking GUID associated with this command. More... | |
| virtual void | _SetFeatureTrackingId (WCharCP featureTrackingId) override |
| Sets the Feature Tracking GUID associated with this command. More... | |
| virtual void | _GetShowExpression (WStringR expression) const override |
| Gets the Named Expression controlling Show/Hide for any UI associated with this command. More... | |
| virtual void | _SetShowExpression (WCharCP expression) override |
| Sets the Named Expression controlling Show/Hide for any UI associated with this command. More... | |
| virtual bool | _EvaluateShowExpression (bool defaultValue) const override |
| Evaluates the Named Expression controlling Show/Hide for any UI associated with this command. More... | |
| virtual bool | _HasShowExpression () const override |
| Determines if this command has a Named Expression controlling Show/Hide for any UI associate with this command. More... | |
| virtual void | _GetEnableExpression (WStringR expression) const override |
| Gets the Named Expression controlling Enable/Disable for any UI associated with this command. More... | |
| virtual void | _SetEnableExpression (WCharCP expression) override |
| Sets the Named Expression controlling Enable/Disable for any UI associated with this command. More... | |
| virtual bool | _EvaluateEnableExpression (bool defaultValue) const override |
| Evaluates the Named Expression controlling Enable/Disable for any UI associated with this command. More... | |
| virtual bool | _HasEnableExpression () const override |
| Determines if this command has a Named Expression controlling Enable/Disable for any UI associate with this command. More... | |
| virtual void | _GetToggleExpression (WStringR expression) const override |
| Gets the Named Expression controlling Toggle state for any UI associated with this command. More... | |
| virtual void | _SetToggleExpression (WCharCP expression) override |
| Sets the Named Expression controlling Toggle state for any UI associated with this command. More... | |
| virtual bool | _EvaluateToggleExpression (bool defaultValue) const override |
| Evaluates the Named Expression controlling Toggle state for any UI associated with this command. More... | |
| virtual bool | _HasToggleExpression () const override |
| Determines if this command has a Named Expression controlling Toggle state for any UI associate with this command. More... | |
| virtual void | _GetMarkExpression (WStringR expression) const override |
| Gets the Named Expression controlling Menu Mark state for any UI associated with this command. More... | |
| virtual void | _SetMarkExpression (WCharCP expression) override |
| Sets the Named Expression controlling Menu Mark state for any UI associated with this command. More... | |
| virtual MenuMarkType | _EvaluateMarkExpression (MenuMarkType defaultValue) const override |
| Evaluates the Named Expression controlling Menu Mark state for any UI associated with this command. More... | |
| virtual bool | _HasMarkExpression () const override |
| Determines if this command has a Named Expression controlling Menu Mark state for any UI associate with this command. More... | |
| virtual void | _GetUISyncEvents (WStringR value) const override |
| Gets the UISyncEvent associated with this command. More... | |
| virtual void | _SetUISyncEvents (WCharCP value) override |
| Sets the UISyncEvent associated with this command. More... | |
| virtual UInt32 | _GetAttributes () const override |
| Gets the attributes associated with this command. More... | |
| virtual void | _SetAttributes (UInt32 attributes) override |
| Sets the attributes associated with this command. More... | |
| virtual UInt32 | _GetAccelerator () const override |
| Gets the accelerator value associated with this command. More... | |
| virtual void | _SetAccelerator (UInt32 accelerator) override |
| Sets the accelerator value associated with this command. More... | |
| virtual bool | _GetAcceleratorString (WStringR accelStr) const override |
| Gets the string representation of the accelerator value associated with this command. More... | |
| virtual void | _GetCmdNumber (CommandNumber &cmdNumber, WString &unparsed, WCharCP &taskId) override |
| Gets the Command Number information. More... | |
| virtual BentleyStatus | _ExecuteCmd (Bentley::ECN::IAUIDataContextCP instance) override |
| Executes the command for this XCommand. More... | |
| virtual WCharCP | _GetCommandId () const override |
| Gets the Id of this XCommand. More... | |
| virtual WString | _GetLabel () const override |
| Gets the Label for UI associated with this XCommand. More... | |
| virtual void | _SetLabel (WCharCP label) override |
| Sets the Label for UI associated with this XCommand. More... | |
| virtual WString | _GetDescription () const override |
| Gets the Description for UI associated with this XCommand. More... | |
| virtual void | _SetDescription (WCharCP description) override |
| Sets the Description for UI associated with this XCommand. More... | |
| virtual Bentley::ECN::ECImageKeyCP | _GetImageId () const override |
| Gets the Image Key for UI associated with this XCommand. More... | |
| virtual void | _SetImageId (Bentley::ECN::ECImageKeyCR key) override |
| Sets the Image Key for UI associated with this XCommand. More... | |
| virtual bool | _GetIsEnabled () const override |
| Gets whether the UI associated with this XCommand is enabled. More... | |
| virtual void | _SetIsEnabled (bool enabled) override |
| Sets whether the UI associated with this XCommand is enabled. More... | |
| virtual bool | _IsUserDefined () const override |
| Return true if command was loaded via MS_NAMEDCOMMANDSLIST; otherwise, false. More... | |
| Protected Member Functions inherited from IXCommand | |
| virtual void | _CanExecuteChanged (bool newValue) |
| Called when the CanExecute status changes. More... | |
| virtual void | _CanDisplayChanged (bool newValue) |
| Called when the CanDisplay status changes. More... | |
| virtual bool | _IsAllowed () const |
| Determines if this command is allowed to execute in the given product context. More... | |
| Protected Member Functions inherited from MstnEditAction | |
| virtual BentleyStatus | _ExecuteCmd (ECN::IAUIDataContextCP instance) override |
| virtual void | _AddToMenu (IEditActionMenu *menu) |
| void | AddToMenu (IEditActionMenu *menu) |
Additional Inherited Members | |
| Protected Attributes inherited from XCommand | |
| WString | m_commandId |
| bool | m_canExecute |
| bool | m_canDisplay |
| bool | m_isUserDefined |
| bool | m_journalCommand |
| CommandNumber | m_commandNumber |
| WString | m_commandTaskId |
| WString | m_unparsed |
| Bentley::ECN::ECImageKey | m_image |
| WString | m_label |
| WString | m_description |
| WString | m_featureTrackingId |
| WString | m_UISyncEvents |
| ExpressionUICriteria * | m_showUICriteria |
| ExpressionUICriteria * | m_enableUICriteria |
| ExpressionUICriteria * | m_toggleUICriteria |
| MarkExpressionUICriteria * | m_markUICriteria |
| UInt32 | m_accelerator |
| UInt32 | m_attributes |
Detailed Description
XCommand derivative that holds info to activate a delivered IconCmd tool.
This command is processed exactly the same as ApplicationRef tools in TaskNavigation
Constructor & Destructor Documentation
|
protected |
|
protected |
Member Function Documentation
|
overrideprotectedvirtual |
Reimplemented from XCommand.
|
static |
- Remarks
- Required Library : mdlbltin.lib
| bool GetTreatAsPushButton | ( | ) |
- Remarks
- Required Library : mdlbltin.lib
| void SetTreatAsPushButton | ( | bool | treatAsPushButton | ) |
- Remarks
- Required Library : mdlbltin.lib
The documentation for this class was generated from the following file: