Cmdlet

Add-OfficeVisioTextBox

Aliases: VisioText, VisioTextBox

Module: PSWriteOffice
Aliases: VisioText VisioTextBox
Inputs: OfficeIMO.Visio.VisioPage
Outputs: OfficeIMO.Visio.VisioShape
Source: AddOfficeVisioTextBoxCommand.cs:19 Edit on GitHub

Adds a text box to the current Visio page.

Syntax

Add-OfficeVisioTextBox
[-FillColor <String>]
[-Height <Double>]
[-Key <String>]
[-LineColor <String>]
[-LineWeight <Double>]
[-Name <String>]
[-NameU <String>]
[-Page <VisioPage>]
[-PassThru]
[-Text] <String>
[-Unit <Inches|Centimeters|Millimeters>]
[-Width <Double>]
[-X <Double>]
[-Y <Double>]
[<CommonParameters>]

Parameter set: All Parameter Sets

Examples

Add a diagram note.

OfficeVisio -Path .\Notes.vsdx {
    VisioTextBox -Text 'Generated by PSWriteOffice' -X 1 -Y 1 -Width 3 -Height 0.4
}

Adds a plain text annotation to the active page.

Parameters

-FillColor String optional: Fill color name or hex value.
-Height Double optional: Text box height.
-Key String optional: DSL key used by connector commands.
-LineColor String optional: Line color name or hex value.
-LineWeight Double optional: Line weight.
-Name String optional: Optional shape name.
-NameU String optional: Optional universal shape name.
-Page VisioPage optionalpipeline: True (ByValue): Target page. Optional inside VisioPage or OfficeVisio.
-PassThru SwitchParameter optional: Emit the object created or changed by the command.
-Text String requiredposition: 0: Text placed inside the text box.
-Unit VisioMeasurementUnit optional: Measurement unit for coordinates and dimensions.; Possible values: Inches, Centimeters, Millimeters
-Width Double optional: Text box width.
-X Double optional: X coordinate of the text box origin.
-Y Double optional: Y coordinate of the text box origin.

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.