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
IBarcodeGeneratorgetBarcodeGenerator()
voidsetBarcodeGenerator(IBarcodeGenerator value)
           Gets or set custom barcode generator.
java.lang.StringgetCustomTocStyleSeparator()
voidsetCustomTocStyleSeparator(java.lang.String value)
           Gets or sets custom style separator for the \t switch in TOC field.
java.lang.StringgetDefaultDocumentAuthor()
voidsetDefaultDocumentAuthor(java.lang.String value)
           Gets or sets default document author's name. If author's name is already specified in built-in document properties, this option is not considered.
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.
booleangetLegacyNumberFormat()
voidsetLegacyNumberFormat(boolean value)
           Gets or sets the value indicating whether legacy (early than AW 13.10) number format for fields is enabled or not.
booleangetUseInvariantCultureNumberFormat()
voidsetUseInvariantCultureNumberFormat(boolean value)
           Gets or sets the value indicating that number format is parsed using invariant culture or not
IFieldUserPromptRespondentgetUserPromptRespondent()
voidsetUserPromptRespondent(IFieldUserPromptRespondent value)
           Gets or sets the respondent to user prompts during field update.
 

Property Getters/Setters Detail

getBarcodeGenerator/setBarcodeGenerator

public IBarcodeGenerator getBarcodeGenerator() / public void setBarcodeGenerator(IBarcodeGenerator value)
Gets or set custom barcode generator. Custom barcode generator should implement public interface IBarcodeGenerator.

getCustomTocStyleSeparator/setCustomTocStyleSeparator

public java.lang.String getCustomTocStyleSeparator() / public void setCustomTocStyleSeparator(java.lang.String value)
Gets or sets custom style separator for the \t switch in TOC field. By default, custom styles defined by the \t switch in the TOC field are separated by a delimiter taken from the current culture. This property overrides that behaviour by specifying a user defined delimiter.

getDefaultDocumentAuthor/setDefaultDocumentAuthor

public java.lang.String getDefaultDocumentAuthor() / public void setDefaultDocumentAuthor(java.lang.String value)
Gets or sets default document author's name. If author's name is already specified in built-in document properties, this option is not considered.

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.


getLegacyNumberFormat/setLegacyNumberFormat

public boolean getLegacyNumberFormat() / public void setLegacyNumberFormat(boolean value)
Gets or sets the value indicating whether legacy (early than AW 13.10) number format for fields is enabled or not.

When this property is set to true, template symbol "#" worked as in .net: Replaces the pound sign with the corresponding digit if one is present; otherwise, no symbols appears in the result string.

When this property is set to false, template symbol "#" works as MS Word: This format item specifies the requisite numeric places to display in the result. If the result does not include a digit in that place, MS Word displays a space. For example, { = 9 + 6 \# $### } displays $ 15.

The default value is false.


getUseInvariantCultureNumberFormat/setUseInvariantCultureNumberFormat

public boolean getUseInvariantCultureNumberFormat() / public void setUseInvariantCultureNumberFormat(boolean value)
Gets or sets the value indicating that number format is parsed using invariant culture or not

When this property is set to true, number format is taken from an invariant culture.

When this property is set to false, number format is taken from the current thread's culture.

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.