Xojo Conferences
MBSSep2018MunichDE
XDCMay2019MiamiUSA

Platforms to show: All Mac Windows Linux Cross-Platform

WordFileMBS.Append(other as WordFileMBS) as Boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method Wordfile MBS XL Plugin 17.5 Yes Yes Yes Yes No
Function: Appends one word file text to other.
Notes:
This function takes document part from other word file and copies it’s xml nodes to the current document.
Please only copy from one document to other if they both are made from same template, so internal IDs for styles match.
Returns true on success or false on failure.

Feedback, Comments & Corrections

WordFileMBS.AppendTableRow(tag as string) as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method Wordfile MBS XL Plugin 17.1 Yes Yes Yes Yes No
Function: Duplicates a table row containing a placeholder.
Notes:
If you have tables in your template word file and you like to duplicate it, this function can do that and add the new row on the end of the table.

Returns Values
0success
1Tag not found.
2Tag found, but not in a table.
3Missing main document part.

Feedback, Comments & Corrections

WordFileMBS.Constructor
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method Wordfile MBS XL Plugin 15.4 Yes Yes Yes No No
Function: The private constructor.

Feedback, Comments & Corrections

WordFileMBS.DuplicateTableRow(tag as string) as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method Wordfile MBS XL Plugin 17.1 Yes Yes Yes Yes No
Function: Duplicates a table row containing a placeholder.
Notes:
If you have tables in your template word file and you like to duplicate it, this function can do that and add the new row on just after the row to copy.

Returns Values
0success
1Tag not found.
2Tag found, but not in a table.
3Missing main document part.

Feedback, Comments & Corrections

WordFileMBS.FieldNames as String()
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method Wordfile MBS XL Plugin 17.5 Yes Yes Yes Yes No
Function: Queries field names in the file.
Notes: This looks for form fields in a word file.

Feedback, Comments & Corrections

WordFileMBS.GetFieldText(fieldName as string, byref text as String) as boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method Wordfile MBS XL Plugin 17.5 Yes Yes Yes Yes No
Function: Queries field value.
Notes:
The plugin looks for the field with given name and queries it's text.
Returns true if field was found.

Feedback, Comments & Corrections

WordFileMBS.HasTag(tag as string) as boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method Wordfile MBS XL Plugin 15.4 Yes Yes Yes Yes No
Function: Checks if a tag exists.
Notes:
The place holder in the document must start with « and end with » characters. The place holder you pass here, should not have those quotes.
Returns true on success or false on failure.

If you change font or style of the text within the marker, it will not be recognized. So please keep all text between and including the « and » markers (or whatever is configured) within the same font style.

Feedback, Comments & Corrections

WordFileMBS.MediaFile(name as string) as String
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property Wordfile MBS XL Plugin 16.3 Yes Yes Yes Yes No
Function: Queries or replaces the content of a media file.
Notes:
You can use this to extract images from word file.
Or to replace a placeholder image with the real image.
For replacement please make sure file type and dimensions match.
Raises KeyNotFoundException if media file with given name is not found.
(Read and Write computed property)

Feedback, Comments & Corrections

WordFileMBS.MediaFiles as String()
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method Wordfile MBS XL Plugin 16.3 Yes Yes Yes Yes No
Function: Lists the media files in the word document.
Notes: e.g. image1.png

Feedback, Comments & Corrections

WordFileMBS.Parts as String()
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method Wordfile MBS XL Plugin 16.2 Yes Yes Yes Yes No
Function: Queries names of the parts of the document.
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)

MsgBox w.XML("footer1")
Notes:
This may tell you how many headers/footers we found in a docx file.
e.g. "footer1", "header1", "document".

Feedback, Comments & Corrections

WordFileMBS.RemoveTableRow(tag as string) as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method Wordfile MBS XL Plugin 17.0 Yes Yes Yes Yes No
Function: Removes a table row containing a placeholder.
Notes:
If you have tables in your template word file and you only fill some rows, you can remove superfluous rows using this function.

Returns Values
0success
1Tag not found.
2Tag found, but not in a table.
3Missing main document part.

Feedback, Comments & Corrections

WordFileMBS.ReplaceTag(tag as string, text as string = "", All as boolean = false) as boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method Wordfile MBS XL Plugin 15.4 Yes Yes Yes Yes No
Function: Replaces a placeholder with text.
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
Notes:
The place holder in the document must start with « and end with » characters. The place holder you pass here, should not have those quotes.
Returns true on success or false on failure.
If you need to replace multi line text like addresses, please use several placeholders, at least one per line.

Version 17.0 and newer can handle multi line text better for normal paragraphs. It creates for you new paragraphs for each line in the new text.

If you change font or style of the text within the marker, it will not be recognized. So please keep all text between and including the « and » markers (or whatever is configured) within the same font style.

Feedback, Comments & Corrections

WordFileMBS.SetFieldText(fieldName as string, text as String) as boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method Wordfile MBS XL Plugin 17.5 Yes Yes Yes Yes No
Function: Sets field value.
Notes:
The plugin looks for the field with given name and sets it's text.
Returns true if field was found.

Feedback, Comments & Corrections

WordFileMBS.SetMarkers(openMarker as String, closeMarker as String) as boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method Wordfile MBS XL Plugin 16.3 Yes Yes Yes Yes No
Function: Sets the markers to look for before/after a tag.
Notes:
Default are « and ».
Should be different and not empty.
Returns true on success or false on failure.

Feedback, Comments & Corrections

WordFileMBS.WriteFile(path as folderItem) as boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method Wordfile MBS XL Plugin 15.4 Yes Yes Yes Yes No
Function: Writes a file to disk.
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
Notes: File extension should be correct, either docx or xml depending on what you loaded.

Feedback, Comments & Corrections

WordFileMBS.XML(part as String) as String
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property Wordfile MBS XL Plugin 16.2 Yes Yes Yes Yes No
Function: Queries/Sets XML for a part.
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)

MsgBox Join(w.Parts, EndOfLine)
Notes:
See Parts array for possible parts.
(Read and Write computed property)

See also:

Feedback, Comments & Corrections

The items on this page are in the following plugins: MBS XL Plugin.





Links
MBS Xojo Chart Plugins