Skip to main content

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Documentation Search all OfficeIMO/
Cmdlet

Add-OfficePdfCanvasText

Aliases: PdfCanvasText
Module
PSWriteOffice
Aliases
PdfCanvasText
Inputs
None

Adds plain or rich native text to the active PDF canvas.

Syntax

Add-OfficePdfCanvasText
[-Alignment <OfficeAlignment>]
[-BackgroundColor <OfficeColor>]
[-Baseline <Normal|Superscript|Subscript>]
[-Bold]
[-Color <OfficeColor>]
[-Font <String>]
[-Height <OfficeLength>]
[-Italic]
[-LineHeight <OfficeLength>]
[-Size <OfficeLength>]
[-Strikethrough]
[-Text] <String>
[-Underline <OfficeTextDecorationStyle>]
[-Width <OfficeLength>]
-X <OfficeLength>
-Y <OfficeLength>
[<CommonParameters>]
#
Parameter set: Text
Add-OfficePdfCanvasText
[-Alignment <OfficeAlignment>]
[-Color <OfficeColor>]
[-Content] <ScriptBlock>
[-Height <OfficeLength>]
[-LineHeight <OfficeLength>]
[-Size <OfficeLength>]
[-Width <OfficeLength>]
-X <OfficeLength>
-Y <OfficeLength>
[<CommonParameters>]
#
Parameter set: Content

Examples

Example 1

Add-OfficePdfCanvasText -Text 'Value' -X 'Value' -Y 'Value'

Example 2

Add-OfficePdfCanvasText -Content { } -X 'Value' -Y 'Value'

Parameters

-Alignment OfficeAlignment optional
Alignment for this content.
Possible values: Left, Center, Right, Justify, Start, End
-BackgroundColor OfficeColor optionalsets: Text
BackgroundColor for this content.
-Baseline PdfTextBaseline optionalsets: Text
Baseline for this content.
Possible values: Normal, Superscript, Subscript
-Bold SwitchParameter optionalsets: Text
Bold for this content.
-Color OfficeColor optional
Color for this content.
-Font String optionalsets: Text
Font for this content.
-Height OfficeLength optional
Height for this content.
-Italic SwitchParameter optionalsets: Text
Italic for this content.
-LineHeight OfficeLength optional
LineHeight for this content.
-Size OfficeLength optional
Size for this content.
-Strikethrough SwitchParameter optionalsets: Text
Strikethrough for this content.
-Text String requiredposition: 0sets: Text
Text for this content.
-Underline OfficeTextDecorationStyle optionalsets: Text
Underline for this content.
Possible values: Single, Double, Dotted, Dashed, Wavy, Words
-Width OfficeLength optional
Width for this content.
-X OfficeLength required
X for this content.
-Y OfficeLength required
Y for this content.
-Content ScriptBlock requiredposition: 0sets: Content
Content for this content.

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.