ActionBase Members
The base class for Actions.Fields
| Name | Description |
|---|---|
| AnyCaption | Specifies the caption for the ActionBase.TargetViewId property value which means “Any view ID”. By default, this field value is set to “Any”. |
| RequireMultipleObjectsContext | Returns a context for enabling/disabling the Action whose ActionBase.SelectionDependencyType property is set to RequireMultipleObjects. Used for the Action’s ActionBase.Enabled list item that has the true value, if one or more objects are selected in the current View, and false, if no object is selected. |
| RequireSingleObjectContext | Returns a context for enabling/disabling the Action whose ActionBase.SelectionDependencyType property is set to RequireSingleObjects. Used for the Action’s ActionBase.Enabled list item that has the true value, if a single object is selected in the current View, and false, if more than one object is selected. |
Properties
| Name | Description |
|---|---|
| ActionMeaning | Specifies whether an Action is represented by an accept, cancel or ordinal button in a Window Forms application’s pop-up Windows. |
| Active | Gets a collection of reason/value pairs used to determine or change the Action‘s active state. The resulting state determines the Action’s visibility. |
| Application | Provides access to an XafApplication object that can be used to manage an application. |
| CanRaiseEvents protected | Gets a value indicating whether the component can raise an event. Inherited from Component. |
| Caption | Specifies an Action‘s caption. |
| Category | Specifies an Action‘s category. |
| ConfirmationMessage | Specifies the confirmation message displayed when an end-user executes an Action. |
| Container | Gets the IContainer that contains the Component. Inherited from Component. |
| Controller | Provides access to an Action‘s Controller. |
| Data | For internal use. |
| DesignMode protected | Gets a value that indicates whether the Component is currently in design mode. Inherited from Component. |
| DiagnosticInfo | Specifies information on an Action. This information is appended to the information on the remaining Actions and their Controllers and displayed via the DiagnosticInfo Action. |
| Enabled | Provides access to a collection of key/value pairs used to determine an Action‘s enabled/disabled state. A Disabled Action is visible in the UI, but it is grayed out and cannot be executed. |
| Events protected | Gets the list of event handlers that are attached to this Component. Inherited from Component. |
| HasImage | Indicates whether an Action has an image assigned to it. |
| Id | Specifies an Action‘s identifier. |
| ImageName | Specifies a name of the image displayed for an Action. |
| IsDisposed | Gets a value indicating whether an Action has been disposed of. |
| IsExecuting | For internal use. |
| LockCount | Indicates the count of the ActionBase.BeginUpdate method calls. |
| Model | Gets the Action‘s settings. |
| PaintStyle | Specifies the Action‘s paint style. |
| QuickAccess | Specifies whether the current Action is accessible via the Quick Access Toolbar (this toolbar is available when the Ribbon UI is used). |
| SelectionContext | Specifies a context of an Action‘s execution. |
| SelectionDependencyType | Specifies a context for enabling an Action. |
| Shortcut | Defines the keyboard shortcut used to execute the current Action. Has effect in WinForms applications only. |
| Site | Gets or sets the ISite of the Component. Inherited from Component. |
| Tag | Provides access to the object that contains data about the Action. |
| TargetObjectsCriteria | Specifies a logical expression (criteria) for enabling an Action. |
| TargetObjectsCriteriaMode | Specifies whether all the currently selected objects must satisfy the ActionBase.TargetObjectsCriteria criteria to make an Action enabled. |
| TargetObjectType | Specifies the type of the object(s) that must be represented by the current View to provide an Action activation. |
| TargetViewId | Specifies the identifier of the View for which the Action is activated, or a semicolon-separated list of identifiers if the Action targets multiple Views. |
| TargetViewNesting | Specifies whether the View, for which an Action is intended, must be root, nested or any. |
| TargetViewType | Specifies the type of the View, for which an Action is intended. |
| TestName | For internal use only. |
| ToolTip | Specifies a tooltip for an Action. |
| TypeOfView | Specifies the type of the View for which an Action is intended. |
Methods
| Name | Description |
|---|---|
| AssignFrom(ActionBase) | Shares a specified Action’s settings to the current Action. |
| AssignInfo(IModelAction) | Applies settings stored in the specified Application Model’s node to the current Action. |
| BeginUpdate() | Prevents an Action from being updated until the ActionBase.EndUpdate method is called. |
| Dispose() | Releases all resources used by the Component. Inherited from Component. |
| EndUpdate() | Unlocks an Action after a call to the ActionBase.BeginUpdate method, and causes an immediate update. |
| Equals(Object, Object) static | Determines whether the specified object instances are considered equal. Inherited from Object. |
| Equals(Object) | Determines whether the specified object is equal to the current object. Inherited from Object. |
| GetFormattedConfirmationMessage() | Returns a formatted confirmation message displayed when executing an Action. |
| GetHashCode() | Serves as the default hash function. Inherited from Object. |
| GetLifetimeService() | Retrieves the current lifetime service object that controls the lifetime policy for this instance. Inherited from MarshalByRefObject. |
| GetService(Type) protected | Returns an object that represents a service provided by the Component or by its Container. Inherited from Component. |
| GetTotalToolTip() | Returns the Action‘s total tooltip. Intended for internal use. |
| GetTotalToolTip(String) | Returns the Action‘s total tooltip. Intended for internal use. |
| GetType() | Gets the Type of the current instance. Inherited from Object. |
| InitializeLifetimeService() | Obtains a lifetime service object to control the lifetime policy for this instance. Inherited from MarshalByRefObject. |
| MemberwiseClone() protected | Creates a shallow copy of the current Object. Inherited from Object. |
| MemberwiseClone(Boolean) protected | Creates a shallow copy of the current MarshalByRefObject object. Inherited from MarshalByRefObject. |
| RaiseCustomizeControl(Object) | For internal use. |
| ReferenceEquals(Object, Object) static | Determines whether the specified Object instances are the same instance. Inherited from Object. |
| ResetId() | Restores an Action‘s ActionBase.Id. |
| ToString() | Returns an Action‘s textual representation. |
Events
| Name | Description |
|---|---|
| Changed | Occurs after one of the current ActionBase object’s properties has been changed. |
| CustomGetFormattedConfirmationMessage | Occurs when the ActionBase.GetFormattedConfirmationMessage method is executed. |
| CustomGetTotalTooltip | Occurs when an Action‘s ToolTip is calculated. |
| CustomizeCaption static | |
| CustomizeControl | Fires after the control is initialized. Allows you to customize the control. |
| Disposed | Occurs when the component is disposed by a call to the Dispose() method. Inherited from Component. |
| Disposing | Occurs when disposing of an Action. |
| ExecuteCanceled | Occurs after execution of the Action has been cancelled. |
| ExecuteCompleted | Occurs after all actions implemented in the Execute, ActionBase.Executed and ActionBase.ProcessCreatedView event handlers have been performed. |
| Executed | Occurs after executing an Action. |
| Executing | Occurs before an end-user performs the operation that leads to raising an Action‘s Execute event. |
| HandleException | For internal use only. |
| ProcessCreatedView | Occurs after the ActionBase.Executed event. |
See Also