Represents a class for external spreadsheet. More...

Inheritance diagram for NXOpen.SpreadsheetExternal:

Public Member Functions
unsafe void	CloseFile (bool save)
	Closes an excel file with an option to save the file before close. More...

unsafe int	GetWorksheetIndex (string sheetname)
	Returns worksheet ID. More...

unsafe void	ReadNamedRange (int worksheet, string rangename, out NXOpen.SpreadsheetCellData[] v2)
	Reads a named range. More...

unsafe void	ReadRange (int worksheet, int rowstart, int colstart, int rowend, int colend, out NXOpen.SpreadsheetCellData[] v2)
	Reads the spreadsheet file and returns the data in the specified ranges of the cells. More...

unsafe void	AppendRow (int worksheet, NXOpen.SpreadsheetCellData[] data)
	Appends a new row of data to the Excel file. More...

unsafe void	WriteRange (NXOpen.SpreadsheetCellData[] data)
	Writes the data to the specified range of the spreadsheet. More...

Protected Member Functions
override void	FreeResource ()
	Free resources associated with the instance. 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

Member Function Documentation

unsafe void NXOpen.SpreadsheetExternal.AppendRow	(	int	worksheet,
		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.

unsafe 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.

override void NXOpen.SpreadsheetExternal.FreeResource ( )

protected

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.

unsafe int NXOpen.SpreadsheetExternal.GetWorksheetIndex ( string sheetname )

Returns worksheet ID.

Created in NX11.0.0

License requirements: None.

Parameters

sheetname Sheet name to get Index

Returns: worksheet ID

unsafe void NXOpen.SpreadsheetExternal.ReadNamedRange	(	int	worksheet,
		string	rangename,
		out 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

unsafe void NXOpen.SpreadsheetExternal.ReadRange	(	int	worksheet,
		int	rowstart,
		int	colstart,
		int	rowend,
		int	colend,
		out 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

unsafe void NXOpen.SpreadsheetExternal.WriteRange ( 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:

dotnet_pool/SpreadsheetExternal.cs

Public Member Functions

Protected Member Functions

Detailed Description

Member Function Documentation