VisualNEO Web

Plugin for creating, reading and editing .zip files.

Based on:
https://github.com/Stuk/jszip
https://stuk.github.io/jszip/

Sample App:
https://visualneo.com/tutorials/neozip

Description

The neoZip plugin for VisualNEO Web allows applications to create, read, edit, and manage .zip files, enabling users to bundle files, extract data, or dynamically generate zip archives. This plugin is built on the JSZip library and is useful for applications needing file compression or storage features, such as data export, backup, or content sharing. Here’s a detailed overview of its commands and usage:

Creating a New Zip File

The neoZipCreate command initializes a new zip file, which can then be populated with files and folders.

• Command: neoZipCreate
• Syntax: neoZipCreate "zipName"
• zipName: A unique name for the zip instance.

Example:

neoZipCreate "myZipFile"

This command creates a new zip file named myZipFile, allowing further additions.

Adding Files and Folders

The plugin includes commands to add files in various formats to the zip archive:

• neoZipAddTextFile: Adds a plain text file.
• Syntax: neoZipAddTextFile "zipName" "fileName" "File content"
• neoZipAddBinaryFile: Adds a binary file.
• Syntax: neoZipAddBinaryFile "zipName" "fileName" "[fileContent]"
• neoZipAddBase64File: Adds a base64-encoded file.
• Syntax: neoZipAddBase64File "zipName" "fileName" "[fileContent]"
• neoZipAddFolder: Adds a new folder to the zip file.
• Syntax: neoZipAddFolder "zipName" "folderName"

Example for Adding Text File:

neoZipAddTextFile "myZipFile" "docs/readme.txt" "This is the readme file."

This adds a text file named readme.txt to the docs folder inside myZipFile​​.

Saving the Zip File

The neoZipSave command saves the zip archive as a downloadable .zip file, with optional compression.

• Command: neoZipSave
• Syntax: neoZipSave "zipName" compression "fileName"
• compression: Compression level (e.g., "DEFLATE").
• fileName: Desired name for the saved .zip file.

Example:

neoZipSave "myZipFile" "4" "archive.zip"

This saves myZipFile as archive.zip with 4 level compression.

Loading and Reading Zip Files

To load an existing .zip file, use the neoZipLoad or neoZipLoadLocal command, enabling the app to read or manipulate its contents.

• neoZipLoad: Loads a zip file from a specified URL.
• Syntax: neoZipLoad "zipName" "filePath" callbackSub
• neoZipLoadLocal: Loads a user-selected zip file.
• Syntax: neoZipLoadLocal "inputFileName" "zipName" callbackSub

Once loaded, use commands like neoZipReadTextFile or neoZipReadBinaryFile to extract file content.

Example for Loading:

neoZipLoad "myZipFile" "https://example.com/files/data.zip" "onLoadComplete"

This loads data.zip from a URL into myZipFile, triggering onLoadComplete after loading​​.

Managing and Modifying Zip Contents

The plugin provides commands to modify zip content by removing files or retrieving a file list.

• neoZipRemove: Removes a file or folder from the zip archive.
• Syntax: neoZipRemove "zipName" "fileName"
• neoZipGetFileList: Retrieves a list of all files within the zip archive.
• Syntax: neoZipGetFileList "zipName" resultVar

Example:

neoZipRemove "myZipFile" "docs/oldfile.txt"

This removes oldfile.txt from the docs folder in myZipFile​.

Practical Applications

The neoZip plugin is useful for:

• Data Export and Backup: Exporting user data or backups as zip files.
• Content Sharing: Bundling multiple files for download or sharing.
• File Management: Managing file storage within applications.

The neoZip plugin adds versatile file compression and archival capabilities to VisualNEO Web, enhancing applications with efficient file handling and data management.

neoZipCreate

neoZipAddFolder

neoZipSave

neoZipSaveAsBase64

neoZipSaveAsBinary

neoZipAddTextFile

neoZipAddBase64File

neoZipAddBinaryFile

neoZipReadTextFile

neoZipReadBase64File

neoZipReadBinaryFile

neoZipRemove

neoZipLoad

neoZipLoadLocal

neoZipGetFileList

Created with the Personal Edition of HelpNDoc: Easily create iPhone documentation