Represents Microsoft Excel Shape object. More...

Inheritance diagram for wxAutoExcel::wxExcelShape:

Public Member Functions
void	Apply ()
	Applies to the specified shape formatting that�s been copied by using the PickUp method. More...

void	Copy ()
	Copies the object to the Clipboard. More...

void	CopyPicture (XlPictureAppearance appearance=NULL, XlCopyPictureFormat format=NULL)
	Copies the selected object to the Clipboard as a picture. More...

void	Cut ()
	Cuts the object to the Clipboard. More...

void	Delete ()
	Deletes the object. More...

void	Duplicate ()
	Duplicates the object and returns a reference to the new copy. More...

void	Flip (MsoFlipCmd flipCmd)
	Flips the specified shape around its horizontal or vertical axis. More...

void	IncrementLeft (double increment)
	Moves the specified shape horizontally by the specified number of points. More...

void	IncrementRotation (double increment)
	Changes the rotation of the specified shape around the z-axis by the specified number of degrees. More...

void	IncrementTop (double increment)
	Moves the specified shape vertically by the specified number of points. More...

void	PickUp ()
	Copies the formatting of the specified shape. More...

void	RerouteConnections ()
	This method reroutes all connectors attached to the specified shape; if the specified shape is a connector, it�s rerouted. More...

void	ScaleHeight (double factor, MsoTriState relativeToOriginalSize, MsoScaleFrom *scale)
	Scales the height of the shape by a specified factor. More...

void	ScaleWidth (double factor, MsoTriState relativeToOriginalSize, MsoScaleFrom *scale)
	Scales the width of the shape by a specified factor. More...

void	Select (wxXlTribool replace=wxDefaultXlTribool)
	Selects the object. More...

void	SetShapesDefaultProperties ()
	Makes the formatting of the specified shape the default formatting for the shape. More...

wxExcelShapeRange	Ungroup ()
	Ungroups any grouped shapes in the specified shape or range of shapes. More...

void	ZOrder (MsoZOrderCmd ZOrderCmd)
	Moves the specified shape in front of or behind other shapes in the collection (that is, changes the shape's position in the z-order). More...

wxExcelAdjustments	GetAdjustments ()
	Returns an Adjustments object that contains adjustment values for all the adjustments in the specified shape. More...

wxString	GetAlternativeText ()
	Returns the descriptive (alternative) text string for a Shape object when the object is saved to a Web page. More...

void	SetAlternativeText (const wxString &alternativeText)
	Sets the descriptive (alternative) text string for a Shape object when the object is saved to a Web page. More...

MsoAutoShapeType	GetAutoShapeType ()
	Returns the shape type for the specified Shape or ShapeRange object, which must represent an AutoShape other than a line, freeform drawing, or connector. More...

void	SetAutoShapeType (MsoAutoShapeType autoShapeType)
	Sets the shape type for the specified Shape or ShapeRange object, which must represent an AutoShape other than a line, freeform drawing, or connector. More...

MsoBackgroundStyleIndex	GetBackgroundStyle ()
	Background style. More...

MsoBlackWhiteMode	GetBlackWhiteMode ()
	Returns a value that indicates how the specified shape appears when the presentation is viewed in black-and-white mode. More...

void	SetBlackWhiteMode (MsoBlackWhiteMode blackWhiteMode)
	Sets a value that indicates how the specified shape appears when the presentation is viewed in black-and-white mode. More...

wxExcelRange	GetBottomRightCell ()
	Returns a Range Represents the cell that lies under the lower-right corner of the object. More...

wxExcelCalloutFormat	GetCallout ()
	Returns a CalloutFormat object that contains callout formatting properties for the specified shape. More...

wxExcelChart	GetChart ()
	Read-only Since Excel 2007. More...

MsoTriState	GetChild ()
	Returns msoTrue if the specified shape is a child shape or if all shapes in a shape range are child shapes of the same parent. More...

long	GetConnectionSiteCount ()
	Returns the number of connection sites on the specified shape. More...

MsoTriState	GetConnector ()
	True if the specified shape is a connector. More...

wxExcelConnectorFormat	GetConnectorFormat ()
	Returns a ConnectorFormat object that contains connector formatting properties. More...

wxExcelControlFormat	GetControlFormat ()
	Returns a ControlFormat object that contains Microsoft Excel control properties. More...

wxExcelFillFormat	GetFill ()
	Returns a FillFormat object for a specified shape or a ChartFillFormat object for a specified chart that contains fill formatting properties for the shape or chart. More...

XlFormControl	GetFormControlType ()
	Returns the Microsoft Excel control type. More...

wxExcelGlowFormat	GetGlow ()
	GlowFormat Since Excel 2007. More...

MsoGraphicStyleIndex	GetGraphicStyle ()
	Returns an MsoGraphicStyleIndex constant that represents the style of an SVG graphic. More...

void	SetGraphicStyle (MsoGraphicStyleIndex graphicStyle)
	Sets an MsoGraphicStyleIndex constant that represents the style of an SVG graphic. More...

wxExcelGroupShapes	GetGroupItems ()
	Returns a GroupShapes Represents the individual shapes in the specified group. More...

MsoTriState	GetHasChart ()
	Returns if shape contains a chart. More...

double	GetHeight ()
	Returns a Single value that represents the height, in points, of the object. More...

MsoTriState	GetHorizontalFlip ()
	True if the specified shape is flipped around the horizontal axis. More...

wxExcelHyperlink	GetHyperlink ()
	Returns a Hyperlink Represents the hyperlink for the shape. More...

long	GetID ()
	Returns a Long value that represents the type for the specified object. More...

double	GetLeft ()
	Returns a Single value that represents the distance, in points, from the left edge of the object to the left edge of column A (on a worksheet) or the left edge of the chart area (on a chart). More...

wxExcelLineFormat	GetLine ()
	Returns a LineFormat object that contains line formatting properties for the specified shape. More...

wxExcelLinkFormat	GetLinkFormat ()
	Returns a LinkFormat object that contains linked OLE object properties. More...

MsoTriState	GetLockAspectRatio ()
	True if the specified shape retains its original proportions when you resize it. More...

void	SetLockAspectRatio (MsoTriState lockAspectRatio)
	True if the specified shape retains its original proportions when you resize it. More...

bool	GetLocked ()
	Returns a Boolean value that indicates if the object is locked. More...

void	SetLocked (bool locked)
	Sets a Boolean value that indicates if the object is locked. More...

wxExcelModel3DFormat	GetModel3D ()
	Returns a Model3DFormat object that contains Model3D properties. More...

wxString	GetName ()
	Returns a String value representing the name of the object. More...

wxExcelShapeNodes	GetNodes ()
	Returns a ShapeNodes collection that represents the geometric description of the specified shape. More...

wxExcelOLEFormat	GetOLEFormat ()
	Returns an OLEFormat object that contains OLE object properties. More...

wxString	GetOnAction ()
	Returns the name of a macro that�s run when the specified object is clicked. More...

void	SetOnAction (const wxString &onAction)
	Sets the name of a macro that�s run when the specified object is clicked. More...

wxExcelShape	GetParentGroup ()
	Returns a Shape Represents the common parent shape of a child shape or a range of child shapes. More...

wxExcelPictureFormat	GetPictureFormat ()
	Returns a PictureFormat object that contains picture formatting properties for the specified shape. More...

XlPlacement	GetPlacement ()
	Returns an XlPlacement value that represents the way the object is attached to the cells below it. More...

void	SetPlacement (XlPlacement placement)
	Sets an XlPlacement value that represents the way the object is attached to the cells below it. More...

wxExcelReflectionFormat	GetReflection ()
	ReflectionFormat Since Excel 2007. More...

double	GetRotation ()
	Returns the rotation of the shape, in degrees. More...

void	SetRotation (double rotation)
	Sets the rotation of the shape, in degrees. More...

wxExcelShadowFormat	GetShadow ()
	Returns a read-only ShadowFormat object that contains shadow formatting properties for the specified shape or shapes. More...

MsoShapeStyleIndex	GetShapeStyle ()
	The style of the shape. More...

void	SetShapeStyle (MsoShapeStyleIndex shapeStyle)
	The style of the shape. More...

wxExcelSoftEdgeFormat	GetSoftEdge ()
	SoftEdgeFormat Since Excel 2007. More...

wxExcelTextEffectFormat	GetTextEffect ()
	Returns a TextEffectFormat object that contains text-effect formatting properties for the specified shape. More...

wxExcelTextFrame	GetTextFrame ()
	Returns a TextFrame object that contains the alignment and anchoring properties for the specified shape. More...

wxExcelTextFrame2	GetTextFrame2 ()
	TextFrame2 Since Excel 2007. More...

wxExcelThreeDFormat	GetThreeD ()
	Returns a ThreeDFormat object that contains 3-D � effect formatting properties for the specified shape. More...

double	GetTop ()
	Returns a Single value that represents the distance, in points, from the top edge of the topmost shape in the shape range to the top edge of the worksheet. More...

void	SetTop (double top)
	Sets a Single value that represents the distance, in points, from the top edge of the topmost shape in the shape range to the top edge of the worksheet. More...

wxExcelRange	GetTopLeftCell ()
	Returns a Range Represents the cell that lies under the upper-left corner of the specified object. More...

MsoShapeType	GetType ()
	Returns a MsoShapeType value that represents the shape type. More...

MsoTriState	GetVerticalFlip ()
	True if the specified shape is flipped around the vertical axis. More...

wxVector< wxPoint2DDouble >	GetVertices ()
	Returns the coordinates of the specified freeform drawing's vertices (and control points for B�zier curves) as a series of coordinate pairs. More...

MsoTriState	GetVisible ()
	Returns a MsoTriState value that determines whether the object is visible. More...

void	SetVisible (MsoTriState visible)
	Sets a MsoTriState value that determines whether the object is visible. More...

double	GetWidth ()
	Returns a Single value that represents the width, in points, of the object. More...

void	SetWidth (double width)
	Sets a Single value that represents the width, in points, of the object. More...

long	GetZOrderPosition ()
	Returns the position of the specified shape in the z-order.Read-only. More...

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

Member Function Documentation

◆ Apply()

void wxAutoExcel::wxExcelShape::Apply ( )

Applies to the specified shape formatting that�s been copied by using the PickUp method.

MSDN documentation for Shape.Apply.

◆ Copy()

void wxAutoExcel::wxExcelShape::Copy ( )

Copies the object to the Clipboard.

MSDN documentation for Shape.Copy.

◆ CopyPicture()

void wxAutoExcel::wxExcelShape::CopyPicture	(	XlPictureAppearance *	appearance = `NULL`,
		XlCopyPictureFormat *	format = `NULL`
	)

Copies the selected object to the Clipboard as a picture.

MSDN documentation for Shape.CopyPicture.

◆ Cut()

void wxAutoExcel::wxExcelShape::Cut ( )

Cuts the object to the Clipboard.

MSDN documentation for Shape.Cut.

◆ Delete()

void wxAutoExcel::wxExcelShape::Delete ( )

Deletes the object.

MSDN documentation for Shape.Delete.

◆ Duplicate()

void wxAutoExcel::wxExcelShape::Duplicate ( )

Duplicates the object and returns a reference to the new copy.

MSDN documentation for Shape.Duplicate.

◆ Flip()

void wxAutoExcel::wxExcelShape::Flip ( MsoFlipCmd flipCmd )

Flips the specified shape around its horizontal or vertical axis.

MSDN documentation for Shape.Flip.

◆ IncrementLeft()

void wxAutoExcel::wxExcelShape::IncrementLeft ( double increment )

Moves the specified shape horizontally by the specified number of points.

MSDN documentation for Shape.IncrementLeft.

◆ IncrementRotation()

void wxAutoExcel::wxExcelShape::IncrementRotation ( double increment )

Changes the rotation of the specified shape around the z-axis by the specified number of degrees.

Use the Rotation property to set the absolute rotation of the shape.

MSDN documentation for Shape.IncrementRotation.

◆ IncrementTop()

void wxAutoExcel::wxExcelShape::IncrementTop ( double increment )

Moves the specified shape vertically by the specified number of points.

MSDN documentation for Shape.IncrementTop.

◆ PickUp()

void wxAutoExcel::wxExcelShape::PickUp ( )

Copies the formatting of the specified shape.

Use the Apply method to apply the copied formatting to another shape.

MSDN documentation for Shape.PickUp.

◆ RerouteConnections()

void wxAutoExcel::wxExcelShape::RerouteConnections ( )

This method reroutes all connectors attached to the specified shape; if the specified shape is a connector, it�s rerouted.

MSDN documentation for Shape.RerouteConnections.

◆ ScaleHeight()

void wxAutoExcel::wxExcelShape::ScaleHeight	(	double	factor,
		MsoTriState	relativeToOriginalSize,
		MsoScaleFrom *	scale
	)

Scales the height of the shape by a specified factor.

For pictures and OLE objects, you can indicate whether you want to scale the shape relative to the original or the current size. Shapes other than pictures and OLE objects are always scaled relative to their current height.

MSDN documentation for Shape.ScaleHeight.

◆ ScaleWidth()

void wxAutoExcel::wxExcelShape::ScaleWidth	(	double	factor,
		MsoTriState	relativeToOriginalSize,
		MsoScaleFrom *	scale
	)

Scales the width of the shape by a specified factor.

For pictures and OLE objects, you can indicate whether you want to scale the shape relative to the original or the current size. Shapes other than pictures and OLE objects are always scaled relative to their current width.

MSDN documentation for Shape.ScaleWidth.

◆ Select()

void wxAutoExcel::wxExcelShape::Select ( wxXlTribool replace = wxDefaultXlTribool )

Selects the object.

MSDN documentation for Shape.Select.

◆ SetShapesDefaultProperties()

void wxAutoExcel::wxExcelShape::SetShapesDefaultProperties ( )

Makes the formatting of the specified shape the default formatting for the shape.

MSDN documentation for Shape.SetShapesDefaultProperties.

◆ Ungroup()

wxExcelShapeRange wxAutoExcel::wxExcelShape::Ungroup ( )

Ungroups any grouped shapes in the specified shape or range of shapes.

Disassembles pictures and OLE objects within the specified shape or range of shapes.

MSDN documentation for Shape.Ungroup.

◆ ZOrder()

void wxAutoExcel::wxExcelShape::ZOrder ( MsoZOrderCmd ZOrderCmd )

Moves the specified shape in front of or behind other shapes in the collection (that is, changes the shape's position in the z-order).

MSDN documentation for Shape.ZOrder.

◆ GetAdjustments()

wxExcelAdjustments wxAutoExcel::wxExcelShape::GetAdjustments ( )

Returns an Adjustments object that contains adjustment values for all the adjustments in the specified shape.

Applies to any Shape Represents an AutoShape, WordArt, or a connector.

MSDN documentation for Shape.Adjustments.

◆ GetAlternativeText()

wxString wxAutoExcel::wxExcelShape::GetAlternativeText ( )

Returns the descriptive (alternative) text string for a Shape object when the object is saved to a Web page.

MSDN documentation for Shape.AlternativeText.

◆ SetAlternativeText()

void wxAutoExcel::wxExcelShape::SetAlternativeText ( const wxString & alternativeText )

Sets the descriptive (alternative) text string for a Shape object when the object is saved to a Web page.

MSDN documentation for Shape.AlternativeText.

◆ GetAutoShapeType()

MsoAutoShapeType wxAutoExcel::wxExcelShape::GetAutoShapeType ( )

Returns the shape type for the specified Shape or ShapeRange object, which must represent an AutoShape other than a line, freeform drawing, or connector.

Read/write MsoAutoShapeType.

MSDN documentation for Shape.AutoShapeType.

◆ SetAutoShapeType()

void wxAutoExcel::wxExcelShape::SetAutoShapeType ( MsoAutoShapeType autoShapeType )

Sets the shape type for the specified Shape or ShapeRange object, which must represent an AutoShape other than a line, freeform drawing, or connector.

Read/write MsoAutoShapeType.

MSDN documentation for Shape.AutoShapeType.

◆ GetBackgroundStyle()

MsoBackgroundStyleIndex wxAutoExcel::wxExcelShape::GetBackgroundStyle ( )

Background style.

Since Excel 2007.

MSDN documentation for Shape.BackgroundStyle.

◆ GetBlackWhiteMode()

MsoBlackWhiteMode wxAutoExcel::wxExcelShape::GetBlackWhiteMode ( )

Returns a value that indicates how the specified shape appears when the presentation is viewed in black-and-white mode.

Read/write MsoBlackWhiteMode.

MSDN documentation for Shape.BlackWhiteMode.

◆ SetBlackWhiteMode()

void wxAutoExcel::wxExcelShape::SetBlackWhiteMode ( MsoBlackWhiteMode blackWhiteMode )

Sets a value that indicates how the specified shape appears when the presentation is viewed in black-and-white mode.

Read/write MsoBlackWhiteMode.

MSDN documentation for Shape.BlackWhiteMode.

◆ GetBottomRightCell()

wxExcelRange wxAutoExcel::wxExcelShape::GetBottomRightCell ( )

Returns a Range Represents the cell that lies under the lower-right corner of the object.

MSDN documentation for Shape.BottomRightCell.

◆ GetCallout()

wxExcelCalloutFormat wxAutoExcel::wxExcelShape::GetCallout ( )

Returns a CalloutFormat object that contains callout formatting properties for the specified shape.

Applies to a Shape object that represent line callouts.

MSDN documentation for Shape.Callout.

◆ GetChart()

wxExcelChart wxAutoExcel::wxExcelShape::GetChart ( )

Read-only Since Excel 2007.

MSDN documentation for Shape.Chart.

◆ GetChild()

MsoTriState wxAutoExcel::wxExcelShape::GetChild ( )

Returns msoTrue if the specified shape is a child shape or if all shapes in a shape range are child shapes of the same parent.

Read-only MsoTriState.

MSDN documentation for Shape.Child.

◆ GetConnectionSiteCount()

long wxAutoExcel::wxExcelShape::GetConnectionSiteCount ( )

Returns the number of connection sites on the specified shape.

MSDN documentation for Shape.ConnectionSiteCount.

◆ GetConnector()

MsoTriState wxAutoExcel::wxExcelShape::GetConnector ( )

True if the specified shape is a connector.

Read-only MsoTriState.

MSDN documentation for Shape.Connector.

◆ GetConnectorFormat()

wxExcelConnectorFormat wxAutoExcel::wxExcelShape::GetConnectorFormat ( )

Returns a ConnectorFormat object that contains connector formatting properties.

Applies to a Shape that represent connectors.

MSDN documentation for Shape.ConnectorFormat.

◆ GetControlFormat()

wxExcelControlFormat wxAutoExcel::wxExcelShape::GetControlFormat ( )

Returns a ControlFormat object that contains Microsoft Excel control properties.

MSDN documentation for Shape.ControlFormat.

◆ GetFill()

wxExcelFillFormat wxAutoExcel::wxExcelShape::GetFill ( )

Returns a FillFormat object for a specified shape or a ChartFillFormat object for a specified chart that contains fill formatting properties for the shape or chart.

MSDN documentation for Shape.Fill.

◆ GetFormControlType()

XlFormControl wxAutoExcel::wxExcelShape::GetFormControlType ( )

Returns the Microsoft Excel control type.

Read-only XlFormControl.

MSDN documentation for Shape.FormControlType.

◆ GetGlow()

wxExcelGlowFormat wxAutoExcel::wxExcelShape::GetGlow ( )

GlowFormat Since Excel 2007.

MSDN documentation for Shape.Glow.

◆ GetGraphicStyle()

MsoGraphicStyleIndex wxAutoExcel::wxExcelShape::GetGraphicStyle ( )

Returns an MsoGraphicStyleIndex constant that represents the style of an SVG graphic.

Excel VBA documentation for Shape.GraphicStyle

◆ SetGraphicStyle()

void wxAutoExcel::wxExcelShape::SetGraphicStyle ( MsoGraphicStyleIndex graphicStyle )

Sets an MsoGraphicStyleIndex constant that represents the style of an SVG graphic.

Excel VBA documentation for Shape.GraphicStyle

◆ GetGroupItems()

wxExcelGroupShapes wxAutoExcel::wxExcelShape::GetGroupItems ( )

Returns a GroupShapes Represents the individual shapes in the specified group.

Use the Item method of the GroupShapes object to return a single shape from the group. Applies to Shape objects that represent grouped shapes.

MSDN documentation for Shape.GroupItems.

◆ GetHasChart()

MsoTriState wxAutoExcel::wxExcelShape::GetHasChart ( )

Returns if shape contains a chart.

Since Excel 2007.

MSDN documentation for Shape.HasChart.

◆ GetHeight()

double wxAutoExcel::wxExcelShape::GetHeight ( )

Returns a Single value that represents the height, in points, of the object.

MSDN documentation for Shape.Height.

◆ GetHorizontalFlip()

MsoTriState wxAutoExcel::wxExcelShape::GetHorizontalFlip ( )

True if the specified shape is flipped around the horizontal axis.

Read-only MsoTriState.

MSDN documentation for Shape.HorizontalFlip.

◆ GetHyperlink()

wxExcelHyperlink wxAutoExcel::wxExcelShape::GetHyperlink ( )

Returns a Hyperlink Represents the hyperlink for the shape.

MSDN documentation for Shape.Hyperlink.

◆ GetID()

long wxAutoExcel::wxExcelShape::GetID ( )

Returns a Long value that represents the type for the specified object.

MSDN documentation for Shape.ID.

◆ GetLeft()

double wxAutoExcel::wxExcelShape::GetLeft ( )

Returns a Single value that represents the distance, in points, from the left edge of the object to the left edge of column A (on a worksheet) or the left edge of the chart area (on a chart).

MSDN documentation for Shape.Left.

◆ GetLine()

wxExcelLineFormat wxAutoExcel::wxExcelShape::GetLine ( )

Returns a LineFormat object that contains line formatting properties for the specified shape.

(For a line, the LineFormat object represents the line itself; for a shape with a border, the LineFormat object represents the border).

MSDN documentation for Shape.Line.

◆ GetLinkFormat()

wxExcelLinkFormat wxAutoExcel::wxExcelShape::GetLinkFormat ( )

Returns a LinkFormat object that contains linked OLE object properties.

MSDN documentation for Shape.LinkFormat.

◆ GetLockAspectRatio()

MsoTriState wxAutoExcel::wxExcelShape::GetLockAspectRatio ( )

True if the specified shape retains its original proportions when you resize it.

False if you can change the height and width of the shape independently of one another when you resize it. Read/write MsoTriState.

MSDN documentation for Shape.LockAspectRatio.

◆ SetLockAspectRatio()

void wxAutoExcel::wxExcelShape::SetLockAspectRatio ( MsoTriState lockAspectRatio )

True if the specified shape retains its original proportions when you resize it.

False if you can change the height and width of the shape independently of one another when you resize it. Read/write MsoTriState.

MSDN documentation for Shape.LockAspectRatio.

◆ GetLocked()

bool wxAutoExcel::wxExcelShape::GetLocked ( )

Returns a Boolean value that indicates if the object is locked.

MSDN documentation for Shape.Locked.

◆ SetLocked()

void wxAutoExcel::wxExcelShape::SetLocked ( bool locked )

Sets a Boolean value that indicates if the object is locked.

MSDN documentation for Shape.Locked.

◆ GetModel3D()

wxExcelModel3DFormat wxAutoExcel::wxExcelShape::GetModel3D ( )

Returns a Model3DFormat object that contains Model3D properties.

Excel VBA documentation for Shape.Model3D

◆ GetName()

wxString wxAutoExcel::wxExcelShape::GetName ( )

Returns a String value representing the name of the object.

MSDN documentation for Shape.Name.

◆ GetNodes()

wxExcelShapeNodes wxAutoExcel::wxExcelShape::GetNodes ( )

Returns a ShapeNodes collection that represents the geometric description of the specified shape.

MSDN documentation for Shape.Nodes.

◆ GetOLEFormat()

wxExcelOLEFormat wxAutoExcel::wxExcelShape::GetOLEFormat ( )

Returns an OLEFormat object that contains OLE object properties.

MSDN documentation for Shape.OLEFormat.

◆ GetOnAction()

wxString wxAutoExcel::wxExcelShape::GetOnAction ( )

Returns the name of a macro that�s run when the specified object is clicked.

MSDN documentation for Shape.OnAction.

◆ SetOnAction()

void wxAutoExcel::wxExcelShape::SetOnAction ( const wxString & onAction )

Sets the name of a macro that�s run when the specified object is clicked.

MSDN documentation for Shape.OnAction.

◆ GetParentGroup()

wxExcelShape wxAutoExcel::wxExcelShape::GetParentGroup ( )

Returns a Shape Represents the common parent shape of a child shape or a range of child shapes.

MSDN documentation for Shape.ParentGroup.

◆ GetPictureFormat()

wxExcelPictureFormat wxAutoExcel::wxExcelShape::GetPictureFormat ( )

Returns a PictureFormat object that contains picture formatting properties for the specified shape.

Applies to a Shape object that represent pictures or OLE objects.

MSDN documentation for Shape.PictureFormat.

◆ GetPlacement()

XlPlacement wxAutoExcel::wxExcelShape::GetPlacement ( )

Returns an XlPlacement value that represents the way the object is attached to the cells below it.

MSDN documentation for Shape.Placement.

◆ SetPlacement()

void wxAutoExcel::wxExcelShape::SetPlacement ( XlPlacement placement )

Sets an XlPlacement value that represents the way the object is attached to the cells below it.

MSDN documentation for Shape.Placement.

◆ GetReflection()

wxExcelReflectionFormat wxAutoExcel::wxExcelShape::GetReflection ( )

ReflectionFormat Since Excel 2007.

MSDN documentation for Shape.Reflection.

◆ GetRotation()

double wxAutoExcel::wxExcelShape::GetRotation ( )

Returns the rotation of the shape, in degrees.

Read/write Single.

MSDN documentation for Shape.Rotation.

◆ SetRotation()

void wxAutoExcel::wxExcelShape::SetRotation ( double rotation )

Sets the rotation of the shape, in degrees.

Read/write Single.

MSDN documentation for Shape.Rotation.

◆ GetShadow()

wxExcelShadowFormat wxAutoExcel::wxExcelShape::GetShadow ( )

Returns a read-only ShadowFormat object that contains shadow formatting properties for the specified shape or shapes.

MSDN documentation for Shape.Shadow.

◆ GetShapeStyle()

MsoShapeStyleIndex wxAutoExcel::wxExcelShape::GetShapeStyle ( )

The style of the shape.

Since Excel 2007.

MSDN documentation for Shape.ShapeStyle.

◆ SetShapeStyle()

void wxAutoExcel::wxExcelShape::SetShapeStyle ( MsoShapeStyleIndex shapeStyle )

The style of the shape.

Since Excel 2007.

MSDN documentation for Shape.ShapeStyle.

◆ GetSoftEdge()

wxExcelSoftEdgeFormat wxAutoExcel::wxExcelShape::GetSoftEdge ( )

SoftEdgeFormat Since Excel 2007.

MSDN documentation for Shape.SoftEdge.

◆ GetTextEffect()

wxExcelTextEffectFormat wxAutoExcel::wxExcelShape::GetTextEffect ( )

Returns a TextEffectFormat object that contains text-effect formatting properties for the specified shape.

MSDN documentation for Shape.TextEffect.

◆ GetTextFrame()

wxExcelTextFrame wxAutoExcel::wxExcelShape::GetTextFrame ( )

Returns a TextFrame object that contains the alignment and anchoring properties for the specified shape.

MSDN documentation for Shape.TextFrame.

◆ GetTextFrame2()

wxExcelTextFrame2 wxAutoExcel::wxExcelShape::GetTextFrame2 ( )

TextFrame2 Since Excel 2007.

MSDN documentation for Shape.TextFrame2.

◆ GetThreeD()

wxExcelThreeDFormat wxAutoExcel::wxExcelShape::GetThreeD ( )

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

MSDN documentation for Shape.ThreeD.

◆ GetTop()

double wxAutoExcel::wxExcelShape::GetTop ( )

Returns a Single value that represents the distance, in points, from the top edge of the topmost shape in the shape range to the top edge of the worksheet.

MSDN documentation for Shape.Top.

◆ SetTop()

void wxAutoExcel::wxExcelShape::SetTop ( double top )

Sets a Single value that represents the distance, in points, from the top edge of the topmost shape in the shape range to the top edge of the worksheet.

MSDN documentation for Shape.Top.

◆ GetTopLeftCell()

wxExcelRange wxAutoExcel::wxExcelShape::GetTopLeftCell ( )

Returns a Range Represents the cell that lies under the upper-left corner of the specified object.

MSDN documentation for Shape.TopLeftCell.

◆ GetType()

MsoShapeType wxAutoExcel::wxExcelShape::GetType ( )

Returns a MsoShapeType value that represents the shape type.

MSDN documentation for Shape.Type.

◆ GetVerticalFlip()

MsoTriState wxAutoExcel::wxExcelShape::GetVerticalFlip ( )

True if the specified shape is flipped around the vertical axis.

Read-only MsoTriState.

MSDN documentation for Shape.VerticalFlip.

◆ GetVertices()

wxVector<wxPoint2DDouble> wxAutoExcel::wxExcelShape::GetVertices ( )

Returns the coordinates of the specified freeform drawing's vertices (and control points for B�zier curves) as a series of coordinate pairs.

You can use the array returned by this property as an argument to the AddCurve method or AddPolyLine method.

MSDN documentation for Shape.Vertices.

◆ GetVisible()

MsoTriState wxAutoExcel::wxExcelShape::GetVisible ( )

Returns a MsoTriState value that determines whether the object is visible.

MSDN documentation for Shape.Visible.

◆ SetVisible()

void wxAutoExcel::wxExcelShape::SetVisible ( MsoTriState visible )

Sets a MsoTriState value that determines whether the object is visible.

MSDN documentation for Shape.Visible.

◆ GetWidth()

double wxAutoExcel::wxExcelShape::GetWidth ( )

Returns a Single value that represents the width, in points, of the object.

MSDN documentation for Shape.Width.

◆ SetWidth()

void wxAutoExcel::wxExcelShape::SetWidth ( double width )

Sets a Single value that represents the width, in points, of the object.

MSDN documentation for Shape.Width.

◆ GetZOrderPosition()

long wxAutoExcel::wxExcelShape::GetZOrderPosition ( )

Returns the position of the specified shape in the z-order.Read-only.

MSDN documentation for Shape.ZOrderPosition.

◆ GetAutoExcelObjectName_()

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

inlinevirtual

Returns "Shape".

Reimplemented from wxAutoExcel::wxExcelObject.

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ Apply()

◆ Copy()

◆ CopyPicture()

◆ Cut()

◆ Delete()

◆ Duplicate()

◆ Flip()

◆ IncrementLeft()

◆ IncrementRotation()

◆ IncrementTop()

◆ PickUp()

◆ RerouteConnections()

◆ ScaleHeight()

◆ ScaleWidth()

◆ Select()

◆ SetShapesDefaultProperties()

◆ Ungroup()

◆ ZOrder()

◆ GetAdjustments()

◆ GetAlternativeText()

◆ SetAlternativeText()

◆ GetAutoShapeType()

◆ SetAutoShapeType()

◆ GetBackgroundStyle()

◆ GetBlackWhiteMode()

◆ SetBlackWhiteMode()

◆ GetBottomRightCell()

◆ GetCallout()

◆ GetChart()

◆ GetChild()

◆ GetConnectionSiteCount()

◆ GetConnector()

◆ GetConnectorFormat()

◆ GetControlFormat()

◆ GetFill()

◆ GetFormControlType()

◆ GetGlow()

◆ GetGraphicStyle()

◆ SetGraphicStyle()

◆ GetGroupItems()

◆ GetHasChart()

◆ GetHeight()

◆ GetHorizontalFlip()

◆ GetHyperlink()

◆ GetID()

◆ GetLeft()

◆ GetLine()

◆ GetLinkFormat()

◆ GetLockAspectRatio()

◆ SetLockAspectRatio()

◆ GetLocked()

◆ SetLocked()

◆ GetModel3D()

◆ GetName()

◆ GetNodes()

◆ GetOLEFormat()

◆ GetOnAction()

◆ SetOnAction()

◆ GetParentGroup()

◆ GetPictureFormat()

◆ GetPlacement()

◆ SetPlacement()

◆ GetReflection()

◆ GetRotation()

◆ SetRotation()

◆ GetShadow()

◆ GetShapeStyle()

◆ SetShapeStyle()

◆ GetSoftEdge()

◆ GetTextEffect()

◆ GetTextFrame()

◆ GetTextFrame2()

◆ GetThreeD()

◆ GetTop()

◆ SetTop()

◆ GetTopLeftCell()