public class PlainTextDocument
extends java.lang.Object
To learn more, visit the Working with Text Document documentation article.
Examples:
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 and Description |
|---|
PlainTextDocument(java.io.InputStream stream)
Initializes a new instance of this class.
|
PlainTextDocument(java.io.InputStream stream,
LoadOptions loadOptions)
Initializes a new instance of this class.
|
PlainTextDocument(java.lang.String fileName)
Creates a plain text document from a file.
|
PlainTextDocument(java.lang.String fileName,
LoadOptions loadOptions)
Creates a plain text document from a file.
|
| Modifier and Type | Method and Description |
|---|---|
BuiltInDocumentProperties |
getBuiltInDocumentProperties()
Gets
getBuiltInDocumentProperties() of the document. |
CustomDocumentProperties |
getCustomDocumentProperties()
Gets
getCustomDocumentProperties() of the document. |
java.lang.String |
getText()
Gets textual content of the document concatenated as a string.
|
public PlainTextDocument(java.lang.String fileName)
throws java.lang.Exception
fileName - Name of the file to extract the text from.UnsupportedFileFormatException - The document format is not recognized or not supported.FileCorruptedException - The document appears to be corrupted and cannot be loaded.java.lang.RuntimeException - There is a problem with the document and it should be reported to Aspose.Words developers.java.io.IOException - There is an input/output exception.IncorrectPasswordException - The document is encrypted and requires a password to open, but you supplied an incorrect password.java.lang.IllegalArgumentException - The name of the file cannot be null or empty string.
Examples:
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());
java.lang.Exceptionpublic PlainTextDocument(java.lang.String fileName,
LoadOptions loadOptions)
throws java.lang.Exception
fileName - Name of the file to extract the text from.loadOptions - Additional options to use when loading a document. Can be null.UnsupportedFileFormatException - The document format is not recognized or not supported.FileCorruptedException - The document appears to be corrupted and cannot be loaded.java.lang.RuntimeException - There is a problem with the document and it should be reported to Aspose.Words developers.java.io.IOException - There is an input/output exception.IncorrectPasswordException - The document is encrypted and requires a password to open, but you supplied an incorrect password.java.lang.IllegalArgumentException - The name of the file cannot be null or empty string.
Remarks:
Examples:
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());
java.lang.Exceptionpublic PlainTextDocument(java.io.InputStream stream)
throws java.lang.Exception
java.lang.Exceptionpublic PlainTextDocument(java.io.InputStream stream,
LoadOptions loadOptions)
throws java.lang.Exception
java.lang.Exceptionpublic java.lang.String getText()
Examples:
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());
public BuiltInDocumentProperties getBuiltInDocumentProperties()
getBuiltInDocumentProperties() of the document.
Examples:
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());
getBuiltInDocumentProperties() of the document.public CustomDocumentProperties getCustomDocumentProperties()
getCustomDocumentProperties() of the document.
Examples:
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());
getCustomDocumentProperties() of the document.