Skip to main content

GetFullName

Returns the full name of the currently opened file.

Syntax​

expression.GetFullName();

expression - A variable that represents a Api class.

Parameters​

This method doesn't have any parameters.

Returns​

string

Example​

Retrieve the document file name and display it in a PDF.

// How do I get the file name of a PDF?

// Fetch the document name and insert it as text in a PDF.

const doc = Api.GetDocument();
const page = doc.GetPage(0);

const gs1 = Api.CreateGradientStop(Api.RGB(255, 213, 191), 0);
const gs2 = Api.CreateGradientStop(Api.RGB(255, 111, 61), 100000);
const fill = Api.CreateRadialGradientFill([gs1, gs2]);
const stroke = Api.CreateStroke(0, Api.CreateNoFill());
const shape = Api.CreateShape("flowChartMagneticTape", 150 * 36000, 65 * 36000, fill, stroke);
shape.SetPosition(608400, 1267200);
const docContent = shape.GetContent();
const paragraph = docContent.GetElement(0);
const fullName = Api.GetFullName();
paragraph.AddText("File name: " + fullName);
page.AddObject(shape);