Interface IArchiveControlEventHandler

This interface defines a handler for archive row events - what should happen when a user double-clicks or otherwise operates on a row of a custom archive; and which action items (buttons, menus) should be shown

Custom archives will attempt to instantiate an object implementing this interface, and marked with an attribute giving the same name as the archives' data provider. If such an instance is created, it will then be called as follows:

Event	Call / action taken
Construction	GetButtonItems() is called once, returning an array of items. Buttons are shown from left to right in the order they are returned
Row selection changes	The CanExecute method is called on each action originally returned from GetButtonItems(), whenever the set of currently selected rows changes (including on reload, where no rows are initially selected). Return values are used to enable/disable/show/hide buttons.
Right-click/context menu popup	Before the menu is shown, then GetMenuItems(RowInfo[]) method is called to get the content of the menu. Then, the CanExecute delegate on each returned menu item is called, to determine whether it should be visible and enabled. The menu is then shown.
Menu or button clicked	In Windows, the Execute delegate is called, and its result value processed as described in its comments. In Web, the RowActionItemInfo.ActionScript is executed in the Browser.
Mouse doubleclick on row	If an 'open' action has been declared, then it is processed; otherwise nothing happens

Row selection, double-clicking/Enter key, Add button, Delete button/Del key are special events that have a strongly typed interface; other actions are defined and handled by the generic GetMenuItems(RowInfo[]) and GetButtonItems() methods, and the delegates embedded in their return values.

There are two possible constructor signatures for this class:

Signature	Meaning
No arguments/no constructor	Your code does not care about the "guiName" and "hWnd" parameters. This is the case if there is only the one archive with this provider name, or if the behaviour of all archives for this provider should be identical. It also means that you do not plan to invoke GUI methods that require the knowledge of the Win32 HWND of the archive control itself.
string guiName, int hWnd	Your code needs at least one of these two items, either to differentiate behaviour based on the gui control name (between different archives for the same provider); or you want to perform GUI operations that require the Win32 HWND of the archive control window.

The factory code will automatically recognize and call either of these two constructors. You can also omit defining a constructor altogether if you have no initialization code. Constructors with other signatures will not cause failures, but they will not be called.

Handler called when the user clicks the Add button or menu item

Type	Name	Description
ArchiveRestrictionInfo[]	context	Current archive restrictions that define the context of the archive

Custom archives will attempt to instantiate an object implementing this interface, and marked with an attribute giving the same name as the archives' data provider. If such an instance is created, it will then be called as follows:

Event	Call / action taken
Construction	GetButtonItems() is called once, returning an array of items. Buttons are shown from left to right in the order they are returned
Row selection changes	The CanExecute method is called on each action originally returned from GetButtonItems(), whenever the set of currently selected rows changes (including on reload, where no rows are initially selected). Return values are used to enable/disable/show/hide buttons.
Right-click/context menu popup	Before the menu is shown, then GetMenuItems(RowInfo[]) method is called to get the content of the menu. Then, the CanExecute delegate on each returned menu item is called, to determine whether it should be visible and enabled. The menu is then shown.
Menu or button clicked	In Windows, the Execute delegate is called, and its result value processed as described in its comments. In Web, the RowActionItemInfo.ActionScript is executed in the Browser.
Mouse doubleclick on row	If an 'open' action has been declared, then it is processed; otherwise nothing happens

Row selection, double-clicking/Enter key, Add button, Delete button/Del key are special events that have a strongly typed interface; other actions are defined and handled by the generic GetMenuItems(RowInfo[]) and GetButtonItems() methods, and the delegates embedded in their return values.

There are two possible constructor signatures for this class:

Signature	Meaning
No arguments/no constructor	Your code does not care about the "guiName" and "hWnd" parameters. This is the case if there is only the one archive with this provider name, or if the behaviour of all archives for this provider should be identical. It also means that you do not plan to invoke GUI methods that require the knowledge of the Win32 HWND of the archive control itself.
string guiName, int hWnd	Your code needs at least one of these two items, either to differentiate behaviour based on the gui control name (between different archives for the same provider); or you want to perform GUI operations that require the Win32 HWND of the archive control window.

The factory code will automatically recognize and call either of these two constructors. You can also omit defining a constructor altogether if you have no initialization code. Constructors with other signatures will not cause failures, but they will not be called.

Can a row be added? If the return value does not have the Write right set, then the Add button will be disable and the return values' Reason will be set as the tooltip

Type	Name	Description
ArchiveRestrictionInfo[]	context	Current archive restrictions that define the context of the archive

Type	Description
FieldRight	Desired state of Add button; the CanUIUpdate is bound to the enabled state. If false, then the Reason is shown as the tooltip to explain to the user why the button is disabled

Custom archives will attempt to instantiate an object implementing this interface, and marked with an attribute giving the same name as the archives' data provider. If such an instance is created, it will then be called as follows:

Event	Call / action taken
Construction	GetButtonItems() is called once, returning an array of items. Buttons are shown from left to right in the order they are returned
Row selection changes	The CanExecute method is called on each action originally returned from GetButtonItems(), whenever the set of currently selected rows changes (including on reload, where no rows are initially selected). Return values are used to enable/disable/show/hide buttons.
Right-click/context menu popup	Before the menu is shown, then GetMenuItems(RowInfo[]) method is called to get the content of the menu. Then, the CanExecute delegate on each returned menu item is called, to determine whether it should be visible and enabled. The menu is then shown.
Menu or button clicked	In Windows, the Execute delegate is called, and its result value processed as described in its comments. In Web, the RowActionItemInfo.ActionScript is executed in the Browser.
Mouse doubleclick on row	If an 'open' action has been declared, then it is processed; otherwise nothing happens

Row selection, double-clicking/Enter key, Add button, Delete button/Del key are special events that have a strongly typed interface; other actions are defined and handled by the generic GetMenuItems(RowInfo[]) and GetButtonItems() methods, and the delegates embedded in their return values.

There are two possible constructor signatures for this class:

Signature	Meaning
No arguments/no constructor	Your code does not care about the "guiName" and "hWnd" parameters. This is the case if there is only the one archive with this provider name, or if the behaviour of all archives for this provider should be identical. It also means that you do not plan to invoke GUI methods that require the knowledge of the Win32 HWND of the archive control itself.
string guiName, int hWnd	Your code needs at least one of these two items, either to differentiate behaviour based on the gui control name (between different archives for the same provider); or you want to perform GUI operations that require the Win32 HWND of the archive control window.

The factory code will automatically recognize and call either of these two constructors. You can also omit defining a constructor altogether if you have no initialization code. Constructors with other signatures will not cause failures, but they will not be called.

Delete one or more rows

Type	Name	Description
RowInfo[]	rowInfo	Information identifying the rows to be deleted

Custom archives will attempt to instantiate an object implementing this interface, and marked with an attribute giving the same name as the archives' data provider. If such an instance is created, it will then be called as follows:

Event	Call / action taken
Construction	GetButtonItems() is called once, returning an array of items. Buttons are shown from left to right in the order they are returned
Row selection changes	The CanExecute method is called on each action originally returned from GetButtonItems(), whenever the set of currently selected rows changes (including on reload, where no rows are initially selected). Return values are used to enable/disable/show/hide buttons.
Right-click/context menu popup	Before the menu is shown, then GetMenuItems(RowInfo[]) method is called to get the content of the menu. Then, the CanExecute delegate on each returned menu item is called, to determine whether it should be visible and enabled. The menu is then shown.
Menu or button clicked	In Windows, the Execute delegate is called, and its result value processed as described in its comments. In Web, the RowActionItemInfo.ActionScript is executed in the Browser.
Mouse doubleclick on row	If an 'open' action has been declared, then it is processed; otherwise nothing happens

Row selection, double-clicking/Enter key, Add button, Delete button/Del key are special events that have a strongly typed interface; other actions are defined and handled by the generic GetMenuItems(RowInfo[]) and GetButtonItems() methods, and the delegates embedded in their return values.

There are two possible constructor signatures for this class:

Signature	Meaning
No arguments/no constructor	Your code does not care about the "guiName" and "hWnd" parameters. This is the case if there is only the one archive with this provider name, or if the behaviour of all archives for this provider should be identical. It also means that you do not plan to invoke GUI methods that require the knowledge of the Win32 HWND of the archive control itself.
string guiName, int hWnd	Your code needs at least one of these two items, either to differentiate behaviour based on the gui control name (between different archives for the same provider); or you want to perform GUI operations that require the Win32 HWND of the archive control window.

The factory code will automatically recognize and call either of these two constructors. You can also omit defining a constructor altogether if you have no initialization code. Constructors with other signatures will not cause failures, but they will not be called.

Edit one row (show detail dialog, jump to other application, etc)

Type	Name	Description
RowInfo	rowInfo	Information identifying the row to be deleted

Custom archives will attempt to instantiate an object implementing this interface, and marked with an attribute giving the same name as the archives' data provider. If such an instance is created, it will then be called as follows:

Event	Call / action taken
Construction	GetButtonItems() is called once, returning an array of items. Buttons are shown from left to right in the order they are returned
Row selection changes	The CanExecute method is called on each action originally returned from GetButtonItems(), whenever the set of currently selected rows changes (including on reload, where no rows are initially selected). Return values are used to enable/disable/show/hide buttons.
Right-click/context menu popup	Before the menu is shown, then GetMenuItems(RowInfo[]) method is called to get the content of the menu. Then, the CanExecute delegate on each returned menu item is called, to determine whether it should be visible and enabled. The menu is then shown.
Menu or button clicked	In Windows, the Execute delegate is called, and its result value processed as described in its comments. In Web, the RowActionItemInfo.ActionScript is executed in the Browser.
Mouse doubleclick on row	If an 'open' action has been declared, then it is processed; otherwise nothing happens

Row selection, double-clicking/Enter key, Add button, Delete button/Del key are special events that have a strongly typed interface; other actions are defined and handled by the generic GetMenuItems(RowInfo[]) and GetButtonItems() methods, and the delegates embedded in their return values.

There are two possible constructor signatures for this class:

Signature	Meaning
No arguments/no constructor	Your code does not care about the "guiName" and "hWnd" parameters. This is the case if there is only the one archive with this provider name, or if the behaviour of all archives for this provider should be identical. It also means that you do not plan to invoke GUI methods that require the knowledge of the Win32 HWND of the archive control itself.
string guiName, int hWnd	Your code needs at least one of these two items, either to differentiate behaviour based on the gui control name (between different archives for the same provider); or you want to perform GUI operations that require the Win32 HWND of the archive control window.

The factory code will automatically recognize and call either of these two constructors. You can also omit defining a constructor altogether if you have no initialization code. Constructors with other signatures will not cause failures, but they will not be called.

Get button actions for a custom archive; called once during construction; see class remarks

Type	Description
RowActionItemInfo[]	Array of button items to be included in toolbar; their visibility and enabled state can be determined at a later point depending on the selected rows, through the CanExecute method

Custom archives will attempt to instantiate an object implementing this interface, and marked with an attribute giving the same name as the archives' data provider. If such an instance is created, it will then be called as follows:

Event	Call / action taken
Construction	GetButtonItems() is called once, returning an array of items. Buttons are shown from left to right in the order they are returned
Row selection changes	The CanExecute method is called on each action originally returned from GetButtonItems(), whenever the set of currently selected rows changes (including on reload, where no rows are initially selected). Return values are used to enable/disable/show/hide buttons.
Right-click/context menu popup	Before the menu is shown, then GetMenuItems(RowInfo[]) method is called to get the content of the menu. Then, the CanExecute delegate on each returned menu item is called, to determine whether it should be visible and enabled. The menu is then shown.
Menu or button clicked	In Windows, the Execute delegate is called, and its result value processed as described in its comments. In Web, the RowActionItemInfo.ActionScript is executed in the Browser.
Mouse doubleclick on row	If an 'open' action has been declared, then it is processed; otherwise nothing happens

Row selection, double-clicking/Enter key, Add button, Delete button/Del key are special events that have a strongly typed interface; other actions are defined and handled by the generic GetMenuItems(RowInfo[]) and GetButtonItems() methods, and the delegates embedded in their return values.

There are two possible constructor signatures for this class:

Signature	Meaning
No arguments/no constructor	Your code does not care about the "guiName" and "hWnd" parameters. This is the case if there is only the one archive with this provider name, or if the behaviour of all archives for this provider should be identical. It also means that you do not plan to invoke GUI methods that require the knowledge of the Win32 HWND of the archive control itself.
string guiName, int hWnd	Your code needs at least one of these two items, either to differentiate behaviour based on the gui control name (between different archives for the same provider); or you want to perform GUI operations that require the Win32 HWND of the archive control window.

The factory code will automatically recognize and call either of these two constructors. You can also omit defining a constructor altogether if you have no initialization code. Constructors with other signatures will not cause failures, but they will not be called.

Return a graphic image corresponding to an image hint; or null if the hint refers to a standard graphic that is already present in the calling client code's graphic library

Type	Name	Description
string	iconHint	Image to fetch

Type	Description
Image	Image, or null; if null then the system will attempt to find a corresponding standard icon

Custom archives will attempt to instantiate an object implementing this interface, and marked with an attribute giving the same name as the archives' data provider. If such an instance is created, it will then be called as follows:

Event	Call / action taken
Construction	GetButtonItems() is called once, returning an array of items. Buttons are shown from left to right in the order they are returned
Row selection changes	The CanExecute method is called on each action originally returned from GetButtonItems(), whenever the set of currently selected rows changes (including on reload, where no rows are initially selected). Return values are used to enable/disable/show/hide buttons.
Right-click/context menu popup	Before the menu is shown, then GetMenuItems(RowInfo[]) method is called to get the content of the menu. Then, the CanExecute delegate on each returned menu item is called, to determine whether it should be visible and enabled. The menu is then shown.
Menu or button clicked	In Windows, the Execute delegate is called, and its result value processed as described in its comments. In Web, the RowActionItemInfo.ActionScript is executed in the Browser.
Mouse doubleclick on row	If an 'open' action has been declared, then it is processed; otherwise nothing happens

Row selection, double-clicking/Enter key, Add button, Delete button/Del key are special events that have a strongly typed interface; other actions are defined and handled by the generic GetMenuItems(RowInfo[]) and GetButtonItems() methods, and the delegates embedded in their return values.

There are two possible constructor signatures for this class:

Signature	Meaning
No arguments/no constructor	Your code does not care about the "guiName" and "hWnd" parameters. This is the case if there is only the one archive with this provider name, or if the behaviour of all archives for this provider should be identical. It also means that you do not plan to invoke GUI methods that require the knowledge of the Win32 HWND of the archive control itself.
string guiName, int hWnd	Your code needs at least one of these two items, either to differentiate behaviour based on the gui control name (between different archives for the same provider); or you want to perform GUI operations that require the Win32 HWND of the archive control window.

The factory code will automatically recognize and call either of these two constructors. You can also omit defining a constructor altogether if you have no initialization code. Constructors with other signatures will not cause failures, but they will not be called.

Get context menu items for a particular set of rows; called when user right-clicks to trigger popup menu; see class remarks

Type	Name	Description
RowInfo[]	rowInfo	Array with information about selected rows; empty array if no rows are currently selected

Type	Description
RowActionItemInfo[]	Array of menu items to be included in menu

Custom archives will attempt to instantiate an object implementing this interface, and marked with an attribute giving the same name as the archives' data provider. If such an instance is created, it will then be called as follows:

Event	Call / action taken
Construction	GetButtonItems() is called once, returning an array of items. Buttons are shown from left to right in the order they are returned
Row selection changes	The CanExecute method is called on each action originally returned from GetButtonItems(), whenever the set of currently selected rows changes (including on reload, where no rows are initially selected). Return values are used to enable/disable/show/hide buttons.
Right-click/context menu popup	Before the menu is shown, then GetMenuItems(RowInfo[]) method is called to get the content of the menu. Then, the CanExecute delegate on each returned menu item is called, to determine whether it should be visible and enabled. The menu is then shown.
Menu or button clicked	In Windows, the Execute delegate is called, and its result value processed as described in its comments. In Web, the RowActionItemInfo.ActionScript is executed in the Browser.
Mouse doubleclick on row	If an 'open' action has been declared, then it is processed; otherwise nothing happens

Row selection, double-clicking/Enter key, Add button, Delete button/Del key are special events that have a strongly typed interface; other actions are defined and handled by the generic GetMenuItems(RowInfo[]) and GetButtonItems() methods, and the delegates embedded in their return values.

There are two possible constructor signatures for this class:

Signature	Meaning
No arguments/no constructor	Your code does not care about the "guiName" and "hWnd" parameters. This is the case if there is only the one archive with this provider name, or if the behaviour of all archives for this provider should be identical. It also means that you do not plan to invoke GUI methods that require the knowledge of the Win32 HWND of the archive control itself.
string guiName, int hWnd	Your code needs at least one of these two items, either to differentiate behaviour based on the gui control name (between different archives for the same provider); or you want to perform GUI operations that require the Win32 HWND of the archive control window.

The factory code will automatically recognize and call either of these two constructors. You can also omit defining a constructor altogether if you have no initialization code. Constructors with other signatures will not cause failures, but they will not be called.

Should the system-supplied Add button/context menu item be shown on this archive?

Type	Description
bool

Custom archives will attempt to instantiate an object implementing this interface, and marked with an attribute giving the same name as the archives' data provider. If such an instance is created, it will then be called as follows:

Event	Call / action taken
Construction	GetButtonItems() is called once, returning an array of items. Buttons are shown from left to right in the order they are returned
Row selection changes	The CanExecute method is called on each action originally returned from GetButtonItems(), whenever the set of currently selected rows changes (including on reload, where no rows are initially selected). Return values are used to enable/disable/show/hide buttons.
Right-click/context menu popup	Before the menu is shown, then GetMenuItems(RowInfo[]) method is called to get the content of the menu. Then, the CanExecute delegate on each returned menu item is called, to determine whether it should be visible and enabled. The menu is then shown.
Menu or button clicked	In Windows, the Execute delegate is called, and its result value processed as described in its comments. In Web, the RowActionItemInfo.ActionScript is executed in the Browser.
Mouse doubleclick on row	If an 'open' action has been declared, then it is processed; otherwise nothing happens

Row selection, double-clicking/Enter key, Add button, Delete button/Del key are special events that have a strongly typed interface; other actions are defined and handled by the generic GetMenuItems(RowInfo[]) and GetButtonItems() methods, and the delegates embedded in their return values.

There are two possible constructor signatures for this class:

Signature	Meaning
No arguments/no constructor	Your code does not care about the "guiName" and "hWnd" parameters. This is the case if there is only the one archive with this provider name, or if the behaviour of all archives for this provider should be identical. It also means that you do not plan to invoke GUI methods that require the knowledge of the Win32 HWND of the archive control itself.
string guiName, int hWnd	Your code needs at least one of these two items, either to differentiate behaviour based on the gui control name (between different archives for the same provider); or you want to perform GUI operations that require the Win32 HWND of the archive control window.

The factory code will automatically recognize and call either of these two constructors. You can also omit defining a constructor altogether if you have no initialization code. Constructors with other signatures will not cause failures, but they will not be called.

Should the system-supplied Delete button/menu item be shown on this archive? The enabled/disabled state will be set automatically based on the selected rows' RowRight sentry information

Type	Description
bool

Custom archives will attempt to instantiate an object implementing this interface, and marked with an attribute giving the same name as the archives' data provider. If such an instance is created, it will then be called as follows:

Event	Call / action taken
Construction	GetButtonItems() is called once, returning an array of items. Buttons are shown from left to right in the order they are returned
Row selection changes	The CanExecute method is called on each action originally returned from GetButtonItems(), whenever the set of currently selected rows changes (including on reload, where no rows are initially selected). Return values are used to enable/disable/show/hide buttons.
Right-click/context menu popup	Before the menu is shown, then GetMenuItems(RowInfo[]) method is called to get the content of the menu. Then, the CanExecute delegate on each returned menu item is called, to determine whether it should be visible and enabled. The menu is then shown.
Menu or button clicked	In Windows, the Execute delegate is called, and its result value processed as described in its comments. In Web, the RowActionItemInfo.ActionScript is executed in the Browser.
Mouse doubleclick on row	If an 'open' action has been declared, then it is processed; otherwise nothing happens

Row selection, double-clicking/Enter key, Add button, Delete button/Del key are special events that have a strongly typed interface; other actions are defined and handled by the generic GetMenuItems(RowInfo[]) and GetButtonItems() methods, and the delegates embedded in their return values.

There are two possible constructor signatures for this class:

Signature	Meaning
No arguments/no constructor	Your code does not care about the "guiName" and "hWnd" parameters. This is the case if there is only the one archive with this provider name, or if the behaviour of all archives for this provider should be identical. It also means that you do not plan to invoke GUI methods that require the knowledge of the Win32 HWND of the archive control itself.
string guiName, int hWnd	Your code needs at least one of these two items, either to differentiate behaviour based on the gui control name (between different archives for the same provider); or you want to perform GUI operations that require the Win32 HWND of the archive control window.

The factory code will automatically recognize and call either of these two constructors. You can also omit defining a constructor altogether if you have no initialization code. Constructors with other signatures will not cause failures, but they will not be called.

Interface IArchiveControlEventHandler

Namespace: SuperOffice.CRM.ArchiveLists

Assembly: SoDataBase.dll

Syntax

Remarks

Methods

AddRow(ArchiveRestrictionInfo[])

Declaration

Parameters

Returns

Remarks

CanAddRow(ArchiveRestrictionInfo[])

Declaration

Parameters

Returns

Remarks

DeleteRows(RowInfo[])

Declaration

Parameters

Returns

Remarks

EditRow(RowInfo)

Declaration

Parameters

Returns

Remarks

GetButtonItems()

Declaration

Returns

Remarks

GetImage(string)

Declaration

Parameters

Returns

Remarks

GetMenuItems(RowInfo[])

Declaration

Parameters

Returns

Remarks

HasAddButton()

Declaration

Returns

Remarks

HasDeleteButton()

Declaration

Returns

Remarks

Extension Methods