Parameters of the Microsoft Word connector methods

Learn about the parameters of the Microsoft Word connector methods in RPA Desktop Design Studio.

Tableau 1. Parameters of the Microsoft Word connector methods

Parameter Name	Description	Mandatory?
Bookmark	Bookmark in a Microsoft Word document.	Yes
CellIndex	Index of a cell in a table.	Yes
ColumnIndex	Column sequence in a table.	Yes. The column index must be equal to or greater than zero.
Data	Table that contains data to add into a Microsoft Word document.	Yes
Filepath	Folder location including the name of the document.	Yes
EndCellIndex	Last cell number of a range.	Yes
ImageFilePath	The path to the image with the filename that you want to insert.	Yes
Filepath	location where the document will be exported as a PDF.	Yes. You must provide the filename and the PDF extension.
Bookmark	Exact location on the Word document where the image will be inserted. You must define a bookmark in the document first.	Yes
FilePath	Path to the Microsoft Word file including the filename.	Yes
EndColIndex	Last column number of a range for a bulk operation on a table, such as merging cells, searching text, and setting or getting values.	Yes
EndRowIndex	Last row number of a range for a bulk operation on a table, such as merging cells, searching text, and setting or getting values.	Yes
FirstRowIsHeader	Boolean value to indicate whether the method should treat the first row as a header of the table.	No
PageIndex	Page index value.	No.
Return (Boolean)	Boolean response to indicate whether the request was successful.	Not applicable
Timeout	Seconds after which the request to open the document will time out if no response is received.	No
StartCellIndex	First cell number of a range.	Yes
StartColIndex	First column number of a range for a bulk operation on a table, such as merging cells, searching text, and setting or getting values.	Yes
StartRowIndex	First row number of a range for a bulk operation on a table, such as merging cells, searching text, and setting or getting values.	Yes
RowIndex	Row sequence in a table in the document.	Yes. The row index value must be equal or greater than zero.
Table	The table data.	Yes
TableIndex	Index of a table in a Microsoft Word document.	No
Text Or, FindText Or, ReplaceText	Text to be added in a Microsoft Word document in the AddFooter, AddHeader, or InsertText methods. Text to be searched in the document in the Find method. Text to be replaced within the ReplaceBookmark, ReplaceFooterText, ReplaceHeaderText, or ReplaceText methods.	Yes
Value	Value in a cell.	Yes
Text	Text to be added to the footer.	Yes
FontSize	Font size of the footer text.	No
Text	Custom text to be added to the header.	Yes
FontSize	Font size of the header text.	Yes
Text	Text to find in the document.	Yes
Return (String)	Returns the footer text.	Not applicable
Return (Integer)	Returns the number of pages.	Not applicable
Return (String)	Returns the header text.	Not applicable
Return (String)	Returns the text content.	Not applicable
Text	Text that is inserted in the Word document.	Yes
Return (Boolean)	Returns the Boolean value to indicate whether a Word document is open.	Not applicable
saveChanges	Boolean response to indicate whether you want to save the changes before closing the document.	No
Return (Boolean)	Boolean response to whether the text was found in the document.	Not applicable
Table (Object)	Returns the data in a table as an object.	Not applicable
Data (DataTable)	Returns the data in the table.	Not applicable
Cell Index (Object)	Returns the value of the cell.	Not applicable
Return (Integer)	Returns the total count of tables in the Microsoft Word document.	Not applicable
Row index (Object)	Returns the data in the cell based on the index value.	Not applicable
ColumnIndex	The index value of the column based on which the position of the new column is determined.	No.
RowIndex	Index value of the row based on which the position of the row is determined.	No
Bookmark	Specific position in the Word document where the table will be inserted. Before inserting the table, you must add a bookmark.	Yes
Data (DataTable)	Table that will be inserted.	Yes
FindText	Footer text that will be replaced.	Yes
ReplaceText	Text that will replace the footer text.	Yes
FindText	Header text that will be replaced.	Yes
ReplaceText	Text that will replace the header text.	Yes
Object	Text to replace the text in the document.	Yes
FindText (String)	Text to be replaced.	Yes
ReplaceText	Text that will replace the existing text.	Yes
Left	Resize value from the left margin.	Yes
Top	Resize value from the top margin.	Yes
Width	Resize width value.	Yes
Height	Resize height value.	Yes

Enter inputs for parameters

To enter inputs for the parameters, see Configure port properties.