Platforms to show: All Mac Windows Linux Cross-Platform
WordFileMBS class
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
class | Wordfile | MBS Tools Plugin | 15.4 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
Example:
dim f as FolderItem = GetFolderItem("test.docx")
dim b as BinaryStream = BinaryStream.Open(f)
dim d as string = b.Read(b.Length)
dim w as WordFileMBS = WordFileMBS.OpenData(d)
if w.ReplaceTag("FirstName", "Peter") then
if w.ReplaceTag("LastName", "Miller") then
f = GetFolderItem("output.docx")
if w.WriteFile(f) then
MsgBox "OK"
end if
end if
end if
This is a class for reading word files and replacing text to customize document files.
Works for xml and docx files. Does not support old doc file format.
Please report document files where plugin corrupted file or failed to replace text.
This is an abstract class. You can't create an instance, but you can get one from various plugin functions.
- 7 properties
- property Caseless as Boolean
- property CloseMarker as String
- property OpenMarker as String
- property Text as String
- property XML as String
- property MediaFile(name as string) as String
- property XML(part as String) as String
- 18 methods
- method addMediaFile(name as string, content as string)
- method Append(other as WordFileMBS, AddPageBreak as boolean = false) as Boolean
- method AppendTableRow(tag as string) as Integer
- method Constructor Private
- method Contains(findText as string) as boolean
- method DuplicateTableRow(tag as string) as Integer
- method FieldNames as String()
- method GetFieldText(fieldName as string, byref text as String) as boolean
- method HasTag(tag as string) as boolean
- method MediaFiles as String()
- method Parts as String()
- method RemoveTableRow(tag as string) as Integer
- method ReplaceTag(tag as string, text as string = "", All as boolean = false) as boolean
- method SetFieldText(fieldName as string, text as String) as boolean
- method SetMarkers(openMarker as String, closeMarker as String) as boolean
- method Substitute(findText as string, replaceText as string = "", All as boolean = false) as boolean
- method Tags as String()
- method WriteFile(path as folderItem) as boolean
- 3 shared methods
This class has no sub classes.
Some examples using this class:
Blog Entries
- MBS Xojo Plugins, version 23.2pr1
- MonkeyBread Software Releases the MBS Xojo Plugins in version 22.2
- MBS Xojo Plugins, version 21.6pr3
- MBS Xojo Plugins, version 21.4pr2
- MBS Xojo Plugins in version 19.2
- MBS Xojo Plugins, version 17.5pr8
- MonkeyBread Software Releases the MBS Xojo Plugins in version 17.1
- MBS Xojo / Real Studio plug-ins in version 16.3
- MBS Xojo / Real Studio plug-ins version 16.2
- MBS Xojo / Real Studio plug-ins in version 15.4
Xojo Developer Magazine
Videos
- Presentation from Munich conference about MBS Plugins.
- Presentation from London conference about MBS Plugins.
The items on this page are in the following plugins: MBS Tools Plugin.
