Cmdlet

Add-OfficeVisioContainer

Aliases: VisioContainer

Module: PSWriteOffice
Aliases: VisioContainer
Inputs: System.Object
Outputs: OfficeIMO.Visio.VisioShape
Source: AddOfficeVisioContainerCommand.cs:25 Edit on GitHub

Creates an OfficeIMO-authored Visio-native container around existing shapes.

Syntax

Add-OfficeVisioContainer
[-ContainerStyle <Int32>]
[-FillColor <String>]
[-HeadingHeight <Double>]
[-HeadingStyle <Int32>]
-Id <String>
[[-InputObject] <Object>]
[-LineColor <String>]
[-LineWeight <Double>]
[-Locked]
[-Margin <Double>]
[-NoAutoResize]
[-NoHighlight]
[-NoRibbon]
[-Page <VisioPage>]
[-PassThru]
[-ShapeId <String[]>]
[-Text <String>]
[<CommonParameters>]

Parameter set: All Parameter Sets

Examples

Group related shapes in a container.

OfficeVisio -Path .\Architecture.vsdx {
    VisioRectangle -Key api -Text 'API' -X 2 -Y 4
    VisioRectangle -Key worker -Text 'Worker' -X 4 -Y 4
    VisioContainer -Id app -Text 'Application tier' -ShapeId api,worker -FillColor '#F8FAFC'
}

Creates a native Visio container around previously keyed shapes.

Parameters

-ContainerStyle Int32 optional: Native Visio container gallery identifier. Zero selects the default/no explicit gallery style.
-FillColor String optional: Container fill color.
-HeadingHeight Double optional: Additional heading height in page units.
-HeadingStyle Int32 optional: Native Visio heading gallery identifier. Zero disables the heading style.
-Id String required: Container shape identifier.
-InputObject Object optionalposition: 0pipeline: True (ByValue): Shapes, shape selections, or shape keys/ids to include in the container.
-LineColor String optional: Container line color.
-LineWeight Double optional: Container line weight in inches.
-Locked SwitchParameter optional: Lock the generated container.
-Margin Double optional: Outer margin around member shapes in page units.
-NoAutoResize SwitchParameter optional: Disable Visio container auto resize metadata.
-NoHighlight SwitchParameter optional: Suppress Visio selection highlighting metadata.
-NoRibbon SwitchParameter optional: Suppress Visio container ribbon metadata.
-Page VisioPage optional: Page that owns the member shapes. Optional inside OfficeVisio/VisioPage DSL scopes.
-PassThru SwitchParameter optional: Emit the object created or changed by the command.
-ShapeId String[] optional: Shape keys or ids to include in the container.
-Text String optional: Container heading text.

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.