Represents Microsoft Excel Pane object. More...

#include <wxAutoExcelPanes.h>

Inheritance diagram for wxAutoExcel::wxExcelPane:

Public Member Functions
bool	Activate ()
	Activates the pane.

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

long	PointsToScreenPixelsX (double points)
	Returns or sets a pixel point on the screen.

long	PointsToScreenPixelsY (double points)
	Returns or sets the location of the pixel on the screen.

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 documentpane (depending on the value of the Start argument).

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

long	GetIndex ()
	Returns the index number of the window in the Panescollection.

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

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

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

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

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

virtual wxString	GetAutoExcelObjectName_ () const
	Returns "Pane".

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

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

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

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

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

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

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

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

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.

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

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.

Detailed Description

Represents Microsoft Excel Pane object.

Member Function Documentation

◆ Activate()

bool wxAutoExcel::wxExcelPane::Activate ( )

Activates the pane.

MSDN documentation for Pane.Activate.

◆ LargeScroll()

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

Scrolls the contents of the window by pages.

MSDN documentation for Pane.LargeScroll.

◆ PointsToScreenPixelsX()

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

Returns or sets a pixel point on the screen.

MSDN documentation for Pane.PointsToScreenPixelsX.

◆ PointsToScreenPixelsY()

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

Returns or sets the location of the pixel on the screen.

MSDN documentation for Pane.PointsToScreenPixelsY.

◆ ScrollIntoView()

void wxAutoExcel::wxExcelPane::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 documentpane (depending on the value of the Start argument).

MSDN documentation for Pane.ScrollIntoView.