Class

VisioStencilPreviewImageData

OfficeIMO.Visio.Stencils

Edit on GitHub

Namespace: OfficeIMO.Visio.Stencils
Assembly: OfficeIMO.Visio
Source revision: e163ccb36643 with working tree changes
Source: VisioStencilPreviewImageData.cs:18
Modifiers: sealed

Embedded preview/icon image payload extracted from a package-backed stencil master.

Inheritance

object
VisioStencilPreviewImageData

Usage

Explore 2 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 2

Method VisioStencilPackageCatalog.ExtractPreviewImages
Property VisioStencilPreviewGalleryEntry.Image

Constructors

public VisioStencilPreviewImageData(string masterId, string masterNameU, string? masterName, VisioStencilPreviewImage previewImage, byte[] data)

VisioStencilPreviewImageData.cs:18

Initializes extracted preview image payload data.

Parameters

masterId string required
masterNameU string required
masterName string? required
previewImage OfficeIMO.Visio.Stencils.VisioStencilPreviewImage required
data byte[] required

Methods

Save 2 overloads

public void Save(string path) #

VisioStencilPreviewImageData.cs:67

Saves the preview payload to a file.

Parameters

path string required

public void Save(Stream stream) #

VisioStencilPreviewImageData.cs:72

Saves the preview payload to a caller-owned stream.

Parameters

stream System.IO.Stream required

SaveAsync 2 overloads

public Task SaveAsync(string path, CancellationToken cancellationToken = default) #

VisioStencilPreviewImageData.cs:76

Saves the preview payload to a file asynchronously.

Parameters

path string required
cancellationToken System.Threading.CancellationToken = default optional

Returns

Task

public Task SaveAsync(Stream stream, CancellationToken cancellationToken = default) #

VisioStencilPreviewImageData.cs:82

Saves the preview payload to a caller-owned stream asynchronously.

Parameters

stream System.IO.Stream required
cancellationToken System.Threading.CancellationToken = default optional

Returns

Task

public string SaveToDirectory(string directoryPath) #

VisioStencilPreviewImageData.cs:88

Saves the preview payload to a directory using VisioStencilPreviewImageData.SuggestedFileName.

Parameters

directoryPath string required

Returns

string

public async Task<string> SaveToDirectoryAsync(string directoryPath, CancellationToken cancellationToken = default) #

Saves the preview payload to a directory using VisioStencilPreviewImageData.SuggestedFileName asynchronously.

Parameters

directoryPath string required
cancellationToken System.Threading.CancellationToken = default optional

Returns

Task<string>

public byte[] ToBytes() #

VisioStencilPreviewImageData.cs:48

Returns a copy of the embedded preview image bytes.

Returns

byte[]

public MemoryStream ToStream() #

VisioStencilPreviewImageData.cs:51

Returns the embedded preview image in a new stream positioned at the beginning.

Returns

MemoryStream

Inherited Methods

Properties

public string MasterId { get; } #

VisioStencilPreviewImageData.cs:33

Source master identifier.

public string MasterNameU { get; } #

VisioStencilPreviewImageData.cs:36

Source master universal name.

public string? MasterName { get; } #

VisioStencilPreviewImageData.cs:39

Source master display name, when present.

public VisioStencilPreviewImage PreviewImage { get; } #

VisioStencilPreviewImageData.cs:42

Preview image metadata associated with the extracted payload.

public int ByteLength { get; } #

VisioStencilPreviewImageData.cs:45

Embedded preview image byte length.

public string SuggestedFileName { get; } #

VisioStencilPreviewImageData.cs:56

Stable file name suitable for saving the extracted preview payload.