CFileImageTag
The CFileImageTag class represents an image tag that is associated with a file. It inherits from the CImageTag class and adds additional attributes.
Definition
Namespace: dynamsoft::basic_structures
Assembly: DynamsoftCore
class CFileImageTag : public CImageTag
Methods Summary
| Method | Description |
|---|---|
GetFilePath |
Gets the file path of the image. |
GetPageNumber |
Gets the page number of the current image in the Multi-Page image file. |
GetTotalPages |
Gets the total page number of the Multi-Page image file. |
CFileImageTag |
The constructor of the CFileImageTag class. |
~CFileImageTag |
The destructor of the CFileImageTag class. |
Inherited Methods
The following methods are inherited from class CImageTag.
| Method | Description |
|---|---|
GetType |
Gets the type of the image tag. |
Clone |
Creates a copy of the image tag. |
GetImageId |
Gets the ID of the image. |
SetImageId |
Sets the ID of the image. |
GetImageCaptureDistanceMode |
Gets the capture distance mode of the image. |
SetImageCaptureDistanceMode |
Sets the capture distance mode of the image. |
GetFilePath
Gets the file path of the image tag.
const char* GetFilePath() const
Return value
Returns the file path of the image tag.
GetPageNumber
Get the page number of the current image in the Multi-Page image file.
int GetPageNumber() const
Return value
Returns the page number of the current image in the Multi-Page image file.
GetTotalPages
Gets the total page number of the Multi-Page image file.
int GetTotalPages() const;
Return value
Returns the total page number of the Multi-Page image file.
CFileImageTag Constructor
The constructor of the CFileImageTag class.
CFileImageTag(const char* _filePath, int _pageNumber, int _totalPages)
Parameters
[in] _filePath The file path of the image tag.
[in] _pageNumber The page number of the current image in the Multi-Page image file.
[in] _totalPages The total page number of the Multi-Page image file.
CFileImageTag Destructor
The destructor of the CFileImageTag class. It frees the memory allocated for the file path.
virtual ~CFileImageTag()
Yes
No