API Reference

Cmdlet

New-OfficePdfTableCell

Aliases: PdfTableCell
Namespace PSWriteOffice
Aliases
PdfTableCell
Outputs
PSWriteOffice.Services.Table.OfficeTableCellSpec

Creates a reusable PDF table cell definition for explicit table rows.

Remarks

Creates a reusable PDF table cell definition for explicit table rows.

Examples

Authored help example

Example 1: Create a full-width PDF table section row.

PS>


$row = @(New-OfficePdfTableCell -Text 'Identity systems' -ColumnSpan 3 -FillColor '#DBEAFE' -TextColor '#1E3A8A' -Bold)
        

The returned cell can be passed to PdfTable inside explicit row arrays.

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-OfficePdfTableCell [-Align <Nullable`1>] [-Bold] [-CheckBox <PdfTableCellCheckBox[]>] [-ColumnSpan <Int32>] [-FillColor <String>] [-FontSize <Nullable`1>] [-FormField <PdfTableCellFormField[]>] [-Image <PdfTableCellImage[]>] [-Italic] [-LinkContents <String>] [-LinkDestinationName <String>] [-LinkUri <String>] [-NamedDestinationName <String>] [-NoWrap] [-RowSpan <Int32>] [-Run <Object[]>] [-Strike] [-Text <String>] [-TextColor <String>] [-Underline] [-UnderlineStyle <String>] [-VerticalAlign <Nullable`1>] [<CommonParameters>]
#
Parameter set: All Parameter Sets

Parameters

Align Nullable`1 optionalposition: namedpipeline: False
Horizontal cell alignment. Possible values: Left, Center, Right
Bold SwitchParameter optionalposition: namedpipeline: False
Render the cell text in bold.
CheckBox PdfTableCellCheckBox[] optionalposition: namedpipeline: Falsealiases: CheckBoxes
Typed check boxes rendered inside the cell.
ColumnSpan Int32 optionalposition: namedpipeline: False
Number of logical columns covered by the cell.
FillColor String optionalposition: namedpipeline: Falsealiases: BackgroundColor, CellFill
Cell fill color. Named colors and hexadecimal colors are accepted.
FontSize Nullable`1 optionalposition: namedpipeline: False
Cell font size in PDF points.
FormField PdfTableCellFormField[] optionalposition: namedpipeline: Falsealiases: FormFields
Typed text or choice form fields rendered inside the cell.
Image PdfTableCellImage[] optionalposition: namedpipeline: Falsealiases: Images
Typed images rendered inside the cell.
Italic SwitchParameter optionalposition: namedpipeline: False
Render the cell text in italics.
LinkContents String optionalposition: namedpipeline: False
Accessible annotation text for the cell link.
LinkDestinationName String optionalposition: namedpipeline: False
Named PDF destination linked from the cell.
LinkUri String optionalposition: namedpipeline: False
Absolute or catalog-base-relative URI linked from the cell.
NamedDestinationName String optionalposition: namedpipeline: False
Named PDF destination defined at this cell.
NoWrap SwitchParameter optionalposition: namedpipeline: False
Keep the cell content on one visual line.
RowSpan Int32 optionalposition: namedpipeline: False
Number of logical rows covered by the cell.
Run Object[] optionalposition: namedpipeline: Falsealiases: Runs
Rich text runs for the cell. Each run can be created with TextRun/PdfTextRun or provided as a hashtable/object.
Strike SwitchParameter optionalposition: namedpipeline: False
Render the cell text with strikethrough.
Text String optionalposition: 0pipeline: False
Cell text.
TextColor String optionalposition: namedpipeline: Falsealiases: Color, FontColor
Cell text color. Named colors and hexadecimal colors are accepted.
Underline SwitchParameter optionalposition: namedpipeline: False
Render the cell text with underline.
UnderlineStyle String optionalposition: namedpipeline: False
Optional underline style name. PDF table rendering treats any supported value as underline.
VerticalAlign Nullable`1 optionalposition: namedpipeline: False
Vertical cell alignment. Possible values: Top, Middle, Bottom

Outputs

PSWriteOffice.Services.Table.OfficeTableCellSpec: Describes a logical table cell that can be rendered by multiple Office table surfaces.