API Reference

Class

VisioStencilCatalog

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

Named collection of OfficeIMO-native stencil shape definitions.

Inheritance

  • Object
  • VisioStencilCatalog

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

public VisioStencilCatalog(String name, IEnumerable<VisioStencilShape> shapes) #

Initializes a new stencil catalog.

Parameters

name System.String requiredposition: 0
shapes System.Collections.Generic.IEnumerable{OfficeIMO.Visio.Stencils.VisioStencilShape} requiredposition: 1

Methods

public static VisioStencilCatalog Create(String name, Action<VisioStencilCatalogBuilder> configure) #
Returns: VisioStencilCatalog

Creates a stencil catalog using the fluent catalog builder.

Parameters

name System.String requiredposition: 0
configure System.Action{OfficeIMO.Visio.Stencils.VisioStencilCatalogBuilder} requiredposition: 1
public VisioStencilShape FindBest(params String[] queries) #
Returns: VisioStencilShape

Finds the first matching stencil shape from a prioritized set of lookup or search queries. Exact id/name/master/keyword/alias/tag matches are preferred before search matches for each query.

Parameters

queries System.String[] requiredposition: 0
Prioritized lookup or search queries.
public VisioStencilShape Get(String idOrName) #
Returns: VisioStencilShape

Gets a stencil shape by id, name, master name, keyword, alias, or tag.

Parameters

idOrName System.String requiredposition: 0
public IReadOnlyList<VisioStencilShape> InCategory(String category) #
Returns: IReadOnlyList<VisioStencilShape>

Gets shapes in a category.

Parameters

category System.String requiredposition: 0
Category name.
Load 2 overloads
public static VisioStencilCatalog Load(Stream stream) #
Returns: VisioStencilCatalog

Loads an OfficeIMO-native stencil catalog manifest.

Parameters

path System.String requiredposition: 0
Load(System.IO.Stream stream) #

Loads an OfficeIMO-native stencil catalog manifest.

Parameters

stream System.IO.Stream required
Save 2 overloads
public Void Save(Stream stream) #
Returns: Void

Saves this catalog as an OfficeIMO-native stencil catalog manifest.

Parameters

path System.String requiredposition: 0
Save(System.IO.Stream stream) #

Saves this catalog as an OfficeIMO-native stencil catalog manifest.

Parameters

stream System.IO.Stream required
public IReadOnlyList<VisioStencilShape> Search(String query) #
Returns: IReadOnlyList<VisioStencilShape>

Searches stencil shapes by id, name, master name, category, keyword, alias, or tag.

Parameters

query System.String requiredposition: 0
Search text.
public Boolean TryFindBest(IEnumerable<String> queries, out VisioStencilShape shape) #
Returns: Boolean

Attempts to find the first matching stencil shape from a prioritized set of lookup or search queries. Exact id/name/master/keyword/alias/tag matches are preferred before search matches for each query.

Parameters

queries System.Collections.Generic.IEnumerable{System.String} requiredposition: 0
Prioritized lookup or search queries.
shape OfficeIMO.Visio.Stencils.VisioStencilShape@ requiredposition: 1
The matched stencil shape, when one is found.
public Boolean TryGet(String idOrName, out VisioStencilShape shape) #
Returns: Boolean

Attempts to find a stencil shape by id, name, master name, keyword, alias, or tag.

Parameters

idOrName System.String requiredposition: 0
shape OfficeIMO.Visio.Stencils.VisioStencilShape@ requiredposition: 1

Properties

public String Name { get; } #

Gets the catalog name.

public IReadOnlyList<VisioStencilShape> Shapes { get; } #

Gets shapes in this catalog.

public IReadOnlyList<String> Categories { get; } #

Gets category names represented by this catalog.