Namespace EasyXLS

Class ExcelPageSetup

System.Object
EasyXLS.ExcelPageSetup
public class ExcelPageSetup extends System.Object
This class stores page setup settings like print area, the rows to be repeated at top, columns to be repeated at left, page orientation (portrait, landscape), paper size, scaling factor, fit to pages width/height, paper margins, print order, horizontal and vertical page breaks and other customizations like: print gridlines, print black and white, print draft quality, print row and column headings, print comments.

  • Method Summary

    Modifier and Type
    Method
    Description
    bool
    CenterHorizontally()
    Returns the center horizontally option for the page.
    bool
    CenterVertically()
    Returns the center vertically option for the page.
    System.String
    easy_getColumnsToRepeatAtLeft()
    Returns the columns to repeat at left.
    System.String
    easy_getPrintArea()
    Returns the print area.
    System.String
    easy_getRowsToRepeatAtTop()
    Returns the rows to repeat at top.
    void
    easy_removePrintArea()
    Removes the print area.
    void
    easy_setColumnsToRepeatAtLeft​(int startColumn, int endColumn)
    Sets the columns to repeat at left.
    void
    easy_setColumnsToRepeatAtLeft​(int startColumn, int endColumn, bool isR1C1ReferenceStyle)
    Sets the columns to repeat at left.
    This method is overridden as easy_setColumnsToRepeatAtLeft_2 in COM+ version of EasyXLS.
    void
    easy_setColumnsToRepeatAtLeft​(System.String columnRange)
    Sets the columns to repeat at left.
    This method is overridden as easy_setColumnsToRepeatAtLeft_3 in COM+ version of EasyXLS.
    void
    easy_setPrintArea​(int startRow, int startColumn, int endRow, int endColumn)
    Sets the print area.
    void
    easy_setPrintArea​(int startRow, int startColumn, int endRow, int endColumn, bool isR1C1ReferenceStyle)
    Sets the print area.
    This method is overridden as easy_setPrintArea_2 in COM+ version of EasyXLS.
    void
    easy_setPrintArea​(System.String range)
    Sets the print area.
    This method is overridden as easy_setPrintArea_3 in COM+ version of EasyXLS.
    void
    easy_setRowsToRepeatAtTop​(int startRow, int endRow)
    Sets the rows to repeat at top.
    void
    easy_setRowsToRepeatAtTop​(int startRow, int endRow, bool isR1C1ReferenceStyle)
    Sets the rows to repeat at top.
    This method is overridden as easy_setRowsToRepeatAtTop_2 in COM+ version of EasyXLS.
    void
    easy_setRowsToRepeatAtTop​(System.String rowRange)
    Sets the rows to repeat at top.
    This method is overridden as easy_setRowsToRepeatAtTop_3 in COM+ version of EasyXLS.
    double
    getBottomMargin()
    Returns the bottom margin of the paper.
    int
    getFirstPageNumber()
    Returns the starting page number.
    int
    getFitToPagesHeight()
    Returns the number of pages to fit in the page height.
    int
    getFitToPagesWidth()
    Returns the number of pages to fit in the page width.
    double
    getFooterMargin()
    Returns the footer margin of the paper.
    double
    getHeaderMargin()
    Returns the header margin of the paper.
    double
    getLeftMargin()
    Returns the left margin of the paper.
    System.String
    getOrientation()
    Returns the page orientation.
    int
    getPageOrder()
    Returns the print page order.
    int
    getPaperSize()
    Returns the paper size.
    System.String
    getPrintArea()
    Internal use only
    int
    getPrintComments()
    Returns the print comments option for the page.
    double
    getRightMargin()
    Returns the right margin of the paper.
    int
    getScalingFactor()
    Returns the scaling factor.
    double
    getTopMargin()
    Returns the top margin of the paper.
    bool
    PrintBlackAndWhite()
    Returns the print black and white option for the page.
    bool
    PrintDraftQuality()
    Returns the print draft quality option for the page.
    bool
    PrintGridlines()
    Returns the print gridlines option for the page.
    bool
    PrintRowAndColumnHeadings()
    Returns the print row and column headings option for the page.
    void
    setBottomMargin​(double bottomMargin)
    Sets the bottom margin of the paper.
    void
    setCenterHorizontally​(bool isCenterHorizontally)
    Sets the center horizontally option for the page.
    void
    setCenterVertically​(bool isCenterVertically)
    Sets the center vertically option for the page.
    void
    setFirstPageNumber​(int firstPageNumber)
    Sets the starting page number.
    void
    setFitToPagesHeight​(int value)
    Sets the number of pages to fit in the page height.
    void
    setFitToPagesWidth​(int value)
    Sets the number of pages to fit in the page width.
    void
    setFooterMargin​(double footerMargin)
    Sets the footer margin of the paper.
    void
    setHeaderMargin​(double headerMargin)
    Sets the header margin of the paper.
    void
    setLeftMargin​(double leftMargin)
    Sets the left margin of the paper.
    void
    setOrientation​(System.String orientation)
    Sets the page orientation.
    void
    setPageOrder​(int pageOrder)
    Sets the print page order.
    void
    setPaperSize​(int paperSize)
    Sets the paper size.
    void
    setPrintBlackAndWhite​(bool printBlackAndWhite)
    Sets the print black and white option for the page.
    void
    setPrintComments​(int position)
    Sets the print comments option for the page.
    void
    setPrintDraftQuality​(bool printDraftQuality)
    Sets the print draft quality option for the page.
    void
    setPrintGridlines​(bool printGridlines)
    Sets the print gridlines option for the page.
    void
    setPrintRowAndColumnHeadings​(bool printRowAndColumnHeadings)
    Sets the print row and column headings option for the page.
    void
    setRightMargin​(double rightMargin)
    Sets the right margin of the paper.
    void
    setScalingFactor​(int scalingFactor)
    Sets the scaling factor.
    void
    setTopMargin​(double topMargin)
    Sets the top margin of the paper.

    Methods inherited from class System.Object

    equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait