Skip to main content

GetInternalId

Returns an internal id of the current form.

Inherited from ApiFormBase.GetInternalId.

Syntax​

expression.GetInternalId();

expression - A variable that represents an ApiSignatureForm class.

Parameters​

This method doesn't have any parameters.

Returns​

string

Example​

Read the internal identifier of a signature form in a document.

// How do I find the unique internal identifier of a signature form in a document?

// Capture the system-assigned identifier of a signature form in a document.

let doc = Api.GetDocument();
let signatureForm = Api.CreateSignatureForm({"key": "Signature", "tip": "Please sign here", "placeholder": "Signature"});
let paragraph = doc.GetElement(0);
paragraph.AddElement(signatureForm);
let internalId = signatureForm.GetInternalId();
paragraph = Api.CreateParagraph();
paragraph.AddText("Internal id: " + internalId);
doc.Push(paragraph);