NXOpen::SpreadsheetExternal Class Reference

Represents a class for external spreadsheet. More...

Inheritance diagram for NXOpen::SpreadsheetExternal:

Public Member Functions
void	AppendRow (int worksheet, const std::vector< NXOpen::SpreadsheetCellData * > &data)
	Appends a new row of data to the Excel file. More...
void	CloseFile (bool save)
	Closes an excel file with an option to save the file before close. More...
int	GetWorksheetIndex (const NXString &sheetname)
	Returns worksheet ID. More...
int	GetWorksheetIndex (const char *sheetname)
	Returns worksheet ID. More...
void	ReadNamedRange (int worksheet, const NXString &rangename, std::vector< NXOpen::SpreadsheetCellData * > &v2)
	Reads a named range. More...
void	ReadNamedRange (int worksheet, const char *rangename, std::vector< NXOpen::SpreadsheetCellData * > &v2)
	Reads a named range. More...
void	ReadRange (int worksheet, int rowstart, int colstart, int rowend, int colend, std::vector< NXOpen::SpreadsheetCellData * > &v2)
	Reads the spreadsheet file and returns the data in the specified ranges of the cells. More...
void	WriteRange (const std::vector< NXOpen::SpreadsheetCellData * > &data)
	Writes the data to the specified range of the spreadsheet. More...
virtual	~SpreadsheetExternal ()
	Free resources associated with the instance. More...
Public Member Functions inherited from NXOpen::TransientObject
void *	GetHandle ()
	Handle of the internal object represented by this object. More...

Detailed Description

Represents a class for external spreadsheet.

To call functions from this class, use SpreadsheetExternal object returned by NXOpen::SpreadsheetManager::OpenFile .
Usable only on Windows

Created in NX11.0.0.

Constructor & Destructor Documentation

virtual NXOpen::SpreadsheetExternal::~SpreadsheetExternal ( )

virtual

Free resources associated with the instance.

After this method is called, it is illegal to use the object. In .NET, this method is automatically called when the object is deleted by the garbage collector.
Created in NX11.0.0.

License requirements : None

Member Function Documentation

void NXOpen::SpreadsheetExternal::AppendRow	(	int	worksheet,
		const std::vector< NXOpen::SpreadsheetCellData * > &	data
	)

Appends a new row of data to the Excel file.

Created in NX11.0.0.

License requirements : None

Parameters

worksheet	Worksheet ID
data	The append data list.

void NXOpen::SpreadsheetExternal::CloseFile

(

bool

save

)

Closes an excel file with an option to save the file before close.

Created in NX11.0.0.

License requirements : None

Parameters

save	If true, the file will be saved. If false, the file will not be saved.

int NXOpen::SpreadsheetExternal::GetWorksheetIndex

(

const NXString &

sheetname

)

Returns worksheet ID.

Returns

worksheet ID
Created in NX11.0.0.

License requirements : None

Parameters

sheetname

Sheet name to get Index

int NXOpen::SpreadsheetExternal::GetWorksheetIndex

(

const char *

sheetname

)

Returns worksheet ID.

Returns

worksheet ID
Created in NX11.0.0.

License requirements : None

Parameters

sheetname

Sheet name to get Index

void NXOpen::SpreadsheetExternal::ReadNamedRange	(	int	worksheet,
		const NXString &	rangename,
		std::vector< NXOpen::SpreadsheetCellData * > &	v2
	)

Reads a named range.

Created in NX11.0.0.

License requirements : None

Parameters

worksheet	worksheet ID
rangename	Range name
v2	Data list for given range name

void NXOpen::SpreadsheetExternal::ReadNamedRange	(	int	worksheet,
		const char *	rangename,
		std::vector< NXOpen::SpreadsheetCellData * > &	v2
	)

Reads a named range.

Created in NX11.0.0.

License requirements : None

Parameters

worksheet	worksheet ID
rangename	Range name
v2	Data list for given range name

void NXOpen::SpreadsheetExternal::ReadRange	(	int	worksheet,
		int	rowstart,
		int	colstart,
		int	rowend,
		int	colend,
		std::vector< NXOpen::SpreadsheetCellData * > &	v2
	)

Reads the spreadsheet file and returns the data in the specified ranges of the cells.

Created in NX11.0.0.

License requirements : None

Parameters

worksheet	Worksheet ID
rowstart	Starting row of the range
colstart	Starting column of the range
rowend	Ending row of the range
colend	Ending column of the range
v2	Data list for given range

void NXOpen::SpreadsheetExternal::WriteRange

(

const std::vector< NXOpen::SpreadsheetCellData * > &

data

)

Writes the data to the specified range of the spreadsheet.

Created in NX11.0.0.

License requirements : None

Parameters

data	The data list to be written to external Excel worksheet.

---

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

• SpreadsheetExternal.hxx