Teros.DocxToTextConverter 1.0.2

Teros.DocxToTextConverter

DocxToTextConverter converts a Word "Docx" document to a text string.

Usage

Pass a file stream, file path or byte array, with optional settings, to the converter. A newline-delimited text string is returned.

var converter = new Teros.DocxToTextConverter();

var docText = converter.ConvertDocxToText(filePathStreamOrBytes);

This class uses the Open XML SDK and is not thread-safe. You should instantiate a new object instance for each process or thread that uses it.

Options

There is no end to how people format Word documents, especially for bulleted lists, white space, and special characters. The DocxToText converter tries to make smart choices about how to interpret each document. These settings can be used as the second argument to adjust qualities of the converted text appearance:

var settings = new DocxToTextSettings() 
{ 
    // When true, this overrides most of the other settings:
    PreserveDocumentFormatting = false,

    // These are the default settings:
    ReplaceNonStandardCharsWithAsciiChars = true,
    BulletCharsForLists = BulletListChars.UseSolidBulletChar,
    ConvertAsciiBulletChars = true,
    IndentNestedListsWithTabChar = true,
    FollowBulletCharBySpaceChar = true,
    HyperlinkFormatting = HyperlinkFormat.TextAndUrl
    ReplaceLongBlankStringsWithTab = true
}

var docText = converter.ConvertDocxToText(filePathStreamOrBytes, settings);

Descriptions of these options can be seen in Visual Studio by using Intellisense or by hovering the mouse over the settings properties. Available options may differ from those shown here.

Limitations

• DocxToTextConverter extracts only text from a Word document. It does not recognize tables, images, etc.

• At this time, numbered lists are converted to bullets, and the original bullet chars in Word are not currently retrieved.

Technical Support

Please send problems, questions and comments to nuget@terosresearch.com. If you are reporting a problem, please describe how to replicate it; attachments are discouraged and we will ask for one if the problem can't be replicated.

License

This software can be used without restrictions under the terms of the MIT License.

Donations

ConvertDocxToText is free to download and use. If you find this project helpful and would like to help support its development, please Buy Me a Coffee.