Get Started

API Reference

Class

VisioStencilCatalogBuilder

Edit on GitHub
Namespace OfficeIMO.Visio.Stencils
Assembly OfficeIMO.Visio
Source OfficeIMO.Visio/Stencils/VisioStencilCatalogBuilder.cs:10
Modifiers sealed

Fluent builder for OfficeIMO-native stencil catalogs.

Inheritance

  • Object
  • VisioStencilCatalogBuilder

Usage

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

Returned or exposed by

Accepted by parameters

Constructors

public VisioStencilCatalogBuilder(String name) #
OfficeIMO.Visio/Stencils/VisioStencilCatalogBuilder.cs:10

Initializes a new stencil catalog builder.

Parameters

name System.String requiredposition: 0
Catalog name.

Methods

Add 2 overloads
public VisioStencilCatalogBuilder Add(String id, String name, String masterNameU, String category, Double defaultWidth, Double defaultHeight, params String[] keywords) #
OfficeIMO.Visio/Stencils/VisioStencilCatalogBuilder.cs:43
Returns: VisioStencilCatalogBuilder

Adds a stencil shape and derives common aliases and tags from the id, category, master, name, and keywords.

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.String[] requiredposition: 6
public VisioStencilCatalogBuilder Add(VisioStencilShape shape) #
OfficeIMO.Visio/Stencils/VisioStencilCatalogBuilder.cs:104
Returns: VisioStencilCatalogBuilder

Adds an existing stencil shape definition.

Parameters

shape OfficeIMO.Visio.Stencils.VisioStencilShape requiredposition: 0
AddWithMetadata 3 overloads
public VisioStencilCatalogBuilder AddWithMetadata(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) #
OfficeIMO.Visio/Stencils/VisioStencilCatalogBuilder.cs:60
Returns: VisioStencilCatalogBuilder

Adds a stencil shape with explicit search 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} = 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 VisioStencilCatalogBuilder AddWithMetadata(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) #
OfficeIMO.Visio/Stencils/VisioStencilCatalogBuilder.cs:78
Returns: VisioStencilCatalogBuilder

Adds a stencil shape with explicit search metadata and 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 VisioStencilCatalogBuilder AddWithMetadata(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) #
OfficeIMO.Visio/Stencils/VisioStencilCatalogBuilder.cs:97
Returns: VisioStencilCatalogBuilder

Adds a stencil shape with explicit search metadata, default-size unit, and source package path.

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
public VisioStencilCatalog Build() #
OfficeIMO.Visio/Stencils/VisioStencilCatalogBuilder.cs:117
Returns: VisioStencilCatalog

Builds the catalog.

Properties

public String Name { get; } #
OfficeIMO.Visio/Stencils/VisioStencilCatalogBuilder.cs:25

Gets the catalog name.

public IReadOnlyList<VisioStencilShape> Shapes { get; } #
OfficeIMO.Visio/Stencils/VisioStencilCatalogBuilder.cs:30

Gets shapes added to the builder.