wxAutoExcel  2.0.0
wxAutoExcel::wxExcelOLEFormat Class Reference

Represents Microsoft Excel OLEFormat object. More...

Inheritance diagram for wxAutoExcel::wxExcelOLEFormat:
wxAutoExcel::wxExcelObject

Public Member Functions

void Activate ()
 Makes the current chart the active chart. More...
 
void Verb (XlOLEVerb *verb=NULL)
 Sends a verb to the server of the specified OLE object. More...
 
wxString GetprogID ()
 Returns the programmatic identifiers for the object. More...
 
virtual wxString GetAutoExcelObjectName_ () const
 Returns "OLEFormat". 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 Microsoft Excel OLEFormat object.

Member Function Documentation

◆ Activate()

void wxAutoExcel::wxExcelOLEFormat::Activate ( )

Makes the current chart the active chart.

MSDN documentation for OLEFormat.Activate.

◆ Verb()

void wxAutoExcel::wxExcelOLEFormat::Verb ( XlOLEVerb verb = NULL)

Sends a verb to the server of the specified OLE object.

MSDN documentation for OLEFormat.Verb.

◆ GetprogID()

wxString wxAutoExcel::wxExcelOLEFormat::GetprogID ( )

Returns the programmatic identifiers for the object.

MSDN documentation for OLEFormat.progID.

◆ GetAutoExcelObjectName_()

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

Returns "OLEFormat".

Reimplemented from wxAutoExcel::wxExcelObject.