com.aspose.words

Class PlainTextDocument

  • java.lang.Object
    • com.aspose.words.PlainTextDocument
public class PlainTextDocument 
extends java.lang.Object

Allows to extract plain-text representation of the document's content.

Example:

Shows how to load the contents of a Microsoft Word document in plaintext.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
builder.writeln("Hello world!");

doc.save(getArtifactsDir() + "PlainTextDocument.Load.docx");

PlainTextDocument plaintext = new PlainTextDocument(getArtifactsDir() + "PlainTextDocument.Load.docx");

Assert.assertEquals("Hello world!", plaintext.getText().trim());

Constructor Summary
PlainTextDocument(java.lang.StringfileName)
Creates a plain text document from a file. Automatically detects the file format.
PlainTextDocument(java.lang.StringfileName, LoadOptions loadOptions)
Creates a plain text document from a file. Allows to specify additional options such as an encryption password.
PlainTextDocument(java.io.InputStreamstream)
Creates a plain text document from a stream. Automatically detects the file format.
PlainTextDocument(java.io.InputStreamstream, LoadOptions loadOptions)
Creates a plain text document from a stream. Allows to specify additional options such as an encryption password.
 
Property Getters/Setters Summary
BuiltInDocumentPropertiesgetBuiltInDocumentProperties()
Gets BuiltInDocumentProperties of the document.
CustomDocumentPropertiesgetCustomDocumentProperties()
Gets CustomDocumentProperties of the document.
java.lang.StringgetText()
Gets textual content of the document concatenated as a string.
 

    • Constructor Detail

      • PlainTextDocument

        public PlainTextDocument(java.lang.String fileName)
                          throws java.lang.Exception
        Creates a plain text document from a file. Automatically detects the file format.
        Parameters:
        fileName - Name of the file to extract the text from.

        Example:

        Shows how to load the contents of a Microsoft Word document in plaintext.
        Document doc = new Document();
        DocumentBuilder builder = new DocumentBuilder(doc);
        builder.writeln("Hello world!");
        
        doc.save(getArtifactsDir() + "PlainTextDocument.Load.docx");
        
        PlainTextDocument plaintext = new PlainTextDocument(getArtifactsDir() + "PlainTextDocument.Load.docx");
        
        Assert.assertEquals("Hello world!", plaintext.getText().trim());
      • PlainTextDocument

        public PlainTextDocument(java.lang.String fileName, LoadOptions loadOptions)
                          throws java.lang.Exception
        Creates a plain text document from a file. Allows to specify additional options such as an encryption password.
        Parameters:
        fileName - Name of the file to extract the text from.
        loadOptions - Additional options to use when loading a document. Can be null.

        Example:

        Shows how to load the contents of an encrypted Microsoft Word document in plaintext.
        Document doc = new Document();
        DocumentBuilder builder = new DocumentBuilder(doc);
        builder.writeln("Hello world!");
        
        OoxmlSaveOptions saveOptions = new OoxmlSaveOptions();
        saveOptions.setPassword("MyPassword");
        
        doc.save(getArtifactsDir() + "PlainTextDocument.LoadEncrypted.docx", saveOptions);
        
        LoadOptions loadOptions = new LoadOptions();
        loadOptions.setPassword("MyPassword");
        
        PlainTextDocument plaintext = new PlainTextDocument(getArtifactsDir() + "PlainTextDocument.LoadEncrypted.docx", loadOptions);
        
        Assert.assertEquals("Hello world!", plaintext.getText().trim());
      • PlainTextDocument

        public PlainTextDocument(java.io.InputStream stream)
                          throws java.lang.Exception
        Creates a plain text document from a stream. Automatically detects the file format.

        The document must be stored at the beginning of the stream.

        Parameters:
        stream - The stream where to extract the text from.

        Example:

        Shows how to load the contents of a Microsoft Word document in plaintext using stream.
        Document doc = new Document();
        DocumentBuilder builder = new DocumentBuilder(doc);
        
        builder.writeln("Hello world!");
        doc.save(getArtifactsDir() + "PlainTextDocument.LoadFromStream.docx");
        
        try (FileInputStream stream = new FileInputStream(getArtifactsDir() + "PlainTextDocument.LoadFromStream.docx")) {
            PlainTextDocument plaintext = new PlainTextDocument(stream);
        
            Assert.assertEquals("Hello world!", plaintext.getText().trim());
        }
      • PlainTextDocument

        public PlainTextDocument(java.io.InputStream stream, LoadOptions loadOptions)
                          throws java.lang.Exception
        Creates a plain text document from a stream. Allows to specify additional options such as an encryption password.

        The document must be stored at the beginning of the stream.

        Parameters:
        stream - The stream where to extract the text from.
        loadOptions - Additional options to use when loading a document. Can be null.

        Example:

        Shows how to load the contents of an encrypted Microsoft Word document in plaintext using stream.
        Document doc = new Document();
        DocumentBuilder builder = new DocumentBuilder(doc);
        
        builder.writeln("Hello world!");
        
        OoxmlSaveOptions saveOptions = new OoxmlSaveOptions();
        saveOptions.setPassword("MyPassword");
        
        doc.save(getArtifactsDir() + "PlainTextDocument.LoadFromStreamWithOptions.docx", saveOptions);
        
        LoadOptions loadOptions = new LoadOptions();
        loadOptions.setPassword("MyPassword");
        
        try (FileInputStream stream = new FileInputStream(getArtifactsDir() + "PlainTextDocument.LoadFromStreamWithOptions.docx")) {
            PlainTextDocument plaintext = new PlainTextDocument(stream, loadOptions);
        
            Assert.assertEquals("Hello world!", plaintext.getText().trim());
        }
    • Property Getters/Setters Detail

      • getBuiltInDocumentProperties

        public BuiltInDocumentProperties getBuiltInDocumentProperties()
        
        Gets BuiltInDocumentProperties of the document.

        Example:

        Shows how to load the contents of a Microsoft Word document in plaintext and then access the original document's built-in properties.
        Document doc = new Document();
        DocumentBuilder builder = new DocumentBuilder(doc);
        
        builder.writeln("Hello world!");
        doc.getBuiltInDocumentProperties().setAuthor("John Doe");
        
        doc.save(getArtifactsDir() + "PlainTextDocument.BuiltInProperties.docx");
        
        PlainTextDocument plaintext = new PlainTextDocument(getArtifactsDir() + "PlainTextDocument.BuiltInProperties.docx");
        
        Assert.assertEquals("Hello world!", plaintext.getText().trim());
        Assert.assertEquals("John Doe", plaintext.getBuiltInDocumentProperties().getAuthor());
      • getCustomDocumentProperties

        public CustomDocumentProperties getCustomDocumentProperties()
        
        Gets CustomDocumentProperties of the document.

        Example:

        Shows how to load the contents of a Microsoft Word document in plaintext and then access the original document's custom properties.
        Document doc = new Document();
        DocumentBuilder builder = new DocumentBuilder(doc);
        
        builder.writeln("Hello world!");
        doc.getCustomDocumentProperties().add("Location of writing", "123 Main St, London, UK");
        
        doc.save(getArtifactsDir() + "PlainTextDocument.CustomDocumentProperties.docx");
        
        PlainTextDocument plaintext = new PlainTextDocument(getArtifactsDir() + "PlainTextDocument.CustomDocumentProperties.docx");
        
        Assert.assertEquals("Hello world!", plaintext.getText().trim());
        Assert.assertEquals("123 Main St, London, UK", plaintext.getCustomDocumentProperties().get("Location of writing").getValue());
      • getText

        public java.lang.String getText()
        
        Gets textual content of the document concatenated as a string.

        Example:

        Shows how to load the contents of a Microsoft Word document in plaintext.
        Document doc = new Document();
        DocumentBuilder builder = new DocumentBuilder(doc);
        builder.writeln("Hello world!");
        
        doc.save(getArtifactsDir() + "PlainTextDocument.Load.docx");
        
        PlainTextDocument plaintext = new PlainTextDocument(getArtifactsDir() + "PlainTextDocument.Load.docx");
        
        Assert.assertEquals("Hello world!", plaintext.getText().trim());