Provides a user interface for reviewing and editing the data elements associated with Grooper document.
The Index Navigator displays a sequence documents which exist at a specific level within the batch, allowing the user to navigate from document to
document and review / edit data values.
| Property Name |
Property Type |
Description |
| Ancestors |
System.Collections.Generic.IEnumerable(Of T) |
Enumerates the parent controls of this control. |
| CanComplete |
System.Boolean |
Returns boolean indicating if the control is currently in a state where it can be closed. |
| CanLeave |
System.Boolean |
Returns boolean indicating if the control is currently in a state where it can be closed. |
| FocusedItem |
Grooper.Core.BatchObject |
Gets or sets the currently-focused item. Derived classes must override this property. When read, this property should return the folder or page which is currently selected. If
multiple objects are selected, the first selected object should be returned. When written, the derived class should update its display
to reflect the indicated item is visible and selected. |
| SelectedItems |
System.Collections.Generic.IEnumerable(Of T) |
Gets or sets the currenly selected Batch Objects. |
| StatProperties |
System.Collections.Generic.IEnumerable(Of T) |
Returns information for each Activity Statistic class member. |
| Method Name |
Description |
| Activate() |
|
| AfterSave(sender As Object, e As ChangesSavedEventArgs) |
Called before changes are saved to the database.
| Parameters |
| sender |
| Type: Object |
| |
| |
| e |
| Type: ChangesSavedEventArgs |
| |
|
| BeforeSave(sender As Object, e As ChangesSavedEventArgs) |
Called before changes are saved to the database.
| Parameters |
| sender |
| Type: Object |
| |
| |
| e |
| Type: ChangesSavedEventArgs |
| |
|
| Clear() |
Called when the attended client is closing the task. |
| CreateMenuItem(Database As GrooperDb, Items As IEnumerable, CommandType As Type, Handler As EventHandler, ContextInstance As Object) As ToolStripMenuItem |
Creates a ToolStripMenuItem for a specific command type, if the command is enabled for a list of selected objects.
| Parameters |
| Database |
| Type: GrooperDb |
| The Grooper database. |
| |
| Items |
| Type: IEnumerable |
| The list of selected objects. |
| |
| CommandType |
| Type: Type |
| A type deriving from ObjectCommand. |
| |
| Handler |
| Type: EventHandler |
| The "Click" event handler to be wired up to the menu item. |
| |
| ContextInstance |
| Type: Object |
| An optional context instance. |
|
| CreateMenuItems(Database As GrooperDb, CommandTypes As IEnumerable(Of Type), Items As IEnumerable, Handler As EventHandler) As List(Of ToolStripMenuItem) |
Creates a list ToolStripMenuItems from a list of command types, returning one ToolStripMenuItem for each enabled command.
| Parameters |
| Database |
| Type: GrooperDb |
| The Grooper database. |
| |
| CommandTypes |
| Type: IEnumerable`1 |
| A list types deriving from ObjectCommand. |
| |
| Items |
| Type: IEnumerable |
| The list of selected objects. |
| |
| Handler |
| Type: EventHandler |
| The "Click" event handler to be wired up to the menu item. |
|
| CreateToolStripButtons(Database As GrooperDb, CommandTypes As IEnumerable(Of Type), Items As IEnumerable, Handler As EventHandler) As IEnumerable(Of ToolStripButton) |
Creates a list ToolStripButtons from a list of command types, returning one ToolStripButton for each enabled command.
| Parameters |
| Database |
| Type: GrooperDb |
| The Grooper database. |
| |
| CommandTypes |
| Type: IEnumerable`1 |
| A list types deriving from ObjectCommand. |
| |
| Items |
| Type: IEnumerable |
| The list of selected objects. |
| |
| Handler |
| Type: EventHandler |
| The "Click" event handler to be wired up to the button. |
|
| Deactivate() |
|
| Dispose(disposing As Boolean) |
Releases the unmanaged resources used by the control and its child controls and optionally releases the managed resources.
| Parameters |
| disposing |
| Type: Boolean |
| true to release both managed and unmanaged resources; false to release only unmanaged resources. |
|
| GetControlCommandTypes(ObjectType As Type, RepositoryId As Guid) As IEnumerable(Of Type) |
Returns a list of object commands which apply to a specific object type within the context of this control.
| Parameters |
| ObjectType |
| Type: Type |
| The object type. |
| |
| RepositoryId |
| Type: Guid |
| The GUID ID of the Grooper repository. |
|
| GetRealTimeStats(Args As DisplayUpdateEventArgs) |
| Parameters |
| Args |
| Type: DisplayUpdateEventArgs |
| |
|
| GetToolStripItems(ControlCommandsOnly As Boolean) As IEnumerable(Of ToolStripMenuItem) |
| Parameters |
| ControlCommandsOnly |
| Type: Boolean |
| |
|
| Initialize(BaseFolder As BatchFolder) |
Called when the control should display content.
| Parameters |
| BaseFolder |
| Type: BatchFolder |
| The folder to display. |
|
| OnActivate() |
|
| OnDeactivate() |
|
| RaiseBatchStateChangedEvent() |
|
| RaiseCommandExecutedEvent(e As CommandExecutedEventArgs) |
| Parameters |
| e |
| Type: CommandExecutedEventArgs |
| |
|
| ResumeNodeModifiedEvents() |
|
| SelectNode(Node As BatchObject) |
| Parameters |
| Node |
| Type: BatchObject |
| |
|
| SetContextInstance(Context As AttendedActivity) |
| Parameters |
| Context |
| Type: AttendedActivity |
| |
|
| ShowValidationErrors(Items As ValidationErrorList, AllowInvalid As Boolean) As Boolean |
| Parameters |
| Items |
| Type: ValidationErrorList |
| |
| |
| AllowInvalid |
| Type: Boolean |
| |
|
| SuspendNodeModifiedEvents() |
|
| UpdateNow(e As ChangesSavedEventArgs) |
Forces the execution of OnNodeModified, bypassing the Node Modified Timer.
| Parameters |
| e |
| Type: ChangesSavedEventArgs |
| |
|
| ValidateObject(Item As GrooperObject, AllowInvalid As Boolean) As Boolean |
| Parameters |
| Item |
| Type: GrooperObject |
| |
| |
| AllowInvalid |
| Type: Boolean |
| |
|
| ValidateProperties() As ValidationErrorList |
|
