DocumentImage.fromFile Method¶
Module: DocumentImage
Definition¶
Creates an Image from the specified file.
@staticmethod
from_file(filepath: str, pixel_format: PixelFormat) -> DocumentImage
Parameters
filepathstrin A string that contains the name of the file from which to create the Image.pixel_formatPixelFormatin The pixel format into which to convert the input image.
Returns
The newly created document image.
Exceptions
An error has occurred during Document Library execution.
static DocumentImage fromFile(String? filepath, PixelFormat pixelFormat)
Parameters
filepathStringin A string that contains the name of the file from which to create the Image.pixelFormatPixelFormatin The pixel format into which to convert the input image.
Returns
The newly created document image.
Exceptions
An error has occurred during Document Library execution.
public static DocumentImage FromFile(string filepath, PixelFormat pixelFormat)
Parameters
filepathstringin A string that contains the name of the file from which to create the Image.pixelFormatPixelFormatin The pixel format into which to convert the input image.
Returns
The newly created document image.
Exceptions
An error has occurred during Document Library execution.
public static DocumentImage fromFile(String filepath, PixelFormat pixelFormat) throws DocumentException
Parameters
filepathStringin A string that contains the name of the file from which to create the Image.pixelFormatPixelFormatin The pixel format into which to convert the input image.
Returns
The newly created document image.
Exceptions
An error has occurred during Document Library execution.
public static func fromFile(filepath: String, pixelFormat: PixelFormat) throws -> DocumentImage
Parameters
filepathStringin A string that contains the name of the file from which to create the Image.pixelFormatPixelFormatin The pixel format into which to convert the input image.
Returns
The newly created document image.
Exceptions
An error has occurred during Document Library execution.
int id3DocumentImage_FromFile (
ID3_DOCUMENT_IMAGE hDocumentImage,
const char * filepath,
id3DocumentPixelFormat ePixelFormat)
Parameters
hDocumentImageID3_DOCUMENT_IMAGEin Handle to the DocumentImage object.filepathconst char *in A string that contains the name of the file from which to create the Image.ePixelFormatid3DocumentPixelFormatin The pixel format into which to convert the input image.
Returns