Represents Microsoft Excel Window object. More...

Inheritance diagram for wxAutoExcel::wxExcelWindow:

Public Member Functions
void	Activate ()
	Brings the window to the front of the z-order. More...

bool	ActivateNext ()
	Activates the specified window and then sends it to the back of the window z-order. More...

bool	ActivatePrevious ()
	Activates the specified window and then activates the window at the back of the window z-order. More...

bool	Close ()
	Closes the object. More...

bool	LargeScroll (long down=NULL, long up=NULL, long toRight=NULL, long toLeft=NULL)
	Scrolls the contents of the window by pages. More...

wxExcelWindow	NewWindow ()
	Creates a new window or a copy of the specified window. More...

long	PointsToScreenPixelsX (double points)
	Converts a horizontal measurement from points (document coordinates) to screen pixels (screen coordinates). More...

long	PointsToScreenPixelsY (double points)
	Converts a vertical measurement from points (document coordinates) to screen pixels (screen coordinates). More...

bool	PrintOut (long from=NULL, long to=NULL, long *copies=NULL, wxXlTribool preview=wxDefaultXlTribool, const wxString &activePrinter=wxEmptyString, wxXlTribool printToFile=wxDefaultXlTribool, wxXlTribool collate=wxDefaultXlTribool, const wxString &prToFileName=wxEmptyString)
	Prints the object. More...

bool	PrintPreview (wxXlTribool enableChanges=wxDefaultXlTribool)
	Shows a preview of the object as it would look when printed. More...

bool	RangeFromPoint (long x, long y, wxExcelRange &range, wxExcelShape &shape)
	Returns Range or Shape that is positioned at the specified pair of screen coordinates, if there's any. More...

void	ScrollIntoView (long left, long top, long width, long height, wxXlTribool start=wxDefaultXlTribool)
	Scrolls the document window so that the contents of a specified rectangular area are displayed in either the upper-left or lower-right corner of the document window or pane (depending on the value of the Start argument). More...

bool	ScrollWorkbookTabs (long sheets=NULL, long position=NULL)
	Scrolls through the workbook tabs at the bottom of the window. More...

bool	SmallScroll (long down=NULL, long up=NULL, long toRight=NULL, long toLeft=NULL)
	Scrolls the contents of the window by rows or columns. More...

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

wxExcelPane	GetActivePane ()
	Returns a Pane Represents the active pane in the window. More...

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

bool	GetAutoFilterDateGrouping ()
	True if the auto filter for date grouping is currently displayed in the specified window. More...

void	SetAutoFilterDateGrouping (bool autoFilterDateGrouping)
	True if the auto filter for date grouping is currently displayed in the specified window. More...

wxString	GetCaption ()
	Returns the name that appears in the title bar of the document window. More...

void	SetCaption (const wxString &caption)
	Sets the name that appears in the title bar of the document window. More...

bool	GetDisplayFormulas ()
	True if the window is displaying formulas; False if the window is displaying values. More...

void	SetDisplayFormulas (bool displayFormulas)
	True if the window is displaying formulas; False if the window is displaying values. More...

bool	GetDisplayGridlines ()
	True if gridlines are displayed. More...

void	SetDisplayGridlines (bool displayGridlines)
	True if gridlines are displayed. More...

bool	GetDisplayHeadings ()
	True if both row and column headings are displayed; False if no headings are displayed. More...

void	SetDisplayHeadings (bool displayHeadings)
	True if both row and column headings are displayed; False if no headings are displayed. More...

bool	GetDisplayHorizontalScrollBar ()
	True if the horizontal scroll bar is displayed. More...

void	SetDisplayHorizontalScrollBar (bool displayHorizontalScrollBar)
	True if the horizontal scroll bar is displayed. More...

bool	GetDisplayOutline ()
	True if outline symbols are displayed. More...

void	SetDisplayOutline (bool displayOutline)
	True if outline symbols are displayed. More...

bool	GetDisplayRightToLeft ()
	True if the specified window is displayed from right to left instead of from left to right. More...

void	SetDisplayRightToLeft (bool displayRightToLeft)
	True if the specified window is displayed from right to left instead of from left to right. More...

bool	GetDisplayRuler ()
	True if a ruler is displayed for the specified window. More...

void	SetDisplayRuler (bool displayRuler)
	True if a ruler is displayed for the specified window. More...

bool	GetDisplayVerticalScrollBar ()
	True if the vertical scroll bar is displayed. More...

void	SetDisplayVerticalScrollBar (bool displayVerticalScrollBar)
	True if the vertical scroll bar is displayed. More...

bool	GetDisplayWhitespace ()
	True if whitespace is displayed. More...

void	SetDisplayWhitespace (bool displayWhitespace)
	True if whitespace is displayed. More...

bool	GetDisplayWorkbookTabs ()
	True if the workbook tabs are displayed. More...

void	SetDisplayWorkbookTabs (bool displayWorkbookTabs)
	True if the workbook tabs are displayed. More...

bool	GetDisplayZeros ()
	True if zero values are displayed. More...

void	SetDisplayZeros (bool displayZeros)
	True if zero values are displayed. More...

bool	GetEnableResize ()
	True if the window can be resized. More...

void	SetEnableResize (bool enableResize)
	True if the window can be resized. More...

bool	GetFreezePanes ()
	True if split panes are frozen. More...

void	SetFreezePanes (bool freezePanes)
	True if split panes are frozen. More...

wxColour	GetGridlineColor ()
	Returns the gridline color as an RGB value. More...

void	SetGridlineColor (const wxColour &gridlineColor)
	Sets the gridline color as an RGB value. More...

long	GetGridlineColorIndex ()
	Returns the gridline color as an index into the current color palette or as the following XlColorIndex constant. More...

void	SetGridlineColorIndex (long gridlineColorIndex)
	Sets the gridline color as an index into the current color palette or as the following XlColorIndex constant. More...

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

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

long	GetIndex ()
	Returns a Long value that represents the index number of the object within the collection of similar objects. More...

double	GetLeft ()
	Returns a Double value that represents the distance, in points, from the left edge of the client area to the left edge of the window. More...

void	SetLeft (double left)
	Sets a Double value that represents the distance, in points, from the left edge of the client area to the left edge of the window. More...

wxExcelPanes	GetPanes ()
	Returns a Panes collection that represents all the panes in the specified window. More...

wxExcelRange	GetRangeSelection ()
	Returns a Range Represents the selected cells on the worksheet in the specified window even if a graphic object is active or selected on the worksheet. More...

long	GetScrollColumn ()
	Returns the number of the leftmost column in the pane or window. More...

void	SetScrollColumn (long scrollColumn)
	Sets the number of the leftmost column in the pane or window. More...

long	GetScrollRow ()
	Returns the number of the row that appears at the top of the pane or window. More...

void	SetScrollRow (long scrollRow)
	Sets the number of the row that appears at the top of the pane or window. More...

wxExcelSheets	GetSelectedSheets ()
	Returns a Sheets collection that represents all the selected sheets in the specified window. More...

wxExcelSheetViews	GetSheetViews ()
	Returns the SheetViews object for the specified window. More...

bool	GetSplit ()
	True if the window is split. More...

void	SetSplit (bool split)
	True if the window is split. More...

long	GetSplitColumn ()
	Returns the column number where the window is split into panes (the number of columns to the left of the split line). More...

void	SetSplitColumn (long splitColumn)
	Sets the column number where the window is split into panes (the number of columns to the left of the split line). More...

double	GetSplitHorizontal ()
	Returns the location of the horizontal window split, in points. More...

void	SetSplitHorizontal (double splitHorizontal)
	Sets the location of the horizontal window split, in points. More...

long	GetSplitRow ()
	Returns the row number where the window is split into panes (the number of rows above the split). More...

void	SetSplitRow (long splitRow)
	Sets the row number where the window is split into panes (the number of rows above the split). More...

double	GetSplitVertical ()
	Returns the location of the vertical window split, in points. More...

void	SetSplitVertical (double splitVertical)
	Sets the location of the vertical window split, in points. More...

double	GetTabRatio ()
	Returns the ratio of the width of the workbook's tab area to the width of the window's horizontal scroll bar (as a number between 0 (zero) and 1; the default value is 0.6). More...

void	SetTabRatio (double tabRatio)
	Sets the ratio of the width of the workbook's tab area to the width of the window's horizontal scroll bar (as a number between 0 (zero) and 1; the default value is 0.6). More...

double	GetTop ()
	Returns a Double value that represents the distance, in points, from the top edge of the window to the top edge of the usable area (below the menus, any toolbars docked at the top, and the formula bar). More...

void	SetTop (double top)
	Sets a Double value that represents the distance, in points, from the top edge of the window to the top edge of the usable area (below the menus, any toolbars docked at the top, and the formula bar). More...

XlWindowType	GetType ()
	Returns a XlWindowType value that represents the window type. More...

void	SetType (XlWindowType type)
	Sets a XlWindowType value that represents the window type. 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...

XlWindowView	GetView ()
	Returns the view showing in the window. More...

void	SetView (XlWindowView view)
	Sets the view showing in the window. 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...

wxExcelRange	GetVisibleRange ()
	Returns a Range Represents the range of cells that are visible in the window or pane. More...

double	GetWidth ()
	Returns a Double value that represents the width, in points, of the window. More...

void	SetWidth (double width)
	Sets a Double value that represents the width, in points, of the window. More...

long	GetWindowNumber ()
	Returns the window number. More...

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

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

long	GetZoom ()
	Returns the display size of the window, as a percentage (100 equals normal size, 200 equals double size, and so on). More...

void	SetZoom (long zoom)
	Sets the display size of the window, as a percentage (100 equals normal size, 200 equals double size, and so on). More...

virtual wxString	GetAutoExcelObjectName_ () const
	Returns "Window". 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...

Additional Inherited Members
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...

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 Window object.

Member Function Documentation

◆ Activate()

void wxAutoExcel::wxExcelWindow::Activate ( )

Brings the window to the front of the z-order.

MSDN documentation for Window.Activate.

◆ ActivateNext()

bool wxAutoExcel::wxExcelWindow::ActivateNext ( )

Activates the specified window and then sends it to the back of the window z-order.

MSDN documentation for Window.ActivateNext.

◆ ActivatePrevious()

bool wxAutoExcel::wxExcelWindow::ActivatePrevious ( )

Activates the specified window and then activates the window at the back of the window z-order.

MSDN documentation for Window.ActivatePrevious.

◆ Close()

bool wxAutoExcel::wxExcelWindow::Close ( )

Closes the object.

MSDN documentation for Window.Close.

◆ LargeScroll()

bool wxAutoExcel::wxExcelWindow::LargeScroll	(	long *	down = `NULL`,
		long *	up = `NULL`,
		long *	toRight = `NULL`,
		long *	toLeft = `NULL`
	)

Scrolls the contents of the window by pages.

MSDN documentation for Window.LargeScroll.

◆ NewWindow()

wxExcelWindow wxAutoExcel::wxExcelWindow::NewWindow ( )

Creates a new window or a copy of the specified window.

MSDN documentation for Window.NewWindow.

◆ PointsToScreenPixelsX()

long wxAutoExcel::wxExcelWindow::PointsToScreenPixelsX ( double points )

Converts a horizontal measurement from points (document coordinates) to screen pixels (screen coordinates).

Returns the converted measurement as a Long value.

MSDN documentation for Window.PointsToScreenPixelsX.

◆ PointsToScreenPixelsY()

long wxAutoExcel::wxExcelWindow::PointsToScreenPixelsY ( double points )

Converts a vertical measurement from points (document coordinates) to screen pixels (screen coordinates).

Returns the converted measurement as a Long value.

MSDN documentation for Window.PointsToScreenPixelsY.

◆ PrintOut()

bool wxAutoExcel::wxExcelWindow::PrintOut	(	long *	from = `NULL`,
		long *	to = `NULL`,
		long *	copies = `NULL`,
		wxXlTribool	preview = `wxDefaultXlTribool`,
		const wxString &	activePrinter = `wxEmptyString`,
		wxXlTribool	printToFile = `wxDefaultXlTribool`,
		wxXlTribool	collate = `wxDefaultXlTribool`,
		const wxString &	prToFileName = `wxEmptyString`
	)

Prints the object.

MSDN documentation for Window.PrintOut.

◆ PrintPreview()

bool wxAutoExcel::wxExcelWindow::PrintPreview ( wxXlTribool enableChanges = wxDefaultXlTribool )

Shows a preview of the object as it would look when printed.

MSDN documentation for Window.PrintPreview.

◆ RangeFromPoint()

bool wxAutoExcel::wxExcelWindow::RangeFromPoint	(	long	x,
		long	y,
		wxExcelRange &	range,
		wxExcelShape &	shape
	)

Returns Range or Shape that is positioned at the specified pair of screen coordinates, if there's any.

MSDN documentation for Window.RangeFromPoint.

◆ ScrollIntoView()

void wxAutoExcel::wxExcelWindow::ScrollIntoView	(	long	left,
		long	top,
		long	width,
		long	height,
		wxXlTribool	start = `wxDefaultXlTribool`
	)

Scrolls the document window so that the contents of a specified rectangular area are displayed in either the upper-left or lower-right corner of the document window or pane (depending on the value of the Start argument).

MSDN documentation for Window.ScrollIntoView.

◆ ScrollWorkbookTabs()

bool wxAutoExcel::wxExcelWindow::ScrollWorkbookTabs	(	long *	sheets = `NULL`,
		long *	position = `NULL`
	)

Scrolls through the workbook tabs at the bottom of the window.

Doesn't affect the active sheet in the workbook.

MSDN documentation for Window.ScrollWorkbookTabs.

◆ SmallScroll()

bool wxAutoExcel::wxExcelWindow::SmallScroll	(	long *	down = `NULL`,
		long *	up = `NULL`,
		long *	toRight = `NULL`,
		long *	toLeft = `NULL`
	)

Scrolls the contents of the window by rows or columns.

MSDN documentation for Window.SmallScroll.

◆ GetActiveCell()

wxExcelRange wxAutoExcel::wxExcelWindow::GetActiveCell ( )

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

If the window isn't displaying a worksheet, this property fails.

MSDN documentation for Window.ActiveCell.

◆ GetActivePane()

wxExcelPane wxAutoExcel::wxExcelWindow::GetActivePane ( )

Returns a Pane Represents the active pane in the window.

MSDN documentation for Window.ActivePane.

◆ GetActiveSheet()

wxExcelSheet wxAutoExcel::wxExcelWindow::GetActiveSheet ( )

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

Returns Nothing if no sheet is active.

MSDN documentation for Window.ActiveSheet.

◆ GetAutoFilterDateGrouping()

bool wxAutoExcel::wxExcelWindow::GetAutoFilterDateGrouping ( )

True if the auto filter for date grouping is currently displayed in the specified window.

Since Excel 2007.

MSDN documentation for Window.AutoFilterDateGrouping.

◆ SetAutoFilterDateGrouping()

void wxAutoExcel::wxExcelWindow::SetAutoFilterDateGrouping ( bool autoFilterDateGrouping )

True if the auto filter for date grouping is currently displayed in the specified window.

MSDN documentation for Window.AutoFilterDateGrouping.

◆ GetCaption()

wxString wxAutoExcel::wxExcelWindow::GetCaption ( )

Returns the name that appears in the title bar of the document window.

MSDN documentation for Window.Caption.

◆ SetCaption()

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

Sets the name that appears in the title bar of the document window.

MSDN documentation for Window.Caption.

◆ GetDisplayFormulas()

bool wxAutoExcel::wxExcelWindow::GetDisplayFormulas ( )

True if the window is displaying formulas; False if the window is displaying values.

MSDN documentation for Window.DisplayFormulas.

◆ SetDisplayFormulas()

void wxAutoExcel::wxExcelWindow::SetDisplayFormulas ( bool displayFormulas )

True if the window is displaying formulas; False if the window is displaying values.

MSDN documentation for Window.DisplayFormulas.

◆ GetDisplayGridlines()

bool wxAutoExcel::wxExcelWindow::GetDisplayGridlines ( )

True if gridlines are displayed.

MSDN documentation for Window.DisplayGridlines.

◆ SetDisplayGridlines()

void wxAutoExcel::wxExcelWindow::SetDisplayGridlines ( bool displayGridlines )

True if gridlines are displayed.

MSDN documentation for Window.DisplayGridlines.

◆ GetDisplayHeadings()

bool wxAutoExcel::wxExcelWindow::GetDisplayHeadings ( )

True if both row and column headings are displayed; False if no headings are displayed.

MSDN documentation for Window.DisplayHeadings.

◆ SetDisplayHeadings()

void wxAutoExcel::wxExcelWindow::SetDisplayHeadings ( bool displayHeadings )

True if both row and column headings are displayed; False if no headings are displayed.

MSDN documentation for Window.DisplayHeadings.

◆ GetDisplayHorizontalScrollBar()

bool wxAutoExcel::wxExcelWindow::GetDisplayHorizontalScrollBar ( )

True if the horizontal scroll bar is displayed.

MSDN documentation for Window.DisplayHorizontalScrollBar.

◆ SetDisplayHorizontalScrollBar()

void wxAutoExcel::wxExcelWindow::SetDisplayHorizontalScrollBar ( bool displayHorizontalScrollBar )

True if the horizontal scroll bar is displayed.

MSDN documentation for Window.DisplayHorizontalScrollBar.

◆ GetDisplayOutline()

bool wxAutoExcel::wxExcelWindow::GetDisplayOutline ( )

True if outline symbols are displayed.

MSDN documentation for Window.DisplayOutline.

◆ SetDisplayOutline()

void wxAutoExcel::wxExcelWindow::SetDisplayOutline ( bool displayOutline )

True if outline symbols are displayed.

MSDN documentation for Window.DisplayOutline.

◆ GetDisplayRightToLeft()

bool wxAutoExcel::wxExcelWindow::GetDisplayRightToLeft ( )

True if the specified window is displayed from right to left instead of from left to right.

False if the object is displayed from left to right.

MSDN documentation for Window.DisplayRightToLeft.

◆ SetDisplayRightToLeft()

void wxAutoExcel::wxExcelWindow::SetDisplayRightToLeft ( bool displayRightToLeft )

True if the specified window is displayed from right to left instead of from left to right.

False if the object is displayed from left to right.

MSDN documentation for Window.DisplayRightToLeft.

◆ GetDisplayRuler()

bool wxAutoExcel::wxExcelWindow::GetDisplayRuler ( )

True if a ruler is displayed for the specified window.

Since Excel 2007.

MSDN documentation for Window.DisplayRuler.

◆ SetDisplayRuler()

void wxAutoExcel::wxExcelWindow::SetDisplayRuler ( bool displayRuler )

True if a ruler is displayed for the specified window.

MSDN documentation for Window.DisplayRuler.

◆ GetDisplayVerticalScrollBar()

bool wxAutoExcel::wxExcelWindow::GetDisplayVerticalScrollBar ( )

True if the vertical scroll bar is displayed.

MSDN documentation for Window.DisplayVerticalScrollBar.

◆ SetDisplayVerticalScrollBar()

void wxAutoExcel::wxExcelWindow::SetDisplayVerticalScrollBar ( bool displayVerticalScrollBar )

True if the vertical scroll bar is displayed.

MSDN documentation for Window.DisplayVerticalScrollBar.

◆ GetDisplayWhitespace()

bool wxAutoExcel::wxExcelWindow::GetDisplayWhitespace ( )

True if whitespace is displayed.

Since Excel 2007.

MSDN documentation for Window.DisplayWhitespace.

◆ SetDisplayWhitespace()

void wxAutoExcel::wxExcelWindow::SetDisplayWhitespace ( bool displayWhitespace )

True if whitespace is displayed.

MSDN documentation for Window.DisplayWhitespace.

◆ GetDisplayWorkbookTabs()

bool wxAutoExcel::wxExcelWindow::GetDisplayWorkbookTabs ( )

True if the workbook tabs are displayed.

MSDN documentation for Window.DisplayWorkbookTabs.

◆ SetDisplayWorkbookTabs()

void wxAutoExcel::wxExcelWindow::SetDisplayWorkbookTabs ( bool displayWorkbookTabs )

True if the workbook tabs are displayed.

MSDN documentation for Window.DisplayWorkbookTabs.

◆ GetDisplayZeros()

bool wxAutoExcel::wxExcelWindow::GetDisplayZeros ( )

True if zero values are displayed.

MSDN documentation for Window.DisplayZeros.

◆ SetDisplayZeros()

void wxAutoExcel::wxExcelWindow::SetDisplayZeros ( bool displayZeros )

True if zero values are displayed.

MSDN documentation for Window.DisplayZeros.

◆ GetEnableResize()

bool wxAutoExcel::wxExcelWindow::GetEnableResize ( )

True if the window can be resized.

MSDN documentation for Window.EnableResize.

◆ SetEnableResize()

void wxAutoExcel::wxExcelWindow::SetEnableResize ( bool enableResize )

True if the window can be resized.

MSDN documentation for Window.EnableResize.

◆ GetFreezePanes()

bool wxAutoExcel::wxExcelWindow::GetFreezePanes ( )

True if split panes are frozen.

MSDN documentation for Window.FreezePanes.

◆ SetFreezePanes()

void wxAutoExcel::wxExcelWindow::SetFreezePanes ( bool freezePanes )

True if split panes are frozen.

MSDN documentation for Window.FreezePanes.

◆ GetGridlineColor()

wxColour wxAutoExcel::wxExcelWindow::GetGridlineColor ( )

Returns the gridline color as an RGB value.

MSDN documentation for Window.GridlineColor.

◆ SetGridlineColor()

void wxAutoExcel::wxExcelWindow::SetGridlineColor ( const wxColour & gridlineColor )

Sets the gridline color as an RGB value.

MSDN documentation for Window.GridlineColor.

◆ GetGridlineColorIndex()

long wxAutoExcel::wxExcelWindow::GetGridlineColorIndex ( )

Returns the gridline color as an index into the current color palette or as the following XlColorIndex constant.

MSDN documentation for Window.GridlineColorIndex.

◆ SetGridlineColorIndex()

void wxAutoExcel::wxExcelWindow::SetGridlineColorIndex ( long gridlineColorIndex )

Sets the gridline color as an index into the current color palette or as the following XlColorIndex constant.

MSDN documentation for Window.GridlineColorIndex.

◆ GetHeight()

double wxAutoExcel::wxExcelWindow::GetHeight ( )

Returns a Double value that represents tThe height, in points, of the window.

MSDN documentation for Window.Height.

◆ SetHeight()

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

Sets a Double value that represents tThe height, in points, of the window.

MSDN documentation for Window.Height.

◆ GetIndex()

long wxAutoExcel::wxExcelWindow::GetIndex ( )

Returns a Long value that represents the index number of the object within the collection of similar objects.

MSDN documentation for Window.Index.

◆ GetLeft()

double wxAutoExcel::wxExcelWindow::GetLeft ( )

Returns a Double value that represents the distance, in points, from the left edge of the client area to the left edge of the window.

MSDN documentation for Window.Left.

◆ SetLeft()

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

Sets a Double value that represents the distance, in points, from the left edge of the client area to the left edge of the window.

MSDN documentation for Window.Left.

◆ GetPanes()

wxExcelPanes wxAutoExcel::wxExcelWindow::GetPanes ( )

Returns a Panes collection that represents all the panes in the specified window.

MSDN documentation for Window.Panes.

◆ GetRangeSelection()

wxExcelRange wxAutoExcel::wxExcelWindow::GetRangeSelection ( )

Returns a Range Represents the selected cells on the worksheet in the specified window even if a graphic object is active or selected on the worksheet.

MSDN documentation for Window.RangeSelection.

◆ GetScrollColumn()

long wxAutoExcel::wxExcelWindow::GetScrollColumn ( )

Returns the number of the leftmost column in the pane or window.

MSDN documentation for Window.ScrollColumn.

◆ SetScrollColumn()

void wxAutoExcel::wxExcelWindow::SetScrollColumn ( long scrollColumn )

Sets the number of the leftmost column in the pane or window.

MSDN documentation for Window.ScrollColumn.

◆ GetScrollRow()

long wxAutoExcel::wxExcelWindow::GetScrollRow ( )

Returns the number of the row that appears at the top of the pane or window.

MSDN documentation for Window.ScrollRow.

◆ SetScrollRow()

void wxAutoExcel::wxExcelWindow::SetScrollRow ( long scrollRow )

Sets the number of the row that appears at the top of the pane or window.

MSDN documentation for Window.ScrollRow.

◆ GetSelectedSheets()

wxExcelSheets wxAutoExcel::wxExcelWindow::GetSelectedSheets ( )

Returns a Sheets collection that represents all the selected sheets in the specified window.

MSDN documentation for Window.SelectedSheets.

◆ GetSheetViews()

wxExcelSheetViews wxAutoExcel::wxExcelWindow::GetSheetViews ( )

Returns the SheetViews object for the specified window.

Since Excel 2007.

MSDN documentation for Window.SheetViews.

◆ GetSplit()

bool wxAutoExcel::wxExcelWindow::GetSplit ( )

True if the window is split.

MSDN documentation for Window.Split.

◆ SetSplit()

void wxAutoExcel::wxExcelWindow::SetSplit ( bool split )

True if the window is split.

MSDN documentation for Window.Split.

◆ GetSplitColumn()

long wxAutoExcel::wxExcelWindow::GetSplitColumn ( )

Returns the column number where the window is split into panes (the number of columns to the left of the split line).

MSDN documentation for Window.SplitColumn.

◆ SetSplitColumn()

void wxAutoExcel::wxExcelWindow::SetSplitColumn ( long splitColumn )

Sets the column number where the window is split into panes (the number of columns to the left of the split line).

MSDN documentation for Window.SplitColumn.

◆ GetSplitHorizontal()

double wxAutoExcel::wxExcelWindow::GetSplitHorizontal ( )

Returns the location of the horizontal window split, in points.

Read/write Double.

MSDN documentation for Window.SplitHorizontal.

◆ SetSplitHorizontal()

void wxAutoExcel::wxExcelWindow::SetSplitHorizontal ( double splitHorizontal )

Sets the location of the horizontal window split, in points.

Read/write Double.

MSDN documentation for Window.SplitHorizontal.

◆ GetSplitRow()

long wxAutoExcel::wxExcelWindow::GetSplitRow ( )

Returns the row number where the window is split into panes (the number of rows above the split).

MSDN documentation for Window.SplitRow.

◆ SetSplitRow()

void wxAutoExcel::wxExcelWindow::SetSplitRow ( long splitRow )

Sets the row number where the window is split into panes (the number of rows above the split).

MSDN documentation for Window.SplitRow.

◆ GetSplitVertical()

double wxAutoExcel::wxExcelWindow::GetSplitVertical ( )

Returns the location of the vertical window split, in points.

Read/write Double.

MSDN documentation for Window.SplitVertical.

◆ SetSplitVertical()

void wxAutoExcel::wxExcelWindow::SetSplitVertical ( double splitVertical )

Sets the location of the vertical window split, in points.

Read/write Double.

MSDN documentation for Window.SplitVertical.

◆ GetTabRatio()

double wxAutoExcel::wxExcelWindow::GetTabRatio ( )

Returns the ratio of the width of the workbook's tab area to the width of the window's horizontal scroll bar (as a number between 0 (zero) and 1; the default value is 0.6).

Read/write Double.

MSDN documentation for Window.TabRatio.

◆ SetTabRatio()

void wxAutoExcel::wxExcelWindow::SetTabRatio ( double tabRatio )

Sets the ratio of the width of the workbook's tab area to the width of the window's horizontal scroll bar (as a number between 0 (zero) and 1; the default value is 0.6).

Read/write Double.

MSDN documentation for Window.TabRatio.

◆ GetTop()

double wxAutoExcel::wxExcelWindow::GetTop ( )

Returns a Double value that represents the distance, in points, from the top edge of the window to the top edge of the usable area (below the menus, any toolbars docked at the top, and the formula bar).

MSDN documentation for Window.Top.

◆ SetTop()

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

Sets a Double value that represents the distance, in points, from the top edge of the window to the top edge of the usable area (below the menus, any toolbars docked at the top, and the formula bar).

MSDN documentation for Window.Top.

◆ GetType()

XlWindowType wxAutoExcel::wxExcelWindow::GetType ( )

Returns a XlWindowType value that represents the window type.

MSDN documentation for Window.Type.

◆ SetType()

void wxAutoExcel::wxExcelWindow::SetType ( XlWindowType type )

Sets a XlWindowType value that represents the window type.

MSDN documentation for Window.Type.

◆ GetUsableHeight()

double wxAutoExcel::wxExcelWindow::GetUsableHeight ( )

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

Read-only Double.

MSDN documentation for Window.UsableHeight.

◆ GetUsableWidth()

double wxAutoExcel::wxExcelWindow::GetUsableWidth ( )

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

Read-only Double.

MSDN documentation for Window.UsableWidth.

◆ GetView()

XlWindowView wxAutoExcel::wxExcelWindow::GetView ( )

Returns the view showing in the window.

Read/write XlWindowView.

MSDN documentation for Window.View.

◆ SetView()

void wxAutoExcel::wxExcelWindow::SetView ( XlWindowView view )

Sets the view showing in the window.

Read/write XlWindowView.

MSDN documentation for Window.View.

◆ GetVisible()

bool wxAutoExcel::wxExcelWindow::GetVisible ( )

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

MSDN documentation for Window.Visible.

◆ SetVisible()

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

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

MSDN documentation for Window.Visible.

◆ GetVisibleRange()

wxExcelRange wxAutoExcel::wxExcelWindow::GetVisibleRange ( )

Returns a Range Represents the range of cells that are visible in the window or pane.

If a column or row is partially visible, it's included in the range.

MSDN documentation for Window.VisibleRange.

◆ GetWidth()

double wxAutoExcel::wxExcelWindow::GetWidth ( )

Returns a Double value that represents the width, in points, of the window.

MSDN documentation for Window.Width.

◆ SetWidth()

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

Sets a Double value that represents the width, in points, of the window.

MSDN documentation for Window.Width.

◆ GetWindowNumber()

long wxAutoExcel::wxExcelWindow::GetWindowNumber ( )

Returns the window number.

For example, a window named "Book1.xls:2" has 2 as its window number. Most windows have the window number 1.

MSDN documentation for Window.WindowNumber.

◆ GetWindowState()

XlWindowState wxAutoExcel::wxExcelWindow::GetWindowState ( )

Returns the state of the window.

Read/write XlWindowState.

MSDN documentation for Window.WindowState.

◆ SetWindowState()

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

Sets the state of the window.

Read/write XlWindowState.

MSDN documentation for Window.WindowState.

◆ GetZoom()

long wxAutoExcel::wxExcelWindow::GetZoom ( )

Returns the display size of the window, as a percentage (100 equals normal size, 200 equals double size, and so on).

MSDN documentation for Window.Zoom.

◆ SetZoom()

void wxAutoExcel::wxExcelWindow::SetZoom ( long zoom )

Sets the display size of the window, as a percentage (100 equals normal size, 200 equals double size, and so on).

MSDN documentation for Window.Zoom.

◆ GetAutoExcelObjectName_()

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

inlinevirtual

Returns "Window".

Reimplemented from wxAutoExcel::wxExcelObject.

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ Activate()

◆ ActivateNext()

◆ ActivatePrevious()

◆ Close()

◆ LargeScroll()

◆ NewWindow()

◆ PointsToScreenPixelsX()

◆ PointsToScreenPixelsY()

◆ PrintOut()

◆ PrintPreview()

◆ RangeFromPoint()

◆ ScrollIntoView()

◆ ScrollWorkbookTabs()

◆ SmallScroll()

◆ GetActiveCell()

◆ GetActivePane()

◆ GetActiveSheet()

◆ GetAutoFilterDateGrouping()

◆ SetAutoFilterDateGrouping()

◆ GetCaption()

◆ SetCaption()

◆ GetDisplayFormulas()

◆ SetDisplayFormulas()

◆ GetDisplayGridlines()

◆ SetDisplayGridlines()

◆ GetDisplayHeadings()

◆ SetDisplayHeadings()

◆ GetDisplayHorizontalScrollBar()

◆ SetDisplayHorizontalScrollBar()

◆ GetDisplayOutline()

◆ SetDisplayOutline()

◆ GetDisplayRightToLeft()

◆ SetDisplayRightToLeft()

◆ GetDisplayRuler()

◆ SetDisplayRuler()

◆ GetDisplayVerticalScrollBar()

◆ SetDisplayVerticalScrollBar()

◆ GetDisplayWhitespace()

◆ SetDisplayWhitespace()

◆ GetDisplayWorkbookTabs()

◆ SetDisplayWorkbookTabs()

◆ GetDisplayZeros()

◆ SetDisplayZeros()

◆ GetEnableResize()

◆ SetEnableResize()

◆ GetFreezePanes()

◆ SetFreezePanes()

◆ GetGridlineColor()

◆ SetGridlineColor()

◆ GetGridlineColorIndex()

◆ SetGridlineColorIndex()

◆ GetHeight()

◆ SetHeight()

◆ GetIndex()

◆ GetLeft()

◆ SetLeft()

◆ GetPanes()

◆ GetRangeSelection()

◆ GetScrollColumn()

◆ SetScrollColumn()

◆ GetScrollRow()

◆ SetScrollRow()

◆ GetSelectedSheets()

◆ GetSheetViews()

◆ GetSplit()

◆ SetSplit()

◆ GetSplitColumn()

◆ SetSplitColumn()

◆ GetSplitHorizontal()

◆ SetSplitHorizontal()

◆ GetSplitRow()

◆ SetSplitRow()

◆ GetSplitVertical()

◆ SetSplitVertical()

◆ GetTabRatio()

◆ SetTabRatio()