|
wxAutoExcel 2.5.1
|
|
wxAutoExcel 2.5.1
|
Represents a cell's threaded comment. More...
#include <wxAutoExcelCommentsThreaded.h>
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. | |
| void | Delete () |
| Deletes the specified threaded comment and all replies associated with that comment (if any exist). | |
| wxExcelCommentThreaded | Next () |
| Returns a CommentThreaded object that represents the next threaded comment. | |
| wxExcelCommentThreaded | Previous () |
| Returns a CommentThreaded object that represents the previous threaded comment. | |
| wxString | Text (const wxString &text=wxEmptyString, long *start=NULL, wxXlTribool overwrite=wxDefaultXlTribool) |
| Sets threaded comment text. | |
| wxExcelAuthor | GetAuthor () |
| Returns the Author object that represents the author of the specified CommentThreaded object. | |
| wxVariant | GetDate () |
| Returns a date that represents the date and time that a threaded comment was added in local time. | |
| 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). | |
| virtual wxString | GetAutoExcelObjectName_ () const |
| Returns "CommentThreaded". | |
| 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 | |
| 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. | |
Represents a cell's threaded comment.
This object can represent both a top-level comment or its replies.
| 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.
| void wxAutoExcel::wxExcelCommentThreaded::Delete | ( | ) |
Deletes the specified threaded comment and all replies associated with that comment (if any exist).
| wxExcelCommentThreaded wxAutoExcel::wxExcelCommentThreaded::Next | ( | ) |
Returns a CommentThreaded object that represents the next threaded comment.
| wxExcelCommentThreaded wxAutoExcel::wxExcelCommentThreaded::Previous | ( | ) |
Returns a CommentThreaded object that represents the previous threaded comment.
| wxString wxAutoExcel::wxExcelCommentThreaded::Text | ( | const wxString & | text = wxEmptyString, |
| long * | start = NULL, | ||
| wxXlTribool | overwrite = wxDefaultXlTribool ) |
Sets threaded comment text.
| wxExcelAuthor wxAutoExcel::wxExcelCommentThreaded::GetAuthor | ( | ) |
Returns the Author object that represents the author of the specified CommentThreaded object.
| wxVariant wxAutoExcel::wxExcelCommentThreaded::GetDate | ( | ) |
Returns a date that represents the date and time that a threaded comment was added in local time.
| 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.
|
inlinevirtual |
Returns "CommentThreaded".
Reimplemented from wxAutoExcel::wxExcelObject.
1.15.0