API Reference

Cmdlet

Import-OfficeVisioStencil

Aliases: Import-VisioStencil
Namespace PSWriteOffice
Aliases
Import-VisioStencil
Inputs
OfficeIMO.Visio.Stencils.VisioStencilCatalog
Outputs
OfficeIMO.Visio.Stencils.VisioStencilCatalog

Registers a stencil catalog with the active Visio DSL scope.

Remarks

Registers a stencil catalog with the active Visio DSL scope.

Examples

Authored help example

Register a catalog for DSL use.

PS>


New-OfficeVisio -Path .\Flow.vsdx -UseMastersByDefault {
                Import-OfficeVisioStencil -BuiltIn Flowchart -Name Flow -Default
                VisioStencil -Stencil process -Key step -Text 'Step' -X 2 -Y 4
            }
        

Registers the flowchart catalog and makes it the default for later VisioStencil calls.

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

Import-OfficeVisioStencil -Catalog <VisioStencilCatalog> [-Default] [-Name <String>] [<CommonParameters>]
#
Parameter set: Catalog

Parameters

Catalog VisioStencilCatalog requiredposition: namedpipeline: True (ByValue)
Catalog object to register.
Default SwitchParameter optionalposition: namedpipeline: False
Make this catalog the default for later VisioStencil calls.
Name String optionalposition: namedpipeline: Falsealiases: CatalogName, Key
Name used by VisioStencil -Catalog in the DSL.

Outputs

OfficeIMO.Visio.Stencils.VisioStencilCatalog

Import-OfficeVisioStencil -BuiltIn <All> [-Default] [-Name <String>] [<CommonParameters>]
#
Parameter set: BuiltIn

Parameters

BuiltIn OfficeVisioBuiltInStencilCatalog requiredposition: namedpipeline: Falsevalues: 16
Built-in OfficeIMO stencil catalog to register.
Possible values: All, BasicShapes, Flowchart, BlockDiagram, Architecture, Network, Infrastructure, Cloud, SecurityIdentity, ContainersKubernetes, DataPlatform, CollaborationBusiness, Swimlane, OrgChart, Timeline, Sequence
Default SwitchParameter optionalposition: namedpipeline: False
Make this catalog the default for later VisioStencil calls.
Name String optionalposition: namedpipeline: Falsealiases: CatalogName, Key
Name used by VisioStencil -Catalog in the DSL.

Outputs

OfficeIMO.Visio.Stencils.VisioStencilCatalog

Import-OfficeVisioStencil [-Category <String>] [-Default] [-DefaultHeight <Double>] [-DefaultWidth <Double>] [-IdPrefix <String>] [-IncludeUnsupportedMasters] [-LoadCatalogName <String>] [-MasterName <String[]>] [-Name <String>] [-NoConnectionPointMetadata] [-NoLearnMasterDimensions] [-NoPreviewImageMetadata] -Path <String[]> [-Recurse] [<CommonParameters>]
#
Parameter set: Path

Parameters

Category String optionalposition: namedpipeline: False
Category assigned to package-backed stencil shapes.
Default SwitchParameter optionalposition: namedpipeline: False
Make this catalog the default for later VisioStencil calls.
DefaultHeight Double optionalposition: namedpipeline: False
Default height for package-backed stencils when dimensions cannot be learned.
DefaultWidth Double optionalposition: namedpipeline: False
Default width for package-backed stencils when dimensions cannot be learned.
IdPrefix String optionalposition: namedpipeline: False
Stable id prefix for package-backed stencil shapes.
IncludeUnsupportedMasters SwitchParameter optionalposition: namedpipeline: False
Include unsupported package masters as generic generated masters.
LoadCatalogName String optionalposition: namedpipeline: False
Catalog display name when loading package metadata.
MasterName String[] optionalposition: namedpipeline: False
Optional master filters for package-backed catalogs.
Name String optionalposition: namedpipeline: Falsealiases: CatalogName, Key
Name used by VisioStencil -Catalog in the DSL.
NoConnectionPointMetadata SwitchParameter optionalposition: namedpipeline: False
Skip reading source connection point metadata from package master parts.
NoLearnMasterDimensions SwitchParameter optionalposition: namedpipeline: False
Skip reading master dimensions from package master parts.
NoPreviewImageMetadata SwitchParameter optionalposition: namedpipeline: False
Skip reading preview image relationship metadata from package master parts.
Path String[] requiredposition: 0pipeline: Falsealiases: FilePath, LiteralPath
Visio package, package directory, or OfficeIMO native stencil manifest path to load and register.
Recurse SwitchParameter optionalposition: namedpipeline: False
Search directories recursively.

Outputs

OfficeIMO.Visio.Stencils.VisioStencilCatalog

Import-OfficeVisioStencil [-Category <String>] [-Default] [-DefaultHeight <Double>] [-DefaultWidth <Double>] [-IdPrefix <String>] [-IncludeUnsupportedMasters] -Installed [-LoadCatalogName <String>] [-MasterName <String[]>] [-Name <String>] [-NoConnectionPointMetadata] [-NoLearnMasterDimensions] [-NoPreviewImageMetadata] [<CommonParameters>]
#
Parameter set: Installed

Parameters

Category String optionalposition: namedpipeline: False
Category assigned to package-backed stencil shapes.
Default SwitchParameter optionalposition: namedpipeline: False
Make this catalog the default for later VisioStencil calls.
DefaultHeight Double optionalposition: namedpipeline: False
Default height for package-backed stencils when dimensions cannot be learned.
DefaultWidth Double optionalposition: namedpipeline: False
Default width for package-backed stencils when dimensions cannot be learned.
IdPrefix String optionalposition: namedpipeline: False
Stable id prefix for package-backed stencil shapes.
IncludeUnsupportedMasters SwitchParameter optionalposition: namedpipeline: False
Include unsupported package masters as generic generated masters.
Installed SwitchParameter requiredposition: namedpipeline: False
Discover installed Microsoft Visio stencils and templates, then register the combined catalog.
LoadCatalogName String optionalposition: namedpipeline: False
Catalog display name when loading package metadata.
MasterName String[] optionalposition: namedpipeline: False
Optional master filters for package-backed catalogs.
Name String optionalposition: namedpipeline: Falsealiases: CatalogName, Key
Name used by VisioStencil -Catalog in the DSL.
NoConnectionPointMetadata SwitchParameter optionalposition: namedpipeline: False
Skip reading source connection point metadata from package master parts.
NoLearnMasterDimensions SwitchParameter optionalposition: namedpipeline: False
Skip reading master dimensions from package master parts.
NoPreviewImageMetadata SwitchParameter optionalposition: namedpipeline: False
Skip reading preview image relationship metadata from package master parts.

Outputs

OfficeIMO.Visio.Stencils.VisioStencilCatalog