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()
int	getAutomationSecurity() Returns the current automation security.
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	setAutomationSecurity(int value) Assign the specified automation security.
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)
void	setDisplayDocumentActionTaskPane(boolean value)
void	setDisplayExcel4Menus(boolean value)
void	setDisplayFormulaBar(boolean value)
void	setDisplayFullScreen(boolean value)
void	setDisplayFunctionToolTips(boolean value)
void	setDisplayInfoWindow(boolean value)
void	setDisplayInsertOptions(boolean value)
void	setDisplayNoteIndicator(boolean value)
void	setDisplayPasteOptions(boolean value)
void	setDisplayRecentFiles(boolean value)
void	setDisplayScrollBars(boolean value)
void	setDisplayStatusBar(boolean value)
void	setEditDirectlyInCell(boolean value)
void	setEnableAnimations(boolean value)
void	setEnableAutoComplete(boolean value)
void	setEnableCancelKey(EnableCancelKey value)
void	setEnableEvents(boolean value)
void	setEnableSound(boolean value)
void	setEnableTipWizard(boolean value)
void	setExtendList(boolean value)
void	setFindFormat(CellFormat value)
void	setFixedDecimal(boolean value)
void	setFixedDecimalPlaces(int value)
void	setGenerateGetPivotData(boolean value)
void	setHeight(double value)
void	setIgnoreRemoteRequests(boolean value)
void	setInteractive(boolean value)
void	setIteration(boolean value)
void	setLargeButtons(boolean value)
void	setLeft(double value)
static void	setLibraryPath(java.lang.String pFilePath) Sets the path to the native DLL library file (moyocore.dll).
void	setMapPaperSize(boolean value)
void	setMaxChange(double value)
void	setMaxIterations(int value)
void	setMoveAfterReturn(boolean value)
void	setMoveAfterReturnDirection(Direction value)
void	setODBCTimeout(int value)
void	setOnCalculate(java.lang.String value)
void	setOnData(java.lang.String value)
void	setOnDoubleClick(java.lang.String value)
void	setOnEntry(java.lang.String value)
void	setOnSheetActivate(java.lang.String value)
void	setOnSheetDeactivate(java.lang.String value)
void	setOnWindow(java.lang.String value)
void	setPivotTableSelection(boolean value)
void	setPromptForSummaryInfo(boolean value)
void	setReferenceStyle(ReferenceStyle value)
void	setReplaceFormat(CellFormat value)
void	setRollZoom(boolean value)
void	setScreenUpdating(boolean value)
void	setSheetsInNewWorkbook(int value)
void	setShowChartTipNames(boolean value)
void	setShowChartTipValues(boolean value)
void	setShowStartupDialog(boolean value)
void	setShowToolTips(boolean value)
void	setShowWindowsInTaskbar(boolean value)
void	setStandardFont(java.lang.String value)
void	setStandardFontSize(double value)
void	setStatusBar(java.lang.String text)
void	setStatusBarToDefaultText()
void	setThousandsSeparator(java.lang.String value)
void	setTop(double value)
void	setTransitionMenuKey(java.lang.String value)
void	setTransitionMenuKeyAction(int value)
void	setTransitionNavigKeys(boolean value)
void	setUILanguage(int value)
void	setUserControl(boolean value)
void	setUserName(java.lang.String value)
void	setUseSystemSeparators(boolean value)
void	setVisible(boolean value)
void	setVolatile()
void	setVolatile(boolean isVolatile)
void	setWidth(double value)
void	setWindowState(WindowState value)
void	undo()
Range	union(Range arg1, Range arg2)
Range	union(Range arg1, Range arg2, Range arg3)
Range	union(Range arg1, Range arg2, Range arg3, Range arg4)
Range	union(Range arg1, Range arg2, Range arg3, Range arg4, Range arg5)
boolean	wait(java.util.Date time)

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Excel

public Excel()
      throws ComponentObjectModelException,
             LibraryNotFoundException

Starts a new Excel application and connects to it.

Throws:

ComponentObjectModelException, - LibraryNotFoundException

ComponentObjectModelException

LibraryNotFoundException

Method Detail

setLibraryPath

public static void setLibraryPath(java.lang.String pFilePath)
                           throws ComponentObjectModelException

Sets the path to the native DLL library file (moyocore.dll).

If the library file is not in a location defined by the java.library.path system property, this method can be used to specify the exact location of the file.

Alternatively, the java.library.path property can be defined when launching the Java application:
java -Djava.library.path=[Folder where the library file is] ...

This static method has to be called BEFORE creating an instance of the Excel object.

Usage example:

Excel.setLibraryPath("c:\\moyocore.dll");
Excel excel = new Excel();
//...
excel.dispose();


Throws:

ComponentObjectModelException - if the library is already loaded.

createInstance

public static Excel createInstance(ComManager comManager)
                            throws ComponentObjectModelException,
                                   LibraryNotFoundException

ComponentObjectModelException

LibraryNotFoundException

getRunningExcelApplication

public static Excel getRunningExcelApplication(ComManager comManager)
                                        throws ComponentObjectModelException,
                                               LibraryNotFoundException

Connects to an already running Excel application.

If multiple Excel applications are running, the first one is returned. If Excel isn't running, this method returns null.

Parameters:

comManager - The COM manager used to access the Excel application.

Throws:

ComponentObjectModelException, - LibraryNotFoundException

ComponentObjectModelException

LibraryNotFoundException

getRunningExcelApplication

public static Excel getRunningExcelApplication()
                                        throws ComponentObjectModelException,
                                               LibraryNotFoundException

Connects to an already running Excel application.

If multiple Excel applications are running, the first one is returned. If Excel isn't running, this method returns null.

Throws:

ComponentObjectModelException, - LibraryNotFoundException

ComponentObjectModelException

LibraryNotFoundException

getRunningExcelApplications

public static Excel[] getRunningExcelApplications(ComManager comManager)
                                           throws ComponentObjectModelException,
                                                  LibraryNotFoundException

Connects to all running Excel applications.

If Excel isn't running, this method returns null.

Parameters:

comManager - The COM manager used to access the Excel application.

Throws:

ComponentObjectModelException, - LibraryNotFoundException

ComponentObjectModelException

LibraryNotFoundException

getRunningExcelApplications

public static Excel[] getRunningExcelApplications()
                                           throws ComponentObjectModelException,
                                                  LibraryNotFoundException

Connects to all running Excel applications.

If Excel isn't running, this method returns null.

Throws:

ComponentObjectModelException, - LibraryNotFoundException

ComponentObjectModelException

LibraryNotFoundException

getApplicationDispatch

public Dispatch getApplicationDispatch()

dispose

public void dispose()

Disposes the native resources used by the library, closes all workbooks (without saving changes), quits and disconnects from the Excel application. Same as calling dispose(true).

dispose

public void dispose(boolean quitIfHidden)

Disposes the native resources used by the library and disconnects from the Excel application.

Parameters:

quitIfHidden - If true, closes all workbooks (without saving changes) and quits the Excel application if Excel is not visible. If false, only disposes native resources (the Excel.exe process may remain running).

createWorkbook

public Workbook createWorkbook()

Creates a new Workbook. This method is equivalent to:
getWorkbooks().add()

openWorkbook

public Workbook openWorkbook(java.io.File file)

Open an existing Workbook Excel document.

getActiveCell

public Range getActiveCell()

getActiveChart

public Chart getActiveChart()

getActiveDialog

public DialogSheet getActiveDialog()

getActiveMenuBar

public MenuBar getActiveMenuBar()

getActivePrinter

public java.lang.String getActivePrinter()

setActivePrinter

public void setActivePrinter(java.lang.String value)

getActiveSheet

public Sheet getActiveSheet()

getActiveWindow

public Window getActiveWindow()

getActiveWorkbook

public Workbook getActiveWorkbook()

getAddIns

public AddIns getAddIns()

calculate

public void calculate()

getCells

public Range getCells()

getCharts

public Sheets getCharts()

getColumns

public Range getColumns()

getDDEAppReturnCode

public int getDDEAppReturnCode()

DDEExecute

public void DDEExecute(int channel,
                       java.lang.String message)

DDEInitiate

public int DDEInitiate(java.lang.String app,
                       java.lang.String topic)

DDETerminate

public void DDETerminate(int channel)

getDialogSheets

public Sheets getDialogSheets()

evaluate

public java.lang.Object evaluate(java.lang.String name)

intersect

public Range intersect(Range range1,
                       Range range2)

intersect

public Range intersect(Range range1,
                       Range range2,
                       Range range3)

intersect

public Range intersect(Range range1,
                       Range range2,
                       Range range3,
                       Range range4)

intersect

public Range intersect(Range range1,
                       Range range2,
                       Range range3,
                       Range range4,
                       Range range5)

getMenuBars

public MenuBars getMenuBars()

getNames

public Names getNames()

getRange

public Range getRange(java.lang.String cell)

getRows

public Range getRows()

runMacro

public java.lang.Object runMacro(java.lang.String macroName)

runMacro

public java.lang.Object runMacro(java.lang.String macroName,
                                 java.lang.Object[] parameters)

getSelection

public java.lang.Object getSelection()

sendKeys

public void sendKeys(java.lang.String keys)

sendKeys

public void sendKeys(java.lang.String keys,
                     boolean wait)

getSheets

public Sheets getSheets()

getThisWorkbook

public Workbook getThisWorkbook()

getToolbars

public Toolbars getToolbars()

union

public Range union(Range arg1,
                   Range arg2)

union

public Range union(Range arg1,
                   Range arg2,
                   Range arg3)

union

public Range union(Range arg1,
                   Range arg2,
                   Range arg3,
                   Range arg4)

union

public Range union(Range arg1,
                   Range arg2,
                   Range arg3,
                   Range arg4,
                   Range arg5)

getWindows

public Windows getWindows()

getWorkbooks

public Workbooks getWorkbooks()

getWorksheetFunction

public WorksheetFunction getWorksheetFunction()

getWorksheets

public Sheets getWorksheets()

getExcel4IntlMacroSheets

public Sheets getExcel4IntlMacroSheets()

getExcel4MacroSheets

public Sheets getExcel4MacroSheets()

activateMicrosoftApp

public void activateMicrosoftApp(MSApplication value)

addChartAutoFormat

public void addChartAutoFormat(Chart chart,
                               java.lang.String name)

addChartAutoFormat

public void addChartAutoFormat(Chart chart,
                               java.lang.String name,
                               java.lang.String description)

addCustomList

public void addCustomList(Range listArray)

addCustomList

public void addCustomList(Range listArray,
                          boolean byRow)

addCustomList

public void addCustomList(java.lang.String[] listArray)

isAlertBeforeOverwriting

public boolean isAlertBeforeOverwriting()

setAlertBeforeOverwriting

public void setAlertBeforeOverwriting(boolean value)

getAltStartupPath

public java.lang.String getAltStartupPath()

setAltStartupPath

public void setAltStartupPath(java.lang.String value)

isAskToUpdateLinks

public boolean isAskToUpdateLinks()

setAskToUpdateLinks

public void setAskToUpdateLinks(boolean value)

isEnableAnimations

public boolean isEnableAnimations()

setEnableAnimations

public void setEnableAnimations(boolean value)

getAutoCorrect

public AutoCorrect getAutoCorrect()

getBuild

public int getBuild()

isCalculateBeforeSave

public boolean isCalculateBeforeSave()

setCalculateBeforeSave

public void setCalculateBeforeSave(boolean value)

getCalculation

public Calculation getCalculation()

setCalculation

public void setCalculation(Calculation value)

isCanPlaySounds

public boolean isCanPlaySounds()

isCanRecordSounds

public boolean isCanRecordSounds()

getCaption

public java.lang.String getCaption()

setCaption

public void setCaption(java.lang.String value)

isCellDragAndDrop

public boolean isCellDragAndDrop()

setCellDragAndDrop

public void setCellDragAndDrop(boolean value)

centimetersToPoints

public double centimetersToPoints(double value)

checkSpelling

public boolean checkSpelling(java.lang.String word)

checkSpelling

public boolean checkSpelling(java.lang.String word,
                             java.lang.String customDictionaryFilename)

checkSpelling

public boolean checkSpelling(java.lang.String word,
                             java.lang.String customDictionaryFilename,
                             boolean ignoreUppercase)

isDisplayClipboardWindow

public boolean isDisplayClipboardWindow()

setDisplayClipboardWindow

public void setDisplayClipboardWindow(boolean value)

isColorButtons

public boolean isColorButtons()

setColorButtons

public void setColorButtons(boolean value)

getCommandUnderlines

public CommandUnderlines getCommandUnderlines()

setCommandUnderlines

public void setCommandUnderlines(CommandUnderlines value)

isConstrainNumeric

public boolean isConstrainNumeric()

setConstrainNumeric

public void setConstrainNumeric(boolean value)

convertFormula

public java.lang.String convertFormula(java.lang.String formula,
                                       ReferenceStyle fromReferenceStyle)

convertFormula

public java.lang.String convertFormula(java.lang.String formula,
                                       ReferenceStyle fromReferenceStyle,
                                       ReferenceStyle toReferenceStyle)

convertFormula

public java.lang.String convertFormula(java.lang.String formula,
                                       ReferenceStyle fromReferenceStyle,
                                       ReferenceStyle toReferenceStyle,
                                       ReferenceStyle toAbsolute)

convertFormula

public java.lang.String convertFormula(java.lang.String formula,
                                       ReferenceStyle fromReferenceStyle,
                                       ReferenceStyle toReferenceStyle,
                                       ReferenceStyle toAbsolute,
                                       Range relativeTo)

isCopyObjectsWithCells

public boolean isCopyObjectsWithCells()

setCopyObjectsWithCells

public void setCopyObjectsWithCells(boolean value)

getCursor

public MousePointer getCursor()

setCursor

public void setCursor(MousePointer value)

getCustomListCount

public int getCustomListCount()

getCutCopyMode

public CutCopyMode getCutCopyMode()

setCutCopyMode

public void setCutCopyMode(CutCopyMode value)

getDataEntryMode

public int getDataEntryMode()

setDataEntryMode

public void setDataEntryMode(int value)

getDefaultFilePath

public java.lang.String getDefaultFilePath()

setDefaultFilePath

public void setDefaultFilePath(java.lang.String value)

deleteChartAutoFormat

public void deleteChartAutoFormat(java.lang.String name)

deleteCustomList

public void deleteCustomList(int listNum)

getDialogs

public Dialogs getDialogs()

isDisplayAlerts

public boolean isDisplayAlerts()

setDisplayAlerts

public void setDisplayAlerts(boolean value)

isDisplayFormulaBar

public boolean isDisplayFormulaBar()

setDisplayFormulaBar

public void setDisplayFormulaBar(boolean value)

isDisplayFullScreen

public boolean isDisplayFullScreen()

setDisplayFullScreen

public void setDisplayFullScreen(boolean value)

isDisplayNoteIndicator

public boolean isDisplayNoteIndicator()

setDisplayNoteIndicator

public void setDisplayNoteIndicator(boolean value)

getDisplayCommentIndicator

public CommentDisplayMode getDisplayCommentIndicator()

setDisplayCommentIndicator

public void setDisplayCommentIndicator(CommentDisplayMode value)

isDisplayExcel4Menus

public boolean isDisplayExcel4Menus()

setDisplayExcel4Menus

public void setDisplayExcel4Menus(boolean value)

isDisplayRecentFiles

public boolean isDisplayRecentFiles()

setDisplayRecentFiles

public void setDisplayRecentFiles(boolean value)

isDisplayScrollBars

public boolean isDisplayScrollBars()

setDisplayScrollBars

public void setDisplayScrollBars(boolean value)

isDisplayStatusBar

public boolean isDisplayStatusBar()

setDisplayStatusBar

public void setDisplayStatusBar(boolean value)

doubleClick

public void doubleClick()

isEditDirectlyInCell

public boolean isEditDirectlyInCell()

setEditDirectlyInCell

public void setEditDirectlyInCell(boolean value)

isEnableAutoComplete

public boolean isEnableAutoComplete()

setEnableAutoComplete

public void setEnableAutoComplete(boolean value)

getEnableCancelKey

public EnableCancelKey getEnableCancelKey()

setEnableCancelKey

public void setEnableCancelKey(EnableCancelKey value)

isEnableSound

public boolean isEnableSound()

setEnableSound

public void setEnableSound(boolean value)

isEnableTipWizard

public boolean isEnableTipWizard()

setEnableTipWizard

public void setEnableTipWizard(boolean value)

isFixedDecimal

public boolean isFixedDecimal()

setFixedDecimal

public void setFixedDecimal(boolean value)

getFixedDecimalPlaces

public int getFixedDecimalPlaces()

setFixedDecimalPlaces

public void setFixedDecimalPlaces(int value)

getCustomListContents

public java.lang.String[] getCustomListContents(int listNum)

getCustomListNum

public int getCustomListNum(java.lang.String[] customList)

getOpenFilename

public java.lang.String getOpenFilename()

getOpenFilename

public java.lang.String getOpenFilename(java.lang.String fileFilter)

getOpenFilename

public java.lang.String getOpenFilename(java.lang.String fileFilter,
                                        int filterIndex)

getOpenFilename

public java.lang.String getOpenFilename(java.lang.String fileFilter,
                                        int filterIndex,
                                        java.lang.String title)

getSaveAsFilename

public java.lang.String getSaveAsFilename()

getSaveAsFilename

public java.lang.String getSaveAsFilename(java.lang.String initialFilename)

getSaveAsFilename

public java.lang.String getSaveAsFilename(java.lang.String initialFilename,
                                          java.lang.String fileFilter)

getSaveAsFilename

public java.lang.String getSaveAsFilename(java.lang.String initialFilename,
                                          java.lang.String fileFilter,
                                          int filterIndex)

getSaveAsFilename

public java.lang.String getSaveAsFilename(java.lang.String initialFilename,
                                          java.lang.String fileFilter,
                                          int filterIndex,
                                          java.lang.String title)

goTo

public void goTo()

goTo

public void goTo(Range reference)

goTo

public void goTo(Range reference,
                 boolean scroll)

goTo

public void goTo(java.lang.String reference)

goTo

public void goTo(java.lang.String reference,
                 boolean scroll)

getHeight

public double getHeight()

setHeight

public void setHeight(double value)

help

public void help()

isIgnoreRemoteRequests

public boolean isIgnoreRemoteRequests()

setIgnoreRemoteRequests

public void setIgnoreRemoteRequests(boolean value)

inchesToPoints

public double inchesToPoints(double inches)

inputBox

public java.lang.String inputBox(java.lang.String prompt)

inputBox

public java.lang.String inputBox(java.lang.String prompt,
                                 java.lang.String title)

inputBox

public java.lang.String inputBox(java.lang.String prompt,
                                 java.lang.String title,
                                 java.lang.String defaultValue)

inputBox

public java.lang.String inputBox(java.lang.String prompt,
                                 java.lang.String title,
                                 java.lang.String defaultValue,
                                 int left)

inputBox

public java.lang.String inputBox(java.lang.String prompt,
                                 java.lang.String title,
                                 java.lang.String defaultValue,
                                 int left,
                                 int top)

inputBox

public java.lang.String inputBox(java.lang.String prompt,
                                 java.lang.String title,
                                 java.lang.String defaultValue,
                                 int left,
                                 int top,
                                 java.lang.String helpFile)

inputBox

public 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)

inputBox

public 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)

isInteractive

public boolean isInteractive()

setInteractive

public void setInteractive(boolean value)

getInternationalString

public java.lang.String getInternationalString(ApplicationInternational index)

getInternationalInt

public int getInternationalInt(ApplicationInternational index)

getInternationalBoolean

public boolean getInternationalBoolean(ApplicationInternational index)

isIteration

public boolean isIteration()

setIteration

public void setIteration(boolean value)

isLargeButtons

public boolean isLargeButtons()

setLargeButtons

public void setLargeButtons(boolean value)

getLeft

public double getLeft()

setLeft

public void setLeft(double value)

getLibraryPath

public java.lang.String getLibraryPath()

macroOptions

public void macroOptions()

macroOptions

public void macroOptions(java.lang.String macro)

macroOptions

public void macroOptions(java.lang.String macro,
                         java.lang.String description)

macroOptions

public void macroOptions(java.lang.String macro,
                         java.lang.String description,
                         int category)

macroOptions

public void macroOptions(java.lang.String macro,
                         java.lang.String description,
                         int category,
                         java.lang.String statusBar)

macroOptions

public void macroOptions(java.lang.String macro,
                         java.lang.String description,
                         int category,
                         java.lang.String statusBar,
                         int helpContextID)

macroOptions

public void macroOptions(java.lang.String macro,
                         java.lang.String description,
                         int category,
                         java.lang.String statusBar,
                         int helpContextID,
                         java.lang.String helpFile)

isMathCoprocessorAvailable

public boolean isMathCoprocessorAvailable()

getMaxChange

public double getMaxChange()

setMaxChange

public void setMaxChange(double value)

getMaxIterations

public int getMaxIterations()

setMaxIterations

public void setMaxIterations(int value)

getMemoryFree

public int getMemoryFree()

getMemoryTotal

public int getMemoryTotal()

getMemoryUsed

public int getMemoryUsed()

isMouseAvailable

public boolean isMouseAvailable()

isMoveAfterReturn

public boolean isMoveAfterReturn()

setMoveAfterReturn

public void setMoveAfterReturn(boolean value)

getMoveAfterReturnDirection

public Direction getMoveAfterReturnDirection()

setMoveAfterReturnDirection

public void setMoveAfterReturnDirection(Direction value)

getRecentFiles

public RecentFiles getRecentFiles()

getName

public java.lang.String getName()

nextLetter

public Workbook nextLetter()

getNetworkTemplatesPath

public java.lang.String getNetworkTemplatesPath()

getODBCTimeout

public int getODBCTimeout()

setODBCTimeout

public void setODBCTimeout(int value)

getOnCalculate

public java.lang.String getOnCalculate()

setOnCalculate

public void setOnCalculate(java.lang.String value)

getOnData

public java.lang.String getOnData()

setOnData

public void setOnData(java.lang.String value)

getOnDoubleClick

public java.lang.String getOnDoubleClick()

setOnDoubleClick

public void setOnDoubleClick(java.lang.String value)

getOnEntry

public java.lang.String getOnEntry()

setOnEntry

public void setOnEntry(java.lang.String value)

onKey

public void onKey(java.lang.String key)

onKey

public void onKey(java.lang.String key,
                  java.lang.String procedureName)

onRepeat

public void onRepeat(java.lang.String text,
                     java.lang.String procedureName)

getOnSheetActivate

public java.lang.String getOnSheetActivate()

setOnSheetActivate

public void setOnSheetActivate(java.lang.String value)

getOnSheetDeactivate

public java.lang.String getOnSheetDeactivate()

setOnSheetDeactivate

public void setOnSheetDeactivate(java.lang.String value)

onTime

public void onTime(java.util.Date earliestTime,
                   java.lang.String procedureName)

onTime

public void onTime(java.util.Date earliestTime,
                   java.lang.String procedureName,
                   java.util.Date latestTime)

onTime

public void onTime(java.util.Date earliestTime,
                   java.lang.String procedureName,
                   java.util.Date latestTime,
                   boolean scheduleNew)

onUndo

public void onUndo(java.lang.String text,
                   java.lang.String procedureName)

getOnWindow

public java.lang.String getOnWindow()

setOnWindow

public void setOnWindow(java.lang.String value)

getOperatingSystem

public java.lang.String getOperatingSystem()

getOrganizationName

public java.lang.String getOrganizationName()

getPath

public java.lang.String getPath()

getPathSeparator

public java.lang.String getPathSeparator()

isPivotTableSelection

public boolean isPivotTableSelection()

setPivotTableSelection

public void setPivotTableSelection(boolean value)

isPromptForSummaryInfo

public boolean isPromptForSummaryInfo()

setPromptForSummaryInfo

public void setPromptForSummaryInfo(boolean value)

quit

public void quit()

recordMacro

public void recordMacro()

recordMacro

public void recordMacro(java.lang.String basicCode)

isRecordRelative

public boolean isRecordRelative()

getReferenceStyle

public ReferenceStyle getReferenceStyle()

setReferenceStyle

public void setReferenceStyle(ReferenceStyle value)

registerXLL

public boolean registerXLL(java.io.File file)

repeat

public void repeat()

resetTipWizard

public void resetTipWizard()

isRollZoom

public boolean isRollZoom()

setRollZoom

public void setRollZoom(boolean value)

save

public void save()

save

public void save(java.io.File file)

saveWorkspace

public void saveWorkspace()

saveWorkspace

public void saveWorkspace(java.io.File file)

isScreenUpdating

public boolean isScreenUpdating()

setScreenUpdating

public void setScreenUpdating(boolean value)

setDefaultChart

public void setDefaultChart()

setDefaultChart

public void setDefaultChart(java.lang.String formatName)

getSheetsInNewWorkbook

public int getSheetsInNewWorkbook()

setSheetsInNewWorkbook

public void setSheetsInNewWorkbook(int value)

isShowChartTipNames

public boolean isShowChartTipNames()

setShowChartTipNames

public void setShowChartTipNames(boolean value)

isShowChartTipValues

public boolean isShowChartTipValues()

setShowChartTipValues

public void setShowChartTipValues(boolean value)

getStandardFont

public java.lang.String getStandardFont()

setStandardFont

public void setStandardFont(java.lang.String value)

getStandardFontSize

public double getStandardFontSize()

setStandardFontSize

public void setStandardFontSize(double value)

getStartupPath

public java.lang.String getStartupPath()

getStatusBar

public java.lang.String getStatusBar()

setStatusBar

public void setStatusBar(java.lang.String text)

setStatusBarToDefaultText

public void setStatusBarToDefaultText()

getTemplatesPath

public java.lang.String getTemplatesPath()

isShowToolTips

public boolean isShowToolTips()

setShowToolTips

public void setShowToolTips(boolean value)

getTop

public double getTop()

setTop

public void setTop(double value)

getDefaultSaveFormat

public FileFormat getDefaultSaveFormat()

setDefaultSaveFormat

public void setDefaultSaveFormat(FileFormat value)

getTransitionMenuKey

public java.lang.String getTransitionMenuKey()

setTransitionMenuKey

public void setTransitionMenuKey(java.lang.String value)

getTransitionMenuKeyAction

public int getTransitionMenuKeyAction()

setTransitionMenuKeyAction

public void setTransitionMenuKeyAction(int value)

isTransitionNavigKeys

public boolean isTransitionNavigKeys()

setTransitionNavigKeys

public void setTransitionNavigKeys(boolean value)

undo

public void undo()

getUsableHeight

public double getUsableHeight()

getUsableWidth

public double getUsableWidth()

isUserControl

public boolean isUserControl()

setUserControl

public void setUserControl(boolean value)

getUserName

public java.lang.String getUserName()

setUserName

public void setUserName(java.lang.String value)

getValue

public java.lang.String getValue()

getVersion

public java.lang.String getVersion()

isVisible

public boolean isVisible()

setVisible

public void setVisible(boolean value)

setVolatile

public void setVolatile()

setVolatile

public void setVolatile(boolean isVolatile)

getWidth

public double getWidth()

setWidth

public void setWidth(double value)

isWindowsForPens

public boolean isWindowsForPens()

getWindowState

public WindowState getWindowState()

setWindowState

public void setWindowState(WindowState value)

getUILanguage

public int getUILanguage()

setUILanguage

public void setUILanguage(int value)

getDefaultSheetDirection

public int getDefaultSheetDirection()

setDefaultSheetDirection

public void setDefaultSheetDirection(int value)

getCursorMovement

public int getCursorMovement()

setCursorMovement

public void setCursorMovement(int value)

isControlCharacters

public boolean isControlCharacters()

setControlCharacters

public void setControlCharacters(boolean value)

isEnableEvents

public boolean isEnableEvents()

setEnableEvents

public void setEnableEvents(boolean value)

isDisplayInfoWindow

public boolean isDisplayInfoWindow()

setDisplayInfoWindow

public void setDisplayInfoWindow(boolean value)

wait

public boolean wait(java.util.Date time)

isExtendList

public boolean isExtendList()

setExtendList

public void setExtendList(boolean value)

getPhonetic

public java.lang.String getPhonetic()

getPhonetic

public java.lang.String getPhonetic(java.lang.String text)

getDefaultWebOptions

public DefaultWebOptions getDefaultWebOptions()

getProductCode

public java.lang.String getProductCode()

getUserLibraryPath

public java.lang.String getUserLibraryPath()

isAutoPercentEntry

public boolean isAutoPercentEntry()

setAutoPercentEntry

public void setAutoPercentEntry(boolean value)

calculateFull

public void calculateFull()

findFile

public boolean findFile()

getCalculationVersion

public int getCalculationVersion()

isShowWindowsInTaskbar

public boolean isShowWindowsInTaskbar()

setShowWindowsInTaskbar

public void setShowWindowsInTaskbar(boolean value)

isReady

public boolean isReady()

getFindFormat

public CellFormat getFindFormat()

setFindFormat

public void setFindFormat(CellFormat value)

getReplaceFormat

public CellFormat getReplaceFormat()

setReplaceFormat

public void setReplaceFormat(CellFormat value)

getCalculationState

public CalculationState getCalculationState()

getCalculationInterruptKey

public CalculationInterruptKey getCalculationInterruptKey()

setCalculationInterruptKey

public void setCalculationInterruptKey(CalculationInterruptKey value)

getWatches

public Watches getWatches()

isDisplayFunctionToolTips

public boolean isDisplayFunctionToolTips()

setDisplayFunctionToolTips

public void setDisplayFunctionToolTips(boolean value)

getAutomationSecurity

public int getAutomationSecurity()

Returns the current automation security. Possible values are:

1 = msoAutomationSecurityLow
2 = msoAutomationSecurityByUI
3 = msoAutomationSecurityForceDisable

MsoAutomationSecurityLow turns on all macros and is the default value when you start the program. MsoAutomationSecurityForceDisable disables all macros in all files that are opened programmatically, without showing any security warnings. MsoAutomationSecurityByUI uses the security setting that is controlled in the Security dialog box (on the Tools menu, point to Macro, and then click Security).

setAutomationSecurity

public void setAutomationSecurity(int value)

Assign the specified automation security. Possible values are:

1 = msoAutomationSecurityLow
2 = msoAutomationSecurityByUI
3 = msoAutomationSecurityForceDisable

MsoAutomationSecurityLow turns on all macros and is the default value when you start the program. MsoAutomationSecurityForceDisable disables all macros in all files that are opened programmatically, without showing any security warnings. MsoAutomationSecurityByUI uses the security setting that is controlled in the Security dialog box (on the Tools menu, point to Macro, and then click Security).

calculateFullRebuild

public void calculateFullRebuild()

isDisplayPasteOptions

public boolean isDisplayPasteOptions()

setDisplayPasteOptions

public void setDisplayPasteOptions(boolean value)

isDisplayInsertOptions

public boolean isDisplayInsertOptions()

setDisplayInsertOptions

public void setDisplayInsertOptions(boolean value)

isGenerateGetPivotData

public boolean isGenerateGetPivotData()

setGenerateGetPivotData

public void setGenerateGetPivotData(boolean value)

getAutoRecover

public AutoRecover getAutoRecover()

checkAbort

public void checkAbort()

checkAbort

public void checkAbort(Range keepAbort)

getErrorCheckingOptions

public ErrorCheckingOptions getErrorCheckingOptions()

isAutoFormatAsYouTypeReplaceHyperlinks

public boolean isAutoFormatAsYouTypeReplaceHyperlinks()

setAutoFormatAsYouTypeReplaceHyperlinks

public void setAutoFormatAsYouTypeReplaceHyperlinks(boolean value)

getSmartTagRecognizers

public SmartTagRecognizers getSmartTagRecognizers()

getSpellingOptions

public SpellingOptions getSpellingOptions()

isMapPaperSize

public boolean isMapPaperSize()

setMapPaperSize

public void setMapPaperSize(boolean value)

isShowStartupDialog

public boolean isShowStartupDialog()

setShowStartupDialog

public void setShowStartupDialog(boolean value)

getDecimalSeparator

public java.lang.String getDecimalSeparator()

setDecimalSeparator

public void setDecimalSeparator(java.lang.String value)

getThousandsSeparator

public java.lang.String getThousandsSeparator()

setThousandsSeparator

public void setThousandsSeparator(java.lang.String value)

isUseSystemSeparators

public boolean isUseSystemSeparators()

setUseSystemSeparators

public void setUseSystemSeparators(boolean value)

getThisCell

public Range getThisCell()

getRTD

public RTD getRTD()

isDisplayDocumentActionTaskPane

public boolean isDisplayDocumentActionTaskPane()

setDisplayDocumentActionTaskPane

public void setDisplayDocumentActionTaskPane(boolean value)

displayXMLSourcePane

public void displayXMLSourcePane()

displayXMLSourcePane

public void displayXMLSourcePane(XmlMap xmlMap)

isArbitraryXMLSupportAvailable

public boolean isArbitraryXMLSupportAvailable()