Log In
Home
Support
Demos
Documentation
Blogs
Training
Webinars
[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
  [Expand]DevExpress.Web.ASPxRichEdit
  [Expand]DevExpress.Web.ASPxRichEdit.Localization
  [Collapse]DevExpress.Web.ASPxRichEdit.Scripts
   [Expand]AbstractNumberingList Class
   [Expand]AddSpacingAfterParagraphCommand Class
   [Expand]AddSpacingBeforeParagraphCommand Class
   [Expand]ASPxClientRichEdit Class
   [Expand]ASPxClientRichEditAutoCorrectEventArgs Class
    ASPxClientRichEditAutoCorrectEventHandler Delegate
   [Expand]ASPxClientRichEditCharacterPropertiesChangedEventArgs Class
    ASPxClientRichEditCharacterPropertiesChangedEventHandler Delegate
   [Expand]ASPxClientRichEditContentInsertedEventArgs Class
    ASPxClientRichEditContentInsertedEventHandler Delegate
   [Expand]ASPxClientRichEditContentRemovedEventArgs Class
    ASPxClientRichEditContentRemovedEventHandler Delegate
   [Expand]ASPxClientRichEditCustomCommandExecutedEventArgs Class
    ASPxClientRichEditCustomCommandExecutedEventHandler Delegate
   [Expand]ASPxClientRichEditHyperlinkClickEventArgs Class
    ASPxClientRichEditHyperlinkClickEventHandler Delegate
   [Expand]ASPxClientRichEditKeyDownEventArgs Class
    ASPxClientRichEditKeyDownEventHandler Delegate
   [Expand]ASPxClientRichEditKeyUpEventArgs Class
    ASPxClientRichEditKeyUpEventHandler Delegate
   [Expand]ASPxClientRichEditParagraphPropertiesChangedEventArgs Class
    ASPxClientRichEditParagraphPropertiesChangedEventHandler Delegate
   [Expand]ASPxClientRichEditPointerDownEventArgs Class
    ASPxClientRichEditPointerDownEventHandler Delegate
   [Expand]ASPxClientRichEditPointerUpEventArgs Class
    ASPxClientRichEditPointerUpEventHandler Delegate
   [Expand]ASPxClientRichEditPopupMenuItem Class
   [Expand]ASPxClientRichEditPopupMenuItemCollection Class
   [Expand]ASPxClientRichEditPopupMenuShowingEventArgs Class
    ASPxClientRichEditPopupMenuShowingEventHandler Delegate
   [Expand]AssignShortcutCommand Class
   [Expand]BackspaceCommand Class
   [Expand]Bookmark Class
    BorderLineStyle Enumeration
   [Expand]CapitalizeEachWordTextCaseCommand Class
   [Expand]ChangeCustomNumberingListCommand Class
   [Expand]ChangeFloatingObjectAbsolutePositionCommand Class
   [Expand]ChangeFloatingObjectAbsoluteSizeCommand Class
   [Expand]ChangeFloatingObjectAlignmentPositionCommand Class
   [Expand]ChangeFloatingObjectFillColorCommand Class
   [Expand]ChangeFloatingObjectLockAnchorCommand Class
   [Expand]ChangeFloatingObjectLockAspectRatioCommand Class
   [Expand]ChangeFloatingObjectOutlineColorCommand Class
   [Expand]ChangeFloatingObjectOutlineWidthCommand Class
   [Expand]ChangeFloatingObjectPropertyCommandBase<T> Class
   [Expand]ChangeFloatingObjectRelativePositionCommand Class
   [Expand]ChangeFloatingObjectRotationCommand Class
   [Expand]ChangeFloatingObjectTextWrappingCommand Class
   [Expand]ChangeFontBackColorCommand Class
   [Expand]ChangeFontBoldCommand Class
   [Expand]ChangeFontForeColorCommand Class
   [Expand]ChangeFontFormattingCommand Class
   [Expand]ChangeFontItalicCommand Class
   [Expand]ChangeFontNameCommand Class
   [Expand]ChangeFontSizeCommand Class
   [Expand]ChangeFontStrikeoutCommand Class
   [Expand]ChangeFontSubscriptCommand Class
   [Expand]ChangeFontSuperscriptCommand Class
   [Expand]ChangeFontUnderlineCommand Class
   [Expand]ChangeHyperlinkCommand Class
   [Expand]ChangePageColorCommand Class
   [Expand]ChangePageMarginsCommand Class
   [Expand]ChangePageOrientationCommand Class
   [Expand]ChangePageSizeCommand Class
   [Expand]ChangeParagraphBackColorCommand Class
   [Expand]ChangeParagraphFormattingCommand Class
   [Expand]ChangePictureScaleCommand Class
   [Expand]ChangeSectionColumnsCommand Class
   [Expand]ChangeSectionEqualColumnCountCommand Class
   [Expand]ChangeStyleCommand Class
   [Expand]ChangeTableBorderRepositoryItemCommand Class
   [Expand]ChangeTableBordersAndShadingCommand Class
   [Expand]ChangeTableCellFormattingCommand Class
   [Expand]ChangeTableCellPreferredWidthCommand Class
   [Expand]ChangeTableCellShadingCommand Class
   [Expand]ChangeTableColumnPreferredWidthCommand Class
   [Expand]ChangeTableFormattingCommand Class
   [Expand]ChangeTableLookCommand Class
   [Expand]ChangeTableRowPreferredHeightCommand Class
   [Expand]ChangeTableStyleCommand Class
   [Expand]ChangeTabsCommand Class
   [Expand]ChangeTextBoxContentMarginsCommand Class
   [Expand]ChangeTextBoxRelativeSizeCommand Class
   [Expand]ChangeTextBoxResizeShapeToFitTextCommand Class
    CharacterFormattingScript Enumeration
   [Expand]CharacterStyle Class
   [Expand]ClearFormattingCommand Class
   [Expand]CloseHeaderFooterCommand Class
   [Expand]CommandBase Class
   [Expand]CommandState<T> Class
   [Expand]CommandWithBooleanStateBase Class
   [Expand]CommandWithSimpleStateBase Class
   [Expand]ContinueNumberingListCommand Class
   [Expand]CopyCommand Class
   [Expand]CopyContentCommand Class
   [Expand]CreateDateFieldCommand Class
   [Expand]CreateFieldCommand Class
   [Expand]CreateMergeFieldCommand Class
   [Expand]CreatePageCountFieldCommand Class
   [Expand]CreatePageFieldCommand Class
   [Expand]CreateTimeFieldCommand Class
   [Expand]CutCommand Class
   [Expand]DataRecordOptions Class
   [Expand]DecreaseFontSizeCommand Class
   [Expand]DecreaseIndentCommand Class
   [Expand]DecrementNumberingIndentCommand Class
   [Expand]DecrementParagraphLeftIndentCommand Class
   [Expand]DeleteBookmarkCommand Class
   [Expand]DeleteCommand Class
   [Expand]DeleteHyperlinkCommand Class
   [Expand]DeleteHyperlinksCommand Class
   [Expand]DeleteTableCellsDialogCommand Class
   [Expand]DeleteTableCellsWithShiftHorizontallyCommand Class
   [Expand]DeleteTableCellsWithShiftVerticallyCommand Class
   [Expand]DeleteTableColumnsCommand Class
   [Expand]DeleteTableCommand Class
   [Expand]DeleteTableRowsCommand Class
    DocumentFormat Enumeration
   [Expand]Field Class
   [Expand]FileDownloadCommand Class
   [Expand]FileNewCommand Class
   [Expand]FileOpenCommand Class
   [Expand]FileOpenDialogCommand Class
   [Expand]FilePrintCommand Class
   [Expand]FileSaveAsCommand Class
   [Expand]FileSaveAsDialogCommand Class
   [Expand]FileSaveCommand Class
   [Expand]FindAllCommand Class
   [Expand]FloatingObjectAbsolutePositionSettings Class
   [Expand]FloatingObjectAbsoluteSizeSettings Class
   [Expand]FloatingObjectAlignmentPositionSettings Class
    FloatingObjectHorizontalPositionAlignment Enumeration
    FloatingObjectHorizontalPositionType Enumeration
    FloatingObjectRelativeHeightType Enumeration
   [Expand]FloatingObjectRelativePositionSettings Class
    FloatingObjectRelativeWidthType Enumeration
   [Expand]FloatingObjectTextWrappingSettings Class
    FloatingObjectTextWrapSide Enumeration
    FloatingObjectTextWrapType Enumeration
    FloatingObjectVerticalPositionAlignment Enumeration
    FloatingObjectVerticalPositionType Enumeration
   [Expand]FontFormattingSettings Class
   [Expand]GoToBookmarkCommand Class
   [Expand]GoToDataRecordCommand Class
   [Expand]GoToFirstDataRecordCommand Class
   [Expand]GoToFooterCommand Class
   [Expand]GoToHeaderCommand Class
   [Expand]GoToLastDataRecordCommand Class
   [Expand]GoToNextDataRecordCommand Class
   [Expand]GoToNextHeaderFooterCommand Class
   [Expand]GoToPreviousDataRecordCommand Class
   [Expand]GoToPreviousHeaderFooterCommand Class
   [Expand]HeaderFooter Class
    HeaderFooterType Enumeration
   [Expand]HideFindResultsCommand Class
   [Expand]HyperlinkSettings Class
   [Expand]IncreaseFontSizeCommand Class
   [Expand]IncreaseIndentCommand Class
   [Expand]IncrementNumberingIndentCommand Class
   [Expand]IncrementParagraphLeftIndentCommand Class
   [Expand]InlinePictureInfo Class
   [Expand]InsertBookmarkCommand Class
   [Expand]InsertColumnBreakCommand Class
   [Expand]InsertEquationsCaptionCommand Class
   [Expand]InsertFiguresCaptionCommand Class
   [Expand]InsertFloatingTextBoxCommand Class
   [Expand]InsertFooterCommand Class
   [Expand]InsertHeaderCommand Class
   [Expand]InsertHtmlCommand Class
   [Expand]InsertHyperlinkCommand Class
   [Expand]InsertLineBreakCommand Class
   [Expand]InsertNonBreakingSpaceCommand Class
   [Expand]InsertNumerationCommand Class
   [Expand]InsertPageBreakCommand Class
   [Expand]InsertParagraphCommand Class
   [Expand]InsertPictureCommand Class
   [Expand]InsertSectionBreakEvenPageCommand Class
   [Expand]InsertSectionBreakNextPageCommand Class
   [Expand]InsertSectionBreakOddPageCommand Class
   [Expand]InsertSymbolCommand Class
   [Expand]InsertTabCommand Class
   [Expand]InsertTableCellsDialogCommand Class
   [Expand]InsertTableCellsWithShiftToTheVerticallyCommand Class
   [Expand]InsertTableCellWithShiftToTheLeftCommand Class
   [Expand]InsertTableColumnToTheLeftCommand Class
   [Expand]InsertTableColumnToTheRightCommand Class
   [Expand]InsertTableCommand Class
   [Expand]InsertTableOfContentsCommand Class
   [Expand]InsertTableOfEquationsCommand Class
   [Expand]InsertTableOfFiguresCommand Class
   [Expand]InsertTableOfTablesCommand Class
   [Expand]InsertTableRowAboveCommand Class
   [Expand]InsertTableRowBelowCommand Class
   [Expand]InsertTablesCaptionCommand Class
   [Expand]InsertTextCommand Class
   [Expand]Interval Class
   [Expand]LinkHeaderFooterToPreviousCommand Class
    ListLevelFormat Enumeration
    ListLevelNumberAlignment Enumeration
   [Expand]ListLevelSettings Class
   [Collapse]MailMergeAndDownloadCommand Class
     MailMergeAndDownloadCommand Members
     MailMergeAndDownloadCommand Constructor
    [Collapse]MailMergeAndDownloadCommand Methods
     [Collapse]execute Method
       execute(String) Method
       execute(DocumentFormat) Method
       execute(String, MailMergeSettings) Method
       execute(DocumentFormat, MailMergeSettings) Method
      getState Method
   [Expand]MailMergeAndSaveAsCommand Class
   [Expand]MailMergeDialogCommand Class
    MailMergeExportRange Enumeration
   [Expand]MailMergeSettings Class
   [Expand]MakeTextLowerCaseCommand Class
   [Expand]MakeTextSentenceCaseCommand Class
   [Expand]MakeTextUpperCaseCommand Class
   [Expand]Margins Class
   [Expand]MergeFieldDialogCommand Class
    MergeMode Enumeration
   [Expand]MergeTableCellsCommand Class
   [Expand]MisspelledInterval Class
   [Expand]MoveContentCommand Class
   [Expand]OpenCustomNumberingListDialogCommand Class
   [Expand]OpenFindAndReplaceDialogCommand Class
   [Expand]OpenFindPanelCommand Class
   [Expand]OpenFontFormattingDialogCommand Class
   [Expand]OpenHyperlinkCommand Class
   [Expand]OpenInsertBookmarkDialogCommand Class
   [Expand]OpenInsertHyperlinkDialogCommand Class
   [Expand]OpenInsertPictureDialogCommand Class
   [Expand]OpenInsertSymbolDialogCommand Class
   [Expand]OpenInsertTableDialogCommand Class
   [Expand]OpenLayoutOptionsDialogCommand Class
   [Expand]OpenNumberingListDialogCommand Class
   [Expand]OpenPageMarginsDialogCommand Class
   [Expand]OpenPagePaperSizeDialogCommand Class
   [Expand]OpenParagraphFormattingDialogCommand Class
   [Expand]OpenSectionColumnsDialogCommand Class
   [Expand]OpenSpellingDialogCommand Class
   [Expand]OpenTableBordersAndShadingDialogCommand Class
   [Expand]OpenTableFormattingDialogCommand Class
   [Expand]OpenTabsDialogCommand Class
    Orientation Enumeration
   [Expand]Paragraph Class
    ParagraphAlignment Enumeration
    ParagraphFirstLineIndent Enumeration
   [Expand]ParagraphFormattingSettings Class
    ParagraphLineSpacingType Enumeration
   [Expand]ParagraphStyle Class
   [Expand]PasteCommand Class
   [Expand]RedoCommand Class
   [Expand]RemoveNextWordCommand Class
   [Expand]RemoveNumerationCommand Class
   [Expand]RemovePrevWordCommand Class
   [Expand]RemoveSpacingAfterParagraphCommand Class
   [Expand]RemoveSpacingBeforeParagraphCommand Class
   [Expand]RemoveTableCellBordersCommand Class
   [Expand]ReplaceAllCommand Class
   [Expand]ReplaceNextCommand Class
   [Expand]RestartNumberingListCommand Class
   [Expand]RichEditCommands Class
   [Expand]RichEditDocument Class
   [Expand]RichEditFileInfo Class
   [Expand]RichEditSelection Class
   [Expand]RichEditUnitConverter Class
   [Expand]Scale Class
   [Expand]Section Class
   [Expand]SectionColumn Class
   [Expand]SetDifferentFirstPageHeaderFooterCommand Class
   [Expand]SetDifferentOddAndEvenPagesHeaderFooterCommand Class
   [Expand]SetDoubleParagraphSpacingCommand Class
   [Expand]SetFullscreenCommand Class
   [Expand]SetPageSizeDialogCommand Class
   [Expand]SetParagraphLevelCommand Class
   [Expand]SetSesquialteralParagraphSpacingCommand Class
   [Expand]SetSingleParagraphSpacingCommand Class
   [Expand]ShowAllFieldCodesCommand Class
   [Expand]ShowFieldCodesCommand Class
   [Expand]ShowHiddenSymbolsCommand Class
   [Expand]ShowHorizontalRulerCommand Class
   [Expand]ShowMergedDataCommand Class
   [Expand]ShowTableGridLinesCommand Class
   [Expand]SimpleCommandState Class
   [Expand]Size Class
    SpellCheckerState Enumeration
    SpellingErrorType Enumeration
   [Expand]SpellingInfo Class
   [Expand]SplitTableCellsCommand Class
   [Expand]SplitTableCellsDialogCommand Class
   [Expand]StyleBase Class
   [Expand]SubDocument Class
    SubDocumentType Enumeration
   [Expand]SwitchTextCaseCommand Class
    TabAlign Enumeration
   [Expand]Table Class
    TabLeaderType Enumeration
   [Expand]TableBorderSettings Class
   [Expand]TableBordersSettings Class
   [Expand]TableCell Class
   [Expand]TableCellFormattingSettings Class
    TableCellVerticalAlignment Enumeration
   [Expand]TableFormattingSettings Class
   [Expand]TableHeightUnit Class
    TableHeightUnitType Enumeration
   [Expand]TableLookSettings Class
   [Expand]TableRow Class
    TableRowAlignment Enumeration
   [Expand]TableStyle Class
   [Expand]TableWidthUnit Class
    TableWidthUnitType Enumeration
   [Expand]TabSettings Class
   [Expand]TabsSettings Class
   [Expand]TextBoxRelativeSizeSettings Class
   [Expand]ToggleBulletedListCommand Class
   [Expand]ToggleMultilevelListCommand Class
   [Expand]ToggleNumberingListCommand Class
   [Expand]ToggleParagraphAlignmentCenterCommand Class
   [Expand]ToggleParagraphAlignmentJustifyCommand Class
   [Expand]ToggleParagraphAlignmentLeftCommand Class
   [Expand]ToggleParagraphAlignmentRightCommand Class
   [Expand]ToggleTableAutoFitContentsCommand Class
   [Expand]ToggleTableAutoFitWindowCommand Class
   [Expand]ToggleTableCellAlignBottomCenterCommand Class
   [Expand]ToggleTableCellAlignBottomLeftCommand Class
   [Expand]ToggleTableCellAlignBottomRightCommand Class
   [Expand]ToggleTableCellAlignMiddleCenterCommand Class
   [Expand]ToggleTableCellAlignMiddleLeftCommand Class
   [Expand]ToggleTableCellAlignMiddleRightCommand Class
   [Expand]ToggleTableCellAlignTopCenterCommand Class
   [Expand]ToggleTableCellAlignTopLeftCommand Class
   [Expand]ToggleTableCellAlignTopRightCommand Class
   [Expand]ToggleTableCellAllBordersCommand Class
   [Expand]ToggleTableCellBottomBorderCommand Class
   [Expand]ToggleTableCellInsideBordersCommand Class
   [Expand]ToggleTableCellInsideHorizontalBordersCommand Class
   [Expand]ToggleTableCellInsideVerticalBordersCommand Class
   [Expand]ToggleTableCellLeftBorderCommand Class
   [Expand]ToggleTableCellOutsideBordersCommand Class
   [Expand]ToggleTableCellRightBorderCommand Class
   [Expand]ToggleTableCellTopBorderCommand Class
   [Expand]ToggleTableFixedColumnWidthCommand Class
   [Expand]ToggleTextCaseCommand Class
   [Expand]UndoCommand Class
   [Expand]UpdateAllFieldsCommand Class
   [Expand]UpdateFieldCommand Class
   [Expand]UpdateTableOfContentsCommand Class
  [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 Server
[Expand]Dashboard
[Expand]eXpressApp Framework
[Expand]CodeRush
[Expand]CodeRush Classic
[Expand]Cross-Platform Core Libraries
[Expand]Tools and Utilities
 End-User Documentation
ASP.NET Controls and MVC Extensions > DevExpress.Web.ASPxRichEdit.Scripts > MailMergeAndDownloadCommand > execute

MailMergeAndDownloadCommand.execute(DocumentFormat, MailMergeSettings) Method

Executes the MailMergeAndDownloadCommand command by applying the specified settings.
May result in taking no action if the command's state does not allow command execution. Use the object's getState method to check the command state.

Namespace:DevExpress.Web.ASPxRichEdit.Scripts
Assembly:JavaScript

Expanded Syntax

Parameters

documentFormat
Type: DocumentFormat
One of the DocumentFormat enumeration values.
settings
Type: MailMergeSettings
A MailMergeSettings object specifying the mail merge settings.

Return value

Type: Boolean
A Boolean value identifying whether method execution was successful or failed.

Expanded Remarks

The execute method checks the command state (obtained using the getState method) before executing, and decides whether the action can be performed.

Usage example:

Expanded See Also

MailMergeAndDownloadCommand Class
MailMergeAndDownloadCommand Members
DevExpress.Web.ASPxRichEdit.Scripts Namespace
Is this topic helpful?​​​​​​​
Copyright (c) 1998-2018 Developer Express Inc. All rights reserved.