Namespace: Consultingwerk.Utilities.Word
Class 
WordUtility Copy to Clipboard
Parent classes:
Progress.Lang.Object
Consultingwerk.Utilities.Word.WordUtility

Inherits: Progress.Lang.Object


Navigate to: Methods | Constructors | Events | Properties | ProDatasets | Temp-Tables



Top Method Summary
Options Name Purpose
AddPageBreak (Document) Adds a Page Break into the specified document
AddPageBreak (WordprocessingDocument) Adds a Page Break into the specified document
TABLE AddTable (WordprocessingDocument, Table>) Inserts a clone of the first stored template table into the Document
TABLE AddTable (WordprocessingDocument, Table>, integer) Inserts a clone of a stored template table into the Document
AddTableRow (table, TableRow, Dictionary) Appends a clone of the given template row to the Table, populated with the given cell values
AppendChildElement (OpenXmlElement, OpenXmlElement) Appends a child element to the given parent element
DocumentFormat.OpenXml.Wordprocessing.TableRow CloneRow (TableRow) Clones and returns the given TableRow
CloseDocument (WordprocessingDocument) Closes the Document
LOGICAL ContainsBookmarks (WordprocessingDocument) Checks if the document contains bookmarks
CopyFiles (character, character) Copies the TemplateFile File to the SourceFile File
DeleteBookmarkElements (OpenXmlElement, character) Deletes the bookmark elements
FetchBookmarks (WordprocessingDocument) Fetches all the document bookmarks
FindAndReplaceBookmarks (WordprocessingDocument, Dictionary) Find And Replace Bookmarks
DocumentFormat.OpenXml.Wordprocessing.Run FindTextRun (OpenXmlElement, character) Returns the first Run element below the given element that carries a Text element with the given text
DocumentFormat.OpenXml.Wordprocessing.Run GetBookmarkRun (BookmarkStart) Returns the Run element between the given BookmarkStart and its BookmarkEnd
GetDocumentBookmarks (WordprocessingDocument) Gets all Document Bookmarks and stores them in a Dictionary
GetFooterBookmarks (WordprocessingDocument) Gets all Document Footer Bookmarks and stores them in a Dictionary
GetHeaderBookmarks (WordprocessingDocument) Gets all Document Header Bookmarks and stores them in a Dictionary
DocumentFormat.OpenXml.OpenXmlElement GetNextSiblingElement (OpenXmlElement) Returns the next sibling element of the given element
DocumentFormat.OpenXml.OpenXmlElement GetRootElement (OpenXmlElement) Returns the root element of the part the given element belongs to
System.Collections.Generic.List <DocumentFormat.OpenXml.Wordprocessing.TableRow> GetTableRows (table) Returns all TableRow elements of the given Table
CHARACTER ImageTypeFromFileName (character) Returns the image type of the given image file name
InsertFooterParagraphImage (FooterPart, Run, character) Inserts an image into a Run of a Document Footer
InsertHeaderParagraphImage (HeaderPart, Run, character) Inserts an image into a Run of a Document Header
InsertTableCellImage (TableCell, character, character) Inserts an image into a specific Table Cell
LOGICAL IsInsideTable (OpenXmlElement) Returns whether the given element is nested inside a Table element
MergeDocument (WordprocessingDocument, AltChunk, logical) Merges an AltChunk into a specific Document
MoveSectionPropertiesToEnd (Body) Moves the SectionProperties element of the given Body back to the end of the Body
DocumentFormat.OpenXml.Packaging.WordprocessingDocument OpenDocument (character) Opens the document
DocumentFormat.OpenXml.Packaging.WordprocessingDocument OpenDocument (character, character) Opens the document copied from the template
RemoveBookmarkEnd (character) Removes the Document Bookmark End linked to the specified Bookmark ID
RemoveBookmarkEnds (WordprocessingDocument) Removes all Document Bookmark Ends from the specified Document
RemoveDocumentParagraphs (WordprocessingDocument) Removes all Paragraph elements from the Document body
RemoveDocumentTableElements (Table>) Removes the listed Table elements from the Document
RemoveRunBookmarkText (BookmarkStart) Removes the Text elements of the Run elements between the given BookmarkStart and its BookmarkEnd
RemoveRunText (Run) Removes the Text elements of the given Run
RemoveTableRows (table, integer) Removes the rows of the given Table from the given starting row index on
ReplaceTextValue (OpenXmlElement, character, character) Replaces the value of every Text element below the given element that equals the search text
ResetImageSize () Resets the Image Size values used by the WordHelper when generating Image elements to their default values
LOGICAL RunHasText (Run, character) Returns whether the given Run carries a Text element with the given text
SaveDocument (WordprocessingDocument) Saves the Document
ScanElementForBookmarks (OpenXmlElement, character) Scans an element for bookmarks
SetImageSize (integer, integer, integer, integer, integer, integer) Sets the Image Size values used by the WordHelper when generating Image elements (see WordHelper:GenerateImageElement)
System.Collections.Generic.List <DocumentFormat.OpenXml.Wordprocessing.Table> StoreDocumentTableElements (WordprocessingDocument) Returns all Table elements of the Document in document order
UpdateBookmark (WordprocessingDocument, character, character) Updates a specific Document Bookmark
UpdateBookmarkEndList (BookmarkEnd) Update Bookmark End List by inserting the BookmarkEnd and BookmarkId
UpdateBookmarkStartList (BookmarkStart, character) Update Bookmark Start List by inserting the BookmarkStart and BookmarkId
UpdateBookmarkText (BookmarkStart, character) Updates the Bookmark Text
UpdateDocumentFooterBookmarkImage (WordprocessingDocument, character, character) Replaces a Document Footer Bookmark with an image
UpdateDocumentHeaderBookmarkImage (WordprocessingDocument, character, character) Replaces a Document Header Bookmark with an image
UpdateMergeBookmark (WordprocessingDocument, character, AltChunk) Updates a specific Document Bookmark
UpdateTableCell (TableCell, character, character) Updates a specific Table Cell by replacing the placeholder text with the given value
UpdateText (Run, character) Updates the Bookmark Run Text Element
LOGICAL UpdateText (Run, character, character) Updates the Text on the Bookmark Run Element
ValidateDocument (WordprocessingDocument) Validate that the document is valid
ValidateDocumentParts (WordprocessingDocument) Validates that the Document has readable contents

Top Property Summary
Options Name Purpose
LOGICAL HasBookmarks


Method Detail
Top

AddPageBreak (Document)
/*
Purpose: Adds a Page Break into the specified document
Notes:

Parameters:
poDocument DocumentFormat.OpenXml.Wordprocessing.Document
Top

AddPageBreak (WordprocessingDocument)
Purpose: Adds a Page Break into the specified document
Notes: Overload for callers holding the WordprocessingDocument; the
SectionProperties element is kept as the last Body child so the
document stays schema-valid

Parameters:
poWordDocument DocumentFormat.OpenXml.Packaging.WordprocessingDocument
The WordprocessingDocument to add the page break to
Top

TABLE AddTable (WordprocessingDocument, Table>)
Purpose: Inserts a clone of the first stored template table into the
Document
Notes: See StoreDocumentTableElements for obtaining the table list

Parameters:
poWordDocument DocumentFormat.OpenXml.Packaging.WordprocessingDocument
The WordprocessingDocument to insert the cloned table into
poTableList System.Collections.Generic.List
The List of stored template Table elements
Returns TABLE
The cloned Table element that was inserted into the Document
Top

TABLE AddTable (WordprocessingDocument, Table>, integer)
Purpose: Inserts a clone of a stored template table into the Document
Notes: The clone is appended to the Document body (followed by an empty
paragraph, see WordHelper:AddTable) and returned for row
population; the SectionProperties element is kept as the last
Body child so the document stays schema-valid

Parameters:
poWordDocument DocumentFormat.OpenXml.Packaging.WordprocessingDocument
The WordprocessingDocument to insert the cloned table into
poTableList System.Collections.Generic.List
The List of stored template Table elements, see StoreDocumentTableElements
piTableIndex INTEGER
The 0-based index of the template table in the list
Returns TABLE
The cloned Table element that was inserted into the Document
Top

AddTableRow (table, TableRow, Dictionary)
Purpose: Appends a clone of the given template row to the Table,
populated with the given cell values
Notes: Every dictionary key found as cell text (placeholder) in the
cloned row is replaced with the dictionary value; the template
row itself stays untouched and remains usable for further rows

Parameters:
poTable TEMP-TABLE poTable
The Table to append the new row to
poRow DocumentFormat.OpenXml.Wordprocessing.TableRow
The template TableRow to clone
poCellValues System.Collections.Generic.Dictionary
The Dictionary of placeholder texts and their cell values
Top

AppendChildElement (OpenXmlElement, OpenXmlElement)
Purpose: Appends a child element to the given parent element
Notes: AppendChild is a generic .NET method and can therefore not be
invoked from the ABL - the non-generic Append overload expects
an OpenXmlElement array

Parameters:
poParent DocumentFormat.OpenXml.OpenXmlElement
The element to append the child element to
poChild DocumentFormat.OpenXml.OpenXmlElement
The child element to append
Top

DocumentFormat.OpenXml.Wordprocessing.TableRow CloneRow (TableRow)
Purpose: Clones and returns the given TableRow
Notes: Used to keep a detached template row before the template rows
are removed from a table, see RemoveTableRows

Parameters:
poRow DocumentFormat.OpenXml.Wordprocessing.TableRow
The TableRow to clone
Returns DocumentFormat.OpenXml.Wordprocessing.TableRow
The cloned TableRow
Top

CloseDocument (WordprocessingDocument)
/*
Purpose: Closes the Document
Notes: Uses the Dispose method to close the WordDocument object and releasing
any resources associated with it.

Parameters:
poWordDocument DocumentFormat.OpenXml.Packaging.WordprocessingDocument
Top

LOGICAL ContainsBookmarks (WordprocessingDocument)
/*
Purpose: Checks if the document contains bookmarks
Notes:

Parameters:
poWordDocument DocumentFormat.OpenXml.Packaging.WordprocessingDocument
Returns LOGICAL
logical
Top

CopyFiles (character, character)
/*
Purpose: Copies the TemplateFile File to the SourceFile File
Notes:

Parameters:
pcTemplateFile CHARACTER
pcSourceFile CHARACTER
Top

DeleteBookmarkElements (OpenXmlElement, character)
/*
Purpose: Deletes the bookmark elements
Notes:

Parameters:
poElement DocumentFormat.OpenXml.OpenXmlElement
pcType CHARACTER
Top

FetchBookmarks (WordprocessingDocument)
/*
Purpose: Fetches all the document bookmarks
Notes:

Parameters:
poWordDocument DocumentFormat.OpenXml.Packaging.WordprocessingDocument
Top

FindAndReplaceBookmarks (WordprocessingDocument, Dictionary)
/*
Purpose: Find And Replace Bookmarks
Notes:

Parameters:
poWordDocument DocumentFormat.OpenXml.Packaging.WordprocessingDocument
poDictionary System.Collections.Generic.Dictionary
Top

DocumentFormat.OpenXml.Wordprocessing.Run FindTextRun (OpenXmlElement, character)
Purpose: Returns the first Run element below the given element that
carries a Text element with the given text
Notes: Searches the element tree recursively

Parameters:
poElement DocumentFormat.OpenXml.OpenXmlElement
The element to search below
pcText CHARACTER
The text to search for
Returns DocumentFormat.OpenXml.Wordprocessing.Run
The Run element carrying the text, or the unknown value when no Run matches
Top

DocumentFormat.OpenXml.Wordprocessing.Run GetBookmarkRun (BookmarkStart)
Purpose: Returns the Run element between the given BookmarkStart and its
BookmarkEnd
Notes: When no Run exists between the bookmark markers, a new Run is
created and appended to the bookmark's parent element
(InsertAfterSelf is a generic .NET method and can therefore not
be invoked from the ABL)

Parameters:
poBookmarkStart DocumentFormat.OpenXml.Wordprocessing.BookmarkStart
The BookmarkStart to return the Run for
Returns DocumentFormat.OpenXml.Wordprocessing.Run
The Run element of the bookmark
Top

GetDocumentBookmarks (WordprocessingDocument)
/*
Purpose: Gets all Document Bookmarks and stores them in a Dictionary
Notes:

Parameters:
poWordDocument DocumentFormat.OpenXml.Packaging.WordprocessingDocument
Top

GetFooterBookmarks (WordprocessingDocument)
/*
Purpose: Gets all Document Footer Bookmarks and stores them in a Dictionary
Notes:

Parameters:
poWordDocument DocumentFormat.OpenXml.Packaging.WordprocessingDocument
Top

GetHeaderBookmarks (WordprocessingDocument)
/*
Purpose: Gets all Document Header Bookmarks and stores them in a Dictionary
Notes:

Parameters:
poWordDocument DocumentFormat.OpenXml.Packaging.WordprocessingDocument
Top

DocumentFormat.OpenXml.OpenXmlElement GetNextSiblingElement (OpenXmlElement)
Purpose: Returns the next sibling element of the given element
Notes: OpenXmlElement:NextSibling must not be invoked from the ABL:
the parameterless generic overload NextSibling<T> makes the
reflection based method lookup of the CLR bridge fail with
System.Reflection.AmbiguousMatchException on OpenEdge releases
before 12.8 (Progress KB 000166593), so the sibling is resolved
through the parent's ChildElements collection instead

Parameters:
poElement DocumentFormat.OpenXml.OpenXmlElement
The element to return the next sibling of
Returns DocumentFormat.OpenXml.OpenXmlElement
The next sibling element, or the unknown value when the element is the last child of its parent
Top

DocumentFormat.OpenXml.OpenXmlElement GetRootElement (OpenXmlElement)
Purpose: Returns the root element of the part the given element belongs to
Notes: Walks the Parent chain; the root element of a header part is a
Header, the root element of a footer part is a Footer

Parameters:
poElement DocumentFormat.OpenXml.OpenXmlElement
The element to return the root element for
Returns DocumentFormat.OpenXml.OpenXmlElement
The root element of the part the element belongs to
Top

System.Collections.Generic.List <DocumentFormat.OpenXml.Wordprocessing.TableRow> GetTableRows (table)
Purpose: Returns all TableRow elements of the given Table
Notes: Rows of nested tables are also part of the result - filter on
the Parent when nested tables must be excluded

Parameters:
poTable TEMP-TABLE poTable
The Table to return the TableRow elements of
Returns System.Collections.Generic.List <DocumentFormat.OpenXml.Wordprocessing.TableRow>
The List of the TableRow elements of the Table
Top

CHARACTER ImageTypeFromFileName (character)
Purpose: Returns the image type of the given image file name
Notes: The image type is derived from the file extension; the WordHelper
treats every unknown type as jpeg

Parameters:
pcImageFile CHARACTER
The name of the image file
Returns CHARACTER
The image type of the image file
Top

InsertFooterParagraphImage (FooterPart, Run, character)
Purpose: Inserts an image into a Run of a Document Footer
Notes: The image part is added to the given FooterPart; the image
element carries the image size values currently set on the
WordHelper properties (see SetImageSize)

Parameters:
poFooterPart DocumentFormat.OpenXml.Packaging.FooterPart
The FooterPart the image part is added to
poRun DocumentFormat.OpenXml.Wordprocessing.Run
The Run the image element is appended to
pcImageFile CHARACTER
The name of the image file to insert
Top

InsertHeaderParagraphImage (HeaderPart, Run, character)
Purpose: Inserts an image into a Run of a Document Header
Notes: The image part is added to the given HeaderPart; the image
element carries the image size values currently set on the
WordHelper properties (see SetImageSize)

Parameters:
poHeaderPart DocumentFormat.OpenXml.Packaging.HeaderPart
The HeaderPart the image part is added to
poRun DocumentFormat.OpenXml.Wordprocessing.Run
The Run the image element is appended to
pcImageFile CHARACTER
The name of the image file to insert
Top

InsertTableCellImage (TableCell, character, character)
Purpose: Inserts an image into a specific Table Cell
Notes: The Run carrying the placeholder text receives the image; its
placeholder Text element is removed. A cell without a matching
placeholder is left unchanged. The image part is added to the
MainDocumentPart of the document the cell belongs to; the image
element carries the image size values currently set on the
WordHelper properties (see SetImageSize)

Parameters:
poCell DocumentFormat.OpenXml.Wordprocessing.TableCell
The TableCell to insert the image into
pcAttribute CHARACTER
The placeholder text identifying the target Run
pcImageFile CHARACTER
The name of the image file to insert
Top

LOGICAL IsInsideTable (OpenXmlElement)
Purpose: Returns whether the given element is nested inside a Table
element
Notes: Walks the Parent chain of the element

Parameters:
poElement DocumentFormat.OpenXml.OpenXmlElement
The element to check
Returns LOGICAL
True when one of the element's ancestors is a Table element
Top

MergeDocument (WordprocessingDocument, AltChunk, logical)
/*
Purpose: Merges an AltChunk into a specific Document
Notes:

Parameters:
poWordDocument DocumentFormat.OpenXml.Packaging.WordprocessingDocument
poAltChunk DocumentFormat.OpenXml.Wordprocessing.AltChunk
plPageBreak LOGICAL
Top

MoveSectionPropertiesToEnd (Body)
Purpose: Moves the SectionProperties element of the given Body back to
the end of the Body
Notes: The SectionProperties (page setup) element must be the last
child of the Body to stay schema-valid; the WordHelper insert
methods append at the end of the Body, so an insert into a
document whose Body ends with the SectionProperties leaves the
new element behind it

Parameters:
poBody DocumentFormat.OpenXml.Wordprocessing.Body
The Body to move the SectionProperties element of
Top

DocumentFormat.OpenXml.Packaging.WordprocessingDocument OpenDocument (character)
/*
Purpose: Opens the document
Notes:

Parameters:
pcSourceFile CHARACTER
Returns DocumentFormat.OpenXml.Packaging.WordprocessingDocument
WordprocessingDocument
Top

DocumentFormat.OpenXml.Packaging.WordprocessingDocument OpenDocument (character, character)
/*
Purpose: Opens the document copied from the template
Notes:

Parameters:
pcTemplateFile CHARACTER
pcSourceFile CHARACTER
Returns DocumentFormat.OpenXml.Packaging.WordprocessingDocument
WordprocessingDocument
Top

RemoveBookmarkEnd (character)
/*
Purpose: Removes the Document Bookmark End linked to the specified Bookmark ID
Notes:

Parameters:
pcBookmarkID CHARACTER
Top

RemoveBookmarkEnds (WordprocessingDocument)
/*
Purpose: Removes all Document Bookmark Ends from the specified Document
Notes:

Parameters:
poWordDocument DocumentFormat.OpenXml.Packaging.WordprocessingDocument
Top

RemoveDocumentParagraphs (WordprocessingDocument)
Purpose: Removes all Paragraph elements from the Document body
Notes: Enables a clean Document for inserting new data; only the
MainDocumentPart is touched - header and footer paragraphs stay,
and the SectionProperties element (page setup) is a direct Body
child - not a Paragraph - so it survives
Paragraphs inside Table elements are skipped - a table cell must
keep at least one Paragraph to stay schema-valid (Word would
otherwise prompt to repair the document); table content is
managed through the table methods (see RemoveDocumentTableElements)

Parameters:
poWordDocument DocumentFormat.OpenXml.Packaging.WordprocessingDocument
The WordprocessingDocument to remove the Paragraph elements from
Top

RemoveDocumentTableElements (Table>)
Purpose: Removes the listed Table elements from the Document
Notes: Removing detaches the elements from the document tree, but the
list keeps the objects alive - they remain usable as clone
templates when building the new Document

Parameters:
poTableList System.Collections.Generic.List
The List of Table elements to remove, see StoreDocumentTableElements
Top

RemoveRunBookmarkText (BookmarkStart)
Purpose: Removes the Text elements of the Run elements between the given
BookmarkStart and its BookmarkEnd
Notes: Ensures that the bookmark placeholder text is removed before it
is replaced with an image

Parameters:
poBookmarkStart DocumentFormat.OpenXml.Wordprocessing.BookmarkStart
The BookmarkStart to remove the Run text for
Top

RemoveRunText (Run)
Purpose: Removes the Text elements of the given Run
Notes: Iterates backwards - removing a child element shifts the
following elements down in the ChildElements collection

Parameters:
poRun DocumentFormat.OpenXml.Wordprocessing.Run
The Run to remove the Text elements of
Top

RemoveTableRows (table, integer)
Purpose: Removes the rows of the given Table from the given starting
row index on
Notes: The index is 0-based - pass 1 to keep the header row, 2 to keep
the header row plus the first (template) row; keep the template
row detached via CloneRow before removing it

Parameters:
poTable TEMP-TABLE poTable
The Table to remove the rows of
piStartIndex INTEGER
The 0-based index of the first row to remove
Top

ReplaceTextValue (OpenXmlElement, character, character)
Purpose: Replaces the value of every Text element below the given element
that equals the search text
Notes: Searches the element tree recursively

Parameters:
poElement DocumentFormat.OpenXml.OpenXmlElement
The element to replace the Text values below
pcSearch CHARACTER
The text value to replace
pcReplace CHARACTER
The replacement text value
Top

ResetImageSize ()
Purpose: Resets the Image Size values used by the WordHelper when generating
Image elements to their default values
Notes: The default values mirror the initial values of the WordHelper
properties (1744122 x 384159 EMU, no effect extent left edge,
no rotation), see SetImageSize

Top

LOGICAL RunHasText (Run, character)
Purpose: Returns whether the given Run carries a Text element with the
given text
Notes:

Parameters:
poRun DocumentFormat.OpenXml.Wordprocessing.Run
The Run to check
pcText CHARACTER
The text to check for
Returns LOGICAL
True when the Run carries a Text element with the given text
Top

SaveDocument (WordprocessingDocument)
/*
Purpose: Saves the Document
Notes:

Parameters:
poWordDocument DocumentFormat.OpenXml.Packaging.WordprocessingDocument
Top

ScanElementForBookmarks (OpenXmlElement, character)
/*
Purpose: Scans an element for bookmarks
Notes:

Parameters:
poElement DocumentFormat.OpenXml.OpenXmlElement
pcType CHARACTER
Top

SetImageSize (integer, integer, integer, integer, integer, integer)
Purpose: Sets the Image Size values used by the WordHelper when generating
Image elements (see WordHelper:GenerateImageElement)
Notes: The WordHelper properties are static, so the values apply to every
following image insertion in this session - until they are set
again or restored using ResetImageSize
The extents are expressed in EMU (914400 EMU = 1 inch, 360000 EMU
= 1 cm), the rotation in 1/60000 of a degree

Parameters:
piExtentX INTEGER
The inline extent width in EMU
piExtentY INTEGER
The inline extent height in EMU
pi2DExtentX INTEGER
The 2D transform extent width in EMU, typically equal to piExtentX
pi2DExtentY INTEGER
The 2D transform extent height in EMU, typically equal to piExtentY
piEffectExtentLeftEdge INTEGER
The effect extent left edge in EMU, used when an Image is to be rotated
piTransform2DRotation INTEGER
The 2D transform rotation in 1/60000 of a degree, used when an Image is to be rotated
Top

System.Collections.Generic.List <DocumentFormat.OpenXml.Wordprocessing.Table> StoreDocumentTableElements (WordprocessingDocument)
Purpose: Returns all Table elements of the Document in document order
Notes: The returned references are the live template tables - they stay
usable (e.g. as clone templates) after RemoveDocumentTableElements
detached them from the document tree

Parameters:
poWordDocument DocumentFormat.OpenXml.Packaging.WordprocessingDocument
The WordprocessingDocument to return the Table elements of
Returns System.Collections.Generic.List <DocumentFormat.OpenXml.Wordprocessing.Table>
The List of the Table elements of the Document
Top

UpdateBookmark (WordprocessingDocument, character, character)
/*
Purpose: Updates a specific Document Bookmark
Notes:

Parameters:
poWordDocument DocumentFormat.OpenXml.Packaging.WordprocessingDocument
pcBookmarkName CHARACTER
pcBookmarkText CHARACTER
Top

UpdateBookmarkEndList (BookmarkEnd)
/*
Purpose: Update Bookmark End List by inserting the BookmarkEnd and BookmarkId
Notes:

Parameters:
poBookmarkEnd DocumentFormat.OpenXml.Wordprocessing.BookmarkEnd
Top

UpdateBookmarkStartList (BookmarkStart, character)
/*
Purpose: Update Bookmark Start List by inserting the BookmarkStart and BookmarkId
Notes:

Parameters:
poBookmarkStart DocumentFormat.OpenXml.Wordprocessing.BookmarkStart
pcBookmarkId CHARACTER
Top

UpdateBookmarkText (BookmarkStart, character)
/*
Purpose: Updates the Bookmark Text
Notes:

Parameters:
poBookmarkStart DocumentFormat.OpenXml.Wordprocessing.BookmarkStart
pcBookmarkText CHARACTER
Top

UpdateDocumentFooterBookmarkImage (WordprocessingDocument, character, character)
Purpose: Replaces a Document Footer Bookmark with an image
Notes: Iterates the footer bookmarks of the document; the matching
bookmark's placeholder text is removed, the image is inserted
into the bookmark's Run and the bookmark markers are removed
The image element carries the image size values currently set
on the WordHelper properties (see SetImageSize)

Parameters:
poWordDocument DocumentFormat.OpenXml.Packaging.WordprocessingDocument
The WordprocessingDocument to update
pcBookmarkName CHARACTER
The name of the footer bookmark to replace
pcImageFile CHARACTER
The name of the image file to insert
Top

UpdateDocumentHeaderBookmarkImage (WordprocessingDocument, character, character)
Purpose: Replaces a Document Header Bookmark with an image
Notes: Iterates the header bookmarks of the document; the matching
bookmark's placeholder text is removed, the image is inserted
into the bookmark's Run and the bookmark markers are removed
The image element carries the image size values currently set
on the WordHelper properties (see SetImageSize)

Parameters:
poWordDocument DocumentFormat.OpenXml.Packaging.WordprocessingDocument
The WordprocessingDocument to update
pcBookmarkName CHARACTER
The name of the header bookmark to replace
pcImageFile CHARACTER
The name of the image file to insert
Top

UpdateMergeBookmark (WordprocessingDocument, character, AltChunk)
/*
Purpose: Updates a specific Document Bookmark
Notes:

Parameters:
poWordDocument DocumentFormat.OpenXml.Packaging.WordprocessingDocument
pcBookmarkName CHARACTER
poAltChunk DocumentFormat.OpenXml.Wordprocessing.AltChunk
Top

UpdateTableCell (TableCell, character, character)
Purpose: Updates a specific Table Cell by replacing the placeholder text
with the given value
Notes: Every Text element of the cell that equals the placeholder is
replaced; a cell without a matching placeholder is left
unchanged

Parameters:
poCell DocumentFormat.OpenXml.Wordprocessing.TableCell
The TableCell to update
pcAttribute CHARACTER
The placeholder text identifying the cell value to change
pcValue CHARACTER
The new cell value
Top

UpdateText (Run, character)
/*
Purpose: Updates the Bookmark Run Text Element
Notes: Updates a Bookmark with the required text

Parameters:
poRun DocumentFormat.OpenXml.Wordprocessing.Run
pcBookmarkText CHARACTER
Top

LOGICAL UpdateText (Run, character, character)
/*
Purpose: Updates the Text on the Bookmark Run Element
Notes: Updates a Bookmark with the required text

Parameters:
poRun DocumentFormat.OpenXml.Wordprocessing.Run
pcBookmarkValue CHARACTER
pcBookmarkText CHARACTER
Returns LOGICAL
logical True if the text was updated, false otherwise
Top

ValidateDocument (WordprocessingDocument)
/*
Purpose: Validate that the document is valid
Notes:

Parameters:
poWordDocument DocumentFormat.OpenXml.Packaging.WordprocessingDocument
Top

ValidateDocumentParts (WordprocessingDocument)
Purpose: Validates that the Document has readable contents
Notes: Guards the full part chain - MainDocumentPart, Document and Body
must be valid and the Body must have contents; complements
ValidateDocument, which only checks the Document contents

Parameters:
poWordDocument DocumentFormat.OpenXml.Packaging.WordprocessingDocument
The WordprocessingDocument to validate


Property Detail
Top

LOGICAL HasBookmarks

Returns LOGICAL


©2006-2026 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       19.09.2026 10:20:13