API Reference
PdfExtractedImage
Represents an image XObject extracted from a parsed PDF page.
Inheritance
- Object
- PdfExtractedImage
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 5
- Method PdfDocumentImageEditor.Extract
- Method PdfDocumentImageEditor.ExtractResult
- Property PdfLogicalImage.SourceImage
- Method PdfReadDocument.ExtractImages
- Method PdfReadPage.GetImages
Accepted by parameters 1
- Method PdfDocumentImageEditor.Visit
Methods
public Void CopyTo(Stream destination, CancellationToken cancellationToken = default) #VoidCopies extracted image bytes without creating another in-memory payload.
Parameters
- destination System.IO.Stream
- cancellationToken System.Threading.CancellationToken = default
Inherited Methods
public virtual Boolean Equals(Object? obj) #BooleanParameters
- obj Object?
Properties
public Int32 PageNumber { get; } #One-based page number containing the image resource.
public String ResourceName { get; } #Image resource name from the page XObject dictionary.
public Int32 ObjectNumber { get; } #PDF object number for the image stream, or 0 when the image is direct.
public Boolean Interpolate { get; } #Whether the PDF requests interpolation while scaling the image.
public Byte[] Bytes { get; } #Extracted bytes. JPEG images are returned as JPEG files. Simple PNG-predictor Flate images, supported ImageMask stencil streams, color-key masked simple and Indexed streams, Decode-aware simple 8-bit DeviceGray/DeviceRGB/basic-converted DeviceCMYK streams, basic ICCBased N=1/3/4 streams, and Decode-aware Indexed palette streams are returned as PNG files when their filters are supported. JPEG images with PDF transparency masks can expose unresolved mask metadata when the JPEG payload is passed through without alpha conversion. Other supported image streams return their original encoded bytes.
public String? FileExtension { get; } #Suggested file extension, such as jpg or png, when the bytes are a complete image file.
public String? MimeType { get; } #Suggested MIME type when the bytes are a complete image file.
public Boolean IsImageFile { get; } #True when PdfExtractedImage.Bytes is a complete image file rather than a raw PDF image stream.
public String? TransparencyMaskKind { get; } #PDF transparency mask kind attached to the image, such as soft-mask, color-key-mask, or explicit-mask-image.
public Boolean TransparencyMaskResolved { get; } #True when the extracted image payload includes the PDF transparency mask semantics.
public Boolean HasTransparencyMask { get; } #True when the source PDF image declared a transparency mask.
public Boolean HasUnresolvedTransparencyMask { get; } #True when the source PDF image declared a transparency mask that is not represented by the extracted payload.
public Boolean IsImageMask { get; } #True when this image came from a PDF /ImageMask stencil XObject.
public OfficeColor ImageMaskColor { get; } #Paint color applied to a stencil image mask.
public OfficeIccRenderingIntent RenderingIntent { get; } #Effective ICC rendering intent used while normalizing extracted samples.
public Boolean HasAuthoredRenderingIntent { get; } #True when the source image or active graphics state explicitly selected a rendering intent.
public Boolean HasExplicitDecode { get; } #True when the image declared a Decode array.
public Boolean HasDecodeParameters { get; } #True when the image filter declared DecodeParms.