The requested page is not available for the requested platform. You are viewing the content for .NET Framework 4.5.2+ platform.
.NET Framework 4.5.2+
.NET Framework 4.5.2+
.NET Standard 2.0+
.NET Core 3.0+

SingleChoiceAction Members

Represents a Single Choice Action.

Constructors

Name Description
SingleChoiceAction()

Creates an instance of the SingleChoiceAction class.

SingleChoiceAction(Controller, String, PredefinedCategory)

Creates a new instance of the SingleChoiceAction class and initializes its properties.

SingleChoiceAction(Controller, String, String)

Creates a new instance of the SingleChoiceAction class and initializes its properties.

SingleChoiceAction(IContainer)

Creates a new Single Choice 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)
DefaultItemCaption static

Used to form a default caption for a Choice Action's item. By default, its value is "Entry". This value is appended by an order index.

(Inherited from ChoiceActionBase)
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)
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)
Controller

Provides access to an Action's Controller.

(Inherited from ActionBase)
Data

For internal use.

(Inherited from ActionBase)
DefaultItemMode

Specifies how the Action's default item is determined.

(Inherited from ChoiceActionBase)
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)
EmptyItemsBehavior

Specifies how to display a Choice Action if its ChoiceActionBase.Items collection is empty.

(Inherited from ChoiceActionBase)
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)
HasImage

Indicates whether an Action has an image assigned to it.

(Inherited from ActionBase)
Id

Specifies an Action's identifier.

(Inherited from ActionBase)
ImageMode

Specifies the type of the image that is displayed by the current Action's control.

(Inherited from ChoiceActionBase)
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)
IsExecuting

For internal use.

(Inherited from ActionBase)
ItemType

Specifies the type of a Single Choice Action's items from the ChoiceActionBase.Items collection.

Items

Specifies a Choice Action's item collection.

(Inherited from ChoiceActionBase)
LockCount

Indicates the count of the ActionBase.BeginUpdate method calls.

(Inherited from ActionBase)
Model

Gets the Action's settings.

(Inherited from ActionBase)
PaintStyle

Gets or sets the paint style for the current Action.

(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)
SelectedIndex

Specifies the index of the selected item in a Single Choice Action's ChoiceActionBase.Items list.

SelectedItem

Specifies a Single Choice Action's selected item.

SelectionContext

Specifies a context of an Action's execution.

(Inherited from ActionBase)
SelectionDependencyType

Specifies a context for enabling an Action.

(Inherited from ActionBase)
Shortcut

Defines the keyboard shortcut used to execute the current Action. Has effect in WinForms applications only.

(Inherited from ActionBase)
ShowItemsOnClick

Specifies whether to show the drop-down with the current Action's items when the Action is clicked in WinForms or ASP.NET applications.

(Inherited from ChoiceActionBase)
Tag

Provides access to the object that contains data about the Action.

(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)
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)
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)

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 ChoiceActionBase)
BeginUpdate()

Prevents an Action from being updated until the ActionBase.EndUpdate method is called.

(Inherited from ActionBase)
DoExecute(ChoiceActionItem)

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)
FindItemByCaptionPath(String)

Provides access to the SingleChoiceAction's ChoiceActionItem with the specified caption path.

FindItemByIdPath(String)

Provides access to the SingleChoiceAction's ChoiceActionItem with the specified identifier path.

GetFormattedConfirmationMessage()

Returns a formatted confirmation message displayed when executing an Action.

(Inherited from ActionBase)
GetTotalToolTip()

Returns the Action's total tooltip. Intended for internal use.

GetTotalToolTip(String)

Returns the Action's total tooltip. Intended for internal use.

(Inherited from ActionBase)
IsHierarchical()

Checks whether the Action's ChoiceActionBase.Items collection has a tree-like structure.

(Inherited from ChoiceActionBase)
RaiseCustomizeControl(Object)

For internal use.

(Inherited from ActionBase)
ResetId()

Restores an Action's ActionBase.Id.

(Inherited from ActionBase)
ToString()

Returns an Action's textual representation.

(Inherited from ActionBase)

Events

Name Description
BehaviorChanged

Occurs when the ChoiceActionBase Action behavior is modified.

(Inherited from ChoiceActionBase)
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)
CustomizeControl

Occurs after the control is initialized. Allows customizing the default control settings.

(Inherited from ActionBase)
Disposing

Occurs when disposing of an Action.

(Inherited from ActionBase)
Execute

Occurs when an end-user clicks the required item located in the Single Choice Action's item list.

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)
ItemTypeChanged

Occurs when a Single Choice Action's SingleChoiceAction.ItemType property is changed.

ItemsChanged

Occurs when a Choice Action's ChoiceActionBase.Items property is changed.

(Inherited from ChoiceActionBase)
ProcessCreatedView

Occurs after the ActionBase.Executed event.

(Inherited from ActionBase)
SelectedItemChanged

Occurs when a Single Choice Action's item is changed by an end-user.

See Also