API Reference
Cmdlet
Invoke-OfficeWordMailMerge
Executes a simple mail merge against MERGEFIELD values in a Word document.
Remarks
Executes a simple mail merge against MERGEFIELD values in a Word document.
Examples
Replace merge fields from a hashtable.
PS>
Invoke-OfficeWordMailMerge -Data @{ FirstName = 'John'; OrderId = 12345 }
Updates MERGEFIELD values in the active Word document.
Common Parameters
This command supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable.
For more information, see about_CommonParameters.
Syntax
Invoke-OfficeWordMailMerge -Data <Object> [-Document <WordDocument>] [-PassThru] [-PreserveFields] [<CommonParameters>]Parameter set:
All Parameter SetsParameters
- Data Object
- Hashtable or object whose properties map to MERGEFIELD names.
- Document WordDocument
- Document to update when provided explicitly.
- PassThru SwitchParameter
- Emit the updated document.
- PreserveFields SwitchParameter
- Preserve field codes and only update displayed field text.
Outputs
OfficeIMO.Word.WordDocument