Class RowActionItemInfo

Description of one action item, destined for an archive row context menu or toolbar button

Inheritance
object
RowActionItemInfo
Inherited Members
Namespace: SuperOffice.CRM.ArchiveLists
Assembly: SoDataBase.dll
Syntax
public class RowActionItemInfo

Constructors

RowActionItemInfo()

Description of one action item, destined for an archive row context menu or toolbar button

Declaration
public RowActionItemInfo()

Fields

CanExecute

CanExecute delegate, called whenever the row-selection state changes, and before a context menu is shown. It influences the enabled/disabled/hidden state of a button or menu item. This value can be left uninitialized (null) if the item should always be available.

Declaration
public CanExecuteDelegate CanExecute
Field Value
Type Description
CanExecuteDelegate

Properties

ChildItems

Sub-items for actions. On Menu items this means a submenu; on Button items this makes the top-level control into a dropdown list, with child controls becoming items and/or sub-headings (no more than one level of headings supported)

Declaration
public RowActionItemInfo[] ChildItems { get; set; }
Property Value
Type Description
RowActionItemInfo[]

DisabledIconHint

Optional name/hint for icon, used in the disabled state; the IArchiveRowEventHandler.GetImage method will be called with this string as parameter when the item is to be shown. If the EnabledIconHint is set, then this member should also be set, unless the client is sure that the action item will never be disabled (icons should generally not be the same for enabled and disabled states)

Declaration
public string DisabledIconHint { get; set; }
Property Value
Type Description
string

DisplayName

Action item text to be shown; can contain resource and multi-language elements

Declaration
public string DisplayName { get; set; }
Property Value
Type Description
string

DisplayTooltip

Tooltip for action item; can contain resource and multi-language elements

Declaration
public string DisplayTooltip { get; set; }
Property Value
Type Description
string

EnabledIconHint

Optional name/hint for icon, used in the enabled state; the IArchiveRowEventHandler.GetImage method will be called with this string as parameter when the item is to be shown.

Declaration
public string EnabledIconHint { get; set; }
Property Value
Type Description
string

Execute

Execute delegate, see the delegate declaration for information. This delegate is relevant for windows only.

Declaration
public ExecuteDelegate Execute { get; set; }
Property Value
Type Description
ExecuteDelegate

Name

Unique item id, must be unique within archive; used to identify menu item chosen (also influences technical name of control in GUI)

Declaration
public string Name { get; set; }
Property Value
Type Description
string

ScriptAction

Script action, to be executed when this action is performed. This string will usually be a JavaScript code fragment; it is relevant for Web only.

Declaration
public string ScriptAction { get; set; }
Property Value
Type Description
string

Extension Methods