Exports a set of Grooper nodes to a ZIP archive.
When running Grooper as a 32 bit Application, Out of Memory exceptions may occur when adding large files to a large Zip Archive using Optimal compression.
If this happens, setting the Compression Level to Fastest or NoCompression may allow the Zip Archive to be created without issue. Otherwise, adding less
Nodes to the Zip Archive is suggested to prevent this error.
Property Name |
Property Type |
Description |
ArchiveInfo |
Grooper.ArchiveInfo |
Information about the Zip Archive being Exported. |
CompressionLevel |
System.IO.Compression.CompressionLevel |
Sets the compression level to be used when adding entries to the Zip Archive.
When running Grooper as a 32 bit Application, Out of Memory exceptions may occur when adding large files to a large Zip Archive using Optimal compression.
If this happens, setting the Compression Level to Fastest or NoCompression may allow the Zip Archive to be created without issue.
Can be one of the following values:
- Optimal: The compression operation should be optimally compressed, even if the operation takes a longer time to complete.
- Fastest: The compression operation should complete as quickly as possible, even if the resulting file is not optimally compressed.
- NoCompression: No compression should be performed on the file.
|
ExportNodes |
Grooper.NodeExportDataCollection |
List of Grooper Nodes to be Exported. |
Filename |
System.String |
Full Path of the Zip Archive to be Exported. |
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. |
Password |
System.String |
Password to use when creating the Zip Archive. If the password is set, then the archive will be encrypted using it, otherwise it will be unencrypted. |
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(Items As IEnumerable(Of GrooperNode)) As Boolean |
Parameters |
Items |
Type: IEnumerable`1 |
|
|
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(Items As IEnumerable(Of GrooperNode)) |
Parameters |
Items |
Type: IEnumerable`1 |
|
|
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. |
|
OnInitialize(Items As IEnumerable(Of GrooperNode)) As Boolean |
Parameters |
Items |
Type: IEnumerable`1 |
|
|
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. |