OfficeDecoderRead Method (Stream, Int32, ProgressEventHandler) |
Read a given frame in an encoded image using this decoder.
Namespace:
Atalasoft.Imaging.Codec.Office
Assembly:
Atalasoft.dotImage.Office (in Atalasoft.dotImage.Office.dll) Version: 11.4.0.9.0.377 (.NET 4.5.2, x86)
Syntax public override AtalaImage Read(
Stream stream,
int frameIndex,
ProgressEventHandler progress
)
Public Overrides Function Read (
stream As Stream,
frameIndex As Integer,
progress As ProgressEventHandler
) As AtalaImage
Parameters
- stream
- Type: System.IOStream
The input Stream. - frameIndex
- Type: SystemInt32
The zero based frame index. - progress
- Type: Atalasoft.ImagingProgressEventHandler
The progress delegate. Can be set to null (Nothing in
Visual Basic).
Return Value
Type:
AtalaImage An
AtalaImage containing the decoded image.
Exceptions Exception | Condition |
---|
ArgumentException | stream is null. |
ArgumentOutOfRangeException | frameIndex is not in range [0, frameCount] (See GetFrameCount(Stream) for details.). |
OfficeDecoderException | error decoding MS Office document. incorrect file format. |
See Also