AddField
Adds a field to the specified range by the field instruction code.
note
This method removes text within a range.
Syntax
expression.AddField(sCode);
expression - A variable that represents an ApiRange class.
Parameters
| Name | Required/Optional | Data type | Default | Description |
|---|---|---|---|---|
| sCode | Required | string | The field instruction code. |
Returns
boolean
Example
Replace a text selection with an automatically updated field in a document.
// How do I insert a dynamic field that replaces existing text in a document?
// Swap out a passage for a field that updates its value automatically in a document.
let doc = Api.GetDocument();
let paragraph = doc.GetElement(0);
paragraph.AddText("This text for time field");
let range = paragraph.GetRange();
range.AddField('TIME \\@ "dddd, MMMM d, yyyy"');
paragraph = Api.CreateParagraph();
paragraph.AddText("The text within range was replaced by field with TIME instruction field.");
doc.Push(paragraph);