Export-OfficeVisioStencilPreviewGallery

Aliases: Export-VisioStencilPreviewGallery

Namespace PSWriteOffice

Aliases

Export-VisioStencilPreviewGallery

Inputs

None

Outputs

OfficeIMO.Visio.Stencils.VisioStencilPreviewGallery

Source

Sources/PSWriteOffice/Cmdlets/Visio/ExportOfficeVisioStencilPreviewGalleryCommand.cs:15 Edit on GitHub

Exports preview artwork from a Visio stencil package into a browsable HTML gallery.

Remarks

Exports preview artwork from a Visio stencil package into a browsable HTML gallery.

Examples

Authored help example

Create a stencil preview gallery.

PS>


$gallery = Export-OfficeVisioStencilPreviewGallery -Path .\MyShapes.vssx -OutputDirectory .\StencilGallery -Title 'Custom stencil previews'
            $gallery | Select-Object PackagePath, IndexPath, BrowserRenderableCount, ThumbnailCount

Extracts preview artwork from package-backed masters and writes preview files plus an HTML index.

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

Export-OfficeVisioStencilPreviewGallery [-DefaultHeight <Double>] [-DefaultWidth <Double>] [-IncludeUnsupportedMasters] [-IndexFileName <String>] [-MasterName <String[]>] [-NoIndex] [-NoLearnMasterDimensions] [-NoThumbnails] -OutputDirectory <String> -Path <String> [-PreviewDirectoryName <String>] [-ThumbnailDirectoryName <String>] [-ThumbnailHeight <Int32>] [-ThumbnailWidth <Int32>] [-Title <String>] [<CommonParameters>]

Parameter set: All Parameter Sets

Parameters

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.
IncludeUnsupportedMasters SwitchParameter optionalposition: namedpipeline: False: Include unsupported package masters when looking for preview artwork.
IndexFileName String optionalposition: namedpipeline: False: Generated HTML index file name.
MasterName String[] optionalposition: namedpipeline: False: Optional master filters for package-backed catalogs.
NoIndex SwitchParameter optionalposition: namedpipeline: False: Do not write an HTML index file.
NoLearnMasterDimensions SwitchParameter optionalposition: namedpipeline: False: Skip reading master dimensions from package master parts.
NoThumbnails SwitchParameter optionalposition: namedpipeline: False: Do not write browser-renderable thumbnail wrappers.
OutputDirectory String requiredposition: 1pipeline: False: Directory that receives preview payloads, thumbnails, and the HTML index.
Path String requiredposition: 0pipeline: Falsealiases: FilePath, LiteralPath: Visio package path, such as .vsdx, .vssx, or .vstx.
PreviewDirectoryName String optionalposition: namedpipeline: False: Subdirectory that receives extracted preview payload files.
ThumbnailDirectoryName String optionalposition: namedpipeline: False: Subdirectory that receives generated thumbnail wrappers.
ThumbnailHeight Int32 optionalposition: namedpipeline: False: Generated thumbnail height in pixels.
ThumbnailWidth Int32 optionalposition: namedpipeline: False: Generated thumbnail width in pixels.
Title String optionalposition: namedpipeline: False: Gallery title. When omitted, a title is derived from the package name.

Outputs

OfficeIMO.Visio.Stencils.VisioStencilPreviewGallery