Grooper.Core.Batch.Reset

Move the batch to a different Batch Process Step, optionally resetting tasks for folders or pages which have already been processed. NOTE: The batch must be paused before this command can be used.


Inherits from: Grooper.MultiUICommand(Of Batch)

Constructors

Signature Description
New ()

Fields

Field Name Field Type Description
ContextInstance As System.Object System.Object
Database As Grooper.GrooperDb Grooper.GrooperDb
ipd As Grooper.IProgressDisplay Grooper.IProgressDisplay
Parent As System.Windows.Forms.IWin32Window System.Windows.Forms.IWin32Window

Properties

Property Name Property Type Description
ClearStatistics System.Boolean If set to true, and statistics previously logged by the steps being reset will be cleared.
HasReferenceProperties System.Boolean Returns true if the object has properties which reference Grooper Node objects.
IsEmpty System.Boolean Returns true if all properties with a ViewableAttribute are set to their default value.
IsWriteable System.Boolean Returns true if the object is writable, or false if it is not.
ResetScope Grooper.Core.Batch.Reset.TaskScope Specifies which items within the batch should be reprocessed.Can be one of the following values:
  • All: Reprocess all items.
  • Errors: Reprocess items in an error state.
  • Completed: Reprocess items which previously completed successfully.
Root Grooper.GrooperRoot Returns the root node
ShowEllipses System.Boolean Specifies whether elipses (...) will be shown after the command name on context menus. By default, this property will return true if the command has configurable properties, or if the command has the RequiresUIAttribute applied. Derived classes may override this property to exercise direct control over whether ellipses will be displayed.
StepsToReset System.Collections.Generic.List(Of T) Specifies which steps should be reset. Resetting a step allows items which were previously processed through the step to be processed again.
TargetStep Grooper.Core.BatchProcessStep The Batch Process Step where the batch will resume execution.

Methods

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.