Add-OfficeVisioContainer

Aliases: VisioContainer

Namespace PSWriteOffice

Aliases

VisioContainer

Inputs

System.Object

Outputs

OfficeIMO.Visio.VisioShape

Source

Sources/PSWriteOffice/Cmdlets/Visio/AddOfficeVisioContainerCommand.cs:22 Edit on GitHub

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

Remarks

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

Examples

Authored help example

Group related shapes in a container.

PS>


New-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.

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-OfficeVisioContainer [-ContainerStyle <Nullable`1>] [-FillColor <String>] [-HeadingHeight <Nullable`1>] [-HeadingStyle <Nullable`1>] -Id <String> [-InputObject <Object>] [-LineColor <String>] [-LineWeight <Nullable`1>] [-Locked] [-Margin <Nullable`1>] [-NoAutoResize] [-NoHighlight] [-NoRibbon] [-Page <VisioPage>] [-ShapeId <String[]>] [-Text <String>] [<CommonParameters>]

Parameter set: All Parameter Sets

Parameters

ContainerStyle Nullable`1 optionalposition: namedpipeline: False: Native Visio container style identifier.
FillColor String optionalposition: namedpipeline: False: Container fill color.
HeadingHeight Nullable`1 optionalposition: namedpipeline: False: Additional heading height in page units.
HeadingStyle Nullable`1 optionalposition: namedpipeline: False: Native Visio heading style identifier.
Id String requiredposition: namedpipeline: False: Container shape identifier.
InputObject Object optionalposition: 0pipeline: True (ByValue): Shapes, shape selections, or shape keys/ids to include in the container.
LineColor String optionalposition: namedpipeline: False: Container line color.
LineWeight Nullable`1 optionalposition: namedpipeline: False: Container line weight in inches.
Locked SwitchParameter optionalposition: namedpipeline: False: Lock the generated container.
Margin Nullable`1 optionalposition: namedpipeline: False: Outer margin around member shapes in page units.
NoAutoResize SwitchParameter optionalposition: namedpipeline: False: Disable Visio container auto resize metadata.
NoHighlight SwitchParameter optionalposition: namedpipeline: False: Suppress Visio selection highlighting metadata.
NoRibbon SwitchParameter optionalposition: namedpipeline: False: Suppress Visio container ribbon metadata.
Page VisioPage optionalposition: namedpipeline: False: Page that owns the member shapes. Optional inside New-OfficeVisio/VisioPage DSL scopes.
ShapeId String[] optionalposition: namedpipeline: False: Shape keys or ids to include in the container.
Text String optionalposition: namedpipeline: False: Container heading text.

Outputs

OfficeIMO.Visio.VisioShape