API Reference

Class

VisioStencilShape

Edit on GitHub

Namespace OfficeIMO.Visio.Stencils

Assembly OfficeIMO.Visio

Source VisioStencilShape.cs:15

Modifiers sealed

Describes an OfficeIMO-native stencil shape that can be generated without depending on a VSDX/VSSX template.

Inheritance

Object
VisioStencilShape

Usage

Explore 32 API references to this type

This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.

Returned or exposed by 8

Property VisioGraphNodeRecord.Stencil
Method VisioStencilCatalog.FindBest
Method VisioStencilCatalog.Get
Method VisioStencilCatalog.InCategory
Method VisioStencilCatalog.Search
Property VisioStencilCatalog.Shapes
Property VisioStencilCatalogBuilder.Shapes
Property VisioStencilMigrationRule.Replacement

Accepted by parameters 24

Method VisioGraphDiagramBuilder.StencilNode parameter stencil
Method VisioFluentPage.ReplaceMaster parameter stencil
Method VisioFluentPage.ReplaceMasters parameter stencil
Method VisioFluentPage.ReplaceMastersByMaster parameter replacementStencil
Method VisioFluentPage.Stencil parameter stencil
Constructor VisioStencilCatalog.VisioStencilCatalog parameter shapes
Method VisioStencilCatalog.TryFindBest parameter shape
Method VisioStencilCatalog.TryGet parameter shape
Method VisioStencilCatalogBuilder.Add parameter shape
Method VisioStencilPageExtensions.AddStencilShape parameter stencil
Method VisioDocument.ImportStencilMasters parameter shapes
Method VisioDocument.ImportStencilMastersAndGet parameter shapes
Method VisioMasterEditingExtensions.ReplaceMaster parameter stencil
Extension method VisioPage.AddStencilShape parameter stencil
Extension method VisioPage.ReplaceMaster parameter stencil
Extension method VisioShapeSelection.ReplaceMaster parameter stencil
Method VisioStencilMigrationMapBuilder.Map parameter replacement
Method VisioStencilMigrationMapBuilder.MapMaster parameter replacement
Method VisioStencilMigrationMapBuilder.MapNameU parameter replacement
Method VisioStencilMigrationMapBuilder.MapStencilId parameter replacement
Method VisioStencilMigrationRule.ForMaster parameter replacement
Method VisioStencilMigrationRule.ForNameU parameter replacement
Method VisioStencilMigrationRule.ForPredicate parameter replacement
Method VisioStencilMigrationRule.ForStencilId parameter replacement

Constructors

VisioStencilShape 6 overloads

public VisioStencilShape(String id, String name, String masterNameU, String category, Double defaultWidth, Double defaultHeight, IEnumerable<String>? keywords = null, IEnumerable<String>? aliases = null, IEnumerable<String>? tags = null, String? iconNameU = null)

VisioStencilShape.cs:15

Initializes a new stencil shape definition.

Parameters

id System.String requiredposition: 0
name System.String requiredposition: 1
masterNameU System.String requiredposition: 2
category System.String requiredposition: 3
defaultWidth System.Double requiredposition: 4
defaultHeight System.Double requiredposition: 5
keywords System.Collections.Generic.IEnumerable<System.String>? = null optionalposition: 6
aliases System.Collections.Generic.IEnumerable<System.String>? = null optionalposition: 7
tags System.Collections.Generic.IEnumerable<System.String>? = null optionalposition: 8
iconNameU System.String? = null optionalposition: 9

public VisioStencilShape(String id, String name, String masterNameU, String category, Double defaultWidth, Double defaultHeight, IEnumerable<String>? keywords, IEnumerable<String>? aliases, IEnumerable<String>? tags, String? iconNameU, VisioMeasurementUnit? defaultUnit)

VisioStencilShape.cs:22

Initializes a new stencil shape definition with an explicit default-size unit.

Parameters

id System.String requiredposition: 0
name System.String requiredposition: 1
masterNameU System.String requiredposition: 2
category System.String requiredposition: 3
defaultWidth System.Double requiredposition: 4
defaultHeight System.Double requiredposition: 5
keywords System.Collections.Generic.IEnumerable<System.String>? requiredposition: 6
aliases System.Collections.Generic.IEnumerable<System.String>? requiredposition: 7
tags System.Collections.Generic.IEnumerable<System.String>? requiredposition: 8
iconNameU System.String? requiredposition: 9
defaultUnit OfficeIMO.Visio.VisioMeasurementUnit? requiredposition: 10

public VisioStencilShape(String id, String name, String masterNameU, String category, Double defaultWidth, Double defaultHeight, IEnumerable<String>? keywords, IEnumerable<String>? aliases, IEnumerable<String>? tags, String? iconNameU, VisioMeasurementUnit? defaultUnit, String? sourcePackagePath)

VisioStencilShape.cs:29

Initializes a new stencil shape definition with source package metadata.

Parameters

id System.String requiredposition: 0
name System.String requiredposition: 1
masterNameU System.String requiredposition: 2
category System.String requiredposition: 3
defaultWidth System.Double requiredposition: 4
defaultHeight System.Double requiredposition: 5
keywords System.Collections.Generic.IEnumerable<System.String>? requiredposition: 6
aliases System.Collections.Generic.IEnumerable<System.String>? requiredposition: 7
tags System.Collections.Generic.IEnumerable<System.String>? requiredposition: 8
iconNameU System.String? requiredposition: 9
defaultUnit OfficeIMO.Visio.VisioMeasurementUnit? requiredposition: 10
sourcePackagePath System.String? requiredposition: 11

public VisioStencilShape(String id, String name, String masterNameU, String category, Double defaultWidth, Double defaultHeight, IEnumerable<String>? keywords, IEnumerable<String>? aliases, IEnumerable<String>? tags, String? iconNameU, VisioMeasurementUnit? defaultUnit, String? sourcePackagePath, VisioStencilPreviewImage? previewImage)

VisioStencilShape.cs:36

Initializes a new stencil shape definition with source package and preview image metadata.

Parameters

id System.String requiredposition: 0
name System.String requiredposition: 1
masterNameU System.String requiredposition: 2
category System.String requiredposition: 3
defaultWidth System.Double requiredposition: 4
defaultHeight System.Double requiredposition: 5
keywords System.Collections.Generic.IEnumerable<System.String>? requiredposition: 6
aliases System.Collections.Generic.IEnumerable<System.String>? requiredposition: 7
tags System.Collections.Generic.IEnumerable<System.String>? requiredposition: 8
iconNameU System.String? requiredposition: 9
defaultUnit OfficeIMO.Visio.VisioMeasurementUnit? requiredposition: 10
sourcePackagePath System.String? requiredposition: 11
previewImage OfficeIMO.Visio.Stencils.VisioStencilPreviewImage? requiredposition: 12

public VisioStencilShape(String id, String name, String masterNameU, String category, Double defaultWidth, Double defaultHeight, IEnumerable<String>? keywords, IEnumerable<String>? aliases, IEnumerable<String>? tags, String? iconNameU, VisioMeasurementUnit? defaultUnit, String? sourcePackagePath, VisioStencilPreviewImage? previewImage, IEnumerable<VisioStencilConnectionPoint>? sourceConnectionPoints)

VisioStencilShape.cs:43

Initializes a new stencil shape definition with source package, preview image, and connection point metadata.

Parameters

id System.String requiredposition: 0
name System.String requiredposition: 1
masterNameU System.String requiredposition: 2
category System.String requiredposition: 3
defaultWidth System.Double requiredposition: 4
defaultHeight System.Double requiredposition: 5
keywords System.Collections.Generic.IEnumerable<System.String>? requiredposition: 6
aliases System.Collections.Generic.IEnumerable<System.String>? requiredposition: 7
tags System.Collections.Generic.IEnumerable<System.String>? requiredposition: 8
iconNameU System.String? requiredposition: 9
defaultUnit OfficeIMO.Visio.VisioMeasurementUnit? requiredposition: 10
sourcePackagePath System.String? requiredposition: 11
previewImage OfficeIMO.Visio.Stencils.VisioStencilPreviewImage? requiredposition: 12
sourceConnectionPoints System.Collections.Generic.IEnumerable<OfficeIMO.Visio.Stencils.VisioStencilConnectionPoint>? requiredposition: 13

public VisioStencilShape(String id, String name, String masterNameU, String category, Double defaultWidth, Double defaultHeight, IEnumerable<String>? keywords, IEnumerable<String>? aliases, IEnumerable<String>? tags, String? iconNameU, VisioMeasurementUnit? defaultUnit, String? sourcePackagePath, VisioStencilPreviewImage? previewImage, IEnumerable<VisioStencilConnectionPoint>? sourceConnectionPoints, Boolean isSupported = true, String? sourceLicense = null, String? sourceAttribution = null)

VisioStencilShape.cs:49

Initializes a new stencil shape definition with source package, preview image, connection point, support, and licensing metadata.

Parameters

id System.String requiredposition: 0
name System.String requiredposition: 1
masterNameU System.String requiredposition: 2
category System.String requiredposition: 3
defaultWidth System.Double requiredposition: 4
defaultHeight System.Double requiredposition: 5
keywords System.Collections.Generic.IEnumerable<System.String>? requiredposition: 6
aliases System.Collections.Generic.IEnumerable<System.String>? requiredposition: 7
tags System.Collections.Generic.IEnumerable<System.String>? requiredposition: 8
iconNameU System.String? requiredposition: 9
defaultUnit OfficeIMO.Visio.VisioMeasurementUnit? requiredposition: 10
sourcePackagePath System.String? requiredposition: 11
previewImage OfficeIMO.Visio.Stencils.VisioStencilPreviewImage? requiredposition: 12
sourceConnectionPoints System.Collections.Generic.IEnumerable<OfficeIMO.Visio.Stencils.VisioStencilConnectionPoint>? requiredposition: 13
isSupported System.Boolean = true optionalposition: 14
sourceLicense System.String? = null optionalposition: 15
sourceAttribution System.String? = null optionalposition: 16

Inherited Methods

Properties

public String Id { get; } #

VisioStencilShape.cs:99

Gets a stable OfficeIMO stencil identifier.

public String Name { get; } #

VisioStencilShape.cs:104

Gets the display name.

public String MasterNameU { get; } #

VisioStencilShape.cs:109

Gets the generated master universal name used by OfficeIMO.

public String Category { get; } #

VisioStencilShape.cs:114

Gets the category name.

public Double DefaultWidth { get; } #

VisioStencilShape.cs:119

Gets the default shape width in the caller's placement unit.

public Double DefaultHeight { get; } #

VisioStencilShape.cs:124

Gets the default shape height in the caller's placement unit.

public VisioMeasurementUnit? DefaultUnit { get; } #

VisioStencilShape.cs:130

Gets the unit used by the default size, when it is fixed by the source catalog. When null, default sizes are interpreted in the caller's placement unit.

public String? SourcePackagePath { get; } #

VisioStencilShape.cs:135

Gets the source `.vssx`, `.vstx`, or `.vsdx` package path when this shape was cataloged from a package.

public VisioStencilPreviewImage? PreviewImage { get; } #

VisioStencilShape.cs:140

Gets preview/icon image metadata discovered from a source package master, when available.

public IReadOnlyList<VisioStencilConnectionPoint> SourceConnectionPoints { get; } #

VisioStencilShape.cs:145

Gets native connection points discovered from a source package master, when available.

public Boolean IsSupported { get; } #

VisioStencilShape.cs:151

Gets whether OfficeIMO has a typed master implementation for this shape. Unsupported package masters may still be cataloged explicitly as generic placeholders.

public String? SourceLicense { get; } #

VisioStencilShape.cs:157

Gets the caller-supplied source package license identifier or notice. OfficeIMO does not infer or grant rights to third-party stencil content.

public String? SourceAttribution { get; } #

VisioStencilShape.cs:160

Gets the caller-supplied source attribution.

public IReadOnlyList<String> Keywords { get; } #

VisioStencilShape.cs:165

Gets searchable keywords.

public IReadOnlyList<String> Aliases { get; } #

VisioStencilShape.cs:170

Gets alternate lookup names.