Grooper.PropertyGrid

The Grooper Property Grid control displays properties for Grooper objects and it retrieves the item's properties.


Inherits from: Grooper.GrooperControl

Constructors

Signature Description
New ()

Properties

Property Name Property Type Description
Ancestors System.Collections.Generic.IEnumerable(Of T) Enumerates the parent controls of this control.
HelpDisplayTarget Grooper.PropertyGrid If set, directs this PropertyGrid to use the help display area of another PropertyGrid control.
HelpVisible System.Boolean Determines whether the help window is visible.
LabelRatio System.Double Allows for the adjustment of the Property Label column width.
PropertySort System.Windows.Forms.PropertySort Determines how properties are sorted.Can be one of the following values:
  • NoSort: Properties are displayed in the order in which they are retrieved from the .
  • Alphabetical: Properties are sorted in an alphabetical list.
  • Categorized: Properties are displayed according to their category in a group. The categories are defined by the properties themselves.
  • CategorizedAlphabetical: Properties are displayed according to their category in a group. The properties are further sorted alphabetically within the group. The categories are defined by the properties themselves.

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.
DisplayObject(obj As GrooperObject)
Parameters
obj
          Type: GrooperObject
          
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.
HandleTab(sender As Object, e As EventArgs)
Parameters
sender
          Type: Object
          
 
e
          Type: EventArgs
          
RaisePropertyValueChangedEvent(OldValue As Object)
Parameters
OldValue
          Type: Object
          
RaisePropertyValueChangedEventForProperty(pd As PropertyDescriptor) Raises a Property Value Changed event for the property whose type is the provided descriptor.
Parameters
pd
          Type: PropertyDescriptor
          The descriptor of the property on which to raise the change event.
RefreshObject()
ShowValidationErrors(Items As ValidationErrorList, AllowInvalid As Boolean) As Boolean
Parameters
Items
          Type: ValidationErrorList
          
 
AllowInvalid
          Type: Boolean
          
ValidateObject(Item As GrooperObject, AllowInvalid As Boolean) As Boolean
Parameters
Item
          Type: GrooperObject
          
 
AllowInvalid
          Type: Boolean
          
ValidateProperties() As ValidationErrorList

Events

Event Name Description
PropertyValueChanged(sender As Object, e As PropertyValueChangedEventArgs) Fired each time a property value in the property grid changes.

PropertyValueChangedEventArgs

Commands

Command Name Description
Mapping Collection - Auto Map Adds mappings based on similar target and source property names.
Grooper Object - Load Property Values Load properties for this object from a file.
Exchange - Rebuild Search Folder Deletes and recreates the Exchange search folder created by Grooper.
Grooper Object - Reset Reset the selected property back to its default value.
Grooper Object - Reset All Reset all properties back to their default value.
Grooper Object - Save Property Values Save the properties of this object to a file.
Tesseract OCR - Train Font Trains Tesseract OCR to recognize special fonts.