Get Started

API Reference

Cmdlet

Get-OfficeExcelRichText

Aliases: ExcelRichTextRuns
Namespace PSWriteOffice
Aliases
ExcelRichTextRuns
Inputs
OfficeIMO.Excel.ExcelDocument
Outputs
System.Management.Automation.PSObject
Source
Sources/PSWriteOffice/Cmdlets/Excel/GetOfficeExcelRichTextCommand.cs:16 Edit on GitHub

Gets mixed-format rich text runs from an Excel cell.

Remarks

Gets mixed-format rich text runs from an Excel cell.

Examples

Authored help example

Inspect rich text runs from a workbook.

PS>


$runs = Get-OfficeExcelRichText -Path .\Report.xlsx -Sheet Summary -Address A1
            $runs |
                Format-Table Index, Text, Bold, Italic, Color

Returns one object per inline rich text run with text and style properties.

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

Get-OfficeExcelRichText [-Address <String>] [-Column <Nullable`1>] [-Row <Nullable`1>] [-Sheet <String>] [-SheetIndex <Nullable`1>] [<CommonParameters>]
#
Parameter set: Context

Parameters

Address String optionalposition: namedpipeline: False
A1-style cell address.
Column Nullable`1 optionalposition: namedpipeline: False
1-based column index.
Row Nullable`1 optionalposition: namedpipeline: False
1-based row index.
Sheet String optionalposition: namedpipeline: Falsealiases: WorksheetName
Worksheet name. Defaults to the current sheet inside an ExcelSheet block.
SheetIndex Nullable`1 optionalposition: namedpipeline: False
Worksheet index when using a workbook object or path.

Outputs

System.Management.Automation.PSObject

Get-OfficeExcelRichText [-Address <String>] [-Column <Nullable`1>] -InputPath <String> [-Row <Nullable`1>] [-Sheet <String>] [-SheetIndex <Nullable`1>] [<CommonParameters>]
#
Parameter set: Path

Parameters

Address String optionalposition: namedpipeline: False
A1-style cell address.
Column Nullable`1 optionalposition: namedpipeline: False
1-based column index.
InputPath String requiredposition: 0pipeline: Falsealiases: FilePath, Path
Workbook path to inspect.
Row Nullable`1 optionalposition: namedpipeline: False
1-based row index.
Sheet String optionalposition: namedpipeline: Falsealiases: WorksheetName
Worksheet name. Defaults to the current sheet inside an ExcelSheet block.
SheetIndex Nullable`1 optionalposition: namedpipeline: False
Worksheet index when using a workbook object or path.

Outputs

System.Management.Automation.PSObject

Get-OfficeExcelRichText [-Address <String>] [-Column <Nullable`1>] -Document <ExcelDocument> [-Row <Nullable`1>] [-Sheet <String>] [-SheetIndex <Nullable`1>] [<CommonParameters>]
#
Parameter set: Document

Parameters

Address String optionalposition: namedpipeline: False
A1-style cell address.
Column Nullable`1 optionalposition: namedpipeline: False
1-based column index.
Document ExcelDocument requiredposition: namedpipeline: True (ByValue)
Workbook to inspect outside the DSL context.
Row Nullable`1 optionalposition: namedpipeline: False
1-based row index.
Sheet String optionalposition: namedpipeline: Falsealiases: WorksheetName
Worksheet name. Defaults to the current sheet inside an ExcelSheet block.
SheetIndex Nullable`1 optionalposition: namedpipeline: False
Worksheet index when using a workbook object or path.

Outputs

System.Management.Automation.PSObject