Cmdlet

Add-OfficeWordTextBox

Aliases: WordTextBox

Module: PSWriteOffice
Aliases: WordTextBox
Inputs: None
Outputs: OfficeIMO.Word.WordTextBox
Source: AddOfficeWordTextBoxCommand.cs:19 Edit on GitHub

Adds an OfficeIMO Word text box to the current Word DSL location.

Syntax

Add-OfficeWordTextBox
[-AutoFit <NoAutoFit|ShrinkTextOnOverflow|ResizeShapeToFitText>]
[-AutoFitToTextSize]
[-HeightCentimeters <Double>]
[-HorizontalAlignment <Left|Center|Right|Outside|Inside>]
[-HorizontalOffsetCentimeters <Double>]
[-HorizontalPositionRelativeFrom <WordHorizontalRelativePosition>]
[-PassThru]
[-Text] <String>
[-VerticalOffsetCentimeters <Double>]
[-VerticalPositionRelativeFrom <WordVerticalRelativePosition>]
[-WidthCentimeters <Double>]
[-WrapText <WordImageTextWrapping>]
[<CommonParameters>]

Parameter set: All Parameter Sets

Examples

Add a positioned report callout.

New-OfficeWord -Path .\Report.docx {
    WordTextBox -Text 'Executive summary' -WidthCentimeters 7 -HeightCentimeters 2 -HorizontalOffsetCentimeters 1.5 -VerticalOffsetCentimeters 1 -AutoFitToTextSize
}

Creates a native OfficeIMO Word text box and applies sizing/positioning through OfficeIMO's text-box API.

Parameters

-AutoFit WordTextBoxAutoFitType optional: Explicit OfficeIMO text-box autofit mode.; Possible values: NoAutoFit, ShrinkTextOnOverflow, ResizeShapeToFitText
-AutoFitToTextSize SwitchParameter optional: Resize the text box to fit its text.
-HeightCentimeters Double optional: Height in centimeters.
-HorizontalAlignment WordTextBoxHorizontalAlignment optional: Horizontal alignment for anchored text boxes.; Possible values: Left, Center, Right, Outside, Inside
-HorizontalOffsetCentimeters Double optional: Horizontal offset in centimeters.
-HorizontalPositionRelativeFrom WordHorizontalRelativePosition optional: Horizontal relative position anchor.; Possible values: Margin, Page, Column, Character, LeftMargin, RightMargin, InsideMargin, OutsideMargin
-PassThru SwitchParameter optional: Emit the created text box.
-Text String requiredposition: 0: Text to place inside the text box.
-VerticalOffsetCentimeters Double optional: Vertical offset in centimeters.
-VerticalPositionRelativeFrom WordVerticalRelativePosition optional: Vertical relative position anchor.; Possible values: Margin, Page, Paragraph, Line, TopMargin, BottomMargin, InsideMargin, OutsideMargin
-WidthCentimeters Double optional: Width in centimeters.
-WrapText WordImageTextWrapping optional: Word text wrapping mode.; Possible values: InLineWithText, Square, Tight, Through, TopAndBottom, BehindText, InFrontOfText

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.