Represents Microsoft Excel Comment object. More...

#include <wxAutoExcelComments.h>

Inheritance diagram for wxAutoExcel::wxExcelComment:

Public Member Functions
void	Delete ()
	Deletes the object.

wxExcelComment	Next ()
	Returns the next comment.

wxExcelComment	Previous ()
	Returns the previous comment.

wxString	Text (const wxString &text=wxEmptyString, long *start=NULL, wxXlTribool overwrite=wxDefaultXlTribool)
	Sets comment text.

wxString	GetAuthor ()
	Returns the author of the comment.

void	SetAuthor (const wxString &author)
	Sets the author of the comment.

wxExcelShape	GetShape ()
	Returns a Shape associated with the comment.

bool	GetVisible ()
	True if the comment is visible.

void	SetVisible (bool visible)
	True if the comment is visible.

virtual wxString	GetAutoExcelObjectName_ () const
	Returns "Comment".

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.

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 Comment object.

Member Function Documentation

◆ Delete()

void wxAutoExcel::wxExcelComment::Delete ( )

Deletes the object.

MSDN documentation for Comment.Delete.

◆ Next()

wxExcelComment wxAutoExcel::wxExcelComment::Next ( )

Returns the next comment.

MSDN documentation for Comment.Next.

◆ Previous()

wxExcelComment wxAutoExcel::wxExcelComment::Previous ( )

Returns the previous comment.

MSDN documentation for Comment.Previous.

◆ Text()

wxString wxAutoExcel::wxExcelComment::Text	(	const wxString &	text = `wxEmptyString`,
		long *	start = `NULL`,
		wxXlTribool	overwrite = `wxDefaultXlTribool`
	)