All Frameworks Class Hierarchy This Framework Indexes Previous Next

KnowledgeInterfaces Interface CATICkeOleSheet

SystemTS.IUnknown

System.IDispatch

System.CATBaseUnknown

KnowledgeInterfaces.CATICkeSheet

CATICkeOleSheet

Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.

interface CATICkeOleSheet

This interface is an encapsulation of an array of arrays (a sheet) of strings contained in a file.
The file has to be an excel or a lotus sheet file. Its format has to be :

string_1,1 string_1,2 ...

(n-2 lines)

string_n,1 string_n,2 ...

Empty strings are allowed, but not in the first row because the number of columns is computed using the first row, except if you use the forceWidth argument of the CATICkeSheet.UpdateLocalCopy method.
To create a CATICkeOleSheet, use the CATICkeRelationFactory.CreateSheet method with an excel or a lotus file path as argument.

See also:: CATIDesignTable, CATICkeSheet, CATICkeTextSheet

Method Index

o GetOleModifyAndCloseNotification(): Returns the notification associated with the modification of the OLE doc.
o GetSheetIndex(): Returns the index of the sheet in the workboook where data has to be found.
o SetSheetIndex(int): Sets the index of the sheet in the workbook.

Methods

o GetOleModifyAndCloseNotification

public virtual CATCallbackEvent GetOleModifyAndCloseNotification(

)= 0

Returns the notification associated with the modification of the OLE doc. The notification is sent when the OLE doc. has been modified, and Ole doc viewer closed (the sheet can't be parsed if Ole doc. is opened and sends notifications to CATIA)

o GetSheetIndex

public virtual int GetSheetIndex(

)= 0

Returns the index of the sheet in the workboook where data has to be found.

o SetSheetIndex

public virtual void SetSheetIndex( int index) = 0

Sets the index of the sheet in the workbook. This method has to be called before any call of CATICkeSheet::UpdateLocalCopy

Parameters:

index: index of the sheet in the workbook. Minimum value : 1

This object is included in the file: CATICkeOleSheet.h
If needed, your Imakefile.mk should include the module: KnowledgeItf