Aspose.Words for .NET Examples

AI-friendly repository containing validated C# examples for Aspose.Words for .NET API.

Persona

Act as a senior .NET documentation editor who provides clear, concise guidance for using Aspose.Words examples.

When working in this repository:

• Keep every .cs file as a standalone console application.
• Require successful dotnet build and dotnet run verification.
• Follow category-level AGENTS.md guidance for feature-specific constraints.

Repository Overview

The repository provides ready-to-run console samples that demonstrate how to use Aspose.Words for .NET across many scenarios. Each example is self-contained, builds on the documented API, and can be executed with minimal setup.

Statistics (as of 2026-11-05):

• Total Examples: 1793
• Categories: 29
• Overall Pass Rate: 100.0%
• Source Run: 20261102_031946_08fb5b

Category Details

barcode-image

• Examples: 30
• Guide: AGENTS.md

charts

• Examples: 39
• Guide: AGENTS.md

comments

• Examples: 30
• Guide: AGENTS.md

comparison

• Examples: 30
• Guide: AGENTS.md

content-control

• Examples: 35
• Guide: AGENTS.md

conversion

• Examples: 108
• Guide: AGENTS.md

extraction

• Examples: 30
• Guide: AGENTS.md

find-and-replace

• Examples: 63
• Guide: AGENTS.md

fonts

• Examples: 35
• Guide: AGENTS.md

form-fields

• Examples: 30
• Guide: AGENTS.md

hyphenation

• Examples: 40
• Guide: AGENTS.md

images

• Examples: 120
• Guide: AGENTS.md

join-documents

• Examples: 36
• Guide: AGENTS.md

linq-reporting

• Examples: 403
• Guide: AGENTS.md

lists

• Examples: 30
• Guide: AGENTS.md

mail-merge

• Examples: 30
• Guide: AGENTS.md

officemath

• Examples: 30
• Guide: AGENTS.md

ole-objects

• Examples: 29
• Guide: AGENTS.md

paragraphs

• Examples: 35
• Guide: AGENTS.md

programming-with-documents

• Examples: 110
• Guide: AGENTS.md

range

• Examples: 30
• Guide: AGENTS.md

rendering

• Examples: 70
• Guide: AGENTS.md

security-and-protection

• Examples: 30
• Guide: AGENTS.md

shapes

• Examples: 35
• Guide: AGENTS.md

split-document

• Examples: 30
• Guide: AGENTS.md

track-changes

• Examples: 40
• Guide: AGENTS.md

vba-macros

• Examples: 34
• Guide: AGENTS.md

watermark

• Examples: 33
• Guide: AGENTS.md

working-with-table

• Examples: 198
• Guide: AGENTS.md

Boundaries

Always

• Use public Aspose.Words APIs and keep examples self-contained.
• Keep each example as a single .cs console application.
• Build with net8.0 and the configured package version.
• Save the resulting document or output file when the task requires output.
• Keep input and output paths explicit and easy to follow.
• Prefer category-level guidance from each folder's AGENTS.md.

Ask First

• Adding extra NuGet packages beyond the known verifier package set.
• Changing shared repository infrastructure or project templates.
• Introducing platform-specific behavior not already present in the examples.

Never

• Never create multi-file example projects for a single example.
• Never use invented or unsupported Aspose.Words APIs.
• Never modify generated AGENTS.md, README.md, or index.json by hand without regenerating related metadata.
• Never rely on missing external input files; bootstrap sample inputs locally when possible.

Repository Structure

AGENTS.md
README.md
index.json
llm.txt
+-- barcode-image/
+-- charts/
+-- comments/
+-- comparison/
+-- content-control/
+-- conversion/
+-- extraction/
+-- find-and-replace/
+-- fonts/
+-- form-fields/
+-- hyphenation/
+-- images/
+-- join-documents/
+-- linq-reporting/
+-- lists/
+-- mail-merge/
+-- officemath/
+-- ole-objects/
+-- paragraphs/
+-- programming-with-documents/
+-- range/
+-- rendering/
+-- security-and-protection/
+-- shapes/
+-- split-document/
+-- track-changes/
+-- vba-macros/
+-- watermark/
+-- working-with-table/

Category Index

Command Reference

Create a temporary console project

dotnet new console -n ExampleProject --framework net8.0
cd ExampleProject

Add required packages

dotnet add package Aspose.Words --version 26.10.0

Add other packages only when an example requires them, for example:

dotnet add package Aspose.BarCode --version 26.8.0
dotnet add package Aspose.Drawing.Common --version 26.8.0
dotnet add package Newtonsoft.Json
dotnet add package SkiaSharp --version 3.119.0
dotnet add package System.Text.Encoding.CodePages --version 9.0.2

Copy and run one example

Copy-Item ..\<category-folder>\<example-file>.cs .\Program.cs
dotnet build --configuration Release --verbosity minimal
dotnet run --configuration Release --no-build

Notes for Agents

• Use root metadata for repository navigation and category metadata for feature-specific implementation guidance.
• Preserve exact file-to-task traceability when updating generated examples.
• Keep every example as a standalone console application with explicit inputs and outputs.
• Use the package versions and additional dependencies recorded for the selected category.
• Require successful build and runtime verification before publishing an example.
• Regenerate README.md, AGENTS.md, index.json, and llm.txt together instead of editing generated metadata independently.
• Keep raw generation evidence as diagnostic input separate from publication-ready documentation.

Metadata Maintenance

• Regenerate root metadata after category content, package versions, or validation results change.
• Preserve metadata-sources as the audit trail for prompts, raw diagnostics, polished sections, and assembly manifests.
• Keep the generated maintenance attribution and refresh its date whenever root metadata is rebuilt.

Maintained by an agentic example generation workflow | For repository overview, see README.md | Last updated: 2026-11-05