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

Represents a single add-in, either installed or not installed. More...

#include <wxAutoExcelAddIns.h>

Inheritance diagram for wxAutoExcel::wxExcelAddIn:
wxAutoExcel::wxExcelObject

Public Member Functions

wxString GetCLSID ()
 Returns a read-only unique identifier, or CLSID, identifying an object, as a String.
wxString GetFullName ()
 Returns the name of the object, including its path on disk, as a string.
bool GetInstalled ()
 True if the add-in is installed or to install the add-in, False if the add-in is uninstalled or to uninstall the add-in.
void SetInstalled (bool installed)
 True if the add-in is installed or to install the add-in, False if the add-in is uninstalled or to uninstall the add-in.
bool GetIsOpen ()
 Returns True if the add-in is currently open.
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 Add-in, excluding the final separator and name of the Add-in.
wxString GetprogID ()
 Returns the programmatic identifiers for the object.
virtual wxString GetAutoExcelObjectName_ () const
 Returns "AddIn".
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 single add-in, either installed or not installed.

Member Function Documentation

◆ GetCLSID()

wxString wxAutoExcel::wxExcelAddIn::GetCLSID ( )

Returns a read-only unique identifier, or CLSID, identifying an object, as a String.

MSDN documentation for AddIn.CLSID.aspx).

◆ GetFullName()

wxString wxAutoExcel::wxExcelAddIn::GetFullName ( )

Returns the name of the object, including its path on disk, as a string.

MSDN documentation for AddIn.FullName.aspx).

◆ GetInstalled()

bool wxAutoExcel::wxExcelAddIn::GetInstalled ( )

True if the add-in is installed or to install the add-in, False if the add-in is uninstalled or to uninstall the add-in.

MSDN documentation for AddIn.Installed.aspx).

◆ SetInstalled()

void wxAutoExcel::wxExcelAddIn::SetInstalled ( bool installed)

True if the add-in is installed or to install the add-in, False if the add-in is uninstalled or to uninstall the add-in.

MSDN documentation for AddIn.Installed.aspx).

◆ GetIsOpen()

bool wxAutoExcel::wxExcelAddIn::GetIsOpen ( )

Returns True if the add-in is currently open.

Since Excel 2007.

MSDN documentation for AddIn.IsOpen.aspx).

◆ GetName()

wxString wxAutoExcel::wxExcelAddIn::GetName ( )

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

MSDN documentation for AddIn.Name.aspx).

◆ GetPath()

wxString wxAutoExcel::wxExcelAddIn::GetPath ( )

Returns a String value that represents the complete path to the Add-in, excluding the final separator and name of the Add-in.

MSDN documentation for AddIn.Path.aspx).

◆ GetprogID()

wxString wxAutoExcel::wxExcelAddIn::GetprogID ( )

Returns the programmatic identifiers for the object.

MSDN documentation for AddIn.progID.aspx).

◆ GetAutoExcelObjectName_()

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

Returns "AddIn".

Reimplemented from wxAutoExcel::wxExcelObject.