ConvertTo-OfficeWordHtml

Namespace PSWriteOffice

Inputs

OfficeIMO.Word.WordDocument

Outputs

System.String System.IO.FileInfo

Converts a Word document to HTML.

Remarks

Converts a Word document to HTML.

Examples

Convert a .docx file to HTML text.


PS>$html = ConvertTo-OfficeWordHtml -Path .\report.docx

Loads the document and returns HTML markup.

Save HTML to disk.


PS>ConvertTo-OfficeWordHtml -Path .\report.docx -OutputPath .\report.html -PassThru

Writes report.html and returns the file info.

Common Parameters

This command supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable.

For more information, see about_CommonParameters.

Syntax

ConvertTo-OfficeWordHtml [-ExcludeFootnotes] -FilePath <String> [-FontFamily <String>] [-IncludeDefaultCss] [-IncludeFontStyles] [-IncludeListStyles] [-IncludeParagraphClasses] [-IncludeRunClasses] [-OutputPath <String>] [-PassThru] [-UseImagePaths] [<CommonParameters>]

Parameter set: Path

Parameters

ExcludeFootnotes SwitchParameter optionalposition: namedpipeline: False: Exclude footnotes from the HTML output.
FilePath String requiredposition: 0pipeline: Falsealiases: Path: Path to a .docx file.
FontFamily String optionalposition: namedpipeline: False: Optional font family to use during conversion.
IncludeDefaultCss SwitchParameter optionalposition: namedpipeline: False: Include the built-in default CSS in the HTML head.
IncludeFontStyles SwitchParameter optionalposition: namedpipeline: False: Include font styles as inline CSS.
IncludeListStyles SwitchParameter optionalposition: namedpipeline: False: Include list style metadata.
IncludeParagraphClasses SwitchParameter optionalposition: namedpipeline: False: Emit paragraph styles as CSS classes.
IncludeRunClasses SwitchParameter optionalposition: namedpipeline: False: Emit run styles as CSS classes.
OutputPath String optionalposition: namedpipeline: Falsealiases: OutPath: Optional output path for the HTML file.
PassThru SwitchParameter optionalposition: namedpipeline: False: Emit a FileInfo when saving to disk.
UseImagePaths SwitchParameter optionalposition: namedpipeline: False: Store image references as file paths instead of base64 data URIs.

Outputs

System.String System.IO.FileInfo

ConvertTo-OfficeWordHtml -Document <WordDocument> [-ExcludeFootnotes] [-FontFamily <String>] [-IncludeDefaultCss] [-IncludeFontStyles] [-IncludeListStyles] [-IncludeParagraphClasses] [-IncludeRunClasses] [-OutputPath <String>] [-PassThru] [-UseImagePaths] [<CommonParameters>]

Parameter set: Document

Parameters

Document WordDocument requiredposition: namedpipeline: True (ByValue): Word document instance to convert.
ExcludeFootnotes SwitchParameter optionalposition: namedpipeline: False: Exclude footnotes from the HTML output.
FontFamily String optionalposition: namedpipeline: False: Optional font family to use during conversion.
IncludeDefaultCss SwitchParameter optionalposition: namedpipeline: False: Include the built-in default CSS in the HTML head.
IncludeFontStyles SwitchParameter optionalposition: namedpipeline: False: Include font styles as inline CSS.
IncludeListStyles SwitchParameter optionalposition: namedpipeline: False: Include list style metadata.
IncludeParagraphClasses SwitchParameter optionalposition: namedpipeline: False: Emit paragraph styles as CSS classes.
IncludeRunClasses SwitchParameter optionalposition: namedpipeline: False: Emit run styles as CSS classes.
OutputPath String optionalposition: namedpipeline: Falsealiases: OutPath: Optional output path for the HTML file.
PassThru SwitchParameter optionalposition: namedpipeline: False: Emit a FileInfo when saving to disk.
UseImagePaths SwitchParameter optionalposition: namedpipeline: False: Store image references as file paths instead of base64 data URIs.

Outputs

System.String System.IO.FileInfo