Represents Microsoft Excel ShapeNodes collection. More...

#include <wxAutoExcelShapeNodes.h>

Inheritance diagram for wxAutoExcel::wxExcelShapeNodes:

Public Types
typedef wxExcelCollectionIterator< wxExcelShapeNodes, wxExcelShapeNode >	iterator
	The iterator over the items, see wxExcelCollectionIterator.
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...

Public Member Functions
void	Delete (long index)
	Deletes the object.
void	Insert (long index, MsoSegmentType segmentType, MsoEditingType editingType, double X1, double Y1, double X2=NULL, double Y2=NULL, double X3=NULL, double Y3=NULL)
	Inserts a node into a freeform shape.
wxExcelShapeNode	Item (long index)
	Returns a single object from a collection.
void	SetEditingType (long index, MsoEditingType editingType)
	Sets the editing type of the node specified by Index.
void	SetPosition (long index, double X1, double Y1)
	Sets the location of the node specified by Index.
void	SetSegmentType (long index, MsoSegmentType segmentType)
	Sets the segment type of the segment that follows the node specified by Index.
long	GetCount ()
	Returns an Integer value that represents the number of objects in the collection.
iterator	begin ()
	Returns the iterator referring to the first item, or past the last item, which allows iterating over the items with a range-based for loop, see wxExcelCollectionIterator.
virtual wxString	GetAutoExcelObjectName_ () const
	Returns "ShapeNodes".
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
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 ShapeNodes collection.

Member Typedef Documentation

◆ iterator

typedef wxExcelCollectionIterator<wxExcelShapeNodes, wxExcelShapeNode> wxAutoExcel::wxExcelShapeNodes::iterator

The iterator over the items, see wxExcelCollectionIterator.

Member Function Documentation

◆ Delete()

void wxAutoExcel::wxExcelShapeNodes::Delete ( long index )

Deletes the object.

MSDN documentation for ShapeNodes.Delete.

◆ Insert()

void wxAutoExcel::wxExcelShapeNodes::Insert	(	long	index,
		MsoSegmentType	segmentType,
		MsoEditingType	editingType,
		double	X1,
		double	Y1,
		double *	X2 = NULL,
		double *	Y2 = NULL,
		double *	X3 = NULL,
		double *	Y3 = NULL )

Inserts a node into a freeform shape.

MSDN documentation for ShapeNodes.Insert.

◆ Item()

wxExcelShapeNode wxAutoExcel::wxExcelShapeNodes::Item ( long index )

Returns a single object from a collection.

MSDN documentation for ShapeNodes.Item.

◆ SetEditingType()

void wxAutoExcel::wxExcelShapeNodes::SetEditingType	(	long	index,
		MsoEditingType	editingType )

Sets the editing type of the node specified by Index.

If the node is a control point for a curved segment, this method sets the editing type of the node adjacent to it that joins two segments. Note that, depending on the editing type, this method may affect the position of adjacent nodes.

MSDN documentation for ShapeNodes.SetEditingType.

◆ SetPosition()

void wxAutoExcel::wxExcelShapeNodes::SetPosition	(	long	index,
		double	X1,
		double	Y1 )

Sets the location of the node specified by Index.

Note that, depending on the editing type of the node, this method may affect the position of adjacent nodes.

MSDN documentation for ShapeNodes.SetPosition.

◆ SetSegmentType()

void wxAutoExcel::wxExcelShapeNodes::SetSegmentType	(	long	index,
		MsoSegmentType	segmentType )

Sets the segment type of the segment that follows the node specified by Index.

If the node is a control point for a curved segment, this method sets the segment type for that curve. Note that this may affect the total number of nodes by inserting or deleting adjacent nodes.

MSDN documentation for ShapeNodes.SetSegmentType.

◆ GetCount()

long wxAutoExcel::wxExcelShapeNodes::GetCount ( )

Returns an Integer value that represents the number of objects in the collection.

MSDN documentation for ShapeNodes.Count.

◆ begin()

iterator wxAutoExcel::wxExcelShapeNodes::begin ( )

inline

Returns the iterator referring to the first item, or past the last item, which allows iterating over the items with a range-based for loop, see wxExcelCollectionIterator.

◆ GetAutoExcelObjectName_()

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

inlinevirtual

Returns "ShapeNodes".

Reimplemented from wxAutoExcel::wxExcelObject.

Public Types

Public Member Functions

Additional Inherited Members