SetName

Sets the name of the current drawing. If another drawing with the same name already exists, that drawing's name will be reset to a default auto-generated name.

Syntax

expression.SetName(name);

expression - A variable that represents a ApiDrawing class.

Parameters

Name	Required/Optional	Data type	Default	Description
name	Required	string		The name which will be set to the current drawing.

Returns

boolean

Example

This example shows how to set the name for a drawing object.

• Code
• Result

const worksheet = Api.GetActiveSheet();

const fill = Api.CreateSolidFill(Api.RGB(80, 120, 160));
const stroke = Api.CreateStroke(0, Api.CreateNoFill());
const drawing = worksheet.AddShape(
	'ellipse',
	Api.MillimetersToEmus(60), Api.MillimetersToEmus(40),
	fill, stroke,
	0, Api.MillimetersToEmus(20),
	0, Api.MillimetersToEmus(30)
);

drawing.SetName('BlueEllipse');
const content = drawing.GetContent();
const paragraph = content.GetElement(0);
paragraph.AddText('Name: ' + drawing.GetName());

worksheet.GetRange('A1').SetValue('Drawing name was set to: ' + drawing.GetName());