Skip to main content

GetName

Returns the name of the workbook.

Syntax​

expression.GetName();

expression - A variable that represents a ApiWorkbook class.

Parameters​

This method doesn't have any parameters.

Returns​

string

Example​

Get the name of the current workbook (filename) in a spreadsheet.

// How can I get the name using a workbook in a spreadsheet?

// Get the name for a workbook in a spreadsheet.

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

const lightGreen = Api.RGB(16, 121, 63);
const darkGreen = Api.RGB(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('Filename: ' + workbookName);