Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

com.moyosoft.connector.ms.excel
Class Excel

java.lang.Object
  |
  +--com.moyosoft.connector.ms.excel.Excel
public class Excel
extends java.lang.Object

Represents an Excel application. An Excel object is the starting point for creating or modifying workbooks, worksheets and charts in Excel documents.

The default constructor creates and connects to an Excel application:

Excel excel = new Excel();

The following static methods are available to access an already running Excel application:

Excel runningExcel = Excel.getRunningExcelApplication();
Excel[] allRunningExcels = Excel.getRunningExcelApplications();

Native resources used by the Excel object should be disposed by calling the method dispose() of this class.

Usage example:

Excel excel = new Excel();
System.out.println("Your Excel version is: " + excel.getVersion());
excel.dispose();

See Also:
Excel(), getRunningExcelApplication(), dispose()

Constructor Summary
Excel()
          Starts a new Excel application and connects to it.
 
Method Summary
 void activateMicrosoftApp(MSApplication value)
           
 void addChartAutoFormat(Chart chart, java.lang.String name)
           
 void addChartAutoFormat(Chart chart, java.lang.String name, java.lang.String description)
           
 void addCustomList(Range listArray)
           
 void addCustomList(Range listArray, boolean byRow)
           
 void addCustomList(java.lang.String[] listArray)
           
 void calculate()
           
 void calculateFull()
           
 void calculateFullRebuild()
           
 double centimetersToPoints(double value)
           
 void checkAbort()
           
 void checkAbort(Range keepAbort)
           
 boolean checkSpelling(java.lang.String word)
           
 boolean checkSpelling(java.lang.String word, java.lang.String customDictionaryFilename)
           
 boolean checkSpelling(java.lang.String word, java.lang.String customDictionaryFilename, boolean ignoreUppercase)
           
 java.lang.String convertFormula(java.lang.String formula, ReferenceStyle fromReferenceStyle)
           
 java.lang.String convertFormula(java.lang.String formula, ReferenceStyle fromReferenceStyle, ReferenceStyle toReferenceStyle)
           
 java.lang.String convertFormula(java.lang.String formula, ReferenceStyle fromReferenceStyle, ReferenceStyle toReferenceStyle, ReferenceStyle toAbsolute)
           
 java.lang.String convertFormula(java.lang.String formula, ReferenceStyle fromReferenceStyle, ReferenceStyle toReferenceStyle, ReferenceStyle toAbsolute, Range relativeTo)
           
static Excel createInstance(ComManager comManager)
           
 Workbook createWorkbook()
          Creates a new Workbook.
 void DDEExecute(int channel, java.lang.String message)
           
 int DDEInitiate(java.lang.String app, java.lang.String topic)
           
 void DDETerminate(int channel)
           
 void deleteChartAutoFormat(java.lang.String name)
           
 void deleteCustomList(int listNum)
           
 void displayXMLSourcePane()
           
 void displayXMLSourcePane(XmlMap xmlMap)
           
 void dispose()
          Disposes the native resources used by the library, closes all workbooks (without saving changes), quits and disconnects from the Excel application.
 void dispose(boolean quitIfHidden)
          Disposes the native resources used by the library and disconnects from the Excel application.
 void doubleClick()
           
 java.lang.Object evaluate(java.lang.String name)
           
 boolean findFile()
           
 Range getActiveCell()
           
 Chart getActiveChart()
           
 DialogSheet getActiveDialog()
           
 MenuBar getActiveMenuBar()
           
 java.lang.String getActivePrinter()
           
 Sheet getActiveSheet()
           
 Window getActiveWindow()
           
 Workbook getActiveWorkbook()
           
 AddIns getAddIns()
           
 java.lang.String getAltStartupPath()
           
 Dispatch getApplicationDispatch()
           
 AutoCorrect getAutoCorrect()
           
 AutoRecover getAutoRecover()
           
 int getBuild()
           
 Calculation getCalculation()
           
 CalculationInterruptKey getCalculationInterruptKey()
           
 CalculationState getCalculationState()
           
 int getCalculationVersion()
           
 java.lang.String getCaption()
           
 Range getCells()
           
 Sheets getCharts()
           
 Range getColumns()
           
 CommandUnderlines getCommandUnderlines()
           
 MousePointer getCursor()
           
 int getCursorMovement()
           
 java.lang.String[] getCustomListContents(int listNum)
           
 int getCustomListCount()
           
 int getCustomListNum(java.lang.String[] customList)
           
 CutCopyMode getCutCopyMode()
           
 int getDataEntryMode()
           
 int getDDEAppReturnCode()
           
 java.lang.String getDecimalSeparator()
           
 java.lang.String getDefaultFilePath()
           
 FileFormat getDefaultSaveFormat()
           
 int getDefaultSheetDirection()
           
 DefaultWebOptions getDefaultWebOptions()
           
 Dialogs getDialogs()
           
 Sheets getDialogSheets()
           
 CommentDisplayMode getDisplayCommentIndicator()
           
 EnableCancelKey getEnableCancelKey()
           
 ErrorCheckingOptions getErrorCheckingOptions()
           
 Sheets getExcel4IntlMacroSheets()
           
 Sheets getExcel4MacroSheets()
           
 CellFormat getFindFormat()
           
 int getFixedDecimalPlaces()
           
 double getHeight()
           
 boolean getInternationalBoolean(ApplicationInternational index)
           
 int getInternationalInt(ApplicationInternational index)
           
 java.lang.String getInternationalString(ApplicationInternational index)
           
 double getLeft()
           
 java.lang.String getLibraryPath()
           
 double getMaxChange()
           
 int getMaxIterations()
           
 int getMemoryFree()
           
 int getMemoryTotal()
           
 int getMemoryUsed()
           
 MenuBars getMenuBars()
           
 Direction getMoveAfterReturnDirection()
           
 java.lang.String getName()
           
 Names getNames()
           
 java.lang.String getNetworkTemplatesPath()
           
 int getODBCTimeout()
           
 java.lang.String getOnCalculate()
           
 java.lang.String getOnData()
           
 java.lang.String getOnDoubleClick()
           
 java.lang.String getOnEntry()
           
 java.lang.String getOnSheetActivate()
           
 java.lang.String getOnSheetDeactivate()
           
 java.lang.String getOnWindow()
           
 java.lang.String getOpenFilename()
           
 java.lang.String getOpenFilename(java.lang.String fileFilter)
           
 java.lang.String getOpenFilename(java.lang.String fileFilter, int filterIndex)
           
 java.lang.String getOpenFilename(java.lang.String fileFilter, int filterIndex, java.lang.String title)
           
 java.lang.String getOperatingSystem()
           
 java.lang.String getOrganizationName()
           
 java.lang.String getPath()
           
 java.lang.String getPathSeparator()
           
 java.lang.String getPhonetic()
           
 java.lang.String getPhonetic(java.lang.String text)
           
 java.lang.String getProductCode()
           
 Range getRange(java.lang.String cell)
           
 RecentFiles getRecentFiles()
           
 ReferenceStyle getReferenceStyle()
           
 CellFormat getReplaceFormat()
           
 Range getRows()
           
 RTD getRTD()
           
static Excel getRunningExcelApplication()
          Connects to an already running Excel application.
static Excel getRunningExcelApplication(ComManager comManager)
          Connects to an already running Excel application.
static Excel[] getRunningExcelApplications()
          Connects to all running Excel applications.
static Excel[] getRunningExcelApplications(ComManager comManager)
          Connects to all running Excel applications.
 java.lang.String getSaveAsFilename()
           
 java.lang.String getSaveAsFilename(java.lang.String initialFilename)
           
 java.lang.String getSaveAsFilename(java.lang.String initialFilename, java.lang.String fileFilter)
           
 java.lang.String getSaveAsFilename(java.lang.String initialFilename, java.lang.String fileFilter, int filterIndex)
           
 java.lang.String getSaveAsFilename(java.lang.String initialFilename, java.lang.String fileFilter, int filterIndex, java.lang.String title)
           
 java.lang.Object getSelection()
           
 Sheets getSheets()
           
 int getSheetsInNewWorkbook()
           
 SmartTagRecognizers getSmartTagRecognizers()
           
 SpellingOptions getSpellingOptions()
           
 java.lang.String getStandardFont()
           
 double getStandardFontSize()
           
 java.lang.String getStartupPath()
           
 java.lang.String getStatusBar()
           
 java.lang.String getTemplatesPath()
           
 Range getThisCell()
           
 Workbook getThisWorkbook()
           
 java.lang.String getThousandsSeparator()
           
 Toolbars getToolbars()
           
 double getTop()
           
 java.lang.String getTransitionMenuKey()
           
 int getTransitionMenuKeyAction()
           
 int getUILanguage()
           
 double getUsableHeight()
           
 double getUsableWidth()
           
 java.lang.String getUserLibraryPath()
           
 java.lang.String getUserName()
           
 java.lang.String getValue()
           
 java.lang.String getVersion()
           
 Watches getWatches()
           
 double getWidth()
           
 Windows getWindows()
           
 WindowState getWindowState()
           
 Workbooks getWorkbooks()
           
 WorksheetFunction getWorksheetFunction()
           
 Sheets getWorksheets()
           
 void goTo()
           
 void goTo(Range reference)
           
 void goTo(Range reference, boolean scroll)
           
 void goTo(java.lang.String reference)
           
 void goTo(java.lang.String reference, boolean scroll)
           
 void help()
           
 double inchesToPoints(double inches)
           
 java.lang.String inputBox(java.lang.String prompt)
           
 java.lang.String inputBox(java.lang.String prompt, java.lang.String title)
           
 java.lang.String inputBox(java.lang.String prompt, java.lang.String title, java.lang.String defaultValue)
           
 java.lang.String inputBox(java.lang.String prompt, java.lang.String title, java.lang.String defaultValue, int left)
           
 java.lang.String inputBox(java.lang.String prompt, java.lang.String title, java.lang.String defaultValue, int left, int top)
           
 java.lang.String inputBox(java.lang.String prompt, java.lang.String title, java.lang.String defaultValue, int left, int top, java.lang.String helpFile)
           
 java.lang.String inputBox(java.lang.String prompt, java.lang.String title, java.lang.String defaultValue, int left, int top, java.lang.String helpFile, int helpContextID)
           
 java.lang.String inputBox(java.lang.String prompt, java.lang.String title, java.lang.String defaultValue, int left, int top, java.lang.String helpFile, int helpContextID, int dataType)
           
 Range intersect(Range range1, Range range2)
           
 Range intersect(Range range1, Range range2, Range range3)
           
 Range intersect(Range range1, Range range2, Range range3, Range range4)
           
 Range intersect(Range range1, Range range2, Range range3, Range range4, Range range5)
           
 boolean isAlertBeforeOverwriting()
           
 boolean isArbitraryXMLSupportAvailable()
           
 boolean isAskToUpdateLinks()
           
 boolean isAutoFormatAsYouTypeReplaceHyperlinks()
           
 boolean isAutoPercentEntry()
           
 boolean isCalculateBeforeSave()
           
 boolean isCanPlaySounds()
           
 boolean isCanRecordSounds()
           
 boolean isCellDragAndDrop()
           
 boolean isColorButtons()
           
 boolean isConstrainNumeric()
           
 boolean isControlCharacters()
           
 boolean isCopyObjectsWithCells()
           
 boolean isDisplayAlerts()
           
 boolean isDisplayClipboardWindow()
           
 boolean isDisplayDocumentActionTaskPane()
           
 boolean isDisplayExcel4Menus()
           
 boolean isDisplayFormulaBar()
           
 boolean isDisplayFullScreen()
           
 boolean isDisplayFunctionToolTips()
           
 boolean isDisplayInfoWindow()
           
 boolean isDisplayInsertOptions()
           
 boolean isDisplayNoteIndicator()
           
 boolean isDisplayPasteOptions()
           
 boolean isDisplayRecentFiles()
           
 boolean isDisplayScrollBars()
           
 boolean isDisplayStatusBar()
           
 boolean isEditDirectlyInCell()
           
 boolean isEnableAnimations()
           
 boolean isEnableAutoComplete()
           
 boolean isEnableEvents()
           
 boolean isEnableSound()
           
 boolean isEnableTipWizard()
           
 boolean isExtendList()
           
 boolean isFixedDecimal()
           
 boolean isGenerateGetPivotData()
           
 boolean isIgnoreRemoteRequests()
           
 boolean isInteractive()
           
 boolean isIteration()
           
 boolean isLargeButtons()
           
 boolean isMapPaperSize()
           
 boolean isMathCoprocessorAvailable()
           
 boolean isMouseAvailable()
           
 boolean isMoveAfterReturn()
           
 boolean isPivotTableSelection()
           
 boolean isPromptForSummaryInfo()
           
 boolean isReady()
           
 boolean isRecordRelative()
           
 boolean isRollZoom()
           
 boolean isScreenUpdating()
           
 boolean isShowChartTipNames()
           
 boolean isShowChartTipValues()
           
 boolean isShowStartupDialog()
           
 boolean isShowToolTips()
           
 boolean isShowWindowsInTaskbar()
           
 boolean isTransitionNavigKeys()
           
 boolean isUserControl()
           
 boolean isUseSystemSeparators()
           
 boolean isVisible()
           
 boolean isWindowsForPens()
           
 void macroOptions()
           
 void macroOptions(java.lang.String macro)
           
 void macroOptions(java.lang.String macro, java.lang.String description)
           
 void macroOptions(java.lang.String macro, java.lang.String description, int category)
           
 void macroOptions(java.lang.String macro, java.lang.String description, int category, java.lang.String statusBar)
           
 void macroOptions(java.lang.String macro, java.lang.String description, int category, java.lang.String statusBar, int helpContextID)
           
 void macroOptions(java.lang.String macro, java.lang.String description, int category, java.lang.String statusBar, int helpContextID, java.lang.String helpFile)
           
 Workbook nextLetter()
           
 void onKey(java.lang.String key)
           
 void onKey(java.lang.String key, java.lang.String procedureName)
           
 void onRepeat(java.lang.String text, java.lang.String procedureName)
           
 void onTime(java.util.Date earliestTime, java.lang.String procedureName)
           
 void onTime(java.util.Date earliestTime, java.lang.String procedureName, java.util.Date latestTime)
           
 void onTime(java.util.Date earliestTime, java.lang.String procedureName, java.util.Date latestTime, boolean scheduleNew)
           
 void onUndo(java.lang.String text, java.lang.String procedureName)
           
 Workbook openWorkbook(java.io.File file)
          Open an existing Workbook Excel document.
 void quit()
           
 void recordMacro()
           
 void recordMacro(java.lang.String basicCode)
           
 boolean registerXLL(java.io.File file)
           
 void repeat()
           
 void resetTipWizard()
           
 java.lang.Object runMacro(java.lang.String macroName)
           
 java.lang.Object runMacro(java.lang.String macroName, java.lang.Object[] parameters)
           
 void save()
           
 void save(java.io.File file)
           
 void saveWorkspace()
           
 void saveWorkspace(java.io.File file)
           
 void sendKeys(java.lang.String keys)
           
 void sendKeys(java.lang.String keys, boolean wait)
           
 void setActivePrinter(java.lang.String value)
           
 void setAlertBeforeOverwriting(boolean value)
           
 void setAltStartupPath(java.lang.String value)
           
 void setAskToUpdateLinks(boolean value)
           
 void setAutoFormatAsYouTypeReplaceHyperlinks(boolean value)
           
 void setAutoPercentEntry(boolean value)
           
 void setCalculateBeforeSave(boolean value)
           
 void setCalculation(Calculation value)
           
 void setCalculationInterruptKey(CalculationInterruptKey value)
           
 void setCaption(java.lang.String value)
           
 void setCellDragAndDrop(boolean value)
           
 void setColorButtons(boolean value)
           
 void setCommandUnderlines(CommandUnderlines value)
           
 void setConstrainNumeric(boolean value)
           
 void setControlCharacters(boolean value)
           
 void setCopyObjectsWithCells(boolean value)
           
 void setCursor(MousePointer value)
           
 void setCursorMovement(int value)
           
 void setCutCopyMode(CutCopyMode value)
           
 void setDataEntryMode(int value)
           
 void setDecimalSeparator(java.lang.String value)
           
 void setDefaultChart()
           
 void setDefaultChart(java.lang.String formatName)
           
 void setDefaultFilePath(java.lang.String value)
           
 void setDefaultSaveFormat(FileFormat value)
           
 void setDefaultSheetDirection(int value)
           
 void setDisplayAlerts(boolean value)
           
 void setDisplayClipboardWindow(boolean value)
           
 void setDisplayCommentIndicator(CommentDisplayMode value)</