wxAutoExcel  2.0.0
wxAutoExcel::wxExcelFloor Class Reference

Represents Microsoft Excel Floor object. More...

Inheritance diagram for wxAutoExcel::wxExcelFloor:
wxAutoExcel::wxExcelObject

Public Member Functions

bool ClearFormats ()
 Clears the formatting of the object. More...
 
bool Paste ()
 Pastes a picture from the Clipboard on the floor of the specified chart. More...
 
bool Select ()
 Selects the object. More...
 
wxExcelChartFormat GetFormat ()
 Returns the ChartFormat object. More...
 
wxString GetName ()
 Returns a String value that represents the name of the object. More...
 
long GetPictureType ()
 Returns a Variant value that represents the way pictures are displayed on the walls and faces of a 3-D chart. More...
 
void SetPictureType (long pictureType)
 Sets a Variant value that represents the way pictures are displayed on the walls and faces of a 3-D chart. More...
 
long GetThickness ()
 Returns a Long specifying the thickness of the wall. More...
 
void SetThickness (long thickness)
 Sets a Long specifying the thickness of the wall. More...
 
virtual wxString GetAutoExcelObjectName_ () const
 Returns "Floor". 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 Floor object.

Member Function Documentation

◆ ClearFormats()

bool wxAutoExcel::wxExcelFloor::ClearFormats ( )

Clears the formatting of the object.

MSDN documentation for Floor.ClearFormats.

◆ Paste()

bool wxAutoExcel::wxExcelFloor::Paste ( )

Pastes a picture from the Clipboard on the floor of the specified chart.

MSDN documentation for Floor.Paste.

◆ Select()

bool wxAutoExcel::wxExcelFloor::Select ( )

◆ GetFormat()

wxExcelChartFormat wxAutoExcel::wxExcelFloor::GetFormat ( )

Returns the ChartFormat object.

Since Excel 2007.

MSDN documentation for Floor.Format.

◆ GetName()

wxString wxAutoExcel::wxExcelFloor::GetName ( )

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

MSDN documentation for Floor.Name.

◆ GetPictureType()

long wxAutoExcel::wxExcelFloor::GetPictureType ( )

Returns a Variant value that represents the way pictures are displayed on the walls and faces of a 3-D chart.

MSDN documentation for Floor.PictureType.

◆ SetPictureType()

void wxAutoExcel::wxExcelFloor::SetPictureType ( long  pictureType)

Sets a Variant value that represents the way pictures are displayed on the walls and faces of a 3-D chart.

MSDN documentation for Floor.PictureType.

◆ GetThickness()

long wxAutoExcel::wxExcelFloor::GetThickness ( )

Returns a Long specifying the thickness of the wall.

Since Excel 2007.

MSDN documentation for Floor.Thickness.

◆ SetThickness()

void wxAutoExcel::wxExcelFloor::SetThickness ( long  thickness)

Sets a Long specifying the thickness of the wall.

Since Excel 2007.

MSDN documentation for Floor.Thickness.

◆ GetAutoExcelObjectName_()

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

Returns "Floor".

Reimplemented from wxAutoExcel::wxExcelObject.