wxAutoExcel  2.0.0
wxAutoExcel::wxExcelWorksheets Class Reference

Represents Microsoft Excel Worksheets collection. More...

Inheritance diagram for wxAutoExcel::wxExcelWorksheets:
wxAutoExcel::wxExcelObject

Public Member Functions

wxExcelWorksheet Add (long count=1, const wxString &templateFile=wxEmptyString)
 Creates a new worksheet. More...
 
void FillAcrossSheets (wxExcelRange range, XlFillWith *type)
 Copies a range to the same area on all other worksheets in a collection. More...
 
void Select (wxXlTribool replace=wxDefaultXlTribool)
 Selects the object. More...
 
long GetCount ()
 Returns a Long value that represents the number of objects in the collection. More...
 
wxExcelPageBreaks GetHPageBreaks ()
 Returns a PageBreaks collection that represents the horizontal page breaks on the sheet. More...
 
wxExcelWorksheet GetItem (long index)
 Returns a single object from a collection. More...
 
bool GetVisible ()
 Returns a Variant value that determines whether the object is visible. More...
 
wxExcelPageBreaks GetVPageBreaks ()
 Returns a PageBreaks collection that represents the vertical page breaks on the sheet. More...
 
virtual wxString GetAutoExcelObjectName_ () const
 Returns "Worksheets". 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 Worksheets collection.

Member Function Documentation

◆ Add()

wxExcelWorksheet wxAutoExcel::wxExcelWorksheets::Add ( long  count = 1,
const wxString &  templateFile = wxEmptyString 
)

Creates a new worksheet.

The new worksheet becomes the active sheet.

MSDN documentation for Worksheets.Add.

◆ FillAcrossSheets()

void wxAutoExcel::wxExcelWorksheets::FillAcrossSheets ( wxExcelRange  range,
XlFillWith type 
)

Copies a range to the same area on all other worksheets in a collection.

MSDN documentation for Worksheets.FillAcrossSheets.

◆ Select()

void wxAutoExcel::wxExcelWorksheets::Select ( wxXlTribool  replace = wxDefaultXlTribool)

◆ GetCount()

long wxAutoExcel::wxExcelWorksheets::GetCount ( )

Returns a Long value that represents the number of objects in the collection.

MSDN documentation for Worksheets.Count.

◆ GetHPageBreaks()

wxExcelPageBreaks wxAutoExcel::wxExcelWorksheets::GetHPageBreaks ( )

Returns a PageBreaks collection that represents the horizontal page breaks on the sheet.

MSDN documentation for Worksheets.HPageBreaks.

◆ GetItem()

wxExcelWorksheet wxAutoExcel::wxExcelWorksheets::GetItem ( long  index)

Returns a single object from a collection.

MSDN documentation for Worksheets.Item.

◆ GetVisible()

bool wxAutoExcel::wxExcelWorksheets::GetVisible ( )

Returns a Variant value that determines whether the object is visible.

MSDN documentation for Worksheets.Visible.

◆ GetVPageBreaks()

wxExcelPageBreaks wxAutoExcel::wxExcelWorksheets::GetVPageBreaks ( )

Returns a PageBreaks collection that represents the vertical page breaks on the sheet.

MSDN documentation for Worksheets.VPageBreaks.

◆ GetAutoExcelObjectName_()

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

Returns "Worksheets".

Reimplemented from wxAutoExcel::wxExcelObject.