1. Home
  2. /
  3. GroupDocs.Conversion.LowCode
  4. /
  5. Getting Started
  6. /
  7. Running Examples

Running Examples

This page provides instructions on how to set up and run code examples for GroupDocs.Conversion.LowCode. The examples are designed to demonstrate basic and detailed scenarios when using the GroupDocs.Conversion.LowCode package.

Prerequisites

Before running the examples, make sure you have:

  1. Configured your environment as described in the System Requirements topic.
  2. Downloaded one of the repositories with code examples:
Note
This guide demonstrates how to run examples in C#, but the process is similar for VB.NET and F# examples.

Project Structure

The example repository is structured similarly to this documentation, making it easy to find the code examples and related input documents.

groupdocs-conversion-lowcode-examples-csharp/
├── 📂 licensing/
│   ├── 📂 SetLicenseFromFile/
│   └── 📂 SetLicenseKeys/
├── 📂 getting-started/
│   └── 📂 quick-start-guide/
│       └── 📂 AddConversionCode/
├── 📂 developer-guide/
│   ├── 📂 loading-source-documents/
│   │   ├── 📂 LoadFromFilePath/
│   │   ├── 📂 LoadFromStream/
│   │   └── 📂 SetLoadOptions/
│   ├── 📂 saving-converted-documents/
│   │   ├── 📂 SaveToFilePath/
│   │   ├── 📂 SaveToStream/
│   │   └── 📂 SetConvertOptions/
│   ├── 📂 using-doc-to-pdf-converter/
│   │   ├── 📂 BasicExample/
│   │   ├── 📂 DocToPasswordProtectedPdf/
│   │   ├── 📂 DocToPdfaFormat/
│   │   ├── 📂 DocWithCommentsToPdfWithoutComments/
│   │   ├── 📂 DocWithTrackedChangesToPdf/
│   │   ├── 📂 ProtectedDocToPdf/
│   │   └── 📂 SpecificDocPagesToPdf/
│   ├── 📂 using-docx-to-pdf-converter/
│   │   ├── 📂 BasicExample/
│   │   ├── 📂 DocxToPasswordProtectedPdf/
│   │   ├── 📂 DocxWithCommentsToPdfWithoutComments/
│   │   ├── 📂 DocxWithTrackedChangesToPdf/
│   │   ├── 📂 ProtectedDocxToPdf/
│   │   └── 📂 SpecificDocxPagesToPdf/
│   ├── 📂 using-html-to-pdf-converter/
│   │   ├── 📂 BasicExample/
│   │   ├── 📂 HtmlToPasswordProtectedPdf/
│   │   ├── 📂 HtmlToPdfWithSpecificPdfFormat/
│   │   ├── 📂 HtmlWithCustomCssStyling/
│   │   ├── 📂 HtmlWithZoomLevel/
│   │   └── 📂 SkipExternalResourcesReferencedInHtml/
│   ├── 📂 using-pdf-to-docx-converter/
│   │   ├── 📂 BasicExample/
│   │   ├── 📂 FlattenFieldsInFormFillablePdf/
│   │   ├── 📂 PdfToDocxWithA4PageSize/
│   │   ├── 📂 PdfToPasswordProtectedDocx/
│   │   ├── 📂 PdfWithAnnotationsToDocxWithoutAnnotations/
│   │   └── 📂 ProtectedPdfToDocx/
│   ├── 📂 using-pdf-to-md-converter/
│   │   ├── 📂 BasicExample/
│   │   ├── 📂 FlattenFieldsInFormFillablePdf/
│   │   ├── 📂 PdfWithAnnotationsToMarkdownWithoutAnnotations/
│   │   ├── 📂 ProtectedPdfToMarkdown/
│   │   └── 📂 SkipImagesWhenConvertingPdfToMarkdown/
│   ├── 📂 using-pdf-to-pdfa-converter/
│   │   ├── 📂 BasicExample/
│   │   ├── 📂 FlattenFieldsInFormFillablePdf/
│   │   ├── 📂 PdfToPasswordProtectedPdfa/
│   │   ├── 📂 PdfWithAnnotationsToPdfaWithoutAnnotations/
│   │   ├── 📂 ProtectedPdfToPdfa/
│   │   └── 📂 SpecificPdfPagesToPdfa/
│   ├── 📂 using-ppt-to-pdf-converter/
│   │   ├── 📂 BasicExample/
│   │   ├── 📂 PptToPasswordProtectedPdf/
│   │   ├── 📂 PptWithHiddenSlides/
│   │   ├── 📂 PptWithPreservedDocumentStructureForAccessiblePdf/
│   │   ├── 📂 ProtectedPptToPdf/
│   │   └── 📂 SpecificPptSlidesToPdf/
│   ├── 📂 using-pptx-to-pdf-converter/
│   │   ├── 📂 BasicExample/
│   │   ├── 📂 PptxToPasswordProtectedPdf/
│   │   ├── 📂 PptxWithHiddenSlides/
│   │   ├── 📂 PreserveDocumentStructureForAccessiblePdf/
│   │   ├── 📂 ProtectedPptxToPdf/
│   │   └── 📂 SpecificPptxSlidesToPdf/
│   ├── 📂 using-xls-to-pdf-converter/
│   │   ├── 📂 BasicExample/
│   │   ├── 📂 ProtectedXlsToPdf/
│   │   ├── 📂 SpecificSheetsFromXlsToPdf/
│   │   ├── 📂 XlsToPasswordProtectedPdf/
│   │   ├── 📂 XlsToPdfWithSpecificPdfFormat/
│   │   └── 📂 XlsWithHiddenSheets/
│   ├── 📂 using-xlsx-to-pdf-converter/
│   │   ├── 📂 BasicExample/
│   │   ├── 📂 ProtectedXlsxToPdf/
│   │   ├── 📂 SpecificSheetsFromXlsxToPdf/
│   │   ├── 📂 XlsxToPasswordProtectedPdf/
│   │   ├── 📂 XlsxToPdfWithSpecificPdfFormat/
│   │   └── 📂 XlsxWithHiddenSheetsToPdf/
│   └── 📂 CopyTheCodeExample/
├── 📄 GroupDocs.Conversion.LowCode.Examples.sln
├── 📄 LICENSE
├── 📄 README.md
├── 🚀 run_all_examples.bat
├── 🚀 run_all_examples.ps1
└── 🚀 run_all_examples.sh
Tip
Each example folder contains a complete, runnable project with sample input files and expected output files.

Running Individual Examples

1. Navigate to an example folder

cd ./Examples/developer-guide/using-docx-to-pdf-converter/BasicExample

2. Set License (Optional)

Open the Program.cs file using a text editor. You’ll find that license keys are read from environment variables:

// Load license keys
var publicKey = Environment.GetEnvironmentVariable("GD_PUBLIC_KEY");
var privateKey = Environment.GetEnvironmentVariable("GD_PRIVATE_KEY");

// Apply the license
License.Set(publicKey, privateKey);

If you have a license, you can either set environment variables or directly modify the publicKey and privateKey variables in the code.

Note
Learn more about licensing, evaluation, and how to obtain a temporary license in the Licensing documentation topic.

To set environment variables, use the following commands in your shell:

set GD_PUBLIC_KEY=your_public_key
set GD_PRIVATE_KEY=your_private_key
$env:GD_PUBLIC_KEY = "your_public_key"
$env:GD_PRIVATE_KEY = "your_private_key"
export GD_PUBLIC_KEY="your_public_key"
export GD_PRIVATE_KEY="your_private_key"

3. Run the example

To run a code example, use the .NET CLI:

dotnet build

to build the application, and then:

dotnet run

to run the application.

4. Verify the output

Most examples generate an output file saved in the same folder where the example app is located. You can also find all the output files on the corresponding documentation page.

This code example produces business-plan.pdf file that should appear in the current directory.

Troubleshooting

If you encounter any issues while running the examples:

Common Issues

  • Build errors: Ensure that the GroupDocs.Conversion.LowCode package is properly installed
  • License errors: Verify that your license keys are correctly set or that you’re running in evaluation mode
  • File not found errors: Make sure the sample input files are present in the example directory
  • Permission errors: Ensure you have write permissions in the output directory

Getting Help

  • Check the console output for specific error messages
  • Ensure your environment meets the System Requirements
  • Visit our Technical Support page for further assistance
  • Use the feedback form on each documentation page

Next Steps

After successfully running the examples:

  • Explore the Developer Guide for advanced features
  • Try modifying the examples to work with your own documents
  • Check out the Quick Start Guide for a simpler introduction