com.moyosoft.connector.ms.excel
Class Workbook

java.lang.Object
  |
  +--com.moyosoft.connector.ms.excel.Workbook

public class Workbook

extends java.lang.Object

Constructor Summary

Workbook(Dispatch dispatch)

Method Summary

void	acceptAllChanges()
void	acceptAllChanges(java.lang.String when)
void	acceptAllChanges(java.lang.String when, java.lang.String who)
void	acceptAllChanges(java.lang.String when, java.lang.String who, java.lang.String where)
void	activate()
void	addToFavorites()
void	breakLink(java.lang.String name, LinkType value)
boolean	canCheckIn()
void	changeFileAccess(FileAccess mode)
void	changeFileAccess(FileAccess mode, java.lang.String writePassword)
void	changeFileAccess(FileAccess mode, java.lang.String writePassword, boolean notify)
void	changeLink(java.lang.String name, java.lang.String newName)
void	changeLink(java.lang.String name, java.lang.String newName, LinkType value)
void	checkIn()
void	checkIn(boolean saveChanges)
void	checkIn(boolean saveChanges, java.lang.String comments)
void	checkIn(boolean saveChanges, java.lang.String comments, boolean makePublic)
void	close()
void	close(boolean saveChanges)
void	close(boolean saveChanges, java.io.File file)
void	close(boolean saveChanges, java.io.File file, boolean routeWorkbook)
void	deleteNumberFormat(java.lang.String value)
void	endReview()
boolean	exclusiveAccess()
void	followHyperlink(java.lang.String address)
void	followHyperlink(java.lang.String address, java.lang.String subAddress)
void	followHyperlink(java.lang.String address, java.lang.String subAddress, boolean newWindow)
void	followHyperlink(java.lang.String address, java.lang.String subAddress, boolean newWindow, java.lang.String extraInfo)
void	forwardMailer()
Chart	getActiveChart()
Sheet	getActiveSheet()
Worksheet	getActiveWorksheet()
java.lang.String	getAuthor()
int	getAutoUpdateFrequency()
int	getCalculationVersion()
int	getChangeHistoryDuration()
Sheets	getCharts()
java.lang.String	getCodeName()
int	getColor(int index)
int[]	getColors() Returns the palette of 56 colors, each represented by an RGB value
java.lang.String	getComments()
SaveConflictResolution	getConflictResolution()
CustomViews	getCustomViews()
Sheets	getDialogSheets()
Dispatch	getDispatch()
DisplayDrawingObjects	getDisplayDrawingObjects()
Sheets	getExcel4IntlMacroSheets()
Sheets	getExcel4MacroSheets()
FileFormat	getFileFormat()
java.lang.String	getFullName()
java.lang.String	getFullNameURLEncoded()
java.lang.String	getKeywords()
Sheets	getModules()
java.lang.String	getName()
Names	getNames()
java.lang.String	getPassword()
java.lang.String	getPasswordEncryptionAlgorithm()
int	getPasswordEncryptionKeyLength()
java.lang.String	getPasswordEncryptionProvider()
java.lang.String	getPath()
PublishObjects	getPublishObjects()
int	getRevisionNumber()
Sheets	getSheets()
SmartTagOptions	getSmartTagOptions()
Styles	getStyles()
java.lang.String	getSubject()
java.lang.String	getTitle()
UpdateLinks	getUpdateLinks()
WebOptions	getWebOptions()
Windows	getWindows()
Sheets	getWorksheets()
java.lang.String	getWritePassword()
java.lang.String	getWriteReservedBy()
XmlMaps	getXmlMaps()
XmlNamespaces	getXmlNamespaces()
boolean	hasMailer()
boolean	hasPassword()
boolean	hasRoutingSlip()
boolean	isAcceptLabelsInFormulas()
boolean	isAddin()
boolean	isAutoUpdateSaveChanges()
boolean	isCreateBackup()
boolean	isDisplayInkComments()
boolean	isEnableAutoRecover()
boolean	isEnvelopeVisible()
boolean	isHighlightChangesOnScreen()
boolean	isInactiveListBorderVisible()
boolean	isInplace()
boolean	isKeepChangeHistory()
boolean	isListChangesOnNewSheet()
boolean	isMultiUserEditing()
boolean	isPersonalViewListSettings()
boolean	isPersonalViewPrintSettings()
boolean	isPrecisionAsDisplayed()
boolean	isReadOnly()
boolean	isReadOnlyRecommended()
boolean	isRemovePersonalInformation()
boolean	isRouted()
boolean	isSaved()
boolean	isSaveLinkValues()
boolean	isShowConflictHistory()
boolean	isShowPivotTableFieldList()
boolean	isTemplateRemoveExtData()
boolean	isUpdateRemoteReferences()
boolean	isUserControl()
boolean	isUsing1904DateSystem()
boolean	isVBASigned()
boolean	isWriteReserved()
java.lang.String[]	linkSources()
java.lang.String[]	linkSources(Link linkType)
void	mergeWorkbook(java.io.File file)
Window	newWindow()
void	openLinks(java.lang.String name)
void	openLinks(java.lang.String name, boolean readOnly)
void	openLinks(java.lang.String name, boolean readOnly, Link type)
void	printPreview()
void	protect()
void	protect(java.lang.String password)
void	purgeChangeHistoryNow(int days)
void	purgeChangeHistoryNow(int days, java.lang.String sharingPassword)
void	recheckSmartTags()
void	refreshAll()
void	rejectAllChanges()
void	rejectAllChanges(java.lang.String when)
void	rejectAllChanges(java.lang.String when, java.lang.String who)
void	rejectAllChanges(java.lang.String when, java.lang.String who, java.lang.String where)
void	reply()
void	replyAll()
void	resetColors()
void	route()
void	runAutoMacros(RunAutoMacro value)
void	save()
void	saveAs()
void	saveAs(java.io.File file)
void	saveAs(java.io.File file, FileFormat fileFormat)
void	saveAs(java.io.File file, FileFormat fileFormat, java.lang.String password)
void	saveAs(java.io.File file, FileFormat fileFormat, java.lang.String password, java.lang.String writeResPassword)
void	saveAs(java.io.File file, FileFormat fileFormat, java.lang.String password, java.lang.String writeResPassword, boolean readOnlyRecommended)
void	saveAs(java.io.File file, FileFormat fileFormat, java.lang.String password, java.lang.String writeResPassword, boolean readOnlyRecommended, boolean createBackup)
void	saveAs(java.io.File file, FileFormat fileFormat, java.lang.String password, java.lang.String writeResPassword, boolean readOnlyRecommended, boolean createBackup, SaveAsAccessMode accessMode)
void	saveAs(java.io.File file, FileFormat fileFormat, java.lang.String password, java.lang.String writeResPassword, boolean readOnlyRecommended, boolean createBackup, SaveAsAccessMode accessMode, SaveConflictResolution conflictResolution)
void	saveAs(java.io.File file, FileFormat fileFormat, java.lang.String password, java.lang.String writeResPassword, boolean readOnlyRecommended, boolean createBackup, SaveAsAccessMode accessMode, SaveConflictResolution conflictResolution, boolean addToMru)
void	saveAsXMLData(java.io.File file, XmlMap value)
void	saveCopyAs(java.io.File file)
void	setAcceptLabelsInFormulas(boolean value)
void	setAuthor(java.lang.String value)
void	setAutoUpdateFrequency(int value)
void	setAutoUpdateSaveChanges(boolean value)
void	setChangeHistoryDuration(int value)
void	setColors(int index, int color)
void	setComments(java.lang.String value)
void	setConflictResolution(SaveConflictResolution value)
void	setDisplayDrawingObjects(DisplayDrawingObjects value)
void	setDisplayInkComments(boolean value)
void	setEnableAutoRecover(boolean value)
void	setEnvelopeVisible(boolean value)
void	setHasMailer(boolean value)
void	setHasRoutingSlip(boolean value)
void	setHighlightChangesOnScreen(boolean value)
void	setInactiveListBorderVisible(boolean value)
void	setIsAddin(boolean value)
void	setKeepChangeHistory(boolean value)
void	setKeywords(java.lang.String value)
void	setLinkOnData(java.lang.String name)
void	setLinkOnData(java.lang.String name, java.lang.String procedure)
void	setListChangesOnNewSheet(boolean value)
void	setPassword(java.lang.String value)
void	setPersonalViewListSettings(boolean value)
void	setPersonalViewPrintSettings(boolean value)
void	setPrecisionAsDisplayed(boolean value)
void	setReadOnlyRecommended(boolean value)
void	setRemovePersonalInformation(boolean value)
void	setSaved(boolean value)
void	setSaveLinkValues(boolean value)
void	setShowConflictHistory(boolean value)
void	setShowPivotTableFieldList(boolean value)
void	setSubject(java.lang.String value)
void	setTemplateRemoveExtData(boolean value)
void	setTitle(java.lang.String value)
void	setUpdateLinks(UpdateLinks value)
void	setUpdateRemoteReferences(boolean value)
void	setUserControl(boolean value)
void	setUsing1904DateSystem(boolean value)
void	setWritePassword(java.lang.String value)
void	toggleFormsDesign()
void	unprotect()
void	unprotect(java.lang.String password)
void	unprotectSharing()
void	unprotectSharing(java.lang.String password)
void	updateFromFile()
void	updateLink()
void	updateLink(java.lang.String name)
void	updateLink(java.lang.String name, LinkType type)
void	webPagePreview()
XmlImportResult	xmlImport(java.lang.String url, XmlMap importMap)
XmlImportResult	xmlImport(java.lang.String url, XmlMap importMap, boolean overwrite)
XmlImportResult	xmlImport(java.lang.String url, XmlMap importMap, boolean overwrite, Range destination)
XmlImportResult	xmlImportXml(java.lang.String data, XmlMap importMap)
XmlImportResult	xmlImportXml(java.lang.String data, XmlMap importMap, boolean overwrite)
XmlImportResult	xmlImportXml(java.lang.String data, XmlMap importMap, boolean overwrite, Range destination)

Methods inherited from class java.lang.Object

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

Constructor Detail

Workbook

public Workbook(Dispatch dispatch)

Method Detail

getDispatch

public Dispatch getDispatch()

isAcceptLabelsInFormulas

public boolean isAcceptLabelsInFormulas()

setAcceptLabelsInFormulas

public void setAcceptLabelsInFormulas(boolean value)

activate

public void activate()

getActiveChart

public Chart getActiveChart()

getActiveSheet

public Sheet getActiveSheet()

getActiveWorksheet

public Worksheet getActiveWorksheet()

getAuthor

public java.lang.String getAuthor()

setAuthor

public void setAuthor(java.lang.String value)

getAutoUpdateFrequency

public int getAutoUpdateFrequency()

setAutoUpdateFrequency

public void setAutoUpdateFrequency(int value)

isAutoUpdateSaveChanges

public boolean isAutoUpdateSaveChanges()

setAutoUpdateSaveChanges

public void setAutoUpdateSaveChanges(boolean value)

getChangeHistoryDuration

public int getChangeHistoryDuration()

setChangeHistoryDuration

public void setChangeHistoryDuration(int value)

changeFileAccess

public void changeFileAccess(FileAccess mode)

changeFileAccess

public void changeFileAccess(FileAccess mode,
                             java.lang.String writePassword)

changeFileAccess

public void changeFileAccess(FileAccess mode,
                             java.lang.String writePassword,
                             boolean notify)

changeLink

public void changeLink(java.lang.String name,
                       java.lang.String newName)

changeLink

public void changeLink(java.lang.String name,
                       java.lang.String newName,
                       LinkType value)

getCharts

public Sheets getCharts()

close

public void close()

close

public void close(boolean saveChanges)

close

public void close(boolean saveChanges,
                  java.io.File file)

close

public void close(boolean saveChanges,
                  java.io.File file,
                  boolean routeWorkbook)

getCodeName

public java.lang.String getCodeName()

getColors

public int[] getColors()

Returns the palette of 56 colors, each represented by an RGB value

getColor

public int getColor(int index)

Parameters:

index - The color number (from 0 to 55)

setColors

public void setColors(int index,
                      int color)

getComments

public java.lang.String getComments()

setComments

public void setComments(java.lang.String value)

getConflictResolution

public SaveConflictResolution getConflictResolution()

setConflictResolution

public void setConflictResolution(SaveConflictResolution value)

isCreateBackup

public boolean isCreateBackup()

isUsing1904DateSystem

public boolean isUsing1904DateSystem()

setUsing1904DateSystem

public void setUsing1904DateSystem(boolean value)

deleteNumberFormat

public void deleteNumberFormat(java.lang.String value)

getDialogSheets

public Sheets getDialogSheets()

getDisplayDrawingObjects

public DisplayDrawingObjects getDisplayDrawingObjects()

setDisplayDrawingObjects

public void setDisplayDrawingObjects(DisplayDrawingObjects value)

exclusiveAccess

public boolean exclusiveAccess()

getFileFormat

public FileFormat getFileFormat()

forwardMailer

public void forwardMailer()

getFullName

public java.lang.String getFullName()

hasMailer

public boolean hasMailer()

setHasMailer

public void setHasMailer(boolean value)

hasPassword

public boolean hasPassword()

hasRoutingSlip

public boolean hasRoutingSlip()

setHasRoutingSlip

public void setHasRoutingSlip(boolean value)

isAddin

public boolean isAddin()

setIsAddin

public void setIsAddin(boolean value)

getKeywords

public java.lang.String getKeywords()

setKeywords

public void setKeywords(java.lang.String value)

linkSources

public java.lang.String[] linkSources()

linkSources

public java.lang.String[] linkSources(Link linkType)

mergeWorkbook

public void mergeWorkbook(java.io.File file)

getModules

public Sheets getModules()

isMultiUserEditing

public boolean isMultiUserEditing()

getName

public java.lang.String getName()

getNames

public Names getNames()

newWindow

public Window newWindow()

openLinks

public void openLinks(java.lang.String name)

openLinks

public void openLinks(java.lang.String name,
                      boolean readOnly)

openLinks

public void openLinks(java.lang.String name,
                      boolean readOnly,
                      Link type)

getPath

public java.lang.String getPath()

isPersonalViewListSettings

public boolean isPersonalViewListSettings()

setPersonalViewListSettings

public void setPersonalViewListSettings(boolean value)

isPersonalViewPrintSettings

public boolean isPersonalViewPrintSettings()

setPersonalViewPrintSettings

public void setPersonalViewPrintSettings(boolean value)

isPrecisionAsDisplayed

public boolean isPrecisionAsDisplayed()

setPrecisionAsDisplayed

public void setPrecisionAsDisplayed(boolean value)

printPreview

public void printPreview()

isReadOnly

public boolean isReadOnly()

refreshAll

public void refreshAll()

reply

public void reply()

replyAll

public void replyAll()

getRevisionNumber

public int getRevisionNumber()

route

public void route()

isRouted

public boolean isRouted()

runAutoMacros

public void runAutoMacros(RunAutoMacro value)

save

public void save()

saveCopyAs

public void saveCopyAs(java.io.File file)

isSaved

public boolean isSaved()

setSaved

public void setSaved(boolean value)

isSaveLinkValues

public boolean isSaveLinkValues()

setSaveLinkValues

public void setSaveLinkValues(boolean value)

setLinkOnData

public void setLinkOnData(java.lang.String name)

setLinkOnData

public void setLinkOnData(java.lang.String name,
                          java.lang.String procedure)

getSheets

public Sheets getSheets()

isShowConflictHistory

public boolean isShowConflictHistory()

setShowConflictHistory

public void setShowConflictHistory(boolean value)

getStyles

public Styles getStyles()

getSubject

public java.lang.String getSubject()

setSubject

public void setSubject(java.lang.String value)

getTitle

public java.lang.String getTitle()

setTitle

public void setTitle(java.lang.String value)

unprotect

public void unprotect()

unprotect

public void unprotect(java.lang.String password)

unprotectSharing

public void unprotectSharing()

unprotectSharing

public void unprotectSharing(java.lang.String password)

updateFromFile

public void updateFromFile()

updateLink

public void updateLink()

updateLink

public void updateLink(java.lang.String name)

updateLink

public void updateLink(java.lang.String name,
                       LinkType type)

isUpdateRemoteReferences

public boolean isUpdateRemoteReferences()

setUpdateRemoteReferences

public void setUpdateRemoteReferences(boolean value)

isUserControl

public boolean isUserControl()

setUserControl

public void setUserControl(boolean value)

getCustomViews

public CustomViews getCustomViews()

getWindows

public Windows getWindows()

getWorksheets

public Sheets getWorksheets()

isWriteReserved

public boolean isWriteReserved()

getWriteReservedBy

public java.lang.String getWriteReservedBy()

getExcel4IntlMacroSheets

public Sheets getExcel4IntlMacroSheets()

getExcel4MacroSheets

public Sheets getExcel4MacroSheets()

isTemplateRemoveExtData

public boolean isTemplateRemoveExtData()

setTemplateRemoveExtData

public void setTemplateRemoveExtData(boolean value)

isHighlightChangesOnScreen

public boolean isHighlightChangesOnScreen()

setHighlightChangesOnScreen

public void setHighlightChangesOnScreen(boolean value)

isKeepChangeHistory

public boolean isKeepChangeHistory()

setKeepChangeHistory

public void setKeepChangeHistory(boolean value)

isListChangesOnNewSheet

public boolean isListChangesOnNewSheet()

setListChangesOnNewSheet

public void setListChangesOnNewSheet(boolean value)

purgeChangeHistoryNow

public void purgeChangeHistoryNow(int days)

purgeChangeHistoryNow

public void purgeChangeHistoryNow(int days,
                                  java.lang.String sharingPassword)

acceptAllChanges

public void acceptAllChanges()

acceptAllChanges

public void acceptAllChanges(java.lang.String when)

acceptAllChanges

public void acceptAllChanges(java.lang.String when,
                             java.lang.String who)

acceptAllChanges

public void acceptAllChanges(java.lang.String when,
                             java.lang.String who,
                             java.lang.String where)

rejectAllChanges

public void rejectAllChanges()

rejectAllChanges

public void rejectAllChanges(java.lang.String when)

rejectAllChanges

public void rejectAllChanges(java.lang.String when,
                             java.lang.String who)

rejectAllChanges

public void rejectAllChanges(java.lang.String when,
                             java.lang.String who,
                             java.lang.String where)

resetColors

public void resetColors()

followHyperlink

public void followHyperlink(java.lang.String address)

followHyperlink

public void followHyperlink(java.lang.String address,
                            java.lang.String subAddress)

followHyperlink

public void followHyperlink(java.lang.String address,
                            java.lang.String subAddress,
                            boolean newWindow)

followHyperlink

public void followHyperlink(java.lang.String address,
                            java.lang.String subAddress,
                            boolean newWindow,
                            java.lang.String extraInfo)

addToFavorites

public void addToFavorites()

isInplace

public boolean isInplace()

webPagePreview

public void webPagePreview()

getPublishObjects

public PublishObjects getPublishObjects()

getWebOptions

public WebOptions getWebOptions()

isEnvelopeVisible

public boolean isEnvelopeVisible()

setEnvelopeVisible

public void setEnvelopeVisible(boolean value)

getCalculationVersion

public int getCalculationVersion()

isVBASigned

public boolean isVBASigned()

isShowPivotTableFieldList

public boolean isShowPivotTableFieldList()

setShowPivotTableFieldList

public void setShowPivotTableFieldList(boolean value)

getUpdateLinks

public UpdateLinks getUpdateLinks()

setUpdateLinks

public void setUpdateLinks(UpdateLinks value)

breakLink

public void breakLink(java.lang.String name,
                      LinkType value)

saveAs

public void saveAs()

saveAs

public void saveAs(java.io.File file)

saveAs

public void saveAs(java.io.File file,
                   FileFormat fileFormat)

saveAs

public void saveAs(java.io.File file,
                   FileFormat fileFormat,
                   java.lang.String password)

saveAs

public void saveAs(java.io.File file,
                   FileFormat fileFormat,
                   java.lang.String password,
                   java.lang.String writeResPassword)

saveAs

public void saveAs(java.io.File file,
                   FileFormat fileFormat,
                   java.lang.String password,
                   java.lang.String writeResPassword,
                   boolean readOnlyRecommended)

saveAs

public void saveAs(java.io.File file,
                   FileFormat fileFormat,
                   java.lang.String password,
                   java.lang.String writeResPassword,
                   boolean readOnlyRecommended,
                   boolean createBackup)

saveAs

public void saveAs(java.io.File file,
                   FileFormat fileFormat,
                   java.lang.String password,
                   java.lang.String writeResPassword,
                   boolean readOnlyRecommended,
                   boolean createBackup,
                   SaveAsAccessMode accessMode)

saveAs

public void saveAs(java.io.File file,
                   FileFormat fileFormat,
                   java.lang.String password,
                   java.lang.String writeResPassword,
                   boolean readOnlyRecommended,
                   boolean createBackup,
                   SaveAsAccessMode accessMode,
                   SaveConflictResolution conflictResolution)

saveAs

public void saveAs(java.io.File file,
                   FileFormat fileFormat,
                   java.lang.String password,
                   java.lang.String writeResPassword,
                   boolean readOnlyRecommended,
                   boolean createBackup,
                   SaveAsAccessMode accessMode,
                   SaveConflictResolution conflictResolution,
                   boolean addToMru)

isEnableAutoRecover

public boolean isEnableAutoRecover()

setEnableAutoRecover

public void setEnableAutoRecover(boolean value)

isRemovePersonalInformation

public boolean isRemovePersonalInformation()

setRemovePersonalInformation

public void setRemovePersonalInformation(boolean value)

getFullNameURLEncoded

public java.lang.String getFullNameURLEncoded()

checkIn

public void checkIn()

checkIn

public void checkIn(boolean saveChanges)

checkIn

public void checkIn(boolean saveChanges,
                    java.lang.String comments)

checkIn

public void checkIn(boolean saveChanges,
                    java.lang.String comments,
                    boolean makePublic)

canCheckIn

public boolean canCheckIn()

endReview

public void endReview()

getPassword

public java.lang.String getPassword()

setPassword

public void setPassword(java.lang.String value)

getWritePassword

public java.lang.String getWritePassword()

setWritePassword

public void setWritePassword(java.lang.String value)

getPasswordEncryptionProvider

public java.lang.String getPasswordEncryptionProvider()

getPasswordEncryptionAlgorithm

public java.lang.String getPasswordEncryptionAlgorithm()

getPasswordEncryptionKeyLength

public int getPasswordEncryptionKeyLength()

isReadOnlyRecommended

public boolean isReadOnlyRecommended()

setReadOnlyRecommended

public void setReadOnlyRecommended(boolean value)