| Method Name |
Description |
| Activate() |
|
| AddContextMenuItems(ContextMenu As ContextMenuStrip) |
| Parameters |
| ContextMenu |
| Type: ContextMenuStrip |
| |
|
| AfterSave(sender As Object, e As ChangesSavedEventArgs) |
Called before changes are saved to the database.
| Parameters |
| sender |
| Type: Object |
| |
| |
| e |
| Type: ChangesSavedEventArgs |
| |
|
| BatchViewer_Load(sender As Object, e As EventArgs) |
| Parameters |
| sender |
| Type: Object |
| |
| |
| e |
| Type: EventArgs |
| |
|
| BeforeSave(sender As Object, e As ChangesSavedEventArgs) |
Called before changes are saved to the database.
| Parameters |
| sender |
| Type: Object |
| |
| |
| e |
| Type: ChangesSavedEventArgs |
| |
|
| Clear() |
Deselects all nodes in the TreeViewer |
| ClearSelection() |
Deselects all nodes in the TreeViewer |
| 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() |
|
| DeleteSelection(ipd As IProgressDisplay) |
Deletes all currently selected items.
| Parameters |
| ipd |
| Type: IProgressDisplay |
| |
|
| 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. |
|
| EnsureVisible(Item As BatchObject) |
| Parameters |
| Item |
| Type: BatchObject |
| |
|
| EnterScanMode() |
|
| ExitScanMode() |
|
| Expand(Item As BatchObject) |
| Parameters |
| Item |
| Type: BatchObject |
| |
|
| 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) |
Displays a branch of the batch tree in this control.
| Parameters |
| BaseFolder |
| Type: BatchFolder |
| The root node or a folder node in a batch. |
|
| MergeAndRemoveSelection() |
Deletes a folder, appending its contents into the target folder. If the target folder parameter is omitted, the batch pages
will be inserted into the parent batch folder at the same position the folder was located. |
| MergeSelectionToFolder(TargetFolder As BatchFolder) |
| Parameters |
| TargetFolder |
| Type: BatchFolder |
| |
|
| MoveSelectionDown() As Boolean |
Moves all selected nodes down 1 position. |
| MoveSelectionToFolder(TargetFolderNode As GrooperNode, Index As Int32, MaintainPageSelection As Boolean) As Boolean |
Moves all selected items to the specified folder.
| Parameters |
| TargetFolderNode |
| Type: GrooperNode |
| Folder node the selected items are being moved into. |
| |
| Index |
| Type: Int32 |
| Optional insertion index. If not provided, selection will be appended. |
| |
| MaintainPageSelection |
| Type: Boolean |
| Keeps the selected pages selected after moving into the passed Batch Folder. |
|
| MoveSelectionToNewFolder(ContentType As ContentType) As BatchFolder |
Creates a new folder with the specified name, and moves all selected pages into it.
| Parameters |
| ContentType |
| Type: ContentType |
| Content type for new folder. |
|
| MoveSelectionUp() As Boolean |
Moves all selected nodes up 1 position. |
| MoveToNewFolder(CreateSibling As Boolean, ContentType As ContentType, Pages As List(Of BatchPage)) As BatchFolder |
Creates a new folder and moves the passed nodes set into it
| Parameters |
| CreateSibling |
| Type: Boolean |
| If false, new folder will be |
| |
| ContentType |
| Type: ContentType |
| Content type for new folder |
| |
| Pages |
| Type: List`1 |
| Pages to add to new folder |
|
| NodeIsSelected(Node As GrooperNode) As Boolean |
Determines if the provided node is currently selected.
| Parameters |
| Node |
| Type: GrooperNode |
| |
|
| OnActivate() |
|
| OnDeactivate() |
|
| ProcessEnterLeaveEvent() |
|
| RaiseBatchStateChangedEvent() |
|
| RaiseCommandExecutedEvent(e As CommandExecutedEventArgs) |
| Parameters |
| e |
| Type: CommandExecutedEventArgs |
| |
|
| ResumeNodeModifiedEvents() |
|
| SelectNode(Node As BatchObject) |
| Parameters |
| Node |
| Type: BatchObject |
| |
|
| SelectNodes(FocusedNode As GrooperNode, SelectedNodes As IEnumerable(Of BatchObject), EnsureVisible As Boolean) |
Selects the nodes associated with multiple BatchNode objects in the TreeView control.
| Parameters |
| FocusedNode |
| Type: GrooperNode |
| The node to be set as the "focused" node. |
| |
| SelectedNodes |
| Type: IEnumerable`1 |
| The list of nodes to be selected. |
| |
| EnsureVisible |
| Type: Boolean |
| |
|
| 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 |
|
