Component: WordFile 
--------------------

Modify Word files.

Load a word file, replace tags with real values and save file.

| Version | macOS | Windows | Linux | Server | iOS SDK |
|---|---|---|---|---|---|
| [5.4](newinversion54.md "First functions introduced with version 5.4.") / [15.4](newinversion154.md "Newest functions in version 15.4.") | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes |

  
| Item | Details |
|:--|:--|
| [WordFile.Append](WordFileAppend.md)   Appends one word file text to other. | All   7.5 |
| [WordFile.AppendTableRow](WordFileAppendTableRow.md)   Duplicates and appends a table row containing a placeholder. | All   7.1 |
| [WordFile.Contains](WordFileContains.md)   Checks if some text exists in the document. | All   11.4 |
| [WordFile.DuplicateTableRow](WordFileDuplicateTableRow.md)   Duplicates a table row containing a placeholder. | All   7.1 |
| [WordFile.FieldNames](WordFileFieldNames.md)   Queries field names in the file. | All   7.5 |
| [WordFile.GetCaseless](WordFileGetCaseless.md)   Queries caseless state. | All   7.4 |
| [WordFile.GetFieldText](WordFileGetFieldText.md)   Queries field value. | All   7.5 |
| [WordFile.GetMediaFile](WordFileGetMediaFile.md)   Queries media file in word file. | All   6.3 |
| [WordFile.GetProperty](WordFileGetProperty.md)   Queries a metadata property. | All   14.5 |
| [WordFile.GetSkipDeletedText](WordFileGetSkipDeletedText.md)   Queries whether we skip deleted text | All   15.4 |
| [WordFile.GetXML](WordFileGetXML.md)   Queries xml content of the word file. | All   6.2 |
| [WordFile.HasTag](WordFileHasTag.md)   Checks if a tag exists. | All   5.4 |
| [WordFile.List](WordFileList.md)   Lists all IDs of word file objects. | All   13.0 |
| [WordFile.MediaFiles](WordFileMediaFiles.md)   Queries list of media files in the word file. | All   6.3 |
| [WordFile.OpenContainer](WordFileOpenContainer.md)   Opens a word file from container. | All   5.4 |
| [WordFile.OpenFile](WordFileOpenFile.md)   Opens a word file from file. | All   5.4 |
| [WordFile.OpenText](WordFileOpenText.md)   Opens a word xml file from text. | All   5.4 |
| [WordFile.Parts](WordFileParts.md)   Queries names of the parts of the document. | All   6.2 |
| [WordFile.Release](WordFileRelease.md)   Frees the memory used for the word file. | All   5.4 |
| [WordFile.ReleaseAll](WordFileReleaseAll.md)   Releases all word file objects. | All   10.5 |
| [WordFile.RemoveTableRow](WordFileRemoveTableRow.md)   Removes a table row containing a placeholder. | All   7.0 |
| [WordFile.ReplaceTag](WordFileReplaceTag.md)   Replaces a placeholder with text. | All   5.4 |
| [WordFile.SetCaseless](WordFileSetCaseless.md)   Sets caseless state. | All   7.4 |
| [WordFile.SetFieldText](WordFileSetFieldText.md)   Sets field value. | All   7.5 |
| [WordFile.SetMarkers](WordFileSetMarkers.md)   Sets the markers to look for before/after a tag. | All   6.3 |
| [WordFile.SetMediaFile](WordFileSetMediaFile.md)   Sets a media file image. | All   6.3 |
| [WordFile.SetProperty](WordFileSetProperty.md)   Sets a metadata property. | All   14.5 |
| [WordFile.SetSkipDeletedText](WordFileSetSkipDeletedText.md)   Sets whether to skip deleted text. | All   15.4 |
| [WordFile.SetXML](WordFileSetXML.md)   Sets the xml for this word file. | All   6.2 |
| [WordFile.Substitute](WordFileSubstitute.md)   Replaces some text in the document with new text. | All   11.4 |
| [WordFile.Tags](WordFileTags.md)   Queries list of tags. | All   12.2 |
| [WordFile.Texts](WordFileTexts.md)   Extracts text of word file. | All   5.4 |
| [WordFile.WriteContainer](WordFileWriteContainer.md)   Writes a file to container. | All   11.4 |
| [WordFile.WriteFile](WordFileWriteFile.md)   Writes a file to disk. | All   5.4 |

34 functions shown.

These functions require a license (82%).

### Release notes

- **Version 16.2**
    - Improved [WordFile.Texts](https://www.mbsplugins.eu/WordFileTexts.shtml) function to add more line breaks.
- **Version 15.4**
    - Added [WordFile.SetSkipDeletedText](https://www.mbsplugins.eu/WordFileSetSkipDeletedText.shtml) and [WordFile.GetSkipDeletedText](https://www.mbsplugins.eu/WordFileGetSkipDeletedText.shtml) functions.
    - Improved [WordFile.Texts](https://www.mbsplugins.eu/WordFileTexts.shtml) to skip a couple of node types.
- **Version 15.0**
    - Added UTF-8 validation checks to [WordFile](https://www.mbsplugins.eu/component_WordFile.shtml) functions to avoid creating invalid word files with invalid text.
    - Improved [WordFile.GetProperty](https://www.mbsplugins.eu/WordFileGetProperty.shtml) and [WordFile.SetProperty](https://www.mbsplugins.eu/WordFileSetProperty.shtml) to work on custom and app properties, too.
- **Version 14.5**
    - Added [WordFile.GetProperty](https://www.mbsplugins.eu/WordFileGetProperty.shtml) and [WordFile.SetProperty](https://www.mbsplugins.eu/WordFileSetProperty.shtml) functions.
- **Version 14.3**
    - Fixed the [WordFile.ReplaceTag](https://www.mbsplugins.eu/WordFileReplaceTag.shtml) function, which broke in 14.2.
- **Version 14.2**
    - Improved [WordFile.ReplaceTag](https://www.mbsplugins.eu/WordFileReplaceTag.shtml) and [WordFile.Substitute](https://www.mbsplugins.eu/WordFileSubstitute.shtml) functions to remove control characters from replacement text to avoid creating broken word files.
- **Version 13.4**
    - Fixed a problem with [WordFile.ReplaceTag](https://www.mbsplugins.eu/WordFileReplaceTag.shtml) and [WordFile.Substitute](https://www.mbsplugins.eu/WordFileSubstitute.shtml) functions when passing in NULL characters in the text.
- **Version 13.0**
    - Added [WordFile.List](https://www.mbsplugins.eu/WordFileList.shtml) function.
- **Version 12.5**
    - Fixed problem in [WordFile.ReplaceTag](https://www.mbsplugins.eu/WordFileReplaceTag.shtml) with all = true, where it returned error, but replaced tags.

### Blog Entries

- [MBS FileMaker Plugin, version 14.6pr4](https://www.mbsplugins.de/archive/2024-12-13/MBS_FileMaker_Plugin_version_1/monkeybreadsoftware_blog_filemaker)
- [MBS FileMaker Plugin 14.5 for Claris FileMaker](https://www.mbsplugins.de/archive/2024-11-12/MBS_FileMaker_Plugin_145_for_C/monkeybreadsoftware_blog_filemaker)
- [MBS FileMaker Plugin 12.2](https://www.mbsplugins.de/archive/2022-06-09/MBS_FileMaker_Plugin_122/monkeybreadsoftware_blog_filemaker)
- [MBS Plugin 12.2 for Claris FileMaker](https://www.mbsplugins.de/archive/2022-05-17/MBS_Plugin_122_for_Claris_File/monkeybreadsoftware_blog_filemaker)
- [MBS FileMaker Plugin 12.0 - More than 6700 Functions In One Plugin](https://www.mbsplugins.de/archive/2022-01-18/MBS_FileMaker_Plugin_120_-_Mor/monkeybreadsoftware_blog_filemaker)
- [MBS FileMaker Plugin 11.4 - More than 6500 Functions In One Plugin](https://www.mbsplugins.de/archive/2021-09-07/MBS_FileMaker_Plugin_114_-_Mor/monkeybreadsoftware_blog_filemaker)
- [MBS FileMaker Plugin 7.5 - More than 5000 Functions In One Plugin](https://www.mbsplugins.de/archive/2017-11-28/MBS_FileMaker_Plugin_75_-_More/monkeybreadsoftware_blog_filemaker)
- [MBS FileMaker Plugin 7.1 - More than 4400 Functions In One Plugin](https://www.mbsplugins.de/archive/2017-03-14/MBS_FileMaker_Plugin_71_-_More/monkeybreadsoftware_blog_filemaker)
- [New functions for MBS FileMaker Plugin coming soon](https://www.mbsplugins.de/archive/2016-03-17/New_functions_for_MBS_FileMake/monkeybreadsoftware_blog_filemaker)
- [MBS FileMaker Plugin 5.4 for OS X/Windows](https://www.mbsplugins.de/archive/2015-11-24/MBS_FileMaker_Plugin_54_for_OS/monkeybreadsoftware_blog_filemaker)

### FileMaker Magazin

- [Ausgabe 6/2021, Seite 20 bis 21](https://filemaker-magazin.de/neuigkeit/4165-Appetithappen-FMM_202106)
- [Ausgabe 6/2020, Seite 25](https://filemaker-magazin.de/neuigkeit/4118-Appetithappen-FMM_202006)
- [Ausgabe 6/2016, Seite 38 bis 39](https://filemaker-magazin.de/neuigkeit/3913-Appetithappen-FMM_201606)

### Example Databases

- [WordFile/WordFile](https://www.mbsplugins.eu/MBS-FileMaker-Plugin-Examples/WordFile/WordFile.shtml#1ScriptAnchor_)

[HTML Version](component_WordFile.shtml)