| ScanMSWordDocument |
| |
Scan the paragraphs in a MS Word document |
| |
| Library |
 |
wh::parser/msword.whlib |
| |
| Syntax |
 |
PUBLIC RECORD FUNCTION ScanMSWordDocument (INTEGER docid,BOOLEAN emptydocobjects,RECORD ARRAY filters) |
| |
| Parameters |
 |
| docid |
 |
Document id to scan |
 |
| emptydocobjects |
 |
If true, attempt to eliminate empty paragraphs by converting them to top/bottom padding of their neighbouring paragraphs |
 |
| filters |
 |
A record array of filters to apply to Word paragraphs. The records must be built by updating return values from GetBaseWordFilter() |
 |
|
| |
| Returns |
 |
A record describing the scan results, or a non-existing record if this document has already been scanned |
| |
The record contains the following cells:
| errorcode |
 |
Conversion error code. If 0, scanning paragraphs was successful |
 |
| errormsg |
 |
Extra data accompanying the error code |
 |
| parserobjects |
 |
Array of output objects gathered from the Word document |
 |
| parserobjects.id |
 |
Parsre object id, usable in PrintParserObject calls |
 |
| parserobjects.toclevel |
 |
Toc level set for this style |
 |
| parserobjects.hidden |
 |
True if this object should be hidden from the output |
 |
| parserobjects.filtersplit |
 |
True if this object had a style applied that requested a split |
 |
|
| |