Cmdlet

ConvertTo-OfficeExcelHtml

Aliases: ConvertTo-ExcelHtml

Module: PSWriteOffice
Aliases: ConvertTo-ExcelHtml
Inputs: OfficeIMO.Excel.ExcelDocument System.String
Outputs: System.String System.IO.FileInfo
Source: ConvertToOfficeExcelHtmlCommand.cs:30 Edit on GitHub

Converts an Excel workbook to an HTML review document.

Syntax

ConvertTo-OfficeExcelHtml
[-EmptyCellText <String>]
[-MaxRowsPerSheet <Int32>]
[-NoDefaultStyles]
[-OutputPath <String>]
[-PassThru]
[-Password <String>]
[-Path] <String>
[-Profile <SemanticTables|VisualReview>]
[-Theme <OfficeVisualThemeKind>]
[-Title <String>]
[<CommonParameters>]

Parameter set: Path

ConvertTo-OfficeExcelHtml
[-EmptyCellText <String>]
[-MaxRowsPerSheet <Int32>]
[-NoDefaultStyles]
[-OutputPath <String>]
[-PassThru]
[-Profile <SemanticTables|VisualReview>]
[-Theme <OfficeVisualThemeKind>]
[-Title <String>]
-Workbook <ExcelDocument>
[<CommonParameters>]

Parameter set: Workbook

Examples

Export a workbook as semantic HTML.

ConvertTo-OfficeExcelHtml -Path .\Report.xlsx -OutputPath .\Report.html -Title 'Workbook Review' -PassThru

Loads the workbook and writes an HTML file with tables, formulas, comments, charts, and image inventory where available.

Export a visual review artifact.

ConvertTo-OfficeExcelHtml -Path .\Report.xlsx -Profile VisualReview -OutputPath .\Report.visual.html

Uses the OfficeIMO Excel visual review profile.

Parameters

-EmptyCellText String optional: Text used for empty cells in semantic table output.
-MaxRowsPerSheet Int32 optional: Maximum number of used rows to emit per worksheet.
-NoDefaultStyles SwitchParameter optional: Do not include OfficeIMO default CSS styles.
-OutputPath String optionalaliases: OutPath: Optional output HTML path. When omitted, HTML text is returned.
-PassThru SwitchParameter optional: Emit a FileInfo when saving to disk.
-Password String optionalsets: Path: Password used to open an encrypted workbook package.
-Path String requiredposition: 0pipeline: True (ByValue)aliases: FilePathsets: Path: Path to the workbook to convert.
-Profile OfficeExcelHtmlProfile optional: HTML conversion profile.; Possible values: SemanticTables, VisualReview
-Theme OfficeVisualThemeKind optional: Built-in HTML document theme.; Possible values: Plain, WordLike, TechnicalDocument, GitHubLike, Compact, Report
-Title String optional: Optional HTML document title.
-Workbook ExcelDocument requiredpipeline: True (ByValue)sets: Workbook: Workbook 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.