[Expand]General Information
[Expand]WinForms Controls
[Collapse]ASP.NET Controls and MVC Extensions
 [Expand]Prerequisites
 [Expand]What's Installed
 [Expand]Common Concepts
 [Expand]ASP.NET WebForms Controls
 [Expand]ASP.NET MVC Extensions
 [Expand]Localization
 [Expand]Redistribution and Deployment
  Get More Help
 [Collapse]API Reference
  [Expand]DevExpress.Data.Linq
  [Expand]DevExpress.Web
  [Expand]DevExpress.Web.ASPxGauges
  [Expand]DevExpress.Web.ASPxGauges.Base
  [Expand]DevExpress.Web.ASPxGauges.Scripts
  [Expand]DevExpress.Web.ASPxHtmlEditor
  [Expand]DevExpress.Web.ASPxHtmlEditor.Localization
  [Expand]DevExpress.Web.ASPxHtmlEditor.Scripts
  [Expand]DevExpress.Web.ASPxPivotGrid
  [Expand]DevExpress.Web.ASPxPivotGrid.Data
  [Expand]DevExpress.Web.ASPxPivotGrid.HtmlControls
  [Expand]DevExpress.Web.ASPxPivotGrid.Scripts
  [Collapse]DevExpress.Web.ASPxRichEdit
   [Collapse]ASPxRichEdit Class
     ASPxRichEdit Members
     ASPxRichEdit Constructor
    [Expand]ASPxRichEdit Properties
    [Collapse]ASPxRichEdit Events
      CalculateDocumentVariable Event
      Callback Event
      CustomizeMergeFields Event
      CustomJSProperties Event
      DocumentSelectorCloudProviderRequest Event
      DocumentSelectorFileUploading Event
      DocumentSelectorFolderCreating Event
      DocumentSelectorItemCopying Event
      DocumentSelectorItemDeleting Event
      DocumentSelectorItemMoving Event
      DocumentSelectorItemRenaming Event
      Saving Event
      SpellCheckerWordAdded Event
    [Expand]ASPxRichEdit Methods
   [Expand]ASPxRichEditAuthenticationSettings Class
   [Expand]ASPxRichEditAutoCorrectReplaceInfo Class
   [Expand]ASPxRichEditAutoCorrectReplaceInfoCollection Class
   [Expand]ASPxRichEditAutoCorrectReplaceInfoCollectionSettings Class
   [Expand]ASPxRichEditAutoCorrectSettings Class
   [Expand]ASPxRichEditBehaviorSettings Class
   [Expand]ASPxRichEditBookmarkSettings Class
   [Expand]ASPxRichEditCharacterFormattingDetailedSettings Class
   [Expand]ASPxRichEditDocumentCapabilitiesSettings Class
   [Expand]ASPxRichEditFieldsSettings Class
   [Expand]ASPxRichEditHorizontalRulerSettings Class
   [Expand]ASPxRichEditNumberingSettings Class
   [Expand]ASPxRichEditOptionsSpelling Class
   [Expand]ASPxRichEditRangePermissionSettings Class
   [Expand]ASPxRichEditSettings Class
   [Expand]ASPxRichEditSettingsBase Class
   [Expand]ASPxRichEditSpellCheckerSettings Class
   [Expand]RichEditClientSideEvents Class
   [Expand]RichEditDialogSettings Class
   [Expand]RichEditDocumentSelectorCommonSettings Class
   [Expand]RichEditDocumentSelectorSettings Class
   [Expand]RichEditDocumentSelectorUploadSettings Class
   [Expand]RichEditFileManager Class
   [Expand]RichEditFileManagerCommonSettings Class
   [Expand]RichEditFileManagerEditingSettings Class
   [Expand]RichEditFileManagerFoldersSettings Class
   [Expand]RichEditFileManagerStyles Class
   [Expand]RichEditFileManagerValidationSettings Class
   [Expand]RichEditFolderManager Class
   [Expand]RichEditImages Class
   [Expand]RichEditInsertLinkDialogSettings Class
   [Expand]RichEditInsertPictureDialogSettings Class
   [Expand]RichEditPopupMenuItem Class
   [Expand]RichEditPopupMenuItemCollection Class
   [Expand]RichEditRibbonContextTabCategoryCollection Class
    RichEditRibbonMode Enumeration
   [Expand]RichEditRibbonTabCollection Class
   [Expand]RichEditRulerImages Class
   [Expand]RichEditSaveFileDialogSettings Class
    RichEditUnit Enumeration
    SaveFileDialogDisplaySectionMode Enumeration
  [Expand]DevExpress.Web.ASPxRichEdit.Localization
  [Expand]DevExpress.Web.ASPxRichEdit.Scripts
  [Expand]DevExpress.Web.ASPxScheduler
  [Expand]DevExpress.Web.ASPxScheduler.Commands
  [Expand]DevExpress.Web.ASPxScheduler.Commands.Dialogs
  [Expand]DevExpress.Web.ASPxScheduler.Controls
  [Expand]DevExpress.Web.ASPxScheduler.Dialogs
  [Expand]DevExpress.Web.ASPxScheduler.Drawing
  [Expand]DevExpress.Web.ASPxScheduler.Localization
  [Expand]DevExpress.Web.ASPxScheduler.Reporting
  [Expand]DevExpress.Web.ASPxScheduler.Scripts
  [Expand]DevExpress.Web.ASPxSpellChecker
  [Expand]DevExpress.Web.ASPxSpellChecker.Localization
  [Expand]DevExpress.Web.ASPxSpellChecker.Scripts
  [Expand]DevExpress.Web.ASPxSpreadsheet
  [Expand]DevExpress.Web.ASPxSpreadsheet.Localization
  [Expand]DevExpress.Web.ASPxSpreadsheet.Scripts
  [Expand]DevExpress.Web.ASPxTreeList
  [Expand]DevExpress.Web.ASPxTreeList.Internal
  [Expand]DevExpress.Web.ASPxTreeList.Localization
  [Expand]DevExpress.Web.ASPxTreeList.Scripts
  [Expand]DevExpress.Web.Captcha
  [Expand]DevExpress.Web.Data
  [Expand]DevExpress.Web.Internal
  [Expand]DevExpress.Web.Localization
  [Expand]DevExpress.Web.Mvc
  [Expand]DevExpress.Web.Mvc.BinderSettings
  [Expand]DevExpress.Web.Mvc.Controllers
  [Expand]DevExpress.Web.MVC.Scripts
  [Expand]DevExpress.Web.Mvc.UI
  [Expand]DevExpress.Web.Office
  [Expand]DevExpress.Web.Office.Internal
  [Expand]DevExpress.Web.Rendering
  [Expand]DevExpress.Web.Scripts
  [Expand]DevExpress.XtraCharts.Web
  [Expand]DevExpress.XtraCharts.Web.Designer
  [Expand]DevExpress.XtraCharts.Web.Scripts
[Expand]ASP.NET Bootstrap Controls
[Expand]ASP.NET Core Bootstrap Controls
[Expand]WPF Controls
[Expand]Xamarin Controls
[Expand]Windows 10 App Controls
[Expand]Office File API
[Expand]Reporting
[Expand]Report and Dashboard Server
[Expand]Dashboard
[Expand]eXpressApp Framework
[Expand]CodeRush
[Expand]CodeRush Classic
[Expand]Cross-Platform Core Libraries
[Expand]Tools and Utilities
 End-User Documentation

ASPxRichEdit.CalculateDocumentVariable Event

Fires when the DOCVARIABLE field field is updated.

Namespace:DevExpress.Web.ASPxRichEdit
Assembly:DevExpress.Web.ASPxRichEdit.v18.1.dll

Expanded Syntax

Expanded Event Data

The event handler receives an argument of type CalculateDocumentVariableEventArgs containing data related to this event.

The following CalculateDocumentVariableEventArgs properties provide information specific to this event.
Property Description
Arguments Provides access to a collection of arguments within the DOCVARIABLE field.
FieldLocked Gets or sets a locked attribute to the field for which the event occurs.
Handled Gets or sets whether the default action is required.
KeepLastParagraph Gets or sets whether the last paragraph of the inserted document is kept in the resulting document.
PreserveInsertedContentFormatting Gets or sets whether to insert an additional hidden paragraph so that the inserted content is not formatted with the DOCVARIABLE field's paragraph formatting.
Value Gets or sets the value of the DOCVARIABLE field that fired the event.
VariableName Gets the name of the document variable to which the DOCVARIABLE field refers.

Expanded Remarks

The CalculateDocumentVariable event is fired when the DOCVARIABLE field value is calculated.

You can handle this event to analyze DOCVARIABLE field switches and arguments, and provide custom content to insert into this field. The content can be of any supported type, and even as complex as another generated (mail merged) document.

To learn more, see the Document Variables Support demo.

Expanded See Also

Is this topic helpful?​​​​​​​