setActiveSheet

CONTENTS

LAYOUT AND SETTINGS

TEMPLATES

SAVE

FORMAT CONVERSION

transform

XLSXUTILITIES

INDEXER

indexer

PERFORMANCE

zipStream

CRYPTO

DIGITAL SIGNATURE

sign (XLSX)

setActiveSheet

BASIC / ADVANCED / PREMIUM

Sets the active sheet.

Description

public setActiveSheet($options)

This method sets the internal active sheet.

This internal active sheet is used to add new contents in the chosen sheet. It doesn't change the active sheet value in the worksheet.

Parameters

options

Key	Type	Description
name	string	Sheet name.
position	int	Sheet position. 0 is the first sheet. -1 choose the last sheet.

An existing name or position must be chosen.

Exceptions

The name or the position don't exist.

Code samples

Example #1

require_once 'classes/CreateXlsx.php';

$xlsx = new CreateXlsx();

$xlsx->addSheet();
$xlsx->addSheet(array('name'=> 'Other'));

// this method doesn't change the activeTab in the workbook file. It's used as internal active sheet
$xlsx->setActiveSheet(array('position' => 1));

$content = array(
    'text' => 'Lorem ipsum dolor sit amet',
);
$xlsx->addCell($content, 'A1');

$xlsx->saveXlsx('output');

The resulting XLSX looks like:

Example #2

require_once 'classes/CreateXlsx.php';

$xlsx = new CreateXlsx();

$xlsx->addSheet();
$xlsx->addSheet(array('name'=> 'Other'));

// this method doesn't change the activeTab in the workbook file. It's used as internal active sheet
$xlsx->setActiveSheet(array('name' => 'Other'));

$content = array(
    'text' => 'Lorem ipsum dolor sit amet',
);
$xlsx->addCell($content, 'A1');

$xlsx->saveXlsx('output');

The resulting XLSX looks like:

Release notes

phpxlsx 2.0:
- -1 as position to choose the last sheet.

phpxlsx 1.0:
- new method.