API Reference

Cmdlet

Add-OfficeVisioStencilShape

Aliases: VisioStencil
Namespace PSWriteOffice
Aliases
VisioStencil
Inputs
OfficeIMO.Visio.VisioPage
Outputs
OfficeIMO.Visio.VisioShape

Adds a stencil shape to the current Visio page.

Remarks

Adds a stencil shape to the current Visio page.

Examples

Authored help example

Add built-in flowchart stencil shapes.

PS>


New-OfficeVisio -Path .\StencilFlow.vsdx -UseMastersByDefault {
                Import-OfficeVisioStencil -BuiltIn Flowchart -Name Flow -Default
                VisioStencil -Catalog Flow -Stencil process -Key intake -Text 'Intake' -X 1.5 -Y 4
            }
        

Registers a built-in catalog and places a stencil shape on the active page.

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-OfficeVisioStencilShape [-Angle <Nullable`1>] [-Catalog <String>] [-FillColor <String>] [-FillPattern <Nullable`1>] [-Height <Nullable`1>] [-Key <String>] [-LineColor <String>] [-LinePattern <Nullable`1>] [-LineWeight <Nullable`1>] [-NameU <String>] [-Page <VisioPage>] [-ShapeName <String>] -Stencil <String> [-Text <String>] [-Width <Nullable`1>] [-X <Double>] [-Y <Double>] [<CommonParameters>]
#
Parameter set: CatalogName

Parameters

Angle Nullable`1 optionalposition: namedpipeline: False
Shape angle in radians.
Catalog String optionalposition: namedpipeline: Falsealiases: CatalogName
Catalog previously registered in the active Visio DSL scope.
FillColor String optionalposition: namedpipeline: False
Fill color name or hex value.
FillPattern Nullable`1 optionalposition: namedpipeline: False
Fill pattern.
Height Nullable`1 optionalposition: namedpipeline: False
Optional shape height. Omit to use the stencil default height.
Key String optionalposition: namedpipeline: False
DSL key used by connector commands.
LineColor String optionalposition: namedpipeline: False
Line color name or hex value.
LinePattern Nullable`1 optionalposition: namedpipeline: False
Line pattern.
LineWeight Nullable`1 optionalposition: namedpipeline: False
Line weight.
NameU String optionalposition: namedpipeline: False
Optional universal shape name.
Page VisioPage optionalposition: namedpipeline: True (ByValue)
Target page. Optional inside VisioPage or New-OfficeVisio.
ShapeName String optionalposition: namedpipeline: False
Optional shape name.
Stencil String requiredposition: 0pipeline: Falsealiases: Name
Stencil id, name, master name, keyword, alias, or tag.
Text String optionalposition: 1pipeline: False
Text placed inside the shape. Omit to use the stencil display name.
Width Nullable`1 optionalposition: namedpipeline: False
Optional shape width. Omit to use the stencil default width.
X Double optionalposition: namedpipeline: False
X coordinate of the stencil shape center.
Y Double optionalposition: namedpipeline: False
Y coordinate of the stencil shape center.

Outputs

OfficeIMO.Visio.VisioShape

Add-OfficeVisioStencilShape [-Angle <Nullable`1>] -CatalogObject <VisioStencilCatalog> [-FillColor <String>] [-FillPattern <Nullable`1>] [-Height <Nullable`1>] [-Key <String>] [-LineColor <String>] [-LinePattern <Nullable`1>] [-LineWeight <Nullable`1>] [-NameU <String>] [-Page <VisioPage>] [-ShapeName <String>] -Stencil <String> [-Text <String>] [-Width <Nullable`1>] [-X <Double>] [-Y <Double>] [<CommonParameters>]
#
Parameter set: CatalogObject

Parameters

Angle Nullable`1 optionalposition: namedpipeline: False
Shape angle in radians.
CatalogObject VisioStencilCatalog requiredposition: namedpipeline: False
Catalog object containing the stencil shape.
FillColor String optionalposition: namedpipeline: False
Fill color name or hex value.
FillPattern Nullable`1 optionalposition: namedpipeline: False
Fill pattern.
Height Nullable`1 optionalposition: namedpipeline: False
Optional shape height. Omit to use the stencil default height.
Key String optionalposition: namedpipeline: False
DSL key used by connector commands.
LineColor String optionalposition: namedpipeline: False
Line color name or hex value.
LinePattern Nullable`1 optionalposition: namedpipeline: False
Line pattern.
LineWeight Nullable`1 optionalposition: namedpipeline: False
Line weight.
NameU String optionalposition: namedpipeline: False
Optional universal shape name.
Page VisioPage optionalposition: namedpipeline: True (ByValue)
Target page. Optional inside VisioPage or New-OfficeVisio.
ShapeName String optionalposition: namedpipeline: False
Optional shape name.
Stencil String requiredposition: 0pipeline: Falsealiases: Name
Stencil id, name, master name, keyword, alias, or tag.
Text String optionalposition: 1pipeline: False
Text placed inside the shape. Omit to use the stencil display name.
Width Nullable`1 optionalposition: namedpipeline: False
Optional shape width. Omit to use the stencil default width.
X Double optionalposition: namedpipeline: False
X coordinate of the stencil shape center.
Y Double optionalposition: namedpipeline: False
Y coordinate of the stencil shape center.

Outputs

OfficeIMO.Visio.VisioShape

Add-OfficeVisioStencilShape [-Angle <Nullable`1>] [-BuiltIn <All>] [-FillColor <String>] [-FillPattern <Nullable`1>] [-Height <Nullable`1>] [-Key <String>] [-LineColor <String>] [-LinePattern <Nullable`1>] [-LineWeight <Nullable`1>] [-NameU <String>] [-Page <VisioPage>] [-ShapeName <String>] -Stencil <String> [-Text <String>] [-Width <Nullable`1>] [-X <Double>] [-Y <Double>] [<CommonParameters>]
#
Parameter set: BuiltIn

Parameters

Angle Nullable`1 optionalposition: namedpipeline: False
Shape angle in radians.
BuiltIn OfficeVisioBuiltInStencilCatalog optionalposition: namedpipeline: Falsevalues: 16
Built-in OfficeIMO stencil catalog containing the shape.
Possible values: All, BasicShapes, Flowchart, BlockDiagram, Architecture, Network, Infrastructure, Cloud, SecurityIdentity, ContainersKubernetes, DataPlatform, CollaborationBusiness, Swimlane, OrgChart, Timeline, Sequence
FillColor String optionalposition: namedpipeline: False
Fill color name or hex value.
FillPattern Nullable`1 optionalposition: namedpipeline: False
Fill pattern.
Height Nullable`1 optionalposition: namedpipeline: False
Optional shape height. Omit to use the stencil default height.
Key String optionalposition: namedpipeline: False
DSL key used by connector commands.
LineColor String optionalposition: namedpipeline: False
Line color name or hex value.
LinePattern Nullable`1 optionalposition: namedpipeline: False
Line pattern.
LineWeight Nullable`1 optionalposition: namedpipeline: False
Line weight.
NameU String optionalposition: namedpipeline: False
Optional universal shape name.
Page VisioPage optionalposition: namedpipeline: True (ByValue)
Target page. Optional inside VisioPage or New-OfficeVisio.
ShapeName String optionalposition: namedpipeline: False
Optional shape name.
Stencil String requiredposition: 0pipeline: Falsealiases: Name
Stencil id, name, master name, keyword, alias, or tag.
Text String optionalposition: 1pipeline: False
Text placed inside the shape. Omit to use the stencil display name.
Width Nullable`1 optionalposition: namedpipeline: False
Optional shape width. Omit to use the stencil default width.
X Double optionalposition: namedpipeline: False
X coordinate of the stencil shape center.
Y Double optionalposition: namedpipeline: False
Y coordinate of the stencil shape center.

Outputs

OfficeIMO.Visio.VisioShape