com.acesoft.aceoffix
Class WordResDataRegion

java.lang.Object
  extended by com.acesoft.aceoffix.WordResDataRegion

public class WordResDataRegion
extends java.lang.Object

Represents a DataRegion. Fills data into DataRegion and controls behavior of DataRegion. You can only use the WordResponse.openDataRegion method to obtain a WordResDataRegion object.

In Word document, developer can define any range of selection as a DataRegion object by inserting a bookmark with the prefix name "ACE_". In other words, the DataRegion is a bookmark object whose name begins with "ACE_" in Word document. The prefix name "ACE_" is used to differentiate DataRegions from bookmarks defined by users. The bookmark name of a DataRegion is "ACE_" + DataRegionName. For example, if you want to define a specified range as a DataRegion whose DataRegionName is "ProductName" in a Word document, you should manually insert a bookmark whose name is "ACE_ProductName" for the range before you openDocument this document.

Version:
3.0
Author:
Acesoft Corporation

Method Summary
 java.lang.String getName()
          Gets the name of the DataRegion.
 boolean getNeedSubmit()
          Gets a value that indicates whether the DataRegion should be submitted.
 void setNeedSubmit(boolean value)
          Sets a value that indicates whether the DataRegion should be submitted.
 void setValue(java.lang.String value)
          Sets the value of the DataRegion.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

getName

public java.lang.String getName()
                         throws java.io.IOException
Gets the name of the DataRegion.

Throws:
java.io.IOException

getNeedSubmit

public boolean getNeedSubmit()
Gets a value that indicates whether the DataRegion should be submitted.


setNeedSubmit

public void setNeedSubmit(boolean value)
Sets a value that indicates whether the DataRegion should be submitted.

The NeedSubmit property is used to mark the DataRegion to be submitted. When NeedSubmit is true and OpenMode is OpenModeType.docSubmitForm, the DataRegion will automatically be editable.


setValue

public void setValue(java.lang.String value)
              throws java.io.IOException
Sets the value of the DataRegion.

Throws:
java.io.IOException