Tutorial 09: How to set page setup options and page breaks in PHP

How to set page setup options and page breaks in PHP

EasyXLS Excel library can be used to export Excel files with PHP on Windows, Linux, Mac or other operating systems. The integration vary depending on the operating system or if .NET Framework or Java is chosen:

1. EasyXLS on Windows using .NET Framework (COM+) with PHP

2. EasyXLS on Linux, Mac, Windows using Java with PHP

EasyXLS on Windows using .NET Framework (COM+) with PHP

If you opt for the COM+ version of EasyXLS, be sure that you have EasyXLS installed and registered on your machine.

Find more about Getting Started with EasyXLS

Step 1: Download and install EasyXLS Excel Library for COM+

To download the trial version of EasyXLS Excel Library, press the below button:

If you already own a license key, you may login and download EasyXLS from your account.

Step 2: Verify if COM and .NET extension is enabled in PHP

Check PHP.ini for [COM_DOT_NET] extension.

Step 3: Verify if EasyXLS is registered

Check if EasyXLS component is present in Component Services.

Step 4: License file setup

Step required for EasyXLS v9.0 or later.

If you are using a trial, generate a trial license file from EasyXLS trials page. The trial license is valid for 30-days.

If you own a license key, you may login to the account that purchased the license and generate the license file from:
https://www.easyxls.com/my-orders

Setup the license file into your project using these guidelines.

Step 5: Run PHP code for page setup options and page breaks

Execute the following PHP code that exports an Excel file with a specified print area, rows repeated at top, page orientation as portrait, paper size as A4 and other related settings.

View Excel file

Copy code

<?php

/*==========================================================================
| Tutorial 09
|
| This tutorial shows how to create an Excel file in PHP
| having multiple sheets. The first sheet is filled with data  
| and the cells are formatted and locked.
| The column header has comments.
| The first worksheet has header & footer.
| The first worksheet has print area, rows to repeat at top, center on page,
| page orientation, page order, paper size, comments print location,
| print gridlines option and page breaks.
* ========================================================================*/

include("DataType.inc");
include("Alignment.inc");
include("Border.inc");
include("Color.inc");
include("Header.inc");
include("Footer.inc");
include("PageSetup.inc");

header("Content-Type: text/html");

echo "Tutorial 09<br>";
echo "----------<br>";

// Create an instance of the class that exports Excel files
$workbook = new COM("EasyXLS.ExcelDocument");

// Create two sheets
$workbook->easy_addWorksheet_2("First tab");
$workbook->easy_addWorksheet_2("Second tab");

// Protect first sheet
$workbook->easy_getSheetAt(0)->setSheetProtected(true);

// Get the table of data for the first worksheet
$xlsFirstTable = $workbook->easy_getSheetAt(0)->easy_getExcelTable();

// Create the formatting style for the header
$xlsStyleHeader = new COM("EasyXLS.ExcelStyle");
$xlsStyleHeader->setFont("Verdana");
$xlsStyleHeader->setFontSize(8);
$xlsStyleHeader->setItalic(True);
$xlsStyleHeader->setBold(True);
$xlsStyleHeader->setForeground((int)$COLOR_YELLOW);
$xlsStyleHeader->setBackground((int)$COLOR_BLACK);
$xlsStyleHeader->setBorderColors ((int)$COLOR_GRAY, (int)$COLOR_GRAY, (int)$COLOR_GRAY, (int)$COLOR_GRAY);
$xlsStyleHeader->setBorderStyles ($BORDER_BORDER_MEDIUM, $BORDER_BORDER_MEDIUM, 
                                        $BORDER_BORDER_MEDIUM, $BORDER_BORDER_MEDIUM);
$xlsStyleHeader->setHorizontalAlignment($ALIGNMENT_ALIGNMENT_CENTER);
$xlsStyleHeader->setVerticalAlignment($ALIGNMENT_ALIGNMENT_BOTTOM);
$xlsStyleHeader->setWrap(True);
$xlsStyleHeader->setDataType($DATATYPE_STRING);

// Add data in cells for report header
for ($column=0; $column<5; $column++)
{
    $xlsFirstTable->easy_getCell(0,$column)->setValue("Column " . ($column + 1));
    $xlsFirstTable->easy_getCell(0,$column)->setStyle($xlsStyleHeader);

    // Add comment for report header cells
    $xlsFirstTable->easy_getCell(0, $column)->setComment_2("This is column no " . ($column + 1));
}
$xlsFirstTable->easy_getRowAt(0)->setHeight(30);

// Create a formatting style for cells
$xlsStyleData = new COM("EasyXLS.ExcelStyle");
$xlsStyleData->setHorizontalAlignment($ALIGNMENT_ALIGNMENT_LEFT);
$xlsStyleData->setForeground((int)$COLOR_DARKGRAY);
$xlsStyleData->setWrap(false);
// Protect cells
$xlsStyleData->setLocked(true);
$xlsStyleData->setDataType($DATATYPE_STRING);

// Add data in cells for report values
for ($row=0; $row<100; $row++)
{
    for ($column=0; $column<5; $column++)
    {
    $xlsFirstTable->easy_getCell($row+1,$column)->setValue("Data " . ($row + 1) . ", " . ($column + 1));
    $xlsFirstTable->easy_getCell($row+1,$column)->setStyle($xlsStyleData);
    }
}

// Set column widths
$xlsFirstTable->setColumnWidth_2(0, 70);
$xlsFirstTable->setColumnWidth_2(1, 100);
$xlsFirstTable->setColumnWidth_2(2, 70);
$xlsFirstTable->setColumnWidth_2(3, 100);
$xlsFirstTable->setColumnWidth_2(4, 70);

// Add header on center section
$xlsFirstTab = $workbook->easy_getSheetAt(0);
$xlsFirstTab->easy_getHeaderAt_2($HEADER_POSITION_CENTER)->InsertSingleUnderline();
$xlsFirstTab->easy_getHeaderAt_2($HEADER_POSITION_CENTER)->InsertFile();
$xlsFirstTab->easy_getHeaderAt_2($HEADER_POSITION_CENTER)->InsertValue(" - How to create header and footer");

// Add header on right section
$xlsFirstTab->easy_getHeaderAt_2($HEADER_POSITION_RIGHT)->InsertDate();
$xlsFirstTab->easy_getHeaderAt_2($HEADER_POSITION_RIGHT)->InsertValue(" ");
$xlsFirstTab->easy_getHeaderAt_2($HEADER_POSITION_RIGHT)->InsertTime();

// Add footer on center section
$xlsFirstTab->easy_getFooterAt_2($FOOTER_POSITION_CENTER)->InsertPage();
$xlsFirstTab->easy_getFooterAt_2($FOOTER_POSITION_CENTER)->InsertValue(" of ");
$xlsFirstTab->easy_getFooterAt_2($FOOTER_POSITION_CENTER)->InsertPages();

// Get the object that stores the page setup options for the first sheet
$xlsPageSetup = $xlsFirstTab->easy_getPageSetup();
// Set print area
$xlsPageSetup->easy_setPrintArea_3("A1:E101");
// Set the rows to repeat at top
$xlsPageSetup->easy_setRowsToRepeatAtTop_3("$1:$1");
// Set center on page option
$xlsPageSetup->setCenterHorizontally(true);
// Set page orientation
$xlsPageSetup->setOrientation($PAGESETUP_ORIENTATION_PORTRAIT);
// Set page order
$xlsPageSetup->setPageOrder($PAGESETUP_PAGE_ORDER_DOWN_THEN_OVER);
// Set paper size
$xlsPageSetup->setPaperSize($PAGESETUP_PAPER_SIZE_A4);
// Set where the comments to be printed
$xlsPageSetup->setPrintComments($PAGESETUP_COMMENTS_AT_END_OF_SHEET);
// Set the gridlines to be printed
$xlsPageSetup->setPrintGridlines(true);

// Insert page breaks on rows
$xlsFirstTable->easy_insertPageBreakAtRow(21);
$xlsFirstTable->easy_insertPageBreakAtRow(41);
$xlsFirstTable->easy_insertPageBreakAtRow(61);
$xlsFirstTable->easy_insertPageBreakAtRow(81);

// Set page break preview for the sheet
$xlsFirstTab->setPageBreakPreview(true);

// Export Excel file
echo "Writing file: C:\Samples\Tutorial09 - Excel page setup.xlsx<br>";
$workbook->easy_WriteXLSXFile("C:\Samples\Tutorial09 - Excel page setup.xlsx");

// Confirm export of Excel file
    if ($workbook->easy_getError() == "")
echo "File successfully created.";
else
    echo "Error encountered: " . $workbook->easy_getError();

// Dispose memory
$workbook->Dispose();
$workbook = null;
$xlsStyleHeader = null;
$xlsStyleData = null;

?>

Overloaded methods
For methods with same name but different parameters, only the first method overload retains the original name. Subsequent overloads are uniquely renamed by appending to the method name '_2', '_3', etc (method, method_2, method_3), an integer that corresponds to the order of declaration that can be found in EasyXLS.h, a file that comes with EasyXLS installation.

EasyXLS on Linux, Mac, Windows using Java with PHP

If you opt for the Java version of EasyXLS, a similar code as above requires PHP/Java Bridge between PHP and Java.

Find more about Getting Started with EasyXLS

Step 1: Download EasyXLS Excel Library for Java

To download the trial version of EasyXLS Excel Library, press the below button:

If you already own a license key, you may login and download EasyXLS from your account.

Step 2: License file setup

Step 3: Install PHP/Java Bridge

Download PHP/Java Bridge and follow the PHP/Java Bridge installation guide for directions.

Step 4: Setup EasyXLS library in Tomcat

Copy EasyXLS.jar into Tomcat installation path, lib folder.

Step 5: Run PHP code for page setup options and page breaks

Execute the following PHP code that exports an Excel file with a specified print area, rows repeated at top, page orientation as portrait, paper size as A4 and other related settings.

View Excel file

Copy code

<?php require_once("http://localhost:8080/JavaBridge/java/Java.inc");

/*==========================================================================
| Tutorial 09
|
| This tutorial shows how to create an Excel file in PHP
| having multiple sheets. The first sheet is filled with data 
| and the cells are formatted and locked.
| The column header has comments.
| The first worksheet has header & footer.
| The first worksheet has print area, rows to repeat at top, center on page,
| page orientation, page order, paper size, comments print location,
| print gridlines option and page breaks.
==========================================================================*/

include("DataType.inc");
include("Alignment.inc");
include("Border.inc");
include("Color.inc");
include("Header.inc");
include("Footer.inc");
include("PageSetup.inc");

header("Content-Type: text/html");
	
echo "Tutorial 09<br>";
echo "----------<br>";
	
// Create an instance of the class that exports Excel files
$workbook = new java("EasyXLS.ExcelDocument");
	
// Create two sheets
$workbook->easy_addWorksheet("First tab");
$workbook->easy_addWorksheet("Second tab");

// Protect first sheet
$workbook->easy_getSheetAt(0)->setSheetProtected(true);
	
// Get the table of data for the first worksheet
$xlsFirstTable = $workbook->easy_getSheetAt(0)->easy_getExcelTable();

// Create the formatting style for the header
$xlsStyleHeader = new java("EasyXLS.ExcelStyle");
$xlsStyleHeader->setFont("Verdana");
$xlsStyleHeader->setFontSize(8);
$xlsStyleHeader->setItalic(True);
$xlsStyleHeader->setBold(True);
$xlsStyleHeader->setForeground(java("java.awt.Color")->YELLOW);
$xlsStyleHeader->setBackground(java("java.awt.Color")->BLACK);
$xlsStyleHeader->setBorderColors (java("java.awt.Color")->GRAY, java("java.awt.Color")->GRAY,
                                  java("java.awt.Color")->GRAY, java("java.awt.Color")->GRAY);
$xlsStyleHeader->setBorderStyles ($BORDER_BORDER_MEDIUM, $BORDER_BORDER_MEDIUM,
                                  $BORDER_BORDER_MEDIUM, $BORDER_BORDER_MEDIUM);
$xlsStyleHeader->setHorizontalAlignment($ALIGNMENT_ALIGNMENT_CENTER);
$xlsStyleHeader->setVerticalAlignment($ALIGNMENT_ALIGNMENT_BOTTOM);
$xlsStyleHeader->setWrap(True);
$xlsStyleHeader->setDataType($DATATYPE_STRING);
	
// Add data in cells for report header
for ($column=0; $column<5; $column++)
{
    $xlsFirstTable->easy_getCell(0,$column)->setValue("Column " . ($column + 1));
    $xlsFirstTable->easy_getCell(0,$column)->setStyle($xlsStyleHeader);

    // Add comment for report header cells
    $xlsFirstTable->easy_getCell(0, $column)->setComment("This is column no " . ($column + 1));
}
$xlsFirstTable->easy_getRowAt(0)->setHeight(30);
	
// Create a formatting style for cells
$xlsStyleData = new java("EasyXLS.ExcelStyle");
$xlsStyleData->setHorizontalAlignment($ALIGNMENT_ALIGNMENT_LEFT);
$xlsStyleData->setForeground(java("java.awt.Color")->LIGHT_GRAY);
$xlsStyleData->setWrap(false);
// Protect cells
$xlsStyleData->setLocked(true);
$xlsStyleData->setDataType($DATATYPE_STRING);
	
// Add data in cells for report values
for ($row=0; $row<100; $row++)
{
    for ($column=0; $column<5; $column++)
    {
        $xlsFirstTable->easy_getCell($row+1,$column)->setValue("Data " . ($row + 1) .
                                                               ", " . ($column + 1));
        $xlsFirstTable->easy_getCell($row+1,$column)->setStyle($xlsStyleData);
    }
}
	
// Set column widths
$xlsFirstTable->setColumnWidth(0, 70);
$xlsFirstTable->setColumnWidth(1, 100);
$xlsFirstTable->setColumnWidth(2, 70);
$xlsFirstTable->setColumnWidth(3, 100);
$xlsFirstTable->setColumnWidth(4, 70);
	
// Add header on center section
$xlsFirstTab = $workbook->easy_getSheetAt(0);
$xlsFirstTab->easy_getHeaderAt($HEADER_POSITION_CENTER)->InsertSingleUnderline();
$xlsFirstTab->easy_getHeaderAt($HEADER_POSITION_CENTER)->InsertFile();
$xlsFirstTab->easy_getHeaderAt($HEADER_POSITION_CENTER)->InsertValue(" - How to create header and footer");

// Add header on right section
$xlsFirstTab->easy_getHeaderAt($HEADER_POSITION_RIGHT)->InsertDate();
$xlsFirstTab->easy_getHeaderAt($HEADER_POSITION_RIGHT)->InsertValue(" ");
$xlsFirstTab->easy_getHeaderAt($HEADER_POSITION_RIGHT)->InsertTime();

// Add footer on center section
$xlsFirstTab->easy_getFooterAt($FOOTER_POSITION_CENTER)->InsertPage();
$xlsFirstTab->easy_getFooterAt($FOOTER_POSITION_CENTER)->InsertValue(" of ");
$xlsFirstTab->easy_getFooterAt($FOOTER_POSITION_CENTER)->InsertPages();
	
// Get the object that stores the page setup options for the first sheet
$xlsPageSetup = $xlsFirstTab->easy_getPageSetup();
// Set print area
$xlsPageSetup->easy_setPrintArea("A1:E101");
// Set the rows to repeat at top
$xlsPageSetup->easy_setRowsToRepeatAtTop("$1:$1");
// Set center on page option
$xlsPageSetup->setCenterHorizontally(true);
// Set page orientation
$xlsPageSetup->setOrientation($PAGESETUP_ORIENTATION_PORTRAIT);
// Set page order
$xlsPageSetup->setPageOrder($PAGESETUP_PAGE_ORDER_DOWN_THEN_OVER);
// Set paper size
$xlsPageSetup->setPaperSize($PAGESETUP_PAPER_SIZE_A4);
// Set where the comments to be printed
$xlsPageSetup->setPrintComments($PAGESETUP_COMMENTS_AT_END_OF_SHEET);
// Set the gridlines to be printed
$xlsPageSetup->setPrintGridlines(true);
	
// Insert page breaks on rows
$xlsFirstTable->easy_insertPageBreakAtRow(21);
$xlsFirstTable->easy_insertPageBreakAtRow(41);
$xlsFirstTable->easy_insertPageBreakAtRow(61);
$xlsFirstTable->easy_insertPageBreakAtRow(81);
	
// Set page break preview for the sheet
$xlsFirstTab->setPageBreakPreview(true);
	
// Export Excel file
echo "Writing file: C:\Samples\Tutorial09 - Excel page setup.xlsx<br>";
$workbook->easy_WriteXLSXFile("C:\Samples\Tutorial09 - Excel page setup.xlsx");
	
// Confirm export of Excel file
if ($workbook->easy_getError() == "")
    echo "File successfully created.";
else
    echo "Error encountered: " . $workbook->easy_getError();
		
// Dispose memory
$workbook->Dispose();

?>

EasyXLS Excel libraries:
Excel Library for PHP COM+
full COM+ version to import, export or convert Excel files
Excel Writer for PHP COM+
COM+ version to create and export Excel files


Excel Library for PHP Java
full Java version to import, export or convert Excel files
Excel Writer for PHP Java
Java version to create and export Excel files

File formats:
Office 365 MS Excel 2021 - 2024 MS Excel 2007 - 2019 MS Excel 97 - 2003

How to set page setup options and page breaks in PHP

EasyXLS on Windows using .NET Framework (COM+) with PHP

Step 1: Download and install EasyXLS Excel Library for COM+

Step 2: Verify if COM and .NET extension is enabled in PHP

See also

Step 3: Verify if EasyXLS is registered

See also

Step 4: License file setup

Step 5: Run PHP code for page setup options and page breaks

EasyXLS on Linux, Mac, Windows using Java with PHP

Step 1: Download EasyXLS Excel Library for Java

Step 2: License file setup

Step 3: Install PHP/Java Bridge

Step 4: Setup EasyXLS library in Tomcat

Step 5: Run PHP code for page setup options and page breaks

Related sections

See also

Related methods

Related constants

EasyXLS Excel libraries:

File formats: