Grooper.Core.IndexPanel

Displays Document Instance objects, providing a user interface for reviewing and editing the data elements associated with a document. The Index Panel is a hierarchy of Index Panel Control objects, designed to allow editing of the hierarchical Data Instance objects produced by the Extract activity.


Inherits from: Grooper.GrooperControl

Constructors

Signature Description
New ()

Fields

Field Name Field Type Description
Keystrokes As System.Int32 System.Int32
RootInstance As Grooper.Core.DocumentInstance Grooper.Core.DocumentInstance
SingleLevelDisplay As System.Boolean System.Boolean
Stat_Field_Rubberband As System.Int32 System.Int32
Stat_Field_SetZone As System.Int32 System.Int32
Stat_Section_Add As System.Int32 System.Int32
Stat_Section_Delete As System.Int32 System.Int32
Stat_Section_Rubberband As System.Int32 System.Int32
Stat_Table_AddRow As System.Int32 System.Int32
Stat_Table_DeleteRow As System.Int32 System.Int32
Stat_Table_Rubberband As System.Int32 System.Int32

Properties

Property Name Property Type Description
Ancestors System.Collections.Generic.IEnumerable(Of T) Enumerates the parent controls of this control.
DataIsValid System.Boolean Returns true if the currently loaded DocumentInstance's data is valid.

Methods

Method Name Description
Clear()
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.
DisplayFolder(Folder As BatchFolder)
Parameters
Folder
          Type: BatchFolder
          
DisplayInstance(Instance As DocumentInstance, FocusMode As InitialFocusMode, CustomCommands As IEnumerable(Of ToolStripItem)) Displays a DataInstance hierarchy.
Parameters
Instance
          Type: DocumentInstance
          The instance to display.
 
FocusMode
          Type: InitialFocusMode
          
 
CustomCommands
          Type: IEnumerable`1
          
DisplayMessage(Message As String, pa() As Object())
Parameters
Message
          Type: String
          
 
pa
          Type: Object
          
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.
GetFocusedField() As FieldInstance
HighlightInstance(Instance As DataInstance)
Parameters
Instance
          Type: DataInstance
          
ProcessCmdKey(msg As Message&, keyData As Keys) As Boolean Processes a command key.
Parameters
msg
          Type: Message&
          A , passed by reference, that represents the window message to process.
 
keyData
          Type: Keys
          One of the values that represents the key to process.
ProcessKeyPreview(m As Message&) As Boolean Overrides ProcessKeyPreview() to capture shortcut keys.
Parameters
m
          Type: Message&
          
Save(UpdateFlag As Boolean)
Parameters
UpdateFlag
          Type: Boolean
          
SetFocusedField(Field As FieldInstance)
Parameters
Field
          Type: FieldInstance
          
SetStatusMessage(Message As String, pa() As Object())
Parameters
Message
          Type: String
          
 
pa
          Type: Object
          
ShowValidationErrors(Items As ValidationErrorList, AllowInvalid As Boolean) As Boolean
Parameters
Items
          Type: ValidationErrorList
          
 
AllowInvalid
          Type: Boolean
          
StartRubberbandOperation(Element As IndexPanelControl, Data As Object)
Parameters
Element
          Type: IndexPanelControl
          
 
Data
          Type: Object
          
SuppressKey(Control As Control)
Parameters
Control
          Type: Control
          
ValidateObject(Item As GrooperObject, AllowInvalid As Boolean) As Boolean
Parameters
Item
          Type: GrooperObject
          
 
AllowInvalid
          Type: Boolean
          
ValidateProperties() As ValidationErrorList