Aspose::Cells::IPageSetup Class Referenceabstract

Encapsulates the object that represents the page setup description. The IPageSetup object contains all page setup options. More...

Inherits Object.

Public Member Functions

virtual void Copy (intrusive_ptr< Aspose::Cells::IPageSetup > source, intrusive_ptr< Aspose::Cells::ICopyOptions > copyOptions)=0
 Copies the setting of the page setup. More...
 
virtual intrusive_ptr< Aspose::Cells::Systems::String > GetPrintArea ()=0
 Represents the range to be printed. More...
 
virtual void SetPrintArea (intrusive_ptr< Aspose::Cells::Systems::String > value)=0
 Represents the range to be printed. More...
 
virtual intrusive_ptr< Aspose::Cells::Systems::String > GetPrintTitleColumns ()=0
 Represents the columns that contain the cells to be repeated on the left side of each page. More...
 
virtual void SetPrintTitleColumns (intrusive_ptr< Aspose::Cells::Systems::String > value)=0
 Represents the columns that contain the cells to be repeated on the left side of each page. More...
 
virtual intrusive_ptr< Aspose::Cells::Systems::String > GetPrintTitleRows ()=0
 Represents the rows that contain the cells to be repeated at the top of each page. More...
 
virtual void SetPrintTitleRows (intrusive_ptr< Aspose::Cells::Systems::String > value)=0
 Represents the rows that contain the cells to be repeated at the top of each page. More...
 
virtual bool GetBlackAndWhite ()=0
 Represents if elements of the document will be printed in black and white. More...
 
virtual void SetBlackAndWhite (bool value)=0
 Represents if elements of the document will be printed in black and white. More...
 
virtual bool GetCenterHorizontally ()=0
 Represent if the sheet is printed centered horizontally. More...
 
virtual void SetCenterHorizontally (bool value)=0
 Represent if the sheet is printed centered horizontally. More...
 
virtual bool GetCenterVertically ()=0
 Represent if the sheet is printed centered vertically. More...
 
virtual void SetCenterVertically (bool value)=0
 Represent if the sheet is printed centered vertically. More...
 
virtual bool GetPrintDraft ()=0
 Represents if the sheet will be printed without graphics. More...
 
virtual void SetPrintDraft (bool value)=0
 Represents if the sheet will be printed without graphics. More...
 
virtual Aspose::Cells::Systems::Double GetFooterMargin ()=0
 Represents the distance from the bottom of the page to the footer, in unit of centimeters. More...
 
virtual void SetFooterMargin (Aspose::Cells::Systems::Double value)=0
 Represents the distance from the bottom of the page to the footer, in unit of centimeters. More...
 
virtual Aspose::Cells::Systems::Double GetFooterMarginInch ()=0
 Represents the distance from the bottom of the page to the footer, in unit of inches. More...
 
virtual void SetFooterMarginInch (Aspose::Cells::Systems::Double value)=0
 Represents the distance from the bottom of the page to the footer, in unit of inches. More...
 
virtual Aspose::Cells::Systems::Double GetHeaderMargin ()=0
 Represents the distance from the top of the page to the header, in unit of centimeters. More...
 
virtual void SetHeaderMargin (Aspose::Cells::Systems::Double value)=0
 Represents the distance from the top of the page to the header, in unit of centimeters. More...
 
virtual Aspose::Cells::Systems::Double GetHeaderMarginInch ()=0
 Represents the distance from the top of the page to the header, in unit of inches. More...
 
virtual void SetHeaderMarginInch (Aspose::Cells::Systems::Double value)=0
 Represents the distance from the top of the page to the header, in unit of inches. More...
 
virtual intrusive_ptr< Aspose::Cells::Systems::Array1D< Aspose::Cells::Systems::Byte > > GetPrinterSettings ()=0
 Gets the settings of the default printer. More...
 
virtual void SetPrinterSettings (intrusive_ptr< Aspose::Cells::Systems::Array1D< Aspose::Cells::Systems::Byte >> value)=0
 Sets the settings of the default printer. More...
 
virtual Aspose::Cells::Systems::Double GetLeftMargin ()=0
 Represents the size of the left margin, in unit of centimeters. More...
 
virtual void SetLeftMargin (Aspose::Cells::Systems::Double value)=0
 Represents the size of the left margin, in unit of centimeters. More...
 
virtual Aspose::Cells::Systems::Double GetLeftMarginInch ()=0
 Represents the size of the left margin, in unit of inches. More...
 
virtual void SetLeftMarginInch (Aspose::Cells::Systems::Double value)=0
 Represents the size of the left margin, in unit of inches. More...
 
virtual Aspose::Cells::Systems::Double GetRightMargin ()=0
 Represents the size of the right margin, in unit of centimeters. More...
 
virtual void SetRightMargin (Aspose::Cells::Systems::Double value)=0
 Represents the size of the right margin, in unit of centimeters. More...
 
virtual Aspose::Cells::Systems::Double GetRightMarginInch ()=0
 Represents the size of the right margin, in unit of inches. More...
 
virtual void SetRightMarginInch (Aspose::Cells::Systems::Double value)=0
 Represents the size of the right margin, in unit of inches. More...
 
virtual Aspose::Cells::Systems::Double GetTopMargin ()=0
 Represents the size of the top margin, in unit of centimeters. More...
 
virtual void SetTopMargin (Aspose::Cells::Systems::Double value)=0
 Represents the size of the top margin, in unit of centimeters. More...
 
virtual Aspose::Cells::Systems::Double GetTopMarginInch ()=0
 Represents the size of the top margin, in unit of inches. More...
 
virtual void SetTopMarginInch (Aspose::Cells::Systems::Double value)=0
 Represents the size of the top margin, in unit of inches. More...
 
virtual Aspose::Cells::Systems::Double GetBottomMargin ()=0
 Represents the size of the bottom margin, in unit of centimeters. More...
 
virtual void SetBottomMargin (Aspose::Cells::Systems::Double value)=0
 Represents the size of the bottom margin, in unit of centimeters. More...
 
virtual Aspose::Cells::Systems::Double GetBottomMarginInch ()=0
 Represents the size of the bottom margin, in unit of inches. More...
 
virtual void SetBottomMarginInch (Aspose::Cells::Systems::Double value)=0
 Represents the size of the bottom margin, in unit of inches. More...
 
virtual Aspose::Cells::Systems::Int32 GetFirstPageNumber ()=0
 Represents the first page number that will be used when this sheet is printed. More...
 
virtual void SetFirstPageNumber (Aspose::Cells::Systems::Int32 value)=0
 Represents the first page number that will be used when this sheet is printed. More...
 
virtual void SetFitToPages (Aspose::Cells::Systems::Int32 wide, Aspose::Cells::Systems::Int32 tall)=0
 Sets the number of pages the worksheet will be scaled to when it's printed. More...
 
virtual Aspose::Cells::Systems::Int32 GetFitToPagesTall ()=0
 Represents the number of pages tall the worksheet will be scaled to when it's printed. The default value is 1. More...
 
virtual void SetFitToPagesTall (Aspose::Cells::Systems::Int32 value)=0
 Represents the number of pages tall the worksheet will be scaled to when it's printed. The default value is 1. More...
 
virtual Aspose::Cells::Systems::Int32 GetFitToPagesWide ()=0
 Represents the number of pages wide the worksheet will be scaled to when it's printed. The default value is 1. More...
 
virtual void SetFitToPagesWide (Aspose::Cells::Systems::Int32 value)=0
 Represents the number of pages wide the worksheet will be scaled to when it's printed. The default value is 1. More...
 
virtual bool IsPercentScale ()=0
 If this property is False, the GetFitToPagesWide() and GetFitToPagesTall() methods control how the worksheet is scaled. More...
 
virtual void SetPercentScale (bool value)=0
 If this property is False, the GetFitToPagesWide() and GetFitToPagesTall() methods control how the worksheet is scaled. More...
 
virtual Aspose::Cells::PrintOrderType GetOrder ()=0
 Represents the order that Microsoft Excel uses to number pages when printing a large worksheet. More...
 
virtual void SetOrder (Aspose::Cells::PrintOrderType value)=0
 Represents the order that Microsoft Excel uses to number pages when printing a large worksheet. More...
 
virtual bool IsAutomaticPaperSize ()=0
 Indicates whether the paper size is automatic. More...
 
virtual Aspose::Cells::PaperSizeType GetPaperSize ()=0
 Represents the size of the paper. More...
 
virtual void SetPaperSize (Aspose::Cells::PaperSizeType value)=0
 Represents the size of the paper. More...
 
virtual Aspose::Cells::Systems::Double GetPaperWidth ()=0
 Gets the width of the paper in unit of inches, considered page orientation. More...
 
virtual Aspose::Cells::Systems::Double GetPaperHeight ()=0
 Gets the height of the paper in unit of inches , considered page orientation. More...
 
virtual void CustomPaperSize (Aspose::Cells::Systems::Double width, Aspose::Cells::Systems::Double height)=0
 Sets the custom paper size, in unit of inches. More...
 
virtual Aspose::Cells::PageOrientationType GetOrientation ()=0
 Represents page print orientation. More...
 
virtual void SetOrientation (Aspose::Cells::PageOrientationType value)=0
 Represents page print orientation. More...
 
virtual Aspose::Cells::PrintCommentsType GetPrintComments ()=0
 Represents the way comments are printed with the sheet. More...
 
virtual void SetPrintComments (Aspose::Cells::PrintCommentsType value)=0
 Represents the way comments are printed with the sheet. More...
 
virtual Aspose::Cells::PrintErrorsType GetPrintErrors ()=0
 Specifies the type of print error displayed. More...
 
virtual void SetPrintErrors (Aspose::Cells::PrintErrorsType value)=0
 Specifies the type of print error displayed. More...
 
virtual bool GetPrintHeadings ()=0
 Represents if row and column headings are printed with this page. More...
 
virtual void SetPrintHeadings (bool value)=0
 Represents if row and column headings are printed with this page. More...
 
virtual bool GetPrintGridlines ()=0
 Represents if cell gridlines are printed on the page. More...
 
virtual void SetPrintGridlines (bool value)=0
 Represents if cell gridlines are printed on the page. More...
 
virtual Aspose::Cells::Systems::Int32 GetZoom ()=0
 Represents the scaling factor in percent. It should be between 10 and 400. More...
 
virtual void SetZoom (Aspose::Cells::Systems::Int32 value)=0
 Represents the scaling factor in percent. It should be between 10 and 400. More...
 
virtual bool IsAutoFirstPageNumber ()=0
 Indicates whether the first the page number is automatically assigned. More...
 
virtual void SetAutoFirstPageNumber (bool value)=0
 Indicates whether the first the page number is automatically assigned. More...
 
virtual Aspose::Cells::Systems::Int32 GetPrintQuality ()=0
 Represents the print quality. More...
 
virtual void SetPrintQuality (Aspose::Cells::Systems::Int32 value)=0
 Represents the print quality. More...
 
virtual Aspose::Cells::Systems::Int32 GetPrintCopies ()=0
 Get number of copies to print. More...
 
virtual void SetPrintCopies (Aspose::Cells::Systems::Int32 value)=0
 Sets number of copies to print. More...
 
virtual void ClearHeaderFooter ()=0
 Clears header and footer setting. More...
 
virtual intrusive_ptr< Aspose::Cells::Systems::String > GetHeader (Aspose::Cells::Systems::Int32 section)=0
 Gets a script formatting the header of an Excel file. More...
 
virtual intrusive_ptr< Aspose::Cells::Systems::Array1D< Aspose::Cells::IHeaderFooterCommand * > > GetIHeaderFooterCommand (intrusive_ptr< Aspose::Cells::Systems::String > headerFooterScript)=0
 Gets all commands of header or footer. More...
 
virtual intrusive_ptr< Aspose::Cells::Systems::String > GetFooter (Aspose::Cells::Systems::Int32 section)=0
 Gets a script formatting the footer of an Excel file. More...
 
virtual void SetHeader (Aspose::Cells::Systems::Int32 section, intrusive_ptr< Aspose::Cells::Systems::String > headerScript)=0
 Sets a script formatting the header of an Excel file. More...
 
virtual void SetFooter (Aspose::Cells::Systems::Int32 section, intrusive_ptr< Aspose::Cells::Systems::String > footerScript)=0
 Sets a script formatting the footer of an Excel file. More...
 
virtual void SetEvenHeader (Aspose::Cells::Systems::Int32 section, intrusive_ptr< Aspose::Cells::Systems::String > headerScript)=0
 Sets a script formatting the even page header of an Excel file. Only effect in Excel 2007 when IsHFDiffOddEven() is true. More...
 
virtual intrusive_ptr< Aspose::Cells::Systems::String > GetEvenHeader (Aspose::Cells::Systems::Int32 section)=0
 Gets a script formatting the even header of an Excel file. More...
 
virtual void SetEvenFooter (Aspose::Cells::Systems::Int32 section, intrusive_ptr< Aspose::Cells::Systems::String > footerScript)=0
 Sets a script formatting the even page footer of an Excel file. Only effect in Excel 2007 when IsHFDiffOddEven() is true. More...
 
virtual intrusive_ptr< Aspose::Cells::Systems::String > GetEvenFooter (Aspose::Cells::Systems::Int32 section)=0
 Gets a script formatting the even footer of an Excel file. More...
 
virtual void SetFirstPageHeader (Aspose::Cells::Systems::Int32 section, intrusive_ptr< Aspose::Cells::Systems::String > headerScript)=0
 Sets a script formatting the first page header of an Excel file. Only effect in Excel 2007 when IsHFDiffFirst is true. More...
 
virtual intrusive_ptr< Aspose::Cells::Systems::String > GetFirstPageHeader (Aspose::Cells::Systems::Int32 section)=0
 Gets a script formatting the first page header of an Excel file. More...
 
virtual void SetFirstPageFooter (Aspose::Cells::Systems::Int32 section, intrusive_ptr< Aspose::Cells::Systems::String > footerScript)=0
 Sets a script formatting the first page footer of an Excel file. More...
 
virtual intrusive_ptr< Aspose::Cells::Systems::String > GetFirstPageFooter (Aspose::Cells::Systems::Int32 section)=0
 Gets a script formatting the first page footer of an Excel file. More...
 
virtual bool IsHFDiffOddEven ()=0
 True means that the header/footer of the odd pages is different with odd pages. More...
 
virtual void SetHFDiffOddEven (bool value)=0
 True means that the header/footer of the odd pages is different with odd pages. More...
 
virtual bool IsHFDiffFirst ()=0
 True means that the header/footer of the first page is different with other pages. More...
 
virtual void SetHFDiffFirst (bool value)=0
 True means that the header/footer of the first page is different with other pages. More...
 
virtual bool IsHFScaleWithDoc ()=0
 Indicates whether header and footer are scaled with document scaling. Only applies for Excel 2007. More...
 
virtual void SetHFScaleWithDoc (bool value)=0
 Indicates whether header and footer are scaled with document scaling. Only applies for Excel 2007. More...
 
virtual bool IsHFAlignMargins ()=0
 Indicates whether header and footer margins are aligned with the page margins. Only applies for Excel 2007. More...
 
virtual void SetHFAlignMargins (bool value)=0
 Indicates whether header and footer margins are aligned with the page margins. Only applies for Excel 2007. More...
 
virtual intrusive_ptr< Aspose::Cells::Drawing::IPictureSetHeaderIPicture (Aspose::Cells::Systems::Int32 section, intrusive_ptr< Aspose::Cells::Systems::Array1D< Aspose::Cells::Systems::Byte >> headerPicture)=0
 Sets an image in the header of a worksheet. More...
 
virtual intrusive_ptr< Aspose::Cells::Drawing::IPictureSetFooterIPicture (Aspose::Cells::Systems::Int32 section, intrusive_ptr< Aspose::Cells::Systems::Array1D< Aspose::Cells::Systems::Byte >> footerPicture)=0
 Sets an image in the footer of a worksheet. More...
 
virtual intrusive_ptr< Aspose::Cells::Drawing::IPictureSetIPicture (bool isFirst, bool isEven, bool isHeader, Aspose::Cells::Systems::Int32 section, intrusive_ptr< Aspose::Cells::Systems::Array1D< Aspose::Cells::Systems::Byte >> imageData)=0
 Sets an image in the header/footer of a worksheet. More...
 
virtual intrusive_ptr< Aspose::Cells::Drawing::IPictureGetIPicture (bool isHeader, Aspose::Cells::Systems::Int32 section)=0
 Gets the IPicture object of the header / footer. More...
 
virtual intrusive_ptr< Aspose::Cells::Drawing::IPictureGetIPicture (bool isFirst, bool isEven, bool isHeader, Aspose::Cells::Systems::Int32 section)=0
 Gets the IPicture object of the header / footer. More...
 

Detailed Description

Encapsulates the object that represents the page setup description. The IPageSetup object contains all page setup options.

[C++]
intrusive_ptr<Aspose::Cells::IWorkbook> workbook = Factory::CreateIWorkbook();
intrusive_ptr<Aspose::Cells::IWorksheet> sheet = workbook->GetIWorksheets()->GetObjectByIndex(0);
sheet->GetIPageSetup()->SetPrintArea(new String("D1:K13"));
sheet->GetIPageSetup()->SetPrintTitleRows(new String("$5:$7"));
sheet->GetIPageSetup()->SetPrintTitleColumns(new String("$A:$B"));

Member Function Documentation

◆ ClearHeaderFooter()

virtual void Aspose::Cells::IPageSetup::ClearHeaderFooter ( )
pure virtual

Clears header and footer setting.

◆ Copy()

virtual void Aspose::Cells::IPageSetup::Copy ( intrusive_ptr< Aspose::Cells::IPageSetup source,
intrusive_ptr< Aspose::Cells::ICopyOptions copyOptions 
)
pure virtual

Copies the setting of the page setup.

Parameters
sourceThe source.
copyOptionsThe copy options.

◆ CustomPaperSize()

virtual void Aspose::Cells::IPageSetup::CustomPaperSize ( Aspose::Cells::Systems::Double  width,
Aspose::Cells::Systems::Double  height 
)
pure virtual

Sets the custom paper size, in unit of inches.

Parameters
widthThe width of the paper.
heightThe height of the paper.

◆ GetBlackAndWhite()

virtual bool Aspose::Cells::IPageSetup::GetBlackAndWhite ( )
pure virtual

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

◆ GetBottomMargin()

virtual Aspose::Cells::Systems::Double Aspose::Cells::IPageSetup::GetBottomMargin ( )
pure virtual

Represents the size of the bottom margin, in unit of centimeters.

◆ GetBottomMarginInch()

virtual Aspose::Cells::Systems::Double Aspose::Cells::IPageSetup::GetBottomMarginInch ( )
pure virtual

Represents the size of the bottom margin, in unit of inches.

◆ GetCenterHorizontally()

virtual bool Aspose::Cells::IPageSetup::GetCenterHorizontally ( )
pure virtual

Represent if the sheet is printed centered horizontally.

◆ GetCenterVertically()

virtual bool Aspose::Cells::IPageSetup::GetCenterVertically ( )
pure virtual

Represent if the sheet is printed centered vertically.

◆ GetEvenFooter()

virtual intrusive_ptr<Aspose::Cells::Systems::String> Aspose::Cells::IPageSetup::GetEvenFooter ( Aspose::Cells::Systems::Int32  section)
pure virtual

Gets a script formatting the even footer of an Excel file.

Parameters
section

0:Left Section.

1:Center Section

2:Right Section

◆ GetEvenHeader()

virtual intrusive_ptr<Aspose::Cells::Systems::String> Aspose::Cells::IPageSetup::GetEvenHeader ( Aspose::Cells::Systems::Int32  section)
pure virtual

Gets a script formatting the even header of an Excel file.

Parameters
section

0:Left Section.

1:Center Section

2:Right Section

◆ GetFirstPageFooter()

virtual intrusive_ptr<Aspose::Cells::Systems::String> Aspose::Cells::IPageSetup::GetFirstPageFooter ( Aspose::Cells::Systems::Int32  section)
pure virtual

Gets a script formatting the first page footer of an Excel file.

Parameters
section

0:Left Section.

1:Center Section

2:Right Section

◆ GetFirstPageHeader()

virtual intrusive_ptr<Aspose::Cells::Systems::String> Aspose::Cells::IPageSetup::GetFirstPageHeader ( Aspose::Cells::Systems::Int32  section)
pure virtual

Gets a script formatting the first page header of an Excel file.

Parameters
section

0:Left Section.

1:Center Section

2:Right Section

◆ GetFirstPageNumber()

virtual Aspose::Cells::Systems::Int32 Aspose::Cells::IPageSetup::GetFirstPageNumber ( )
pure virtual

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

◆ GetFitToPagesTall()

virtual Aspose::Cells::Systems::Int32 Aspose::Cells::IPageSetup::GetFitToPagesTall ( )
pure virtual

Represents the number of pages tall the worksheet will be scaled to when it's printed. The default value is 1.

You have to set FitToPagesWide as zero if you want to fit all rows on one page.

◆ GetFitToPagesWide()

virtual Aspose::Cells::Systems::Int32 Aspose::Cells::IPageSetup::GetFitToPagesWide ( )
pure virtual

Represents the number of pages wide the worksheet will be scaled to when it's printed. The default value is 1.

You have to set FitToPagesTall as zero if you want to fit all columns on one page.

◆ GetFooter()

virtual intrusive_ptr<Aspose::Cells::Systems::String> Aspose::Cells::IPageSetup::GetFooter ( Aspose::Cells::Systems::Int32  section)
pure virtual

Gets a script formatting the footer of an Excel file.

Parameters
section

0:Left Section.

1:Center Section

2:Right Section

◆ GetFooterMargin()

virtual Aspose::Cells::Systems::Double Aspose::Cells::IPageSetup::GetFooterMargin ( )
pure virtual

Represents the distance from the bottom of the page to the footer, in unit of centimeters.

◆ GetFooterMarginInch()

virtual Aspose::Cells::Systems::Double Aspose::Cells::IPageSetup::GetFooterMarginInch ( )
pure virtual

Represents the distance from the bottom of the page to the footer, in unit of inches.

◆ GetHeader()

virtual intrusive_ptr<Aspose::Cells::Systems::String> Aspose::Cells::IPageSetup::GetHeader ( Aspose::Cells::Systems::Int32  section)
pure virtual

Gets a script formatting the header of an Excel file.

Parameters
section

0:Left Section.

1:Center Section

2:Right Section

◆ GetHeaderMargin()

virtual Aspose::Cells::Systems::Double Aspose::Cells::IPageSetup::GetHeaderMargin ( )
pure virtual

Represents the distance from the top of the page to the header, in unit of centimeters.

◆ GetHeaderMarginInch()

virtual Aspose::Cells::Systems::Double Aspose::Cells::IPageSetup::GetHeaderMarginInch ( )
pure virtual

Represents the distance from the top of the page to the header, in unit of inches.

◆ GetIHeaderFooterCommand()

virtual intrusive_ptr<Aspose::Cells::Systems::Array1D<Aspose::Cells::IHeaderFooterCommand*> > Aspose::Cells::IPageSetup::GetIHeaderFooterCommand ( intrusive_ptr< Aspose::Cells::Systems::String >  headerFooterScript)
pure virtual

Gets all commands of header or footer.

Parameters
headerFooterScriptThe header/footer script
Returns
Returns all commands of header or footer.

◆ GetIPicture() [1/2]

virtual intrusive_ptr<Aspose::Cells::Drawing::IPicture> Aspose::Cells::IPageSetup::GetIPicture ( bool  isHeader,
Aspose::Cells::Systems::Int32  section 
)
pure virtual

Gets the IPicture object of the header / footer.

Parameters
isHeaderIndicates whether it is in the header or footer.
section

0:Left Section.

1:Center Section

2:Right Section

Returns
Returns IPicture object. Returns null if there is no picture.

◆ GetIPicture() [2/2]

virtual intrusive_ptr<Aspose::Cells::Drawing::IPicture> Aspose::Cells::IPageSetup::GetIPicture ( bool  isFirst,
bool  isEven,
bool  isHeader,
Aspose::Cells::Systems::Int32  section 
)
pure virtual

Gets the IPicture object of the header / footer.

Parameters
isFirstIndicates whether getting the picture of first page header/footer.
isEvenIndicates whether getting the picture of even page header/footer.
isHeaderIndicates whether getting the picture of header/footer.
section

0:Left Section.

1:Center Section

2:Right Section

Returns
Returns IPicture object.

◆ GetLeftMargin()

virtual Aspose::Cells::Systems::Double Aspose::Cells::IPageSetup::GetLeftMargin ( )
pure virtual

Represents the size of the left margin, in unit of centimeters.

◆ GetLeftMarginInch()

virtual Aspose::Cells::Systems::Double Aspose::Cells::IPageSetup::GetLeftMarginInch ( )
pure virtual

Represents the size of the left margin, in unit of inches.

◆ GetOrder()

virtual Aspose::Cells::PrintOrderType Aspose::Cells::IPageSetup::GetOrder ( )
pure virtual

Represents the order that Microsoft Excel uses to number pages when printing a large worksheet.

◆ GetOrientation()

virtual Aspose::Cells::PageOrientationType Aspose::Cells::IPageSetup::GetOrientation ( )
pure virtual

Represents page print orientation.

◆ GetPaperHeight()

virtual Aspose::Cells::Systems::Double Aspose::Cells::IPageSetup::GetPaperHeight ( )
pure virtual

Gets the height of the paper in unit of inches , considered page orientation.

◆ GetPaperSize()

virtual Aspose::Cells::PaperSizeType Aspose::Cells::IPageSetup::GetPaperSize ( )
pure virtual

Represents the size of the paper.

◆ GetPaperWidth()

virtual Aspose::Cells::Systems::Double Aspose::Cells::IPageSetup::GetPaperWidth ( )
pure virtual

Gets the width of the paper in unit of inches, considered page orientation.

◆ GetPrintArea()

virtual intrusive_ptr<Aspose::Cells::Systems::String> Aspose::Cells::IPageSetup::GetPrintArea ( )
pure virtual

Represents the range to be printed.

◆ GetPrintComments()

virtual Aspose::Cells::PrintCommentsType Aspose::Cells::IPageSetup::GetPrintComments ( )
pure virtual

Represents the way comments are printed with the sheet.

◆ GetPrintCopies()

virtual Aspose::Cells::Systems::Int32 Aspose::Cells::IPageSetup::GetPrintCopies ( )
pure virtual

Get number of copies to print.

◆ GetPrintDraft()

virtual bool Aspose::Cells::IPageSetup::GetPrintDraft ( )
pure virtual

Represents if the sheet will be printed without graphics.

◆ GetPrintErrors()

virtual Aspose::Cells::PrintErrorsType Aspose::Cells::IPageSetup::GetPrintErrors ( )
pure virtual

Specifies the type of print error displayed.

◆ GetPrinterSettings()

virtual intrusive_ptr<Aspose::Cells::Systems::Array1D<Aspose::Cells::Systems::Byte> > Aspose::Cells::IPageSetup::GetPrinterSettings ( )
pure virtual

Gets the settings of the default printer.

◆ GetPrintGridlines()

virtual bool Aspose::Cells::IPageSetup::GetPrintGridlines ( )
pure virtual

Represents if cell gridlines are printed on the page.

◆ GetPrintHeadings()

virtual bool Aspose::Cells::IPageSetup::GetPrintHeadings ( )
pure virtual

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

◆ GetPrintQuality()

virtual Aspose::Cells::Systems::Int32 Aspose::Cells::IPageSetup::GetPrintQuality ( )
pure virtual

Represents the print quality.

◆ GetPrintTitleColumns()

virtual intrusive_ptr<Aspose::Cells::Systems::String> Aspose::Cells::IPageSetup::GetPrintTitleColumns ( )
pure virtual

Represents the columns that contain the cells to be repeated on the left side of each page.

[C++]
intrusive_ptr<Aspose::Cells::Systems::String> sColumns = sheet->GetIPageSetup()->GetPrintTitleColumns();

◆ GetPrintTitleRows()

virtual intrusive_ptr<Aspose::Cells::Systems::String> Aspose::Cells::IPageSetup::GetPrintTitleRows ( )
pure virtual

Represents the rows that contain the cells to be repeated at the top of each page.

[C++]
intrusive_ptr<Aspose::Cells::Systems::String> sRows = sheet->GetIPageSetup()->GetPrintTitleRows();

◆ GetRightMargin()

virtual Aspose::Cells::Systems::Double Aspose::Cells::IPageSetup::GetRightMargin ( )
pure virtual

Represents the size of the right margin, in unit of centimeters.

◆ GetRightMarginInch()

virtual Aspose::Cells::Systems::Double Aspose::Cells::IPageSetup::GetRightMarginInch ( )
pure virtual

Represents the size of the right margin, in unit of inches.

◆ GetTopMargin()

virtual Aspose::Cells::Systems::Double Aspose::Cells::IPageSetup::GetTopMargin ( )
pure virtual

Represents the size of the top margin, in unit of centimeters.

◆ GetTopMarginInch()

virtual Aspose::Cells::Systems::Double Aspose::Cells::IPageSetup::GetTopMarginInch ( )
pure virtual

Represents the size of the top margin, in unit of inches.

◆ GetZoom()

virtual Aspose::Cells::Systems::Int32 Aspose::Cells::IPageSetup::GetZoom ( )
pure virtual

Represents the scaling factor in percent. It should be between 10 and 400.

◆ IsAutoFirstPageNumber()

virtual bool Aspose::Cells::IPageSetup::IsAutoFirstPageNumber ( )
pure virtual

Indicates whether the first the page number is automatically assigned.

◆ IsAutomaticPaperSize()

virtual bool Aspose::Cells::IPageSetup::IsAutomaticPaperSize ( )
pure virtual

Indicates whether the paper size is automatic.

◆ IsHFAlignMargins()

virtual bool Aspose::Cells::IPageSetup::IsHFAlignMargins ( )
pure virtual

Indicates whether header and footer margins are aligned with the page margins. Only applies for Excel 2007.

◆ IsHFDiffFirst()

virtual bool Aspose::Cells::IPageSetup::IsHFDiffFirst ( )
pure virtual

True means that the header/footer of the first page is different with other pages.

◆ IsHFDiffOddEven()

virtual bool Aspose::Cells::IPageSetup::IsHFDiffOddEven ( )
pure virtual

True means that the header/footer of the odd pages is different with odd pages.

◆ IsHFScaleWithDoc()

virtual bool Aspose::Cells::IPageSetup::IsHFScaleWithDoc ( )
pure virtual

Indicates whether header and footer are scaled with document scaling. Only applies for Excel 2007.

◆ IsPercentScale()

virtual bool Aspose::Cells::IPageSetup::IsPercentScale ( )
pure virtual

If this property is False, the GetFitToPagesWide() and GetFitToPagesTall() methods control how the worksheet is scaled.

◆ SetAutoFirstPageNumber()

virtual void Aspose::Cells::IPageSetup::SetAutoFirstPageNumber ( bool  value)
pure virtual

Indicates whether the first the page number is automatically assigned.

◆ SetBlackAndWhite()

virtual void Aspose::Cells::IPageSetup::SetBlackAndWhite ( bool  value)
pure virtual

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

◆ SetBottomMargin()

virtual void Aspose::Cells::IPageSetup::SetBottomMargin ( Aspose::Cells::Systems::Double  value)
pure virtual

Represents the size of the bottom margin, in unit of centimeters.

◆ SetBottomMarginInch()

virtual void Aspose::Cells::IPageSetup::SetBottomMarginInch ( Aspose::Cells::Systems::Double  value)
pure virtual

Represents the size of the bottom margin, in unit of inches.

◆ SetCenterHorizontally()

virtual void Aspose::Cells::IPageSetup::SetCenterHorizontally ( bool  value)
pure virtual

Represent if the sheet is printed centered horizontally.

◆ SetCenterVertically()

virtual void Aspose::Cells::IPageSetup::SetCenterVertically ( bool  value)
pure virtual

Represent if the sheet is printed centered vertically.

◆ SetEvenFooter()

virtual void Aspose::Cells::IPageSetup::SetEvenFooter ( Aspose::Cells::Systems::Int32  section,
intrusive_ptr< Aspose::Cells::Systems::String >  footerScript 
)
pure virtual

Sets a script formatting the even page footer of an Excel file. Only effect in Excel 2007 when IsHFDiffOddEven() is true.

Parameters
section

0:Left Section.

1:Center Section

2:Right Section

Parameters
footerScriptFooter format script.

◆ SetEvenHeader()

virtual void Aspose::Cells::IPageSetup::SetEvenHeader ( Aspose::Cells::Systems::Int32  section,
intrusive_ptr< Aspose::Cells::Systems::String >  headerScript 
)
pure virtual

Sets a script formatting the even page header of an Excel file. Only effect in Excel 2007 when IsHFDiffOddEven() is true.

Parameters
section

0:Left Section.

1:Center Section

2:Right Section

Parameters
headerScriptHeader format script.

◆ SetFirstPageFooter()

virtual void Aspose::Cells::IPageSetup::SetFirstPageFooter ( Aspose::Cells::Systems::Int32  section,
intrusive_ptr< Aspose::Cells::Systems::String >  footerScript 
)
pure virtual

Sets a script formatting the first page footer of an Excel file.

Parameters
section

0:Left Section.

1:Center Section

2:Right Section

Parameters
footerScriptFooter format script.

◆ SetFirstPageHeader()

virtual void Aspose::Cells::IPageSetup::SetFirstPageHeader ( Aspose::Cells::Systems::Int32  section,
intrusive_ptr< Aspose::Cells::Systems::String >  headerScript 
)
pure virtual

Sets a script formatting the first page header of an Excel file. Only effect in Excel 2007 when IsHFDiffFirst is true.

Parameters
section

0:Left Section.

1:Center Section

2:Right Section

Parameters
headerScriptHeader format script.

◆ SetFirstPageNumber()

virtual void Aspose::Cells::IPageSetup::SetFirstPageNumber ( Aspose::Cells::Systems::Int32  value)
pure virtual

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

◆ SetFitToPages()

virtual void Aspose::Cells::IPageSetup::SetFitToPages ( Aspose::Cells::Systems::Int32  wide,
Aspose::Cells::Systems::Int32  tall 
)
pure virtual

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

Parameters
widePages wide.
tallPages tall.

◆ SetFitToPagesTall()

virtual void Aspose::Cells::IPageSetup::SetFitToPagesTall ( Aspose::Cells::Systems::Int32  value)
pure virtual

Represents the number of pages tall the worksheet will be scaled to when it's printed. The default value is 1.

You have to set FitToPagesWide as zero if you want to fit all rows on one page.

◆ SetFitToPagesWide()

virtual void Aspose::Cells::IPageSetup::SetFitToPagesWide ( Aspose::Cells::Systems::Int32  value)
pure virtual

Represents the number of pages wide the worksheet will be scaled to when it's printed. The default value is 1.

You have to set FitToPagesTall as zero if you want to fit all columns on one page.

◆ SetFooter()

virtual void Aspose::Cells::IPageSetup::SetFooter ( Aspose::Cells::Systems::Int32  section,
intrusive_ptr< Aspose::Cells::Systems::String >  footerScript 
)
pure virtual

Sets a script formatting the footer of an Excel file.

Parameters
section

0:Left Section.

1:Center Section

2:Right Section

◆ SetFooterIPicture()

virtual intrusive_ptr<Aspose::Cells::Drawing::IPicture> Aspose::Cells::IPageSetup::SetFooterIPicture ( Aspose::Cells::Systems::Int32  section,
intrusive_ptr< Aspose::Cells::Systems::Array1D< Aspose::Cells::Systems::Byte >>  footerPicture 
)
pure virtual

Sets an image in the footer of a worksheet.

Parameters
section

0:Left Section.

1:Center Section

2:Right Section

Parameters
footerPictureImage data.
Returns
Returns IPicture object.

◆ SetFooterMargin()

virtual void Aspose::Cells::IPageSetup::SetFooterMargin ( Aspose::Cells::Systems::Double  value)
pure virtual

Represents the distance from the bottom of the page to the footer, in unit of centimeters.

◆ SetFooterMarginInch()

virtual void Aspose::Cells::IPageSetup::SetFooterMarginInch ( Aspose::Cells::Systems::Double  value)
pure virtual

Represents the distance from the bottom of the page to the footer, in unit of inches.

◆ SetHeader()

virtual void Aspose::Cells::IPageSetup::SetHeader ( Aspose::Cells::Systems::Int32  section,
intrusive_ptr< Aspose::Cells::Systems::String >  headerScript 
)
pure virtual

Sets a script formatting the header of an Excel file.

Parameters
section

0:Left Section.

1:Center Section

2:Right Section

Parameters
headerScriptHeader format script.

Script commands:

<font color="gray">Command </font>

<td width="75%" ><font color="gray" ><b>Description</b>

</font>

P

Current page number

N

Page count

D

Current date

T

Current time

A

Sheet name

F

File name without path

"FontName"

Font name, for example: "Arial"

"FontName, FontStyle"

Font name and font style, for example: "Arial,Bold"

FontSize

Font size. If this command is followed by a plain number to be printed in the header, it will be separated from the font height with a space character.

"K"

Font color, for example(RED): FF0000

G

Image script

For example: "Arial,Bold8Header Note"

◆ SetHeaderIPicture()

virtual intrusive_ptr<Aspose::Cells::Drawing::IPicture> Aspose::Cells::IPageSetup::SetHeaderIPicture ( Aspose::Cells::Systems::Int32  section,
intrusive_ptr< Aspose::Cells::Systems::Array1D< Aspose::Cells::Systems::Byte >>  headerPicture 
)
pure virtual

Sets an image in the header of a worksheet.

Parameters
section

0:Left Section.

1:Center Section

2:Right Section

Parameters
headerPictureImage data.
Returns
Returns IPicture object.

◆ SetHeaderMargin()

virtual void Aspose::Cells::IPageSetup::SetHeaderMargin ( Aspose::Cells::Systems::Double  value)
pure virtual

Represents the distance from the top of the page to the header, in unit of centimeters.

◆ SetHeaderMarginInch()

virtual void Aspose::Cells::IPageSetup::SetHeaderMarginInch ( Aspose::Cells::Systems::Double  value)
pure virtual

Represents the distance from the top of the page to the header, in unit of inches.

◆ SetHFAlignMargins()

virtual void Aspose::Cells::IPageSetup::SetHFAlignMargins ( bool  value)
pure virtual

Indicates whether header and footer margins are aligned with the page margins. Only applies for Excel 2007.

◆ SetHFDiffFirst()

virtual void Aspose::Cells::IPageSetup::SetHFDiffFirst ( bool  value)
pure virtual

True means that the header/footer of the first page is different with other pages.

◆ SetHFDiffOddEven()

virtual void Aspose::Cells::IPageSetup::SetHFDiffOddEven ( bool  value)
pure virtual

True means that the header/footer of the odd pages is different with odd pages.

◆ SetHFScaleWithDoc()

virtual void Aspose::Cells::IPageSetup::SetHFScaleWithDoc ( bool  value)
pure virtual

Indicates whether header and footer are scaled with document scaling. Only applies for Excel 2007.

◆ SetIPicture()

virtual intrusive_ptr<Aspose::Cells::Drawing::IPicture> Aspose::Cells::IPageSetup::SetIPicture ( bool  isFirst,
bool  isEven,
bool  isHeader,
Aspose::Cells::Systems::Int32  section,
intrusive_ptr< Aspose::Cells::Systems::Array1D< Aspose::Cells::Systems::Byte >>  imageData 
)
pure virtual

Sets an image in the header/footer of a worksheet.

Parameters
isFirstIndicates whether setting the picture of first page header/footer.
isEvenIndicates whether setting the picture of even page header/footer.
isHeaderIndicates whether setting the picture of header/footer.
section

0:Left Section.

1:Center Section

2:Right Section

Parameters
imageDataImage data.
Returns
Returns IPicture object.

◆ SetLeftMargin()

virtual void Aspose::Cells::IPageSetup::SetLeftMargin ( Aspose::Cells::Systems::Double  value)
pure virtual

Represents the size of the left margin, in unit of centimeters.

◆ SetLeftMarginInch()

virtual void Aspose::Cells::IPageSetup::SetLeftMarginInch ( Aspose::Cells::Systems::Double  value)
pure virtual

Represents the size of the left margin, in unit of inches.

◆ SetOrder()

virtual void Aspose::Cells::IPageSetup::SetOrder ( Aspose::Cells::PrintOrderType  value)
pure virtual

Represents the order that Microsoft Excel uses to number pages when printing a large worksheet.

◆ SetOrientation()

virtual void Aspose::Cells::IPageSetup::SetOrientation ( Aspose::Cells::PageOrientationType  value)
pure virtual

Represents page print orientation.

◆ SetPaperSize()

virtual void Aspose::Cells::IPageSetup::SetPaperSize ( Aspose::Cells::PaperSizeType  value)
pure virtual

Represents the size of the paper.

◆ SetPercentScale()

virtual void Aspose::Cells::IPageSetup::SetPercentScale ( bool  value)
pure virtual

If this property is False, the GetFitToPagesWide() and GetFitToPagesTall() methods control how the worksheet is scaled.

◆ SetPrintArea()

virtual void Aspose::Cells::IPageSetup::SetPrintArea ( intrusive_ptr< Aspose::Cells::Systems::String >  value)
pure virtual

Represents the range to be printed.

◆ SetPrintComments()

virtual void Aspose::Cells::IPageSetup::SetPrintComments ( Aspose::Cells::PrintCommentsType  value)
pure virtual

Represents the way comments are printed with the sheet.

◆ SetPrintCopies()

virtual void Aspose::Cells::IPageSetup::SetPrintCopies ( Aspose::Cells::Systems::Int32  value)
pure virtual

Sets number of copies to print.

◆ SetPrintDraft()

virtual void Aspose::Cells::IPageSetup::SetPrintDraft ( bool  value)
pure virtual

Represents if the sheet will be printed without graphics.

◆ SetPrintErrors()

virtual void Aspose::Cells::IPageSetup::SetPrintErrors ( Aspose::Cells::PrintErrorsType  value)
pure virtual

Specifies the type of print error displayed.

◆ SetPrinterSettings()

virtual void Aspose::Cells::IPageSetup::SetPrinterSettings ( intrusive_ptr< Aspose::Cells::Systems::Array1D< Aspose::Cells::Systems::Byte >>  value)
pure virtual

Sets the settings of the default printer.

◆ SetPrintGridlines()

virtual void Aspose::Cells::IPageSetup::SetPrintGridlines ( bool  value)
pure virtual

Represents if cell gridlines are printed on the page.

◆ SetPrintHeadings()

virtual void Aspose::Cells::IPageSetup::SetPrintHeadings ( bool  value)
pure virtual

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

◆ SetPrintQuality()

virtual void Aspose::Cells::IPageSetup::SetPrintQuality ( Aspose::Cells::Systems::Int32  value)
pure virtual

Represents the print quality.

◆ SetPrintTitleColumns()

virtual void Aspose::Cells::IPageSetup::SetPrintTitleColumns ( intrusive_ptr< Aspose::Cells::Systems::String >  value)
pure virtual

Represents the columns that contain the cells to be repeated on the left side of each page.

[C++]
sheet->GetIPageSetup()->SetPrintTitleColumns(new String("$A:$A"));

◆ SetPrintTitleRows()

virtual void Aspose::Cells::IPageSetup::SetPrintTitleRows ( intrusive_ptr< Aspose::Cells::Systems::String >  value)
pure virtual

Represents the rows that contain the cells to be repeated at the top of each page.

[C++]
sheet->GetIPageSetup()->SetPrintTitleRows(new String("$1:$1"));

◆ SetRightMargin()

virtual void Aspose::Cells::IPageSetup::SetRightMargin ( Aspose::Cells::Systems::Double  value)
pure virtual

Represents the size of the right margin, in unit of centimeters.

◆ SetRightMarginInch()

virtual void Aspose::Cells::IPageSetup::SetRightMarginInch ( Aspose::Cells::Systems::Double  value)
pure virtual

Represents the size of the right margin, in unit of inches.

◆ SetTopMargin()

virtual void Aspose::Cells::IPageSetup::SetTopMargin ( Aspose::Cells::Systems::Double  value)
pure virtual

Represents the size of the top margin, in unit of centimeters.

◆ SetTopMarginInch()

virtual void Aspose::Cells::IPageSetup::SetTopMarginInch ( Aspose::Cells::Systems::Double  value)
pure virtual

Represents the size of the top margin, in unit of inches.

◆ SetZoom()

virtual void Aspose::Cells::IPageSetup::SetZoom ( Aspose::Cells::Systems::Int32  value)
pure virtual

Represents the scaling factor in percent. It should be between 10 and 400.