Represents Microsoft Excel TextEffectFormat object. More...

Inheritance diagram for wxAutoExcel::wxExcelTextEffectFormat:

Public Member Functions
void	ToggleVerticalText ()
	Switches the text flow in the specified WordArt from horizontal to vertical, or vice versa. More...

MsoTextEffectAlignment	GetAlignment ()
	Returns an MsoTextEffectAlignment value that represents the alignment for WordArt. More...

MsoTriState	GetFontBold ()
	True if the font in the specified WordArt is bold. More...

void	SetFontBold (MsoTriState fontBold)
	True if the font in the specified WordArt is bold. More...

MsoTriState	GetFontItalic ()
	Returns msoTrue if the font in the specified WordArt is italic. More...

void	SetFontItalic (MsoTriState fontItalic)
	Returns msoTrue if the font in the specified WordArt is italic. More...

wxString	GetFontName ()
	Returns the name of the font in the specified WordArt. More...

void	SetFontName (const wxString &fontName)
	Sets the name of the font in the specified WordArt. More...

double	GetFontSize ()
	Returns the font size for the specified WordArt, in points. More...

void	SetFontSize (double fontSize)
	Sets the font size for the specified WordArt, in points. More...

MsoTriState	GetKernedPairs ()
	True if character pairs in the specified WordArt are kerned. More...

void	SetKernedPairs (MsoTriState kernedPairs)
	True if character pairs in the specified WordArt are kerned. More...

MsoTriState	GetNormalizedHeight ()
	True if all characters (both uppercase and lowercase) in the specified WordArt are the same height. More...

void	SetNormalizedHeight (MsoTriState normalizedHeight)
	True if all characters (both uppercase and lowercase) in the specified WordArt are the same height. More...

MsoPresetTextEffectShape	GetPresetShape ()
	Returns the shape of the specified WordArt. More...

void	SetPresetShape (MsoPresetTextEffectShape presetShape)
	Sets the shape of the specified WordArt. More...

MsoPresetTextEffect	GetPresetTextEffect ()
	Returns the style of the specified WordArt. More...

void	SetPresetTextEffect (MsoPresetTextEffect presetTextEffect)
	Sets the style of the specified WordArt. More...

MsoTriState	GetRotatedChars ()
	True if characters in the specified WordArt are rotated 90 degrees relative to the WordArt's bounding shape. More...

void	SetRotatedChars (MsoTriState rotatedChars)
	True if characters in the specified WordArt are rotated 90 degrees relative to the WordArt's bounding shape. More...

wxString	GetText ()
	Returns the text for the specified object. More...

void	SetText (const wxString &text)
	Sets the text for the specified object. More...

double	GetTracking ()
	Returns the ratio of the horizontal space allotted to each character in the specified WordArt to the width of the character. More...

void	SetTracking (double tracking)
	Sets the ratio of the horizontal space allotted to each character in the specified WordArt to the width of the character. More...

virtual wxString	GetAutoExcelObjectName_ () const
	Returns "TextEffectFormat". 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 TextEffectFormat object.

Member Function Documentation

◆ ToggleVerticalText()

void wxAutoExcel::wxExcelTextEffectFormat::ToggleVerticalText ( )

Switches the text flow in the specified WordArt from horizontal to vertical, or vice versa.

MSDN documentation for TextEffectFormat.ToggleVerticalText.

◆ GetAlignment()

MsoTextEffectAlignment wxAutoExcel::wxExcelTextEffectFormat::GetAlignment ( )

Returns an MsoTextEffectAlignment value that represents the alignment for WordArt.

MSDN documentation for TextEffectFormat.Alignment.

◆ GetFontBold()

MsoTriState wxAutoExcel::wxExcelTextEffectFormat::GetFontBold ( )

True if the font in the specified WordArt is bold.

Read/write MsoTriState.

MSDN documentation for TextEffectFormat.FontBold.

◆ SetFontBold()

void wxAutoExcel::wxExcelTextEffectFormat::SetFontBold ( MsoTriState fontBold )

True if the font in the specified WordArt is bold.

Read/write MsoTriState.

MSDN documentation for TextEffectFormat.FontBold.

◆ GetFontItalic()

MsoTriState wxAutoExcel::wxExcelTextEffectFormat::GetFontItalic ( )

Returns msoTrue if the font in the specified WordArt is italic.

Read/write MsoTriState.

MSDN documentation for TextEffectFormat.FontItalic.

◆ SetFontItalic()

void wxAutoExcel::wxExcelTextEffectFormat::SetFontItalic ( MsoTriState fontItalic )

Returns msoTrue if the font in the specified WordArt is italic.

Read/write MsoTriState.

MSDN documentation for TextEffectFormat.FontItalic.

◆ GetFontName()

wxString wxAutoExcel::wxExcelTextEffectFormat::GetFontName ( )

Returns the name of the font in the specified WordArt.

MSDN documentation for TextEffectFormat.FontName.

◆ SetFontName()

void wxAutoExcel::wxExcelTextEffectFormat::SetFontName ( const wxString & fontName )

Sets the name of the font in the specified WordArt.

MSDN documentation for TextEffectFormat.FontName.

◆ GetFontSize()

double wxAutoExcel::wxExcelTextEffectFormat::GetFontSize ( )

Returns the font size for the specified WordArt, in points.

Read/write Single.

MSDN documentation for TextEffectFormat.FontSize.

◆ SetFontSize()

void wxAutoExcel::wxExcelTextEffectFormat::SetFontSize ( double fontSize )

Sets the font size for the specified WordArt, in points.

Read/write Single.

MSDN documentation for TextEffectFormat.FontSize.

◆ GetKernedPairs()

MsoTriState wxAutoExcel::wxExcelTextEffectFormat::GetKernedPairs ( )

True if character pairs in the specified WordArt are kerned.

Read/write MsoTriState.

MSDN documentation for TextEffectFormat.KernedPairs.

◆ SetKernedPairs()

void wxAutoExcel::wxExcelTextEffectFormat::SetKernedPairs ( MsoTriState kernedPairs )

True if character pairs in the specified WordArt are kerned.

Read/write MsoTriState.

MSDN documentation for TextEffectFormat.KernedPairs.

◆ GetNormalizedHeight()

MsoTriState wxAutoExcel::wxExcelTextEffectFormat::GetNormalizedHeight ( )

True if all characters (both uppercase and lowercase) in the specified WordArt are the same height.

Read/write MsoTriState.

MSDN documentation for TextEffectFormat.NormalizedHeight.

◆ SetNormalizedHeight()

void wxAutoExcel::wxExcelTextEffectFormat::SetNormalizedHeight ( MsoTriState normalizedHeight )

True if all characters (both uppercase and lowercase) in the specified WordArt are the same height.

Read/write MsoTriState.

MSDN documentation for TextEffectFormat.NormalizedHeight.

◆ GetPresetShape()

MsoPresetTextEffectShape wxAutoExcel::wxExcelTextEffectFormat::GetPresetShape ( )

Returns the shape of the specified WordArt.

Read/write MsoPresetTextEffectShape.

MSDN documentation for TextEffectFormat.PresetShape.

◆ SetPresetShape()

void wxAutoExcel::wxExcelTextEffectFormat::SetPresetShape ( MsoPresetTextEffectShape presetShape )

Sets the shape of the specified WordArt.

Read/write MsoPresetTextEffectShape.

MSDN documentation for TextEffectFormat.PresetShape.

◆ GetPresetTextEffect()

MsoPresetTextEffect wxAutoExcel::wxExcelTextEffectFormat::GetPresetTextEffect ( )

Returns the style of the specified WordArt.

Read/write MsoPresetTextEffect.

MSDN documentation for TextEffectFormat.PresetTextEffect.

◆ SetPresetTextEffect()

void wxAutoExcel::wxExcelTextEffectFormat::SetPresetTextEffect ( MsoPresetTextEffect presetTextEffect )

Sets the style of the specified WordArt.

Read/write MsoPresetTextEffect.

MSDN documentation for TextEffectFormat.PresetTextEffect.

◆ GetRotatedChars()

MsoTriState wxAutoExcel::wxExcelTextEffectFormat::GetRotatedChars ( )

True if characters in the specified WordArt are rotated 90 degrees relative to the WordArt's bounding shape.

False if characters in the specified WordArt retain their original orientation relative to the bounding shape. Read/write MsoTriState.

MSDN documentation for TextEffectFormat.RotatedChars.

◆ SetRotatedChars()

void wxAutoExcel::wxExcelTextEffectFormat::SetRotatedChars ( MsoTriState rotatedChars )

True if characters in the specified WordArt are rotated 90 degrees relative to the WordArt's bounding shape.

False if characters in the specified WordArt retain their original orientation relative to the bounding shape. Read/write MsoTriState.

MSDN documentation for TextEffectFormat.RotatedChars.

◆ GetText()

wxString wxAutoExcel::wxExcelTextEffectFormat::GetText ( )

Returns the text for the specified object.

MSDN documentation for TextEffectFormat.Text.

◆ SetText()

void wxAutoExcel::wxExcelTextEffectFormat::SetText ( const wxString & text )

Sets the text for the specified object.

MSDN documentation for TextEffectFormat.Text.

◆ GetTracking()

double wxAutoExcel::wxExcelTextEffectFormat::GetTracking ( )

Returns the ratio of the horizontal space allotted to each character in the specified WordArt to the width of the character.

Can be a value from 0 (zero) through 5. (Large values for this property specify ample space between characters; values less than 1 can produce character overlap.) Read/write Single.

MSDN documentation for TextEffectFormat.Tracking.

◆ SetTracking()

void wxAutoExcel::wxExcelTextEffectFormat::SetTracking ( double tracking )

Sets the ratio of the horizontal space allotted to each character in the specified WordArt to the width of the character.

Can be a value from 0 (zero) through 5. (Large values for this property specify ample space between characters; values less than 1 can produce character overlap.) Read/write Single.

MSDN documentation for TextEffectFormat.Tracking.

◆ GetAutoExcelObjectName_()

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

inlinevirtual

Returns "TextEffectFormat".

Reimplemented from wxAutoExcel::wxExcelObject.

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ ToggleVerticalText()

◆ GetAlignment()

◆ GetFontBold()

◆ SetFontBold()

◆ GetFontItalic()

◆ SetFontItalic()

◆ GetFontName()

◆ SetFontName()

◆ GetFontSize()

◆ SetFontSize()

◆ GetKernedPairs()

◆ SetKernedPairs()

◆ GetNormalizedHeight()

◆ SetNormalizedHeight()

◆ GetPresetShape()

◆ SetPresetShape()

◆ GetPresetTextEffect()

◆ SetPresetTextEffect()

◆ GetRotatedChars()

◆ SetRotatedChars()

◆ GetText()

◆ SetText()

◆ GetTracking()

◆ SetTracking()

◆ GetAutoExcelObjectName_()