ConvertTo-OfficeExcelHtml

Aliases: ConvertTo-ExcelHtml

Namespace PSWriteOffice

Aliases

ConvertTo-ExcelHtml

Inputs

System.String OfficeIMO.Excel.ExcelDocument

Outputs

System.String System.IO.FileInfo

Source

Sources/PSWriteOffice/Cmdlets/Excel/ConvertToOfficeExcelHtmlCommand.cs:27 Edit on GitHub

Converts an Excel workbook to an HTML review document.

Remarks

Converts an Excel workbook to an HTML review document.

Examples

Authored help example

Export a workbook as semantic HTML.

PS>


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.

PS>


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

Uses the OfficeIMO Excel visual review profile.

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-OfficeExcelHtml [-EmptyCellText <String>] [-MaxRowsPerSheet <Nullable`1>] [-NoDefaultStyles] [-OutputPath <String>] [-PassThru] [-Password <String>] -Path <String> [-Profile <SemanticTables|VisualReview>] [-Theme <Plain>] [-Title <String>] [<CommonParameters>]

Parameter set: Path

Parameters

EmptyCellText String optionalposition: namedpipeline: False: Text used for empty cells in semantic table output.
MaxRowsPerSheet Nullable`1 optionalposition: namedpipeline: False: Maximum number of used rows to emit per worksheet.
NoDefaultStyles SwitchParameter optionalposition: namedpipeline: False: Do not include OfficeIMO default CSS styles.
OutputPath String optionalposition: namedpipeline: Falsealiases: OutPath: Optional output HTML path. When omitted, HTML text is returned.
PassThru SwitchParameter optionalposition: namedpipeline: False: Emit a FileInfo when saving to disk.
Password String optionalposition: namedpipeline: False: Password used to open an encrypted workbook package.
Path String requiredposition: 0pipeline: True (ByValue)aliases: FilePath: Path to the workbook to convert.
Profile OfficeExcelHtmlProfile optionalposition: namedpipeline: Falsevalues: 2: HTML conversion profile.; Possible values: SemanticTables, VisualReview
Theme OfficeVisualThemeKind optionalposition: namedpipeline: Falsevalues: 6: Built-in HTML document theme.; Possible values: Plain, WordLike, TechnicalDocument, GitHubLike, Compact, Report
Title String optionalposition: namedpipeline: False: Optional HTML document title.

Outputs

System.String System.IO.FileInfo

ConvertTo-OfficeExcelHtml [-EmptyCellText <String>] [-MaxRowsPerSheet <Nullable`1>] [-NoDefaultStyles] [-OutputPath <String>] [-PassThru] [-Profile <SemanticTables|VisualReview>] [-Theme <Plain>] [-Title <String>] -Workbook <ExcelDocument> [<CommonParameters>]

Parameter set: Workbook

Parameters

EmptyCellText String optionalposition: namedpipeline: False: Text used for empty cells in semantic table output.
MaxRowsPerSheet Nullable`1 optionalposition: namedpipeline: False: Maximum number of used rows to emit per worksheet.
NoDefaultStyles SwitchParameter optionalposition: namedpipeline: False: Do not include OfficeIMO default CSS styles.
OutputPath String optionalposition: namedpipeline: Falsealiases: OutPath: Optional output HTML path. When omitted, HTML text is returned.
PassThru SwitchParameter optionalposition: namedpipeline: False: Emit a FileInfo when saving to disk.
Profile OfficeExcelHtmlProfile optionalposition: namedpipeline: Falsevalues: 2: HTML conversion profile.; Possible values: SemanticTables, VisualReview
Theme OfficeVisualThemeKind optionalposition: namedpipeline: Falsevalues: 6: Built-in HTML document theme.; Possible values: Plain, WordLike, TechnicalDocument, GitHubLike, Compact, Report
Title String optionalposition: namedpipeline: False: Optional HTML document title.
Workbook ExcelDocument requiredposition: namedpipeline: True (ByValue): Workbook instance to convert.

Outputs

System.String System.IO.FileInfo