com.aspose.words
Class FieldOptions

java.lang.Object
    extended by com.aspose.words.FieldOptions

public class FieldOptions 
extends java.lang.Object

Represents options to control field handling in a document.

Example:

Shows how to specify where the locale for date formatting during field update and mail merge is chosen from.
// Set the culture used during field update to the culture used by the field.
doc.getFieldOptions().setFieldUpdateCultureSource(FieldUpdateCultureSource.FIELD_CODE);
doc.getMailMerge().execute(new String[] { "Date2" }, new Object[] { new SimpleDateFormat("yyyy/MM/DD").parse("2011/01/01") });

Property Getters/Setters Summary
intgetFieldUpdateCultureSource()
voidsetFieldUpdateCultureSource(int value)
           Specifies what culture to use to format the field result. The value of the property is FieldUpdateCultureSource integer constant.
booleanisBidiTextSupportedOnUpdate()
voidisBidiTextSupportedOnUpdate(boolean value)
           Gets or sets the value indicating whether bidirectional text is fully supported during field update or not.
IFieldUserPromptRespondentgetUserPromptRespondent()
voidsetUserPromptRespondent(IFieldUserPromptRespondent value)
           Gets or sets the respondent to user prompts during field update.
 

Property Getters/Setters Detail

getFieldUpdateCultureSource/setFieldUpdateCultureSource

public int getFieldUpdateCultureSource() / public void setFieldUpdateCultureSource(int value)
Specifies what culture to use to format the field result. The value of the property is FieldUpdateCultureSource integer constant.

By default, the culture of the current thread is used.

The setting affects only date/time fields with \\@ format switch.

Example:

Shows how to specify where the locale for date formatting during field update and mail merge is chosen from.
// Set the culture used during field update to the culture used by the field.
doc.getFieldOptions().setFieldUpdateCultureSource(FieldUpdateCultureSource.FIELD_CODE);
doc.getMailMerge().execute(new String[] { "Date2" }, new Object[] { new SimpleDateFormat("yyyy/MM/DD").parse("2011/01/01") });

isBidiTextSupportedOnUpdate/isBidiTextSupportedOnUpdate

public boolean isBidiTextSupportedOnUpdate() / public void isBidiTextSupportedOnUpdate(boolean value)
Gets or sets the value indicating whether bidirectional text is fully supported during field update or not.

When this property is set to true, additional steps are performed to produce Right-To-Left language (i.e. Arabic or Hebrew) compatible field result during its update.

When this property is set to false and Right-To-Left language is used, correctness of field result after its update is not guaranteed.

The default value is false.


getUserPromptRespondent/setUserPromptRespondent

public IFieldUserPromptRespondent getUserPromptRespondent() / public void setUserPromptRespondent(IFieldUserPromptRespondent value)
Gets or sets the respondent to user prompts during field update.

If the value of this property is set to null, the fields that require user response on prompting (such as ASK or FILLIN) are not updated.

The default value is null.


See Also:
          Aspose.Words Documentation - the home page for the Aspose.Words Product Documentation.
          Aspose.Words Support Forum - our preferred method of support.