API Reference

Class

VisioStencilShape

Namespace OfficeIMO.Visio.Stencils
Assembly OfficeIMO.Visio
Modifiers sealed

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

Inheritance

  • Object
  • VisioStencilShape

Usage

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

Accepted by parameters

Constructors

VisioStencilShape 3 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) #

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, Nullable<VisioMeasurementUnit> defaultUnit) #

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 System.Nullable{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, Nullable<VisioMeasurementUnit> defaultUnit, String sourcePackagePath) #

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 System.Nullable{OfficeIMO.Visio.VisioMeasurementUnit} requiredposition: 10
sourcePackagePath System.String requiredposition: 11

Properties

public String Id { get; } #

Gets a stable OfficeIMO stencil identifier.

public String Name { get; } #

Gets the display name.

public String MasterNameU { get; } #

Gets the generated master universal name used by OfficeIMO.

public String Category { get; } #

Gets the category name.

public Double DefaultWidth { get; } #

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

public Double DefaultHeight { get; } #

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

public Nullable<VisioMeasurementUnit> DefaultUnit { get; } #

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; } #

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

public IReadOnlyList<String> Keywords { get; } #

Gets searchable keywords.

public IReadOnlyList<String> Aliases { get; } #

Gets alternate lookup names.

public IReadOnlyList<String> Tags { get; } #

Gets semantic tags used by stencil catalog search.

public String IconNameU { get; } #

Gets the generated master universal name that can be used as this stencil shape's preview icon.