wxAutoExcel  2.0.0
wxAutoExcel::wxExcelFont2 Class Reference

Represents Microsoft Excel Font2 object. More...

Inheritance diagram for wxAutoExcel::wxExcelFont2:
wxAutoExcel::wxExcelObject

Public Member Functions

MsoTriState GetAllcaps ()
 True if the font is formatted as all capital letters. More...
 
void SetAllcaps (MsoTriState allcaps)
 True if the font is formatted as all capital letters. More...
 
MsoTriState GetAutorotateNumbers ()
 Gets or sets a value that specifies whether the numbers in a numbered list should be rotated when the text is rotated. More...
 
void SetAutorotateNumbers (MsoTriState autorotateNumbers)
 Gets or sets a value that specifies whether the numbers in a numbered list should be rotated when the text is rotated. More...
 
double GetBaselineOffset ()
 Gets or sets a value specifying the horizontaol offset of the selected font. More...
 
void SetBaselineOffset (double baselineOffset)
 Gets or sets a value specifying the horizontaol offset of the selected font. More...
 
MsoTriState GetBold ()
 Gets or sets a value specifying whether the font should be bold. More...
 
void SetBold (MsoTriState bold)
 Gets or sets a value specifying whether the font should be bold. More...
 
MsoTextCaps GetCaps ()
 Gets or sets a value specifying that the text should be capitalized. More...
 
void SetCaps (MsoTextCaps caps)
 Gets or sets a value specifying that the text should be capitalized. More...
 
MsoTriState GetDoubleStrikeThrough ()
 True if the specified font is formatted as double strikethrough text. More...
 
void SetDoubleStrikeThrough (MsoTriState doubleStrikeThrough)
 True if the specified font is formatted as double strikethrough text. More...
 
MsoTriState GetEmbeddable ()
 Gets a value indicating whether the font can be embedded in a page. More...
 
MsoTriState GetEmbedded ()
 Gets a value specifying whether the font is embedded in a page. More...
 
MsoTriState GetEqualize ()
 Gets or sets a value specifying whether the text for a selection should be spaced equal distances apart. More...
 
void SetEqualize (MsoTriState equalize)
 Gets or sets a value specifying whether the text for a selection should be spaced equal distances apart. More...
 
wxExcelFillFormat GetFill ()
 Gets a value specifying the fill format for a font. More...
 
wxExcelGlowFormat GetGlow ()
 Gets a value indicating whether the font is displayed as a glow effect. More...
 
wxExcelColorFormat GetHighlight ()
 Gets a value indicating whether the font is displayed as highlighted. More...
 
MsoTriState GetItalic ()
 Gets or sets a value specifying whether the text for a selection is italic. More...
 
void SetItalic (MsoTriState italic)
 Gets or sets a value specifying whether the text for a selection is italic. More...
 
double GetKerning ()
 Gets or sets a value specifying the amount of spacing between text characters. More...
 
void SetKerning (double kerning)
 Gets or sets a value specifying the amount of spacing between text characters. More...
 
wxExcelLineFormat GetLine ()
 Gets a value specifiying the format of a line. More...
 
wxString GetName ()
 Gets or sets a value specifying the font to use for a selection. More...
 
void SetName (const wxString &name)
 Gets or sets a value specifying the font to use for a selection. More...
 
wxString GetNameAscii ()
 Gets or sets the font used for Latin text (characters with character codes from 0 (zero) through 127). More...
 
void SetNameAscii (const wxString &nameAscii)
 Gets or sets the font used for Latin text (characters with character codes from 0 (zero) through 127). More...
 
wxString GetNameComplexScript ()
 Gets or sets the complex script font name. More...
 
void SetNameComplexScript (const wxString &nameComplexScript)
 Gets or sets the complex script font name. More...
 
wxString GetNameFarEast ()
 Gets or sets an East Asian font name. More...
 
void SetNameFarEast (const wxString &nameFarEast)
 Gets or sets an East Asian font name. More...
 
wxString GetNameOther ()
 Gets or sets the font used for characters whose character set numbers are greater than 127. More...
 
void SetNameOther (const wxString &nameOther)
 Gets or sets the font used for characters whose character set numbers are greater than 127. More...
 
wxExcelReflectionFormat GetReflection ()
 Gets a value specifying the type of reflection format for the selection of text. More...
 
wxExcelShadowFormat GetShadow ()
 Gets the value specifying the type of shadow effect for the selection of text. More...
 
double GetSize ()
 Gets or sets a value specifying the size of the font. More...
 
void SetSize (double size)
 Gets or sets a value specifying the size of the font. More...
 
MsoTriState GetSmallcaps ()
 Gets or sets a value specifying whether small caps should be used with the slection of text. More...
 
void SetSmallcaps (MsoTriState smallcaps)
 Gets or sets a value specifying whether small caps should be used with the slection of text. More...
 
MsoSoftEdgeType GetSoftEdgeFormat ()
 Gets or sets a value specifying the type of soft edge effect used in a selection of text. More...
 
void SetSoftEdgeFormat (MsoSoftEdgeType softEdgeFormat)
 Gets or sets a value specifying the type of soft edge effect used in a selection of text. More...
 
double GetSpacing ()
 Gets or sets a value specifying the spacing between characters in a selection of text. More...
 
void SetSpacing (double spacing)
 Gets or sets a value specifying the spacing between characters in a selection of text. More...
 
MsoTextStrike GetStrike ()
 Gets or sets a value specifying the strike format used for a selection of text. More...
 
void SetStrike (MsoTextStrike strike)
 Gets or sets a value specifying the strike format used for a selection of text. More...
 
MsoTriState GetStrikeThrough ()
 Gets or sets a value specifying the text should be rendered in a strikethrough appearance. More...
 
void SetStrikeThrough (MsoTriState strikeThrough)
 Gets or sets a value specifying the text should be rendered in a strikethrough appearance. More...
 
MsoTriState GetSubscript ()
 Gets or sets a value specifying that the selected text should be displayed a subscript. More...
 
void SetSubscript (MsoTriState subscript)
 Gets or sets a value specifying that the selected text should be displayed a subscript. More...
 
MsoTriState GetSuperscript ()
 Gets or sets a value specifying that the selected text should be displayed a subscript. More...
 
void SetSuperscript (MsoTriState superscript)
 Gets or sets a value specifying that the selected text should be displayed a subscript. More...
 
wxExcelColorFormat GetUnderlineColor ()
 Gets a value specifying the color of the underline for the selected text. More...
 
MsoTextUnderlineType GetUnderlineStyle ()
 Gets or sets a value specifying the underline style for the selected text. More...
 
void SetUnderlineStyle (MsoTextUnderlineType underlineStyle)
 Gets or sets a value specifying the underline style for the selected text. More...
 
MsoPresetTextEffect GetWordArtformat ()
 Gets or sets a value specifying the text effect for the selected text. More...
 
void SetWordArtformat (MsoPresetTextEffect wordArtformat)
 Gets or sets a value specifying the text effect for the selected text. More...
 
virtual wxString GetAutoExcelObjectName_ () const
 Returns "Font2". 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 Font2 object.

MSDN documentation for Font.

Member Function Documentation

◆ GetAllcaps()

MsoTriState wxAutoExcel::wxExcelFont2::GetAllcaps ( )

True if the font is formatted as all capital letters.

MSDN documentation for Font2.Allcaps.

◆ SetAllcaps()

void wxAutoExcel::wxExcelFont2::SetAllcaps ( MsoTriState  allcaps)

True if the font is formatted as all capital letters.

MSDN documentation for Font2.Allcaps.

◆ GetAutorotateNumbers()

MsoTriState wxAutoExcel::wxExcelFont2::GetAutorotateNumbers ( )

Gets or sets a value that specifies whether the numbers in a numbered list should be rotated when the text is rotated.

MSDN documentation for Font2.AutorotateNumbers.

◆ SetAutorotateNumbers()

void wxAutoExcel::wxExcelFont2::SetAutorotateNumbers ( MsoTriState  autorotateNumbers)

Gets or sets a value that specifies whether the numbers in a numbered list should be rotated when the text is rotated.

MSDN documentation for Font2.AutorotateNumbers.

◆ GetBaselineOffset()

double wxAutoExcel::wxExcelFont2::GetBaselineOffset ( )

Gets or sets a value specifying the horizontaol offset of the selected font.

MSDN documentation for Font2.BaselineOffset.

◆ SetBaselineOffset()

void wxAutoExcel::wxExcelFont2::SetBaselineOffset ( double  baselineOffset)

Gets or sets a value specifying the horizontaol offset of the selected font.

MSDN documentation for Font2.BaselineOffset.

◆ GetBold()

MsoTriState wxAutoExcel::wxExcelFont2::GetBold ( )

Gets or sets a value specifying whether the font should be bold.

MSDN documentation for Font2.Bold.

◆ SetBold()

void wxAutoExcel::wxExcelFont2::SetBold ( MsoTriState  bold)

Gets or sets a value specifying whether the font should be bold.

MSDN documentation for Font2.Bold.

◆ GetCaps()

MsoTextCaps wxAutoExcel::wxExcelFont2::GetCaps ( )

Gets or sets a value specifying that the text should be capitalized.

MSDN documentation for Font2.Caps.

◆ SetCaps()

void wxAutoExcel::wxExcelFont2::SetCaps ( MsoTextCaps  caps)

Gets or sets a value specifying that the text should be capitalized.

MSDN documentation for Font2.Caps.

◆ GetDoubleStrikeThrough()

MsoTriState wxAutoExcel::wxExcelFont2::GetDoubleStrikeThrough ( )

True if the specified font is formatted as double strikethrough text.

MSDN documentation for Font2.DoubleStrikeThrough.

◆ SetDoubleStrikeThrough()

void wxAutoExcel::wxExcelFont2::SetDoubleStrikeThrough ( MsoTriState  doubleStrikeThrough)

True if the specified font is formatted as double strikethrough text.

MSDN documentation for Font2.DoubleStrikeThrough.

◆ GetEmbeddable()

MsoTriState wxAutoExcel::wxExcelFont2::GetEmbeddable ( )

Gets a value indicating whether the font can be embedded in a page.

MSDN documentation for Font2.Embeddable.

◆ GetEmbedded()

MsoTriState wxAutoExcel::wxExcelFont2::GetEmbedded ( )

Gets a value specifying whether the font is embedded in a page.

MSDN documentation for Font2.Embedded.

◆ GetEqualize()

MsoTriState wxAutoExcel::wxExcelFont2::GetEqualize ( )

Gets or sets a value specifying whether the text for a selection should be spaced equal distances apart.

MSDN documentation for Font2.Equalize.

◆ SetEqualize()

void wxAutoExcel::wxExcelFont2::SetEqualize ( MsoTriState  equalize)

Gets or sets a value specifying whether the text for a selection should be spaced equal distances apart.

MSDN documentation for Font2.Equalize.

◆ GetFill()

wxExcelFillFormat wxAutoExcel::wxExcelFont2::GetFill ( )

Gets a value specifying the fill format for a font.

MSDN documentation for Font2.Fill.

◆ GetGlow()

wxExcelGlowFormat wxAutoExcel::wxExcelFont2::GetGlow ( )

Gets a value indicating whether the font is displayed as a glow effect.

MSDN documentation for Font2.Glow.

◆ GetHighlight()

wxExcelColorFormat wxAutoExcel::wxExcelFont2::GetHighlight ( )

Gets a value indicating whether the font is displayed as highlighted.

MSDN documentation for Font2.Highlight.

◆ GetItalic()

MsoTriState wxAutoExcel::wxExcelFont2::GetItalic ( )

Gets or sets a value specifying whether the text for a selection is italic.

MSDN documentation for Font2.Italic.

◆ SetItalic()

void wxAutoExcel::wxExcelFont2::SetItalic ( MsoTriState  italic)

Gets or sets a value specifying whether the text for a selection is italic.

MSDN documentation for Font2.Italic.

◆ GetKerning()

double wxAutoExcel::wxExcelFont2::GetKerning ( )

Gets or sets a value specifying the amount of spacing between text characters.

MSDN documentation for Font2.Kerning.

◆ SetKerning()

void wxAutoExcel::wxExcelFont2::SetKerning ( double  kerning)

Gets or sets a value specifying the amount of spacing between text characters.

MSDN documentation for Font2.Kerning.

◆ GetLine()

wxExcelLineFormat wxAutoExcel::wxExcelFont2::GetLine ( )

Gets a value specifiying the format of a line.

MSDN documentation for Font2.Line.

◆ GetName()

wxString wxAutoExcel::wxExcelFont2::GetName ( )

Gets or sets a value specifying the font to use for a selection.

MSDN documentation for Font2.Name.

◆ SetName()

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

Gets or sets a value specifying the font to use for a selection.

MSDN documentation for Font2.Name.

◆ GetNameAscii()

wxString wxAutoExcel::wxExcelFont2::GetNameAscii ( )

Gets or sets the font used for Latin text (characters with character codes from 0 (zero) through 127).

MSDN documentation for Font2.NameAscii.

◆ SetNameAscii()

void wxAutoExcel::wxExcelFont2::SetNameAscii ( const wxString &  nameAscii)

Gets or sets the font used for Latin text (characters with character codes from 0 (zero) through 127).

MSDN documentation for Font2.NameAscii.

◆ GetNameComplexScript()

wxString wxAutoExcel::wxExcelFont2::GetNameComplexScript ( )

Gets or sets the complex script font name.

Used for mixed language text..

MSDN documentation for Font2.NameComplexScript.

◆ SetNameComplexScript()

void wxAutoExcel::wxExcelFont2::SetNameComplexScript ( const wxString &  nameComplexScript)

Gets or sets the complex script font name.

Used for mixed language text..

MSDN documentation for Font2.NameComplexScript.

◆ GetNameFarEast()

wxString wxAutoExcel::wxExcelFont2::GetNameFarEast ( )

Gets or sets an East Asian font name.

MSDN documentation for Font2.NameFarEast.

◆ SetNameFarEast()

void wxAutoExcel::wxExcelFont2::SetNameFarEast ( const wxString &  nameFarEast)

Gets or sets an East Asian font name.

MSDN documentation for Font2.NameFarEast.

◆ GetNameOther()

wxString wxAutoExcel::wxExcelFont2::GetNameOther ( )

Gets or sets the font used for characters whose character set numbers are greater than 127.

MSDN documentation for Font2.NameOther.

◆ SetNameOther()

void wxAutoExcel::wxExcelFont2::SetNameOther ( const wxString &  nameOther)

Gets or sets the font used for characters whose character set numbers are greater than 127.

MSDN documentation for Font2.NameOther.

◆ GetReflection()

wxExcelReflectionFormat wxAutoExcel::wxExcelFont2::GetReflection ( )

Gets a value specifying the type of reflection format for the selection of text.

MSDN documentation for Font2.Reflection.

◆ GetShadow()

wxExcelShadowFormat wxAutoExcel::wxExcelFont2::GetShadow ( )

Gets the value specifying the type of shadow effect for the selection of text.

MSDN documentation for Font2.Shadow.

◆ GetSize()

double wxAutoExcel::wxExcelFont2::GetSize ( )

Gets or sets a value specifying the size of the font.

MSDN documentation for Font2.Size.

◆ SetSize()

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

Gets or sets a value specifying the size of the font.

MSDN documentation for Font2.Size.

◆ GetSmallcaps()

MsoTriState wxAutoExcel::wxExcelFont2::GetSmallcaps ( )

Gets or sets a value specifying whether small caps should be used with the slection of text.

Small caps are the same height as the lowercase letters in a slection of text.

MSDN documentation for Font2.Smallcaps.

◆ SetSmallcaps()

void wxAutoExcel::wxExcelFont2::SetSmallcaps ( MsoTriState  smallcaps)

Gets or sets a value specifying whether small caps should be used with the slection of text.

Small caps are the same height as the lowercase letters in a slection of text.

MSDN documentation for Font2.Smallcaps.

◆ GetSoftEdgeFormat()

MsoSoftEdgeType wxAutoExcel::wxExcelFont2::GetSoftEdgeFormat ( )

Gets or sets a value specifying the type of soft edge effect used in a selection of text.

MSDN documentation for Font2.SoftEdgeFormat.

◆ SetSoftEdgeFormat()

void wxAutoExcel::wxExcelFont2::SetSoftEdgeFormat ( MsoSoftEdgeType  softEdgeFormat)

Gets or sets a value specifying the type of soft edge effect used in a selection of text.

MSDN documentation for Font2.SoftEdgeFormat.

◆ GetSpacing()

double wxAutoExcel::wxExcelFont2::GetSpacing ( )

Gets or sets a value specifying the spacing between characters in a selection of text.

MSDN documentation for Font2.Spacing.

◆ SetSpacing()

void wxAutoExcel::wxExcelFont2::SetSpacing ( double  spacing)

Gets or sets a value specifying the spacing between characters in a selection of text.

MSDN documentation for Font2.Spacing.

◆ GetStrike()

MsoTextStrike wxAutoExcel::wxExcelFont2::GetStrike ( )

Gets or sets a value specifying the strike format used for a selection of text.

MSDN documentation for Font2.Strike.

◆ SetStrike()

void wxAutoExcel::wxExcelFont2::SetStrike ( MsoTextStrike  strike)

Gets or sets a value specifying the strike format used for a selection of text.

MSDN documentation for Font2.Strike.

◆ GetStrikeThrough()

MsoTriState wxAutoExcel::wxExcelFont2::GetStrikeThrough ( )

Gets or sets a value specifying the text should be rendered in a strikethrough appearance.

MSDN documentation for Font2.StrikeThrough.

◆ SetStrikeThrough()

void wxAutoExcel::wxExcelFont2::SetStrikeThrough ( MsoTriState  strikeThrough)

Gets or sets a value specifying the text should be rendered in a strikethrough appearance.

MSDN documentation for Font2.StrikeThrough.

◆ GetSubscript()

MsoTriState wxAutoExcel::wxExcelFont2::GetSubscript ( )

Gets or sets a value specifying that the selected text should be displayed a subscript.

MSDN documentation for Font2.Subscript.

◆ SetSubscript()

void wxAutoExcel::wxExcelFont2::SetSubscript ( MsoTriState  subscript)

Gets or sets a value specifying that the selected text should be displayed a subscript.

MSDN documentation for Font2.Subscript.

◆ GetSuperscript()

MsoTriState wxAutoExcel::wxExcelFont2::GetSuperscript ( )

Gets or sets a value specifying that the selected text should be displayed a subscript.

MSDN documentation for Font2.Superscript.

◆ SetSuperscript()

void wxAutoExcel::wxExcelFont2::SetSuperscript ( MsoTriState  superscript)

Gets or sets a value specifying that the selected text should be displayed a subscript.

MSDN documentation for Font2.Superscript.

◆ GetUnderlineColor()

wxExcelColorFormat wxAutoExcel::wxExcelFont2::GetUnderlineColor ( )

Gets a value specifying the color of the underline for the selected text.

MSDN documentation for Font2.UnderlineColor.

◆ GetUnderlineStyle()

MsoTextUnderlineType wxAutoExcel::wxExcelFont2::GetUnderlineStyle ( )

Gets or sets a value specifying the underline style for the selected text.

MSDN documentation for Font2.UnderlineStyle.

◆ SetUnderlineStyle()

void wxAutoExcel::wxExcelFont2::SetUnderlineStyle ( MsoTextUnderlineType  underlineStyle)

Gets or sets a value specifying the underline style for the selected text.

MSDN documentation for Font2.UnderlineStyle.

◆ GetWordArtformat()

MsoPresetTextEffect wxAutoExcel::wxExcelFont2::GetWordArtformat ( )

Gets or sets a value specifying the text effect for the selected text.

MSDN documentation for Font2.WordArtformat.

◆ SetWordArtformat()

void wxAutoExcel::wxExcelFont2::SetWordArtformat ( MsoPresetTextEffect  wordArtformat)

Gets or sets a value specifying the text effect for the selected text.

MSDN documentation for Font2.WordArtformat.

◆ GetAutoExcelObjectName_()

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

Returns "Font2".

Reimplemented from wxAutoExcel::wxExcelObject.