Skip to main content

GetDescription

Returns the document description.

Syntax​

expression.GetDescription();

expression - A variable that represents a ApiCore class.

Parameters​

This method doesn't have any parameters.

Returns​

string

Example​

Set and get the description of the current presentation using the core properties in a presentation.

// How do I get the description in a presentation?

// Get the description using a core properties object in a presentation.

const presentation = Api.GetPresentation();
const core = presentation.GetCore();
core.SetDescription("This is a sample presentation made to help fellow users understand how to use the ApiCore methods.");

const fill = Api.CreateSolidFill(Api.RGB(100, 150, 200));
const stroke = Api.CreateStroke(0, Api.CreateNoFill());
const shape = Api.CreateShape("rect", 150 * 36000, 150 * 36000, fill, stroke);

const description = core.GetDescription();
const paragraph = shape.GetDocContent().GetElement(0);
paragraph.AddText("Description: " + description);

const slide = presentation.GetSlideByIndex(0);
slide.RemoveAllObjects();
slide.AddObject(shape);