MST::Imaging::FileFormat Class Reference

#include <FileFormat.h>

Inheritance diagram for MST::Imaging::FileFormat:

Public Member Functions
virtual	~FileFormat ()
	It is dispose.
Page^	GetPage (int PageNum)
	It is used to get specified page from document. More...
Page^	GetPage (int PageNum, PAGEINFO% pageInfo)
array< Page^ >^	GetPages (int From, int To)
	It is used to get multiple pages from document. More...
bool	Export (System::String^ fileName, OutputFileTypes fileType)
	It is used to export document. More...
bool	Export (System::String^ fileName, OutputFileTypes fileType, SAVEOPTION Option)

Static Public Member Functions
static FileFormat^	FromFile (String^ fileName)
	It is a static function which load file using its path. More...
static FileFormat^	FromStream (Stream^ fileStream)
	It is a static function which load file using stream of file. More...
static FileFormat^	FromUri (Uri^ fileUri)
	It is a static function which load file from remote loaction. More...
static bool	Merge (array< FileFormat^ >^docs, System::String^ filename, OutputFileTypes fileType)
	It is a static function which merge two or more document into one document. More...
static bool	Merge (Dictionary< FileFormat^ , int >^docMap, System::String^ filename, OutputFileTypes fileType)
	It is a static function which merge multipages document's specified pages into one document. More...

Static Public Attributes
static PlugInConnectorLib::ImageFactoryClass^	factory =gcnew PlugInConnectorLib::ImageFactoryClass()

Protected Attributes
int	m_Handle
int	m_PageCount
FileTypes	m_FileType

Properties
bool	IsDocument [get]
	Use to check either it is a document or image .
FileTypes	FileType [get]
	Use to get documents type.
int	PageCount [get]
	Use to get total number of pages in document.
int	Handle [get]
	Use to get handle of document.

Detailed Description

This is an abstract class and also used for saving & loading a file.

Member Function Documentation

bool MST::Imaging::FileFormat::Export	(	System::String^	fileName,
		OutputFileTypes	fileType
	)

It is used to export document.

Parameters

fileName	path where document will be exported.
fileType	Type of exported document.

Returns

return True if successfull else false.

Parameters

fileName	path where document will be exported.
fileType	Type of exported document.
Option	some oher option that will be used in advanced file exporting.

Returns

return True if successfull else false.

static FileFormat MST::Imaging::FileFormat::FromFile ( String^  fileName )

static

It is a static function which load file using its path.

Parameters

fileName

Path of a file which will be loaded.

Returns

object of class Fileformat.

static FileFormat MST::Imaging::FileFormat::FromStream ( Stream^  fileStream )

static

It is a static function which load file using stream of file.

Parameters

fileStream

stream of a file which will be loaded.

Returns

object of class Fileformat.

static FileFormat MST::Imaging::FileFormat::FromUri ( Uri^  fileUri )

static

It is a static function which load file from remote loaction.

Parameters

fileUri

file path at remote location.

Returns

object of class Fileformat.

Page MST::Imaging::FileFormat::GetPage

(

int

PageNum

)

It is used to get specified page from document.

Parameters

PageNum

Page number which it will be return.

Returns

object of class Page.

array< Page^ > MST::Imaging::FileFormat::GetPages	(	int	From,
		int	To
	)

It is used to get multiple pages from document.

Parameters

From	start index.
to	end index.

Returns

array of pages.

static bool MST::Imaging::FileFormat::Merge ( array< FileFormat^ >^  docs, System::String^  filename, OutputFileTypes  fileType  )

static

It is a static function which merge two or more document into one document.

Parameters

docs	array of FileFormat which contains docs that will be merge together.
filename	path where merged file will be saved.
fileType	type of a file created after merging different files.

Returns

object of class Fileformat.

static bool MST::Imaging::FileFormat::Merge ( Dictionary< FileFormat^ , int >^  docMap, System::String^  filename, OutputFileTypes  fileType  )

static

It is a static function which merge multipages document's specified pages into one document.

Parameters

docMap	dictionary of FileFormat and pages of multipage document.
filename	path where merged file will be saved.
fileType	type of a file created after merging different files.

Returns

object of class Fileformat.

---

The documentation for this class was generated from the following file:

• F:/MSTRasterSDK/Include/FileFormat.h