Wordize SDK is designed to perform high-level document processing tasks. Its primary focus is on operations such as template-based document generation, document conversion, merging, splitting, comparison, modifying content through regular expressions, adding watermarks or signatures. These capabilities allow developers to automate and optimize document flow without having to manipulate the internal, element-level structure of documents.
Wordize SDK does not support DOM-level document processing: traversal of the document structure, creation, modification, deletion of individual elements. Instead, it offers high-level content editing capabilities via regular expressions.
Wordize SDK includes a number of functional units, referred to as modules. These modules are divided into two main groups: File Format Modules, which allow you to work with specific file types, and Document Processing Modules, which provide tools for performing various operations on documents. Some modules, such as Wordize Core and Wordize Rendering, belong to both groups at the same time.
File Format Modules
| Module Name | Provided Functionality |
|---|---|
| Wordize Core | Support for Word document formats |
| Wordize eBook | Support for e-book file formats |
| Wordize OpenOffice | Support for OpenOffice document formats |
| Wordize PDF Load | Support for reading PDF files |
| Wordize Rendering | Support for writing results to fixed layout and image formats |
| Wordize Web | Support for web-based document formats |
Document Processing Modules
| Module Name | Provided Functionality |
|---|---|
| Wordize Core | Core functionality, including the ability to convert file formats |
| Wordize Comparison | Compare documents, identifying differences in content and formatting |
| Wordize LINQ Reporting | Generate high quality reports using templates and a functional programming approach |
| Wordize Mail Merge | Generate personalized documents by merging data from various sources into Word templates |
| Wordize Merge | Combine multiple documents into a single file |
| Wordize Rendering | Render document pages into fixed layout and image formats |
| Wordize Replacement | Find and replace text in documents using regular expressions |
| Wordize Signature | Add and verify digital signatures in documents |
| Wordize Splitting | Split large documents into smaller parts |
| Wordize Watermark | Add and remove watermarks in documents |
For detailed information about the modules, see the Documentation.
Wordize SDK enables reading from all supported input formats and writing to all supported output formats regardless of other conditions, but full unrestricted functionality, such as unlimited paragraph processing and watermark-free outputs, depends entirely on the licenses you hold. These licenses define which formats can be used without operational limitations, though the core I/O format support itself remains unaffected.
For example, if you have licenses for the PDF Load and Signature modules, but no license for the Rendering module, you are free to read and sign PDF without restrictions. However, exporting the results to PDF will be limited to Evaluation mode, which automatically adds watermarks. While you technically retain the ability to sign such watermarked PDF files, these watermarks make the document unsuitable for official use.
Thus, the lack of installed licenses has a significant impact on I/O operations, but in no way prevents any file format from being technically available or functional in its basic form. This approach ensures that even with limited functionality all I/O formats remain available for evaluation.
For detailed information about the file formats supported by each module, see the Documentation.
Wordize SDK allows you to both read PDF files and save results in PDF format, but these features require separate licenses if you want to work with PDF without restrictions:
- To read and process PDF files, you’ll need a license for the PDF Load module
- To save results in PDF format, you’ll need a license for the Rendering module.
Wordize Rendering module is used to convert document pages into a wide variety of fixed page layout and image formats. Fixed layout formats (e.g., PDF, XPS, HtmlFixed, SVG, PS) preserve the exact layout, structure and appearance of document’s pages, ensuring that content looks the same regardless of the device, platform or viewer used. Image formats (e.g., JPG, PNG, WEBP, EMF, SVG) are ideal for embedding content into web pages or applications.
A license for the Rendering module is required if you want to save the results to PDF without restrictions.
Wordize doesn’t support document creation in the usual sense, i.e. by assembling a DOM-tree structure from individual elements. Instead, Wordize provides powerful functionality for generating documents using templates and external data:
-
The LINQ Reporting module allows developers to use templates that contain predefined layouts and placeholders for dynamic data. The LINQ Reporting Engine, which is the core of this module, will allow you to populate these templates with data from various sources such as databases, JSON or XML files.
-
The Mail Merge module also simplifies document generation by merging data into predefined Word templates. This functionality is typically used to create personalized documents, such as letters or certificates, where static content is combined with dynamic fields that are replaced with specific data during the merge process.
Wordize supports modification of document content, but this functionality operates at a relatively high level. The Replacement module enables you to search for text fragments in a document using regular expressions (RegEx). Once these patterns are identified, they can be replaced with new values, including dynamically generated ones. This makes the Replacement module an effective tool for document content modification tasks.
Wordize does not support editing documents via the Document Object Model (DOM). This means that you cannot directly interact with or modify the internal structure of a document. You can only modify text content.
Yes, Wordize SDK offers robust tools specifically designed for this purpose. Wordize provides two key approaches to create reports programmatically: the LINQ Reporting Engine and Mail Merge functionality.
The LINQ Reporting Engine allows developers to generate dynamic and structured reports using templates with plain-text tags. These templates can include placeholders for data, which are populated programmatically from various sources, such as databases, XML files, JSON files. This approach makes it easy to create professional-quality reports with complex layouts, charts, and tables, all while maintaining a clean and efficient workflow.
In addition, Wordize offers the Mail Merge functionality, which simplifies the generation of personalized reports by merging data into predefined templates. This functionality is particularly useful for creating large volumes of personalized documents, such as invoices, letters, certificates, or detailed individual reports.
Yes, you can explore the Wordize SDK for free using two methods: Evaluation Access and a Trial (Temporary) license.
-
Use Evaluation Access to test the core functionality. Wordize SDK operates in Evaluation Access mode by default when you install the SDK. This requires no additional setup, registrations, or approvals. Simply integrate the SDK into your project and start experimenting. Once you confirm the SDK aligns with your project’s needs in Evaluation Access, we recommend upgrading to a Trial license.
-
Use Trial (Temporary) license to get free full-featured access to the SDK for 30 days. You will be able to test the performance of Wordize SDK in a production environment. This includes assessing how the SDK handles large-scale data processing, complex workflows, and high-performance requirements.
This flexible approach allows you to adjust your usage depending on your needs. Start with Evaluation Access if you are in the early stages of research or need basic functionality for small tasks. Upgrade to a Trial license if you’re ready to test the SDK in a production environment or need to demonstrate the full potential of the SDK to stakeholders. By offering both options, Wordize ensures that you can risk-free test the effectiveness of the software solution before moving to a commercial plan.
You can find questions and answers about license types in the ‘License’ section of this FAQ.
Evaluation Access mode is designed for early stage evaluation and imposes the following restrictions:
- A limited number of paragraphs can be processed per method call. This can be either the number of paragraphs at the input or the number of paragraphs at the output.
- Output documents may contain watermarks.
- Some advanced features may be unavailable.
If you need unrestricted access to validate the SDK for production-grade workflows, proceed to the Trial (Temporary) license.
You can integrate the Wordize SDK into your projects in two ways:
-
Using NuGet Package Manager (recommended). This is the most preferred method due to its seamless integration with .NET workflows, automatic dependency management, and compatibility with modern IDEs. Supported IDEs: Visual Studio (Windows/macOS), JetBrains Rider (Windows/macOS/Linux), VS Code (cross-platform).
In Visual Studio or JetBrains Rider: - Right-click your project in Solution Explorer. - Select Manage NuGet Packages. - In the Browse tab, search for “Wordize”. - Select the package and click Install.
In VS Code or Command Line: - Open the terminal in your project directory. - Run:
dotnet add package Wordize -
Using .NET CLI. This method is suitable for developers who prefer command-line tools or work in terminal-centric environments. Supported Platforms: Windows, macOS, Linux.
- Navigate to your project directory via terminal.
- Run:
dotnet add package Wordize - Build your project to verify integration:
dotnet build
Please refer to the Documentation for detailed installation instructions.
-
Test Core Features. The Evaluation Access mode lets you experiment with basic functionality to assess compatibility and relevance. Test critical workflows with scaled-down data volumes. Measure speed, resource usage, and accuracy under your specific use case.
-
Explore the Documentation. The official documentation includes detailed descriptions of classes, methods and parameters, as well as ready-to-execute C# code samples.
-
Build a Prototype. Creating a prototype will help you make an informed decision about whether to proceed with a full-scale implementation.
-
Plan for Full-featured Testing in a production environment. If Wordize SDK meets your needs in Evaluation Access mode, consider upgrading to a Trial (Temporary) License. This license is available for 30 days and provides full access to all SDK features without any restrictions.
-
Contact our Support Team. Assistance is free for all customers, including those testing the Evaluation version. Wordize experts are ready to answer your questions and help you figure out whether Wordize SDK is right for your needs.
If you have previously purchased a license for a particular module, check the subscription expiration date for that module before upgrading. Please note that if you upgrade to an SDK version released after your subscription expires, the functionality of the licensed module will go into Evaluation mode (in this case, you will need to undo the SDK update to return the module to fully functional mode).
To update Wordize SDK, use one of the methods below based on your original installation approach:
-
Update via NuGet Package Manager (recommended)
- Open your IDE (Visual Studio, JetBrains Rider, or VS Code).
- In Solution Explorer, right-click your project and select Manage NuGet Packages.
- Navigate to the Updates tab.
- Locate Wordize SDK in the list, select the latest version, and click Update.
- Rebuild your project to apply changes.
-
Update via .NET CLI
- Open the terminal in your project directory.
- Run the following command to update the package:
dotnet update package Wordize - Rebuild the project:
dotnet build
Wordize provides you with the following support options:
- You can post your questions on Wordize community forums, where both Wordize support team and other users can assist you. We recommend using this method to ensure a fast and efficient support team workflow. Our forum is a place of collective discussion where information about your issue is easily accessible at any time. If your issue is related to feature enhancements or bug fixes, the content of forum discussions is used to create detailed tickets for our developers. This ensures that your problem is accurately communicated and prioritized for resolution.
- You can contact our support team directly by sending an email to support@wordize.com. However, we strongly recommend using Wordize community forums, as it helps to resolve issues more efficiently.
- You can also refer to the Documentation to find the answer to your question there. Exhaustive documentation covers all major aspects of using the SDK, including a step-by-step installation process, licensing, API usage, and more.