Represents Microsoft Excel Font. More...

#include <wxAutoExcelFont.h>

Inheritance diagram for wxAutoExcel::wxExcelFont:

Public Member Functions
XlBackground	GetBackground ()
	Returns the type of background.

void	SetBackground (XlBackground background)
	Sets the type of background.

bool	GetBold ()
	True if the font is bold.

void	SetBold (bool bold)
	True if the font is bold.

wxColour	GetColor ()
	Returns the primary color.

void	SetColor (const wxColour &color)
	Sets the primary color.

long	GetColorIndex ()
	Returns the color of the font.

void	SetColorIndex (long colorIndex)
	Sets the color of the font.

wxString	GetFontStyle ()
	Returns the font style.

void	SetFontStyle (const wxString &fontStyle)
	Sets the font style.

bool	GetItalic ()
	True if the font style is italic.

void	SetItalic (bool italic)
	True if the font style is italic.

wxString	GetName ()
	Returns font name.

void	SetName (const wxString &name)
	Sets font name.

double	GetSize ()
	Returns font size in points.

void	SetSize (double size)
	Sets font size in points.

bool	GetStrikethrough ()
	True if the font is struck through with a horizontal line.

void	SetStrikethrough (bool strikethrough)
	True if the font is struck through with a horizontal line.

bool	GetSubscript ()
	True if the font is formatted as subscript.

void	SetSubscript (bool subscript)
	True if the font is formatted as subscript.

bool	GetSuperscript ()
	True if the font is formatted as superscript; False by default.

void	SetSuperscript (bool superscript)
	True if the font is formatted as superscript; False by default.

XlThemeColor	GetThemeColor ()
	Returns the theme color in the applied color scheme.

void	SetThemeColor (XlThemeColor themeColor)
	Sets the theme color in the applied color scheme.

XlThemeFont	GetThemeFont ()
	Returns the theme font in the applied font scheme.

void	SetThemeFont (XlThemeFont themeFont)
	Sets the theme font in the applied font 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.

virtual wxString	GetAutoExcelObjectName_ () const
	Returns "Font".

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 Font.

MSDN documentation for Font.

Member Function Documentation

◆ GetBackground()

XlBackground wxAutoExcel::wxExcelFont::GetBackground ( )

Returns the type of background.

MSDN documentation for Font.Background.

◆ SetBackground()

void wxAutoExcel::wxExcelFont::SetBackground ( XlBackground background )

Sets the type of background.

MSDN documentation for Font.Background.

◆ GetBold()

bool wxAutoExcel::wxExcelFont::GetBold ( )

True if the font is bold.

MSDN documentation for Font.Bold.

◆ SetBold()

void wxAutoExcel::wxExcelFont::SetBold ( bool bold )

True if the font is bold.

MSDN documentation for Font.Bold.

◆ GetColor()

wxColour wxAutoExcel::wxExcelFont::GetColor ( )

Returns the primary color.

MSDN documentation for Font.Color.

◆ SetColor()

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

Sets the primary color.

MSDN documentation for Font.Color.

◆ GetColorIndex()

long wxAutoExcel::wxExcelFont::GetColorIndex ( )

Returns the color of the font.

MSDN documentation for Font.ColorIndex.

◆ SetColorIndex()

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

Sets the color of the font.

MSDN documentation for Font.ColorIndex.

◆ GetFontStyle()

wxString wxAutoExcel::wxExcelFont::GetFontStyle ( )

Returns the font style.

MSDN documentation for Font.FontStyle.

◆ SetFontStyle()

void wxAutoExcel::wxExcelFont::SetFontStyle ( const wxString & fontStyle )

Sets the font style.

MSDN documentation for Font.FontStyle.

◆ GetItalic()

bool wxAutoExcel::wxExcelFont::GetItalic ( )

True if the font style is italic.

MSDN documentation for Font.Italic.

◆ SetItalic()

void wxAutoExcel::wxExcelFont::SetItalic ( bool italic )

True if the font style is italic.

MSDN documentation for Font.Italic.

◆ GetName()

wxString wxAutoExcel::wxExcelFont::GetName ( )

Returns font name.

MSDN documentation for Font.Name.

◆ SetName()

void wxAutoExcel::wxExcelFont::SetName ( const wxString & name )

Sets font name.

MSDN documentation for Font.Name.

◆ GetSize()

double wxAutoExcel::wxExcelFont::GetSize ( )

Returns font size in points.

MSDN documentation for Font.Size.

◆ SetSize()

void wxAutoExcel::wxExcelFont::SetSize ( double size )

Sets font size in points.

MSDN documentation for Font.Size.

◆ GetStrikethrough()

bool wxAutoExcel::wxExcelFont::GetStrikethrough ( )

True if the font is struck through with a horizontal line.

MSDN documentation for Font.Strikethrough.

◆ SetStrikethrough()

void wxAutoExcel::wxExcelFont::SetStrikethrough ( bool strikethrough )

True if the font is struck through with a horizontal line.

MSDN documentation for Font.Strikethrough.

◆ GetSubscript()

bool wxAutoExcel::wxExcelFont::GetSubscript ( )

True if the font is formatted as subscript.

False by default.

MSDN documentation for Font.Subscript.

◆ SetSubscript()

void wxAutoExcel::wxExcelFont::SetSubscript ( bool subscript )

True if the font is formatted as subscript.

False by default.

MSDN documentation for Font.Subscript.

◆ GetSuperscript()

bool wxAutoExcel::wxExcelFont::GetSuperscript ( )

True if the font is formatted as superscript; False by default.

MSDN documentation for Font.Superscript.

◆ SetSuperscript()

void wxAutoExcel::wxExcelFont::SetSuperscript ( bool superscript )

True if the font is formatted as superscript; False by default.

MSDN documentation for Font.Superscript.

◆ GetThemeColor()

XlThemeColor wxAutoExcel::wxExcelFont::GetThemeColor ( )

Returns the theme color in the applied color scheme.

Since Excel 2007.

MSDN documentation for Font.ThemeColor.

◆ SetThemeColor()

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

Sets the theme color in the applied color scheme.

MSDN documentation for Font.ThemeColor.

◆ GetThemeFont()

XlThemeFont wxAutoExcel::wxExcelFont::GetThemeFont ( )

Returns the theme font in the applied font scheme.

MSDN documentation for Font.ThemeFont.

◆ SetThemeFont()

void wxAutoExcel::wxExcelFont::SetThemeFont ( XlThemeFont themeFont )

Sets the theme font in the applied font scheme.