New-OfficeTextRun

Aliases: ExcelTextRun, PdfTextRun, PowerPointTextRun, PptTextRun, TextRun, WordTextRun

Namespace PSWriteOffice

Aliases

ExcelTextRun PdfTextRun PowerPointTextRun PptTextRun TextRun WordTextRun

Inputs

None

Outputs

PSWriteOffice.Services.Text.OfficeTextRunSpec

Source

Sources/PSWriteOffice/Cmdlets/Text/NewOfficeTextRunCommand.cs:7 Edit on GitHub

Creates a reusable rich text run specification for Word, Excel, PowerPoint, and PDF commands.

Remarks

Creates a reusable rich text run specification for Word, Excel, PowerPoint, and PDF commands.

Examples

Authored help example

EXAMPLE 1


New-OfficeTextRun -BackgroundColor 'Value'

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

New-OfficeTextRun [-BackgroundColor <String>] [-Baseline <String>] [-Bold] [-Color <String>] [-FontName <String>] [-FontSize <Nullable`1>] [-Italic] [-Kind <String>] [-LinkContents <String>] [-LinkDestinationName <String>] [-LinkUri <String>] [-Strike] [-TabAlignment <String>] [-TabLeader <String>] [-Text <String>] [-Underline] [-UnderlineStyle <String>] [<CommonParameters>]

Parameter set: All Parameter Sets

Parameters

BackgroundColor String optionalposition: namedpipeline: Falsealiases: FillColor, HighlightColor: Run background or highlight color. Named colors and hexadecimal colors are accepted.
Baseline String optionalposition: namedpipeline: False: Target-specific baseline name, such as Superscript or Subscript.
Bold SwitchParameter optionalposition: namedpipeline: False: Render the run in bold.
Color String optionalposition: namedpipeline: Falsealiases: FontColor, TextColor: Text color. Named colors and hexadecimal colors are accepted.
FontName String optionalposition: namedpipeline: Falsealiases: Font, FontFamily, Typeface: Font name, family, or target-specific font identifier.
FontSize Nullable`1 optionalposition: namedpipeline: False: Font size in points.
Italic SwitchParameter optionalposition: namedpipeline: False: Render the run in italics.
Kind String optionalposition: namedpipeline: False: Run kind such as Text, LineBreak, Tab, Superscript, or Subscript.
LinkContents String optionalposition: namedpipeline: Falsealiases: Contents, Tooltip: Optional link tooltip or annotation contents.
LinkDestinationName String optionalposition: namedpipeline: Falsealiases: Bookmark, BookmarkName, DestinationName: Named destination or bookmark target when supported by the target format.
LinkUri String optionalposition: namedpipeline: Falsealiases: Href, Uri, Url: URI link target when supported by the target format.
Strike SwitchParameter optionalposition: namedpipeline: False: Render the run with strikethrough.
TabAlignment String optionalposition: namedpipeline: Falsealiases: Alignment: Tab alignment name.
TabLeader String optionalposition: namedpipeline: Falsealiases: Leader: PDF tab leader style name.
Text String optionalposition: 0pipeline: False: Run text.
Underline SwitchParameter optionalposition: namedpipeline: False: Render the run with underline.
UnderlineStyle String optionalposition: namedpipeline: False: Optional underline style name when the target format supports it.

Outputs

PSWriteOffice.Services.Text.OfficeTextRunSpec: PowerShell-friendly rich text run specification used by document adapters.