Installing Sheetize via NuGet

How to Install via NuGet Package Manager Console

• Open Your Project:

  • Launch Visual Studio and open your .NET application.

• Access the Package Manager Console:

  • Navigate to Tools > NuGet Package Manager > Package Manager Console.

• Install the Package:

  • To install the latest full release, enter the command Install-Package Sheetize.
  • To install the latest release including hot fixes, use Install-Package Sheetize -prerelease.
  • Press Enter to execute the command.

How to Update Package via NuGet Package Manager Console

If you have already installed Sheetize via NuGet and want to update to the latest version:

• Open Your Project:

  • Launch Visual Studio and open your .NET application.

• Access the Package Manager Console:

  • Navigate to Tools > NuGet Package Manager > Package Manager Console.

• Update the Package:

  • To update to the latest full release, enter Update-Package Sheetize.
  • To update to the latest release including hot fixes, use Update-Package Sheetize -prerelease.
  • Press Enter to execute the command.

How to Install via NuGet Package Manager GUI

• Open Your Project:

  • Launch Visual Studio and open your .NET application.

• Navigate to Manage NuGet Packages:

  • From the Project menu, select Manage NuGet Packages.

• Search for Sheetize:

  • Go to the Browse tab and enter Sheetize into the search box.

• Install the Package:

  • Click Install/Update next to the latest version of Sheetize.
  • Confirm by clicking Accept in the pop-up window.

Pros of Using NuGet

• Automatic Dependency Management:

  • NuGet automatically handles dependencies, ensuring all required libraries are included and updated correctly.

• Simplified Updates:

  • Updating packages is straightforward with NuGet, either through the Package Manager Console or GUI.

• Integrated with Visual Studio:

  • NuGet is seamlessly integrated with Visual Studio, offering a user-friendly interface for package management.

• Versioning:

  • NuGet allows you to manage different library versions, making it easy to revert to previous versions or test new releases.

Cons of Using NuGet

• Limited to Visual Studio:

  • NuGet is primarily designed for Visual Studio, though it can be used in other environments with less integration.

• Potential for Version Conflicts:

  • Managing versions in larger projects can become complex, requiring careful attention.

• Network Dependency:

  • Installing and updating packages requires an internet connection. Offline use may require pre-downloaded packages.

• Complexity for Large Projects:

  • Large projects with extensive dependencies may find NuGet management more cumbersome, necessitating additional tools or strategies.

Installing Documentize via ZIP

How to Install via ZIP Archive

• Download the ZIP Archive:

  • Click the to download the latest version of Documentize in an archive format.

• Extract the Contents:

  • After downloading, extract the contents of the ZIP file to a directory of your choice. You can choose to keep these files in a shared directory or within your project structure.

• Add References to Your Project:

  • Open your project in your IDE (e.g., Visual Studio).
  • Go to Project > Add Reference > Browse and navigate to the directory where you extracted the DLLs.
  • Select the relevant DLL files and add them as references to your project.

• Manual Updates:

  • If a new version of Documentize is released, you will need to manually download the updated ZIP archive and replace the old DLL files in your project with the new ones.

Pros of Using the ZIP Archive

• Complete Control:

  • You have full control over where and how the DLLs are stored and referenced in your project. This can be beneficial if you prefer a custom setup or need to manage dependencies manually.

• No Dependency on Package Managers:

  • Unlike NuGet, you don’t rely on a package manager to handle installations. This can be advantageous in environments where package managers are not available or preferred.

• Portability:

  • The ZIP archive can be easily shared and moved across different systems, making it ideal for projects that need to be portable or distributed without relying on external tools.

Cons of Using the ZIP Archive

• Manual Management:

  • Unlike NuGet, where updates and dependency management are automated, with the ZIP archive, you must manually manage updates and ensure that all required DLLs are correctly referenced.

• Risk of Version Conflicts:

  • If you’re managing multiple projects or working in a team, there’s a risk of version conflicts if different projects use different versions of the DLLs. This requires careful tracking of versions across projects.

• No Automatic Updates:

  • You won’t receive automatic updates or notifications when a new version is available. This can lead to the risk of using outdated libraries unless you regularly check for updates.

Installing Sheetize via MSI

How to Install Sheetize via MSI Installer

• Download the MSI Installer:

  • Click the to download the MSI installer for the latest version of Sheetize.

• Run the Installer:

  • Double-click the downloaded MSI file to launch the installation wizard.

• Follow the Installation Wizard:

  • Follow the on-screen instructions. You may need to agree to the license agreement and select installation options.

• Complete the Installation:

  • Once the installation is complete, the Sheetize DLLs will be installed into your system’s Global Assembly Cache (GAC) or another specified location.

• Verify Installation:

  • Check that the DLLs are correctly installed by verifying their presence in the designated installation directory or GAC.

Pros of Using the MSI Installer

• Ease of Use:

  • The MSI installer provides a straightforward and guided installation process, ensuring all necessary configurations are handled automatically.

• System-wide Installation:

  • Installs Sheetize into the system’s Global Assembly Cache (GAC) or another central location, making it accessible across multiple projects on the same system.

• Automated Updates:

  • Updates are seamless when using a new MSI file, as the installer typically manages updates efficiently.

• Consistency:

  • Ensures all required files are installed correctly and consistently across different environments, reducing the risk of missing dependencies.

Cons of Using the MSI Installer

• Limited Flexibility:

  • The system-wide installation might not suit projects requiring custom or localized configurations.

• Potential Overhead:

  • Installing to the GAC can add complexity, particularly if multiple versions of Sheetize are needed for different projects.

• Manual Removal:

  • Uninstalling requires the MSI uninstaller, which might leave residual files or configurations behind if not thoroughly managed.

• Version Conflicts:

  • System-wide installations can lead to conflicts if projects need different versions of Sheetize. Resolving such conflicts may require additional configuration.

Non-Windows Environment

Working with .NET Core DLLs in Non-Windows Environment

As Sheetize for .NET supports .NET Standard 2.0 (.NET Core 2.0), it can be used in Core Applications running on Linux-based operating systems. While the API is continually optimized for .NET Core environments, there are a few steps you should take to ensure better results when using Sheetize features in non-Windows environments.

Required Packages

1. libgdiplus
   Install the libgdiplus package to enable compatibility with graphical features on Linux.

2. Microsoft-Compatible Fonts
   Install fonts using the ttf-mscorefonts-installer package:

   • Run: sudo apt-get install ttf-mscorefonts-installer
   • Ensure the fonts are located in the /usr/share/fonts/truetype/msttcorefonts directory, as Sheetize scans this location by default.

Custom Font Folder

If your Linux operating system uses a different default font folder or you cannot place fonts in the system directory (e.g., on cloud servers), you can specify a custom font folder in your application code:

1. Create a folder named fonts in your program directory.
2. Copy the required font files into this folder.
3. Set the custom font path in your program:
   Sheetize.FontConfigs.SetFontFolder("fonts", true);

This ensures that Sheetize can locate and use the fonts from your project directory, even in restricted environments.

Using Fonts in Docker

If running your application in a Docker environment, you can copy the fonts to the system path during the build process:

1. Place the font files in a fonts folder in your project directory.
2. Add this to your Dockerfile:
   COPY fonts/ /usr/share/fonts

This ensures the required fonts are available in the Docker container for Sheetize to use.

Why Font Management Matters

Proper font management ensures accurate rendering of spreadsheets in environments where default fonts are limited. Without the correct fonts:

• Layouts and formatting may differ from the original file.
• Characters might not render as expected, affecting the quality of your output.

Configuring fonts as described will help produce consistent and satisfactory results when processing spreadsheets with Sheetize on non-Windows systems.