Get Started

API Reference

Class

VisioStencilCatalog

Edit on GitHub
Namespace OfficeIMO.Visio.Stencils
Assembly OfficeIMO.Visio
Source OfficeIMO.Visio/Stencils/VisioStencilCatalog.cs:13
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.

Returned or exposed by

Accepted by parameters

Constructors

public VisioStencilCatalog(String name, IEnumerable<VisioStencilShape> shapes) #
OfficeIMO.Visio/Stencils/VisioStencilCatalog.cs:13

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) #
OfficeIMO.Visio/Stencils/VisioStencilCatalog.cs:53
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) #
OfficeIMO.Visio/Stencils/VisioStencilCatalog.cs:198
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) #
OfficeIMO.Visio/Stencils/VisioStencilCatalog.cs:161
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) #
OfficeIMO.Visio/Stencils/VisioStencilCatalog.cs:233
Returns: IReadOnlyList<VisioStencilShape>

Gets shapes in a category.

Parameters

category System.String requiredposition: 0
Category name.
Load 4 overloads
public static VisioStencilCatalog Load(Stream stream) #
OfficeIMO.Visio/Stencils/VisioStencilCatalog.cs:78
Returns: VisioStencilCatalog

Loads an OfficeIMO-native stencil catalog manifest.

Parameters

path System.String requiredposition: 0
public static VisioStencilCatalog Load(Stream stream, VisioStencilCatalogManifestLoadOptions options) #
OfficeIMO.Visio/Stencils/VisioStencilCatalog.cs:85
Returns: VisioStencilCatalog

Loads an OfficeIMO-native stencil catalog manifest with explicit source-package trust options.

Parameters

path System.String requiredposition: 0
options OfficeIMO.Visio.Stencils.VisioStencilCatalogManifestLoadOptions requiredposition: 1
Load(System.IO.Stream stream) #

Loads an OfficeIMO-native stencil catalog manifest.

Parameters

stream System.IO.Stream required
Load(System.IO.Stream stream, OfficeIMO.Visio.Stencils.VisioStencilCatalogManifestLoadOptions options) #

Loads an OfficeIMO-native stencil catalog manifest with explicit source-package trust options.

Parameters

stream System.IO.Stream required
options OfficeIMO.Visio.Stencils.VisioStencilCatalogManifestLoadOptions required
LoadAsync 2 overloads
public static Task<VisioStencilCatalog> LoadAsync(Stream stream, VisioStencilCatalogManifestLoadOptions options = null, CancellationToken cancellationToken = null) #
OfficeIMO.Visio/Stencils/VisioStencilCatalog.cs:100
Returns: Task<VisioStencilCatalog>

Loads an OfficeIMO-native stencil catalog manifest asynchronously.

Parameters

path System.String requiredposition: 0
options OfficeIMO.Visio.Stencils.VisioStencilCatalogManifestLoadOptions = null optionalposition: 1
cancellationToken System.Threading.CancellationToken = null optionalposition: 2
LoadAsync(System.IO.Stream stream, OfficeIMO.Visio.Stencils.VisioStencilCatalogManifestLoadOptions options, System.Threading.CancellationToken cancellationToken) #

Loads an OfficeIMO-native stencil catalog manifest from a caller-owned stream asynchronously.

Parameters

stream System.IO.Stream required
options OfficeIMO.Visio.Stencils.VisioStencilCatalogManifestLoadOptions required
cancellationToken System.Threading.CancellationToken required
Save 2 overloads
public Void Save(Stream stream) #
OfficeIMO.Visio/Stencils/VisioStencilCatalog.cs:128
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
SaveAsync 2 overloads
public Task SaveAsync(Stream stream, CancellationToken cancellationToken = null) #
OfficeIMO.Visio/Stencils/VisioStencilCatalog.cs:143
Returns: Task

Saves this catalog manifest asynchronously.

Parameters

path System.String requiredposition: 0
cancellationToken System.Threading.CancellationToken = null optionalposition: 1
SaveAsync(System.IO.Stream stream, System.Threading.CancellationToken cancellationToken) #

Saves this catalog manifest to a caller-owned stream asynchronously.

Parameters

stream System.IO.Stream required
cancellationToken System.Threading.CancellationToken required
public IReadOnlyList<VisioStencilShape> Search(String query) #
OfficeIMO.Visio/Stencils/VisioStencilCatalog.cs:212
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 Byte[] ToBytes() #
OfficeIMO.Visio/Stencils/VisioStencilCatalog.cs:132
Returns: Byte[]

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

public MemoryStream ToStream() #
OfficeIMO.Visio/Stencils/VisioStencilCatalog.cs:135
Returns: MemoryStream

Serializes this catalog to a new memory stream positioned at the beginning.

public Boolean TryFindBest(IEnumerable<String> queries, out VisioStencilShape shape) #
OfficeIMO.Visio/Stencils/VisioStencilCatalog.cs:175
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) #
OfficeIMO.Visio/Stencils/VisioStencilCatalog.cs:149
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; } #
OfficeIMO.Visio/Stencils/VisioStencilCatalog.cs:105

Gets the catalog name.

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

Gets shapes in this catalog.

public IReadOnlyList<String> Categories { get; } #
OfficeIMO.Visio/Stencils/VisioStencilCatalog.cs:115

Gets category names represented by this catalog.