Pause processing on the batch.
Removes all pending tasks and changes the status of the batch to 'Paused'. Tasks which are already in progress when the pause command is issued will continue
through to completion.
Method Name |
Description |
CanExecute(Items As IEnumerable(Of Batch)) As Boolean |
Parameters |
Items |
Type: IEnumerable`1 |
|
|
CanExecuteCommand(Items As IEnumerable) As Boolean |
Returns true if the command can be executed on the provided list of items.
Parameters |
Items |
Type: IEnumerable |
The list of item to which the command will be applied. |
|
Execute(Items As IEnumerable(Of Batch)) |
Parameters |
Items |
Type: IEnumerable`1 |
|
|
ExecuteCommand(Items As IEnumerable) |
Executes the code written in the overridden instance of ExecuteCommand.
Parameters |
Items |
Type: IEnumerable |
A list of items to apply to command to. |
|
GetProperties() As PropertyDescriptorCollection |
|
GetReferences() As List(Of GrooperNode) |
Returns a list of GrooperNode objects referenced in the properties of this object. |
Initialize(gdb As GrooperDb, Parent As IWin32Window, ContextInstance As Object) |
Initializes the command.
Parameters |
gdb |
Type: GrooperDb |
The Grooper database. |
|
Parent |
Type: IWin32Window |
The parent window, or null if there is no UI. |
|
ContextInstance |
Type: Object |
An optional context instance. |
|
IsPropertyEnabled(PropertyName As String) As Nullable(Of Boolean) |
Defines whether a property is currently enabled.
Parameters |
PropertyName |
Type: String |
The name of the property to determine the enabled state for. |
|
IsPropertyVisible(PropertyName As String) As Nullable(Of Boolean) |
Defines whether a property is currently visible.
Parameters |
PropertyName |
Type: String |
The name of the property to determine the visible state for. |
|
IsType(Type As Type) As Boolean |
Returns true if the object is of the type specified, or if it derives from the type specfied.
Parameters |
Type |
Type: Type |
The type to check. |
|
OnInitialize(Items As IEnumerable(Of Batch)) As Boolean |
Parameters |
Items |
Type: IEnumerable`1 |
|
|
Serialize() As String |
Serializes the object. |
SetDatabase(Database As GrooperDb) |
Sets the database connection of the object.
Parameters |
Database |
Type: GrooperDb |
|
|
ToString() As String |
Returns a string value representation of the connected object. |
Uninitialize() |
Uninitializes the command. |
ValidateProperties() As ValidationErrorList |
Validates the properties of the object, returning a list of validation errors. |