Edit

Share via

Word.DocumentMergeOptions interface

Package:
word

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Provides configuration options for the Document.merge method.

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

Properties

addToRecentFiles

If provided, specifies whether to add the merged document to recent files. The default value is true.
detectFormatChanges

If provided, specifies whether to detect format changes during the merge. The default value is true.
mergeTarget

If provided, specifies the target of the merge operation. The default value is current.
useFormattingFrom

If provided, specifies the source of formatting to use in the merge. The default value is current.

Property Details

addToRecentFiles

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

If provided, specifies whether to add the merged document to recent files. The default value is true.

addToRecentFiles?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

detectFormatChanges

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

If provided, specifies whether to detect format changes during the merge. The default value is true.

detectFormatChanges?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

mergeTarget

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

If provided, specifies the target of the merge operation. The default value is current.

mergeTarget?: Word.MergeTarget | "Selected" | "Current" | "New";

Property Value

Word.MergeTarget | "Selected" | "Current" | "New"

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

useFormattingFrom

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

If provided, specifies the source of formatting to use in the merge. The default value is current.

useFormattingFrom?: Word.UseFormattingFrom | "Current" | "Selected" | "Prompt";

Property Value

Word.UseFormattingFrom | "Current" | "Selected" | "Prompt"

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]