Grooper.Core.BatchThumbnailViewer

Provides a thumbnail-based view of a Batch. The Thumbnail Viewer also allows users to sort images by attributes such as width, height, and others.


Inherits from: Grooper.Core.BatchView

Constructors

Signature Description
New ()

Fields

Field Name Field Type Description
CommandShortcutKeysDelegate As Grooper.Core.BatchView+ShortcutKeysDelegate Grooper.Core.BatchView.ShortcutKeysDelegate
CommandStateDelegate As Grooper.Core.BatchView+EnabledStateDelegate Grooper.Core.BatchView.EnabledStateDelegate
CommandStatesDisabled As System.Boolean System.Boolean
ContextInstance As Grooper.Core.AttendedActivity Grooper.Core.AttendedActivity
CustomIcons As System.Collections.Generic.Dictionary`2[[System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089],[System.Drawing.Bitmap, System.Drawing, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a]] System.Collections.Generic.Dictionary(Of TKey, TValue)
IsActive As System.Boolean System.Boolean
ViewerSettings As Grooper.Core.BatchView+BatchViewSettings Grooper.Core.BatchView.BatchViewSettings

Properties

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 node.
SelectedItems System.Collections.Generic.IEnumerable(Of T) Gets or sets the currenly selected Batch Objects.
SortedPages System.Collections.Generic.IEnumerable(Of T) Returns pages in order, according to the currently selected sort type.
Sorting Grooper.Core.BatchThumbnailViewer.SortType Gets or sets the sorting method for thumbnails.Can be one of the following values:
  • None
  • Intensity
  • Width
  • Height
  • AspectRatio
  • FlagStatus
  • BatchOrder
StatProperties System.Collections.Generic.IEnumerable(Of T) Returns information for each Activity Statistic class member.
ThumbSize Grooper.IP.ThumbnailCache.ThumbnailSize Gets or sets size of thumbnails to display.Can be one of the following values:
  • Smallest: 16 x 16
  • ExtraSmall: 24 x 24
  • Small: 32 x 32
  • Medium: 48 x 48
  • Large: 64 x 64
  • ExtraLarge: 96 x 96
  • Largest: 128 x 128

Methods

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() Removes all thumbnails from the control.
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() Deletes all currently selected items.
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.
NextPage(CurPage As BatchPage) As BatchPage
Parameters
CurPage
          Type: BatchPage
          
OnActivate()
OnDeactivate()
RaiseBatchStateChangedEvent()
RaiseCommandExecutedEvent(e As CommandExecutedEventArgs)
Parameters
e
          Type: CommandExecutedEventArgs
          
ReSortAfterChange() Resorts the thumbnails if the sort order is based on batch order. Call after changing the order of items in the batch.
ResumeNodeModifiedEvents()
SelectNode(Node As BatchObject)
Parameters
Node
          Type: BatchObject
          
SelectNodes(FocusedNode As GrooperNode, SelectedNodes As IEnumerable(Of BatchObject)) Selects the nodes associated with multiple BatchNode objects in the ListView 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.
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