Property Name |
Property Type |
Description |
AttributesToClear |
System.IO.FileAttributes |
File attributes which should be cleared on each file after import.A combination of the following flags:
- ReadOnly: The file is read-only.
- Hidden: The file is hidden, and thus is not included in an ordinary directory listing.
- System: The file is a system file. That is, the file is part of the operating system or is used exclusively by the operating system.
- Directory: The file is a directory.
- Archive: The file is a candidate for backup or removal.
- Device: Reserved for future use.
- Normal: The file is a standard file that has no special attributes. This attribute is valid only if it is used alone.
- Temporary: The file is temporary. A temporary file contains data that is needed while an application is executing but is not needed after the application is finished. File systems try to keep all the data in memory for quicker access rather than flushing the data back to mass storage. A temporary file should be deleted by the application as soon as it is no longer needed.
- SparseFile: The file is a sparse file. Sparse files are typically large files whose data consists of mostly zeros.
- ReparsePoint: The file contains a reparse point, which is a block of user-defined data associated with a file or a directory.
- Compressed: The file is compressed.
- Offline: The file is offline. The data of the file is not immediately available.
- NotContentIndexed: The file will not be indexed by the operating system's content indexing service.
- Encrypted: The file or directory is encrypted. For a file, this means that all data in the file is encrypted. For a directory, this means that encryption is the default for newly created files and directories.
- IntegrityStream: The file or directory includes data integrity support. When this value is applied to a file, all data streams in the file have integrity support. When this value is applied to a directory, all new files and subdirectories within that directory, by default, include integrity support.
- NoScrubData: The file or directory is excluded from the data integrity scan. When this value is applied to a directory, by default, all new files and subdirectories within that directory are excluded from data integrity.
|
AttributesToSet |
System.IO.FileAttributes |
File attributes which should be set on each file after import.A combination of the following flags:
- ReadOnly: The file is read-only.
- Hidden: The file is hidden, and thus is not included in an ordinary directory listing.
- System: The file is a system file. That is, the file is part of the operating system or is used exclusively by the operating system.
- Directory: The file is a directory.
- Archive: The file is a candidate for backup or removal.
- Device: Reserved for future use.
- Normal: The file is a standard file that has no special attributes. This attribute is valid only if it is used alone.
- Temporary: The file is temporary. A temporary file contains data that is needed while an application is executing but is not needed after the application is finished. File systems try to keep all the data in memory for quicker access rather than flushing the data back to mass storage. A temporary file should be deleted by the application as soon as it is no longer needed.
- SparseFile: The file is a sparse file. Sparse files are typically large files whose data consists of mostly zeros.
- ReparsePoint: The file contains a reparse point, which is a block of user-defined data associated with a file or a directory.
- Compressed: The file is compressed.
- Offline: The file is offline. The data of the file is not immediately available.
- NotContentIndexed: The file will not be indexed by the operating system's content indexing service.
- Encrypted: The file or directory is encrypted. For a file, this means that all data in the file is encrypted. For a directory, this means that encryption is the default for newly created files and directories.
- IntegrityStream: The file or directory includes data integrity support. When this value is applied to a file, all data streams in the file have integrity support. When this value is applied to a directory, all new files and subdirectories within that directory, by default, include integrity support.
- NoScrubData: The file or directory is excluded from the data integrity scan. When this value is applied to a directory, by default, all new files and subdirectories within that directory are excluded from data integrity.
|
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. |
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. |
Method Name |
Description |
CanExecute(Item As FileSystemLink) As Boolean |
Parameters |
Item |
Type: FileSystemLink |
|
|
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(Link As FileSystemLink) |
Parameters |
Link |
Type: FileSystemLink |
|
|
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. |