Documentize.AddTable
Inserts an Excel worksheet as a table into a PDF.
This is one of the Documentize CLI plugins: a small, self-contained command-line tool. What you download from the Documentize CLI Plugin Catalog is a pre-built, obfuscated .NET assembly (a .dll) -- not source code -- so you run it directly; no build step, SDK, or source checkout required.
Requirements
- .NET 10 runtime installed on your computer (Windows, macOS, or Linux). The download is a
pre-built, obfuscated Documentize.AddTable.dll -- not source -- so the .NET SDK is not required, only the runtime.
- An Aspose Documentize license file,
documentize.lic, placed next to Documentize.AddTable.dll
(the plugin runs in Aspose evaluation/unlicensed mode if it is absent).
OS packages
This plugin renders/edits documents through Aspose. On Linux, .NET's System.Drawing/GDI+ compatibility layer (libgdiplus) and a font configuration (fontconfig + at least one font family) are required for correct text measurement and rendering.
Windows
No extra OS packages are normally required — GDI+ and fonts are part of Windows. If the document uses fonts not installed system-wide, install them normally (Settings > Fonts) so Aspose can find them.
Linux (primary platform)
sudo apt-get update
sudo apt-get install -y libgdiplus fontconfig fonts-liberation fonts-dejavu-core
# Recommended for documents authored with Microsoft-compatible fonts:
sudo apt-get install -y ttf-mscorefonts-installer
fc-cache -f
Run
From the terminal (Linux) / cmd or PowerShell (Windows)
Run it:
# Any OS, with just the .NET 10 runtime installed
dotnet Documentize.AddTable.dll --insert-page-before 1 --sheet-name value
# If the download includes a native executable for your OS, you can also run it directly:
./Documentize.AddTable --insert-page-before 1 --sheet-name value # Linux/macOS
.\Documentize.AddTable.exe --insert-page-before 1 --sheet-name value # Windows (cmd.exe or PowerShell)
Show all available options:
dotnet Documentize.AddTable.dll --help
Input and output files
The plugin does not take file paths as CLI flags. It reads input from, and writes output to, a per-task folder pair:
- Input folder:
<PLUGIN_INPUT_DIR>/<task-id>/ -- env var PLUGIN_INPUT_DIR, defaults to
%TEMP%\documentize\input on Windows and /tmp/documentize/input on Linux/macOS.
- Output folder:
<PLUGIN_OUTPUT_DIR>/<task-id>/ -- env var PLUGIN_OUTPUT_DIR, defaults to
%TEMP%\documentize\output on Windows and /tmp/documentize/output on Linux/macOS.
Always pass an explicit --task-id so you know which folder to use -- if you omit it, the plugin generates a random GUID internally that you won't know in advance.
Place a PDF (*.pdf, required) in the input folder and, if you want to import a table from a spreadsheet, an Excel file (*.xlsx, optional) alongside it -- pick the worksheet with --sheet-name.
Example (Windows PowerShell):
$env:PLUGIN_INPUT_DIR = "C:\documentize-work\input"
$env:PLUGIN_OUTPUT_DIR = "C:\documentize-work\output"
New-Item -ItemType Directory -Force "$env:PLUGIN_INPUT_DIR\job1" | Out-Null
Copy-Item report.pdf "$env:PLUGIN_INPUT_DIR\job1\"
Copy-Item table.xlsx "$env:PLUGIN_INPUT_DIR\job1\"
dotnet Documentize.AddTable.dll --task-id job1 --insert-page-before 1 --sheet-name value
dir "$env:PLUGIN_OUTPUT_DIR\job1"
The output folder also gets a <task-id>.json handoff file alongside the result -- that's metadata for the Plugin Manager and can be ignored for standalone/manual use.
CLI options
| Flag | Type | Default | Description | |---|---|---|---| | --insert-page-before | int | null | Insert the table before this page number; null = append. | | --sheet-name | string | null | Worksheet name to import; null = first sheet. | | --first-row-is-header | bool | false | Treat the first row as a header row. | | --max-rows | int | 1000 | Maximum rows to import (default 1000). | | --max-columns | int | 50 | Maximum columns to import (default 50). |
Every plugin also accepts --task-id <guid> (alias --id) to set the task id used for the input/output working directories; if omitted, a new GUID is generated.
Alternative input: base64 task JSON
As an alternative to --flags, the plugin also accepts a single base64-encoded JSON argument instead. JSON field names are PascalCase (matching the CLI options above), plus an "ID" field for the task id (same as --task-id/--id; a fresh GUID is generated if omitted). Full field spec:
| JSON field | Type | Required | Default | Description | |---|---|---|---|---| | ID | string (GUID) | no | new GUID if omitted | Task id -- same as --task-id/--id. | | InsertPageBefore | integer | no | null | Insert the table before this page number; null = append. | | SheetName | string | no | null | Worksheet name to import; null = first sheet. | | FirstRowIsHeader | boolean | no | false | Treat the first row as a header row. | | MaxRows | integer | no | 1000 | Maximum rows to import (default 1000). | | MaxColumns | integer | no | 50 | Maximum columns to import (default 50). |
Full example:
{ "ID": "b1e6a4b0-0000-0000-0000-000000000000", "InsertPageBefore": null, "SheetName": null, "FirstRowIsHeader": false, "MaxRows": 1000, "MaxColumns": 50 }
Encode it to base64 and pass that as the plugin's only argument:
# Windows PowerShell
$json = '{ "ID": "b1e6a4b0-0000-0000-0000-000000000000", "InsertPageBefore": null, "SheetName": null, "FirstRowIsHeader": false, "MaxRows": 1000, "MaxColumns": 50 }'
$b64 = [Convert]::ToBase64String([Text.Encoding]::UTF8.GetBytes($json))
dotnet Documentize.AddTable.dll $b64
# Linux/macOS
python3 -c "import base64; print(base64.b64encode('{ \"ID\": \"b1e6a4b0-0000-0000-0000-000000000000\", \"InsertPageBefore\": null, \"SheetName\": null, \"FirstRowIsHeader\": false, \"MaxRows\": 1000, \"MaxColumns\": 50 }'.encode()).decode())"
dotnet Documentize.AddTable.dll <base64-string-from-above>
Exit codes
| Code | Meaning | |---|---| | 0 | Success | | 1 | The task ran but failed (see stderr for the exception) | | 2 | Usage/argument error (missing required option, invalid value, --help) |