Represents Microsoft Excel Application. More...

Inheritance diagram for wxAutoExcel::wxExcelApplication:

Public Types
enum	ExcelForWindowsVersions { evUnknown = 0 , evExcel2000 = 90 , evExcel2002 = 100 , evExcel2003 = 110 , evExcel2007 = 120 , evExcel2010 = 140 , evExcel2013 = 150 , evExcel2016 = 160 , evExcel2016or2019 = evExcel2016 }
	Constants for known MS Excel versions used by GetVersionAsEnum_() and IsVersionAtLeast_(). More...

Public Types inherited from wxAutoExcel::wxExcelObject
enum	ErrorFlags { Err_DoNothing = 0 , Err_LogOnInvalidDispatch = 1 , Err_AssertOnInvalidDispatch = 1 << 1 , Err_ThrowOnInvalidDispatch = 1 << 2 , Err_LogOnInvalidArgument = 1 << 3 , Err_AssertOnInvalidArgument = 1 << 4 , Err_ThrowOnInvalidArgument = 1 << 5 , Err_LogOnFailedInvoke = 1 << 6 , Err_AssertOnFailedInvoke = 1 << 7 , Err_ThrowOnFailedInvoke = 1 << 8 , Err_LogOnInvalidReturnType = 1 << 9 , Err_AssertOnInvalidReturnType = 1 << 10 , Err_ThrowOnInvalidReturnType = 1 << 11 , Err_LogOnOtherError = 1 << 12 , Err_AssertOnOtherError = 1 << 13 , Err_ThrowOnOtherError = 1 << 14 }
	Flags affecting the behaviour of wxExcelObject and its descendants when an error occurs during accessing an Excel object property or calling its method. More...

Public Member Functions
void	ActivateMicrosoftApp (XlMSApplication index)
	Activates a Microsoft application. More...

bool	AddCustomList (const wxArrayString &listArray)
	Adds a custom list for custom autofill and/or custom sort. More...

void	Calculate ()
	Calculates all open workbooks. More...

void	CalculateFull ()
	Forces a full calculation of the data in all open workbooks. More...

void	CalculateFullRebuild ()
	For all open workbooks, forces a full calculation of the data and rebuilds the dependencies. More...

void	CalculateUntilAsyncQueriesDone ()
	Runs all pending queries to OLEDB and OLAP data sources. More...

double	CentimetersToPoints (double centimeters)
	Converts a measurement from centimeters to points (one point equals 0.035 centimeters). More...

void	CheckAbort (wxExcelRange *keepAbort=NULL)
	Stops recalculation. More...

bool	CheckSpelling (const wxString &word, const wxString &customDictionary=wxEmptyString, wxXlTribool ignoreUpperCase=wxDefaultXlTribool)
	Checks the spelling of a single word. More...

wxString	ConvertFormula (const wxString &formula, XlReferenceStyle fromReferenceStyle, XlReferenceStyle toReferenceStyle=NULL, XlReferenceStyle toAbsolute=NULL, wxExcelRange *relativeTo=NULL)
	Converts cell references in a formula between the A1 and R1C1 reference styles, between relative and absolute references, or both. More...

void	DDEExecute (long channel, const wxString &str)
	Runs a command or performs some other action or actions in another application by way of the specified DDE channel. More...

long	DDEInitiate (const wxString &app, const wxString &topic)
	Opens a DDE channel to an application. More...

void	DDEPoke (long channel, const wxVariant &item, const wxVariant &data)
	Sends data to an application. More...

wxVariant	DDERequest (long channel, const wxString &item)
	Requests information from the specified application. More...

void	DDETerminate (long channel)
	Closes a channel to another application. More...

bool	DeleteCustomList (long listNum)
	Deletes a custom list. More...

void	DoubleClick ()
	Equivalent to double-clicking the active cell. More...

bool	FindFile ()
	Displays the Open dialog box. More...

wxArrayString	GetCustomListContents (long listNum)
	Returns a custom list. More...

long	GetCustomListNum (const wxArrayString &listArray)
	Returns the custom list number for an array of strings. More...

wxArrayString	GetOpenFilename (const wxString &fileFilter=wxEmptyString, long *filterIndex=NULL, const wxString &title=wxEmptyString, wxXlTribool multiSelect=wxDefaultXlTribool)
	Displays the standard Open dialog box and gets a file name from the user without actually opening any files. More...

wxString	GetPhonetic (const wxString &text)
	Returns the Japanese phonetic text of the specified text string. More...

wxString	GetSaveAsFilename (const wxString &initialFilename=wxEmptyString, const wxString &fileFilter=wxEmptyString, long *filterIndex=NULL, const wxString &title=wxEmptyString)
	Displays the standard Save As dialog box and gets a file name from the user without actually saving any files. More...

void	Goto (const wxString &reference=wxEmptyString, bool scroll=false)
	Selects any range or Visual Basic procedure in any workbook, and activates that workbook if it is not already active. More...

void	Help (const wxString &helpFile=wxEmptyString, long *helpContextID=NULL)
	Displays a Help topic. More...

double	InchesToPoints (double inches)
	Converts a measurement from inches to points. More...

wxExcelRange	Intersect (const wxExcelRangeVector &ranges)
	Returns a Range representing the rectangular intersection of two or more ranges. More...

void	MailLogoff ()
	Closes a MAPI mail session established by Microsoft Excel. More...

void	MailLogon (const wxString &name=wxEmptyString, const wxString &password=wxEmptyString, wxXlTribool downloadNewMail=wxDefaultXlTribool)
	Logs in to MAPI Mail or Microsoft Exchange and establishes a mail session. More...

void	Quit ()
	Quits Microsoft Excel. More...

void	RecordMacro (const wxString &basicCode, const wxString &XlmCode=wxEmptyString)
	Records code if the macro recorder is on. More...

bool	RegisterXLL (const wxString &fileName)
	Loads an XLL code resource and automatically registers the functions and commands contained in the resource. More...

wxVariant	Run (const wxString &macro, const wxVariantVector &arguments)
	Runs a macro. More...

void	SaveWorkspace (const wxString &fileName=wxEmptyString)
	Saves the current workspace. More...

void	SendKeys (wxString &keys, bool wait=false)
	Sends keystrokes to Excel application. More...

long	SharePointVersion (const wxString &url)
	The SharePoint version number. More...

wxExcelRange	Union (const wxExcelRangeVector &ranges)
	Returns the union of two or more ranges. More...

wxExcelRange	GetActiveCell ()
	Returns a Range Represents the active cell in the active window (the window on top) or in the specified window. More...

wxString	GetActivePrinter ()
	Returns the name of the active printer. More...

void	SetActivePrinter (const wxString &activePrinter)
	Sets the name of the active printer. More...

wxExcelSheet	GetActiveSheet ()
	Returns the active sheet (the sheet on top) in the active workbook or in the specified window or workbook. More...

wxExcelWindow	GetActiveWindow ()
	Returns the active window (the window on top). More...

wxExcelWorkbook	GetActiveWorkbook ()
	Returns the workbook in the active window (the window on top). More...

wxExcelAddIns	GetAddIns ()
	Returns an AddIns collection that represents all the add-ins listed in the Add-Ins dialog box (Add-Ins command on the Developer tab). More...

wxExcelAddIns2	GetAddIns2 ()
	Returns an AddIns2 collection that represents all the add-ins that are currently available or open in Microsoft Excel, regardless of whether they are installed. More...

bool	GetAlertBeforeOverwriting ()
	True if Microsoft Excel displays a message before overwriting nonblank cells during a drag-and-drop editing operation. More...

void	SetAlertBeforeOverwriting (bool alertBeforeOverwriting)
	True if Microsoft Excel displays a message before overwriting nonblank cells during a drag-and-drop editing operation. More...

wxString	GetAltStartupPath ()
	Returns the name of the alternate startup folder. More...

void	SetAltStartupPath (const wxString &altStartupPath)
	Sets the name of the alternate startup folder. More...

bool	GetAlwaysUseClearType ()
	Returns a Boolean that represents whether to use ClearType to display fonts in the menu, Ribbon, and dialog box text. More...

void	SetAlwaysUseClearType (bool alwaysUseClearType)
	Sets a Boolean that represents whether to use ClearType to display fonts in the menu, Ribbon, and dialog box text. More...

bool	GetArbitraryXMLSupportAvailable ()
	Returns a Boolean value that indicates whether the XML features in Microsoft Excel are available. More...

bool	GetAskToUpdateLinks ()
	True if Microsoft Excel asks the user to update links when opening files with links. More...

void	SetAskToUpdateLinks (bool askToUpdateLinks)
	True if Microsoft Excel asks the user to update links when opening files with links. More...

bool	GetAutoFormatAsYouTypeReplaceHyperlinks ()
	True (default) if Microsoft Excel automatically formats hyperlinks as you type. More...

void	SetAutoFormatAsYouTypeReplaceHyperlinks (bool autoFormatAsYouTypeReplaceHyperlinks)
	True (default) if Microsoft Excel automatically formats hyperlinks as you type. More...

MsoAutomationSecurity	GetAutomationSecurity ()
	Returns an MsoAutomationSecurity constant that represents the security mode Microsoft Excel uses when programmatically opening files. More...

void	SetAutomationSecurity (MsoAutomationSecurity security)
	Sets an MsoAutomationSecurity constant that represents the security mode Microsoft Excel uses when programmatically opening files. More...

bool	GetAutoPercentEntry ()
	True if entries in cells formatted as percentages aren't automatically multiplied by 100 as soon as they are entered. More...

void	SetAutoPercentEntry (bool autoPercentEntry)
	True if entries in cells formatted as percentages aren't automatically multiplied by 100 as soon as they are entered. More...

double	GetBuild ()
	Returns the Microsoft Excel build number. More...

bool	GetCalculateBeforeSave ()
	True if workbooks are calculated before they're saved to disk (if the Calculation property is set to xlManual). More...

void	SetCalculateBeforeSave (bool calculateBeforeSave)
	True if workbooks are calculated before they're saved to disk (if the Calculation property is set to xlManual). More...

XlCalculation	GetCalculation ()
	Returns an XlCalculation value that represents the calculation mode. More...

void	SetCalculation (XlCalculation calculation)
	Sets an XlCalculation value that represents the calculation mode. More...

XlCalculationInterruptKey	GetCalculationInterruptKey ()
	Returns an XlCalculationInterruptKey constant that specifies the key that can interrupt Microsoft Excel when performing calculations. More...

void	SetCalculationInterruptKey (XlCalculationInterruptKey calculationInterruptKey)
	Sets an XlCalculationInterruptKey constant that specifies the key that can interrupt Microsoft Excel when performing calculations. More...

XlCalculationState	GetCalculationState ()
	Returns an XlCalculationState constant that indicates the calculation state of the application, for any calculations that are being performed in Microsoft Excel. More...

long	GetCalculationVersion ()
	Returns a number whose rightmost four digits are the minor calculation engine version number, and whose other digits (on the left) are the major version of Microsoft Excel. More...

wxString	GetCaption ()
	Returns a String value that represents the name that appears in the title bar of the main Microsoft Excel window. More...

void	SetCaption (const wxString &caption)
	Sets a String value that represents the name that appears in the title bar of the main Microsoft Excel window. More...

bool	GetCellDragAndDrop ()
	True if dragging and dropping cells is enabled. More...

void	SetCellDragAndDrop (bool cellDragAndDrop)
	True if dragging and dropping cells is enabled. More...

wxArrayLong	GetClipboardFormats ()
	Returns the formats that are currently on the Clipboard, as an array of numeric values. More...

bool	GetConstrainNumeric ()
	True if handwriting recognition is limited to numbers and punctuation only. More...

void	SetConstrainNumeric (bool constrainNumeric)
	True if handwriting recognition is limited to numbers and punctuation only. More...

bool	GetControlCharacters ()
	True if Microsoft Excel displays control characters for right-to-left languages. More...

void	SetControlCharacters (bool controlCharacters)
	True if Microsoft Excel displays control characters for right-to-left languages. More...

bool	GetCopyObjectsWithCells ()
	True if objects are cut, copied, extracted, and sorted with cells. More...

void	SetCopyObjectsWithCells (bool copyObjectsWithCells)
	True if objects are cut, copied, extracted, and sorted with cells. More...

XlMousePointer	GetCursor ()
	Returns the appearance of the mouse pointer in Microsoft Excel. More...

void	SetCursor (XlMousePointer cursor)
	Sets the appearance of the mouse pointer in Microsoft Excel. More...

long	GetCursorMovement ()
	Returns a value that indicates whether a visual cursor or a logical cursor is used. More...

long	GetCustomListCount ()
	Returns the number of defined custom lists (including built-in lists). More...

long	GetCutCopyMode ()
	Returns the status of Cut or Copy mode. More...

void	SetCutCopyMode ()
	Cancels Cut or Copy mode and removes the moving border. More...

long	GetDataEntryMode ()
	Returns Data Entry mode (xlOn, xlOff or xlStrict). More...

void	SetDataEntryMode (long dataEntryMode)
	Sets Data Entry mode (xlOn, xlOff or xlStrict). More...

long	GetDDEAppReturnCode ()
	Returns the application-specific DDE return code that was contained in the last DDE acknowledge message received by Microsoft Excel. More...

wxString	GetDecimalSeparator ()
	Returns the character used for the decimal separator. More...

void	SetDecimalSeparator (const wxString &decimalSeparator)
	Sets the character used for the decimal separator. More...

wxString	GetDefaultFilePath ()
	Returns the default path that Microsoft Excel uses when it opens files. More...

void	SetDefaultFilePath (const wxString &defaultFilePath)
	Sets the default path that Microsoft Excel uses when it opens files. More...

XlFileFormat	GetDefaultSaveFormat ()
	Returns the default format for saving files. More...

void	SetDefaultSaveFormat (XlFileFormat defaultSaveFormat)
	Sets the default format for saving files. More...

long	GetDefaultSheetDirection ()
	Returns the default direction in which Microsoft Excel displays new windows and worksheets. More...

void	SetDefaultSheetDirection (long defaultSheetDirection)
	Sets the default direction in which Microsoft Excel displays new windows and worksheets. More...

bool	GetDisplayAlerts ()
	True if Microsoft Excel displays certain alerts and messages. More...

void	SetDisplayAlerts (bool displayAlerts)
	True if Microsoft Excel displays certain alerts and messages. More...

XlCommentDisplayMode	GetDisplayCommentIndicator ()
	Returns the way cells display comments and indicators. More...

void	SetDisplayCommentIndicator (XlCommentDisplayMode displayCommentIndicator)
	Sets the way cells display comments and indicators. More...

bool	GetDisplayFormulaAutoComplete ()
	Gets or sets whether to show a list of relevant functions and defined names when building cell formulas. More...

void	SetDisplayFormulaAutoComplete (bool displayFormulaAutoComplete)
	Gets or sets whether to show a list of relevant functions and defined names when building cell formulas. More...

bool	GetDisplayFormulaBar ()
	True if the formula bar is displayed. More...

void	SetDisplayFormulaBar (bool displayFormulaBar)
	True if the formula bar is to be displayed. More...

bool	GetDisplayFullScreen ()
	True if Microsoft Excel is in full-screen mode. More...

void	SetDisplayFullScreen (bool displayFullScreen)
	True if Microsoft Excel should switch to a full-screen mode. More...

bool	GetDisplayFunctionToolTips ()
	True if function ToolTips can be displayed. More...

void	SetDisplayFunctionToolTips (bool displayFunctionToolTips)
	True if function ToolTips are to be displayed. More...

bool	GetDisplayNoteIndicator ()
	True if cells containing notes display cell tips and contain note indicators (small dots in their upper-right corners). More...

void	SetDisplayNoteIndicator (bool displayNoteIndicator)
	True if cells containing notes display cell tips and contain note indicators (small dots in their upper-right corners). More...

bool	GetDisplayScrollBars ()
	True if scroll bars are visible for all workbooks. More...

void	SetDisplayScrollBars (bool displayScrollBars)
	True if scroll bars are to be visible for all workbooks. More...

bool	GetDisplayStatusBar ()
	True if the status bar is displayed. More...

void	SetDisplayStatusBar (bool displayStatusBar)
	True if the status bar is to be displayed. More...

bool	GetEditDirectlyInCell ()
	True if Microsoft Excel allows editing in cells. More...

void	SetEditDirectlyInCell (bool editDirectlyInCell)
	True if Microsoft Excel should allow editing in cells. More...

bool	GetEnableAnimations ()
	True if animated insertion and deletion is enabled. More...

void	SetEnableAnimations (bool enableAnimations)
	True if animated insertion and deletion is to be enabled. More...

bool	GetEnableAutoComplete ()
	True if the AutoComplete feature is enabled. More...

void	SetEnableAutoComplete (bool enableAutoComplete)
	True if the AutoComplete feature is to be enabled. More...

XlEnableCancelKey	GetEnableCancelKey ()
	Controls how Microsoft Excel handles CTRL+BREAK (or ESC or COMMAND+PERIOD) user interruptions to the running procedure. More...

void	SetEnableCancelKey (XlEnableCancelKey enableCancelKey)
	Controls how Microsoft Excel handles CTRL+BREAK (or ESC or COMMAND+PERIOD) user interruptions to the running procedure. More...

bool	GetEnableLargeOperationAlert ()
	Returns a Boolean that represents whether to display an alert message when a user attempts to perform an operation that affects a larger number of cells than is specified in the Office center UI. More...

void	SetEnableLargeOperationAlert (bool enableLargeOperationAlert)
	Sets a Boolean that represents whether to display an alert message when a user attempts to perform an operation that affects a larger number of cells than is specified in the Office center UI. More...

bool	GetEnableLivePreview ()
	Returns a Boolean that represents whether to show or hide gallery previews that appear when using galleries that support previewing. More...

void	SetEnableLivePreview (bool enableLivePreview)
	Sets a Boolean that represents whether to show or hide gallery previews that appear when using galleries that support previewing. More...

bool	GetEnableMacroAnimations ()
	Controls whether macro animations are enabled. More...

void	SetEnableMacroAnimations (bool enableMacroAnimations)
	Controls whether macro animations are enabled. More...

bool	GetEnableSound ()
	True if sound is enabled for Microsoft Office. More...

void	SetEnableSound (bool enableSound)
	True if sound is enabled for Microsoft Office. More...

wxExcelErrorCheckingOptions	GetErrorCheckingOptions ()
	Returns an ErrorCheckingOptions object, which represents the error checking options for an application. More...

bool	GetExtendList ()
	True if Microsoft Excel automatically extends formatting and formulas to new data that is added to a list. More...

void	SetExtendList (bool extendList)
	True if Microsoft Excel automatically extends formatting and formulas to new data that is added to a list. More...

MsoFeatureInstall	GetFeatureInstall ()
	Returns a value (constant) that specifies how Microsoft Excel handles calls to methods and properties that require features that aren't yet installed. More...

void	SetFeatureInstall (MsoFeatureInstall featureInstall)
	Sets a value (constant) that specifies how Microsoft Excel handles calls to methods and properties that require features that aren't yet installed. More...

wxExcelFileExportConverters	GetFileExportConverters ()
	Returns a FileExportConverters collection that represents all the file converters for saving files available to Microsoft Excel. More...

MsoFileValidationMode	GetFileValidation ()
	Returns how Excel will validate files before opening them. More...

void	SetFileValidation (MsoFileValidationMode fileValidation)
	Sets how Excel will validate files before opening them. More...

bool	GetFixedDecimal ()
	All data entered after this property is set to True will be formatted with the number of fixed decimal places set by the FixedDecimalPlaces property. More...

void	SetFixedDecimal (bool fixedDecimal)
	All data entered after this property is set to True will be formatted with the number of fixed decimal places set by the FixedDecimalPlaces property. More...

long	GetFixedDecimalPlaces ()
	Returns the number of fixed decimal places used when the FixedDecimal property is set to True. More...

void	SetFixedDecimalPlaces (long fixedDecimalPlaces)
	Sets the number of fixed decimal places used when the FixedDecimal property is set to True. More...

bool	GetFlashFill ()
	Controls whether Flash Fill feature has been enabled and active. More...

void	SetFlashFill (bool flashFill)
	Controls whether Flash Fill feature has been enabled and active. More...

bool	GetFlashFillMode ()
	Controls whether Flash Fill feature is enabled. More...

void	SetFlashFillMode (bool flashFillMode)
	Controls whether Flash Fill feature is enabled. More...

long	GetFormulaBarHeight ()
	Allows the user to specify the height of the formula bar in lines. More...

void	SetFormulaBarHeight (long formulaBarHeight)
	Allows the user to specify the height of the formula bar in lines. More...

bool	GetGenerateGetPivotData ()
	Returns True when Microsoft Excel can get PivotTable report data. More...

void	SetGenerateGetPivotData (bool generateGetPivotData)
	Returns True when Microsoft Excel can get PivotTable report data. More...

XlGenerateTableRefs	GetGenerateTableRefs ()
	The GenerateTableRefs property determines whether the traditional notation method or the new structured referencing notation method is used for referencing tables in formulas. More...

void	SetGenerateTableRefs (XlGenerateTableRefs generateTableRefs)
	The GenerateTableRefs property determines whether the traditional notation method or the new structured referencing notation method is used for referencing tables in formulas. More...

double	GetHeight ()
	Returns a Double value that represents the height in points of the main application window. More...

void	SetHeight (double height)
	Sets a Double value that represents the height in points of the main application window. More...

bool	GetHighQualityModeForGraphics ()
	Returns whether Excel uses high quality mode to print graphics. More...

void	SetHighQualityModeForGraphics (bool highQualityModeForGraphics)
	Sets whether Excel uses high quality mode to print graphics. More...

long	GetHinstance ()
	Returns the instance Microsoft Excel application. More...

wxAEHinstPtr	GetHinstancePtr ()
	Returns the instance Microsoft Excel application. More...

long	GetHwnd ()
	Returns a Long indicating the top-level window handle of the Microsoft Excel window. More...

bool	GetIgnoreRemoteRequests ()
	True if remote DDE requests are ignored. More...

void	SetIgnoreRemoteRequests (bool ignoreRemoteRequests)
	True if remote DDE requests are ignored. More...

bool	GetInteractive ()
	True if Microsoft Excel is in interactive mode. More...

void	SetInteractive (bool interactive)
	True to set Microsoft Excel into interactive mode. More...

wxVariant	GetInternational (XlApplicationInternational *index=NULL)
	Returns information about the current country/region and international settings. More...

bool	GetIteration ()
	True if Microsoft Excel will use iteration to resolve circular references. More...

void	SetIteration (bool iteration)
	True if Microsoft Excel will use iteration to resolve circular references. More...

bool	GetIsSandboxed ()
	Returns true if the specified workbook is open in a Protected View window. More...

wxExcelLanguageSettings	GetLanguageSettings ()
	Returns the LanguageSettings object, which contains information about the language settings in Microsoft Excel. More...

long	GetLargeOperationCellThousandCount ()
	Returns the maximum number of cells needed in an operation beyond which an alert is triggered. More...

void	SetLargeOperationCellThousandCount (long largeOperationCellThousandCount)
	Sets the maximum number of cells needed in an operation beyond which an alert is triggered. More...

double	GetLeft ()
	The distance, in points, from the left edge of the screen to the left edge of the main Microsoft Excel window. More...

void	SetLeft (double left)
	The distance, in points, from the left edge of the screen to the left edge of the main Microsoft Excel window. More...

wxString	GetLibraryPath ()
	Returns the path to the Library folder, but without the final separator. More...

wxString	GetMailSession ()
	Returns the MAPI mail session number as a hexadecimal string (if there's an active session), or an empty string if there's no session. More...

XlMailSystem	GetMailSystem ()
	Returns the mail system that's installed on the host machine. More...

bool	GetMapPaperSize ()
	True if documents formatted for the standard paper size of another country/region (for example, A4) are automatically adjusted so that they're printed correctly on the standard paper size (for example, Letter) of your country/region. More...

void	SetMapPaperSize (bool mapPaperSize)
	True if documents formatted for the standard paper size of another country/region (for example, A4) are automatically adjusted so that they're printed correctly on the standard paper size (for example, Letter) of your country/region. More...

bool	GetMathCoprocessorAvailable ()
	True if a math coprocessor is available. More...

double	GetMaxChange ()
	Returns the maximum amount of change between each iteration as Microsoft Excel resolves circular references. More...

void	SetMaxChange (double maxChange)
	Sets the maximum amount of change between each iteration as Microsoft Excel resolves circular references. More...

long	GetMaxIterations ()
	Returns the maximum number of iterations that Microsoft Excel can use to resolve a circular reference. More...

void	SetMaxIterations (long iterations)
	Sets the maximum number of iterations that Microsoft Excel can use to resolve a circular reference. More...

bool	GetMergeInstances ()
	Controls whether to merge multiple instances of the application into a single one. More...

void	SetMergeInstances (bool mergeInstances)
	Controls whether to merge multiple instances of the application into a single one. More...

XlMeasurementUnits	GetMeasurementUnit ()
	Specifies the measurement unit used in the application. More...

void	SetMeasurementUnit (XlMeasurementUnits measurementUnit)
	Specifies the measurement unit used in the application. More...

bool	GetMouseAvailable ()
	True if a mouse is available. More...

bool	GetMoveAfterReturn ()
	True if the active cell will be moved as soon as the ENTER (RETURN) key is pressed. More...

void	SetMoveAfterReturn (bool moveAfterReturn)
	True if the active cell will be moved as soon as the ENTER (RETURN) key is pressed. More...

XlDirection	GetMoveAfterReturnDirection ()
	Returns the direction in which the active cell is moved when the user presses ENTER. More...

void	SetMoveAfterReturnDirection (XlDirection moveAfterReturnDirection)
	Sets the direction in which the active cell is moved when the user presses ENTER. More...

wxExcelMultiThreadedCalculation	GetMultiThreadedCalculation ()
	Returns a MultiThreadedCalculation object that controls the multi-threaded recalculation settings. More...

wxString	GetName ()
	Returns the name of the object. More...

wxExcelNames	GetNames ()
	Returns a Names collection that represents all the names in the active workbook. More...

wxString	GetNetworkTemplatesPath ()
	Returns the network path where templates are stored. More...

long	GetODBCTimeout ()
	Returns the ODBC query time limit, in seconds. More...

void	SetODBCTimeout (long oDBCTimeout)
	Sets the ODBC query time limit, in seconds. More...

wxString	GetOperatingSystem ()
	Returns the name and version number of the current operating system - for example, "Windows (32-bit) 4.00" or "Macintosh 7.00". More...

wxString	GetOrganizationName ()
	Returns the registered organization name. More...

wxString	GetPath ()
	Returns a String value that represents the complete path to the application, excluding the final separator and name of the application. More...

wxString	GetPathSeparator ()
	Returns the path separator character ("\"). More...

bool	GetPivotTableSelection ()
	True if PivotTable reports use structured selection. More...

void	SetPivotTableSelection (bool pivotTableSelection)
	True if PivotTable reports use structured selection. More...

bool	GetPrintCommunication ()
	Specifies whether communication with the printer is turned on. More...

void	SetPrintCommunication (bool printCommunication)
	Specifies whether communication with the printer is turned on. More...

wxString	GetProductCode ()
	Returns the globally unique identifier (GUID) for Microsoft Excel. More...

bool	GetPromptForSummaryInfo ()
	True if Microsoft Excel asks for summary information when files are first saved. More...

void	SetPromptForSummaryInfo (bool promptForSummaryInfo)
	True if Microsoft Excel asks for summary information when files are first saved. More...

bool	GetReady ()
	Returns True when the Microsoft Excel application is ready. More...

wxExcelRecentFiles	GetRecentFiles ()
	Returns a RecentFiles collection that represents the list of recently used files. More...

XlReferenceStyle	GetReferenceStyle ()
	Returns how Microsoft Excel displays cell references and row and column headings in either A1 or R1C1 reference style. More...

void	SetReferenceStyle (XlReferenceStyle referenceStyle)
	Sets how Microsoft Excel displays cell references and row and column headings in either A1 or R1C1 reference style. More...

bool	GetRollZoom ()
	True if the IntelliMouse zooms instead of scrolling. More...

void	SetRollZoom (bool rollZoom)
	True if the IntelliMouse zooms instead of scrolling. More...

bool	GetScreenUpdating ()
	True if screen updating is turned on. More...

void	SetScreenUpdating (bool screenUpdating)
	True if screen updating is turned on. More...

wxExcelSheets	GetSheets ()
	Returns a Sheets collection that represents all the sheets in the active workbook. More...

long	GetSheetsInNewWorkbook ()
	Returns the number of sheets that Microsoft Excel automatically inserts into new workbooks. More...

void	SetSheetsInNewWorkbook (long sheetsInNewWorkbook)
	Sets the number of sheets that Microsoft Excel automatically inserts into new workbooks. More...

bool	GetShowDevTools ()
	Returns a Boolean that represents whether the Developer tab is displayed in the Ribbon. More...

void	SetShowDevTools (bool showDevTools)
	Sets a Boolean that represents whether the Developer tab is displayed in the Ribbon. More...

bool	GetShowMenuFloaties ()
	Returns a Boolean that represents whether to display Mini toolbars when the user right-clicks in the workbook window. More...

void	SetShowMenuFloaties (bool showMenuFloaties)
	Sets a Boolean that represents whether to display Mini toolbars when the user right-clicks in the workbook window. More...

bool	GetShowQuickAnalysis ()
	Controls whether the Quick Analysis contextual user interface is displayed on selection. More...

void	SetShowQuickAnalysis (bool showQuickAnalysis)
	Controls whether the Quick Analysis contextual user interface is displayed on selection. More...

bool	GetShowSelectionFloaties ()
	Returns a Boolean that represents whether Mini toolbars displays when a user selects text. More...

void	SetShowSelectionFloaties (bool showSelectionFloaties)
	Sets a Boolean that represents whether Mini toolbars displays when a user selects text. More...

bool	GetShowStartupDialog ()
	Returns True (default is False) when the New Workbook task pane appears for a Microsoft Excel application. More...

void	SetShowStartupDialog (bool showStartupDialog)
	Returns True (default is False) when the New Workbook task pane appears for a Microsoft Excel application. More...

bool	GetShowToolTips ()
	True if ToolTips are turned on. More...

void	SetShowToolTips (bool showToolTips)
	True if ToolTips are turned on. More...

bool	GetShowWindowsInTaskbar ()
	True if there's a separate Windows taskbar button for each open workbook. More...

void	SetShowWindowsInTaskbar (bool showWindowsInTaskbar)
	True if there's a separate Windows taskbar button for each open workbook. More...

wxString	GetStandardFont ()
	Returns the name of the standard font. More...

void	SetStandardFont (const wxString &standardFont)
	Sets the name of the standard font. More...

double	GetStandardFontSize ()
	Returns the standard font size, in points. More...

void	SetStandardFontSize (double standardFontSize)
	Sets the standard font size, in points. More...

wxString	GetStartupPath ()
	Returns the complete path of the startup folder, excluding the final separator. More...

wxString	GetStatusBar ()
	Returns the text in the status bar. More...

void	SetStatusBar (const wxString &statusBar)
	Sets the text in the status bar. More...

wxString	GetTemplatesPath ()
	Returns the local path where templates are stored. More...

wxString	GetThousandsSeparator ()
	Returns the character used for the thousands separator as a String. More...

void	SetThousandsSeparator (const wxString &thousandsSeparator)
	Sets the character used for the thousands separator as a String. More...

double	GetTop ()
	Returns a Double value that represents the distance, in points, from the top edge of the screen to the top edge of the main Microsoft Excel window. More...

void	SetTop (double top)
	Sets a Double value that represents the distance, in points, from the top edge of the screen to the top edge of the main Microsoft Excel window. More...

wxString	GetTransitionMenuKey ()
	Returns the Microsoft Excel menu or help key, which is usually "/". More...

void	SetTransitionMenuKey (const wxString &transitionMenuKey)
	Sets the Microsoft Excel menu or help key, which is usually "/". More...

long	GetTransitionMenuKeyAction ()
	Returns the action taken when the Microsoft Excel menu key is pressed. More...

void	SetTransitionMenuKeyAction (long transitionMenuKeyAction)
	Sets the action taken when the Microsoft Excel menu key is pressed. More...

bool	GetTransitionNavigKeys ()
	True if transition navigation keys are active. More...

void	SetTransitionNavigKeys (bool transitionNavigKeys)
	True if transition navigation keys are active. More...

double	GetUsableHeight ()
	Returns the maximum height of the space that a window can occupy in the application window area, in points. More...

double	GetUsableWidth ()
	Returns the maximum width of the space that a window can occupy in the application window area, in points. More...

bool	GetUserControl ()
	True if the application is visible or if it was created or started by the user. More...

void	SetUserControl (bool userControl)
	True if the application is visible or if it was created or started by the user. More...

wxString	GetUserLibraryPath ()
	Returns the path to the location on the user's computer where the COM add-ins are installed. More...

wxString	GetUsername ()
	Returns the name of the current user. More...

void	SetUsername (const wxString &userName)
	Sets the name of the current user. More...

bool	GetUseSystemSeparators ()
	True (default) if the system separators of Microsoft Excel are enabled. More...

void	SetUseSystemSeparators (bool useSystemSeparators)
	True (default) if the system separators of Microsoft Excel are enabled. More...

wxString	GetVersion ()
	Returns a String value that represents the Microsoft Excel version number. More...

bool	GetVisible ()
	Returns a Boolean value that determines whether the object is visible. More...

void	SetVisible (bool visible)
	Sets a Boolean value that determines whether the object is visible. More...

double	GetWidth ()
	Returns a Double value that represents the distance, in points, from the left edge of the application window to its right edge. More...

void	SetWidth (double width)
	Sets a Double value that represents the distance, in points, from the left edge of the application window to its right edge. More...

wxExcelWindows	GetWindows ()
	Returns a Windows collection that represents all the windows in all the workbooks. More...

bool	GetWindowsForPens ()
	True if the computer is running under Microsoft Windows for Pen Computing. More...

XlWindowState	GetWindowState ()
	Returns the state of the window. More...

void	SetWindowState (XlWindowState windowState)
	Sets the state of the window. More...

wxExcelWorkbooks	GetWorkbooks ()
	Returns a Workbooks collection that represents all the open workbooks. More...

wxExcelWorksheets	GetWorksheets ()
	For an Application object, returns a Sheets collection that represents all the worksheets in the active workbook. More...

bool	GetVersionAsDouble_ (double &version)
	Returns MS Excel version as a double matching Application.Version. More...

bool	GetVersionAsEnum_ (ExcelForWindowsVersions &version)
	Returns MS Excel version as an ExcelForWindowsVersions enum value. More...

bool	IsVersionAtLeast_ (ExcelForWindowsVersions version)
	Returns true if the instance is version or newer. More...

virtual wxString	GetAutoExcelObjectName_ () const
	Returns "Application". More...

Public Member Functions inherited from wxAutoExcel::wxExcelRangeOwner
wxExcelRange	GetCells (long row=NULL, long column=NULL)
	wxExcelApplication: Returns a Range representing all the cells on the active worksheet. More...

wxExcelRange	GetRange (const wxString &cell1, const wxString &cell2=wxEmptyString)
	wxExcelWorksheet: Returns a Range representing a cell or a range of cells. More...

wxExcelRange	GetRows ()
	wxExcelWorksheet: Returns a Range representing all the rows on the specified worksheet. More...

wxExcelRange	GetRows (long rowIndex)
	wxExcelRange: Returns a Range containing just one row with rowIndex (starting with 1). More...

wxExcelRange	GetRows (const wxString &rowRange)
	wxExcelWorksheet: Returns a Range that can contain several contiguous rows. More...

wxExcelRange	GetColumns ()
	wxExcelWorksheet: Returns a Range representing all the columns on the active worksheet. More...

wxExcelRange	GetColumns (long columnIndex)
	wxExcelRange: Returns a Range containing just one column with columnIndex (starting with 1). More...

wxExcelRange	GetColumns (const wxString &columnRange)
	wxExcelWorksheet: Returns a Range that can contain several contiguous columns. More...

Public Member Functions inherited from wxAutoExcel::wxExcelObject
bool	IsOk_ () const
	Returns true if the object has a valid dispatch. More...

wxString	GetAutomationObjectName_ (bool stripUnderscores=false) const
	Returns object name as provided by IDispatch->GetTypeInfo()->GetDocumentation(MEMBERID_NIL, &name, NULL, NULL, NULL). More...

wxSharedPtr< wxAutomationObject >	GetAutomationObject_ ()
	Returns the underlying wxAutomationObject. More...

	operator bool () const
	Returns true if the object has a valid dispatch and its last automation call (if any), i.e. More...

WXLCID	GetAutomationLCID_ () const
	Returns the locale identifier used in automation calls. More...

bool	SetAutomationLCID_ (WXLCID lcid)
	Sets the locale identifier to be used in automation calls. More...

bool	GetPropertyAndMethodNames_ (wxArrayString &propertyNames, wxArrayString &methodNames, bool includeHidden=false)
	Returns lists of property and method names the automation interface exposes. More...

bool	GetUnimplementedObject_ (const wxString &name, wxAutomationObject &object)
	Helper function for receiving an automation object not implemented in wxAutoExcel, see FAQ on how to use. More...

Static Public Member Functions
static wxExcelApplication	CreateInstance ()
	Launches MS Excel and creates an instance of MS Excel Application. More...

static wxExcelApplication	GetInstance (int flags=wxAutomationInstance_CreateIfNeeded)
	Analogical to wxAutomationObject::GetInstance(). More...

static wxExcelApplication	GetInstance (const wxString &workbookPath)
	Attempts to connect to the instance of Excel where the workbook with the workbookPath (must be the full path) is opened, if any. More...

Static Public Member Functions inherited from wxAutoExcel::wxExcelObject
static unsigned	GetErrorMode_ ()
	Sets the error mode to the combination of wxExcelObject::ErrorFlags. More...

static void	SetErrorMode_ (unsigned mode)
	Sets the error mode as the combination of wxExcelObject::ErrorFlags. More...

static bool	GetUnimplementedCollectionItem_ (wxAutomationObject &collection, const long index, wxAutomationObject &item, bool asProperty)
	Helper function for obtaining an item from MS Excel collection not implemented in wxAutoExcel, see FAQ on how to use. More...

Detailed Description

Represents Microsoft Excel Application.

Member Enumeration Documentation

◆ ExcelForWindowsVersions

enum wxAutoExcel::wxExcelApplication::ExcelForWindowsVersions

Constants for known MS Excel versions used by GetVersionAsEnum_() and IsVersionAtLeast_().

Enumerator
evUnknown	Unknown MS Excel version.
evExcel2000	MS Excel for Windows 2000 (v9.0).
evExcel2002	MS Excel for Windows 2002 (v10.0).
evExcel2003	MS Excel for Windows 2003 (v11.0).
evExcel2007	MS Excel for Windows 2007 (v12.0).
evExcel2010	MS Excel for Windows 2010 (v14.0).
evExcel2013	MS Excel for Windows 2013 (v15.0).
evExcel2016	MS Excel for Windows 2016 (v16.0).
evExcel2016or2019	MS Excel for Windows 2016 or 2019 (v16.0).

Member Function Documentation

◆ CreateInstance()

static wxExcelApplication wxAutoExcel::wxExcelApplication::CreateInstance ( )

static

Launches MS Excel and creates an instance of MS Excel Application.

If failed then returned wxExcelApplication::IsOk_() returns false.

◆ GetInstance() [1/2]

static wxExcelApplication wxAutoExcel::wxExcelApplication::GetInstance ( int flags = wxAutomationInstance_CreateIfNeeded )

static

Analogical to wxAutomationObject::GetInstance().

If failed then returned wxExcelApplication::IsOk_() returns false.

◆ GetInstance() [2/2]

static wxExcelApplication wxAutoExcel::wxExcelApplication::GetInstance ( const wxString & workbookPath )

static

Attempts to connect to the instance of Excel where the workbook with the workbookPath (must be the full path) is opened, if any.

Note: After getting the instance, the workbook with workbookPath may not be the ActiveWorkbook, in case the Excel instance has several documents open and some other workbook is active. If failed then returned wxExcelApplication::IsOk_() returns false.

◆ ActivateMicrosoftApp()

void wxAutoExcel::wxExcelApplication::ActivateMicrosoftApp ( XlMSApplication index )

Activates a Microsoft application.

If the application is already running, this method activates the running application. If the application is not running, this method starts a new instance of the application.

MSDN documentation for Application.ActivateMicrosoftApp.

◆ AddCustomList()

bool wxAutoExcel::wxExcelApplication::AddCustomList ( const wxArrayString & listArray )

Adds a custom list for custom autofill and/or custom sort.

MSDN documentation for Application.AddCustomList.

◆ Calculate()

void wxAutoExcel::wxExcelApplication::Calculate ( )

Calculates all open workbooks.

MSDN documentation for Application.Calculate.

◆ CalculateFull()

void wxAutoExcel::wxExcelApplication::CalculateFull ( )

Forces a full calculation of the data in all open workbooks.

MSDN documentation for Application.CalculateFull.

◆ CalculateFullRebuild()

void wxAutoExcel::wxExcelApplication::CalculateFullRebuild ( )

For all open workbooks, forces a full calculation of the data and rebuilds the dependencies.

MSDN documentation for Application.CalculateFullRebuild.

◆ CalculateUntilAsyncQueriesDone()

void wxAutoExcel::wxExcelApplication::CalculateUntilAsyncQueriesDone ( )

Runs all pending queries to OLEDB and OLAP data sources.

MSDN documentation for Application.CalculateUntilAsyncQueriesDone.

◆ CentimetersToPoints()

double wxAutoExcel::wxExcelApplication::CentimetersToPoints ( double centimeters )

Converts a measurement from centimeters to points (one point equals 0.035 centimeters).

MSDN documentation for Application.CentimetersToPoints.

◆ CheckAbort()

void wxAutoExcel::wxExcelApplication::CheckAbort ( wxExcelRange * keepAbort = NULL )

Stops recalculation.

If keepAbort is a valid range, the recalculation will be finished for it.

MSDN documentation for Application.CheckAbort.

◆ CheckSpelling()

bool wxAutoExcel::wxExcelApplication::CheckSpelling	(	const wxString &	word,
		const wxString &	customDictionary = `wxEmptyString`,
		wxXlTribool	ignoreUpperCase = `wxDefaultXlTribool`
	)

Checks the spelling of a single word.

MSDN documentation for Application.CheckSpelling.

◆ ConvertFormula()

wxString wxAutoExcel::wxExcelApplication::ConvertFormula	(	const wxString &	formula,
		XlReferenceStyle	fromReferenceStyle,
		XlReferenceStyle *	toReferenceStyle = `NULL`,
		XlReferenceStyle *	toAbsolute = `NULL`,
		wxExcelRange *	relativeTo = `NULL`
	)

Converts cell references in a formula between the A1 and R1C1 reference styles, between relative and absolute references, or both.

MSDN documentation for Application.ConvertFormula.

◆ DDEExecute()

void wxAutoExcel::wxExcelApplication::DDEExecute	(	long	channel,
		const wxString &	str
	)

Runs a command or performs some other action or actions in another application by way of the specified DDE channel.

MSDN documentation for Application.DDEExecute.

◆ DDEInitiate()

long wxAutoExcel::wxExcelApplication::DDEInitiate	(	const wxString &	app,
		const wxString &	topic
	)

Opens a DDE channel to an application.

MSDN documentation for Application.DDEInitiate.

◆ DDEPoke()

void wxAutoExcel::wxExcelApplication::DDEPoke	(	long	channel,
		const wxVariant &	item,
		const wxVariant &	data
	)

Sends data to an application.

MSDN documentation for Application.DDEPoke.

◆ DDERequest()

wxVariant wxAutoExcel::wxExcelApplication::DDERequest	(	long	channel,
		const wxString &	item
	)

Requests information from the specified application.

This method always returns a list.

MSDN documentation for Application.DDERequest.

◆ DDETerminate()

void wxAutoExcel::wxExcelApplication::DDETerminate ( long channel )

Closes a channel to another application.

MSDN documentation for Application.DDETerminate.

◆ DeleteCustomList()

bool wxAutoExcel::wxExcelApplication::DeleteCustomList ( long listNum )

Deletes a custom list.

MSDN documentation for Application.DeleteCustomList.

◆ DoubleClick()

void wxAutoExcel::wxExcelApplication::DoubleClick ( )

Equivalent to double-clicking the active cell.

MSDN documentation for Application.DoubleClick.

◆ FindFile()

bool wxAutoExcel::wxExcelApplication::FindFile ( )

Displays the Open dialog box.

Returns true if the file chosen by the user was successfully open, false otherwise.

MSDN documentation for Application.FindFile.

◆ GetCustomListContents()

wxArrayString wxAutoExcel::wxExcelApplication::GetCustomListContents ( long listNum )

Returns a custom list.

MSDN documentation for Application.GetCustomListContents.

◆ GetCustomListNum()

long wxAutoExcel::wxExcelApplication::GetCustomListNum ( const wxArrayString & listArray )

Returns the custom list number for an array of strings.

You can use this method to match both built-in lists and custom-defined lists.

MSDN documentation for Application.GetCustomListNum.

◆ GetOpenFilename()

wxArrayString wxAutoExcel::wxExcelApplication::GetOpenFilename	(	const wxString &	fileFilter = `wxEmptyString`,
		long *	filterIndex = `NULL`,
		const wxString &	title = `wxEmptyString`,
		wxXlTribool	multiSelect = `wxDefaultXlTribool`
	)

Displays the standard Open dialog box and gets a file name from the user without actually opening any files.

MSDN documentation for Application.GetOpenFilename.

◆ GetPhonetic()

wxString wxAutoExcel::wxExcelApplication::GetPhonetic ( const wxString & text )

Returns the Japanese phonetic text of the specified text string.

This method is available to you only if you have selected or installed Japanese language support for Microsoft Office.

MSDN documentation for Application.GetPhonetic.

◆ GetSaveAsFilename()

wxString wxAutoExcel::wxExcelApplication::GetSaveAsFilename	(	const wxString &	initialFilename = `wxEmptyString`,
		const wxString &	fileFilter = `wxEmptyString`,
		long *	filterIndex = `NULL`,
		const wxString &	title = `wxEmptyString`
	)

Displays the standard Save As dialog box and gets a file name from the user without actually saving any files.

MSDN documentation for Application.GetSaveAsFilename.

◆ Goto()

void wxAutoExcel::wxExcelApplication::Goto	(	const wxString &	reference = `wxEmptyString`,
		bool	scroll = `false`
	)

Selects any range or Visual Basic procedure in any workbook, and activates that workbook if it is not already active.

MSDN documentation for Application.Goto.

◆ Help()

void wxAutoExcel::wxExcelApplication::Help	(	const wxString &	helpFile = `wxEmptyString`,
		long *	helpContextID = `NULL`
	)

Displays a Help topic.

MSDN documentation for Application.Help.

◆ InchesToPoints()

double wxAutoExcel::wxExcelApplication::InchesToPoints ( double inches )

Converts a measurement from inches to points.

MSDN documentation for Application.InchesToPoints.

◆ Intersect()

wxExcelRange wxAutoExcel::wxExcelApplication::Intersect ( const wxExcelRangeVector & ranges )

Returns a Range representing the rectangular intersection of two or more ranges.

MSDN documentation for Application.Intersect.

◆ MailLogoff()

void wxAutoExcel::wxExcelApplication::MailLogoff ( )

Closes a MAPI mail session established by Microsoft Excel.

MSDN documentation for Application.MailLogoff.

◆ MailLogon()

void wxAutoExcel::wxExcelApplication::MailLogon	(	const wxString &	name = `wxEmptyString`,
		const wxString &	password = `wxEmptyString`,
		wxXlTribool	downloadNewMail = `wxDefaultXlTribool`
	)

Logs in to MAPI Mail or Microsoft Exchange and establishes a mail session.

If Microsoft Mail is not already running, you must use this method to establish a mail session before mail or document routing functions can be used.

MSDN documentation for Application.MailLogon.

◆ Quit()

void wxAutoExcel::wxExcelApplication::Quit ( )

Quits Microsoft Excel.

MSDN documentation for Application.Quit.

◆ RecordMacro()

void wxAutoExcel::wxExcelApplication::RecordMacro	(	const wxString &	basicCode,
		const wxString &	XlmCode = `wxEmptyString`
	)

Records code if the macro recorder is on.

MSDN documentation for Application.RecordMacro.

◆ RegisterXLL()

bool wxAutoExcel::wxExcelApplication::RegisterXLL ( const wxString & fileName )

Loads an XLL code resource and automatically registers the functions and commands contained in the resource.

MSDN documentation for Application.RegisterXLL.

◆ Run()

wxVariant wxAutoExcel::wxExcelApplication::Run	(	const wxString &	macro,
		const wxVariantVector &	arguments
	)

Runs a macro.

MSDN documentation for Application.Run.

◆ SaveWorkspace()

void wxAutoExcel::wxExcelApplication::SaveWorkspace ( const wxString & fileName = wxEmptyString )

Saves the current workspace.

MSDN documentation for Application.SaveWorkspace.

◆ SendKeys()

void wxAutoExcel::wxExcelApplication::SendKeys	(	wxString &	keys,
		bool	wait = `false`
	)

Sends keystrokes to Excel application.

MSDN documentation for Application.SendKeys.

◆ SharePointVersion()

long wxAutoExcel::wxExcelApplication::SharePointVersion ( const wxString & url )

The SharePoint version number.

MSDN documentation for Application.SharePointVersion.

◆ Union()

wxExcelRange wxAutoExcel::wxExcelApplication::Union ( const wxExcelRangeVector & ranges )

Returns the union of two or more ranges.

MSDN documentation for Application.Union.

◆ GetActiveCell()

wxExcelRange wxAutoExcel::wxExcelApplication::GetActiveCell ( )

Returns a Range Represents the active cell in the active window (the window on top) or in the specified window.

If the window is not displaying a worksheet, this property fails.

MSDN documentation for Application.ActiveCell.

◆ GetActivePrinter()

wxString wxAutoExcel::wxExcelApplication::GetActivePrinter ( )

Returns the name of the active printer.

MSDN documentation for Application.ActivePrinter.

◆ SetActivePrinter()

void wxAutoExcel::wxExcelApplication::SetActivePrinter ( const wxString & activePrinter )

Sets the name of the active printer.

MSDN documentation for Application.ActivePrinter.

◆ GetActiveSheet()

wxExcelSheet wxAutoExcel::wxExcelApplication::GetActiveSheet ( )

Returns the active sheet (the sheet on top) in the active workbook or in the specified window or workbook.

MSDN documentation for Application.ActiveSheet.

◆ GetActiveWindow()

wxExcelWindow wxAutoExcel::wxExcelApplication::GetActiveWindow ( )

Returns the active window (the window on top).

MSDN documentation for Application.ActiveWindow.

◆ GetActiveWorkbook()

wxExcelWorkbook wxAutoExcel::wxExcelApplication::GetActiveWorkbook ( )

Returns the workbook in the active window (the window on top).

MSDN documentation for Application.ActiveWorkbook.

◆ GetAddIns()

wxExcelAddIns wxAutoExcel::wxExcelApplication::GetAddIns ( )

Returns an AddIns collection that represents all the add-ins listed in the Add-Ins dialog box (Add-Ins command on the Developer tab).

MSDN documentation for Application.AddIns.

◆ GetAddIns2()

wxExcelAddIns2 wxAutoExcel::wxExcelApplication::GetAddIns2 ( )

Returns an AddIns2 collection that represents all the add-ins that are currently available or open in Microsoft Excel, regardless of whether they are installed.

MSDN documentation for Application.AddIns2.

◆ GetAlertBeforeOverwriting()

bool wxAutoExcel::wxExcelApplication::GetAlertBeforeOverwriting ( )

True if Microsoft Excel displays a message before overwriting nonblank cells during a drag-and-drop editing operation.

MSDN documentation for Application.AlertBeforeOverwriting.

◆ SetAlertBeforeOverwriting()

void wxAutoExcel::wxExcelApplication::SetAlertBeforeOverwriting ( bool alertBeforeOverwriting )

True if Microsoft Excel displays a message before overwriting nonblank cells during a drag-and-drop editing operation.

MSDN documentation for Application.AlertBeforeOverwriting.

◆ GetAltStartupPath()

wxString wxAutoExcel::wxExcelApplication::GetAltStartupPath ( )

Returns the name of the alternate startup folder.

MSDN documentation for Application.AltStartupPath.

◆ SetAltStartupPath()

void wxAutoExcel::wxExcelApplication::SetAltStartupPath ( const wxString & altStartupPath )

Sets the name of the alternate startup folder.

MSDN documentation for Application.AltStartupPath.

◆ GetAlwaysUseClearType()

bool wxAutoExcel::wxExcelApplication::GetAlwaysUseClearType ( )

Returns a Boolean that represents whether to use ClearType to display fonts in the menu, Ribbon, and dialog box text.

Since MS Excel 2007.

MSDN documentation for Application.AlwaysUseClearType.

◆ SetAlwaysUseClearType()

void wxAutoExcel::wxExcelApplication::SetAlwaysUseClearType ( bool alwaysUseClearType )

Sets a Boolean that represents whether to use ClearType to display fonts in the menu, Ribbon, and dialog box text.

Since MS Excel 2007.

MSDN documentation for Application.AlwaysUseClearType.

◆ GetArbitraryXMLSupportAvailable()

bool wxAutoExcel::wxExcelApplication::GetArbitraryXMLSupportAvailable ( )

Returns a Boolean value that indicates whether the XML features in Microsoft Excel are available.

MSDN documentation for Application.ArbitraryXMLSupportAvailable.

◆ GetAskToUpdateLinks()

bool wxAutoExcel::wxExcelApplication::GetAskToUpdateLinks ( )

True if Microsoft Excel asks the user to update links when opening files with links.

False if links are automatically updated with no dialog box.

MSDN documentation for Application.AskToUpdateLinks.

◆ SetAskToUpdateLinks()

void wxAutoExcel::wxExcelApplication::SetAskToUpdateLinks ( bool askToUpdateLinks )

True if Microsoft Excel asks the user to update links when opening files with links.

False if links are automatically updated with no dialog box.

MSDN documentation for Application.AskToUpdateLinks.

◆ GetAutoFormatAsYouTypeReplaceHyperlinks()

bool wxAutoExcel::wxExcelApplication::GetAutoFormatAsYouTypeReplaceHyperlinks ( )

True (default) if Microsoft Excel automatically formats hyperlinks as you type.

False if Excel does not automatically format hyperlinks as you type.

MSDN documentation for Application.AutoFormatAsYouTypeReplaceHyperlinks.

◆ SetAutoFormatAsYouTypeReplaceHyperlinks()

void wxAutoExcel::wxExcelApplication::SetAutoFormatAsYouTypeReplaceHyperlinks ( bool autoFormatAsYouTypeReplaceHyperlinks )

True (default) if Microsoft Excel automatically formats hyperlinks as you type.

False if Excel does not automatically format hyperlinks as you type.

MSDN documentation for Application.AutoFormatAsYouTypeReplaceHyperlinks.

◆ GetAutomationSecurity()

MsoAutomationSecurity wxAutoExcel::wxExcelApplication::GetAutomationSecurity ( )

Returns an MsoAutomationSecurity constant that represents the security mode Microsoft Excel uses when programmatically opening files.

MSDN documentation for Application.AutomationSecurity.

◆ SetAutomationSecurity()

void wxAutoExcel::wxExcelApplication::SetAutomationSecurity ( MsoAutomationSecurity security )

Sets an MsoAutomationSecurity constant that represents the security mode Microsoft Excel uses when programmatically opening files.

MSDN documentation for Application.AutomationSecurity.

◆ GetAutoPercentEntry()

bool wxAutoExcel::wxExcelApplication::GetAutoPercentEntry ( )

True if entries in cells formatted as percentages aren't automatically multiplied by 100 as soon as they are entered.

MSDN documentation for Application.AutoPercentEntry.

◆ SetAutoPercentEntry()

void wxAutoExcel::wxExcelApplication::SetAutoPercentEntry ( bool autoPercentEntry )

True if entries in cells formatted as percentages aren't automatically multiplied by 100 as soon as they are entered.

MSDN documentation for Application.AutoPercentEntry.

◆ GetBuild()

double wxAutoExcel::wxExcelApplication::GetBuild ( )

Returns the Microsoft Excel build number.

MSDN documentation for Application.Build.

◆ GetCalculateBeforeSave()

bool wxAutoExcel::wxExcelApplication::GetCalculateBeforeSave ( )

True if workbooks are calculated before they're saved to disk (if the Calculation property is set to xlManual).

This property is preserved even if you change the Calculation property.

MSDN documentation for Application.CalculateBeforeSave.

◆ SetCalculateBeforeSave()

void wxAutoExcel::wxExcelApplication::SetCalculateBeforeSave ( bool calculateBeforeSave )

True if workbooks are calculated before they're saved to disk (if the Calculation property is set to xlManual).

This property is preserved even if you change the Calculation property.

MSDN documentation for Application.CalculateBeforeSave.

◆ GetCalculation()

XlCalculation wxAutoExcel::wxExcelApplication::GetCalculation ( )

Returns an XlCalculation value that represents the calculation mode.

MSDN documentation for Application.Calculation.

◆ SetCalculation()

void wxAutoExcel::wxExcelApplication::SetCalculation ( XlCalculation calculation )

Sets an XlCalculation value that represents the calculation mode.

There must be at least one active workbook, else the call fails.

MSDN documentation for Application.Calculation.

◆ GetCalculationInterruptKey()

XlCalculationInterruptKey wxAutoExcel::wxExcelApplication::GetCalculationInterruptKey ( )

Returns an XlCalculationInterruptKey constant that specifies the key that can interrupt Microsoft Excel when performing calculations.

MSDN documentation for Application.CalculationInterruptKey.

◆ SetCalculationInterruptKey()

void wxAutoExcel::wxExcelApplication::SetCalculationInterruptKey ( XlCalculationInterruptKey calculationInterruptKey )

Sets an XlCalculationInterruptKey constant that specifies the key that can interrupt Microsoft Excel when performing calculations.

MSDN documentation for Application.CalculationInterruptKey.

◆ GetCalculationState()

XlCalculationState wxAutoExcel::wxExcelApplication::GetCalculationState ( )

Returns an XlCalculationState constant that indicates the calculation state of the application, for any calculations that are being performed in Microsoft Excel.

MSDN documentation for Application.CalculationState.

◆ GetCalculationVersion()

long wxAutoExcel::wxExcelApplication::GetCalculationVersion ( )

Returns a number whose rightmost four digits are the minor calculation engine version number, and whose other digits (on the left) are the major version of Microsoft Excel.

MSDN documentation for Application.CalculationVersion.

◆ GetCaption()

wxString wxAutoExcel::wxExcelApplication::GetCaption ( )

Returns a String value that represents the name that appears in the title bar of the main Microsoft Excel window.

MSDN documentation for Application.Caption.

◆ SetCaption()

void wxAutoExcel::wxExcelApplication::SetCaption ( const wxString & caption )

Sets a String value that represents the name that appears in the title bar of the main Microsoft Excel window.

MSDN documentation for Application.Caption.

◆ GetCellDragAndDrop()

bool wxAutoExcel::wxExcelApplication::GetCellDragAndDrop ( )

True if dragging and dropping cells is enabled.

MSDN documentation for Application.CellDragAndDrop.

◆ SetCellDragAndDrop()

void wxAutoExcel::wxExcelApplication::SetCellDragAndDrop ( bool cellDragAndDrop )

True if dragging and dropping cells is enabled.

MSDN documentation for Application.CellDragAndDrop.

◆ GetClipboardFormats()

wxArrayLong wxAutoExcel::wxExcelApplication::GetClipboardFormats ( )

Returns the formats that are currently on the Clipboard, as an array of numeric values.

To determine whether a particular format is on the Clipboard, compare each element in the array with the appropriate XlClipboardFormat constant.

MSDN documentation for Application.ClipboardFormats.

◆ GetConstrainNumeric()

bool wxAutoExcel::wxExcelApplication::GetConstrainNumeric ( )

True if handwriting recognition is limited to numbers and punctuation only.

This property is available only if you're using Microsoft Windows for Pen Computing.

MSDN documentation for Application.ConstrainNumeric.

◆ SetConstrainNumeric()

void wxAutoExcel::wxExcelApplication::SetConstrainNumeric ( bool constrainNumeric )

True if handwriting recognition is limited to numbers and punctuation only.

This property is available only if you're using Microsoft Windows for Pen Computing.

MSDN documentation for Application.ConstrainNumeric.

◆ GetControlCharacters()

bool wxAutoExcel::wxExcelApplication::GetControlCharacters ( )

True if Microsoft Excel displays control characters for right-to-left languages.

MSDN documentation for Application.ControlCharacters.

◆ SetControlCharacters()

void wxAutoExcel::wxExcelApplication::SetControlCharacters ( bool controlCharacters )

True if Microsoft Excel displays control characters for right-to-left languages.

This property can be set only when right to left language support has been installed and selected.

MSDN documentation for Application.ControlCharacters.

◆ GetCopyObjectsWithCells()

bool wxAutoExcel::wxExcelApplication::GetCopyObjectsWithCells ( )

True if objects are cut, copied, extracted, and sorted with cells.

MSDN documentation for Application.CopyObjectsWithCells.

◆ SetCopyObjectsWithCells()

void wxAutoExcel::wxExcelApplication::SetCopyObjectsWithCells ( bool copyObjectsWithCells )

True if objects are cut, copied, extracted, and sorted with cells.

MSDN documentation for Application.CopyObjectsWithCells.

◆ GetCursor()

XlMousePointer wxAutoExcel::wxExcelApplication::GetCursor ( )

Returns the appearance of the mouse pointer in Microsoft Excel.

MSDN documentation for Application.Cursor.

◆ SetCursor()

void wxAutoExcel::wxExcelApplication::SetCursor ( XlMousePointer cursor )

Sets the appearance of the mouse pointer in Microsoft Excel.

MSDN documentation for Application.Cursor.

◆ GetCursorMovement()

long wxAutoExcel::wxExcelApplication::GetCursorMovement ( )

Returns a value that indicates whether a visual cursor or a logical cursor is used.

Can be one of the following constants: xlVisualCursor or xlLogicalCursor.

MSDN documentation for Application.CursorMovement.

◆ GetCustomListCount()

long wxAutoExcel::wxExcelApplication::GetCustomListCount ( )

Returns the number of defined custom lists (including built-in lists).

MSDN documentation for Application.CustomListCount.

◆ GetCutCopyMode()

long wxAutoExcel::wxExcelApplication::GetCutCopyMode ( )

Returns the status of Cut or Copy mode.

Can be 0 ( for false) or an XlCutCopyMode constant.

MSDN documentation for Application.CutCopyMode.

◆ SetCutCopyMode()

void wxAutoExcel::wxExcelApplication::SetCutCopyMode ( )

Cancels Cut or Copy mode and removes the moving border.

MSDN documentation for Application.CutCopyMode.

◆ GetDataEntryMode()

long wxAutoExcel::wxExcelApplication::GetDataEntryMode ( )

Returns Data Entry mode (xlOn, xlOff or xlStrict).

When in Data Entry mode, you can enter data only in the unlocked cells in the currently selected range.

MSDN documentation for Application.DataEntryMode.

◆ SetDataEntryMode()

void wxAutoExcel::wxExcelApplication::SetDataEntryMode ( long dataEntryMode )

Sets Data Entry mode (xlOn, xlOff or xlStrict).

When in Data Entry mode, you can enter data only in the unlocked cells in the currently selected range.

MSDN documentation for Application.DataEntryMode.

◆ GetDDEAppReturnCode()

long wxAutoExcel::wxExcelApplication::GetDDEAppReturnCode ( )

Returns the application-specific DDE return code that was contained in the last DDE acknowledge message received by Microsoft Excel.

MSDN documentation for Application.DDEAppReturnCode.

◆ GetDecimalSeparator()

wxString wxAutoExcel::wxExcelApplication::GetDecimalSeparator ( )

Returns the character used for the decimal separator.

MSDN documentation for Application.DecimalSeparator.

◆ SetDecimalSeparator()

void wxAutoExcel::wxExcelApplication::SetDecimalSeparator ( const wxString & decimalSeparator )

Sets the character used for the decimal separator.

MSDN documentation for Application.DecimalSeparator.

◆ GetDefaultFilePath()

wxString wxAutoExcel::wxExcelApplication::GetDefaultFilePath ( )

Returns the default path that Microsoft Excel uses when it opens files.

MSDN documentation for Application.DefaultFilePath.

◆ SetDefaultFilePath()

void wxAutoExcel::wxExcelApplication::SetDefaultFilePath ( const wxString & defaultFilePath )

Sets the default path that Microsoft Excel uses when it opens files.

MSDN documentation for Application.DefaultFilePath.

◆ GetDefaultSaveFormat()

XlFileFormat wxAutoExcel::wxExcelApplication::GetDefaultSaveFormat ( )

Returns the default format for saving files.

MSDN documentation for Application.DefaultSaveFormat.

◆ SetDefaultSaveFormat()

void wxAutoExcel::wxExcelApplication::SetDefaultSaveFormat ( XlFileFormat defaultSaveFormat )

Sets the default format for saving files.

MSDN documentation for Application.DefaultSaveFormat.

◆ GetDefaultSheetDirection()

long wxAutoExcel::wxExcelApplication::GetDefaultSheetDirection ( )

Returns the default direction in which Microsoft Excel displays new windows and worksheets.

Can be one of the following constants: xlRTL (right to left) or xlLTR (left to right).

MSDN documentation for Application.DefaultSheetDirection.

◆ SetDefaultSheetDirection()

void wxAutoExcel::wxExcelApplication::SetDefaultSheetDirection ( long defaultSheetDirection )

Sets the default direction in which Microsoft Excel displays new windows and worksheets.

Can be one of the following constants: xlRTL (right to left) or xlLTR (left to right).

MSDN documentation for Application.DefaultSheetDirection.

◆ GetDisplayAlerts()

bool wxAutoExcel::wxExcelApplication::GetDisplayAlerts ( )

True if Microsoft Excel displays certain alerts and messages.

MSDN documentation for Application.DisplayAlerts.

◆ SetDisplayAlerts()

void wxAutoExcel::wxExcelApplication::SetDisplayAlerts ( bool displayAlerts )

True if Microsoft Excel displays certain alerts and messages.

MSDN documentation for Application.DisplayAlerts.

◆ GetDisplayCommentIndicator()

XlCommentDisplayMode wxAutoExcel::wxExcelApplication::GetDisplayCommentIndicator ( )

Returns the way cells display comments and indicators.

Can be one of the XlCommentDisplayMode constants.

MSDN documentation for Application.DisplayCommentIndicator.

◆ SetDisplayCommentIndicator()

void wxAutoExcel::wxExcelApplication::SetDisplayCommentIndicator ( XlCommentDisplayMode displayCommentIndicator )

Sets the way cells display comments and indicators.

Can be one of the XlCommentDisplayMode constants.

MSDN documentation for Application.DisplayCommentIndicator.

◆ GetDisplayFormulaAutoComplete()

bool wxAutoExcel::wxExcelApplication::GetDisplayFormulaAutoComplete ( )

Gets or sets whether to show a list of relevant functions and defined names when building cell formulas.

Since MS Excel 2007.

MSDN documentation for Application.DisplayFormulaAutoComplete.

◆ SetDisplayFormulaAutoComplete()

void wxAutoExcel::wxExcelApplication::SetDisplayFormulaAutoComplete ( bool displayFormulaAutoComplete )

Gets or sets whether to show a list of relevant functions and defined names when building cell formulas.

Since MS Excel 2007.

MSDN documentation for Application.DisplayFormulaAutoComplete.

◆ GetDisplayFormulaBar()

bool wxAutoExcel::wxExcelApplication::GetDisplayFormulaBar ( )

True if the formula bar is displayed.

MSDN documentation for Application.DisplayFormulaBar.

◆ SetDisplayFormulaBar()

void wxAutoExcel::wxExcelApplication::SetDisplayFormulaBar ( bool displayFormulaBar )

True if the formula bar is to be displayed.

MSDN documentation for Application.DisplayFormulaBar.

◆ GetDisplayFullScreen()

bool wxAutoExcel::wxExcelApplication::GetDisplayFullScreen ( )

True if Microsoft Excel is in full-screen mode.

MSDN documentation for Application.DisplayFullScreen.

◆ SetDisplayFullScreen()

void wxAutoExcel::wxExcelApplication::SetDisplayFullScreen ( bool displayFullScreen )

True if Microsoft Excel should switch to a full-screen mode.

MSDN documentation for Application.DisplayFullScreen.

◆ GetDisplayFunctionToolTips()

bool wxAutoExcel::wxExcelApplication::GetDisplayFunctionToolTips ( )

True if function ToolTips can be displayed.

MSDN documentation for Application.DisplayFunctionToolTips.

◆ SetDisplayFunctionToolTips()

void wxAutoExcel::wxExcelApplication::SetDisplayFunctionToolTips ( bool displayFunctionToolTips )

True if function ToolTips are to be displayed.

MSDN documentation for Application.DisplayFunctionToolTips.

◆ GetDisplayNoteIndicator()

bool wxAutoExcel::wxExcelApplication::GetDisplayNoteIndicator ( )

True if cells containing notes display cell tips and contain note indicators (small dots in their upper-right corners).

MSDN documentation for Application.DisplayNoteIndicator.

◆ SetDisplayNoteIndicator()

void wxAutoExcel::wxExcelApplication::SetDisplayNoteIndicator ( bool displayNoteIndicator )

True if cells containing notes display cell tips and contain note indicators (small dots in their upper-right corners).

MSDN documentation for Application.DisplayNoteIndicator.

◆ GetDisplayScrollBars()

bool wxAutoExcel::wxExcelApplication::GetDisplayScrollBars ( )

True if scroll bars are visible for all workbooks.

MSDN documentation for Application.DisplayScrollBars.

◆ SetDisplayScrollBars()

void wxAutoExcel::wxExcelApplication::SetDisplayScrollBars ( bool displayScrollBars )

True if scroll bars are to be visible for all workbooks.

MSDN documentation for Application.DisplayScrollBars.

◆ GetDisplayStatusBar()

bool wxAutoExcel::wxExcelApplication::GetDisplayStatusBar ( )

True if the status bar is displayed.

MSDN documentation for Application.DisplayStatusBar.

◆ SetDisplayStatusBar()

void wxAutoExcel::wxExcelApplication::SetDisplayStatusBar ( bool displayStatusBar )

True if the status bar is to be displayed.

MSDN documentation for Application.DisplayStatusBar.

◆ GetEditDirectlyInCell()

bool wxAutoExcel::wxExcelApplication::GetEditDirectlyInCell ( )

True if Microsoft Excel allows editing in cells.

MSDN documentation for Application.EditDirectlyInCell.

◆ SetEditDirectlyInCell()

void wxAutoExcel::wxExcelApplication::SetEditDirectlyInCell ( bool editDirectlyInCell )

True if Microsoft Excel should allow editing in cells.

MSDN documentation for Application.EditDirectlyInCell.

◆ GetEnableAnimations()

bool wxAutoExcel::wxExcelApplication::GetEnableAnimations ( )

True if animated insertion and deletion is enabled.

MSDN documentation for Application.EnableAnimations.

◆ SetEnableAnimations()

void wxAutoExcel::wxExcelApplication::SetEnableAnimations ( bool enableAnimations )

True if animated insertion and deletion is to be enabled.

MSDN documentation for Application.EnableAnimations.

◆ GetEnableAutoComplete()

bool wxAutoExcel::wxExcelApplication::GetEnableAutoComplete ( )

True if the AutoComplete feature is enabled.

MSDN documentation for Application.EnableAutoComplete.

◆ SetEnableAutoComplete()

void wxAutoExcel::wxExcelApplication::SetEnableAutoComplete ( bool enableAutoComplete )

True if the AutoComplete feature is to be enabled.

MSDN documentation for Application.EnableAutoComplete.

◆ GetEnableCancelKey()

XlEnableCancelKey wxAutoExcel::wxExcelApplication::GetEnableCancelKey ( )

Controls how Microsoft Excel handles CTRL+BREAK (or ESC or COMMAND+PERIOD) user interruptions to the running procedure.

MSDN documentation for Application.EnableCancelKey.

◆ SetEnableCancelKey()

void wxAutoExcel::wxExcelApplication::SetEnableCancelKey ( XlEnableCancelKey enableCancelKey )

Controls how Microsoft Excel handles CTRL+BREAK (or ESC or COMMAND+PERIOD) user interruptions to the running procedure.

MSDN documentation for Application.EnableCancelKey.

◆ GetEnableLargeOperationAlert()

bool wxAutoExcel::wxExcelApplication::GetEnableLargeOperationAlert ( )

Returns a Boolean that represents whether to display an alert message when a user attempts to perform an operation that affects a larger number of cells than is specified in the Office center UI.

Since MS Excel 2007.

MSDN documentation for Application.EnableLargeOperationAlert.

◆ SetEnableLargeOperationAlert()

void wxAutoExcel::wxExcelApplication::SetEnableLargeOperationAlert ( bool enableLargeOperationAlert )

Sets a Boolean that represents whether to display an alert message when a user attempts to perform an operation that affects a larger number of cells than is specified in the Office center UI.

Since MS Excel 2007.

MSDN documentation for Application.EnableLargeOperationAlert.

◆ GetEnableLivePreview()

bool wxAutoExcel::wxExcelApplication::GetEnableLivePreview ( )

Returns a Boolean that represents whether to show or hide gallery previews that appear when using galleries that support previewing.

Setting this property to True shows a preview of your workbook before applying the command. Since MS Excel 2007.

MSDN documentation for Application.EnableLivePreview.

◆ SetEnableLivePreview()

void wxAutoExcel::wxExcelApplication::SetEnableLivePreview ( bool enableLivePreview )

Sets a Boolean that represents whether to show or hide gallery previews that appear when using galleries that support previewing.

Setting this property to True shows a preview of your workbook before applying the command. Since MS Excel 2007.

MSDN documentation for Application.EnableLivePreview.

◆ GetEnableMacroAnimations()

bool wxAutoExcel::wxExcelApplication::GetEnableMacroAnimations ( )

Controls whether macro animations are enabled.

Excel VBA documentation for Application.EnableMacroAnimations

◆ SetEnableMacroAnimations()

void wxAutoExcel::wxExcelApplication::SetEnableMacroAnimations ( bool enableMacroAnimations )

Controls whether macro animations are enabled.

Excel VBA documentation for Application.EnableMacroAnimations

◆ GetEnableSound()

bool wxAutoExcel::wxExcelApplication::GetEnableSound ( )

True if sound is enabled for Microsoft Office.

MSDN documentation for Application.EnableSound.

◆ SetEnableSound()

void wxAutoExcel::wxExcelApplication::SetEnableSound ( bool enableSound )

True if sound is enabled for Microsoft Office.

MSDN documentation for Application.EnableSound.

◆ GetErrorCheckingOptions()

wxExcelErrorCheckingOptions wxAutoExcel::wxExcelApplication::GetErrorCheckingOptions ( )

Returns an ErrorCheckingOptions object, which represents the error checking options for an application.

MSDN documentation for Application.ErrorCheckingOptions.

◆ GetExtendList()

bool wxAutoExcel::wxExcelApplication::GetExtendList ( )

True if Microsoft Excel automatically extends formatting and formulas to new data that is added to a list.

MSDN documentation for Application.ExtendList.

◆ SetExtendList()

void wxAutoExcel::wxExcelApplication::SetExtendList ( bool extendList )

True if Microsoft Excel automatically extends formatting and formulas to new data that is added to a list.

MSDN documentation for Application.ExtendList.

◆ GetFeatureInstall()

MsoFeatureInstall wxAutoExcel::wxExcelApplication::GetFeatureInstall ( )

Returns a value (constant) that specifies how Microsoft Excel handles calls to methods and properties that require features that aren't yet installed.

Can be one of the MsoFeatureInstall constants listed in the following table.

MSDN documentation for Application.FeatureInstall.

◆ SetFeatureInstall()

void wxAutoExcel::wxExcelApplication::SetFeatureInstall ( MsoFeatureInstall featureInstall )

Sets a value (constant) that specifies how Microsoft Excel handles calls to methods and properties that require features that aren't yet installed.

Can be one of the MsoFeatureInstall constants listed in the following table.

MSDN documentation for Application.FeatureInstall.

◆ GetFileExportConverters()

wxExcelFileExportConverters wxAutoExcel::wxExcelApplication::GetFileExportConverters ( )

Returns a FileExportConverters collection that represents all the file converters for saving files available to Microsoft Excel.

MSDN documentation for Application.FileExportConverters.

◆ GetFileValidation()

MsoFileValidationMode wxAutoExcel::wxExcelApplication::GetFileValidation ( )

Returns how Excel will validate files before opening them.

Since Excel 2010.

MSDN documentation for Application.FileValidation.

◆ SetFileValidation()

void wxAutoExcel::wxExcelApplication::SetFileValidation ( MsoFileValidationMode fileValidation )

Sets how Excel will validate files before opening them.

Since Excel 2010.

MSDN documentation for Application.FileValidation.

◆ GetFixedDecimal()

bool wxAutoExcel::wxExcelApplication::GetFixedDecimal ( )

All data entered after this property is set to True will be formatted with the number of fixed decimal places set by the FixedDecimalPlaces property.

MSDN documentation for Application.FixedDecimal.

◆ SetFixedDecimal()

void wxAutoExcel::wxExcelApplication::SetFixedDecimal ( bool fixedDecimal )

All data entered after this property is set to True will be formatted with the number of fixed decimal places set by the FixedDecimalPlaces property.

MSDN documentation for Application.FixedDecimal.

◆ GetFixedDecimalPlaces()

long wxAutoExcel::wxExcelApplication::GetFixedDecimalPlaces ( )

Returns the number of fixed decimal places used when the FixedDecimal property is set to True.

MSDN documentation for Application.FixedDecimalPlaces.

◆ SetFixedDecimalPlaces()

void wxAutoExcel::wxExcelApplication::SetFixedDecimalPlaces ( long fixedDecimalPlaces )

Sets the number of fixed decimal places used when the FixedDecimal property is set to True.

MSDN documentation for Application.FixedDecimalPlaces.

◆ GetFlashFill()

bool wxAutoExcel::wxExcelApplication::GetFlashFill ( )

Controls whether Flash Fill feature has been enabled and active.

Excel VBA documentation for Application.FlashFill

◆ SetFlashFill()

void wxAutoExcel::wxExcelApplication::SetFlashFill ( bool flashFill )

Controls whether Flash Fill feature has been enabled and active.

Excel VBA documentation for Application.FlashFill

◆ GetFlashFillMode()

bool wxAutoExcel::wxExcelApplication::GetFlashFillMode ( )

Controls whether Flash Fill feature is enabled.

Excel VBA documentation for Application.FlashFillMode

◆ SetFlashFillMode()

void wxAutoExcel::wxExcelApplication::SetFlashFillMode ( bool flashFillMode )

Controls whether Flash Fill feature is enabled.

Excel VBA documentation for Application.FlashFillMode

◆ GetFormulaBarHeight()

long wxAutoExcel::wxExcelApplication::GetFormulaBarHeight ( )

Allows the user to specify the height of the formula bar in lines.

Since MS Excel 2007.

MSDN documentation for Application.FormulaBarHeight.

◆ SetFormulaBarHeight()

void wxAutoExcel::wxExcelApplication::SetFormulaBarHeight ( long formulaBarHeight )

Allows the user to specify the height of the formula bar in lines.

Since MS Excel 2007.

MSDN documentation for Application.FormulaBarHeight.

◆ GetGenerateGetPivotData()

bool wxAutoExcel::wxExcelApplication::GetGenerateGetPivotData ( )

Returns True when Microsoft Excel can get PivotTable report data.

MSDN documentation for Application.GenerateGetPivotData.

◆ SetGenerateGetPivotData()

void wxAutoExcel::wxExcelApplication::SetGenerateGetPivotData ( bool generateGetPivotData )

Returns True when Microsoft Excel can get PivotTable report data.

MSDN documentation for Application.GenerateGetPivotData.

◆ GetGenerateTableRefs()

XlGenerateTableRefs wxAutoExcel::wxExcelApplication::GetGenerateTableRefs ( )

The GenerateTableRefs property determines whether the traditional notation method or the new structured referencing notation method is used for referencing tables in formulas.

Since MS Excel 2007.

MSDN documentation for Application.GenerateTableRefs.

◆ SetGenerateTableRefs()

void wxAutoExcel::wxExcelApplication::SetGenerateTableRefs ( XlGenerateTableRefs generateTableRefs )

The GenerateTableRefs property determines whether the traditional notation method or the new structured referencing notation method is used for referencing tables in formulas.

Since MS Excel 2007.

MSDN documentation for Application.GenerateTableRefs.

◆ GetHeight()

double wxAutoExcel::wxExcelApplication::GetHeight ( )

Returns a Double value that represents the height in points of the main application window.

MSDN documentation for Application.Height.

◆ SetHeight()

void wxAutoExcel::wxExcelApplication::SetHeight ( double height )

Sets a Double value that represents the height in points of the main application window.

MSDN documentation for Application.Height.

◆ GetHighQualityModeForGraphics()

bool wxAutoExcel::wxExcelApplication::GetHighQualityModeForGraphics ( )

Returns whether Excel uses high quality mode to print graphics.

MSDN documentation for Application.HighQualityModeForGraphics.

◆ SetHighQualityModeForGraphics()

void wxAutoExcel::wxExcelApplication::SetHighQualityModeForGraphics ( bool highQualityModeForGraphics )

Sets whether Excel uses high quality mode to print graphics.

MSDN documentation for Application.HighQualityModeForGraphics.

◆ GetHinstance()

long wxAutoExcel::wxExcelApplication::GetHinstance ( )

Returns the instance Microsoft Excel application.

MSDN documentation for Application.Hinstance.

◆ GetHinstancePtr()

wxAEHinstPtr wxAutoExcel::wxExcelApplication::GetHinstancePtr ( )

Returns the instance Microsoft Excel application.

Since Excel 2010.

MSDN documentation for Application.HinstancePtr.

◆ GetHwnd()

long wxAutoExcel::wxExcelApplication::GetHwnd ( )

Returns a Long indicating the top-level window handle of the Microsoft Excel window.

MSDN documentation for Application.Hwnd.

◆ GetIgnoreRemoteRequests()

bool wxAutoExcel::wxExcelApplication::GetIgnoreRemoteRequests ( )

True if remote DDE requests are ignored.

MSDN documentation for Application.IgnoreRemoteRequests.

◆ SetIgnoreRemoteRequests()

void wxAutoExcel::wxExcelApplication::SetIgnoreRemoteRequests ( bool ignoreRemoteRequests )

True if remote DDE requests are ignored.

MSDN documentation for Application.IgnoreRemoteRequests.

◆ GetInteractive()

bool wxAutoExcel::wxExcelApplication::GetInteractive ( )

True if Microsoft Excel is in interactive mode.

MSDN documentation for Application.Interactive.

◆ SetInteractive()

void wxAutoExcel::wxExcelApplication::SetInteractive ( bool interactive )

True to set Microsoft Excel into interactive mode.

MSDN documentation for Application.Interactive.

◆ GetInternational()

wxVariant wxAutoExcel::wxExcelApplication::GetInternational ( XlApplicationInternational * index = NULL )

Returns information about the current country/region and international settings.

When called without a parameter, all the values are returned as a list.

MSDN documentation for Application.International.

◆ GetIteration()

bool wxAutoExcel::wxExcelApplication::GetIteration ( )

True if Microsoft Excel will use iteration to resolve circular references.

MSDN documentation for Application.Iteration.

◆ SetIteration()

void wxAutoExcel::wxExcelApplication::SetIteration ( bool iteration )

True if Microsoft Excel will use iteration to resolve circular references.

MSDN documentation for Application.Iteration.

◆ GetIsSandboxed()

bool wxAutoExcel::wxExcelApplication::GetIsSandboxed ( )

Returns true if the specified workbook is open in a Protected View window.

Since Excel 2010.

MSDN documentation for Application.IsSandboxed.

◆ GetLanguageSettings()

wxExcelLanguageSettings wxAutoExcel::wxExcelApplication::GetLanguageSettings ( )

Returns the LanguageSettings object, which contains information about the language settings in Microsoft Excel.

MSDN documentation for Application.LanguageSettings.

◆ GetLargeOperationCellThousandCount()

long wxAutoExcel::wxExcelApplication::GetLargeOperationCellThousandCount ( )

Returns the maximum number of cells needed in an operation beyond which an alert is triggered.

Since MS Excel 2007.

MSDN documentation for Application.LargeOperationCellThousandCount.

◆ SetLargeOperationCellThousandCount()

void wxAutoExcel::wxExcelApplication::SetLargeOperationCellThousandCount ( long largeOperationCellThousandCount )

Sets the maximum number of cells needed in an operation beyond which an alert is triggered.

Since MS Excel 2007.

MSDN documentation for Application.LargeOperationCellThousandCount.

◆ GetLeft()

double wxAutoExcel::wxExcelApplication::GetLeft ( )

The distance, in points, from the left edge of the screen to the left edge of the main Microsoft Excel window.

MSDN documentation for Application.Left.

◆ SetLeft()

void wxAutoExcel::wxExcelApplication::SetLeft ( double left )

The distance, in points, from the left edge of the screen to the left edge of the main Microsoft Excel window.

MSDN documentation for Application.Left.

◆ GetLibraryPath()

wxString wxAutoExcel::wxExcelApplication::GetLibraryPath ( )

Returns the path to the Library folder, but without the final separator.

MSDN documentation for Application.LibraryPath.

◆ GetMailSession()

wxString wxAutoExcel::wxExcelApplication::GetMailSession ( )

Returns the MAPI mail session number as a hexadecimal string (if there's an active session), or an empty string if there's no session.

MSDN documentation for Application.MailSession.

◆ GetMailSystem()

XlMailSystem wxAutoExcel::wxExcelApplication::GetMailSystem ( )

Returns the mail system that's installed on the host machine.

MSDN documentation for Application.MailSystem.

◆ GetMapPaperSize()

bool wxAutoExcel::wxExcelApplication::GetMapPaperSize ( )

True if documents formatted for the standard paper size of another country/region (for example, A4) are automatically adjusted so that they're printed correctly on the standard paper size (for example, Letter) of your country/region.

MSDN documentation for Application.MapPaperSize.

◆ SetMapPaperSize()

void wxAutoExcel::wxExcelApplication::SetMapPaperSize ( bool mapPaperSize )

True if documents formatted for the standard paper size of another country/region (for example, A4) are automatically adjusted so that they're printed correctly on the standard paper size (for example, Letter) of your country/region.

MSDN documentation for Application.MapPaperSize.

◆ GetMathCoprocessorAvailable()

bool wxAutoExcel::wxExcelApplication::GetMathCoprocessorAvailable ( )

True if a math coprocessor is available.

MSDN documentation for Application.MathCoprocessorAvailable.

◆ GetMaxChange()

double wxAutoExcel::wxExcelApplication::GetMaxChange ( )

Returns the maximum amount of change between each iteration as Microsoft Excel resolves circular references.

MSDN documentation for Application.MaxChange.

◆ SetMaxChange()

void wxAutoExcel::wxExcelApplication::SetMaxChange ( double maxChange )

Sets the maximum amount of change between each iteration as Microsoft Excel resolves circular references.

MSDN documentation for Application.MaxChange.

◆ GetMaxIterations()

long wxAutoExcel::wxExcelApplication::GetMaxIterations ( )

Returns the maximum number of iterations that Microsoft Excel can use to resolve a circular reference.

MSDN documentation for Application.MaxIterations.

◆ SetMaxIterations()

void wxAutoExcel::wxExcelApplication::SetMaxIterations ( long iterations )

Sets the maximum number of iterations that Microsoft Excel can use to resolve a circular reference.

MSDN documentation for Application.MaxIterations.

◆ GetMergeInstances()

bool wxAutoExcel::wxExcelApplication::GetMergeInstances ( )

Controls whether to merge multiple instances of the application into a single one.

Excel VBA documentation for Application.MergeInstances

◆ SetMergeInstances()

void wxAutoExcel::wxExcelApplication::SetMergeInstances ( bool mergeInstances )

Controls whether to merge multiple instances of the application into a single one.

Excel VBA documentation for Application.MergeInstances

◆ GetMeasurementUnit()

XlMeasurementUnits wxAutoExcel::wxExcelApplication::GetMeasurementUnit ( )

Specifies the measurement unit used in the application.

Since MS Excel 2007.

MSDN documentation for Application.MeasurementUnit.

◆ SetMeasurementUnit()

void wxAutoExcel::wxExcelApplication::SetMeasurementUnit ( XlMeasurementUnits measurementUnit )

Specifies the measurement unit used in the application.

Since MS Excel 2007.

MSDN documentation for Application.MeasurementUnit.

◆ GetMouseAvailable()

bool wxAutoExcel::wxExcelApplication::GetMouseAvailable ( )

True if a mouse is available.

MSDN documentation for Application.MouseAvailable.

◆ GetMoveAfterReturn()

bool wxAutoExcel::wxExcelApplication::GetMoveAfterReturn ( )

True if the active cell will be moved as soon as the ENTER (RETURN) key is pressed.

MSDN documentation for Application.MoveAfterReturn.

◆ SetMoveAfterReturn()

void wxAutoExcel::wxExcelApplication::SetMoveAfterReturn ( bool moveAfterReturn )

True if the active cell will be moved as soon as the ENTER (RETURN) key is pressed.

MSDN documentation for Application.MoveAfterReturn.

◆ GetMoveAfterReturnDirection()

XlDirection wxAutoExcel::wxExcelApplication::GetMoveAfterReturnDirection ( )

Returns the direction in which the active cell is moved when the user presses ENTER.

MSDN documentation for Application.MoveAfterReturnDirection.

◆ SetMoveAfterReturnDirection()

void wxAutoExcel::wxExcelApplication::SetMoveAfterReturnDirection ( XlDirection moveAfterReturnDirection )

Sets the direction in which the active cell is moved when the user presses ENTER.

MSDN documentation for Application.MoveAfterReturnDirection.

◆ GetMultiThreadedCalculation()

wxExcelMultiThreadedCalculation wxAutoExcel::wxExcelApplication::GetMultiThreadedCalculation ( )

Returns a MultiThreadedCalculation object that controls the multi-threaded recalculation settings.

MSDN documentation for Application.MultiThreadedCalculation

◆ GetName()

wxString wxAutoExcel::wxExcelApplication::GetName ( )

Returns the name of the object.

MSDN documentation for Application.Name.

◆ GetNames()

wxExcelNames wxAutoExcel::wxExcelApplication::GetNames ( )

Returns a Names collection that represents all the names in the active workbook.

MSDN documentation for Application.Names.

◆ GetNetworkTemplatesPath()

wxString wxAutoExcel::wxExcelApplication::GetNetworkTemplatesPath ( )

Returns the network path where templates are stored.

If the network path doesn't exist, this property returns an empty string.

MSDN documentation for Application.NetworkTemplatesPath.

◆ GetODBCTimeout()

long wxAutoExcel::wxExcelApplication::GetODBCTimeout ( )

Returns the ODBC query time limit, in seconds.

The default value is 45 seconds.

MSDN documentation for Application.ODBCTimeout.

◆ SetODBCTimeout()

void wxAutoExcel::wxExcelApplication::SetODBCTimeout ( long oDBCTimeout )

Sets the ODBC query time limit, in seconds.

The default value is 45 seconds.

MSDN documentation for Application.ODBCTimeout.

◆ GetOperatingSystem()

wxString wxAutoExcel::wxExcelApplication::GetOperatingSystem ( )

Returns the name and version number of the current operating system - for example, "Windows (32-bit) 4.00" or "Macintosh 7.00".

MSDN documentation for Application.OperatingSystem.

◆ GetOrganizationName()

wxString wxAutoExcel::wxExcelApplication::GetOrganizationName ( )

Returns the registered organization name.

MSDN documentation for Application.OrganizationName.

◆ GetPath()

wxString wxAutoExcel::wxExcelApplication::GetPath ( )

Returns a String value that represents the complete path to the application, excluding the final separator and name of the application.

MSDN documentation for Application.Path.

◆ GetPathSeparator()

wxString wxAutoExcel::wxExcelApplication::GetPathSeparator ( )

Returns the path separator character ("\").

MSDN documentation for Application.PathSeparator.

◆ GetPivotTableSelection()

bool wxAutoExcel::wxExcelApplication::GetPivotTableSelection ( )

True if PivotTable reports use structured selection.

MSDN documentation for Application.PivotTableSelection.

◆ SetPivotTableSelection()

void wxAutoExcel::wxExcelApplication::SetPivotTableSelection ( bool pivotTableSelection )

True if PivotTable reports use structured selection.

MSDN documentation for Application.PivotTableSelection.

◆ GetPrintCommunication()

bool wxAutoExcel::wxExcelApplication::GetPrintCommunication ( )

Specifies whether communication with the printer is turned on.

Since Excel 2010.

MSDN documentation for Application.PrintCommunication.

◆ SetPrintCommunication()

void wxAutoExcel::wxExcelApplication::SetPrintCommunication ( bool printCommunication )

Specifies whether communication with the printer is turned on.

Since Excel 2010.

MSDN documentation for Application.PrintCommunication.

◆ GetProductCode()

wxString wxAutoExcel::wxExcelApplication::GetProductCode ( )

Returns the globally unique identifier (GUID) for Microsoft Excel.

MSDN documentation for Application.ProductCode.

◆ GetPromptForSummaryInfo()

bool wxAutoExcel::wxExcelApplication::GetPromptForSummaryInfo ( )

True if Microsoft Excel asks for summary information when files are first saved.

MSDN documentation for Application.PromptForSummaryInfo.

◆ SetPromptForSummaryInfo()

void wxAutoExcel::wxExcelApplication::SetPromptForSummaryInfo ( bool promptForSummaryInfo )

True if Microsoft Excel asks for summary information when files are first saved.

MSDN documentation for Application.PromptForSummaryInfo.

◆ GetReady()

bool wxAutoExcel::wxExcelApplication::GetReady ( )

Returns True when the Microsoft Excel application is ready.

MSDN documentation for Application.Ready.

◆ GetRecentFiles()

wxExcelRecentFiles wxAutoExcel::wxExcelApplication::GetRecentFiles ( )

Returns a RecentFiles collection that represents the list of recently used files.

MSDN documentation for Application.RecentFiles.

◆ GetReferenceStyle()

XlReferenceStyle wxAutoExcel::wxExcelApplication::GetReferenceStyle ( )

Returns how Microsoft Excel displays cell references and row and column headings in either A1 or R1C1 reference style.

MSDN documentation for Application.ReferenceStyle.

◆ SetReferenceStyle()

void wxAutoExcel::wxExcelApplication::SetReferenceStyle ( XlReferenceStyle referenceStyle )

Sets how Microsoft Excel displays cell references and row and column headings in either A1 or R1C1 reference style.

MSDN documentation for Application.ReferenceStyle.

◆ GetRollZoom()

bool wxAutoExcel::wxExcelApplication::GetRollZoom ( )

True if the IntelliMouse zooms instead of scrolling.

MSDN documentation for Application.RollZoom.

◆ SetRollZoom()

void wxAutoExcel::wxExcelApplication::SetRollZoom ( bool rollZoom )

True if the IntelliMouse zooms instead of scrolling.

MSDN documentation for Application.RollZoom.

◆ GetScreenUpdating()

bool wxAutoExcel::wxExcelApplication::GetScreenUpdating ( )

True if screen updating is turned on.

MSDN documentation for Application.ScreenUpdating.

◆ SetScreenUpdating()

void wxAutoExcel::wxExcelApplication::SetScreenUpdating ( bool screenUpdating )

True if screen updating is turned on.

MSDN documentation for Application.ScreenUpdating.

◆ GetSheets()

wxExcelSheets wxAutoExcel::wxExcelApplication::GetSheets ( )

Returns a Sheets collection that represents all the sheets in the active workbook.

MSDN documentation for Application.Sheets.

◆ GetSheetsInNewWorkbook()

long wxAutoExcel::wxExcelApplication::GetSheetsInNewWorkbook ( )

Returns the number of sheets that Microsoft Excel automatically inserts into new workbooks.

MSDN documentation for Application.SheetsInNewWorkbook.

◆ SetSheetsInNewWorkbook()

void wxAutoExcel::wxExcelApplication::SetSheetsInNewWorkbook ( long sheetsInNewWorkbook )

Sets the number of sheets that Microsoft Excel automatically inserts into new workbooks.

MSDN documentation for Application.SheetsInNewWorkbook.

◆ GetShowDevTools()

bool wxAutoExcel::wxExcelApplication::GetShowDevTools ( )

Returns a Boolean that represents whether the Developer tab is displayed in the Ribbon.

MSDN documentation for Application.ShowDevTools. Since MS Excel 2007.

◆ SetShowDevTools()

void wxAutoExcel::wxExcelApplication::SetShowDevTools ( bool showDevTools )

Sets a Boolean that represents whether the Developer tab is displayed in the Ribbon.

Since MS Excel 2007.

MSDN documentation for Application.ShowDevTools.

◆ GetShowMenuFloaties()

bool wxAutoExcel::wxExcelApplication::GetShowMenuFloaties ( )

Returns a Boolean that represents whether to display Mini toolbars when the user right-clicks in the workbook window.

Since MS Excel 2007.

MSDN documentation for Application.ShowMenuFloaties.

◆ SetShowMenuFloaties()

void wxAutoExcel::wxExcelApplication::SetShowMenuFloaties ( bool showMenuFloaties )

Sets a Boolean that represents whether to display Mini toolbars when the user right-clicks in the workbook window.

Since MS Excel 2007.

MSDN documentation for Application.ShowMenuFloaties.

◆ GetShowQuickAnalysis()

bool wxAutoExcel::wxExcelApplication::GetShowQuickAnalysis ( )

Controls whether the Quick Analysis contextual user interface is displayed on selection.

Excel VBA documentation for Application.ShowQuickAnalysis

◆ SetShowQuickAnalysis()

void wxAutoExcel::wxExcelApplication::SetShowQuickAnalysis ( bool showQuickAnalysis )

Controls whether the Quick Analysis contextual user interface is displayed on selection.

Excel VBA documentation for Application.ShowQuickAnalysis

◆ GetShowSelectionFloaties()

bool wxAutoExcel::wxExcelApplication::GetShowSelectionFloaties ( )

Returns a Boolean that represents whether Mini toolbars displays when a user selects text.

Since MS Excel 2007.

MSDN documentation for Application.ShowSelectionFloaties.

◆ SetShowSelectionFloaties()

void wxAutoExcel::wxExcelApplication::SetShowSelectionFloaties ( bool showSelectionFloaties )

Sets a Boolean that represents whether Mini toolbars displays when a user selects text.

Since MS Excel 2007.

MSDN documentation for Application.ShowSelectionFloaties.

◆ GetShowStartupDialog()

bool wxAutoExcel::wxExcelApplication::GetShowStartupDialog ( )

Returns True (default is False) when the New Workbook task pane appears for a Microsoft Excel application.

MSDN documentation for Application.ShowStartupDialog.

◆ SetShowStartupDialog()

void wxAutoExcel::wxExcelApplication::SetShowStartupDialog ( bool showStartupDialog )

Returns True (default is False) when the New Workbook task pane appears for a Microsoft Excel application.

MSDN documentation for Application.ShowStartupDialog.

◆ GetShowToolTips()

bool wxAutoExcel::wxExcelApplication::GetShowToolTips ( )

True if ToolTips are turned on.

MSDN documentation for Application.ShowToolTips.

◆ SetShowToolTips()

void wxAutoExcel::wxExcelApplication::SetShowToolTips ( bool showToolTips )

True if ToolTips are turned on.

MSDN documentation for Application.ShowToolTips.

◆ GetShowWindowsInTaskbar()

bool wxAutoExcel::wxExcelApplication::GetShowWindowsInTaskbar ( )

True if there's a separate Windows taskbar button for each open workbook.

The default value is True.

MSDN documentation for Application.ShowWindowsInTaskbar.

◆ SetShowWindowsInTaskbar()

void wxAutoExcel::wxExcelApplication::SetShowWindowsInTaskbar ( bool showWindowsInTaskbar )

True if there's a separate Windows taskbar button for each open workbook.

The default value is True.

MSDN documentation for Application.ShowWindowsInTaskbar.

◆ GetStandardFont()

wxString wxAutoExcel::wxExcelApplication::GetStandardFont ( )

Returns the name of the standard font.

MSDN documentation for Application.StandardFont.

◆ SetStandardFont()

void wxAutoExcel::wxExcelApplication::SetStandardFont ( const wxString & standardFont )

Sets the name of the standard font.

The change doesn't take effect until you restart Microsoft Excel.

MSDN documentation for Application.StandardFont.

◆ GetStandardFontSize()

double wxAutoExcel::wxExcelApplication::GetStandardFontSize ( )

Returns the standard font size, in points.

MSDN documentation for Application.StandardFontSize.

◆ SetStandardFontSize()

void wxAutoExcel::wxExcelApplication::SetStandardFontSize ( double standardFontSize )

Sets the standard font size, in points.

The change doesn't take effect until you restart Microsoft Excel.

MSDN documentation for Application.StandardFontSize.

◆ GetStartupPath()

wxString wxAutoExcel::wxExcelApplication::GetStartupPath ( )

Returns the complete path of the startup folder, excluding the final separator.

MSDN documentation for Application.StartupPath.

◆ GetStatusBar()

wxString wxAutoExcel::wxExcelApplication::GetStatusBar ( )

Returns the text in the status bar.

MSDN documentation for Application.StatusBar.

◆ SetStatusBar()

void wxAutoExcel::wxExcelApplication::SetStatusBar ( const wxString & statusBar )

Sets the text in the status bar.

The second version restores the default status bar text.

MSDN documentation for Application.StatusBar.

◆ GetTemplatesPath()

wxString wxAutoExcel::wxExcelApplication::GetTemplatesPath ( )

Returns the local path where templates are stored.

MSDN documentation for Application.TemplatesPath.

◆ GetThousandsSeparator()

wxString wxAutoExcel::wxExcelApplication::GetThousandsSeparator ( )

Returns the character used for the thousands separator as a String.

MSDN documentation for Application.ThousandsSeparator.

◆ SetThousandsSeparator()

void wxAutoExcel::wxExcelApplication::SetThousandsSeparator ( const wxString & thousandsSeparator )

Sets the character used for the thousands separator as a String.

MSDN documentation for Application.ThousandsSeparator.

◆ GetTop()

double wxAutoExcel::wxExcelApplication::GetTop ( )

Returns a Double value that represents the distance, in points, from the top edge of the screen to the top edge of the main Microsoft Excel window.

MSDN documentation for Application.Top.

◆ SetTop()

void wxAutoExcel::wxExcelApplication::SetTop ( double top )

Sets a Double value that represents the distance, in points, from the top edge of the screen to the top edge of the main Microsoft Excel window.

MSDN documentation for Application.Top.

◆ GetTransitionMenuKey()

wxString wxAutoExcel::wxExcelApplication::GetTransitionMenuKey ( )

Returns the Microsoft Excel menu or help key, which is usually "/".

MSDN documentation for Application.TransitionMenuKey.

◆ SetTransitionMenuKey()

void wxAutoExcel::wxExcelApplication::SetTransitionMenuKey ( const wxString & transitionMenuKey )

Sets the Microsoft Excel menu or help key, which is usually "/".

MSDN documentation for Application.TransitionMenuKey.

◆ GetTransitionMenuKeyAction()

long wxAutoExcel::wxExcelApplication::GetTransitionMenuKeyAction ( )

Returns the action taken when the Microsoft Excel menu key is pressed.

Can be either xlExcelMenus or xlLotusHelp.

MSDN documentation for Application.TransitionMenuKeyAction.

◆ SetTransitionMenuKeyAction()

void wxAutoExcel::wxExcelApplication::SetTransitionMenuKeyAction ( long transitionMenuKeyAction )

Sets the action taken when the Microsoft Excel menu key is pressed.

Can be either xlExcelMenus or xlLotusHelp.

MSDN documentation for Application.TransitionMenuKeyAction.

◆ GetTransitionNavigKeys()

bool wxAutoExcel::wxExcelApplication::GetTransitionNavigKeys ( )

True if transition navigation keys are active.

MSDN documentation for Application.TransitionNavigKeys.

◆ SetTransitionNavigKeys()

void wxAutoExcel::wxExcelApplication::SetTransitionNavigKeys ( bool transitionNavigKeys )

True if transition navigation keys are active.

MSDN documentation for Application.TransitionNavigKeys.

◆ GetUsableHeight()

double wxAutoExcel::wxExcelApplication::GetUsableHeight ( )

Returns the maximum height of the space that a window can occupy in the application window area, in points.

MSDN documentation for Application.UsableHeight.

◆ GetUsableWidth()

double wxAutoExcel::wxExcelApplication::GetUsableWidth ( )

Returns the maximum width of the space that a window can occupy in the application window area, in points.

MSDN documentation for Application.UsableWidth.

◆ GetUserControl()

bool wxAutoExcel::wxExcelApplication::GetUserControl ( )

True if the application is visible or if it was created or started by the user.

False if you created or started the application programmatically by using the CreateObject or GetObject functions, and the application is hidden.

MSDN documentation for Application.UserControl.

◆ SetUserControl()

void wxAutoExcel::wxExcelApplication::SetUserControl ( bool userControl )

True if the application is visible or if it was created or started by the user.

False if you created or started the application programmatically by using the CreateObject or GetObject functions, and the application is hidden.

MSDN documentation for Application.UserControl.

◆ GetUserLibraryPath()

wxString wxAutoExcel::wxExcelApplication::GetUserLibraryPath ( )

Returns the path to the location on the user's computer where the COM add-ins are installed.

MSDN documentation for Application.UserLibraryPath.

◆ GetUsername()

wxString wxAutoExcel::wxExcelApplication::GetUsername ( )

Returns the name of the current user.

MSDN documentation for Application.UserName.

◆ SetUsername()

void wxAutoExcel::wxExcelApplication::SetUsername ( const wxString & userName )

Sets the name of the current user.

MSDN documentation for Application.UserName.

◆ GetUseSystemSeparators()

bool wxAutoExcel::wxExcelApplication::GetUseSystemSeparators ( )

True (default) if the system separators of Microsoft Excel are enabled.

MSDN documentation for Application.UseSystemSeparators.

◆ SetUseSystemSeparators()

void wxAutoExcel::wxExcelApplication::SetUseSystemSeparators ( bool useSystemSeparators )

True (default) if the system separators of Microsoft Excel are enabled.

MSDN documentation for Application.UseSystemSeparators.

◆ GetVersion()

wxString wxAutoExcel::wxExcelApplication::GetVersion ( )

Returns a String value that represents the Microsoft Excel version number.

Version numbers are as follows: Excel 97 = 8 Excel 2000 = 9 Excel 2002 = 10 Excel 2003 = 11 Excel 2007 = 12 Excel 2010 = 14 Excel 2013 = 15 Excel 2016 = 16

MSDN documentation for Application.Version.

See also GetVersionAsDouble_(), GetVersionAsEnum_(), and IsVersionAtLeast_() methods.

◆ GetVisible()

bool wxAutoExcel::wxExcelApplication::GetVisible ( )

Returns a Boolean value that determines whether the object is visible.

MSDN documentation for Application.Visible.

◆ SetVisible()

void wxAutoExcel::wxExcelApplication::SetVisible ( bool visible )

Sets a Boolean value that determines whether the object is visible.

MSDN documentation for Application.Visible.

◆ GetWidth()

double wxAutoExcel::wxExcelApplication::GetWidth ( )

Returns a Double value that represents the distance, in points, from the left edge of the application window to its right edge.

MSDN documentation for Application.Width.

◆ SetWidth()

void wxAutoExcel::wxExcelApplication::SetWidth ( double width )

Sets a Double value that represents the distance, in points, from the left edge of the application window to its right edge.

MSDN documentation for Application.Width.

◆ GetWindows()

wxExcelWindows wxAutoExcel::wxExcelApplication::GetWindows ( )

Returns a Windows collection that represents all the windows in all the workbooks.

MSDN documentation for Application.Windows.

◆ GetWindowsForPens()

bool wxAutoExcel::wxExcelApplication::GetWindowsForPens ( )

True if the computer is running under Microsoft Windows for Pen Computing.

MSDN documentation for Application.WindowsForPens.

◆ GetWindowState()

XlWindowState wxAutoExcel::wxExcelApplication::GetWindowState ( )

Returns the state of the window.

MSDN documentation for Application.WindowState.

◆ SetWindowState()

void wxAutoExcel::wxExcelApplication::SetWindowState ( XlWindowState windowState )

Sets the state of the window.

MSDN documentation for Application.WindowState.

◆ GetWorkbooks()

wxExcelWorkbooks wxAutoExcel::wxExcelApplication::GetWorkbooks ( )

Returns a Workbooks collection that represents all the open workbooks.

MSDN documentation for Application.Workbooks.

◆ GetWorksheets()

wxExcelWorksheets wxAutoExcel::wxExcelApplication::GetWorksheets ( )

For an Application object, returns a Sheets collection that represents all the worksheets in the active workbook.

For a Workbook object, returns a Sheets collection that represents all the worksheets in the specified workbook.

MSDN documentation for Application.Worksheets.

◆ GetVersionAsDouble_()

bool wxAutoExcel::wxExcelApplication::GetVersionAsDouble_ ( double & version )

Returns MS Excel version as a double matching Application.Version.

◆ GetVersionAsEnum_()

bool wxAutoExcel::wxExcelApplication::GetVersionAsEnum_ ( ExcelForWindowsVersions & version )

Returns MS Excel version as an ExcelForWindowsVersions enum value.

◆ IsVersionAtLeast_()

bool wxAutoExcel::wxExcelApplication::IsVersionAtLeast_ ( ExcelForWindowsVersions version )

Returns true if the instance is version or newer.

◆ GetAutoExcelObjectName_()

virtual wxString wxAutoExcel::wxExcelApplication::GetAutoExcelObjectName_ ( ) const

inlinevirtual

Returns "Application".

Reimplemented from wxAutoExcel::wxExcelRangeOwner.

Public Types

Public Member Functions

Static Public Member Functions

Detailed Description

Member Enumeration Documentation

◆ ExcelForWindowsVersions

Member Function Documentation

◆ CreateInstance()

◆ GetInstance() [1/2]

◆ GetInstance() [2/2]

◆ ActivateMicrosoftApp()

◆ AddCustomList()

◆ Calculate()

◆ CalculateFull()

◆ CalculateFullRebuild()

◆ CalculateUntilAsyncQueriesDone()

◆ CentimetersToPoints()

◆ CheckAbort()

◆ CheckSpelling()

◆ ConvertFormula()

◆ DDEExecute()

◆ DDEInitiate()

◆ DDEPoke()

◆ DDERequest()

◆ DDETerminate()

◆ DeleteCustomList()

◆ DoubleClick()

◆ FindFile()

◆ GetCustomListContents()

◆ GetCustomListNum()

◆ GetOpenFilename()

◆ GetPhonetic()

◆ GetSaveAsFilename()

◆ Goto()

◆ Help()

◆ InchesToPoints()

◆ Intersect()

◆ MailLogoff()

◆ MailLogon()

◆ Quit()

◆ RecordMacro()

◆ RegisterXLL()

◆ Run()

◆ SaveWorkspace()

◆ SendKeys()

◆ SharePointVersion()

◆ Union()

◆ GetActiveCell()

◆ GetActivePrinter()

◆ SetActivePrinter()

◆ GetActiveSheet()

◆ GetActiveWindow()

◆ GetActiveWorkbook()

◆ GetAddIns()

◆ GetAddIns2()

◆ GetAlertBeforeOverwriting()

◆ SetAlertBeforeOverwriting()

◆ GetAltStartupPath()

◆ SetAltStartupPath()

◆ GetAlwaysUseClearType()

◆ SetAlwaysUseClearType()

◆ GetArbitraryXMLSupportAvailable()

◆ GetAskToUpdateLinks()

◆ SetAskToUpdateLinks()

◆ GetAutoFormatAsYouTypeReplaceHyperlinks()

◆ SetAutoFormatAsYouTypeReplaceHyperlinks()

◆ GetAutomationSecurity()

◆ SetAutomationSecurity()

◆ GetAutoPercentEntry()

◆ SetAutoPercentEntry()

◆ GetBuild()

◆ GetCalculateBeforeSave()

◆ SetCalculateBeforeSave()

◆ GetCalculation()

◆ SetCalculation()

◆ GetCalculationInterruptKey()

◆ SetCalculationInterruptKey()

◆ GetCalculationState()

◆ GetCalculationVersion()

◆ GetCaption()