wxAutoExcel::wxExcelBorders Class Reference

Represents Microsoft Excel Borders collection. More...

#include <wxAutoExcelBorders.h>

Inheritance diagram for wxAutoExcel::wxExcelBorders:

Public Member Functions
long	GetCount ()
	Returns a Long value that represents the number of objects in the collection.
wxExcelBorder	GetItem (XlBordersIndex index)
	Returns a Border Represents one of the borders of either a range of cells or a style.
virtual wxString	GetAutoExcelObjectName_ () const
	Returns "Borders".
Public Member Functions inherited from wxAutoExcel::wxExcelBorder
wxColour	GetColor ()
	Returns the primary color.
void	SetColor (const wxColour &color)
	Sets the primary color of the object.
long	GetColorIndex ()
	Returns the primary color index.
void	SetColorIndex (long colorIndex)
	Sets the primary color index.
long	GetLineStyle ()
	Returns the line style for the border.
void	SetLineStyle (long lineStyle)
	Sets the line style for the border.
XlThemeColor	GetThemeColor ()
	Returns the theme color in the applied color scheme.
void	SetThemeColor (XlThemeColor themeColor)
	Sets the theme color in the applied color scheme.
double	GetTintAndShade ()
	A number from -1 (darkest) to 1 (lightest) or 0 for neutral.
void	SetTintAndShade (double tintAndShade)
	A number from -1 (darkest) to 1 (lightest) or 0 for neutral.
XlBorderWeight	GetWeight ()
	Returns a XlBorderWeight value that represents the weight of the border.
void	SetWeight (XlBorderWeight weight)
	Sets a XlBorderWeight value that represents the weight of the border.
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 Borders collection.

Member Function Documentation

GetCount()

long wxAutoExcel::wxExcelBorders::GetCount

(

)

Returns a Long value that represents the number of objects in the collection.

MSDN documentation for Borders.Count.

GetItem()

wxExcelBorder wxAutoExcel::wxExcelBorders::GetItem

(

XlBordersIndex

index

)

Returns a Border Represents one of the borders of either a range of cells or a style.

MSDN documentation for Borders.Item.

GetAutoExcelObjectName_()

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

inlinevirtual

Returns "Borders".

Reimplemented from wxAutoExcel::wxExcelBorder.