Skip to main content

GetTheme

Returns the theme of the workbook.

Syntax​

expression.GetTheme();

expression - A variable that represents a ApiWorkbook class.

Parameters​

This method doesn't have any parameters.

Returns​

ApiTheme

Example​

Read the active color theme of the workbook and show its name on the sheet in a spreadsheet.

// How do I find out which visual theme is applied to my workbook in a spreadsheet?

// Display the theme name inside a shape that is filled with one of the theme's accent colors in a spreadsheet.

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

const theme = workbook.GetTheme();
const themeName = theme.GetName();

const fill = Api.CreateSolidFill(Api.ThemeColor('accent3'));
const stroke = Api.CreateStroke(0, Api.CreateNoFill());
const shape = worksheet.AddShape(
	'rect',
	Api.MillimetersToEmus(100), Api.MillimetersToEmus(40),
	fill, stroke,
	0, Api.MillimetersToEmus(2), 0, Api.MillimetersToEmus(3)
);

const paragraph = shape.GetContent().GetElement(0);
paragraph.AddText('This shape is filled with the theme color "Accent 3".');
paragraph.AddText('Change the theme to see the fill color of the shape changed accordingly.\n\n');
paragraph.AddText('Workbook theme: ' + themeName);