Use this to manage an excel sheet. More...

Inheritance diagram for IEwXLSSheetX:

Public Member Functions
BSTR	readString (LONG lRow, LONG lCol)
	Return a string with the value of cell. More...

void	writeString (LONG lRow, LONG lColumn, BSTR strValue)
	Write the string in the indicated cell. More...

LONG	firstRow ()
	Get the first row in sheet. More...

LONG	lastRow ()
	Get the last row in sheet. More...

LONG	firstColumn ()
	Get the first column in sheet. More...

LONG	lastColumn ()
	Get the last column in sheet. More...

LONG	firstFilledColumn ()
	Get the first column filled in sheet. More...

LONG	lastFilledColumn ()
	Get the last row filled in the sheet. More...

LONG	firstFilledRow ()
	Get the first row filled in the sheet. More...

LONG	lastFilledRow ()
	Get the last row filled in the sheet. More...

DOUBLE	columnWidth (LONG lColumn, EwErrorCode *errorCode)
	Get the width of a column. More...

DOUBLE	rowHeight (LONG lRow, EwErrorCode *errorCode)
	Get the height of a row. More...

LONG	columnWidthInPixels (LONG lColumn, EwErrorCode *errorCode)
	Get the width of the column. More...

LONG	rowHeightInPixels (LONG lRow, EwErrorCode *errorCode)
	Get the height of the row. More...

BSTR	font (LONG lRow, LONG lColumn, EwErrorCode *errorCode)
	Get the font used in a cell. More...

VARIANT_BOOL	isBold (LONG lRow, LONG lColumn, EwErrorCode *errorCode)
	Return true if the bold is used in the cell. More...

VARIANT_BOOL	isItalic (LONG lRow, LONG lColumn, EwErrorCode *errorCode)
	Return true if italic is used in the cell. More...

VARIANT_BOOL	isUnderline (LONG lRow, LONG lColumn, EwErrorCode *errorCode)
	Return true if underline is used in the cell. More...

LONG	textHeight (LONG lRow, LONG lColumn, EwErrorCode *errorCode)
	Get the height of text in cell. More...

Detailed Description

Use this to manage an excel sheet.

Since: 2018 Beta3

Member Function Documentation

◆ columnWidth()

DOUBLE IEwXLSSheetX::columnWidth	(	LONG	lColumn,
		EwErrorCode *	errorCode
	)

Get the width of a column.

The column width is measured as the number of characters of the maximum digit width of the numbers 0, 1, 2, ..., 9 as rendered in the normal style's font

Since: 2024 SP2

Parameters

[in]	lColumn	Column index
[out]	errorCode	EwErrorCode enum type can be: EW_UNDEFINED_ERROR if another error occurred EW_BAD_INPUTS row or column index are not between first and last column EW_NO_ERROR if no error detected

Returns: The width of a column

◆ columnWidthInPixels()

LONG IEwXLSSheetX::columnWidthInPixels	(	LONG	lColumn,
		EwErrorCode *	errorCode
	)

Get the width of the column.

Since: 2024 SP2

Parameters

[in]	lColumn	Column index
[out]	errorCode	EwErrorCode enum type can be: EW_UNDEFINED_ERROR if another error occurred EW_BAD_INPUTS row or column index are not between first and last column EW_NO_ERROR if no error detected

Returns: Column width in pixels.

◆ firstColumn()

LONG IEwXLSSheetX::firstColumn ( )

Get the first column in sheet.

Returns: The first column in the sheet.

◆ firstFilledColumn()

LONG IEwXLSSheetX::firstFilledColumn ( )

Get the first column filled in sheet.

Since: 2024 SP2

Returns: The first column filled in the sheet.

◆ firstFilledRow()

LONG IEwXLSSheetX::firstFilledRow ( )

Get the first row filled in the sheet.

Since: 2024 SP2

Returns: the first row filled in the sheet

◆ firstRow()

LONG IEwXLSSheetX::firstRow ( )

Get the first row in sheet.

Returns: First row in the sheet.

◆ font()

BSTR IEwXLSSheetX::font	(	LONG	lRow,
		LONG	lColumn,
		EwErrorCode *	errorCode
	)

Get the font used in a cell.

Since: 2024 SP2

Parameters

[in]	lRow	Row index of the cell
[in]	lColumn	Column index of the cell
[out]	errorCode	EwErrorCode enum type can be: EW_UNDEFINED_ERROR if another error occurred EW_BAD_INPUTS row or column index are not between first and last row and column EW_NO_ERROR if no error detected

Returns: Font used in cell.

◆ isBold()

VARIANT_BOOL IEwXLSSheetX::isBold	(	LONG	lRow,
		LONG	lColumn,
		EwErrorCode *	errorCode
	)

Return true if the bold is used in the cell.

Since: 2024 SP2

Parameters

[in]	lRow	Row index of the cell
[in]	lColumn	Column index of the cell
[out]	errorCode	EwErrorCode enum type can be: EW_UNDEFINED_ERROR if another error occurred EW_BAD_INPUTS row or column index are not between first and last row and column EW_NO_ERROR if no error detected

Returns: True if content of cell is bold.

◆ isItalic()

VARIANT_BOOL IEwXLSSheetX::isItalic	(	LONG	lRow,
		LONG	lColumn,
		EwErrorCode *	errorCode
	)

Return true if italic is used in the cell.

Parameters

[in]	lRow	Row index of the cell
[in]	lColumn	Column index of the cell
[out]	errorCode	EwErrorCode enum type can be: EW_UNDEFINED_ERROR if another error occurred EW_BAD_INPUTS row or column index are not between first and last row and column EW_NO_ERROR if no error detected

Since: 2024 SP2

Returns: True if content of cell is italic.

◆ isUnderline()

VARIANT_BOOL IEwXLSSheetX::isUnderline	(	LONG	lRow,
		LONG	lColumn,
		EwErrorCode *	errorCode
	)

Return true if underline is used in the cell.

Since: 2024 SP2

Parameters

[in]	lRow	Row index of the cell
[in]	lColumn	Column index of the cell
[out]	errorCode	EwErrorCode enum type can be: EW_UNDEFINED_ERROR if another error occurred EW_BAD_INPUTS row or column index are not between first and last row and column EW_NO_ERROR if no error detected

Returns: True if content of cell is underline.

◆ lastColumn()

LONG IEwXLSSheetX::lastColumn ( )

Get the last column in sheet.

Returns: The last column in the sheet.

◆ lastFilledColumn()

LONG IEwXLSSheetX::lastFilledColumn ( )

Get the last row filled in the sheet.

Since: 2024 SP2

Returns: The last column filled in the sheet.

◆ lastFilledRow()

LONG IEwXLSSheetX::lastFilledRow ( )

Get the last row filled in the sheet.

Since: 2024 SP2

Returns: the last row filled in the sheet.

◆ lastRow()

LONG IEwXLSSheetX::lastRow ( )

Get the last row in sheet.

Returns: The last row in the sheet.

◆ readString()

BSTR IEwXLSSheetX::readString	(	LONG	lRow,
		LONG	lCol
	)

Return a string with the value of cell.

Parameters

[in]	lRow	Number of the row in the sheet to read the value.
[in]	lCol	Number of the column in the sheet to read the value.

Returns: a string with the value of cell.

◆ rowHeight()

DOUBLE IEwXLSSheetX::rowHeight	(	LONG	lRow,
		EwErrorCode *	errorCode
	)

Get the height of a row.

The row height in typographical points. Point is 1/72 inch

Since: 2024 SP2

Parameters

[in]	lRow	Row index
[out]	errorCode	EwErrorCode enum type can be: EW_UNDEFINED_ERROR if another error occurred EW_BAD_INPUTS row or column index are not between first and last row EW_NO_ERROR if no error detected

Returns: The height of a row

◆ rowHeightInPixels()

LONG IEwXLSSheetX::rowHeightInPixels	(	LONG	lRow,
		EwErrorCode *	errorCode
	)

Get the height of the row.

Since: 2024 SP2

Parameters

[in]	lRow	Row index
[out]	errorCode	EwErrorCode enum type can be: EW_UNDEFINED_ERROR if another error occurred EW_BAD_INPUTS row or column index are not between first and last row EW_NO_ERROR if no error detected

Returns: Row height in pixels.

◆ textHeight()

LONG IEwXLSSheetX::textHeight	(	LONG	lRow,
		LONG	lColumn,
		EwErrorCode *	errorCode
	)

Get the height of text in cell.

Since: 2024 SP2

Parameters

[in]	lRow	Row index of the cell
[in]	lColumn	Column index of the cell
[out]	errorCode	EwErrorCode enum type can be: EW_UNDEFINED_ERROR if another error occurred EW_BAD_INPUTS row or column index are not between first and last row and column EW_NO_ERROR if no error detected

Returns: Height of text.

◆ writeString()

void IEwXLSSheetX::writeString	(	LONG	lRow,
		LONG	lColumn,
		BSTR	strValue
	)

Write the string in the indicated cell.

Parameters

[in]	lRow	Number of the row from which we want to write the value.
[in]	lColumn	Number of the row from which we want to write the value.
[in]	strValue	the string to write in the cell.


*Email:
Subject:		Feedback on Help Topics
Page:		SOLIDWORKS Electrical API: IEwXLSSheetX Interface Reference
*Comment:
*		I acknowledge I have read and I hereby accept the privacy policy under which my Personal Data will be used by Dassault Systèmes

Public Member Functions

Detailed Description

Member Function Documentation

◆ columnWidth()

◆ columnWidthInPixels()

◆ firstColumn()

◆ firstFilledColumn()

◆ firstFilledRow()

◆ firstRow()

◆ font()

◆ isBold()

◆ isItalic()

◆ isUnderline()

◆ lastColumn()

◆ lastFilledColumn()

◆ lastFilledRow()

◆ lastRow()

◆ readString()

◆ rowHeight()

◆ rowHeightInPixels()

◆ textHeight()

◆ writeString()