API Reference
VisioStencilPreviewImageData
Embedded preview/icon image payload extracted from a package-backed stencil master.
Inheritance
- Object
- VisioStencilPreviewImageData
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
Constructors
public VisioStencilPreviewImageData(String masterId, String masterNameU, String masterName, VisioStencilPreviewImage previewImage, Byte[] data) #Initializes extracted preview image payload data.
Parameters
- masterId System.String
- masterNameU System.String
- masterName System.String
- previewImage OfficeIMO.Visio.Stencils.VisioStencilPreviewImage
- data System.Byte[]
Methods
public Task SaveAsync(Stream stream, CancellationToken cancellationToken = null) #TaskSaves the preview payload to a file asynchronously.
Parameters
- path System.String
- cancellationToken System.Threading.CancellationToken = null
SaveAsync(System.IO.Stream stream, System.Threading.CancellationToken cancellationToken) #Saves the preview payload to a caller-owned stream asynchronously.
Parameters
- stream System.IO.Stream
- cancellationToken System.Threading.CancellationToken
public String SaveToDirectory(String directoryPath) #StringSaves the preview payload to a directory using SuggestedFileName.
Parameters
- directoryPath System.String
public async Task<String> SaveToDirectoryAsync(String directoryPath, CancellationToken cancellationToken = null) #Task<String>Saves the preview payload to a directory using SuggestedFileName asynchronously.
Parameters
- directoryPath System.String
- cancellationToken System.Threading.CancellationToken = null
public MemoryStream ToStream() #MemoryStreamReturns the embedded preview image in a new stream positioned at the beginning.
Inherited Methods
public override Boolean Equals(Object obj) #BooleanParameters
- obj Object
Properties
public String MasterId { get; } #Source master identifier.
public String MasterNameU { get; } #Source master universal name.
public String MasterName { get; } #Source master display name, when present.
public VisioStencilPreviewImage PreviewImage { get; } #Preview image metadata associated with the extracted payload.
public Int32 ByteLength { get; } #Embedded preview image byte length.
public String SuggestedFileName { get; } #Stable file name suitable for saving the extracted preview payload.