com.aspose.words

Class FieldFormat

java.lang.Object

com.aspose.words.FieldFormat

public class FieldFormat
extends java.lang.Object

Provides typed access to field's numeric, date and time, and general formatting.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDateTimeFormat() Gets a formatting that is applied to a date and time field result.
GeneralFormatCollection	getGeneralFormats() Gets a collection of general formats that are applied to a numeric, text or any field result.
java.lang.String	getNumericFormat() Gets a formatting that is applied to a numeric field result.
void	setDateTimeFormat(java.lang.String value) Sets a formatting that is applied to a date and time field result.
void	setNumericFormat(java.lang.String value) Sets a formatting that is applied to a numeric field result.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getNumericFormat

public java.lang.String getNumericFormat()

Gets a formatting that is applied to a numeric field result. Corresponds to the \# switch.

Returns:

A formatting that is applied to a numeric field result.

setNumericFormat

public void setNumericFormat(java.lang.String value)
                      throws java.lang.Exception

Sets a formatting that is applied to a numeric field result. Corresponds to the \# switch.

Parameters:

value - A formatting that is applied to a numeric field result.

Throws:

java.lang.Exception

getDateTimeFormat

public java.lang.String getDateTimeFormat()

Gets a formatting that is applied to a date and time field result. Corresponds to the \@ switch.

Returns:

A formatting that is applied to a date and time field result.

setDateTimeFormat

public void setDateTimeFormat(java.lang.String value)
                       throws java.lang.Exception

Sets a formatting that is applied to a date and time field result. Corresponds to the \@ switch.

Parameters:

value - A formatting that is applied to a date and time field result.

Throws:

java.lang.Exception

getGeneralFormats

public GeneralFormatCollection getGeneralFormats()

Gets a collection of general formats that are applied to a numeric, text or any field result. Corresponds to the \* switches.

Returns:

A collection of general formats that are applied to a numeric, text or any field result.