DicomObjects.NET.8.48 Documentation
DicomObjects Namespace / DicomImage Class / PrinterImage Method / PrinterImage(Int32,Int32,Boolean,Single,Rectangle,Boolean,Int32) Method

Bit depth of final image (must be 8-16, but always 8 when Planes=3)

1 for monochrome and 3 for colour

Controls whether annotations are "burnt-in" to the new image

Zoom to apply to new image

The area of the original image to use

Controls whether Image Aspect Ratio is used - if true, then output pixels are square, but if false, then they retain their original aspect ratio

If ShowAnnotations is true, then this parameter is ignored and treated as true.

The frame number to use. This is 1-index, i.e. first frame is 1 not 0







In This Topic
    PrinterImage(Int32,Int32,Boolean,Single,Rectangle,Boolean,Int32) Method
    In This Topic
    Creates a copy of the image for printing or other purposes
    Syntax
    'Declaration
     
    
    Public Overloads Function PrinterImage( _
       ByVal Bits As System.Integer, _
       ByVal Planes As System.Integer, _
       ByVal ShowAnnotations As System.Boolean, _
       ByVal Zoom As System.Single, _
       ByVal Area As System.Drawing.Rectangle, _
       ByVal SquarePixels As System.Boolean, _
       ByVal Frame As System.Integer _
    ) As DicomImage
    'Usage
     
    
    Dim instance As DicomImage
    Dim Bits As System.Integer
    Dim Planes As System.Integer
    Dim ShowAnnotations As System.Boolean
    Dim Zoom As System.Single
    Dim Area As System.Drawing.Rectangle
    Dim SquarePixels As System.Boolean
    Dim Frame As System.Integer
    Dim value As DicomImage
     
    value = instance.PrinterImage(Bits, Planes, ShowAnnotations, Zoom, Area, SquarePixels, Frame)
    public DicomImage PrinterImage( 
       System.int Bits,
       System.int Planes,
       System.bool ShowAnnotations,
       System.float Zoom,
       System.Drawing.Rectangle Area,
       System.bool SquarePixels,
       System.int Frame
    )
    public function PrinterImage( 
        Bits: System.Integer;
        Planes: System.Integer;
        ShowAnnotations: System.Boolean;
        Zoom: System.Single;
        Area: System.Drawing.Rectangle;
        SquarePixels: System.Boolean;
        Frame: System.Integer
    ): DicomImage; 
    public function PrinterImage( 
       Bits : System.int,
       Planes : System.int,
       ShowAnnotations : System.boolean,
       Zoom : System.float,
       Area : System.Drawing.Rectangle,
       SquarePixels : System.boolean,
       Frame : System.int
    ) : DicomImage;
    public: DicomImage* PrinterImage( 
       System.int Bits,
       System.int Planes,
       System.bool ShowAnnotations,
       System.float Zoom,
       System.Drawing.Rectangle Area,
       System.bool SquarePixels,
       System.int Frame
    ) 
    public:
    DicomImage^ PrinterImage( 
       System.int Bits,
       System.int Planes,
       System.bool ShowAnnotations,
       System.float Zoom,
       System.Drawing.Rectangle Area,
       System.bool SquarePixels,
       System.int Frame
    ) 

    Parameters

    Bits

    Bit depth of final image (must be 8-16, but always 8 when Planes=3)

    Planes

    1 for monochrome and 3 for colour

    ShowAnnotations

    Controls whether annotations are "burnt-in" to the new image

    Zoom

    Zoom to apply to new image

    Area

    The area of the original image to use

    SquarePixels

    Controls whether Image Aspect Ratio is used - if true, then output pixels are square, but if false, then they retain their original aspect ratio

    If ShowAnnotations is true, then this parameter is ignored and treated as true.

    Frame

    The frame number to use. This is 1-index, i.e. first frame is 1 not 0

    Return Value

    Remarks
    The copy is fully rendered and scaled to the chosen bit depth, so no further windowing is required. Only 8 bits are allowed when Planes=3 (RGB). Area refers to the original image � the size of the final image is the product of the cropped size and the chosen zoom. If the edges are given as 0, the full image is used.
    Requirements

    Target Platforms: .NET CLR 4.8 or higher

    See Also