appendField method

appendField(fieldType, updateField)

Appends a field to this paragraph.

appendField(fieldType: Aspose.Words.Fields.FieldType, updateField: boolean)
ParameterTypeDescription
fieldTypeFieldTypeThe type of the field to append.
updateFieldbooleanSpecifies whether to update the field immediately.

Returns

A Field object that represents the appended field.

appendField(fieldCode)

Appends a field to this paragraph.

appendField(fieldCode: string)
ParameterTypeDescription
fieldCodestringThe field code to append (without curly braces).

Returns

A Field object that represents the appended field.

appendField(fieldCode, fieldValue)

Appends a field to this paragraph.

appendField(fieldCode: string, fieldValue: string)
ParameterTypeDescription
fieldCodestringThe field code to append (without curly braces).
fieldValuestringThe field value to append. Pass null for fields that do not have a value.

Returns

A Field object that represents the appended field.

Examples

Shows various ways of appending fields to a paragraph.

let doc = new aw.Document();
let paragraph = doc.firstSection.body.firstParagraph;

// Below are three ways of appending a field to the end of a paragraph.
// 1 -  Append a DATE field using a field type, and then update it:
paragraph.appendField(aw.Fields.FieldType.FieldDate, true);

// 2 -  Append a TIME field using a field code: 
paragraph.appendField(" TIME  \\@ \"HH:mm:ss\" ");

// 3 -  Append a QUOTE field using a field code, and get it to display a placeholder value:
paragraph.appendField(" QUOTE \"Real value\"", "Placeholder value");

expect(doc.range.fields.at(2).result).toEqual("Placeholder value");

// This field will display its placeholder value until we update it.
doc.updateFields();

expect(doc.range.fields.at(2).result).toEqual("Real value");

doc.save(base.artifactsDir + "Paragraph.appendField.docx");

See Also