com.aspose.words

Class FieldBuilder

java.lang.Object

com.aspose.words.FieldBuilder

public class FieldBuilder
extends java.lang.Object

Builds a field from field code tokens (arguments and switches).

Constructor Summary

Constructors

Constructor and Description
FieldBuilder(int fieldType) Initializes a new instance of this class.

Method Summary

Modifier and Type	Method and Description
FieldBuilder	addArgument(double argument) Adds a field's argument.
FieldBuilder	addArgument(FieldArgumentBuilder argument) Adds a field's argument represented by FieldArgumentBuilder to the field's code.
FieldBuilder	addArgument(FieldBuilder argument) Adds a child field represented by another FieldBuilder to the field's code.
FieldBuilder	addArgument(int argument) Adds a field's argument.
FieldBuilder	addArgument(java.lang.String argument) Adds a field's argument.
FieldBuilder	addSwitch(java.lang.String switchName) Adds a field's switch.
FieldBuilder	addSwitch(java.lang.String switchName, double switchArgument) Adds a field's switch.
FieldBuilder	addSwitch(java.lang.String switchName, int switchArgument) Adds a field's switch.
FieldBuilder	addSwitch(java.lang.String switchName, java.lang.String switchArgument) Adds a field's switch.
Field	buildAndInsert(Inline refNode) Builds and inserts a field into the document before the specified inline node.
Field	buildAndInsert(Paragraph refNode) Builds and inserts a field into the document to the end of the specified paragraph.
void	buildBlock(DocumentBuilder documentBuilder)

Methods inherited from class java.lang.Object

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

Constructor Detail

FieldBuilder

public FieldBuilder(int fieldType)

Initializes a new instance of this class.

Method Detail

addArgument

public FieldBuilder addArgument(java.lang.String argument)

Adds a field's argument.

Parameters:

argument - The argument value.

addArgument

public FieldBuilder addArgument(int argument)

Adds a field's argument.

Parameters:

argument - The argument value.

addArgument

public FieldBuilder addArgument(double argument)

Adds a field's argument.

Parameters:

argument - The argument value.

addArgument

public FieldBuilder addArgument(FieldBuilder argument)

Adds a child field represented by another FieldBuilder to the field's code. This overload is used when the argument consists of a single child field.

addArgument

public FieldBuilder addArgument(FieldArgumentBuilder argument)

Adds a field's argument represented by FieldArgumentBuilder to the field's code. This overload is used when the argument consists of a mixture of different parts such as child fields, nodes, and plain text.

addSwitch

public FieldBuilder addSwitch(java.lang.String switchName)

Adds a field's switch. This overload adds a flag (switch without argument).

Parameters:

switchName - The switch name.

addSwitch

public FieldBuilder addSwitch(java.lang.String switchName,
                              java.lang.String switchArgument)

Adds a field's switch.

Parameters:

switchName - The switch name.

switchArgument - The switch value.

addSwitch

public FieldBuilder addSwitch(java.lang.String switchName,
                              int switchArgument)

Adds a field's switch.

Parameters:

switchName - The switch name.

switchArgument - The switch value.

addSwitch

public FieldBuilder addSwitch(java.lang.String switchName,
                              double switchArgument)

Adds a field's switch.

Parameters:

switchName - The switch name.

switchArgument - The switch value.

buildAndInsert

public Field buildAndInsert(Inline refNode)
                     throws java.lang.Exception

Builds and inserts a field into the document before the specified inline node.

Returns:

A Field object that represents the inserted field.

Throws:

java.lang.Exception

buildAndInsert

public Field buildAndInsert(Paragraph refNode)
                     throws java.lang.Exception

Builds and inserts a field into the document to the end of the specified paragraph.

Returns:

A Field object that represents the inserted field.

Throws:

java.lang.Exception

buildBlock

public void buildBlock(DocumentBuilder documentBuilder)
                throws java.lang.Exception

Throws:

java.lang.Exception