wxAutoExcel  2.0.0
wxAutoExcel::wxExcelTabStops2 Class Reference

Represents Microsoft Excel TabStops2 collection. More...

Inheritance diagram for wxAutoExcel::wxExcelTabStops2:
wxAutoExcel::wxExcelObject

Public Member Functions

wxExcelTabStop2 Add (MsoTabStopType type, double position)
 Adds a new tab stop to the specified TabStops2 object. More...
 
wxExcelTabStop2 Item (long index)
 Gets an individual object from the TabStops2 collection. More...
 
long GetCount ()
 Gets a Long indicating the number of items in the TabStops2 collection. More...
 
double GetDefaultSpacing ()
 Gets or sets the default spacing between tab stops. More...
 
void SetDefaultSpacing (double defaultSpacing)
 Gets or sets the default spacing between tab stops. More...
 
virtual wxString GetAutoExcelObjectName_ () const
 Returns "TabStops2". 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 TabStops2 collection.

Member Function Documentation

◆ Add()

wxExcelTabStop2 wxAutoExcel::wxExcelTabStops2::Add ( MsoTabStopType  type,
double  position 
)

Adds a new tab stop to the specified TabStops2 object.

MSDN documentation for TabStops2.Add.

◆ Item()

wxExcelTabStop2 wxAutoExcel::wxExcelTabStops2::Item ( long  index)

Gets an individual object from the TabStops2 collection.

MSDN documentation for TabStops2.Item.

◆ GetCount()

long wxAutoExcel::wxExcelTabStops2::GetCount ( )

Gets a Long indicating the number of items in the TabStops2 collection.

MSDN documentation for TabStops2.Count.

◆ GetDefaultSpacing()

double wxAutoExcel::wxExcelTabStops2::GetDefaultSpacing ( )

Gets or sets the default spacing between tab stops.

MSDN documentation for TabStops2.DefaultSpacing.

◆ SetDefaultSpacing()

void wxAutoExcel::wxExcelTabStops2::SetDefaultSpacing ( double  defaultSpacing)

Gets or sets the default spacing between tab stops.

MSDN documentation for TabStops2.DefaultSpacing.

◆ GetAutoExcelObjectName_()

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

Returns "TabStops2".

Reimplemented from wxAutoExcel::wxExcelObject.