com.fatwire.transformer.common

Interface WordDocument

@Exported
public interface WordDocument

This is an instance of a docx file. It allows certain operations to be performed on the loaded documents. CS-Desktop works based on 2 types of property in the word documents. 1 Custom Property and Bookmark. It allows to operate on those properties

Method Summary

Modifier and Type	Method and Description
boolean	addBookMarks(Map<String,String> bookmark) Add bookmark properties to the word document
boolean	addCustomProperties(Map<String,String> customProps) Add custom properties to the word document
boolean	modifyBookMarks(Map<String,String> bookmark) Modifies a bookmark of the Word document
boolean	modifyCustomProperties(Map<String,String> customProps) Modifies custom properties of the Word document
Map<String,String>	readBookMarks() Read the bookmarks from the document
Map<String,String>	readCustomProperties() Read the custom properties from the document
boolean	removeBookMark(String bookmarkname) remove bookmark from the word document
boolean	removeCustomProperty(String attributename) remove custom property from the word document

Method Detail

addCustomProperties

boolean addCustomProperties(Map<String,String> customProps)

Add custom properties to the word document

Parameters:

customProps - -- map of custom properties

Returns:

true if added otherwise false

addBookMarks

boolean addBookMarks(Map<String,String> bookmark)

Add bookmark properties to the word document

Parameters:

bookmark - -- list of bookmarks

Returns:

true if added otherwise false

modifyCustomProperties

boolean modifyCustomProperties(Map<String,String> customProps)

Modifies custom properties of the Word document

Parameters:

customProps - -- list of custom properties

Returns:

true if modified otherwise false

modifyBookMarks

boolean modifyBookMarks(Map<String,String> bookmark)

Modifies a bookmark of the Word document

Parameters:

bookmark - -- modify the bookmark

Returns:

true if modified otherwise false

readCustomProperties

Map<String,String> readCustomProperties()

Read the custom properties from the document

Returns:

- Map of the custom properties

readBookMarks

Map<String,String> readBookMarks()

Read the bookmarks from the document

Returns:

- Map of bookmark which keep the name of the bookmark and its content

removeCustomProperty

boolean removeCustomProperty(String attributename)

remove custom property from the word document

Parameters:

attributename - -- name of custom property

Returns:

true if modified otherwise false

removeBookMark

boolean removeBookMark(String bookmarkname)

remove bookmark from the word document

Parameters:

bookmarkname - -- list of name of the bookmark

Returns:

true if removed otherwise false