Represents Microsoft Excel TextFrame2. More...

#include <wxAutoExcelTextFrame2.h>

Inheritance diagram for wxAutoExcel::wxExcelTextFrame2:

Public Member Functions
void	DeleteText ()
	Deletes the text from a text frame and all the associated text properties.
MsoAutoSize	GetAutoSize ()
	The size of the specified object that changes automatically to fit text within its boundaries.
void	SetAutoSize (MsoAutoSize autoSize)
	Sets whether the size of the specified shape is changed automatically to fit text within its boundaries.
wxExcelTextColumn2	GetColumn ()
	Returns the TextColumn2 Represents the columns within the text frame.
long	GetCreator ()
	Returns a 32-bit integer that indicates the application in which this object was created.
MsoTriState	GetHasText ()
	Returns whether the specified text frame has text.
MsoHorizontalAnchor	GetHorizontalAnchor ()
	Returns the horizontal anchor type for the specified text.
void	SetHorizontalAnchor (MsoHorizontalAnchor horizontalAnchor)
	Sets the horizontal anchor type for the specified text.
double	GetMarginBottom ()
	Returns the distance (in points) between the bottom of the text frame and the bottom of the inscribed rectangle of the shape that contains the text.
void	SetMarginBottom (double marginBottom)
	Sets the distance (in points) between the bottom of the text frame and the bottom of the inscribed rectangle of the shape that contains the text.
double	GetMarginLeft ()
	Returns the distance (in points) between the left edge of the text frame and the left edge of the inscribed rectangle of the shape that contains the text.
void	SetMarginLeft (double marginLeft)
	Sets the distance (in points) between the left edge of the text frame and the left edge of the inscribed rectangle of the shape that contains the text.
double	GetMarginRight ()
	Returns the distance (in points) between the right edge of the text frame and the right edge of the inscribed rectangle of the shape that contains the text.
void	SetMarginRight (double marginRight)
	Sets the distance (in points) between the right edge of the text frame and the right edge of the inscribed rectangle of the shape that contains the text.
double	GetMarginTop ()
	Returns the distance (in points) between the top of the text frame and the top of the inscribed rectangle of the shape that contains the textSince Excel 2007.
void	SetMarginTop (double marginTop)
	Sets the distance (in points) between the top of the text frame and the top of the inscribed rectangle of the shape that contains the text.
MsoTriState	GetNoTextRotation ()
	Returns a value that specifies if the text on a shape is rotated if the shape itself is being rotated.
void	SetNoTextRotation (MsoTriState rotation)
	Sets a value that specifies if the text on a shape is rotated if the shape itself is being rotated.
MsoTextOrientation	GetOrientation ()
	Returns a value that represents the text frame orientation.
void	SetOrientation (MsoTextOrientation orientation)
	Sets a value that represents the text frame orientation.
MsoPathFormat	GetPathFormat ()
	Returns the path type for the specified text frame.
void	SetPathFormat (MsoPathFormat pathFormat)
	Sets the path type for the specified text frame.
wxExcelTextRange2	GetTextRange ()
	Returns the TextRange2 Represents the text in the object.
wxExcelThreeDFormat	GetThreeD ()
	Returns a ThreeDFormat object that contains 3-D�effect formatting properties for the specified text.
MsoVerticalAnchor	GetVerticalAnchor ()
	Returns the vertical anchor type for the specified text.
void	SetVerticalAnchor (MsoVerticalAnchor verticalAnchor)
	Sets the vertical anchor type for the specified text.
MsoWarpFormat	GetWarpFormat ()
	Returns the warp type for the specified text frame.
void	SetWarpFormat (MsoWarpFormat warpFormat)
	Sets the warp type for the specified text frame.
MsoPresetTextEffect	GetWordArtformat ()
	Returns the Word Art type for the specified text frame.
void	SetWordArtformat (MsoPresetTextEffect wordArtformat)
	Sets the Word Art type for the specified text frame.
MsoTriState	GetWordWrap ()
	Returns text break lines within or past the boundaries of the shape.
void	SetWordWrap (MsoTriState wordWrap)
	Sets text break lines within or past the boundaries of the shape.
virtual wxString	GetAutoExcelObjectName_ () const
	Returns "TextFrame2".
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.
bool	IsLastResultNull_ () const
	Returns true if MS Excel returned Null (or Empty) for the last property or method, e.g.
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 TextFrame2.

Member Function Documentation

◆ DeleteText()

void wxAutoExcel::wxExcelTextFrame2::DeleteText ( )

Deletes the text from a text frame and all the associated text properties.

MSDN documentation for TextFrame2.DeleteText.

◆ GetAutoSize()

MsoAutoSize wxAutoExcel::wxExcelTextFrame2::GetAutoSize ( )

The size of the specified object that changes automatically to fit text within its boundaries.

Since Excel 2007.

MSDN documentation for TextFrame2.AutoSize.

◆ SetAutoSize()

void wxAutoExcel::wxExcelTextFrame2::SetAutoSize ( MsoAutoSize autoSize )

Sets whether the size of the specified shape is changed automatically to fit text within its boundaries.

MSDN documentation for TextFrame2.AutoSize.

◆ GetColumn()

wxExcelTextColumn2 wxAutoExcel::wxExcelTextFrame2::GetColumn ( )

Returns the TextColumn2 Represents the columns within the text frame.

Since Excel 2007.

MSDN documentation for TextFrame2.Column.

◆ GetCreator()

long wxAutoExcel::wxExcelTextFrame2::GetCreator ( )

Returns a 32-bit integer that indicates the application in which this object was created.

Since Excel 2007.

MSDN documentation for TextFrame2.Creator.

◆ GetHasText()

MsoTriState wxAutoExcel::wxExcelTextFrame2::GetHasText ( )

Returns whether the specified text frame has text.

Since Excel 2007.

MSDN documentation for TextFrame2.HasText.

◆ GetHorizontalAnchor()

MsoHorizontalAnchor wxAutoExcel::wxExcelTextFrame2::GetHorizontalAnchor ( )

Returns the horizontal anchor type for the specified text.

Since Excel 2007.

MSDN documentation for TextFrame2.HorizontalAnchor.

◆ SetHorizontalAnchor()

void wxAutoExcel::wxExcelTextFrame2::SetHorizontalAnchor ( MsoHorizontalAnchor horizontalAnchor )

Sets the horizontal anchor type for the specified text.

Since Excel 2007.

MSDN documentation for TextFrame2.HorizontalAnchor.

◆ GetMarginBottom()

double wxAutoExcel::wxExcelTextFrame2::GetMarginBottom ( )

Returns the distance (in points) between the bottom of the text frame and the bottom of the inscribed rectangle of the shape that contains the text.

Since Excel 2007.

MSDN documentation for TextFrame2.MarginBottom.

◆ SetMarginBottom()

void wxAutoExcel::wxExcelTextFrame2::SetMarginBottom ( double marginBottom )

Sets the distance (in points) between the bottom of the text frame and the bottom of the inscribed rectangle of the shape that contains the text.

Since Excel 2007.

MSDN documentation for TextFrame2.MarginBottom.

◆ GetMarginLeft()

double wxAutoExcel::wxExcelTextFrame2::GetMarginLeft ( )

Returns the distance (in points) between the left edge of the text frame and the left edge of the inscribed rectangle of the shape that contains the text.

Since Excel 2007.

MSDN documentation for TextFrame2.MarginLeft.

◆ SetMarginLeft()

void wxAutoExcel::wxExcelTextFrame2::SetMarginLeft ( double marginLeft )

Sets the distance (in points) between the left edge of the text frame and the left edge of the inscribed rectangle of the shape that contains the text.

Since Excel 2007.

MSDN documentation for TextFrame2.MarginLeft.

◆ GetMarginRight()

double wxAutoExcel::wxExcelTextFrame2::GetMarginRight ( )

Returns the distance (in points) between the right edge of the text frame and the right edge of the inscribed rectangle of the shape that contains the text.

Since Excel 2007.

MSDN documentation for TextFrame2.MarginRight.

◆ SetMarginRight()

void wxAutoExcel::wxExcelTextFrame2::SetMarginRight ( double marginRight )

Sets the distance (in points) between the right edge of the text frame and the right edge of the inscribed rectangle of the shape that contains the text.

Since Excel 2007.

MSDN documentation for TextFrame2.MarginRight.

◆ GetMarginTop()

double wxAutoExcel::wxExcelTextFrame2::GetMarginTop ( )

Returns the distance (in points) between the top of the text frame and the top of the inscribed rectangle of the shape that contains the textSince Excel 2007.

MSDN documentation for TextFrame2.MarginTop.

◆ SetMarginTop()

void wxAutoExcel::wxExcelTextFrame2::SetMarginTop ( double marginTop )

Sets the distance (in points) between the top of the text frame and the top of the inscribed rectangle of the shape that contains the text.

Since Excel 2007.

MSDN documentation for TextFrame2.MarginTop.

◆ GetNoTextRotation()

MsoTriState wxAutoExcel::wxExcelTextFrame2::GetNoTextRotation ( )

Returns a value that specifies if the text on a shape is rotated if the shape itself is being rotated.

MSDN documentation for TextFrame2.NoTextRotation.

◆ SetNoTextRotation()

void wxAutoExcel::wxExcelTextFrame2::SetNoTextRotation ( MsoTriState rotation )

Sets a value that specifies if the text on a shape is rotated if the shape itself is being rotated.

MSDN documentation for TextFrame2.NoTextRotation.

◆ GetOrientation()

MsoTextOrientation wxAutoExcel::wxExcelTextFrame2::GetOrientation ( )

Returns a value that represents the text frame orientation.

Since Excel 2007.

MSDN documentation for TextFrame2.Orientation.

◆ SetOrientation()

void wxAutoExcel::wxExcelTextFrame2::SetOrientation ( MsoTextOrientation orientation )

Sets a value that represents the text frame orientation.

Since Excel 2007.

MSDN documentation for TextFrame2.Orientation.

◆ GetPathFormat()

MsoPathFormat wxAutoExcel::wxExcelTextFrame2::GetPathFormat ( )

Returns the path type for the specified text frame.

Since Excel 2007.

MSDN documentation for TextFrame2.PathFormat.

◆ SetPathFormat()

void wxAutoExcel::wxExcelTextFrame2::SetPathFormat ( MsoPathFormat pathFormat )

Sets the path type for the specified text frame.

MSDN documentation for TextFrame2.PathFormat.

◆ GetTextRange()

wxExcelTextRange2 wxAutoExcel::wxExcelTextFrame2::GetTextRange ( )

Returns the TextRange2 Represents the text in the object.

Since Excel 2007.

MSDN documentation for TextFrame2.TextRange.

◆ GetThreeD()

wxExcelThreeDFormat wxAutoExcel::wxExcelTextFrame2::GetThreeD ( )

Returns a ThreeDFormat object that contains 3-D�effect formatting properties for the specified text.

Since Excel 2007.

MSDN documentation for TextFrame2.ThreeD.

◆ GetVerticalAnchor()

MsoVerticalAnchor wxAutoExcel::wxExcelTextFrame2::GetVerticalAnchor ( )

Returns the vertical anchor type for the specified text.

Since Excel 2007.

MSDN documentation for TextFrame2.VerticalAnchor.

◆ SetVerticalAnchor()

void wxAutoExcel::wxExcelTextFrame2::SetVerticalAnchor ( MsoVerticalAnchor verticalAnchor )

Sets the vertical anchor type for the specified text.

Since Excel 2007.

MSDN documentation for TextFrame2.VerticalAnchor.

◆ GetWarpFormat()

MsoWarpFormat wxAutoExcel::wxExcelTextFrame2::GetWarpFormat ( )

Returns the warp type for the specified text frame.

Since Excel 2007.

MSDN documentation for TextFrame2.WarpFormat.

◆ SetWarpFormat()

void wxAutoExcel::wxExcelTextFrame2::SetWarpFormat ( MsoWarpFormat warpFormat )

Sets the warp type for the specified text frame.

Since Excel 2007.

MSDN documentation for TextFrame2.WarpFormat.

◆ GetWordArtformat()

MsoPresetTextEffect wxAutoExcel::wxExcelTextFrame2::GetWordArtformat ( )

Returns the Word Art type for the specified text frame.

Since Excel 2007.

MSDN documentation for TextFrame2.WordArtformat.

◆ SetWordArtformat()

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

Sets the Word Art type for the specified text frame.

Since Excel 2007.

MSDN documentation for TextFrame2.WordArtformat.

◆ GetWordWrap()

MsoTriState wxAutoExcel::wxExcelTextFrame2::GetWordWrap ( )

Returns text break lines within or past the boundaries of the shape.

Since Excel 2007.

MSDN documentation for TextFrame2.WordWrap.

◆ SetWordWrap()

void wxAutoExcel::wxExcelTextFrame2::SetWordWrap ( MsoTriState wordWrap )

Sets text break lines within or past the boundaries of the shape.

Since Excel 2007.

MSDN documentation for TextFrame2.WordWrap.

◆ GetAutoExcelObjectName_()

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

inlinevirtual

Returns "TextFrame2".

Reimplemented from wxAutoExcel::wxExcelObject.

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ DeleteText()

◆ GetAutoSize()

◆ SetAutoSize()

◆ GetColumn()

◆ GetCreator()

◆ GetHasText()

◆ GetHorizontalAnchor()

◆ SetHorizontalAnchor()

◆ GetMarginBottom()

◆ SetMarginBottom()

◆ GetMarginLeft()

◆ SetMarginLeft()

◆ GetMarginRight()

◆ SetMarginRight()

◆ GetMarginTop()

◆ SetMarginTop()

◆ GetNoTextRotation()

◆ SetNoTextRotation()

◆ GetOrientation()

◆ SetOrientation()

◆ GetPathFormat()

◆ SetPathFormat()

◆ GetTextRange()

◆ GetThreeD()

◆ GetVerticalAnchor()

◆ SetVerticalAnchor()

◆ GetWarpFormat()

◆ SetWarpFormat()

◆ GetWordArtformat()

◆ SetWordArtformat()

◆ GetWordWrap()

◆ SetWordWrap()

◆ GetAutoExcelObjectName_()