Output adapters

View as MarkdownMarkdown

Set up your AI agent

Give your coding agent live access to the GroupDocs documentation and API reference through the GroupDocs Docs MCP server — no install, no API key. Learn more

claude mcp add --transport http groupdocs-docs https://docs.groupdocs.com/mcp

Also process documents locally

The GroupDocs.Search MCP server lets your agent work with files on your machine; they are never uploaded. It runs in Docker: replace /path/to/documents with the folder it may use.

claude mcp add groupdocs-search -- docker run --rm -i -v /path/to/documents:/data ghcr.io/groupdocs-search/search-net-mcp:latest
Folders, licensing and more →

Output adapters are used to output generated HTML or plain text to various output objects. The output format (HTML or plain text) is specified by the OutputFormat value passed to the constructor of an adapter. The following output adapters are currently supported:

  • FileOutputAdapter is an output adapter that is used to output text to a file. The path to a file is specified in the constructor of the adapter.
  • StreamOutputAdapter is an output adapter that is used to output text to a stream. The stream is specified in the constructor of the adapter. Since version 26.11, the adapter writes into the stream and does not close it: the stream can be read or written after the output, and one adapter can take several outputs. Close the stream yourself, for example with a using statement, as in the example below. Before, the adapter closed the stream at the end of the first output.
  • StringOutputAdapter is an output adapter that is used to output text to a string. The resulting string can be accessed through the GetResult method of the adapter class.
  • StructureOutputAdapter is an output adapter that is used to output the text of each field of the document separately. The resulting array of fields can be accessed through the GetResult method of the adapter class.

The example below demonstrates how to use adapters of different types.

C#

string indexFolder = @"c:\MyIndex\";
string documentsFolder = @"c:\MyDocuments\";

// Creating an index settings instance
IndexSettings settings = new IndexSettings();
settings.TextStorageSettings = new TextStorageSettings(Compression.High); // Enabling storage of extracted text in the index

// Creating an index in the specified folder
Index index = new Index(indexFolder, settings);

// Indexing documents from the specified folder
index.Add(documentsFolder);

// Getting list of indexed documents
DocumentInfo[] documents = index.GetIndexedDocuments();

// Getting a document text
if (documents.Length > 0)
{
    DocumentInfo document = documents[0];

    // Output to a file
    FileOutputAdapter fileOutputAdapter = new FileOutputAdapter(OutputFormat.Html, @"C:\Text.html");
    index.GetDocumentText(document, fileOutputAdapter);

    // Output to a stream
    using (Stream stream = new MemoryStream())
    {
        StreamOutputAdapter streamOutputAdapter = new StreamOutputAdapter(OutputFormat.Html, stream);
        index.GetDocumentText(document, streamOutputAdapter);

        // The adapter does not close the stream, so the stream can be used after the output
        Console.WriteLine("Bytes written to the stream: " + stream.Length);
    } // The stream is closed here

    // Output to a string
    StringOutputAdapter stringOutputAdapter = new StringOutputAdapter(OutputFormat.Html);
    index.GetDocumentText(document, stringOutputAdapter);
    string htmlText = stringOutputAdapter.GetResult();
    Console.WriteLine(htmlText);

    // Output to a structure
    StructureOutputAdapter structureOutputAdapter = new StructureOutputAdapter(OutputFormat.PlainText);
    index.GetDocumentText(document, structureOutputAdapter);
    DocumentField[] fields = structureOutputAdapter.GetResult();
    Console.WriteLine(document.ToString());
    for (int i = 0; i < fields.Length; i++)
    {
        DocumentField field = fields[i];
        Console.WriteLine("\t" + field.Name);
    }
}

More resources

GitHub examples

You may easily run the code from documentation articles and see the features in action in our GitHub examples:

Free online document search App

Along with full featured .NET library we provide simple, but powerful free Apps.

You are welcome to search over your PDF, DOC, DOCX, PPT, PPTX, XLS, XLSX and more with our free online Free Online Document Search App.