ParametrizedAction Members
Represents a Parametrized Action.Constructors
| Name | Description |
|---|---|
| ParametrizedAction() | Creates a new Parametrized Action. |
| ParametrizedAction(Controller, String, PredefinedCategory, Type) | Initializes a new instance of the ParametrizedAction class. |
| ParametrizedAction(Controller, String, String, Type) | Initializes a new instance of the ParametrizedAction class. |
| ParametrizedAction(IContainer) | Creates a new Parametrized Action and initializes its container. |
Fields
| Name | Description |
|---|---|
| AnyCaption static | Specifies the caption for the ActionBase.TargetViewId property value which means “Any view ID”. By default, this field value is set to “Any”. Inherited from ActionBase. |
| RequireMultipleObjectsContext static | 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. Inherited from ActionBase. |
| RequireSingleObjectContext static | 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. Inherited from ActionBase. |
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. Inherited from ActionBase. |
| 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. Inherited from ActionBase. |
| Application | Provides access to an XafApplication object that can be used to manage an application. Inherited from ActionBase. |
| CanRaiseEvents protected | Gets a value indicating whether the component can raise an event. Inherited from Component. |
| Caption | Specifies an Action‘s caption. Inherited from ActionBase. |
| Category | Specifies an Action‘s category. Inherited from ActionBase. |
| ConfirmationMessage | Specifies the confirmation message displayed when an end-user executes an Action. Inherited from ActionBase. |
| Container | Gets the IContainer that contains the Component. Inherited from Component. |
| Controller | Provides access to an Action‘s Controller. Inherited from ActionBase. |
| Data | For internal use. Inherited from ActionBase. |
| 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. Inherited from ActionBase. |
| 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. Inherited from ActionBase. |
| 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. Inherited from ActionBase. |
| Id | Specifies an Action‘s identifier. Inherited from ActionBase. |
| ImageName | Specifies a name of the image displayed for an Action. Inherited from ActionBase. |
| IsDisposed | Gets a value indicating whether an Action has been disposed of. Inherited from ActionBase. |
| IsDisposing | Inherited from ActionBase. |
| IsExecuting | For internal use. Inherited from ActionBase. |
| LockCount | Indicates the count of the ActionBase.BeginUpdate method calls. Inherited from ActionBase. |
| Model | Gets the Action‘s settings. Inherited from ActionBase. |
| NullValuePrompt | Specifies the default text that is displayed in the Parametrized Action’s control. |
| PaintStyle | Specifies the Action‘s paint style. Inherited from ActionBase. |
| QuickAccess | Specifies whether the current Action is accessible via the Quick Access Toolbar (this toolbar is available when the Ribbon UI is used). Inherited from ActionBase. |
| SelectionContext | Specifies a context of an Action‘s execution. Inherited from ActionBase. |
| SelectionDependencyType | Specifies a context for enabling an Action. Inherited from ActionBase. |
| ShortCaption | Specifies a caption of the button attached to a Parametrized Action’s editor. |
| Shortcut | Defines the keyboard shortcut used to execute the current Action. Has effect in WinForms applications only. Inherited from ActionBase. |
| Site | Gets or sets the ISite of the Component. Inherited from Component. |
| Tag | Provides access to the object that contains data about the Action. Inherited from ActionBase. |
| TargetObjectsCriteria | Specifies a logical expression (criteria) for enabling an Action. Inherited from ActionBase. |
| TargetObjectsCriteriaMode | Specifies whether all the currently selected objects must satisfy the ActionBase.TargetObjectsCriteria criteria to make an Action enabled. Inherited from ActionBase. |
| TargetObjectType | Specifies the type of the object(s) that must be represented by the current View to provide an Action activation. Inherited from ActionBase. |
| 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. Inherited from ActionBase. |
| TargetViewNesting | Specifies whether the View, for which an Action is intended, must be root, nested or any. Inherited from ActionBase. |
| TargetViewType | Specifies the type of the View, for which an Action is intended. Inherited from ActionBase. |
| TestName | For internal use only. Inherited from ActionBase. |
| ToolTip | Specifies a tooltip for an Action. Inherited from ActionBase. |
| TypeOfView | Specifies the type of the View for which an Action is intended. Inherited from ActionBase. |
| Value | Specifies the value currently entered into the a Parametrized Action’s editor. |
| ValueType | Specifies the type of values that must be entered in a Parametrized Action’s editor. |
Methods
| Name | Description |
|---|---|
| AssignFrom(ActionBase) | Shares a specified Action’s settings to the current Action. Inherited from ActionBase. |
| AssignInfo(IModelAction) | Applies settings stored in the specified Application Model’s node to the current Action. Inherited from ActionBase. |
| BeginUpdate() | Prevents an Action from being updated until the ActionBase.EndUpdate method is called. Inherited from ActionBase. |
| Dispose() | Releases all resources used by the Component. Inherited from Component. |
| DoExecute(Object) | Raises the ActionBase.Executing, SimpleAction.Execute, ActionBase.Executed, ActionBase.ProcessCreatedView and ActionBase.ExecuteCompleted events one after another. |
| EndUpdate() | Unlocks an Action after a call to the ActionBase.BeginUpdate method, and causes an immediate update. Inherited from ActionBase. |
| 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. Inherited from ActionBase. |
| 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. Inherited from ActionBase. |
| GetTotalToolTip(String) | Returns the Action‘s total tooltip. Intended for internal use. Inherited from ActionBase. |
| 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. Inherited from ActionBase. |
| ReferenceEquals(Object, Object) static | Determines whether the specified Object instances are the same instance. Inherited from Object. |
| ResetId() | Restores an Action‘s ActionBase.Id. Inherited from ActionBase. |
| ToString() | Returns an Action‘s textual representation. Inherited from ActionBase. |
Events
| Name | Description |
|---|---|
| Changed | Occurs after one of the current ActionBase object’s properties has been changed. Inherited from ActionBase. |
| CustomGetFormattedConfirmationMessage | Occurs when the ActionBase.GetFormattedConfirmationMessage method is executed. Inherited from ActionBase. |
| CustomGetTotalTooltip | Occurs when an Action‘s ToolTip is calculated. Inherited from ActionBase. |
| CustomizeCaption static | Inherited from ActionBase. |
| CustomizeControl | Fires after the control is initialized. Allows you to customize the control. Inherited from ActionBase. |
| Disposed | Occurs when the component is disposed by a call to the Dispose() method. Inherited from Component. |
| Disposing | Occurs when disposing of an Action. Inherited from ActionBase. |
| Execute | Occurs after a Parametrized Action’s editor value has been validated. |
| ExecuteCanceled | Occurs after execution of the Action has been cancelled. Inherited from ActionBase. |
| ExecuteCompleted | Occurs after all actions implemented in the Execute, ActionBase.Executed and ActionBase.ProcessCreatedView event handlers have been performed. Inherited from ActionBase. |
| Executed | Occurs after executing an Action. Inherited from ActionBase. |
| Executing | Occurs before an end-user performs the operation that leads to raising an Action‘s Execute event. Inherited from ActionBase. |
| HandleException | For internal use only. Inherited from ActionBase. |
| ProcessCreatedView | Occurs after the ActionBase.Executed event. Inherited from ActionBase. |
| ValueChanged | Occurs after an end-user has typed and submitted a parameter in the Action’s editor, and after the ParametrizedAction.Value property has been changed in code. |
See Also