OfficeRasterDecodeInfo
OfficeIMO.Drawing
Typed evidence describing one shared raster decode decision.
Inheritance
- object
- OfficeRasterDecodeInfo
Usage
Explore 6 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 1
Accepted by parameters 5
Inherited Methods
Properties
public string? DiagnosticCode { get; } #Stable diagnostic code for an unavailable system codec, otherwise null.
public OfficeImageFormat Format { get; } #Detected source format, or OfficeImageFormat.Unknown.
public int FrameCount { get; } #Known frame count. Static formats report one; zero means the count could not be established.
public int SelectedFrameIndex { get; } #Requested zero-based frame index.
public bool Succeeded { get; } #True when the requested selected frame or complete sequence was decoded.
public OfficeRasterDecodeFailure Failure { get; internal set; } #Typed reason for failure; cancellation and invalid caller options still throw.
public bool DecodedAllFrames { get; internal set; } #True when every source frame or page was retained by the operation.
public bool OrientationNormalized { get; internal set; } #True when decoding normalized a non-default EXIF orientation in at least one retained unit.
public OfficeImageOrientation SourceOrientation { get; internal set; } #Stored orientation of the selected source unit, or Normal when absent.
public bool IsAnimated { get; } #True when the inspected source contains timed animation frames.
public bool HasMultipleFramesOrPages { get; } #True when the inspected source contains more than one frame or page.
public bool FramesOrPagesDiscarded { get; } #True when the static result intentionally retained only the selected frame or page.
public bool PagesDiscarded { get; } #True when a multi-page source was reduced to the selected page.
public bool AnimationDiscarded { get; } #True when a static result intentionally represents only one frame of an animated source.
public string? Diagnostic { get; } #Stable human-readable reason when decoding did not complete or discarded animation.
public OfficeRasterContainerInfo? Container { get; } #Format-neutral frame/page inventory when the container could be inspected safely.
public OfficeRasterFrameInfo? SelectedFrame { get; } #Selected frame or page descriptor when available.