Skip to main content

GetFormat

Gets the date format of the current form.

Syntax​

expression.GetFormat();

expression - A variable that represents a ApiDateForm class.

Parameters​

This method doesn't have any parameters.

Returns​

string

Example​

Read the date display format from a date form in a document.

// How do I check which date format is applied to a date form in a document?

// Confirm the format after changing it to make sure the update took effect.

let doc = Api.GetDocument();
let dateForm = Api.CreateDateForm({"key": "Nowadays", "tip": "Enter current date", "required": true, "placeholder": "Your date here", "format": "mm.dd.yyyy", "lang": "en-US"});
let paragraph = doc.GetElement(0);
paragraph.AddElement(dateForm);
dateForm.SetFormat("dddd, dd MMMM yyyy");
let format = dateForm.GetFormat();
paragraph = Api.CreateParagraph();
paragraph.AddText("The first date form from this document has format: " + format);
doc.Push(paragraph);