Skip to main content

DevExpress v24.2 Update — Your Feedback Matters

Our What's New in v24.2 webpage includes product-specific surveys. Your response to our survey questions will help us measure product satisfaction for features released in this major update and help us refine our plans for our next major release.

Take the survey Not interested

UpdateFieldsOptions Class

Contains field update options.

#Declaration

TypeScript
export class UpdateFieldsOptions

#Remarks

var doInAllSubDocuments = true;
var updateTocFields = true;
var options = new DevExpress.RichEdit.UpdateFieldsOptions(doInAllSubDocuments, updateTocFields);
richEdit.document.fields.updateAllFields(function() {
    console.log('Updated');
}, options);

#constructor

Initializes a new instance of the UpdateFieldsOptions class with specified settings.

#Declaration

TypeScript
constructor(
    doInAllSubDocuments?: boolean,
    updateTocFields?: boolean
)

#Parameters

Name Type Description
doInAllSubDocuments boolean

true, to update fields in all sub-documents, false, to update fields in the current sub-document only.

updateTocFields boolean

true, to update TOC fields; otherwise, false.

#Properties

#doInAllSubDocuments Property

Specifies whether to update fields in the current sub-document or in all sub-documents.

#Declaration

TypeScript
doInAllSubDocuments: boolean

#Property Value

Type Description
boolean

true, to update fields in all sub-documents, false, to update fields in the current sub-document only.

#updateTocFields Property

Specifies whether TOC fields should be updated.

#Declaration

TypeScript
updateTocFields: boolean

#Property Value

Type Description
boolean

true, to update TOC fields; otherwise, false.