Fix: Broken Image Paths in Excel-to-Word Document Generation
Stop storing machine-specific paths in Excel. Resolve one approved photo folder, preflight every file, snapshot the inputs, and embed the verified image before saving DOCX/PDF.
Quick answer: store the filename and build the path once
Put only a filename such as site-0042.jpg in PhotoFile. Keep approved images under Assets\Photos beside the saved workbook. Reject directory separators and drive prefixes, join the two trusted parts at runtime, and verify every READY row before starting Word.
Path resolution belongs in preflight. If any required photo is missing, inaccessible, empty, or outside the filename contract, stop before generating the first document.
Diagnose the broken path before changing Word
Works only on the author’s PC
Cause: an absolute user-folder path. Fix: keep only the filename and resolve the shared workbook-relative photo folder.
Mapped drive fails elsewhere
Cause: the drive letter is not universal. Fix: use the separate controlled UNC workflow when the source truly lives on a network share.
Some rows fail after a move
Cause: mixed absolute and relative values. Fix: enforce one filename-only contract for every row.
File exists but Word shows nothing
Cause: the wrong record may point to the file, the bookmark may be invalid, or Word may reject the file content. Fix: validate both the asset and template contract.
The same image changes mid-batch
Cause: the source file was replaced while processing. Fix: copy approved assets into a run-specific input snapshot.
DOCX looks right but PDF does not
Cause: export or layout behavior rather than path resolution. Fix: inspect the saved DOCX and PDF as separate release outputs.
Define one literal image-path contract
Allowed Excel value
A filename only: site-0042.jpg.
Rejected absolute path
Do not store C:\Users\Name\Pictures\site-0042.jpg.
Rejected network path
Do not mix \\server\share\site-0042.jpg into this local-folder workflow.
Rejected traversal
Do not accept ..\OtherFolder\site-0042.jpg or any slash, backslash, colon, wildcard, or control character.
Approved root
The macro resolves every file under Assets\Photos beside the workbook.
Approved formats
Use PNG, JPG, or JPEG, then verify existence and nonzero size before Word starts.
Use exact Excel headers and Word bookmarks
Required column order (row 1): A — DocumentID; B — TitleText; C — DepartmentText; D — DocumentDateDisplay; E — OwnerName; F — CaptionText; G — PhotoFile; H — OutputName; I — GenerationStatus.
Text bookmarks
DocumentID, TitleText, DepartmentText, DocumentDateDisplay, OwnerName, and CaptionText.
Image bookmark
Photo must be a clean range without nested fields, content controls, or existing inline images.
Output controls
OutputName is a Windows-safe stem without .docx or .pdf; GenerationStatus is READY, HOLD, or DONE.
Template state
Turn off Track Changes, resolve revisions across all Word stories, and remove comments.
Free Excel VBA example: resolve and snapshot verified photos
Save the workbook as .xlsm, create ImageJobs, place ImageDocumentTemplate.docx in Templates, and put the photos in Assets\Photos. Run GenerateDocumentsFromVerifiedImagePaths. The macro preflights every READY row before Word starts and uses only snapshot copies during generation.
Option Explicit
Private Const DATA_SHEET As String = "ImageJobs"
Private Const READY_STATUS As String = "READY"
Private Const HOLD_STATUS As String = "HOLD"
Private Const DONE_STATUS As String = "DONE"
Private Const WORD_FORMAT_XML_DOCUMENT As Long = 12
Private Const WORD_EXPORT_FORMAT_PDF As Long = 17
Private Const WORD_EXPORT_OPTIMIZE_FOR_PRINT As Long = 0
Private Const WORD_EXPORT_ALL_DOCUMENT As Long = 0
Private Const WORD_EXPORT_DOCUMENT_CONTENT As Long = 0
Private Const WORD_EXPORT_CREATE_NO_BOOKMARKS As Long = 0
Private Const WORD_DO_NOT_SAVE_CHANGES As Long = 0
Private Const WORD_ALERTS_NONE As Long = 0
Private Const WORD_COLLAPSE_START As Long = 1
Private Const OFFICE_TRUE As Long = -1
Private Const POINTS_PER_CM As Double = 28.3464567
Private Const MAX_PHOTO_WIDTH_CM As Double = 12#
Private Const MAX_PHOTO_HEIGHT_CM As Double = 8#
Public Sub GenerateDocumentsFromVerifiedImagePaths()
Dim wb As Workbook
Dim ws As Worksheet
Dim fso As Object
Dim wdApp As Object
Dim wdDoc As Object
Dim templatePath As String
Dim photoFolder As String
Dim outputRoot As String
Dim runFolder As String
Dim inputSnapshotFolder As String
Dim photoSnapshotFolder As String
Dim templateSnapshotPath As String
Dim sourcePhotoPath As String
Dim snapshotPhotoPath As String
Dim stagingFolder As String
Dim completedFolder As String
Dim tempDocxPath As String
Dim tempPdfPath As String
Dim finalDocxPath As String
Dim finalPdfPath As String
Dim data As Variant
Dim photoPaths() As String
Dim lastRow As Long
Dim dataRow As Long
Dim excelRow As Long
Dim readyCount As Long
Dim generatedCount As Long
Dim documentId As String
Dim titleText As String
Dim departmentText As String
Dim documentDateDisplay As String
Dim ownerName As String
Dim captionText As String
Dim photoFile As String
Dim outputName As String
Dim generationStatus As String
Dim documentIds As Object
Dim outputNames As Object
Dim photoSnapshots As Object
Dim previousScreenUpdating As Boolean
Dim previousEnableEvents As Boolean
Dim appStateCaptured As Boolean
Dim currentStep As String
Dim errorNumber As Long
Dim errorDescription As String
Dim statusSavePending As Boolean
Dim statusRow As Long
Dim statusRecoveryMessage As String
On Error GoTo CleanFail
Set wb = ThisWorkbook
previousScreenUpdating = Application.ScreenUpdating
previousEnableEvents = Application.EnableEvents
appStateCaptured = True
Application.ScreenUpdating = False
Application.EnableEvents = False
currentStep = "checking the macro-enabled workbook"
RequireWritableMacroWorkbook wb
Set ws = wb.Worksheets(DATA_SHEET)
If ws.ProtectContents Then
Err.Raise vbObjectError + 5000, , _
"The ImageJobs sheet is protected against status updates."
End If
ValidateHeaders ws
lastRow = FindLastDataRow(ws)
If lastRow < 2 Then
Err.Raise vbObjectError + 5001, , _
"No image-job records were found below row 1."
End If
templatePath = JoinPath(JoinPath(wb.Path, "Templates"), _
"ImageDocumentTemplate.docx")
photoFolder = JoinPath(JoinPath(wb.Path, "Assets"), _
"Photos")
outputRoot = JoinPath(wb.Path, "GeneratedImageDocuments")
RequireNonemptyFile templatePath, "image document template"
RequireFolder photoFolder, "photo asset folder"
data = ws.Range("A2:I" & lastRow).Value2
ReDim photoPaths(1 To UBound(data, 1))
Set documentIds = CreateObject("Scripting.Dictionary")
documentIds.CompareMode = vbTextCompare
Set outputNames = CreateObject("Scripting.Dictionary")
outputNames.CompareMode = vbTextCompare
currentStep = "preflighting Excel image-job rows"
For dataRow = 1 To UBound(data, 1)
excelRow = dataRow + 1
If Not DataRowIsBlank(data, dataRow) Then
generationStatus = ReadRequiredText(data(dataRow, 9), _
"GenerationStatus", excelRow)
ValidateStatus generationStatus, excelRow
If StrComp(generationStatus, READY_STATUS, _
vbBinaryCompare) = 0 Then
documentId = ReadRequiredText(data(dataRow, 1), _
"DocumentID", excelRow)
titleText = ReadRequiredText(data(dataRow, 2), _
"TitleText", excelRow)
departmentText = ReadRequiredText(data(dataRow, 3), _
"DepartmentText", excelRow)
documentDateDisplay = ReadRequiredText(data(dataRow, 4), _
"DocumentDateDisplay", excelRow)
ownerName = ReadRequiredText(data(dataRow, 5), _
"OwnerName", excelRow)
captionText = ReadRequiredText(data(dataRow, 6), _
"CaptionText", excelRow)
photoFile = ReadRequiredText(data(dataRow, 7), _
"PhotoFile", excelRow)
outputName = ReadRequiredText(data(dataRow, 8), _
"OutputName", excelRow)
ValidateIdentifier documentId, "DocumentID", excelRow
ValidateFileStem outputName, excelRow
ValidateImageFileName photoFile, excelRow
photoPaths(dataRow) = JoinPath(photoFolder, photoFile)
RequireNonemptyFile photoPaths(dataRow), _
"photo for row " & excelRow
AddUniqueValue documentIds, documentId, _
"DocumentID", excelRow
AddUniqueValue outputNames, outputName, _
"OutputName", excelRow
readyCount = readyCount + 1
End If
End If
Next dataRow
If readyCount = 0 Then
Err.Raise vbObjectError + 5002, , _
"No image-job rows are marked exactly READY."
End If
currentStep = "saving the preflighted Excel workbook"
wb.Save
Set fso = CreateObject("Scripting.FileSystemObject")
EnsureFolder outputRoot
runFolder = CreateRunFolder(fso, outputRoot)
inputSnapshotFolder = JoinPath(runFolder, "InputSnapshot")
photoSnapshotFolder = JoinPath(inputSnapshotFolder, "Photos")
stagingFolder = JoinPath(runFolder, "Staging")
completedFolder = JoinPath(runFolder, "Completed")
fso.CreateFolder inputSnapshotFolder
fso.CreateFolder photoSnapshotFolder
fso.CreateFolder stagingFolder
fso.CreateFolder completedFolder
currentStep = "creating the controlled input snapshot"
templateSnapshotPath = JoinPath(inputSnapshotFolder, _
"ImageDocumentTemplate.docx")
CopyFileToSnapshot fso, templatePath, templateSnapshotPath, _
"image document template"
Set photoSnapshots = CreateObject("Scripting.Dictionary")
photoSnapshots.CompareMode = vbTextCompare
For dataRow = 1 To UBound(data, 1)
generationStatus = CStr(data(dataRow, 9))
If StrComp(generationStatus, READY_STATUS, _
vbBinaryCompare) = 0 Then
photoFile = CStr(data(dataRow, 7))
If Not photoSnapshots.Exists(photoFile) Then
sourcePhotoPath = photoPaths(dataRow)
snapshotPhotoPath = JoinPath( _
photoSnapshotFolder, photoFile)
CopyFileToSnapshot fso, sourcePhotoPath, _
snapshotPhotoPath, _
"photo " & photoFile
photoSnapshots.Add photoFile, _
snapshotPhotoPath
End If
photoPaths(dataRow) = photoSnapshots(photoFile)
End If
Next dataRow
currentStep = "starting Microsoft Word Desktop"
Set wdApp = CreateObject("Word.Application")
wdApp.Visible = False
wdApp.DisplayAlerts = WORD_ALERTS_NONE
wdApp.ScreenUpdating = False
currentStep = "validating the image document template snapshot"
Set wdDoc = wdApp.Documents.Open( _
templateSnapshotPath, False, True, False)
ValidateImageTemplate wdDoc
wdDoc.Close WORD_DO_NOT_SAVE_CHANGES
Set wdDoc = Nothing
For dataRow = 1 To UBound(data, 1)
excelRow = dataRow + 1
generationStatus = CStr(data(dataRow, 9))
If StrComp(generationStatus, READY_STATUS, _
vbBinaryCompare) = 0 Then
currentStep = "rechecking Excel row " & excelRow
RequireRowUnchanged ws, excelRow, data, dataRow
documentId = CStr(data(dataRow, 1))
titleText = CStr(data(dataRow, 2))
departmentText = CStr(data(dataRow, 3))
documentDateDisplay = CStr(data(dataRow, 4))
ownerName = CStr(data(dataRow, 5))
captionText = CStr(data(dataRow, 6))
outputName = CStr(data(dataRow, 8))
tempDocxPath = JoinPath(stagingFolder, outputName & ".docx")
tempPdfPath = JoinPath(stagingFolder, outputName & ".pdf")
finalDocxPath = JoinPath(completedFolder, outputName & ".docx")
finalPdfPath = JoinPath(completedFolder, outputName & ".pdf")
RequireTargetAbsent tempDocxPath
RequireTargetAbsent tempPdfPath
RequireTargetAbsent finalDocxPath
RequireTargetAbsent finalPdfPath
currentStep = "generating image-job row " & excelRow
Set wdDoc = wdApp.Documents.Open( _
templateSnapshotPath, False, True, False)
WriteRequiredBookmark wdDoc, "DocumentID", documentId
WriteRequiredBookmark wdDoc, "TitleText", titleText
WriteRequiredBookmark wdDoc, "DepartmentText", departmentText
WriteRequiredBookmark wdDoc, "DocumentDateDisplay", _
documentDateDisplay
WriteRequiredBookmark wdDoc, "OwnerName", ownerName
WriteRequiredBookmark wdDoc, "CaptionText", captionText
InsertPhotoBookmark wdDoc, "Photo", _
photoPaths(dataRow)
ValidateImageResultBeforeSave wdDoc
wdDoc.SaveAs2 tempDocxPath, WORD_FORMAT_XML_DOCUMENT
wdDoc.ExportAsFixedFormat _
tempPdfPath, _
WORD_EXPORT_FORMAT_PDF, _
False, _
WORD_EXPORT_OPTIMIZE_FOR_PRINT, _
WORD_EXPORT_ALL_DOCUMENT, _
1, _
1, _
WORD_EXPORT_DOCUMENT_CONTENT, _
True, _
True, _
WORD_EXPORT_CREATE_NO_BOOKMARKS, _
True, _
True, _
False
wdDoc.Close WORD_DO_NOT_SAVE_CHANGES
Set wdDoc = Nothing
RequireNonemptyFile tempDocxPath, _
"staged DOCX for row " & excelRow
RequireNonemptyFile tempPdfPath, _
"staged PDF for row " & excelRow
RequireTargetAbsent finalDocxPath
RequireTargetAbsent finalPdfPath
Name tempDocxPath As finalDocxPath
Name tempPdfPath As finalPdfPath
currentStep = "saving DONE for image-job row " & excelRow
statusRow = excelRow
statusSavePending = True
ws.Cells(excelRow, 9).Value2 = DONE_STATUS
wb.Save
statusSavePending = False
generatedCount = generatedCount + 1
End If
Next dataRow
wdApp.NormalTemplate.Saved = True
wdApp.Quit WORD_DO_NOT_SAVE_CHANGES
Set wdApp = Nothing
Application.EnableEvents = previousEnableEvents
Application.ScreenUpdating = previousScreenUpdating
appStateCaptured = False
MsgBox "Verified-image document batch completed." & vbCrLf & _
"Image documents generated: " & generatedCount & vbCrLf & _
"Completed folder: " & completedFolder & vbCrLf & vbCrLf & _
"Review the resolved photo, DOCX, and PDF before release.", _
vbInformation
CleanExit:
On Error Resume Next
If Not wdDoc Is Nothing Then _
wdDoc.Close WORD_DO_NOT_SAVE_CHANGES
If Not wdApp Is Nothing Then
wdApp.NormalTemplate.Saved = True
wdApp.Quit WORD_DO_NOT_SAVE_CHANGES
End If
If appStateCaptured Then
Application.EnableEvents = previousEnableEvents
Application.ScreenUpdating = previousScreenUpdating
End If
Set wdDoc = Nothing
Set wdApp = Nothing
Set fso = Nothing
Set photoSnapshots = Nothing
Set ws = Nothing
Set wb = Nothing
On Error GoTo 0
Exit Sub
CleanFail:
errorNumber = Err.Number
errorDescription = Err.Description
On Error Resume Next
If statusSavePending And Not ws Is Nothing Then
ws.Cells(statusRow, 9).Value2 = generationStatus
statusRecoveryMessage = vbCrLf & _
"DONE was restored to " & generationStatus & _
" in memory because the workbook save was not confirmed."
End If
If Not wdDoc Is Nothing Then _
wdDoc.Close WORD_DO_NOT_SAVE_CHANGES
If Not wdApp Is Nothing Then
wdApp.NormalTemplate.Saved = True
wdApp.Quit WORD_DO_NOT_SAVE_CHANGES
End If
If appStateCaptured Then
Application.EnableEvents = previousEnableEvents
Application.ScreenUpdating = previousScreenUpdating
End If
Set wdDoc = Nothing
Set wdApp = Nothing
Set fso = Nothing
Set photoSnapshots = Nothing
Set ws = Nothing
Set wb = Nothing
On Error GoTo 0
MsgBox "Image document generation stopped while " & currentStep & "." & _
vbCrLf & "Error " & errorNumber & ": " & errorDescription & _
vbCrLf & IIf(Len(runFolder) > 0, _
"Inspect the retained run folder: " & runFolder, _
"No run folder was created.") & vbCrLf & _
"Existing completed files were not deleted." & _
statusRecoveryMessage, vbCritical
End Sub
Private Sub CopyFileToSnapshot(ByVal fso As Object, _
ByVal sourcePath As String, _
ByVal snapshotPath As String, _
ByVal fileLabel As String)
Dim sourceSize As Variant
Dim sourceModified As Date
Dim errorDescription As String
RequireNonemptyFile sourcePath, fileLabel
RequireTargetAbsent snapshotPath
On Error GoTo CopyFailed
sourceSize = fso.GetFile(sourcePath).Size
sourceModified = fso.GetFile(sourcePath).DateLastModified
fso.CopyFile sourcePath, snapshotPath, False
RequireNonemptyFile snapshotPath, fileLabel & " snapshot"
If fso.GetFile(snapshotPath).Size <> sourceSize Then
Err.Raise vbObjectError + 5046, , _
"Snapshot size differs from the source " & fileLabel & "."
End If
If fso.GetFile(sourcePath).Size <> sourceSize Or _
fso.GetFile(sourcePath).DateLastModified <> sourceModified Then
Err.Raise vbObjectError + 5047, , _
"The source " & fileLabel & _
" changed while its run snapshot was being created."
End If
Exit Sub
CopyFailed:
errorDescription = Err.Description
Err.Raise vbObjectError + 5048, , _
"Could not create the controlled " & fileLabel & _
" snapshot: " & errorDescription
End Sub
Private Sub RequireWritableMacroWorkbook(ByVal wb As Workbook)
If Len(wb.Path) = 0 Then
Err.Raise vbObjectError + 5003, , _
"Save the Excel workbook before generation."
End If
If LCase$(Right$(wb.Name, 5)) <> ".xlsm" Then
Err.Raise vbObjectError + 5004, , _
"Save the workbook as an Excel Macro-Enabled Workbook (.xlsm)."
End If
If wb.ReadOnly Then
Err.Raise vbObjectError + 5005, , _
"The Excel workbook is read-only; DONE statuses cannot be saved."
End If
End Sub
Private Sub ValidateHeaders(ByVal ws As Worksheet)
Dim expected As Variant
Dim columnIndex As Long
Dim actualText As String
expected = Array("DocumentID", "TitleText", "DepartmentText", _
"DocumentDateDisplay", "OwnerName", "CaptionText", _
"PhotoFile", "OutputName", "GenerationStatus")
For columnIndex = 1 To 9
If IsError(ws.Cells(1, columnIndex).Value2) Then
Err.Raise vbObjectError + 5006, , _
"Header cell " & ws.Cells(1, columnIndex).Address(False, False) & _
" contains an Excel error."
End If
If VarType(ws.Cells(1, columnIndex).Value2) <> vbString Then
Err.Raise vbObjectError + 5007, , _
"Header cell " & ws.Cells(1, columnIndex).Address(False, False) & _
" must contain exact text."
End If
actualText = CStr(ws.Cells(1, columnIndex).Value2)
If StrComp(actualText, CStr(expected(columnIndex - 1)), _
vbBinaryCompare) <> 0 Then
Err.Raise vbObjectError + 5008, , _
"Expected header " & expected(columnIndex - 1) & _
" in column " & columnIndex & ", found " & actualText & "."
End If
Next columnIndex
End Sub
Private Function FindLastDataRow(ByVal ws As Worksheet) As Long
Dim lastCell As Range
Set lastCell = ws.Range("A:I").Find( _
What:="*", _
After:=ws.Cells(1, 1), _
LookIn:=xlFormulas, _
LookAt:=xlPart, _
SearchOrder:=xlByRows, _
SearchDirection:=xlPrevious, _
MatchCase:=False)
If lastCell Is Nothing Then
FindLastDataRow = 0
Else
FindLastDataRow = lastCell.Row
End If
End Function
Private Function DataRowIsBlank(ByRef data As Variant, _
ByVal dataRow As Long) As Boolean
Dim columnIndex As Long
DataRowIsBlank = True
For columnIndex = 1 To 9
If IsError(data(dataRow, columnIndex)) Then
DataRowIsBlank = False
Exit Function
End If
If Len(CStr(data(dataRow, columnIndex))) > 0 Then
DataRowIsBlank = False
Exit Function
End If
Next columnIndex
End Function
Private Function ReadRequiredText(ByVal rawValue As Variant, _
ByVal fieldName As String, _
ByVal excelRow As Long) As String
If IsError(rawValue) Then
Err.Raise vbObjectError + 5009, , _
fieldName & " contains an Excel error on row " & excelRow & "."
End If
If VarType(rawValue) <> vbString Then
Err.Raise vbObjectError + 5010, , _
fieldName & " must be stored as text on row " & excelRow & "."
End If
ReadRequiredText = CStr(rawValue)
If Len(ReadRequiredText) = 0 Then
Err.Raise vbObjectError + 5011, , _
fieldName & " is blank on row " & excelRow & "."
End If
If ReadRequiredText <> Trim$(ReadRequiredText) Then
Err.Raise vbObjectError + 5012, , _
fieldName & " has outer whitespace on row " & excelRow & "."
End If
If ContainsControlCharacter(ReadRequiredText) Then
Err.Raise vbObjectError + 5013, , _
fieldName & " contains a control character on row " & excelRow & "."
End If
End Function
Private Sub ValidateStatus(ByVal statusText As String, _
ByVal excelRow As Long)
If StrComp(statusText, READY_STATUS, vbBinaryCompare) <> 0 And _
StrComp(statusText, HOLD_STATUS, vbBinaryCompare) <> 0 And _
StrComp(statusText, DONE_STATUS, vbBinaryCompare) <> 0 Then
Err.Raise vbObjectError + 5014, , _
"GenerationStatus must be exactly READY, HOLD, or DONE on row " & _
excelRow & "."
End If
End Sub
Private Sub ValidateIdentifier(ByVal identifierText As String, _
ByVal fieldName As String, _
ByVal excelRow As Long)
If Len(identifierText) > 80 Then
Err.Raise vbObjectError + 5015, , _
fieldName & " exceeds 80 characters on row " & excelRow & "."
End If
End Sub
Private Sub AddUniqueValue(ByVal valuesSeen As Object, _
ByVal valueText As String, _
ByVal fieldName As String, _
ByVal excelRow As Long)
If valuesSeen.Exists(valueText) Then
Err.Raise vbObjectError + 5016, , _
"Duplicate " & fieldName & " on rows " & _
valuesSeen(valueText) & " and " & excelRow & ": " & valueText
End If
valuesSeen.Add valueText, excelRow
End Sub
Private Sub ValidateImageFileName(ByVal fileName As String, _
ByVal excelRow As Long)
Dim extensionPosition As Long
Dim extensionText As String
Dim baseName As String
Dim forbidden As Variant
Dim item As Variant
forbidden = Array("<", ">", ":", Chr$(34), "/", "\", "|", "?", "*")
For Each item In forbidden
If InStr(1, fileName, CStr(item), vbBinaryCompare) > 0 Then
Err.Raise vbObjectError + 5017, , _
"PhotoFile contains a forbidden path character on row " & _
excelRow & "."
End If
Next item
If Right$(fileName, 1) = "." Or Right$(fileName, 1) = " " Then
Err.Raise vbObjectError + 5018, , _
"PhotoFile cannot end with a period or space on row " & _
excelRow & "."
End If
extensionPosition = InStrRev(fileName, ".")
If extensionPosition <= 1 Then
Err.Raise vbObjectError + 5019, , _
"PhotoFile needs a PNG, JPG, or JPEG extension on row " & _
excelRow & "."
End If
extensionText = UCase$(Mid$(fileName, extensionPosition + 1))
If extensionText <> "PNG" And extensionText <> "JPG" And _
extensionText <> "JPEG" Then
Err.Raise vbObjectError + 5020, , _
"PhotoFile must use PNG, JPG, or JPEG on row " & excelRow & "."
End If
baseName = Left$(fileName, extensionPosition - 1)
If IsReservedWindowsName(baseName) Then
Err.Raise vbObjectError + 5053, , _
"PhotoFile uses a reserved Windows name on row " & excelRow & "."
End If
End Sub
Private Sub ValidateFileStem(ByVal fileStem As String, _
ByVal excelRow As Long)
Dim invalidCharacters As Variant
Dim invalidCharacter As Variant
Dim baseName As String
Dim lowerName As String
If Len(fileStem) > 120 Then
Err.Raise vbObjectError + 5021, , _
"OutputName exceeds 120 characters on row " & excelRow & "."
End If
lowerName = LCase$(fileStem)
If Right$(lowerName, 5) = ".docx" Or _
Right$(lowerName, 4) = ".pdf" Then
Err.Raise vbObjectError + 5049, , _
"OutputName must not include a .docx or .pdf extension on row " & _
excelRow & "."
End If
invalidCharacters = Array("<", ">", ":", Chr$(34), "/", "\", _
"|", "?", "*")
For Each invalidCharacter In invalidCharacters
If InStr(1, fileStem, CStr(invalidCharacter), vbBinaryCompare) > 0 Then
Err.Raise vbObjectError + 5022, , _
"OutputName contains a forbidden Windows character on row " & _
excelRow & "."
End If
Next invalidCharacter
If Right$(fileStem, 1) = "." Or Right$(fileStem, 1) = " " Then
Err.Raise vbObjectError + 5023, , _
"OutputName cannot end with a period or space on row " & _
excelRow & "."
End If
baseName = fileStem
If InStr(1, baseName, ".", vbBinaryCompare) > 0 Then
baseName = Left$(baseName, InStr(1, baseName, ".", _
vbBinaryCompare) - 1)
End If
If IsReservedWindowsName(baseName) Then
Err.Raise vbObjectError + 5024, , _
"OutputName uses a reserved Windows name on row " & excelRow & "."
End If
End Sub
Private Sub ValidateImageTemplate(ByVal doc As Object)
RejectTrackedChanges doc, "image document template snapshot"
If doc.Comments.Count > 0 Then
Err.Raise vbObjectError + 5026, , _
"Remove comments from ImageDocumentTemplate.docx."
End If
RequireBookmark doc, "DocumentID"
RequireBookmark doc, "TitleText"
RequireBookmark doc, "DepartmentText"
RequireBookmark doc, "DocumentDateDisplay"
RequireBookmark doc, "OwnerName"
RequireBookmark doc, "CaptionText"
RequireBookmark doc, "Photo"
End Sub
Private Sub ValidateImageResultBeforeSave(ByVal doc As Object)
RejectTrackedChanges doc, "generated image document"
If doc.Comments.Count > 0 Then
Err.Raise vbObjectError + 5050, , _
"The generated image document contains a comment before saving."
End If
RequireBookmark doc, "DocumentID"
RequireBookmark doc, "TitleText"
RequireBookmark doc, "DepartmentText"
RequireBookmark doc, "DocumentDateDisplay"
RequireBookmark doc, "OwnerName"
RequireBookmark doc, "CaptionText"
RequireBookmark doc, "Photo"
End Sub
Private Sub RejectTrackedChanges(ByVal doc As Object, _
ByVal documentLabel As String)
If doc.TrackRevisions Then
Err.Raise vbObjectError + 5051, , _
"Turn off Track Changes in the " & documentLabel & "."
End If
If CountRevisionsInAllStories(doc) > 0 Then
Err.Raise vbObjectError + 5052, , _
"Resolve tracked revisions in every story of the " & _
documentLabel & "."
End If
End Sub
Private Function CountRevisionsInAllStories(ByVal doc As Object) As Long
Dim storyRoot As Object
Dim currentStory As Object
Dim revisionCount As Long
For Each storyRoot In doc.StoryRanges
Set currentStory = storyRoot
Do While Not currentStory Is Nothing
revisionCount = revisionCount + currentStory.Revisions.Count
Set currentStory = currentStory.NextStoryRange
Loop
Next storyRoot
CountRevisionsInAllStories = revisionCount
End Function
Private Sub RequireBookmark(ByVal doc As Object, _
ByVal bookmarkName As String)
If Not doc.Bookmarks.Exists(bookmarkName) Then
Err.Raise vbObjectError + 5027, , _
"Missing required Word bookmark: " & bookmarkName
End If
End Sub
Private Sub WriteRequiredBookmark(ByVal doc As Object, _
ByVal bookmarkName As String, _
ByVal replacementText As String)
Dim targetRange As Object
Dim styleValue As Variant
RequireBookmark doc, bookmarkName
Set targetRange = doc.Bookmarks(bookmarkName).Range
If targetRange.Fields.Count > 0 Or _
targetRange.ContentControls.Count > 0 Or _
targetRange.InlineShapes.Count > 0 Then
Err.Raise vbObjectError + 5028, , _
"Text bookmark contains a field, content control, or image: " & _
bookmarkName
End If
If InStr(1, targetRange.Text, vbCr, vbBinaryCompare) > 0 Or _
InStr(1, targetRange.Text, Chr$(7), vbBinaryCompare) > 0 Then
Err.Raise vbObjectError + 5029, , _
"Text bookmark includes a paragraph or cell marker: " & bookmarkName
End If
styleValue = targetRange.Style
targetRange.Text = replacementText
targetRange.Style = styleValue
doc.Bookmarks.Add bookmarkName, targetRange
If Not doc.Bookmarks.Exists(bookmarkName) Then
Err.Raise vbObjectError + 5030, , _
"Bookmark was not restored: " & bookmarkName
End If
If StrComp(CStr(doc.Bookmarks(bookmarkName).Range.Text), _
replacementText, vbBinaryCompare) <> 0 Then
Err.Raise vbObjectError + 5031, , _
"Bookmark value differs after replacement: " & bookmarkName
End If
End Sub
Private Sub InsertPhotoBookmark(ByVal doc As Object, _
ByVal bookmarkName As String, _
ByVal photoPath As String)
Dim targetRange As Object
Dim picture As Object
Dim maximumWidth As Double
Dim maximumHeight As Double
RequireBookmark doc, bookmarkName
Set targetRange = doc.Bookmarks(bookmarkName).Range
If targetRange.Fields.Count > 0 Or _
targetRange.ContentControls.Count > 0 Or _
targetRange.InlineShapes.Count > 0 Then
Err.Raise vbObjectError + 5032, , _
"Photo bookmark contains a nested object."
End If
If InStr(1, targetRange.Text, vbCr, vbBinaryCompare) > 0 Or _
InStr(1, targetRange.Text, Chr$(7), vbBinaryCompare) > 0 Then
Err.Raise vbObjectError + 5033, , _
"Photo bookmark includes a paragraph or cell marker."
End If
targetRange.Text = ""
targetRange.Collapse WORD_COLLAPSE_START
Set picture = doc.InlineShapes.AddPicture( _
photoPath, False, True, targetRange)
If picture.Width <= 0 Or picture.Height <= 0 Then
Err.Raise vbObjectError + 5034, , _
"Word inserted an invalid photo."
End If
picture.LockAspectRatio = OFFICE_TRUE
maximumWidth = MAX_PHOTO_WIDTH_CM * POINTS_PER_CM
maximumHeight = MAX_PHOTO_HEIGHT_CM * POINTS_PER_CM
If picture.Width > maximumWidth Then picture.Width = maximumWidth
If picture.Height > maximumHeight Then picture.Height = maximumHeight
doc.Bookmarks.Add bookmarkName, picture.Range
If Not doc.Bookmarks.Exists(bookmarkName) Then
Err.Raise vbObjectError + 5035, , _
"Photo bookmark was not restored."
End If
If doc.Bookmarks(bookmarkName).Range.InlineShapes.Count <> 1 Then
Err.Raise vbObjectError + 5036, , _
"Photo bookmark does not contain one embedded picture."
End If
End Sub
Private Sub RequireRowUnchanged(ByVal ws As Worksheet, _
ByVal excelRow As Long, _
ByRef data As Variant, _
ByVal dataRow As Long)
Dim columnIndex As Long
Dim currentValue As Variant
Dim originalValue As Variant
For columnIndex = 1 To 9
currentValue = ws.Cells(excelRow, columnIndex).Value2
originalValue = data(dataRow, columnIndex)
If Not VariantValuesExactlyEqual(originalValue, currentValue) Then
Err.Raise vbObjectError + 5037, , _
"Excel row " & excelRow & " changed after preflight. " & _
"Run the batch again."
End If
Next columnIndex
End Sub
Private Function VariantValuesExactlyEqual(ByVal firstValue As Variant, _
ByVal secondValue As Variant) As Boolean
If IsError(firstValue) Or IsError(secondValue) Then
Exit Function
End If
If VarType(firstValue) <> VarType(secondValue) Then Exit Function
VariantValuesExactlyEqual = _
(StrComp(CStr(firstValue), CStr(secondValue), vbBinaryCompare) = 0)
End Function
Private Function CreateRunFolder(ByVal fso As Object, _
ByVal outputRoot As String) As String
Dim baseFolder As String
Dim candidate As String
Dim suffix As Long
baseFolder = "Run_" & Format$(Now, "yyyymmdd_hhnnss")
candidate = JoinPath(outputRoot, baseFolder)
Do While fso.FolderExists(candidate)
suffix = suffix + 1
candidate = JoinPath(outputRoot, baseFolder & "_" & _
Format$(suffix, "000"))
Loop
fso.CreateFolder candidate
CreateRunFolder = candidate
End Function
Private Sub EnsureFolder(ByVal folderPath As String)
If FolderExistsStrict(folderPath) Then Exit Sub
On Error GoTo CreateFailed
MkDir folderPath
Exit Sub
CreateFailed:
Err.Raise vbObjectError + 5038, , _
"Could not create folder: " & folderPath & ". " & Err.Description
End Sub
Private Sub RequireFolder(ByVal folderPath As String, _
ByVal folderLabel As String)
If Not FolderExistsStrict(folderPath) Then
Err.Raise vbObjectError + 5039, , _
"Missing " & folderLabel & ": " & folderPath
End If
End Sub
Private Sub RequireTargetAbsent(ByVal filePath As String)
If FileExistsStrict(filePath) Then
Err.Raise vbObjectError + 5040, , _
"Refusing to overwrite existing file: " & filePath
End If
End Sub
Private Sub RequireNonemptyFile(ByVal filePath As String, _
ByVal fileLabel As String)
If Not FileExistsStrict(filePath) Then
Err.Raise vbObjectError + 5041, , _
"Missing " & fileLabel & ": " & filePath
End If
On Error GoTo SizeFailed
If FileLen(filePath) <= 0 Then
Err.Raise vbObjectError + 5042, , _
"Empty " & fileLabel & ": " & filePath
End If
Exit Sub
SizeFailed:
If Err.Number >= vbObjectError + 5041 And _
Err.Number <= vbObjectError + 5042 Then
Err.Raise Err.Number, , Err.Description
End If
Err.Raise vbObjectError + 5043, , _
"Could not inspect " & fileLabel & ": " & filePath & _
". " & Err.Description
End Sub
Private Function FileExistsStrict(ByVal filePath As String) As Boolean
Dim resultText As String
On Error GoTo CheckFailed
resultText = Dir$(filePath, vbNormal Or vbHidden Or vbSystem Or vbReadOnly)
FileExistsStrict = (Len(resultText) > 0)
Exit Function
CheckFailed:
Err.Raise vbObjectError + 5044, , _
"Could not check file path: " & filePath & ". " & Err.Description
End Function
Private Function FolderExistsStrict(ByVal folderPath As String) As Boolean
Dim resultText As String
On Error GoTo CheckFailed
resultText = Dir$(folderPath, vbDirectory)
If Len(resultText) = 0 Then
FolderExistsStrict = False
Else
FolderExistsStrict = _
((GetAttr(folderPath) And vbDirectory) = vbDirectory)
End If
Exit Function
CheckFailed:
Err.Raise vbObjectError + 5045, , _
"Could not check folder path: " & folderPath & ". " & Err.Description
End Function
Private Function JoinPath(ByVal parentPath As String, _
ByVal childName As String) As String
If Right$(parentPath, 1) = "\" Then
JoinPath = parentPath & childName
Else
JoinPath = parentPath & "\" & childName
End If
End Function
Private Function ContainsControlCharacter(ByVal valueText As String) As Boolean
Dim characterIndex As Long
Dim characterCode As Long
For characterIndex = 1 To Len(valueText)
characterCode = AscW(Mid$(valueText, characterIndex, 1))
If characterCode >= 0 And characterCode <= 31 Then
ContainsControlCharacter = True
Exit Function
End If
Next characterIndex
End Function
Private Function IsReservedWindowsName(ByVal baseName As String) As Boolean
Dim upperName As String
Dim suffixText As String
Dim suffixCode As Long
upperName = UCase$(baseName)
Select Case upperName
Case "CON", "PRN", "AUX", "NUL", "CLOCK$"
IsReservedWindowsName = True
Exit Function
End Select
If Len(upperName) >= 4 Then
If Left$(upperName, 3) = "COM" Or Left$(upperName, 3) = "LPT" Then
suffixText = Mid$(upperName, 4)
If Len(suffixText) = 1 Then
suffixCode = AscW(suffixText)
If (suffixCode >= AscW("1") And suffixCode <= AscW("9")) Or _
suffixText = ChrW$(&HB9) Or _
suffixText = ChrW$(&HB2) Or _
suffixText = ChrW$(&HB3) Then
IsReservedWindowsName = True
End If
End If
End If
End If
End FunctionThe example uses Word’s documented bookmark checks, embedded pictures, DOCX save, and PDF export.
Verify the result at three levels
Path resolution
Confirm the workbook used the intended filename and the approved Assets\Photos root.
Record identity
Match DocumentID, caption, owner, and visible photo to the source record.
Word result
Confirm one embedded image remains inside the Photo bookmark with the intended proportions.
PDF result
Inspect cropping, resolution, page breaks, and whether the correct photo survives export.
Run evidence
Retain InputSnapshot when the batch requires traceability or later reconciliation.
Status meaning
Treat DONE as generated and saved, not as visual approval.
Know what this fix does not cover
No network-share resolver
The example rejects UNC and mapped-drive paths instead of silently mixing environments.
No web download
HTTP URLs, authentication, redirects, and remote caching require another workflow.
No binary image authentication
Extension and file size do not prove that the bytes are a valid, safe image.
No visual identity decision
The macro cannot know whether the photo belongs to the intended record.
No atomic file-and-status commit
Output moves and Excel status saving remain separate operations.
No automatic distribution
Review remains required before sending or publishing the documents.
Use Factory when every row follows the same image contract
DocxForge Pro Factory applies one standard Word template to many independent Excel rows, including rows that reference approved local image files.
Factory fits a repeated one-row, one-template image workflow. Contractor is the alternative when one reviewed case must create several different documents from different templates.


Frequently asked questions
Why does an image path work on one PC but fail on another?
The saved path may depend on a local user folder, drive letter, mapped network drive, or workbook location that differs on the second PC. Store only the filename and resolve it from a controlled folder available to the machine running the batch.
Should Excel store a full image path?
Not in this workflow. PhotoFile stores one filename such as site-0042.jpg. The macro rejects slashes, drive letters, UNC paths, and traversal strings, then joins the filename to Assets\Photos.
Does checking the extension prove the file is a real image?
No. The example checks the approved extension, existence, and nonzero size. It does not inspect the binary file signature, decode the image independently, or validate EXIF metadata.
Can this VBA example use network or web image URLs?
No. It intentionally uses local files under one controlled folder. Use the separate network-photo workflow for UNC shares. Downloading or authenticating web assets requires a different trust and error model.
Why copy photos into InputSnapshot before generation?
The snapshot prevents later rows from silently using a different file if an asset is replaced during the run. Each document uses the copied input selected during preflight.
Does DONE prove the picture is visually correct?
No. DONE confirms generation and workbook saving. A reviewer must still confirm that the photo belongs to the record, appears correctly, and remains correct in both DOCX and PDF.