GetSinglePageFilename(String,VintasoftImage) Method (DocumentConverter)

In This Topic

Returns filename of single-page file.

Syntax

Visual Basic
C#
Managed Extensions for C++
C++/CLI

'Declaration

Protected Overridable Function GetSinglePageFilename( _
   ByVal filenameThe filename.
 
 The filename can contains the predefined format variables:
  {PageNumber} - page number in source image file
 {PageIndex} - zero-based page index in source image file
 {ImageNumber} - image number in image collection
 {ImageIndex} - zero-based image index in image collection
 {DecoderName} - decoder name
 {ImageWidthPx} - source image width, in pixels
 {ImageHeightPx} - source image height, in pixels
 {ImageSizeMpx} - source image size, in megapixels
 {ImageHRes} - source image horizontal resolution, in DPI
 {ImageVRes} - source image vertical resolution, in DPI
 {ImageBitsPerPixel} - source image bits per pixel
 {PageLabel} - PageLabel
 
 Examples of filename format:
  image-{PageNumber}.png
 image-{PageNumber}_{ImageBitsPerPixel}bpp.tif
 
 As System.String, _
   ByVal imageThe image that must be encoded to the file.
 As VintasoftImage _
) As System.String

protected virtual System.String GetSinglePageFilename(
   System.String filename, 
   VintasoftImage image
)

protected: virtual System.String GetSinglePageFilename(
   System.String filename, 
   VintasoftImage* image
)

protected:
virtual System.String GetSinglePageFilename(
   System.String filename, 
   VintasoftImage^ image
)

Parameters

filename

The filename.

The filename can contains the predefined format variables:

{PageNumber} - page number in source image file
{PageIndex} - zero-based page index in source image file
{ImageNumber} - image number in image collection
{ImageIndex} - zero-based image index in image collection
{DecoderName} - decoder name
{ImageWidthPx} - source image width, in pixels
{ImageHeightPx} - source image height, in pixels
{ImageSizeMpx} - source image size, in megapixels
{ImageHRes} - source image horizontal resolution, in DPI
{ImageVRes} - source image vertical resolution, in DPI
{ImageBitsPerPixel} - source image bits per pixel
{PageLabel} - PageLabel

Examples of filename format:

image-{PageNumber}.png
image-{PageNumber}_{ImageBitsPerPixel}bpp.tif

image

The image that must be encoded to the file.

Return Value

The filename of singlepage file.

Requirements

Target Platforms: .NET9; .NET 8; .NET 7; .NET 6; .NET Framework 4.8, 4.7, 4.6, 4.5, 4.0, 3.5

Reference

DocumentConverter Class
DocumentConverter Members

Send Feedback