PlainTextDocument constructor
Contents
[
Hide
]PlainTextDocument(file_name)
Creates a plain text document from a file. Automatically detects the file format.
def __init__(self, file_name: str):
...
| Parameter | Type | Description |
|---|---|---|
| file_name | str | Name of the file to extract the text from. |
Exceptions
| exception | condition |
|---|---|
| RuntimeError (Proxy error(UnsupportedFileFormatException)) | The document format is not recognized or not supported. |
| RuntimeError (Proxy error(FileCorruptedException)) | The document appears to be corrupted and cannot be loaded. |
| RuntimeError (Proxy error(Exception)) | There is a problem with the document and it should be reported to Aspose.Words developers. |
| RuntimeError (Proxy error(IOException)) | There is an input/output exception. |
| RuntimeError (Proxy error(IncorrectPasswordException)) | The document is encrypted and requires a password to open, but you supplied an incorrect password. |
| RuntimeError (Proxy error(ArgumentException)) | The name of the file cannot be null or empty string. |
PlainTextDocument(file_name, load_options)
Creates a plain text document from a file. Allows to specify additional options such as an encryption password.
def __init__(self, file_name: str, load_options: aspose.words.loading.LoadOptions):
...
| Parameter | Type | Description |
|---|---|---|
| file_name | str | Name of the file to extract the text from. |
| load_options | LoadOptions | Additional options to use when loading a document. Can be None. |
Remarks
Exceptions
| exception | condition |
|---|---|
| RuntimeError (Proxy error(UnsupportedFileFormatException)) | The document format is not recognized or not supported. |
| RuntimeError (Proxy error(FileCorruptedException)) | The document appears to be corrupted and cannot be loaded. |
| RuntimeError (Proxy error(Exception)) | There is a problem with the document and it should be reported to Aspose.Words developers. |
| RuntimeError (Proxy error(IOException)) | There is an input/output exception. |
| RuntimeError (Proxy error(IncorrectPasswordException)) | The document is encrypted and requires a password to open, but you supplied an incorrect password. |
| RuntimeError (Proxy error(ArgumentException)) | The name of the file cannot be null or empty string. |
PlainTextDocument(stream)
Creates a plain text document from a stream. Automatically detects the file format.
def __init__(self, stream: io.BytesIO):
...
| Parameter | Type | Description |
|---|---|---|
| stream | io.BytesIO | The stream where to extract the text from. |
Remarks
The document must be stored at the beginning of the stream. The stream must support random positioning.
Exceptions
| exception | condition |
|---|---|
| RuntimeError (Proxy error(UnsupportedFileFormatException)) | The document format is not recognized or not supported. |
| RuntimeError (Proxy error(FileCorruptedException)) | The document appears to be corrupted and cannot be loaded. |
| RuntimeError (Proxy error(Exception)) | There is a problem with the document and it should be reported to Aspose.Words developers. |
| RuntimeError (Proxy error(IOException)) | There is an input/output exception. |
| RuntimeError (Proxy error(IncorrectPasswordException)) | The document is encrypted and requires a password to open, but you supplied an incorrect password. |
| RuntimeError (Proxy error(ArgumentNullException)) | The stream cannot be null. |
| RuntimeError (Proxy error(NotSupportedException)) | The stream does not support reading or seeking. |
| RuntimeError (Proxy error(ObjectDisposedException)) | The stream is a disposed object. |
PlainTextDocument(stream, load_options)
Creates a plain text document from a stream. Allows to specify additional options such as an encryption password.
def __init__(self, stream: io.BytesIO, load_options: aspose.words.loading.LoadOptions):
...
| Parameter | Type | Description |
|---|---|---|
| stream | io.BytesIO | The stream where to extract the text from. |
| load_options | LoadOptions | Additional options to use when loading a document. Can be None. |
Remarks
The document must be stored at the beginning of the stream. The stream must support random positioning.
Exceptions
| exception | condition |
|---|---|
| RuntimeError (Proxy error(UnsupportedFileFormatException)) | The document format is not recognized or not supported. |
| RuntimeError (Proxy error(FileCorruptedException)) | The document appears to be corrupted and cannot be loaded. |
| RuntimeError (Proxy error(Exception)) | There is a problem with the document and it should be reported to Aspose.Words developers. |
| RuntimeError (Proxy error(IOException)) | There is an input/output exception. |
| RuntimeError (Proxy error(IncorrectPasswordException)) | The document is encrypted and requires a password to open, but you supplied an incorrect password. |
| RuntimeError (Proxy error(ArgumentNullException)) | The stream cannot be null. |
| RuntimeError (Proxy error(NotSupportedException)) | The stream does not support reading or seeking. |
| RuntimeError (Proxy error(ObjectDisposedException)) | The stream is a disposed object. |
Examples
Shows how to load the contents of a Microsoft Word document in plaintext.
doc = aw.Document()
builder = aw.DocumentBuilder(doc=doc)
builder.writeln('Hello world!')
doc.save(file_name=ARTIFACTS_DIR + 'PlainTextDocument.Load.docx')
plaintext = aw.PlainTextDocument(file_name=ARTIFACTS_DIR + 'PlainTextDocument.Load.docx')
self.assertEqual('Hello world!', plaintext.text.strip())
Shows how to load the contents of an encrypted Microsoft Word document in plaintext.
doc = aw.Document()
builder = aw.DocumentBuilder(doc=doc)
builder.writeln('Hello world!')
save_options = aw.saving.OoxmlSaveOptions()
save_options.password = 'MyPassword'
doc.save(file_name=ARTIFACTS_DIR + 'PlainTextDocument.LoadEncrypted.docx', save_options=save_options)
load_options = aw.loading.LoadOptions()
load_options.password = 'MyPassword'
plaintext = aw.PlainTextDocument(file_name=ARTIFACTS_DIR + 'PlainTextDocument.LoadEncrypted.docx', load_options=load_options)
self.assertEqual('Hello world!', plaintext.text.strip())
Shows how to load the contents of a Microsoft Word document in plaintext using stream.
doc = aw.Document()
builder = aw.DocumentBuilder(doc=doc)
builder.writeln('Hello world!')
doc.save(file_name=ARTIFACTS_DIR + 'PlainTextDocument.LoadFromStream.docx')
with system_helper.io.FileStream(ARTIFACTS_DIR + 'PlainTextDocument.LoadFromStream.docx', system_helper.io.FileMode.OPEN) as stream:
plaintext = aw.PlainTextDocument(stream=stream)
self.assertEqual('Hello world!', plaintext.text.strip())
Shows how to load the contents of an encrypted Microsoft Word document in plaintext using stream.
doc = aw.Document()
builder = aw.DocumentBuilder(doc=doc)
builder.writeln('Hello world!')
save_options = aw.saving.OoxmlSaveOptions()
save_options.password = 'MyPassword'
doc.save(file_name=ARTIFACTS_DIR + 'PlainTextDocument.LoadFromStreamWithOptions.docx', save_options=save_options)
load_options = aw.loading.LoadOptions()
load_options.password = 'MyPassword'
with system_helper.io.FileStream(ARTIFACTS_DIR + 'PlainTextDocument.LoadFromStreamWithOptions.docx', system_helper.io.FileMode.OPEN) as stream:
plaintext = aw.PlainTextDocument(stream=stream, load_options=load_options)
self.assertEqual('Hello world!', plaintext.text.strip())
See Also
- module aspose.words
- class PlainTextDocument