Represents Microsoft Excel CalloutFormat object. More...

Inheritance diagram for wxAutoExcel::wxExcelCalloutFormat:

Public Member Functions
void	AutomaticLength ()
	Specifies that the first segment of the callout line (the segment attached to the text callout box) be scaled automatically when the callout is moved. More...

void	CustomDrop (double drop)
	Sets the vertical distance (in points) from the edge of the text bounding box to the place where the callout line attaches to the text box. More...

void	CustomLength (double length)
	Specifies that the first segment of the callout line (the segment attached to the text callout box) retain a fixed length whenever the callout is moved. More...

void	PresetDrop (MsoCalloutDropType dropType)
	Specifies whether the callout line attaches to the top, bottom, or center of the callout text box or whether it attaches at a point that�s a specified distance from the top or bottom of the text box. More...

MsoTriState	GetAccent ()
	Allows the user to place a vertical accent bar to separate the callout text from the callout line. More...

void	SetAccent (MsoTriState accent)
	Allows the user to place a vertical accent bar to separate the callout text from the callout line. More...

MsoCalloutAngleType	GetAngle ()
	Returns the angle of the callout line. More...

void	SetAngle (MsoCalloutAngleType angle)
	Sets the angle of the callout line. More...

MsoTriState	GetAutoAttach ()
	True if the place where the callout line attaches to the callout text box changes depending on whether the origin of the callout line (where the callout points to) is to the left or right of the callout text box. More...

void	SetAutoAttach (MsoTriState autoAttach)
	True if the place where the callout line attaches to the callout text box changes depending on whether the origin of the callout line (where the callout points to) is to the left or right of the callout text box. More...

MsoTriState	GetAutoLength ()
	Applies only to callouts whose lines consist of more than one segment (types msoCalloutThree and msoCalloutFour). More...

void	SetAutoLength (MsoTriState autoLength)
	Applies only to callouts whose lines consist of more than one segment (types msoCalloutThree and msoCalloutFour). More...

MsoTriState	GetBorder ()
	Returns a MsoTriState value that represents the visibility options for the border of the object. More...

void	SetBorder (MsoTriState border)
	Sets a MsoTriState value that represents the visibility options for the border of the object. More...

double	GetDrop ()
	For callouts with an explicitly set drop value, this property returns the vertical distance (in points) from the edge of the text bounding box to the place where the callout line attaches to the text box. More...

MsoCalloutDropType	GetDropType ()
	Returns a value that indicates where the callout line attaches to the callout text box. More...

double	GetGap ()
	Returns the horizontal distance (in points) between the end of the callout line and the text bounding box. More...

void	SetGap (double gap)
	Sets the horizontal distance (in points) between the end of the callout line and the text bounding box. More...

double	GetLength ()
	Returns a Single value that represents the length (in points) of the first segment of the callout line (the segment attached to the text callout box.) More...

MsoCalloutType	GetType ()
	Returns a MsoCalloutType value that represents the callout format type. More...

void	SetType (MsoCalloutType type)
	Sets a MsoCalloutType value that represents the callout format type. More...

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

Member Function Documentation

◆ AutomaticLength()

void wxAutoExcel::wxExcelCalloutFormat::AutomaticLength ( )

Specifies that the first segment of the callout line (the segment attached to the text callout box) be scaled automatically when the callout is moved.

Use the CustomLength method to specify that the first segment of the callout line retain the fixed length returned by the Length property whenever the callout is moved. Applies only to callouts whose lines consist of more than one segment (types msoCalloutThree and msoCalloutFour).

MSDN documentation for CalloutFormat.AutomaticLength.

◆ CustomDrop()

void wxAutoExcel::wxExcelCalloutFormat::CustomDrop ( double drop )

Sets the vertical distance (in points) from the edge of the text bounding box to the place where the callout line attaches to the text box.

This distance is measured from the top of the text box unless the AutoAttach property is set to True and the text box is to the left of the origin of the callout line (the place that the callout points to), in which case the drop distance is measured from the bottom of the text box.

MSDN documentation for CalloutFormat.CustomDrop.

◆ CustomLength()

void wxAutoExcel::wxExcelCalloutFormat::CustomLength ( double length )

Specifies that the first segment of the callout line (the segment attached to the text callout box) retain a fixed length whenever the callout is moved.

Use the AutomaticLength method to specify that the first segment of the callout line be scaled automatically whenever the callout is moved. Applies only to callouts whose lines consist of more than one segment (types msoCalloutThree and msoCalloutFour).

MSDN documentation for CalloutFormat.CustomLength.

◆ PresetDrop()

void wxAutoExcel::wxExcelCalloutFormat::PresetDrop ( MsoCalloutDropType dropType )

Specifies whether the callout line attaches to the top, bottom, or center of the callout text box or whether it attaches at a point that�s a specified distance from the top or bottom of the text box.

MSDN documentation for CalloutFormat.PresetDrop.

◆ GetAccent()

MsoTriState wxAutoExcel::wxExcelCalloutFormat::GetAccent ( )

Allows the user to place a vertical accent bar to separate the callout text from the callout line.

Read/write MsoTriState.

MSDN documentation for CalloutFormat.Accent.

◆ SetAccent()

void wxAutoExcel::wxExcelCalloutFormat::SetAccent ( MsoTriState accent )

Allows the user to place a vertical accent bar to separate the callout text from the callout line.

Read/write MsoTriState.

MSDN documentation for CalloutFormat.Accent.

◆ GetAngle()

MsoCalloutAngleType wxAutoExcel::wxExcelCalloutFormat::GetAngle ( )

Returns the angle of the callout line.

If the callout line contains more than one line segment, this property returns or sets the angle of the segment that is farthest from the callout text box. Read/write MsoCalloutAngleType.

MSDN documentation for CalloutFormat.Angle.

◆ SetAngle()

void wxAutoExcel::wxExcelCalloutFormat::SetAngle ( MsoCalloutAngleType angle )

Sets the angle of the callout line.

If the callout line contains more than one line segment, this property returns or sets the angle of the segment that is farthest from the callout text box. Read/write MsoCalloutAngleType.

MSDN documentation for CalloutFormat.Angle.

◆ GetAutoAttach()

MsoTriState wxAutoExcel::wxExcelCalloutFormat::GetAutoAttach ( )

True if the place where the callout line attaches to the callout text box changes depending on whether the origin of the callout line (where the callout points to) is to the left or right of the callout text box.

Read/write MsoTriState.

MSDN documentation for CalloutFormat.AutoAttach.

◆ SetAutoAttach()

void wxAutoExcel::wxExcelCalloutFormat::SetAutoAttach ( MsoTriState autoAttach )

True if the place where the callout line attaches to the callout text box changes depending on whether the origin of the callout line (where the callout points to) is to the left or right of the callout text box.

Read/write MsoTriState.

MSDN documentation for CalloutFormat.AutoAttach.

◆ GetAutoLength()

MsoTriState wxAutoExcel::wxExcelCalloutFormat::GetAutoLength ( )

Applies only to callouts whose lines consist of more than one segment (types msoCalloutThree and msoCalloutFour).

Read/write MsoTriState.

MSDN documentation for CalloutFormat.AutoLength.

◆ SetAutoLength()

void wxAutoExcel::wxExcelCalloutFormat::SetAutoLength ( MsoTriState autoLength )

Applies only to callouts whose lines consist of more than one segment (types msoCalloutThree and msoCalloutFour).

Read/write MsoTriState.

MSDN documentation for CalloutFormat.AutoLength.

◆ GetBorder()

MsoTriState wxAutoExcel::wxExcelCalloutFormat::GetBorder ( )

Returns a MsoTriState value that represents the visibility options for the border of the object.

MSDN documentation for CalloutFormat.Border.

◆ SetBorder()

void wxAutoExcel::wxExcelCalloutFormat::SetBorder ( MsoTriState border )

Sets a MsoTriState value that represents the visibility options for the border of the object.

MSDN documentation for CalloutFormat.Border.

◆ GetDrop()

double wxAutoExcel::wxExcelCalloutFormat::GetDrop ( )

For callouts with an explicitly set drop value, this property returns the vertical distance (in points) from the edge of the text bounding box to the place where the callout line attaches to the text box.

Read-only Single.

MSDN documentation for CalloutFormat.Drop.

◆ GetDropType()

MsoCalloutDropType wxAutoExcel::wxExcelCalloutFormat::GetDropType ( )

Returns a value that indicates where the callout line attaches to the callout text box.

Read-only MsoCalloutDropType.

MSDN documentation for CalloutFormat.DropType.

◆ GetGap()

double wxAutoExcel::wxExcelCalloutFormat::GetGap ( )

Returns the horizontal distance (in points) between the end of the callout line and the text bounding box.

Read/write Single.

MSDN documentation for CalloutFormat.Gap.

◆ SetGap()

void wxAutoExcel::wxExcelCalloutFormat::SetGap ( double gap )

Sets the horizontal distance (in points) between the end of the callout line and the text bounding box.

Read/write Single.

MSDN documentation for CalloutFormat.Gap.

◆ GetLength()

double wxAutoExcel::wxExcelCalloutFormat::GetLength ( )

Returns a Single value that represents the length (in points) of the first segment of the callout line (the segment attached to the text callout box.)

MSDN documentation for CalloutFormat.Length.

◆ GetType()

MsoCalloutType wxAutoExcel::wxExcelCalloutFormat::GetType ( )

Returns a MsoCalloutType value that represents the callout format type.

MSDN documentation for CalloutFormat.Type.

◆ SetType()

void wxAutoExcel::wxExcelCalloutFormat::SetType ( MsoCalloutType type )

Sets a MsoCalloutType value that represents the callout format type.

MSDN documentation for CalloutFormat.Type.

◆ GetAutoExcelObjectName_()

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

inlinevirtual

Returns "CalloutFormat".

Reimplemented from wxAutoExcel::wxExcelObject.

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ AutomaticLength()

◆ CustomDrop()

◆ CustomLength()

◆ PresetDrop()

◆ GetAccent()

◆ SetAccent()

◆ GetAngle()

◆ SetAngle()

◆ GetAutoAttach()

◆ SetAutoAttach()

◆ GetAutoLength()

◆ SetAutoLength()

◆ GetBorder()

◆ SetBorder()

◆ GetDrop()

◆ GetDropType()

◆ GetGap()

◆ SetGap()

◆ GetLength()

◆ GetType()

◆ SetType()

◆ GetAutoExcelObjectName_()