wxAutoExcel  2.0.0
wxAutoExcel::wxExcelCommentThreaded Class Reference

Represents a cell's threaded comment. More...

Inheritance diagram for wxAutoExcel::wxExcelCommentThreaded:
wxAutoExcel::wxExcelObject

Public Member Functions

wxExcelCommentThreaded AddReply (const wxString &text=wxEmptyString)
 If the comment is a top-level comment, it will add a reply to its replies collection. More...
 
void Delete ()
 Deletes the specified threaded comment and all replies associated with that comment (if any exist). More...
 
wxExcelCommentThreaded Next ()
 Returns a CommentThreaded object that represents the next threaded comment. More...
 
wxExcelCommentThreaded Previous ()
 Returns a CommentThreaded object that represents the previous threaded comment. More...
 
wxString Text (const wxString &text=wxEmptyString, long *start=NULL, wxXlTribool overwrite=wxDefaultXlTribool)
 Sets threaded comment text. More...
 
wxExcelAuthor GetAuthor ()
 Returns the Author object that represents the author of the specified CommentThreaded object. More...
 
wxVariant GetDate ()
 Returns a date that represents the date and time that a threaded comment was added in local time. More...
 
wxExcelCommentsThreaded GetReplies ()
 If this comment is a parent, returns a CommentsThreaded collection of CommentThreaded objects that are children/replies of the specified comment (if any exist). More...
 
virtual wxString GetAutoExcelObjectName_ () const
 Returns "CommentThreaded". 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 a cell's threaded comment.

This object can represent both a top-level comment or its replies.

Member Function Documentation

◆ AddReply()

wxExcelCommentThreaded wxAutoExcel::wxExcelCommentThreaded::AddReply ( const wxString &  text = wxEmptyString)

If the comment is a top-level comment, it will add a reply to its replies collection.

If this comment is a reply, it will add a reply to its Parent's replies collection.

Excel VBA documentation for CommentThreaded.AddReply

◆ Delete()

void wxAutoExcel::wxExcelCommentThreaded::Delete ( )

Deletes the specified threaded comment and all replies associated with that comment (if any exist).

Excel VBA documentation for CommentThreaded.Delete

◆ Next()

wxExcelCommentThreaded wxAutoExcel::wxExcelCommentThreaded::Next ( )

Returns a CommentThreaded object that represents the next threaded comment.

Excel VBA documentation for CommentThreaded.Next

◆ Previous()

wxExcelCommentThreaded wxAutoExcel::wxExcelCommentThreaded::Previous ( )

Returns a CommentThreaded object that represents the previous threaded comment.

Excel VBA documentation for CommentThreaded.Previous

◆ Text()

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

◆ GetAuthor()

wxExcelAuthor wxAutoExcel::wxExcelCommentThreaded::GetAuthor ( )

Returns the Author object that represents the author of the specified CommentThreaded object.

Excel VBA documentation for CommentThreaded.Author

◆ GetDate()

wxVariant wxAutoExcel::wxExcelCommentThreaded::GetDate ( )

Returns a date that represents the date and time that a threaded comment was added in local time.

Excel VBA documentation for CommentThreaded.Date

◆ GetReplies()

wxExcelCommentsThreaded wxAutoExcel::wxExcelCommentThreaded::GetReplies ( )

If this comment is a parent, returns a CommentsThreaded collection of CommentThreaded objects that are children/replies of the specified comment (if any exist).

The replies are sorted by time stamp. If this comment is a child/reply or a legacy comment, returns an empty collection.

Excel VBA documentation for CommentThreaded.Replies

◆ GetAutoExcelObjectName_()

virtual wxString wxAutoExcel::wxExcelCommentThreaded::GetAutoExcelObjectName_ ( ) const
inlinevirtual

Returns "CommentThreaded".

Reimplemented from wxAutoExcel::wxExcelObject.