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.

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.
 
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:

        Show how to simply extract text from a document.
        LoadOptions loadOptions = new LoadOptions();
        loadOptions.setAllowTrailingWhitespaceForListItems(false);
        
        PlainTextDocument plaintext = new PlainTextDocument(getMyDir() + "Bookmark.docx");
        
        plaintext = new PlainTextDocument(getMyDir() + "Bookmark.docx", loadOptions);
      • 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:

        Show how to simply extract text from a document.
        LoadOptions loadOptions = new LoadOptions();
        loadOptions.setAllowTrailingWhitespaceForListItems(false);
        
        PlainTextDocument plaintext = new PlainTextDocument(getMyDir() + "Bookmark.docx");
        
        plaintext = new PlainTextDocument(getMyDir() + "Bookmark.docx", loadOptions);
    • Property Getters/Setters Detail

      • getBuiltInDocumentProperties

        public BuiltInDocumentProperties getBuiltInDocumentProperties()
        
        Gets BuiltInDocumentProperties of the document.

        Example:

        Show how to get BuiltIn properties of plain text document.
        PlainTextDocument plaintext = new PlainTextDocument(getMyDir() + "Bookmark.docx");
        BuiltInDocumentProperties builtInDocumentProperties = plaintext.getBuiltInDocumentProperties();
      • getCustomDocumentProperties

        public CustomDocumentProperties getCustomDocumentProperties()
        
        Gets CustomDocumentProperties of the document.

        Example:

        Show how to get custom properties of plain text document.
        PlainTextDocument plaintext = new PlainTextDocument(getMyDir() + "Bookmark.docx");
        CustomDocumentProperties customDocumentProperties = plaintext.getCustomDocumentProperties();
      • getText

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