wxAutoExcel 2.5.1
Loading...
Searching...
No Matches
wxAutoExcel::wxExcelRecentFile Class Reference

Represents a Microsoft Excel RecentFile object. More...

#include <wxAutoExcelRecentFiles.h>

Inheritance diagram for wxAutoExcel::wxExcelRecentFile:
wxAutoExcel::wxExcelObject

Public Member Functions

void Delete ()
 Deletes the object.
wxExcelWorkbook Open ()
 Opens a recent workbook.
long GetIndex ()
 Returns a Long value that represents the index number of the object within the collection of similar objects.
wxString GetName ()
 Returns a String value that represents the name of the object.
wxString GetPath ()
 Returns a String value that represents the complete path to the workbook/file that this RecentFile object respresents.
virtual wxString GetAutoExcelObjectName_ () const
 Returns "RecentFile".
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.

Detailed Description

Represents a Microsoft Excel RecentFile object.

Member Function Documentation

◆ Delete()

void wxAutoExcel::wxExcelRecentFile::Delete ( )

◆ Open()

wxExcelWorkbook wxAutoExcel::wxExcelRecentFile::Open ( )

Opens a recent workbook.

MSDN documentation for RecentFile.Open.

◆ GetIndex()

long wxAutoExcel::wxExcelRecentFile::GetIndex ( )

Returns a Long value that represents the index number of the object within the collection of similar objects.

MSDN documentation for RecentFile.Index.

◆ GetName()

wxString wxAutoExcel::wxExcelRecentFile::GetName ( )

Returns a String value that represents the name of the object.

MSDN documentation for RecentFile.Name.

◆ GetPath()

wxString wxAutoExcel::wxExcelRecentFile::GetPath ( )

Returns a String value that represents the complete path to the workbook/file that this RecentFile object respresents.

MSDN documentation for RecentFile.Path.

◆ GetAutoExcelObjectName_()

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

Returns "RecentFile".

Reimplemented from wxAutoExcel::wxExcelObject.