Document Solutions for PDF
DS.Documents.Pdf Assembly / GrapeCity.Documents.Pdf.Graphics.Images Namespace / PdfImage Class
Properties Methods

In This Topic
    PdfImage Class Members
    In This Topic

    The following tables list the members exposed by PdfImage.

    Public Properties
     NameDescription
    Public PropertyAssociatedFilesGets the list of embedded files associated with this PdfImageObjectBase. (Inherited from GrapeCity.Documents.Pdf.Graphics.Images.PdfImageObjectBase)
    Public PropertyBitsPerComponentGets the number of bits used to represent each color component in a sample. Valid values are 1, 2, 4, 8, and (in PDF 1.5) 16.  
    Public PropertyBitsPerPixelOverridden. Gets the number of bits-per-pixel (BPP) for this image.  
    Public PropertyDocOverridden. Gets the GrapeCity.Documents.Pdf.GcPdfDocument owning this object.  
    Public PropertyHeightOverridden. Gets the height of the image in pixels.  
    Public PropertyHorizontalResolutionOverridden. Gets the horizontal resolution of the image. If this property returns a value that is less or equal than 0, then the horizontal resolution is not specified for an image.  
    Public PropertyImageMaskOverridden. Gets a value indicating whether the image is defined as a stencil mask for painting in the current color.  
    Public PropertyInlineImageGets a value indicating whether the image is an inline image defined directly in a PDF content stream. (Inherited from GrapeCity.Documents.Pdf.Graphics.Images.PdfImageBase)
    Public PropertyObjIDGets the PDF object ID. (Inherited from GrapeCity.Documents.Pdf.Wrappers.PdfWrapperBase)
    Public PropertyPdfDictGets the underlying GrapeCity.Documents.Pdf.Spec.IPdfDict. (Inherited from GrapeCity.Documents.Pdf.Wrappers.PdfDictWrapper)
    Public PropertyPdfObjectGets the underlying GrapeCity.Documents.Pdf.Spec.IPdfObject. (Inherited from GrapeCity.Documents.Pdf.Wrappers.PdfWrapper<IPdfDict>)
    Public PropertyVerticalResolutionOverridden. Gets the vertical resolution of the image. If this property returns a value that is less or equal than 0, then the vertical resolution is not specified for an image.  
    Public PropertyWidthOverridden. Gets the width of the image in pixels.  
    Top
    Public Methods
     NameDescription
    Public MethodGetCacheKeyFor internal use. Returns a key uniquely identifying the object in its GrapeCity.Documents.Pdf.GcPdfDocument, can return null if object can not be uniquely identified. (Inherited from GrapeCity.Documents.Pdf.Graphics.Images.PdfImageBase)
    Public MethodGetImageStreamInfoOverridden. Returns the GrapeCity.Documents.Pdf.Spec.PdfStreamObject containing unparsed image data and information about the PDF filter and decode parameters.

    Note that not all derived classes support this method (for example, PdfImageHandler).

     
    Public MethodGetNativeImageCreates and returns a GrapeCity.Documents.Imaging.GcBitmap object representing the current PdfImageBase object.

    IMPORTANT NOTE: the returned bitmap must be disposed after use.

    An image in a PDF can be specified as an "image mask" (see PdfImageBase.ImageMask), in which case the image data is used as a stencil mask for painting in the current color specified by currentUnmaskedColor, maskedColor specifies the color of the area excluded from filling (it is transparent in most cases).

    (Inherited from GrapeCity.Documents.Pdf.Graphics.Images.PdfImageBase)
    Public MethodGetPdfStreamGets the System.IO.Stream object containing the data of GrapeCity.Documents.Pdf.Spec.PdfStreamObjectBase owned by this wrapper. Note! The stream should be disposed after usage. (Inherited from GrapeCity.Documents.Pdf.Wrappers.PdfWrapperBase)
    Public MethodGetPdfStreamDataGets the data of GrapeCity.Documents.Pdf.Spec.PdfStreamObjectBase owned by this wrapper. (Inherited from GrapeCity.Documents.Pdf.Wrappers.PdfWrapperBase)
    Public MethodGetPdfStreamInfoGets the GrapeCity.Documents.Pdf.Spec.PdfStreamInfo object containing the data of GrapeCity.Documents.Pdf.Spec.PdfStreamObjectBase owned by this wrapper. Note! The stream should be disposed after usage. (Inherited from GrapeCity.Documents.Pdf.Wrappers.PdfWrapperBase)
    Public MethodGetSoftMaskReturns the PdfImage object defining a soft-mask image, see the PDF specification for details.  
    Public MethodToGcBitmapRetrieves the underlying GrapeCity.Documents.Imaging.GcBitmap object, or creates a new GrapeCity.Documents.Imaging.GcBitmap that contains the image data.

    Note that you should dispose the returned GrapeCity.Documents.Imaging.GcBitmap if disposeAfterUse is true.

    (Inherited from GrapeCity.Documents.Pdf.Graphics.Images.PdfImageBase)
    Top
    See Also

    Reference

    PdfImage Class
    GrapeCity.Documents.Pdf.Graphics.Images Namespace