Represents Microsoft Excel TextFrame. More...

Inheritance diagram for wxAutoExcel::wxExcelTextFrame:

Public Member Functions
wxExcelCharacters	Characters (long start=NULL, long length=NULL)
	Returns a Characters Represents a range of characters within a shape�s text frame. More...

bool	GetAutoSize ()
	True if the size of the specified object is changed automatically to fit text within its boundaries. More...

void	SetAutoSize (bool autoSize)
	True if the size of the specified object is changed automatically to fit text within its boundaries. More...

XlHAlign	GetHorizontalAlignment ()
	Returns a XlHAlign value that represents the horizontal alignment for the specified object. More...

void	SetHorizontalAlignment (XlHAlign horizontalAlignment)
	Sets a XlHAlign value that represents the horizontal alignment for the specified object. More...

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

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

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

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

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

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

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 text. More...

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

long	GetOrientation ()
	Returns a Long value that represents the text frame orientation. More...

void	SetOrientation (long orientation)
	Sets a Long value that represents the text frame orientation. More...

long	GetReadingOrder ()
	Returns the reading order for the specified object. More...

void	SetReadingOrder (long readingOrder)
	Sets the reading order for the specified object. More...

XlVAlign	GetVerticalAlignment ()
	Returns a XlVAlign value that represents the vertical alignment of the specified object. More...

void	SetVerticalAlignment (XlVAlign verticalAlignment)
	Sets a XlVAlign value that represents the vertical alignment of the specified object. More...

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

Member Function Documentation

◆ Characters()

wxExcelCharacters wxAutoExcel::wxExcelTextFrame::Characters	(	long *	start = `NULL`,
		long *	length = `NULL`
	)

Returns a Characters Represents a range of characters within a shape�s text frame.

You can use the Characters object to add and format characters within the text frame.

MSDN documentation for TextFrame.Characters.

◆ GetAutoSize()

bool wxAutoExcel::wxExcelTextFrame::GetAutoSize ( )

True if the size of the specified object is changed automatically to fit text within its boundaries.

MSDN documentation for TextFrame.AutoSize.

◆ SetAutoSize()

void wxAutoExcel::wxExcelTextFrame::SetAutoSize ( bool autoSize )

True if the size of the specified object is changed automatically to fit text within its boundaries.

MSDN documentation for TextFrame.AutoSize.

◆ GetHorizontalAlignment()

XlHAlign wxAutoExcel::wxExcelTextFrame::GetHorizontalAlignment ( )

Returns a XlHAlign value that represents the horizontal alignment for the specified object.

MSDN documentation for TextFrame.HorizontalAlignment.

◆ SetHorizontalAlignment()

void wxAutoExcel::wxExcelTextFrame::SetHorizontalAlignment ( XlHAlign horizontalAlignment )

Sets a XlHAlign value that represents the horizontal alignment for the specified object.

MSDN documentation for TextFrame.HorizontalAlignment.

◆ GetMarginBottom()

double wxAutoExcel::wxExcelTextFrame::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.

Read/write Single.

MSDN documentation for TextFrame.MarginBottom.

◆ SetMarginBottom()

void wxAutoExcel::wxExcelTextFrame::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.

Read/write Single.

MSDN documentation for TextFrame.MarginBottom.

◆ GetMarginLeft()

double wxAutoExcel::wxExcelTextFrame::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.

Read/write Single.

MSDN documentation for TextFrame.MarginLeft.

◆ SetMarginLeft()

void wxAutoExcel::wxExcelTextFrame::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.

Read/write Single.

MSDN documentation for TextFrame.MarginLeft.

◆ GetMarginRight()

double wxAutoExcel::wxExcelTextFrame::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.

Read/write Single.

MSDN documentation for TextFrame.MarginRight.

◆ SetMarginRight()

void wxAutoExcel::wxExcelTextFrame::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.

Read/write Single.

MSDN documentation for TextFrame.MarginRight.

◆ GetMarginTop()

double wxAutoExcel::wxExcelTextFrame::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 text.

Read/write Single.

MSDN documentation for TextFrame.MarginTop.

◆ SetMarginTop()

void wxAutoExcel::wxExcelTextFrame::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.

Read/write Single.

MSDN documentation for TextFrame.MarginTop.

◆ GetOrientation()

long wxAutoExcel::wxExcelTextFrame::GetOrientation ( )

Returns a Long value that represents the text frame orientation.

MSDN documentation for TextFrame.Orientation.

◆ SetOrientation()

void wxAutoExcel::wxExcelTextFrame::SetOrientation ( long orientation )

Sets a Long value that represents the text frame orientation.

MSDN documentation for TextFrame.Orientation.

◆ GetReadingOrder()

long wxAutoExcel::wxExcelTextFrame::GetReadingOrder ( )

Returns the reading order for the specified object.

Can be one of the following constants: xlRTL (right-to-left), xlLTR (left-to-right), or xlContext.

MSDN documentation for TextFrame.ReadingOrder.

◆ SetReadingOrder()

void wxAutoExcel::wxExcelTextFrame::SetReadingOrder ( long readingOrder )

Sets the reading order for the specified object.

Can be one of the following constants: xlRTL (right-to-left), xlLTR (left-to-right), or xlContext.

MSDN documentation for TextFrame.ReadingOrder.

◆ GetVerticalAlignment()

XlVAlign wxAutoExcel::wxExcelTextFrame::GetVerticalAlignment ( )

Returns a XlVAlign value that represents the vertical alignment of the specified object.

MSDN documentation for TextFrame.VerticalAlignment.

◆ SetVerticalAlignment()

void wxAutoExcel::wxExcelTextFrame::SetVerticalAlignment ( XlVAlign verticalAlignment )

Sets a XlVAlign value that represents the vertical alignment of the specified object.

MSDN documentation for TextFrame.VerticalAlignment.

◆ GetAutoExcelObjectName_()

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

inlinevirtual

Returns "TextFrame".

Reimplemented from wxAutoExcel::wxExcelObject.

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ Characters()

◆ GetAutoSize()

◆ SetAutoSize()

◆ GetHorizontalAlignment()

◆ SetHorizontalAlignment()

◆ GetMarginBottom()

◆ SetMarginBottom()

◆ GetMarginLeft()

◆ SetMarginLeft()

◆ GetMarginRight()

◆ SetMarginRight()

◆ GetMarginTop()

◆ SetMarginTop()

◆ GetOrientation()

◆ SetOrientation()

◆ GetReadingOrder()

◆ SetReadingOrder()

◆ GetVerticalAlignment()

◆ SetVerticalAlignment()

◆ GetAutoExcelObjectName_()