Word Document <WordDoc>

Synopsis

A design used to create a Microsoft Word document.

Mixins

WordDocModifier

Parameters

Name Type Description
okToOverwrite? boolean If True, the "OutputDocFileName" file be overwritten. Default is True.
OutputDocFileName string The name of the output file.
OutputDocPath string The folder containing "OutputDocFileName". Default is the project location.
outputDocument string Full path of the output document; "OutputDocPath" and "OutputDocFileName" combined.
SaveAsFormat string The type of output file Word generates. The default of "Word" generates a DOC file, use "Word 2007" for a DOCX file. See the "SaveAsFormats" rule for other options.
ShowReport? boolean If True, the generated document is displayed when complete. Default is False.
TemplateDocPath string The folder containing "TemplateFileName". Default is the project location.
templateDocument string Full path of the template document; "TemplateDocPath" and "TemplateFileName" combined.
TemplateFilename string A Word template to use for the document.

Rules

Name Type Description
SaveAsFormats list Formats that are valid for "SaveAsFormat". Word 2007: docx Word: doc DosText: txt DosTextLineBreaks: txt EncodedText: txt HTML: htm RTF: rtf Template: dot Template 2007: dotx Text: txt TextLineBreaks: txt Unicode: uni