Represents Microsoft Excel PageSetup object. More...

#include <wxAutoExcelPageSetup.h>

Inheritance diagram for wxAutoExcel::wxExcelPageSetup:

Public Member Functions
bool	GetAlignMarginsHeaderFooter ()
	True if the header and the footer are aligned.

void	SetAlignMarginsHeaderFooter (bool alignMarginsHeaderFooter)
	True if the header and the footer are aligned.

bool	GetBlackAndWhite ()
	True if elements of the document will be printed in black and white.

void	SetBlackAndWhite (bool blackAndWhite)
	True if elements of the document will be printed in black and white.

double	GetBottomMargin ()
	Returns the size of the bottom margin, in points.

void	SetBottomMargin (double bottomMargin)
	Sets the size of the bottom margin, in points.

wxString	GetCenterFooter ()
	Returns the center footer.

void	SetCenterFooter (const wxString &centerFooter)
	Sets the center footer.

wxExcelGraphic	GetCenterFooterPicture ()
	Returns a Graphic Represents the picture for the center section of the footer.

wxString	GetCenterHeader ()
	Returns the center heaer.

void	SetCenterHeader (const wxString &centerHeader)
	Sets the center heaer.

wxExcelGraphic	GetCenterHeaderPicture ()
	Returns a Graphic Represents the picture for the center section of the header.

bool	GetCenterHorizontally ()
	True if the sheet is centered horizontally on the page when it's printed.

void	SetCenterHorizontally (bool centerHorizontally)
	True if the sheet is centered horizontally on the page when it's printed.

bool	GetCenterVertically ()
	True if the sheet is centered vertically on the page when it's printed.

void	SetCenterVertically (bool centerVertically)
	True if the sheet is centered vertically on the page when it's printed.

bool	GetDifferentFirstPageHeaderFooter ()
	True if a different header or footer is used on the first page.

void	SetDifferentFirstPageHeaderFooter (bool differentFirstPageHeaderFooter)
	True if a different header or footer is used on the first page.

bool	GetDraft ()
	True if the sheet will be printed without graphics.

void	SetDraft (bool draft)
	True if the sheet will be printed without graphics.

wxExcelPage	GetEvenPage ()
	Returns the page settings for the even pages.

wxExcelPage	GetFirstPage ()
	Returns the page settings for the first page.

long	GetFirstPageNumber ()
	Returns the first page number that will be used when this sheet is printed.

void	SetFirstPageNumber (long firstPageNumber)
	Sets the first page number that will be used when this sheet is printed.

long	GetFitToPagesTall ()
	Returns the number of pages tall the worksheet will be scaled to when it's printed.

void	SetFitToPagesTall (long fitToPagesTall)
	Sets the number of pages tall the worksheet will be scaled to when it's printed.

long	GetFitToPagesWide ()
	Returns the number of pages wide the worksheet will be scaled to when it's printed.

void	SetFitToPagesWide (long fitToPagesWide)
	Sets the number of pages wide the worksheet will be scaled to when it's printed.

double	GetFooterMargin ()
	Returns the distance from the bottom of the page to the footer, in points.

void	SetFooterMargin (double footerMargin)
	Sets the distance from the bottom of the page to the footer, in points.

double	GetHeaderMargin ()
	Returns the distance from the top of the page to the header, in points.

void	SetHeaderMargin (double headerMargin)
	Sets the distance from the top of the page to the header, in points.

wxString	GetLeftFooter ()
	Returns the left footer.

void	SetLeftFooter (const wxString &leftFooter)
	Sets the left footer.

wxExcelGraphic	GetLeftFooterPicture ()
	Returns a Graphic Represents the picture for the left section of the footer.

wxString	GetLeftHeader ()
	Returns the left header.

void	SetLeftHeader (const wxString &leftHeader)
	Sets the left header.

wxExcelGraphic	GetLeftHeaderPicture ()
	Returns a Graphic Represents the picture for the left section of the header.

double	GetLeftMargin ()
	Returns the size of the left margin, in points.

void	SetLeftMargin (double leftMargin)
	Sets the size of the left margin, in points.

bool	GetOddAndEvenPagesHeaderFooter ()
	True if different headers and footers for odd-numbered and even-numbered pages.

void	SetOddAndEvenPagesHeaderFooter (bool oddAndEvenPagesHeaderFooter)
	True if different headers and footers for odd-numbered and even-numbered pages.

XlOrder	GetOrder ()
	Returns a XlOrder value that represents the order that Microsoft Excel uses to number pages when printing a large worksheet.

void	SetOrder (XlOrder order)
	Sets a XlOrder value that represents the order that Microsoft Excel uses to number pages when printing a large worksheet.

XlPageOrientation	GetOrientation ()
	Returns a XlPageOrientation value that represents the portrait or landscape printing mode.

void	SetOrientation (XlPageOrientation orientation)
	Sets a XlPageOrientation value that represents the portrait or landscape printing mode.

wxExcelPages	GetPages ()
	Returns Pages collection.

XlPaperSize	GetPaperSize ()
	Returns the size of the paper.

void	SetPaperSize (XlPaperSize paperSize)
	Sets the size of the paper.

wxString	GetPrintArea ()
	Returns the range to be printed, as a string using A1-style references in the language of the macro.

void	SetPrintArea (const wxString &printArea)
	Sets the range to be printed, as a string using A1-style references in the language of the macro.

XlPrintLocation	GetPrintComments ()
	Returns the way comments are printed with the sheet.

void	SetPrintComments (XlPrintLocation printComments)
	Sets the way comments are printed with the sheet.

XlPrintErrors	GetPrintErrors ()
	Returns an XlPrintErrors contstant specifying the type of print error displayed.

void	SetPrintErrors (XlPrintErrors printErrors)
	Sets an XlPrintErrors contstant specifying the type of print error displayed.

bool	GetPrintGridlines ()
	True if cell gridlines are printed on the page.

void	SetPrintGridlines (bool printGridlines)
	True if cell gridlines are printed on the page.

bool	GetPrintHeadings ()
	True if row and column headings are printed with this page.

void	SetPrintHeadings (bool printHeadings)
	True if row and column headings are printed with this page.

bool	GetPrintNotes ()
	True if cell notes are printed as end notes with the sheet.

void	SetPrintNotes (bool printNotes)
	True if cell notes are printed as end notes with the sheet.

long	GetPrintQuality (int index)
	Returns the print quality.

void	SetPrintQuality (int index, long quality)
	Sets the print quality.

wxString	GetPrintTitleColumns ()
	Returns the columns that contain the cells to be repeated on the left side of each page, as a string in A1-style notation in the language of the macro.

void	SetPrintTitleColumns (const wxString &printTitleColumns)
	Sets the columns that contain the cells to be repeated on the left side of each page, as a string in A1-style notation in the language of the macro.

wxString	GetPrintTitleRows ()
	Returns the rows that contain the cells to be repeated at the top of each page, as a string in A1-style notation in the language of the macro.

void	SetPrintTitleRows (const wxString &printTitleRows)
	Sets the rows that contain the cells to be repeated at the top of each page, as a string in A1-style notation in the language of the macro.

wxString	GetRightFooter ()
	Returns the right part of the footer.

void	SetRightFooter (const wxString &rightFooter)
	Sets the right part of the footer.

wxExcelGraphic	GetRightFooterPicture ()
	Returns a Graphic Represents the picture for the right section of the footer.

wxString	GetRightHeader ()
	Returns the right part of the header.

void	SetRightHeader (const wxString &rightHeader)
	Sets the right part of the header.

wxExcelGraphic	GetRightHeaderPicture ()
	Returns a Graphic Represents the picture for the right section of the header.

double	GetRightMargin ()
	Returns the size of the right margin, in points.

void	SetRightMargin (double rightMargin)
	Sets the size of the right margin, in points.

bool	GetScaleWithDocHeaderFooter ()
	True if the header and footer should be scaled with the document when the size of the document changes.

void	SetScaleWithDocHeaderFooter (bool scaleWithDocHeaderFooter)
	True if the header and footer should be scaled with the document when the size of the document changes.

double	GetTopMargin ()
	Returns the size of the top margin, in points.

void	SetTopMargin (double topMargin)
	Sets the size of the top margin, in points.

long	GetZoom ()
	Returns a value that represents a percentage (between 10 and 400 percent) by which Microsoft Excel will scale the worksheet for printing.

void	SetZoom (long zoom)
	Sets a value that represents a percentage (between 10 and 400 percent) by which Microsoft Excel will scale the worksheet for printing.

virtual wxString	GetAutoExcelObjectName_ () const
	Returns "PageSetup".

Public Member Functions inherited from wxAutoExcel::wxExcelObject
bool	IsOk_ () const
	Returns true if the object has a valid dispatch.

wxString	GetAutomationObjectName_ (bool stripUnderscores=false) const
	Returns object name as provided by IDispatch->GetTypeInfo()->GetDocumentation(MEMBERID_NIL, &name, NULL, NULL, NULL).

wxSharedPtr< wxAutomationObject >	GetAutomationObject_ ()
	Returns the underlying wxAutomationObject.

	operator bool () const
	Returns true if the object has a valid dispatch and its last automation call (if any), i.e.

WXLCID	GetAutomationLCID_ () const
	Returns the locale identifier used in automation calls.

bool	SetAutomationLCID_ (WXLCID lcid)
	Sets the locale identifier to be used in automation calls.

bool	GetPropertyAndMethodNames_ (wxArrayString &propertyNames, wxArrayString &methodNames, bool includeHidden=false)
	Returns lists of property and method names the automation interface exposes.

bool	GetUnimplementedObject_ (const wxString &name, wxAutomationObject &object)
	Helper function for receiving an automation object not implemented in wxAutoExcel, see FAQ on how to use.

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.

static void	SetErrorMode_ (unsigned mode)
	Sets the error mode as the combination of wxExcelObject::ErrorFlags.

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.

Detailed Description

Represents Microsoft Excel PageSetup object.

Member Function Documentation

◆ GetAlignMarginsHeaderFooter()

bool wxAutoExcel::wxExcelPageSetup::GetAlignMarginsHeaderFooter ( )

True if the header and the footer are aligned.

with the margins set in the page setup options. Since Excel 2007.

MSDN documentation for PageSetup.AlignMarginsHeaderFooter.

◆ SetAlignMarginsHeaderFooter()

void wxAutoExcel::wxExcelPageSetup::SetAlignMarginsHeaderFooter ( bool alignMarginsHeaderFooter )

True if the header and the footer are aligned.

with the margins set in the page setup options. Since Excel 2007.

MSDN documentation for PageSetup.AlignMarginsHeaderFooter.

◆ GetBlackAndWhite()

bool wxAutoExcel::wxExcelPageSetup::GetBlackAndWhite ( )

True if elements of the document will be printed in black and white.

MSDN documentation for PageSetup.BlackAndWhite.

◆ SetBlackAndWhite()

void wxAutoExcel::wxExcelPageSetup::SetBlackAndWhite ( bool blackAndWhite )

True if elements of the document will be printed in black and white.

MSDN documentation for PageSetup.BlackAndWhite.

◆ GetBottomMargin()

double wxAutoExcel::wxExcelPageSetup::GetBottomMargin ( )

Returns the size of the bottom margin, in points.

MSDN documentation for PageSetup.BottomMargin.

◆ SetBottomMargin()

void wxAutoExcel::wxExcelPageSetup::SetBottomMargin ( double bottomMargin )

Sets the size of the bottom margin, in points.

MSDN documentation for PageSetup.BottomMargin.

◆ GetCenterFooter()

wxString wxAutoExcel::wxExcelPageSetup::GetCenterFooter ( )

Returns the center footer.

MSDN documentation for PageSetup.CenterFooter.

◆ SetCenterFooter()

void wxAutoExcel::wxExcelPageSetup::SetCenterFooter ( const wxString & centerFooter )

Sets the center footer.

MSDN documentation for PageSetup.CenterFooter.

◆ GetCenterFooterPicture()

wxExcelGraphic wxAutoExcel::wxExcelPageSetup::GetCenterFooterPicture ( )

Returns a Graphic Represents the picture for the center section of the footer.

Used to set attributes about the picture.

MSDN documentation for PageSetup.CenterFooterPicture.

◆ GetCenterHeader()

wxString wxAutoExcel::wxExcelPageSetup::GetCenterHeader ( )

Returns the center heaer.

MSDN documentation for PageSetup.CenterHeader.

◆ SetCenterHeader()

void wxAutoExcel::wxExcelPageSetup::SetCenterHeader ( const wxString & centerHeader )

Sets the center heaer.

MSDN documentation for PageSetup.CenterHeader.

◆ GetCenterHeaderPicture()

wxExcelGraphic wxAutoExcel::wxExcelPageSetup::GetCenterHeaderPicture ( )

Returns a Graphic Represents the picture for the center section of the header.

Used to set attributes about the picture.

MSDN documentation for PageSetup.CenterHeaderPicture.

◆ GetCenterHorizontally()

bool wxAutoExcel::wxExcelPageSetup::GetCenterHorizontally ( )

True if the sheet is centered horizontally on the page when it's printed.

MSDN documentation for PageSetup.CenterHorizontally.

◆ SetCenterHorizontally()

void wxAutoExcel::wxExcelPageSetup::SetCenterHorizontally ( bool centerHorizontally )

True if the sheet is centered horizontally on the page when it's printed.

MSDN documentation for PageSetup.CenterHorizontally.

◆ GetCenterVertically()

bool wxAutoExcel::wxExcelPageSetup::GetCenterVertically ( )

True if the sheet is centered vertically on the page when it's printed.

MSDN documentation for PageSetup.CenterVertically.

◆ SetCenterVertically()

void wxAutoExcel::wxExcelPageSetup::SetCenterVertically ( bool centerVertically )

True if the sheet is centered vertically on the page when it's printed.

MSDN documentation for PageSetup.CenterVertically.

◆ GetDifferentFirstPageHeaderFooter()

bool wxAutoExcel::wxExcelPageSetup::GetDifferentFirstPageHeaderFooter ( )

True if a different header or footer is used on the first page.

MSDN documentation for PageSetup.DifferentFirstPageHeaderFooter.

◆ SetDifferentFirstPageHeaderFooter()

void wxAutoExcel::wxExcelPageSetup::SetDifferentFirstPageHeaderFooter ( bool differentFirstPageHeaderFooter )

True if a different header or footer is used on the first page.

MSDN documentation for PageSetup.DifferentFirstPageHeaderFooter.

◆ GetDraft()

bool wxAutoExcel::wxExcelPageSetup::GetDraft ( )

True if the sheet will be printed without graphics.

MSDN documentation for PageSetup.Draft.

◆ SetDraft()

void wxAutoExcel::wxExcelPageSetup::SetDraft ( bool draft )

True if the sheet will be printed without graphics.

MSDN documentation for PageSetup.Draft.

◆ GetEvenPage()

wxExcelPage wxAutoExcel::wxExcelPageSetup::GetEvenPage ( )

Returns the page settings for the even pages.

Since Excel 2007.

MSDN documentation for PageSetup.EvenPage.

◆ GetFirstPage()

wxExcelPage wxAutoExcel::wxExcelPageSetup::GetFirstPage ( )

Returns the page settings for the first page.

Since Excel 2007.

MSDN documentation for PageSetup.FirstPage.

◆ GetFirstPageNumber()

long wxAutoExcel::wxExcelPageSetup::GetFirstPageNumber ( )

Returns the first page number that will be used when this sheet is printed.

If xlAutomatic, Microsoft Excel chooses the first page number. The default is xlAutomatic.

MSDN documentation for PageSetup.FirstPageNumber.

◆ SetFirstPageNumber()

void wxAutoExcel::wxExcelPageSetup::SetFirstPageNumber ( long firstPageNumber )

Sets the first page number that will be used when this sheet is printed.

If xlAutomatic, Microsoft Excel chooses the first page number. The default is xlAutomatic.

MSDN documentation for PageSetup.FirstPageNumber.

◆ GetFitToPagesTall()

long wxAutoExcel::wxExcelPageSetup::GetFitToPagesTall ( )

Returns the number of pages tall the worksheet will be scaled to when it's printed.

Applies only to worksheets.

MSDN documentation for PageSetup.FitToPagesTall.

◆ SetFitToPagesTall()

void wxAutoExcel::wxExcelPageSetup::SetFitToPagesTall ( long fitToPagesTall )

Sets the number of pages tall the worksheet will be scaled to when it's printed.

Applies only to worksheets.

MSDN documentation for PageSetup.FitToPagesTall.

◆ GetFitToPagesWide()

long wxAutoExcel::wxExcelPageSetup::GetFitToPagesWide ( )

Returns the number of pages wide the worksheet will be scaled to when it's printed.

Applies only to worksheets.

MSDN documentation for PageSetup.FitToPagesWide.

◆ SetFitToPagesWide()

void wxAutoExcel::wxExcelPageSetup::SetFitToPagesWide ( long fitToPagesWide )

Sets the number of pages wide the worksheet will be scaled to when it's printed.

Applies only to worksheets.

MSDN documentation for PageSetup.FitToPagesWide.

◆ GetFooterMargin()

double wxAutoExcel::wxExcelPageSetup::GetFooterMargin ( )

Returns the distance from the bottom of the page to the footer, in points.

MSDN documentation for PageSetup.FooterMargin.

◆ SetFooterMargin()

void wxAutoExcel::wxExcelPageSetup::SetFooterMargin ( double footerMargin )

Sets the distance from the bottom of the page to the footer, in points.

MSDN documentation for PageSetup.FooterMargin.

◆ GetHeaderMargin()

double wxAutoExcel::wxExcelPageSetup::GetHeaderMargin ( )

Returns the distance from the top of the page to the header, in points.

MSDN documentation for PageSetup.HeaderMargin.

◆ SetHeaderMargin()

void wxAutoExcel::wxExcelPageSetup::SetHeaderMargin ( double headerMargin )

Sets the distance from the top of the page to the header, in points.

MSDN documentation for PageSetup.HeaderMargin.

◆ GetLeftFooter()

wxString wxAutoExcel::wxExcelPageSetup::GetLeftFooter ( )

Returns the left footer.

MSDN documentation for PageSetup.LeftFooter.

◆ SetLeftFooter()

void wxAutoExcel::wxExcelPageSetup::SetLeftFooter ( const wxString & leftFooter )

Sets the left footer.

MSDN documentation for PageSetup.LeftFooter.

◆ GetLeftFooterPicture()

wxExcelGraphic wxAutoExcel::wxExcelPageSetup::GetLeftFooterPicture ( )

Returns a Graphic Represents the picture for the left section of the footer.

Used to set attributes about the picture.

MSDN documentation for PageSetup.LeftFooterPicture.

◆ GetLeftHeader()

wxString wxAutoExcel::wxExcelPageSetup::GetLeftHeader ( )

Returns the left header.

MSDN documentation for PageSetup.LeftHeader.

◆ SetLeftHeader()

void wxAutoExcel::wxExcelPageSetup::SetLeftHeader ( const wxString & leftHeader )

Sets the left header.

MSDN documentation for PageSetup.LeftHeader.

◆ GetLeftHeaderPicture()

wxExcelGraphic wxAutoExcel::wxExcelPageSetup::GetLeftHeaderPicture ( )

Returns a Graphic Represents the picture for the left section of the header.

Used to set attributes about the picture.

MSDN documentation for PageSetup.LeftHeaderPicture.

◆ GetLeftMargin()

double wxAutoExcel::wxExcelPageSetup::GetLeftMargin ( )

Returns the size of the left margin, in points.

MSDN documentation for PageSetup.LeftMargin.

◆ SetLeftMargin()

void wxAutoExcel::wxExcelPageSetup::SetLeftMargin ( double leftMargin )

Sets the size of the left margin, in points.

MSDN documentation for PageSetup.LeftMargin.

◆ GetOddAndEvenPagesHeaderFooter()

bool wxAutoExcel::wxExcelPageSetup::GetOddAndEvenPagesHeaderFooter ( )

True if different headers and footers for odd-numbered and even-numbered pages.

Since Excel 2007.

MSDN documentation for PageSetup.OddAndEvenPagesHeaderFooter.

◆ SetOddAndEvenPagesHeaderFooter()

void wxAutoExcel::wxExcelPageSetup::SetOddAndEvenPagesHeaderFooter ( bool oddAndEvenPagesHeaderFooter )

True if different headers and footers for odd-numbered and even-numbered pages.

Since Excel 2007.

MSDN documentation for PageSetup.OddAndEvenPagesHeaderFooter.

◆ GetOrder()

XlOrder wxAutoExcel::wxExcelPageSetup::GetOrder ( )

Returns a XlOrder value that represents the order that Microsoft Excel uses to number pages when printing a large worksheet.

MSDN documentation for PageSetup.Order.

◆ SetOrder()

void wxAutoExcel::wxExcelPageSetup::SetOrder ( XlOrder order )

Sets a XlOrder value that represents the order that Microsoft Excel uses to number pages when printing a large worksheet.

MSDN documentation for PageSetup.Order.

◆ GetOrientation()

XlPageOrientation wxAutoExcel::wxExcelPageSetup::GetOrientation ( )

Returns a XlPageOrientation value that represents the portrait or landscape printing mode.

MSDN documentation for PageSetup.Orientation.

◆ SetOrientation()

void wxAutoExcel::wxExcelPageSetup::SetOrientation ( XlPageOrientation orientation )

Sets a XlPageOrientation value that represents the portrait or landscape printing mode.

MSDN documentation for PageSetup.Orientation.

◆ GetPages()

wxExcelPages wxAutoExcel::wxExcelPageSetup::GetPages ( )

Returns Pages collection.

Since Excel 2007.

MSDN documentation for PageSetup.Pages.

◆ GetPaperSize()

XlPaperSize wxAutoExcel::wxExcelPageSetup::GetPaperSize ( )

Returns the size of the paper.

Read/write XlPaperSize.

MSDN documentation for PageSetup.PaperSize.

◆ SetPaperSize()

void wxAutoExcel::wxExcelPageSetup::SetPaperSize ( XlPaperSize paperSize )

Sets the size of the paper.

Read/write XlPaperSize.

MSDN documentation for PageSetup.PaperSize.

◆ GetPrintArea()

wxString wxAutoExcel::wxExcelPageSetup::GetPrintArea ( )

Returns the range to be printed, as a string using A1-style references in the language of the macro.

MSDN documentation for PageSetup.PrintArea.

◆ SetPrintArea()

void wxAutoExcel::wxExcelPageSetup::SetPrintArea ( const wxString & printArea )

Sets the range to be printed, as a string using A1-style references in the language of the macro.

MSDN documentation for PageSetup.PrintArea.

◆ GetPrintComments()

XlPrintLocation wxAutoExcel::wxExcelPageSetup::GetPrintComments ( )

Returns the way comments are printed with the sheet.

Read/write XlPrintLocation.

MSDN documentation for PageSetup.PrintComments.

◆ SetPrintComments()

void wxAutoExcel::wxExcelPageSetup::SetPrintComments ( XlPrintLocation printComments )

Sets the way comments are printed with the sheet.

Read/write XlPrintLocation.

MSDN documentation for PageSetup.PrintComments.

◆ GetPrintErrors()

XlPrintErrors wxAutoExcel::wxExcelPageSetup::GetPrintErrors ( )

Returns an XlPrintErrors contstant specifying the type of print error displayed.

This feature allows users to suppress the display of error values when printing a worksheet.

MSDN documentation for PageSetup.PrintErrors.

◆ SetPrintErrors()

void wxAutoExcel::wxExcelPageSetup::SetPrintErrors ( XlPrintErrors printErrors )

Sets an XlPrintErrors contstant specifying the type of print error displayed.

This feature allows users to suppress the display of error values when printing a worksheet.

MSDN documentation for PageSetup.PrintErrors.

◆ GetPrintGridlines()

bool wxAutoExcel::wxExcelPageSetup::GetPrintGridlines ( )

True if cell gridlines are printed on the page.

Applies only to worksheets.

MSDN documentation for PageSetup.PrintGridlines.

◆ SetPrintGridlines()

void wxAutoExcel::wxExcelPageSetup::SetPrintGridlines ( bool printGridlines )

True if cell gridlines are printed on the page.

Applies only to worksheets.

MSDN documentation for PageSetup.PrintGridlines.

◆ GetPrintHeadings()

bool wxAutoExcel::wxExcelPageSetup::GetPrintHeadings ( )

True if row and column headings are printed with this page.

Applies only to worksheets.

MSDN documentation for PageSetup.PrintHeadings.

◆ SetPrintHeadings()

void wxAutoExcel::wxExcelPageSetup::SetPrintHeadings ( bool printHeadings )

True if row and column headings are printed with this page.

Applies only to worksheets.

MSDN documentation for PageSetup.PrintHeadings.

◆ GetPrintNotes()

bool wxAutoExcel::wxExcelPageSetup::GetPrintNotes ( )

True if cell notes are printed as end notes with the sheet.

Applies only to worksheets.

MSDN documentation for PageSetup.PrintNotes.

◆ SetPrintNotes()

void wxAutoExcel::wxExcelPageSetup::SetPrintNotes ( bool printNotes )

True if cell notes are printed as end notes with the sheet.

Applies only to worksheets.

MSDN documentation for PageSetup.PrintNotes.

◆ GetPrintQuality()

long wxAutoExcel::wxExcelPageSetup::GetPrintQuality ( int index )

Returns the print quality.

Index can be either 1 for horizontal quality or 2 for vertical quality, which a printer may not support

MSDN documentation for PageSetup.PrintQuality.

◆ SetPrintQuality()

void wxAutoExcel::wxExcelPageSetup::SetPrintQuality	(	int	index,
		long	quality
	)

Sets the print quality.

Index can be either 1 for horizontal quality or 2 for vertical quality, which a printer may not support

MSDN documentation for PageSetup.PrintQuality.

◆ GetPrintTitleColumns()

wxString wxAutoExcel::wxExcelPageSetup::GetPrintTitleColumns ( )

Returns the columns that contain the cells to be repeated on the left side of each page, as a string in A1-style notation in the language of the macro.

MSDN documentation for PageSetup.PrintTitleColumns.

◆ SetPrintTitleColumns()

void wxAutoExcel::wxExcelPageSetup::SetPrintTitleColumns ( const wxString & printTitleColumns )

Sets the columns that contain the cells to be repeated on the left side of each page, as a string in A1-style notation in the language of the macro.

MSDN documentation for PageSetup.PrintTitleColumns.

◆ GetPrintTitleRows()

wxString wxAutoExcel::wxExcelPageSetup::GetPrintTitleRows ( )

Returns the rows that contain the cells to be repeated at the top of each page, as a string in A1-style notation in the language of the macro.

MSDN documentation for PageSetup.PrintTitleRows.

◆ SetPrintTitleRows()

void wxAutoExcel::wxExcelPageSetup::SetPrintTitleRows ( const wxString & printTitleRows )

Sets the rows that contain the cells to be repeated at the top of each page, as a string in A1-style notation in the language of the macro.

MSDN documentation for PageSetup.PrintTitleRows.

◆ GetRightFooter()

wxString wxAutoExcel::wxExcelPageSetup::GetRightFooter ( )

Returns the right part of the footer.

Since Excel 2007.

MSDN documentation for PageSetup.RightFooter.

◆ SetRightFooter()

void wxAutoExcel::wxExcelPageSetup::SetRightFooter ( const wxString & rightFooter )

Sets the right part of the footer.

MSDN documentation for PageSetup.RightFooter.

◆ GetRightFooterPicture()

wxExcelGraphic wxAutoExcel::wxExcelPageSetup::GetRightFooterPicture ( )

Returns a Graphic Represents the picture for the right section of the footer.

Used to set attributes about the picture.

MSDN documentation for PageSetup.RightFooterPicture.

◆ GetRightHeader()

wxString wxAutoExcel::wxExcelPageSetup::GetRightHeader ( )

Returns the right part of the header.

MSDN documentation for PageSetup.RightHeader.

◆ SetRightHeader()

void wxAutoExcel::wxExcelPageSetup::SetRightHeader ( const wxString & rightHeader )

Sets the right part of the header.

MSDN documentation for PageSetup.RightHeader.

◆ GetRightHeaderPicture()

wxExcelGraphic wxAutoExcel::wxExcelPageSetup::GetRightHeaderPicture ( )

Returns a Graphic Represents the picture for the right section of the header.

Used to set attributes about the picture.

MSDN documentation for PageSetup.RightHeaderPicture.

◆ GetRightMargin()

double wxAutoExcel::wxExcelPageSetup::GetRightMargin ( )

Returns the size of the right margin, in points.

MSDN documentation for PageSetup.RightMargin.

◆ SetRightMargin()

void wxAutoExcel::wxExcelPageSetup::SetRightMargin ( double rightMargin )

Sets the size of the right margin, in points.

MSDN documentation for PageSetup.RightMargin.

◆ GetScaleWithDocHeaderFooter()

bool wxAutoExcel::wxExcelPageSetup::GetScaleWithDocHeaderFooter ( )

True if the header and footer should be scaled with the document when the size of the document changes.

Since Excel 2007.

MSDN documentation for PageSetup.ScaleWithDocHeaderFooter.

◆ SetScaleWithDocHeaderFooter()

void wxAutoExcel::wxExcelPageSetup::SetScaleWithDocHeaderFooter ( bool scaleWithDocHeaderFooter )

True if the header and footer should be scaled with the document when the size of the document changes.

Since Excel 2007.

MSDN documentation for PageSetup.ScaleWithDocHeaderFooter.

◆ GetTopMargin()

double wxAutoExcel::wxExcelPageSetup::GetTopMargin ( )

Returns the size of the top margin, in points.

MSDN documentation for PageSetup.TopMargin.

◆ SetTopMargin()

void wxAutoExcel::wxExcelPageSetup::SetTopMargin ( double topMargin )

Sets the size of the top margin, in points.

MSDN documentation for PageSetup.TopMargin.

◆ GetZoom()

long wxAutoExcel::wxExcelPageSetup::GetZoom ( )

Returns a value that represents a percentage (between 10 and 400 percent) by which Microsoft Excel will scale the worksheet for printing.

MSDN documentation for PageSetup.Zoom.

◆ SetZoom()

void wxAutoExcel::wxExcelPageSetup::SetZoom ( long zoom )

Sets a value that represents a percentage (between 10 and 400 percent) by which Microsoft Excel will scale the worksheet for printing.

MSDN documentation for PageSetup.Zoom.

◆ GetAutoExcelObjectName_()

virtual wxString wxAutoExcel::wxExcelPageSetup::GetAutoExcelObjectName_ ( ) const

inlinevirtual

Returns "PageSetup".

Reimplemented from wxAutoExcel::wxExcelObject.

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ GetAlignMarginsHeaderFooter()

◆ SetAlignMarginsHeaderFooter()

◆ GetBlackAndWhite()

◆ SetBlackAndWhite()

◆ GetBottomMargin()

◆ SetBottomMargin()

◆ GetCenterFooter()

◆ SetCenterFooter()

◆ GetCenterFooterPicture()

◆ GetCenterHeader()

◆ SetCenterHeader()

◆ GetCenterHeaderPicture()

◆ GetCenterHorizontally()

◆ SetCenterHorizontally()

◆ GetCenterVertically()

◆ SetCenterVertically()

◆ GetDifferentFirstPageHeaderFooter()

◆ SetDifferentFirstPageHeaderFooter()

◆ GetDraft()

◆ SetDraft()

◆ GetEvenPage()

◆ GetFirstPage()

◆ GetFirstPageNumber()

◆ SetFirstPageNumber()

◆ GetFitToPagesTall()

◆ SetFitToPagesTall()

◆ GetFitToPagesWide()

◆ SetFitToPagesWide()

◆ GetFooterMargin()

◆ SetFooterMargin()

◆ GetHeaderMargin()

◆ SetHeaderMargin()

◆ GetLeftFooter()

◆ SetLeftFooter()

◆ GetLeftFooterPicture()

◆ GetLeftHeader()

◆ SetLeftHeader()

◆ GetLeftHeaderPicture()

◆ GetLeftMargin()

◆ SetLeftMargin()

◆ GetOddAndEvenPagesHeaderFooter()

◆ SetOddAndEvenPagesHeaderFooter()

◆ GetOrder()

◆ SetOrder()

◆ GetOrientation()

◆ SetOrientation()

◆ GetPages()

◆ GetPaperSize()

◆ SetPaperSize()

◆ GetPrintArea()

◆ SetPrintArea()

◆ GetPrintComments()

◆ SetPrintComments()

◆ GetPrintErrors()

◆ SetPrintErrors()

◆ GetPrintGridlines()

◆ SetPrintGridlines()

◆ GetPrintHeadings()

◆ SetPrintHeadings()

◆ GetPrintNotes()

◆ SetPrintNotes()

◆ GetPrintQuality()

◆ SetPrintQuality()

◆ GetPrintTitleColumns()

◆ SetPrintTitleColumns()

◆ GetPrintTitleRows()

◆ SetPrintTitleRows()

◆ GetRightFooter()

◆ SetRightFooter()

◆ GetRightFooterPicture()

◆ GetRightHeader()

◆ SetRightHeader()

◆ GetRightHeaderPicture()

◆ GetRightMargin()

◆ SetRightMargin()

◆ GetScaleWithDocHeaderFooter()