DisplayDepth Property

Gets or sets the resulting raster image pixel depth.

Syntax

public int DisplayDepth {get; set;}

'Declaration
 
Public Property DisplayDepth As Integer

'Usage
 
Dim instance As CodecsPdfLoadOptions
Dim value As Integer
 
instance.DisplayDepth = value
 
value = instance.DisplayDepth

public int DisplayDepth {get; set;}

@property (nonatomic, assign) int displayDepth;

public int getDisplayDepth()
public void setDisplayDepth(int value)

 
get_DisplayDepth();
set_DisplayDepth(value);
Object.defineProperty('DisplayDepth');

public:
property int DisplayDepth {
   int get();
   void set (    int value);
}

The resulting raster image pixel depth, valid values are 0, 1, 4, 8, or 24. The default value is 0 for auto-detect.

Remarks

Possible values are:

Value	Description
0	Auto-detect. The resulting image will have the same bits per pixel as the requested page in the source PDF file. Internally, the toolkit will use the bits per pixel value of the first image item found on the page. If the page does not have any image items, the result will be 24 bits per pixel. Use this value only when the source file is a raster PDF.
1	1 bit per pixel in the resulting image.
4	4 bit per pixel in the resulting image.
8	8 bit per pixel in the resulting image.
24	24 bit per pixel in the resulting image.

Refer to CodecsRasterPdfInfo for information on how to use RasterCodecs.GetRasterPdfInfo to obtain this value from a PDF file saved with RasterCodecs.

This option affect pdf format when UsePdfEngine is set to true to use Leadtools.PdfEngine.dll, it still affects Postscript format.

Example

For an example, refer to CodecsPdfOptions.

Requirements