Cmdlet

Add-OfficePowerPointTextBox

Aliases: PptTextBox

Module: PSWriteOffice
Aliases: PptTextBox
Inputs: OfficeIMO.PowerPoint.PowerPointSlide
Source: AddOfficePowerPointTextBoxCommand.cs:22 Edit on GitHub

Adds a text box to a slide.

Syntax

Add-OfficePowerPointTextBox
[-Height <Int32>]
[-PassThru]
[-Slide <PowerPointSlide>]
-Text <String>
[-Width <Int32>]
[-X <Int32>]
[-Y <Int32>]
[<CommonParameters>]

Parameter set: Text

Add-OfficePowerPointTextBox
[-Height <Int32>]
[-PassThru]
-Run <Object[]>
[-Slide <PowerPointSlide>]
[-Width <Int32>]
[-X <Int32>]
[-Y <Int32>]
[<CommonParameters>]

Parameter set: Run

Description

Creates a rectangle at the requested coordinates and assigns the supplied text.

Examples

Insert a caption.

New-OfficePowerPoint -Path .\Examples\Documents\PowerPointTextBox.pptx {
    $slide = Add-OfficePowerPointSlide -Layout 1 -PassThru
    Add-OfficePowerPointTextBox -Slide $slide -Text 'Quarterly overview' -X 80 -Y 150 -Width 320 -Height 50
    Add-OfficePowerPointTextBox -Slide $slide -Text 'Generated by PSWriteOffice' -X 80 -Y 210 -Width 320 -Height 35
}

Places two text boxes on a generated slide.

Parameters

-Height Int32 optional: Box height in points.
-PassThru SwitchParameter optional: Emit the object created or changed by the command.
-Slide PowerPointSlide optionalpipeline: True (ByValue): Target slide that will receive the text box (optional inside DSL).
-Text String requiredsets: Text: Text to render inside the box.
-Width Int32 optional: Box width in points.
-X Int32 optional: Left offset (in points) from the slide origin.
-Y Int32 optional: Top offset (in points) from the slide origin.
-Run Object[] requiredaliases: Runssets: Run: Rich text runs. Each run can be created with TextRun/PowerPointTextRun or provided as a hashtable/object.

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.