Class CShgName

class CShgName : public CBase;

Description

A spreadsheet engine name entry.

A name is a user-specified identifier for particular cells, ranges, or values.

Derivation

• CBase - Base class for all classes to be instantiated on the heap

• CShgName - A spreadsheet engine name entry

Members

Defined in CShgName:
AsTextL(), ECell, EError, EFormula, EInt, EPermanentlyDeleted, ERange, EReal, EText, Error(), Formula(), GetCell(), GetRange(), Int(), Name(), Real(), TType, Text(), Type(), ~CShgName()

Inherited from CBase:
Delete(), Extension_(), operator new()

virtual ~CShgName();

Description

Destructor.

IMPORT_C TPtrC Name() const;

Description

Gets the name identifier.

Return value

TPtrC Name identifier

IMPORT_C void AsTextL(const CShgWorkBook *aWorkBook, TDes &aDes) const;

Description

Gets the name value as a string.

Where the name value is not a string type, the returned value is an appropriate conversion.

Parameters

const CShgWorkBook *aWorkBook Workbook containing the name TDes &aDes On return, the name value as a string

IMPORT_C TType Type() const;

Description

Gets the name value type.

Return value

TType Name value type

IMPORT_C TInt32 Int() const;

Description

Gets the value of an integer type name.

Return value

TInt32 Name value

IMPORT_C TReal64 Real() const;

Description

Gets the value of a real number type name.

Return value

TReal64 Name value

IMPORT_C TShgCell::TErrorType Error() const;

Description

Gets the error type, if the value results in an error.

Return value

TShgCell::TErrorType Error

IMPORT_C const TDesC &Text() const;

Description

Gets the value of a text type name.

Return value

const TDesC & Name value

IMPORT_C void GetCell(TInt &aWorkSheetNo, TCellRef &aCellRef) const;

Description

Gets the value of a cell type name.

Parameters

TInt &aWorkSheetNo On return, worksheet on which the cell appears TCellRef &aCellRef On return, named cell

IMPORT_C void GetRange(TInt &aWorkSheetNo, TRangeRef &aRangeRef) const;

Description

Gets the value of a cell range type name.

Parameters

TInt &aWorkSheetNo On return, worksheet on which the cell range appears TRangeRef &aRangeRef On return, named cell range

IMPORT_C const TDesC8 *Formula() const;

Description

Gets the value of a formula type name.

Return value

const TDesC8 * Name value

TType

Description

Defines possible name value types.

EInt Name refers to an integer. EReal Name refers to a real number. EText Name refers to a string. ECell Name refers to a cell. ERange Name refers to a cell range. EFormula Name refers to a formula. EPermanentlyDeleted Name refers to an item that has been permanently deleted. EError Name refers to an item in an error state.