Add-OfficeWordTextBox

Aliases: WordTextBox

Namespace PSWriteOffice

Aliases

WordTextBox

Inputs

None

Outputs

OfficeIMO.Word.WordTextBox

Source

Sources/PSWriteOffice/Cmdlets/Word/AddOfficeWordTextBoxCommand.cs:19 Edit on GitHub

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

Remarks

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

Examples

Authored help example

Add a positioned report callout.

PS>


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.

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

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

Parameter set: All Parameter Sets

Parameters

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

Outputs

OfficeIMO.Word.WordTextBox