wxAutoExcel  2.0.0
wxAutoExcel::wxExcelPageBreak Class Reference

Represents Microsoft Excel HPageBreak or VPageBreak object. More...

Inheritance diagram for wxAutoExcel::wxExcelPageBreak:
wxAutoExcel::wxExcelObject

Public Member Functions

void Delete ()
 Deletes the object. More...
 
void DragOff (XlDirection direction, long regionIndex)
 Drags a page break out of the print area. More...
 
XlPageBreakExtent GetExtent ()
 Returns the type of the specified page break: full-screen or only within a print area. More...
 
wxExcelRange GetLocation ()
 Returns the cell (a Range object) that defines the page-break location. More...
 
void SetLocation (wxExcelRange location)
 Sets the cell (a Range object) that defines the page-break location. More...
 
XlPageBreak GetType ()
 Returns a XlPageBreak value that represents the page break type. More...
 
void SetType (XlPageBreak type)
 Sets a XlPageBreak value that represents the page break type. More...
 
virtual wxString GetAutoExcelObjectName_ () const
 Returns "PageBreak". 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 HPageBreak or VPageBreak object.

Member Function Documentation

◆ Delete()

void wxAutoExcel::wxExcelPageBreak::Delete ( )

◆ DragOff()

void wxAutoExcel::wxExcelPageBreak::DragOff ( XlDirection  direction,
long  regionIndex 
)

◆ GetExtent()

XlPageBreakExtent wxAutoExcel::wxExcelPageBreak::GetExtent ( )

Returns the type of the specified page break: full-screen or only within a print area.

Can be either of the following XlPageBreakExtent constants: xlPageBreakFull or xlPageBreakPartial.

MSDN documentation for HPageBreak.Extent. MSDN documentation for VPageBreak.Extent.

◆ GetLocation()

wxExcelRange wxAutoExcel::wxExcelPageBreak::GetLocation ( )

Returns the cell (a Range object) that defines the page-break location.

Horizontal page breaks are aligned with the top edge of the location cell; vertical page breaks are aligned with the left edge of the location cell.

MSDN documentation for HPageBreak.Location. MSDN documentation for VPageBreak.Location.

◆ SetLocation()

void wxAutoExcel::wxExcelPageBreak::SetLocation ( wxExcelRange  location)

Sets the cell (a Range object) that defines the page-break location.

Horizontal page breaks are aligned with the top edge of the location cell; vertical page breaks are aligned with the left edge of the location cell.

MSDN documentation for HPageBreak.Location. MSDN documentation for VPageBreak.Location.

◆ GetType()

XlPageBreak wxAutoExcel::wxExcelPageBreak::GetType ( )

Returns a XlPageBreak value that represents the page break type.

MSDN documentation for HPageBreak.Type. MSDN documentation for VPageBreak.Type.

◆ SetType()

void wxAutoExcel::wxExcelPageBreak::SetType ( XlPageBreak  type)

Sets a XlPageBreak value that represents the page break type.

MSDN documentation for HPageBreak.Type. MSDN documentation for VPageBreak.Type.

◆ GetAutoExcelObjectName_()

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

Returns "PageBreak".

Reimplemented from wxAutoExcel::wxExcelObject.