wxAutoExcel  2.0.0
wxAutoExcel::wxExcelBorder Class Reference

Represents Microsoft Excel Border object. More...

Inheritance diagram for wxAutoExcel::wxExcelBorder:
wxAutoExcel::wxExcelObject wxAutoExcel::wxExcelBorders

Public Member Functions

wxColour GetColor ()
 Returns the primary color. More...
 
void SetColor (const wxColour &color)
 Sets the primary color of the object. More...
 
long GetColorIndex ()
 Returns the primary color index. More...
 
void SetColorIndex (long colorIndex)
 Sets the primary color index. More...
 
long GetLineStyle ()
 Returns the line style for the border. More...
 
void SetLineStyle (long lineStyle)
 Sets the line style for the border. More...
 
XlThemeColor GetThemeColor ()
 Returns the theme color in the applied color scheme. More...
 
void SetThemeColor (XlThemeColor themeColor)
 Sets the theme color in the applied color scheme. More...
 
double GetTintAndShade ()
 A number from -1 (darkest) to 1 (lightest) or 0 for neutral. More...
 
void SetTintAndShade (double tintAndShade)
 A number from -1 (darkest) to 1 (lightest) or 0 for neutral. More...
 
XlBorderWeight GetWeight ()
 Returns a XlBorderWeight value that represents the weight of the border. More...
 
void SetWeight (XlBorderWeight weight)
 Sets a XlBorderWeight value that represents the weight of the border. More...
 
virtual wxString GetAutoExcelObjectName_ () const
 Returns "Border". 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 Border object.

Member Function Documentation

◆ GetColor()

wxColour wxAutoExcel::wxExcelBorder::GetColor ( )

Returns the primary color.

MSDN documentation for Border.Color.

◆ SetColor()

void wxAutoExcel::wxExcelBorder::SetColor ( const wxColour &  color)

Sets the primary color of the object.

MSDN documentation for Border.Color.

◆ GetColorIndex()

long wxAutoExcel::wxExcelBorder::GetColorIndex ( )

Returns the primary color index.

MSDN documentation for Border.ColorIndex.

◆ SetColorIndex()

void wxAutoExcel::wxExcelBorder::SetColorIndex ( long  colorIndex)

Sets the primary color index.

MSDN documentation for Border.ColorIndex.

◆ GetLineStyle()

long wxAutoExcel::wxExcelBorder::GetLineStyle ( )

Returns the line style for the border.

Read/write XlLineStyle, xlGray25, xlGray50, xlGray75, or xlAutomatic.

MSDN documentation for Border.LineStyle.

◆ SetLineStyle()

void wxAutoExcel::wxExcelBorder::SetLineStyle ( long  lineStyle)

Sets the line style for the border.

Read/write XlLineStyle, xlGray25, xlGray50, xlGray75, or xlAutomatic.

MSDN documentation for Border.LineStyle.

◆ GetThemeColor()

XlThemeColor wxAutoExcel::wxExcelBorder::GetThemeColor ( )

Returns the theme color in the applied color scheme.

Since Excel 2007.

MSDN documentation for Border.ThemeColor.

◆ SetThemeColor()

void wxAutoExcel::wxExcelBorder::SetThemeColor ( XlThemeColor  themeColor)

Sets the theme color in the applied color scheme.

MSDN documentation for Border.ThemeColor.

◆ GetTintAndShade()

double wxAutoExcel::wxExcelBorder::GetTintAndShade ( )

A number from -1 (darkest) to 1 (lightest) or 0 for neutral.

Since Excel 2007.

MSDN documentation for Border.TintAndShade.

◆ SetTintAndShade()

void wxAutoExcel::wxExcelBorder::SetTintAndShade ( double  tintAndShade)

A number from -1 (darkest) to 1 (lightest) or 0 for neutral.

MSDN documentation for Border.TintAndShade.

◆ GetWeight()

XlBorderWeight wxAutoExcel::wxExcelBorder::GetWeight ( )

Returns a XlBorderWeight value that represents the weight of the border.

MSDN documentation for Border.Weight.

◆ SetWeight()

void wxAutoExcel::wxExcelBorder::SetWeight ( XlBorderWeight  weight)

Sets a XlBorderWeight value that represents the weight of the border.

MSDN documentation for Border.Weight.

◆ GetAutoExcelObjectName_()

virtual wxString wxAutoExcel::wxExcelBorder::GetAutoExcelObjectName_ ( ) const
inlinevirtual

Returns "Border".

Reimplemented from wxAutoExcel::wxExcelObject.

Reimplemented in wxAutoExcel::wxExcelBorders.