Cross UI Framework PowerPlatform Command interface. More...
#include <IXCommand.h>
Public Member Functions | |
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... | |
Protected Member Functions | |
virtual BentleyStatus | _ExecuteCmd (Bentley::ECN::IAUIDataContextCP instance, WCharCP unparsed)=0 |
Executes the command for this IXCommand. More... | |
virtual void | _SetCmdNumber (CommandNumber cmdNumber, WCharCP taskId, WCharCP unparsed)=0 |
Sets the Command Number. More... | |
virtual bool | _CanExecute () const =0 |
Determines if the command can be executed. More... | |
virtual void | _SetCanExecute (bool value) |
Sets a flag for whether the command can be executed. More... | |
virtual void | _CanExecuteChanged (bool newValue) |
Called when the CanExecute status changes. More... | |
virtual bool | _CanDisplay () const =0 |
Determines if any UI associated with this command can be displayed. More... | |
virtual bool | _IsUserDefined () const |
Return true if command was loaded via MS_NAMEDCOMMANDSLIST; otherwise, false. More... | |
virtual void | _SetCanDisplay (bool value) |
Sets a flag for whether the command's UI can be displayed. More... | |
virtual void | _CanDisplayChanged (bool newValue) |
Called when the CanDisplay status changes. More... | |
virtual void | _GetIconName (WStringR iconName) const |
Gets the icon name for any UI associated with this command. More... | |
virtual void | _GetShowExpression (WStringR expression) const |
Gets the Named Expression controlling Show/Hide for any UI associated with this command. More... | |
virtual void | _SetShowExpression (WCharCP expression) |
Sets the Named Expression controlling Show/Hide for any UI associated with this command. More... | |
virtual bool | _EvaluateShowExpression (bool defaultValue) const |
Evaluates the Named Expression controlling Show/Hide for any UI associated with this command. More... | |
virtual bool | _HasShowExpression () const |
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 |
Gets the Named Expression controlling Enable/Disable for any UI associated with this command. More... | |
virtual void | _SetEnableExpression (WCharCP expression) |
Sets the Named Expression controlling Enable/Disable for any UI associated with this command. More... | |
virtual bool | _EvaluateEnableExpression (bool defaultValue) const |
Evaluates the Named Expression controlling Enable/Disable for any UI associated with this command. More... | |
virtual bool | _HasEnableExpression () const |
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 |
Gets the Named Expression controlling Toggle state for any UI associated with this command. More... | |
virtual void | _SetToggleExpression (WCharCP expression) |
Sets the Named Expression controlling Toggle state for any UI associated with this command. More... | |
virtual bool | _EvaluateToggleExpression (bool defaultValue) const |
Evaluates the Named Expression controlling Toggle state for any UI associated with this command. More... | |
virtual bool | _HasToggleExpression () const |
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 |
Gets the Named Expression controlling Menu Mark state for any UI associated with this command. More... | |
virtual void | _SetMarkExpression (WCharCP expression) |
Sets the Named Expression controlling Menu Mark state for any UI associated with this command. More... | |
virtual MenuMarkType | _EvaluateMarkExpression (MenuMarkType defaultValue) const |
Evaluates the Named Expression controlling Menu Mark state for any UI associated with this command. More... | |
virtual bool | _HasMarkExpression () const |
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 |
Gets the UISyncEvent associated with this command. More... | |
virtual void | _SetUISyncEvents (WCharCP value) |
Sets the UISyncEvent associated with this command. More... | |
virtual void | _GetFeatureTrackingId (WStringR featureTrackingId) const |
Gets the Feature Tracking GUID associated with this command. More... | |
virtual void | _SetFeatureTrackingId (WCharCP featureTrackingId) |
Sets the Feature Tracking GUID associated with this command. More... | |
virtual UInt32 | _GetAttributes () const |
Gets the attributes associated with this command. More... | |
virtual void | _SetAttributes (UInt32 attributes) |
Sets the attributes associated with this command. More... | |
virtual UInt32 | _GetAccelerator () const |
Gets the accelerator value associated with this command. More... | |
virtual void | _SetAccelerator (UInt32 accelerator) |
Sets the accelerator value associated with this command. More... | |
virtual bool | _GetAcceleratorString (WStringR accelStr) const |
Gets the string representation of the accelerator value associated with this command. More... | |
virtual bool | _IsAllowed () const |
Determines if this command is allowed to execute in the given product context. More... | |
![]() | |
virtual bool | _GetIsEnabled () const |
virtual void | _GetCmdNumber (CommandNumber &cmdNumber, WString &unparsed, WCharCP &taskId) |
virtual BentleyStatus | _ExecuteCmd (ECN::IAUIDataContextCP instance) override |
virtual void | _AddToMenu (IEditActionMenu *menu) |
void | AddToMenu (IEditActionMenu *menu) |
Cross UI Framework PowerPlatform Command interface.
|
protectedpure virtual |
Determines if any UI associated with this command can be displayed.
Implemented in XCommand.
|
protectedvirtual |
Called when the CanDisplay status changes.
[in] | newValue | true if the command's UI can be displayed; otherwise, false. |
|
protectedpure virtual |
Determines if the command can be executed.
Implemented in XCommand.
|
protectedvirtual |
Called when the CanExecute status changes.
[in] | newValue | true if the command can be executed; otherwise, false. |
|
protectedvirtual |
Evaluates the Named Expression controlling Enable/Disable for any UI associated with this command.
[in] | defaultValue | true if the command's UI should be enabled by default; otherwise, false. |
Reimplemented in XCommand.
|
protectedvirtual |
Evaluates the Named Expression controlling Menu Mark state for any UI associated with this command.
[in] | defaultValue | The default MenuMarkType |
Reimplemented in XCommand.
|
protectedvirtual |
Evaluates the Named Expression controlling Show/Hide for any UI associated with this command.
[in] | defaultValue | true if the command's UI should be shown by default; otherwise, false. |
Reimplemented in XCommand.
|
protectedvirtual |
Evaluates the Named Expression controlling Toggle state for any UI associated with this command.
[in] | defaultValue | true if the command's UI should be toggled by default; otherwise, false. |
Reimplemented in XCommand.
|
protectedpure virtual |
Executes the command for this IXCommand.
[in] | instance | The data context for this execute invocation |
[in] | unparsed | The string parameter for this execute invocation |
Implemented in ApplicationRefXCommand, UserKeyinXCommand, and XCommand.
|
protectedvirtual |
Gets the accelerator value associated with this command.
Reimplemented in XCommand.
|
protectedvirtual |
Gets the string representation of the accelerator value associated with this command.
[out] | accelStr | the string representation of the accelerator. |
Reimplemented in XCommand.
|
protectedvirtual |
Gets the attributes associated with this command.
Reimplemented in XCommand.
|
protectedvirtual |
Gets the Named Expression controlling Enable/Disable for any UI associated with this command.
[out] | expression | Receives the Named Expression. |
Reimplemented in XCommand.
|
protectedvirtual |
Gets the Feature Tracking GUID associated with this command.
[out] | featureTrackingId | Feature Tracking GUID. |
Reimplemented in XCommand.
|
protectedvirtual |
Gets the icon name for any UI associated with this command.
[out] | iconName | Receives the icon name. |
Reimplemented in XCommand.
|
protectedvirtual |
Gets the Named Expression controlling Menu Mark state for any UI associated with this command.
[out] | expression | Receives the Named Expression. |
Reimplemented in XCommand.
|
protectedvirtual |
Gets the Named Expression controlling Show/Hide for any UI associated with this command.
[out] | expression | Receives the Named Expression. |
Reimplemented in XCommand.
|
protectedvirtual |
Gets the Named Expression controlling Toggle state for any UI associated with this command.
[out] | expression | Receives the Named Expression. |
Reimplemented in XCommand.
|
protectedvirtual |
Gets the UISyncEvent associated with this command.
[out] | value | Receives the UISyncEvent. |
Reimplemented in XCommand.
|
protectedvirtual |
Determines if this command has a Named Expression controlling Enable/Disable for any UI associate with this command.
Reimplemented in XCommand.
|
protectedvirtual |
Determines if this command has a Named Expression controlling Menu Mark state for any UI associate with this command.
Reimplemented in XCommand.
|
protectedvirtual |
Determines if this command has a Named Expression controlling Show/Hide for any UI associate with this command.
Reimplemented in XCommand.
|
protectedvirtual |
Determines if this command has a Named Expression controlling Toggle state for any UI associate with this command.
Reimplemented in XCommand.
|
protectedvirtual |
Determines if this command is allowed to execute in the given product context.
|
protectedvirtual |
Return true if command was loaded via MS_NAMEDCOMMANDSLIST; otherwise, false.
Reimplemented in XCommand.
|
protectedvirtual |
Sets the accelerator value associated with this command.
[in] | accelerator | the accelerator value associated with this command |
Reimplemented in XCommand.
|
protectedvirtual |
Sets the attributes associated with this command.
[in] | attributes | the attributes associated with this command |
Reimplemented in XCommand.
|
protectedvirtual |
Sets a flag for whether the command's UI can be displayed.
[in] | value | true if the command's UI can be displayed; otherwise, false. |
Reimplemented in XCommand.
|
protectedvirtual |
Sets a flag for whether the command can be executed.
[in] | value | true if the command can be executed; otherwise, false. |
Reimplemented in XCommand.
|
protectedpure virtual |
Sets the Command Number.
[in] | cmdNumber | The command number |
[in] | taskId | The Id of the task owning the Command Number |
[in] | unparsed | The string parameter for this command |
Implemented in XCommand.
|
protectedvirtual |
Sets the Named Expression controlling Enable/Disable for any UI associated with this command.
[in] | expression | the Named Expression controlling Enable/Disable. |
Reimplemented in XCommand.
|
protectedvirtual |
Sets the Feature Tracking GUID associated with this command.
[in] | featureTrackingId | Feature Tracking GUID. |
Reimplemented in XCommand.
|
protectedvirtual |
Sets the Named Expression controlling Menu Mark state for any UI associated with this command.
[in] | expression | the Named Expression controlling Menu Mark state. |
Reimplemented in XCommand.
|
protectedvirtual |
Sets the Named Expression controlling Show/Hide for any UI associated with this command.
[in] | expression | the Named Expression controlling Show/Hide. |
Reimplemented in XCommand.
|
protectedvirtual |
Sets the Named Expression controlling Toggle state for any UI associated with this command.
[in] | expression | the Named Expression controlling Toggle state. |
Reimplemented in XCommand.
|
protectedvirtual |
Sets the UISyncEvent associated with this command.
[in] | value | The UISyncEvent to be associated with this command. |
Reimplemented in XCommand.
bool CanDisplay | ( | ) | const |
Determines if any UI associated with this command can be displayed.
void CanDisplayChanged | ( | bool | newValue | ) |
Called when the CanDisplay status changes.
[in] | newValue | true if the command's UI can be displayed; otherwise, false. |
bool CanExecute | ( | ) | const |
Determines if the command can be executed.
void CanExecuteChanged | ( | bool | newValue | ) |
Called when the CanExecute status changes.
[in] | newValue | true if the command can be executed; otherwise, false. |
bool EvaluateEnableExpression | ( | bool | defaultValue | ) | const |
Evaluates the Named Expression controlling Enable/Disable for any UI associated with this command.
[in] | defaultValue | true if the command's UI should be enabled by default; otherwise, false. |
MenuMarkType EvaluateMarkExpression | ( | MenuMarkType | defaultValue | ) | const |
Evaluates the Named Expression controlling Menu Mark state for any UI associated with this command.
[in] | defaultValue | The default MenuMarkType |
bool EvaluateShowExpression | ( | bool | defaultValue | ) | const |
Evaluates the Named Expression controlling Show/Hide for any UI associated with this command.
[in] | defaultValue | true if the command's UI should be shown by default; otherwise, false. |
bool EvaluateToggleExpression | ( | bool | defaultValue | ) | const |
Evaluates the Named Expression controlling Toggle state for any UI associated with this command.
[in] | defaultValue | true if the command's UI should be toggled by default; otherwise, false. |
BentleyStatus ExecuteCmd | ( | Bentley::ECN::IAUIDataContextCP | instance, |
WCharCP | unparsed | ||
) |
Executes the command for this IXCommand.
[in] | instance | The data context for this execute invocation |
[in] | unparsed | The string parameter for this execute invocation |
UInt32 GetAccelerator | ( | ) | const |
Gets the accelerator value associated with this command.
bool GetAcceleratorString | ( | WStringR | accelStr | ) | const |
Gets the string representation of the accelerator value associated with this command.
[out] | accelStr | the string representation of the accelerator. |
UInt32 GetAttributes | ( | ) | const |
Gets the attributes associated with this command.
void GetEnableExpression | ( | WStringR | expression | ) | const |
Gets the Named Expression controlling Enable/Disable for any UI associated with this command.
[out] | expression | Receives the Named Expression. |
void GetFeatureTrackingId | ( | WStringR | featureTrackingId | ) | const |
Gets the Feature Tracking GUID associated with this command.
[out] | featureTrackingId | Feature Tracking GUID. |
void GetIconName | ( | WStringR | iconName | ) | const |
Gets the icon name for any UI associated with this command.
[out] | iconName | Receives the icon name. |
void GetMarkExpression | ( | WStringR | expression | ) | const |
Gets the Named Expression controlling Menu Mark state for any UI associated with this command.
[out] | expression | Receives the Named Expression. |
void GetShowExpression | ( | WStringR | expression | ) | const |
Gets the Named Expression controlling Show/Hide for any UI associated with this command.
[out] | expression | Receives the Named Expression. |
void GetToggleExpression | ( | WStringR | expression | ) | const |
Gets the Named Expression controlling Toggle state for any UI associated with this command.
[out] | expression | Receives the Named Expression. |
void GetUISyncEvents | ( | WStringR | expression | ) | const |
Gets the UISyncEvent associated with this command.
[out] | expression | Receives the UISyncEvent. |
bool HasEnableExpression | ( | ) | const |
Determines if this command has a Named Expression controlling Enable/Disable for any UI associate with this command.
bool HasMarkExpression | ( | ) | const |
Determines if this command has a Named Expression controlling Menu Mark state for any UI associate with this command.
bool HasShowExpression | ( | ) | const |
Determines if this command has a Named Expression controlling Show/Hide for any UI associate with this command.
bool HasToggleExpression | ( | ) | const |
Determines if this command has a Named Expression controlling Toggle state for any UI associate with this command.
bool IsAllowed | ( | ) | const |
Determines if this command is allowed to execute in the given product context.
bool IsUserDefined | ( | ) | const |
Return true if command was loaded via MS_NAMEDCOMMANDSLIST; otherwise, false.
void SetAccelerator | ( | UInt32 | accelerator | ) |
Sets the accelerator value associated with this command.
[in] | accelerator | the accelerator value associated with this command |
void SetAttributes | ( | UInt32 | attributes | ) |
Sets the attributes associated with this command.
[in] | attributes | the attributes associated with this command |
void SetCanDisplay | ( | bool | value | ) |
Sets a flag for whether the command's UI can be displayed.
[in] | value | true if the command's UI can be displayed; otherwise, false. |
void SetCanExecute | ( | bool | value | ) |
Sets a flag for whether the command can be executed.
[in] | value | true if the command can be executed; otherwise, false. |
void SetEnableExpression | ( | WCharCP | expression | ) |
Sets the Named Expression controlling Enable/Disable for any UI associated with this command.
[in] | expression | the Named Expression controlling Enable/Disable. |
void SetFeatureTrackingId | ( | WCharCP | featureTrackingId | ) |
Sets the Feature Tracking GUID associated with this command.
[in] | featureTrackingId | Feature Tracking GUID. |
void SetMarkExpression | ( | WCharCP | expression | ) |
Sets the Named Expression controlling Menu Mark state for any UI associated with this command.
[in] | expression | the Named Expression controlling Menu Mark state. |
void SetShowExpression | ( | WCharCP | expression | ) |
Sets the Named Expression controlling Show/Hide for any UI associated with this command.
[in] | expression | the Named Expression controlling Show/Hide. |
void SetToggleExpression | ( | WCharCP | expression | ) |
Sets the Named Expression controlling Toggle state for any UI associated with this command.
[in] | expression | the Named Expression controlling Toggle state. |
void SetUISyncEvents | ( | WCharCP | expression | ) |
Sets the UISyncEvent associated with this command.
[in] | expression | The UISyncEvent to be associated with this command. |