Cmdlet

ConvertTo-OfficeWordHtml

Aliases: ConvertTo-WordHtml

Module: PSWriteOffice
Aliases: ConvertTo-WordHtml
Inputs: OfficeIMO.Word.WordDocument
Outputs: System.String System.IO.FileInfo
Source: ConvertToOfficeWordHtmlCommand.cs:27 Edit on GitHub

Converts a Word document to HTML.

Syntax

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

Parameter set: Path

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

Parameter set: Document

Description

Returns the HTML string or saves it to a file when -OutputPath is specified.

Examples

Convert a .docx file to HTML text.

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

Loads the document and returns HTML markup.

Save HTML to disk.

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

Writes report.html and returns the file info.

Parameters

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

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.