PdfImage Class
A rectangular array of sample values, each representing a color.
public sealed class PdfImage : PdfExternalObject
Public NotInheritable Class PdfImage
Inherits PdfExternalObject
- Inheritance:
- PdfImage
Properties
BitsPerComponent
(Required except for image masks and images that use the JPXDecode filter) The number of bits used to represent each colour component.
Only a single value shall be specified; the number of bits shall be the same for all colour components. The value shall be 1, 2, 4, 8, or (in PDF 1.5) 16.
If ImageMask is true, this entry is optional, but if specified, its value shall be 1.
Property Value
ColorSpace
(Required for images, except those that use the JPXDecode filter; not permitted for image masks) The colour space in which image samples shall be specified; it can be any type of colour space except Pattern.
public PdfColorSpace ColorSpace { get; }
Public ReadOnly Property ColorSpace As PdfColorSpace
Property Value
The colour space in which image samples shall be specified.
ExplicitMask
(Optional; shall not be present for image masks; PDF 1.3) An image XObject defining an image mask to be applied to this image (see 8.9.6.3,"Explicit masking"), or an array specifying a range of colours to be applied to it as a colour key mask (see 8.9.6.4, "Colour key masking").
If ImageMask is true, this entry shall not be present.
Property Value
An image XObject defining an image mask to be applied to this image.
Height
(Required) The height of the image, in samples.
Property Value
The height of the image, in samples.
ImageMask
(Optional) A flag indicating whether the image shall be treated as an image mask (see 8.9.6, "Masked Images").
If this flag is true, the value of BitsPerComponent shall be 1 and Mask and ColorSpace shall not be specified; unmasked areas shall be painted using the current nonstroking color.
Default value: false.
Property Value
A flag indicating whether the image shall be treated as an image mask.
Size
Gets or sets the size of the PdfImage.
Property Value
SoftMask
(Optional; PDF 1.4) A subsidiary image XObject defining a soft-mask image (see 11.6.5.2, "Soft-mask images") that shall be used as a source of mask shape or mask opacity values in the transparent imaging model. The alpha source parameter in the graphics state determines whether the mask values shall be interpreted as shape or opacity.
If present, this entry shall override the current soft mask in the graphics state, as well as the image’s Mask entry, if any.
Property Value
A subsidiary image XObject defining a soft-mask image.
Width
(Required) The width of the image, in samples.
Property Value
The width of the image, in samples.
Methods
Clone()
Clones this PdfImage.
Returns
Remarks
This method doesn't do a deep clone of the underlying indirect objects and is intended to be used only to edit inline Image as explained in the documentation of the Image property.
Load(Stream)
public static PdfImage Load(Stream stream)
Public Shared Function Load(stream As Stream) As PdfImage
Parameters
Returns
Load(Stream, ImageLoadOptions)
Loads a PdfImage from the specified stream and with the specified options.
public static PdfImage Load(Stream stream, ImageLoadOptions options)
Public Shared Function Load(stream As Stream, options As ImageLoadOptions) As PdfImage
Parameters
options
- ImageLoadOptions
The options used for loading a PdfImage from the specified stream.
Returns
Load(String)
public static PdfImage Load(string path)
Public Shared Function Load(path As String) As PdfImage
Parameters
Returns
Load(String, ImageLoadOptions)
Loads a PdfImage from a file with the specified path and with the specified options.
public static PdfImage Load(string path, ImageLoadOptions options)
Public Shared Function Load(path As String, options As ImageLoadOptions) As PdfImage
Parameters
options
- ImageLoadOptions
The options used for loading a PdfImage from a file.
Returns
Inherited Properties
AssociatedFiles | (Optional; PDF 2.0) An array of one or more PdfFileSpecifications which denote the associated files for this PdfImage or PdfForm. (Inherited from PdfExternalObject) |
Document | Gets the PdfDocument associated with this PdfContentResource or null if no PdfDocument is associated with this PdfContentResource. (Inherited from PdfContentResource) |
Metadata | (Optional; PDF 1.4) A metadata stream containing metadata for the component. (Inherited from PdfObject) |