Image Class

Apitron PDF Kit help
Apitron.PDF.Kit library for .NET
This class represents an image.
Inheritance Hierarchy

SystemObject
  Apitron.PDF.Kit.FixedLayout.ResourcesResource
    Apitron.PDF.Kit.FixedLayout.Resources.XObjectsImage

Namespace:  Apitron.PDF.Kit.FixedLayout.Resources.XObjects
Assembly:  Apitron.PDF.Kit (in Apitron.PDF.Kit.dll) Version: 2.0.37.0 (2.0.37.0)
Syntax

public sealed class Image : Resource, 
	IDisposable

The Image type exposes the following members.

Constructors

  NameDescription
Public methodCode exampleImage(String, Stream, Int32)
Initializes a new instance of the Image class.
Public methodCode exampleImage(String, String, Int32)
Initializes a new instance of the Image class.
Public methodImage(String, Stream, Boolean, Int32)
Initializes a new instance of the Image class.
Public methodCode exampleImage(String, String, Boolean, Int32)
Initializes a new instance of the Image class.
Top
Properties

  NameDescription
Public propertyCanBeExported
Gets a value indicating whether this instance can be exported.
(Inherited from Resource.)
Public propertyCode exampleHeight
Gets the height.
Public propertyInterpolate
Gets or sets a value indicating whether this Image is interpolate.
Public propertyIsStencilMask
Gets or sets a value indicating whether this instance is stencil mask. The instance should be a monochrome image in which each sample is specified by a single bit. However, instead of being painted in opaque black and white, the image mask is treated as a stencil mask that is partly opaque and partly transparent. Sample values in the image do not represent black and white pixels; rather, they designate places on the page that should either be marked with the current colour or masked out (not marked at all). Areas that are masked out retain their former contents. The effect is like applying paint in the current colour through a cut-out stencil, which lets the paint reach the page in some places and masks it out in others.
Public propertyMaskColorRanges
Gets or sets an array specifying a range of colours to be applied to it as a colour key mask.
Public propertyMaskResourceID
Gets or sets the mask resource ID of an image XObject defining an image mask to be applied to this image. It's also possible to use an array specifying a range of colours to be applied as a colour key mask, see MaskColorRanges. If IsStencilMask is true, this entry shall not be present.
Public propertyResourceType
Gets the resource type.
(Inherited from Resource.)
Public propertySoftMaskResourceID
Gets or sets the soft mask resource ID of the image XObject defining a soft-mask image 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 beinterpreted 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. However, the other transparency-related graphics state parameters—blend mode and alpha constant—shall remain in effect. If Soft Mask is absent, the image shall have no associated soft mask (although the current soft mask in the graphics state may still apply).
Public propertyStructParent
The integer key of the image’s entry in the structural parent tree.
Public propertyUseInvertedDecode
Gets or sets an flag specifying how the source samples shall be interpreted. It is meaningfull for Stencil Masks only. If the flag is not set (the default for an image mask), a sample value of 0 shall mark the page with the current colour, and a 1 shall leave the previous contents unchanged. If the flag is set, these meanings shall be reversed.
Public propertyCode exampleWidth
Gets the width.
Top
See Also

Reference