GetActiveSheet

Returns the active sheet of the workbook.

Syntax

expression.GetActiveSheet();

expression - A variable that represents a ApiWorkbook class.

Parameters

This method doesn't have any parameters.

Returns

ApiWorksheet

Example

This example shows how to get the name of the current workbook (filename)

• Code
• Result

const workbook = Api.GetActiveWorkbook();
const worksheet = workbook.GetActiveSheet();

worksheet.SetName('not-an-easter-egg');
const worksheetName = worksheet.GetName();

const lightGreen = Api.CreateRGBColor(16, 121, 63);
const darkGreen = Api.CreateRGBColor(24, 92, 55);
const fill = Api.CreateSolidFill(lightGreen);
const stroke = Api.CreateStroke(2, Api.CreateSolidFill(darkGreen));
let shape = worksheet.AddShape(
	'rect',
	100 * 36000, 70 * 36000,
	fill, stroke,
	0, 2 * 36000,
	0, 3 * 36000
);
const paragraph = shape.GetContent().GetElement(0);
paragraph.AddText('Active Sheet Name: ' + worksheetName);