Property Name |
Property Type |
Description |
DocumentTypes |
System.Collections.Generic.List(Of T) |
The document types for which control sheets should be created. |
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. |
OutputFolder |
System.String |
The folder in which the generated control sheets should be placed. This folder will be created as a child of the 'Control Sheets' folder. If no folder name is specified, the generated control sheets will be placed in the root of the 'Control Sheets' folder. |
Root |
Grooper.GrooperRoot |
Returns the root node |
SeparationLevel |
System.Int32 |
The folder level within the batch at which separation should occur. |
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. |
Method Name |
Description |
CanExecute(Item As ContentType) As Boolean |
Parameters |
Item |
Type: ContentType |
|
|
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(Item As ContentType) |
Parameters |
Item |
Type: ContentType |
|
|
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. |
|
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. |