com.aspose.words

Class FieldSymbol

java.lang.Object

com.aspose.words.Field

com.aspose.words.FieldSymbol

public class FieldSymbol
extends Field

Implements a SYMBOL field.

To learn more, visit the Working with Fields documentation article.

Remarks:

Retrieves the character whose code point value is specified in decimal or hexadecimal.

Examples:

Shows how to use the SYMBOL field.

 
 Document doc = new Document();
 DocumentBuilder builder = new DocumentBuilder(doc);

 // Below are three ways to use a SYMBOL field to display a single character.
 // 1 -  Add a SYMBOL field which displays the © (Copyright) symbol, specified by an ANSI character code:
 FieldSymbol field = (FieldSymbol) builder.insertField(FieldType.FIELD_SYMBOL, true);

 // The ANSI character code "U+00A9", or "169" in integer form, is reserved for the copyright symbol.
 field.setCharacterCode(Integer.toString(0x00a9));
 field.isAnsi(true);

 Assert.assertEquals(field.getFieldCode(), " SYMBOL  169 \\a");

 builder.writeln(" Line 1");

 // 2 -  Add a SYMBOL field which displays the ∞ (Infinity) symbol, and modify its appearance:
 field = (FieldSymbol) builder.insertField(FieldType.FIELD_SYMBOL, true);

 // In Unicode, the infinity symbol occupies the "221E" code.
 field.setCharacterCode(Integer.toString(0x221E));
 field.isUnicode(true);

 // Change the font of our symbol after using the Windows Character Map
 // to ensure that the font can represent that symbol.
 field.setFontName("Calibri");
 field.setFontSize("24");

 // We can set this flag for tall symbols to make them not push down the rest of the text on their line.
 field.setDontAffectsLineSpacing(true);

 Assert.assertEquals(field.getFieldCode(), " SYMBOL  8734 \\u \\f Calibri \\s 24 \\h");

 builder.writeln("Line 2");

 // 3 -  Add a SYMBOL field which displays the あ character,
 // with a font that supports Shift-JIS (Windows-932) codepage:
 field = (FieldSymbol) builder.insertField(FieldType.FIELD_SYMBOL, true);
 field.setFontName("MS Gothic");
 field.setCharacterCode(Integer.toString(0x82A0));
 field.isShiftJis(true);

 Assert.assertEquals(field.getFieldCode(), " SYMBOL  33440 \\f \"MS Gothic\" \\j");

 builder.write("Line 3");

 doc.save(getArtifactsDir() + "Field.SYMBOL.docx");
 
 

Method Summary

Modifier and Type	Method and Description
java.lang.String	getCharacterCode() Gets the character's code point value in decimal or hexadecimal.
boolean	getDontAffectsLineSpacing() Gets whether the character retrieved by the field affects the line spacing of the paragraph.
java.lang.String	getFontName() Gets the name of the font of the character retrieved by the field.
java.lang.String	getFontSize() Gets the size in points of the font of the character retrieved by the field.
int	getSwitchType(java.lang.String switchName)
boolean	isAnsi() Gets whether the character code is interpreted as the value of an ANSI character.
void	isAnsi(boolean value) Sets whether the character code is interpreted as the value of an ANSI character.
boolean	isShiftJis() Gets whether the character code is interpreted as the value of a SHIFT-JIS character.
void	isShiftJis(boolean value) Sets whether the character code is interpreted as the value of a SHIFT-JIS character.
boolean	isUnicode() Gets whether the character code is interpreted as the value of a Unicode character.
void	isUnicode(boolean value) Sets whether the character code is interpreted as the value of a Unicode character.
void	setCharacterCode(java.lang.String value) Sets the character's code point value in decimal or hexadecimal.
void	setDontAffectsLineSpacing(boolean value) Sets whether the character retrieved by the field affects the line spacing of the paragraph.
void	setFontName(java.lang.String value) Sets the name of the font of the character retrieved by the field.
void	setFontSize(java.lang.String value) Sets the size in points of the font of the character retrieved by the field.

Methods inherited from class com.aspose.words.Field

getDisplayResult, getEnd, getFieldCode, getFieldCode, getFormat, getLocaleId, getResult, getSeparator, getStart, getType, isDirty, isDirty, isLocked, isLocked, needStoreOldResultNodes, remove, setLocaleId, setResult, unlink, update, update

Methods inherited from class java.lang.Object

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

Method Detail

getCharacterCode

public java.lang.String getCharacterCode()

Gets the character's code point value in decimal or hexadecimal.

Examples:

Shows how to use the SYMBOL field.

 
 Document doc = new Document();
 DocumentBuilder builder = new DocumentBuilder(doc);

 // Below are three ways to use a SYMBOL field to display a single character.
 // 1 -  Add a SYMBOL field which displays the © (Copyright) symbol, specified by an ANSI character code:
 FieldSymbol field = (FieldSymbol) builder.insertField(FieldType.FIELD_SYMBOL, true);

 // The ANSI character code "U+00A9", or "169" in integer form, is reserved for the copyright symbol.
 field.setCharacterCode(Integer.toString(0x00a9));
 field.isAnsi(true);

 Assert.assertEquals(field.getFieldCode(), " SYMBOL  169 \\a");

 builder.writeln(" Line 1");

 // 2 -  Add a SYMBOL field which displays the ∞ (Infinity) symbol, and modify its appearance:
 field = (FieldSymbol) builder.insertField(FieldType.FIELD_SYMBOL, true);

 // In Unicode, the infinity symbol occupies the "221E" code.
 field.setCharacterCode(Integer.toString(0x221E));
 field.isUnicode(true);

 // Change the font of our symbol after using the Windows Character Map
 // to ensure that the font can represent that symbol.
 field.setFontName("Calibri");
 field.setFontSize("24");

 // We can set this flag for tall symbols to make them not push down the rest of the text on their line.
 field.setDontAffectsLineSpacing(true);

 Assert.assertEquals(field.getFieldCode(), " SYMBOL  8734 \\u \\f Calibri \\s 24 \\h");

 builder.writeln("Line 2");

 // 3 -  Add a SYMBOL field which displays the あ character,
 // with a font that supports Shift-JIS (Windows-932) codepage:
 field = (FieldSymbol) builder.insertField(FieldType.FIELD_SYMBOL, true);
 field.setFontName("MS Gothic");
 field.setCharacterCode(Integer.toString(0x82A0));
 field.isShiftJis(true);

 Assert.assertEquals(field.getFieldCode(), " SYMBOL  33440 \\f \"MS Gothic\" \\j");

 builder.write("Line 3");

 doc.save(getArtifactsDir() + "Field.SYMBOL.docx");
 
 

Returns:

The character's code point value in decimal or hexadecimal.

setCharacterCode

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

Sets the character's code point value in decimal or hexadecimal.

Examples:

Shows how to use the SYMBOL field.

 
 Document doc = new Document();
 DocumentBuilder builder = new DocumentBuilder(doc);

 // Below are three ways to use a SYMBOL field to display a single character.
 // 1 -  Add a SYMBOL field which displays the © (Copyright) symbol, specified by an ANSI character code:
 FieldSymbol field = (FieldSymbol) builder.insertField(FieldType.FIELD_SYMBOL, true);

 // The ANSI character code "U+00A9", or "169" in integer form, is reserved for the copyright symbol.
 field.setCharacterCode(Integer.toString(0x00a9));
 field.isAnsi(true);

 Assert.assertEquals(field.getFieldCode(), " SYMBOL  169 \\a");

 builder.writeln(" Line 1");

 // 2 -  Add a SYMBOL field which displays the ∞ (Infinity) symbol, and modify its appearance:
 field = (FieldSymbol) builder.insertField(FieldType.FIELD_SYMBOL, true);

 // In Unicode, the infinity symbol occupies the "221E" code.
 field.setCharacterCode(Integer.toString(0x221E));
 field.isUnicode(true);

 // Change the font of our symbol after using the Windows Character Map
 // to ensure that the font can represent that symbol.
 field.setFontName("Calibri");
 field.setFontSize("24");

 // We can set this flag for tall symbols to make them not push down the rest of the text on their line.
 field.setDontAffectsLineSpacing(true);

 Assert.assertEquals(field.getFieldCode(), " SYMBOL  8734 \\u \\f Calibri \\s 24 \\h");

 builder.writeln("Line 2");

 // 3 -  Add a SYMBOL field which displays the あ character,
 // with a font that supports Shift-JIS (Windows-932) codepage:
 field = (FieldSymbol) builder.insertField(FieldType.FIELD_SYMBOL, true);
 field.setFontName("MS Gothic");
 field.setCharacterCode(Integer.toString(0x82A0));
 field.isShiftJis(true);

 Assert.assertEquals(field.getFieldCode(), " SYMBOL  33440 \\f \"MS Gothic\" \\j");

 builder.write("Line 3");

 doc.save(getArtifactsDir() + "Field.SYMBOL.docx");
 
 

Parameters:

value - The character's code point value in decimal or hexadecimal.

Throws:

java.lang.Exception

getSwitchType

public int getSwitchType(java.lang.String switchName)

getFontName

public java.lang.String getFontName()

Gets the name of the font of the character retrieved by the field.

Examples:

Shows how to use the SYMBOL field.

 
 Document doc = new Document();
 DocumentBuilder builder = new DocumentBuilder(doc);

 // Below are three ways to use a SYMBOL field to display a single character.
 // 1 -  Add a SYMBOL field which displays the © (Copyright) symbol, specified by an ANSI character code:
 FieldSymbol field = (FieldSymbol) builder.insertField(FieldType.FIELD_SYMBOL, true);

 // The ANSI character code "U+00A9", or "169" in integer form, is reserved for the copyright symbol.
 field.setCharacterCode(Integer.toString(0x00a9));
 field.isAnsi(true);

 Assert.assertEquals(field.getFieldCode(), " SYMBOL  169 \\a");

 builder.writeln(" Line 1");

 // 2 -  Add a SYMBOL field which displays the ∞ (Infinity) symbol, and modify its appearance:
 field = (FieldSymbol) builder.insertField(FieldType.FIELD_SYMBOL, true);

 // In Unicode, the infinity symbol occupies the "221E" code.
 field.setCharacterCode(Integer.toString(0x221E));
 field.isUnicode(true);

 // Change the font of our symbol after using the Windows Character Map
 // to ensure that the font can represent that symbol.
 field.setFontName("Calibri");
 field.setFontSize("24");

 // We can set this flag for tall symbols to make them not push down the rest of the text on their line.
 field.setDontAffectsLineSpacing(true);

 Assert.assertEquals(field.getFieldCode(), " SYMBOL  8734 \\u \\f Calibri \\s 24 \\h");

 builder.writeln("Line 2");

 // 3 -  Add a SYMBOL field which displays the あ character,
 // with a font that supports Shift-JIS (Windows-932) codepage:
 field = (FieldSymbol) builder.insertField(FieldType.FIELD_SYMBOL, true);
 field.setFontName("MS Gothic");
 field.setCharacterCode(Integer.toString(0x82A0));
 field.isShiftJis(true);

 Assert.assertEquals(field.getFieldCode(), " SYMBOL  33440 \\f \"MS Gothic\" \\j");

 builder.write("Line 3");

 doc.save(getArtifactsDir() + "Field.SYMBOL.docx");
 
 

Returns:

The name of the font of the character retrieved by the field.

setFontName

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

Sets the name of the font of the character retrieved by the field.

Examples:

Shows how to use the SYMBOL field.

 
 Document doc = new Document();
 DocumentBuilder builder = new DocumentBuilder(doc);

 // Below are three ways to use a SYMBOL field to display a single character.
 // 1 -  Add a SYMBOL field which displays the © (Copyright) symbol, specified by an ANSI character code:
 FieldSymbol field = (FieldSymbol) builder.insertField(FieldType.FIELD_SYMBOL, true);

 // The ANSI character code "U+00A9", or "169" in integer form, is reserved for the copyright symbol.
 field.setCharacterCode(Integer.toString(0x00a9));
 field.isAnsi(true);

 Assert.assertEquals(field.getFieldCode(), " SYMBOL  169 \\a");

 builder.writeln(" Line 1");

 // 2 -  Add a SYMBOL field which displays the ∞ (Infinity) symbol, and modify its appearance:
 field = (FieldSymbol) builder.insertField(FieldType.FIELD_SYMBOL, true);

 // In Unicode, the infinity symbol occupies the "221E" code.
 field.setCharacterCode(Integer.toString(0x221E));
 field.isUnicode(true);

 // Change the font of our symbol after using the Windows Character Map
 // to ensure that the font can represent that symbol.
 field.setFontName("Calibri");
 field.setFontSize("24");

 // We can set this flag for tall symbols to make them not push down the rest of the text on their line.
 field.setDontAffectsLineSpacing(true);

 Assert.assertEquals(field.getFieldCode(), " SYMBOL  8734 \\u \\f Calibri \\s 24 \\h");

 builder.writeln("Line 2");

 // 3 -  Add a SYMBOL field which displays the あ character,
 // with a font that supports Shift-JIS (Windows-932) codepage:
 field = (FieldSymbol) builder.insertField(FieldType.FIELD_SYMBOL, true);
 field.setFontName("MS Gothic");
 field.setCharacterCode(Integer.toString(0x82A0));
 field.isShiftJis(true);

 Assert.assertEquals(field.getFieldCode(), " SYMBOL  33440 \\f \"MS Gothic\" \\j");

 builder.write("Line 3");

 doc.save(getArtifactsDir() + "Field.SYMBOL.docx");
 
 

Parameters:

value - The name of the font of the character retrieved by the field.

Throws:

java.lang.Exception

getFontSize

public java.lang.String getFontSize()

Gets the size in points of the font of the character retrieved by the field.

Examples:

Shows how to use the SYMBOL field.

 
 Document doc = new Document();
 DocumentBuilder builder = new DocumentBuilder(doc);

 // Below are three ways to use a SYMBOL field to display a single character.
 // 1 -  Add a SYMBOL field which displays the © (Copyright) symbol, specified by an ANSI character code:
 FieldSymbol field = (FieldSymbol) builder.insertField(FieldType.FIELD_SYMBOL, true);

 // The ANSI character code "U+00A9", or "169" in integer form, is reserved for the copyright symbol.
 field.setCharacterCode(Integer.toString(0x00a9));
 field.isAnsi(true);

 Assert.assertEquals(field.getFieldCode(), " SYMBOL  169 \\a");

 builder.writeln(" Line 1");

 // 2 -  Add a SYMBOL field which displays the ∞ (Infinity) symbol, and modify its appearance:
 field = (FieldSymbol) builder.insertField(FieldType.FIELD_SYMBOL, true);

 // In Unicode, the infinity symbol occupies the "221E" code.
 field.setCharacterCode(Integer.toString(0x221E));
 field.isUnicode(true);

 // Change the font of our symbol after using the Windows Character Map
 // to ensure that the font can represent that symbol.
 field.setFontName("Calibri");
 field.setFontSize("24");

 // We can set this flag for tall symbols to make them not push down the rest of the text on their line.
 field.setDontAffectsLineSpacing(true);

 Assert.assertEquals(field.getFieldCode(), " SYMBOL  8734 \\u \\f Calibri \\s 24 \\h");

 builder.writeln("Line 2");

 // 3 -  Add a SYMBOL field which displays the あ character,
 // with a font that supports Shift-JIS (Windows-932) codepage:
 field = (FieldSymbol) builder.insertField(FieldType.FIELD_SYMBOL, true);
 field.setFontName("MS Gothic");
 field.setCharacterCode(Integer.toString(0x82A0));
 field.isShiftJis(true);

 Assert.assertEquals(field.getFieldCode(), " SYMBOL  33440 \\f \"MS Gothic\" \\j");

 builder.write("Line 3");

 doc.save(getArtifactsDir() + "Field.SYMBOL.docx");
 
 

Returns:

The size in points of the font of the character retrieved by the field.

setFontSize

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

Sets the size in points of the font of the character retrieved by the field.

Examples:

Shows how to use the SYMBOL field.

 
 Document doc = new Document();
 DocumentBuilder builder = new DocumentBuilder(doc);

 // Below are three ways to use a SYMBOL field to display a single character.
 // 1 -  Add a SYMBOL field which displays the © (Copyright) symbol, specified by an ANSI character code:
 FieldSymbol field = (FieldSymbol) builder.insertField(FieldType.FIELD_SYMBOL, true);

 // The ANSI character code "U+00A9", or "169" in integer form, is reserved for the copyright symbol.
 field.setCharacterCode(Integer.toString(0x00a9));
 field.isAnsi(true);

 Assert.assertEquals(field.getFieldCode(), " SYMBOL  169 \\a");

 builder.writeln(" Line 1");

 // 2 -  Add a SYMBOL field which displays the ∞ (Infinity) symbol, and modify its appearance:
 field = (FieldSymbol) builder.insertField(FieldType.FIELD_SYMBOL, true);

 // In Unicode, the infinity symbol occupies the "221E" code.
 field.setCharacterCode(Integer.toString(0x221E));
 field.isUnicode(true);

 // Change the font of our symbol after using the Windows Character Map
 // to ensure that the font can represent that symbol.
 field.setFontName("Calibri");
 field.setFontSize("24");

 // We can set this flag for tall symbols to make them not push down the rest of the text on their line.
 field.setDontAffectsLineSpacing(true);

 Assert.assertEquals(field.getFieldCode(), " SYMBOL  8734 \\u \\f Calibri \\s 24 \\h");

 builder.writeln("Line 2");

 // 3 -  Add a SYMBOL field which displays the あ character,
 // with a font that supports Shift-JIS (Windows-932) codepage:
 field = (FieldSymbol) builder.insertField(FieldType.FIELD_SYMBOL, true);
 field.setFontName("MS Gothic");
 field.setCharacterCode(Integer.toString(0x82A0));
 field.isShiftJis(true);

 Assert.assertEquals(field.getFieldCode(), " SYMBOL  33440 \\f \"MS Gothic\" \\j");

 builder.write("Line 3");

 doc.save(getArtifactsDir() + "Field.SYMBOL.docx");
 
 

Parameters:

value - The size in points of the font of the character retrieved by the field.

Throws:

java.lang.Exception

isAnsi

public boolean isAnsi()

Gets whether the character code is interpreted as the value of an ANSI character.

Examples:

Shows how to use the SYMBOL field.

 
 Document doc = new Document();
 DocumentBuilder builder = new DocumentBuilder(doc);

 // Below are three ways to use a SYMBOL field to display a single character.
 // 1 -  Add a SYMBOL field which displays the © (Copyright) symbol, specified by an ANSI character code:
 FieldSymbol field = (FieldSymbol) builder.insertField(FieldType.FIELD_SYMBOL, true);

 // The ANSI character code "U+00A9", or "169" in integer form, is reserved for the copyright symbol.
 field.setCharacterCode(Integer.toString(0x00a9));
 field.isAnsi(true);

 Assert.assertEquals(field.getFieldCode(), " SYMBOL  169 \\a");

 builder.writeln(" Line 1");

 // 2 -  Add a SYMBOL field which displays the ∞ (Infinity) symbol, and modify its appearance:
 field = (FieldSymbol) builder.insertField(FieldType.FIELD_SYMBOL, true);

 // In Unicode, the infinity symbol occupies the "221E" code.
 field.setCharacterCode(Integer.toString(0x221E));
 field.isUnicode(true);

 // Change the font of our symbol after using the Windows Character Map
 // to ensure that the font can represent that symbol.
 field.setFontName("Calibri");
 field.setFontSize("24");

 // We can set this flag for tall symbols to make them not push down the rest of the text on their line.
 field.setDontAffectsLineSpacing(true);

 Assert.assertEquals(field.getFieldCode(), " SYMBOL  8734 \\u \\f Calibri \\s 24 \\h");

 builder.writeln("Line 2");

 // 3 -  Add a SYMBOL field which displays the あ character,
 // with a font that supports Shift-JIS (Windows-932) codepage:
 field = (FieldSymbol) builder.insertField(FieldType.FIELD_SYMBOL, true);
 field.setFontName("MS Gothic");
 field.setCharacterCode(Integer.toString(0x82A0));
 field.isShiftJis(true);

 Assert.assertEquals(field.getFieldCode(), " SYMBOL  33440 \\f \"MS Gothic\" \\j");

 builder.write("Line 3");

 doc.save(getArtifactsDir() + "Field.SYMBOL.docx");
 
 

Returns:

Whether the character code is interpreted as the value of an ANSI character.

isAnsi

public void isAnsi(boolean value)
            throws java.lang.Exception

Sets whether the character code is interpreted as the value of an ANSI character.

Examples:

Shows how to use the SYMBOL field.

 
 Document doc = new Document();
 DocumentBuilder builder = new DocumentBuilder(doc);

 // Below are three ways to use a SYMBOL field to display a single character.
 // 1 -  Add a SYMBOL field which displays the © (Copyright) symbol, specified by an ANSI character code:
 FieldSymbol field = (FieldSymbol) builder.insertField(FieldType.FIELD_SYMBOL, true);

 // The ANSI character code "U+00A9", or "169" in integer form, is reserved for the copyright symbol.
 field.setCharacterCode(Integer.toString(0x00a9));
 field.isAnsi(true);

 Assert.assertEquals(field.getFieldCode(), " SYMBOL  169 \\a");

 builder.writeln(" Line 1");

 // 2 -  Add a SYMBOL field which displays the ∞ (Infinity) symbol, and modify its appearance:
 field = (FieldSymbol) builder.insertField(FieldType.FIELD_SYMBOL, true);

 // In Unicode, the infinity symbol occupies the "221E" code.
 field.setCharacterCode(Integer.toString(0x221E));
 field.isUnicode(true);

 // Change the font of our symbol after using the Windows Character Map
 // to ensure that the font can represent that symbol.
 field.setFontName("Calibri");
 field.setFontSize("24");

 // We can set this flag for tall symbols to make them not push down the rest of the text on their line.
 field.setDontAffectsLineSpacing(true);

 Assert.assertEquals(field.getFieldCode(), " SYMBOL  8734 \\u \\f Calibri \\s 24 \\h");

 builder.writeln("Line 2");

 // 3 -  Add a SYMBOL field which displays the あ character,
 // with a font that supports Shift-JIS (Windows-932) codepage:
 field = (FieldSymbol) builder.insertField(FieldType.FIELD_SYMBOL, true);
 field.setFontName("MS Gothic");
 field.setCharacterCode(Integer.toString(0x82A0));
 field.isShiftJis(true);

 Assert.assertEquals(field.getFieldCode(), " SYMBOL  33440 \\f \"MS Gothic\" \\j");

 builder.write("Line 3");

 doc.save(getArtifactsDir() + "Field.SYMBOL.docx");
 
 

Parameters:

value - Whether the character code is interpreted as the value of an ANSI character.

Throws:

java.lang.Exception

isUnicode

public boolean isUnicode()

Gets whether the character code is interpreted as the value of a Unicode character.

Examples:

Shows how to use the SYMBOL field.

 
 Document doc = new Document();
 DocumentBuilder builder = new DocumentBuilder(doc);

 // Below are three ways to use a SYMBOL field to display a single character.
 // 1 -  Add a SYMBOL field which displays the © (Copyright) symbol, specified by an ANSI character code:
 FieldSymbol field = (FieldSymbol) builder.insertField(FieldType.FIELD_SYMBOL, true);

 // The ANSI character code "U+00A9", or "169" in integer form, is reserved for the copyright symbol.
 field.setCharacterCode(Integer.toString(0x00a9));
 field.isAnsi(true);

 Assert.assertEquals(field.getFieldCode(), " SYMBOL  169 \\a");

 builder.writeln(" Line 1");

 // 2 -  Add a SYMBOL field which displays the ∞ (Infinity) symbol, and modify its appearance:
 field = (FieldSymbol) builder.insertField(FieldType.FIELD_SYMBOL, true);

 // In Unicode, the infinity symbol occupies the "221E" code.
 field.setCharacterCode(Integer.toString(0x221E));
 field.isUnicode(true);

 // Change the font of our symbol after using the Windows Character Map
 // to ensure that the font can represent that symbol.
 field.setFontName("Calibri");
 field.setFontSize("24");

 // We can set this flag for tall symbols to make them not push down the rest of the text on their line.
 field.setDontAffectsLineSpacing(true);

 Assert.assertEquals(field.getFieldCode(), " SYMBOL  8734 \\u \\f Calibri \\s 24 \\h");

 builder.writeln("Line 2");

 // 3 -  Add a SYMBOL field which displays the あ character,
 // with a font that supports Shift-JIS (Windows-932) codepage:
 field = (FieldSymbol) builder.insertField(FieldType.FIELD_SYMBOL, true);
 field.setFontName("MS Gothic");
 field.setCharacterCode(Integer.toString(0x82A0));
 field.isShiftJis(true);

 Assert.assertEquals(field.getFieldCode(), " SYMBOL  33440 \\f \"MS Gothic\" \\j");

 builder.write("Line 3");

 doc.save(getArtifactsDir() + "Field.SYMBOL.docx");
 
 

Returns:

Whether the character code is interpreted as the value of a Unicode character.

isUnicode

public void isUnicode(boolean value)
               throws java.lang.Exception

Sets whether the character code is interpreted as the value of a Unicode character.

Examples:

Shows how to use the SYMBOL field.

 
 Document doc = new Document();
 DocumentBuilder builder = new DocumentBuilder(doc);

 // Below are three ways to use a SYMBOL field to display a single character.
 // 1 -  Add a SYMBOL field which displays the © (Copyright) symbol, specified by an ANSI character code:
 FieldSymbol field = (FieldSymbol) builder.insertField(FieldType.FIELD_SYMBOL, true);

 // The ANSI character code "U+00A9", or "169" in integer form, is reserved for the copyright symbol.
 field.setCharacterCode(Integer.toString(0x00a9));
 field.isAnsi(true);

 Assert.assertEquals(field.getFieldCode(), " SYMBOL  169 \\a");

 builder.writeln(" Line 1");

 // 2 -  Add a SYMBOL field which displays the ∞ (Infinity) symbol, and modify its appearance:
 field = (FieldSymbol) builder.insertField(FieldType.FIELD_SYMBOL, true);

 // In Unicode, the infinity symbol occupies the "221E" code.
 field.setCharacterCode(Integer.toString(0x221E));
 field.isUnicode(true);

 // Change the font of our symbol after using the Windows Character Map
 // to ensure that the font can represent that symbol.
 field.setFontName("Calibri");
 field.setFontSize("24");

 // We can set this flag for tall symbols to make them not push down the rest of the text on their line.
 field.setDontAffectsLineSpacing(true);

 Assert.assertEquals(field.getFieldCode(), " SYMBOL  8734 \\u \\f Calibri \\s 24 \\h");

 builder.writeln("Line 2");

 // 3 -  Add a SYMBOL field which displays the あ character,
 // with a font that supports Shift-JIS (Windows-932) codepage:
 field = (FieldSymbol) builder.insertField(FieldType.FIELD_SYMBOL, true);
 field.setFontName("MS Gothic");
 field.setCharacterCode(Integer.toString(0x82A0));
 field.isShiftJis(true);

 Assert.assertEquals(field.getFieldCode(), " SYMBOL  33440 \\f \"MS Gothic\" \\j");

 builder.write("Line 3");

 doc.save(getArtifactsDir() + "Field.SYMBOL.docx");
 
 

Parameters:

value - Whether the character code is interpreted as the value of a Unicode character.

Throws:

java.lang.Exception

isShiftJis

public boolean isShiftJis()

Gets whether the character code is interpreted as the value of a SHIFT-JIS character.

Examples:

Shows how to use the SYMBOL field.

 
 Document doc = new Document();
 DocumentBuilder builder = new DocumentBuilder(doc);

 // Below are three ways to use a SYMBOL field to display a single character.
 // 1 -  Add a SYMBOL field which displays the © (Copyright) symbol, specified by an ANSI character code:
 FieldSymbol field = (FieldSymbol) builder.insertField(FieldType.FIELD_SYMBOL, true);

 // The ANSI character code "U+00A9", or "169" in integer form, is reserved for the copyright symbol.
 field.setCharacterCode(Integer.toString(0x00a9));
 field.isAnsi(true);

 Assert.assertEquals(field.getFieldCode(), " SYMBOL  169 \\a");

 builder.writeln(" Line 1");

 // 2 -  Add a SYMBOL field which displays the ∞ (Infinity) symbol, and modify its appearance:
 field = (FieldSymbol) builder.insertField(FieldType.FIELD_SYMBOL, true);

 // In Unicode, the infinity symbol occupies the "221E" code.
 field.setCharacterCode(Integer.toString(0x221E));
 field.isUnicode(true);

 // Change the font of our symbol after using the Windows Character Map
 // to ensure that the font can represent that symbol.
 field.setFontName("Calibri");
 field.setFontSize("24");

 // We can set this flag for tall symbols to make them not push down the rest of the text on their line.
 field.setDontAffectsLineSpacing(true);

 Assert.assertEquals(field.getFieldCode(), " SYMBOL  8734 \\u \\f Calibri \\s 24 \\h");

 builder.writeln("Line 2");

 // 3 -  Add a SYMBOL field which displays the あ character,
 // with a font that supports Shift-JIS (Windows-932) codepage:
 field = (FieldSymbol) builder.insertField(FieldType.FIELD_SYMBOL, true);
 field.setFontName("MS Gothic");
 field.setCharacterCode(Integer.toString(0x82A0));
 field.isShiftJis(true);

 Assert.assertEquals(field.getFieldCode(), " SYMBOL  33440 \\f \"MS Gothic\" \\j");

 builder.write("Line 3");

 doc.save(getArtifactsDir() + "Field.SYMBOL.docx");
 
 

Returns:

Whether the character code is interpreted as the value of a SHIFT-JIS character.

isShiftJis

public void isShiftJis(boolean value)
                throws java.lang.Exception

Sets whether the character code is interpreted as the value of a SHIFT-JIS character.

Examples:

Shows how to use the SYMBOL field.

 
 Document doc = new Document();
 DocumentBuilder builder = new DocumentBuilder(doc);

 // Below are three ways to use a SYMBOL field to display a single character.
 // 1 -  Add a SYMBOL field which displays the © (Copyright) symbol, specified by an ANSI character code:
 FieldSymbol field = (FieldSymbol) builder.insertField(FieldType.FIELD_SYMBOL, true);

 // The ANSI character code "U+00A9", or "169" in integer form, is reserved for the copyright symbol.
 field.setCharacterCode(Integer.toString(0x00a9));
 field.isAnsi(true);

 Assert.assertEquals(field.getFieldCode(), " SYMBOL  169 \\a");

 builder.writeln(" Line 1");

 // 2 -  Add a SYMBOL field which displays the ∞ (Infinity) symbol, and modify its appearance:
 field = (FieldSymbol) builder.insertField(FieldType.FIELD_SYMBOL, true);

 // In Unicode, the infinity symbol occupies the "221E" code.
 field.setCharacterCode(Integer.toString(0x221E));
 field.isUnicode(true);

 // Change the font of our symbol after using the Windows Character Map
 // to ensure that the font can represent that symbol.
 field.setFontName("Calibri");
 field.setFontSize("24");

 // We can set this flag for tall symbols to make them not push down the rest of the text on their line.
 field.setDontAffectsLineSpacing(true);

 Assert.assertEquals(field.getFieldCode(), " SYMBOL  8734 \\u \\f Calibri \\s 24 \\h");

 builder.writeln("Line 2");

 // 3 -  Add a SYMBOL field which displays the あ character,
 // with a font that supports Shift-JIS (Windows-932) codepage:
 field = (FieldSymbol) builder.insertField(FieldType.FIELD_SYMBOL, true);
 field.setFontName("MS Gothic");
 field.setCharacterCode(Integer.toString(0x82A0));
 field.isShiftJis(true);

 Assert.assertEquals(field.getFieldCode(), " SYMBOL  33440 \\f \"MS Gothic\" \\j");

 builder.write("Line 3");

 doc.save(getArtifactsDir() + "Field.SYMBOL.docx");
 
 

Parameters:

value - Whether the character code is interpreted as the value of a SHIFT-JIS character.

Throws:

java.lang.Exception

getDontAffectsLineSpacing

public boolean getDontAffectsLineSpacing()

Gets whether the character retrieved by the field affects the line spacing of the paragraph.

Examples:

Shows how to use the SYMBOL field.

 
 Document doc = new Document();
 DocumentBuilder builder = new DocumentBuilder(doc);

 // Below are three ways to use a SYMBOL field to display a single character.
 // 1 -  Add a SYMBOL field which displays the © (Copyright) symbol, specified by an ANSI character code:
 FieldSymbol field = (FieldSymbol) builder.insertField(FieldType.FIELD_SYMBOL, true);

 // The ANSI character code "U+00A9", or "169" in integer form, is reserved for the copyright symbol.
 field.setCharacterCode(Integer.toString(0x00a9));
 field.isAnsi(true);

 Assert.assertEquals(field.getFieldCode(), " SYMBOL  169 \\a");

 builder.writeln(" Line 1");

 // 2 -  Add a SYMBOL field which displays the ∞ (Infinity) symbol, and modify its appearance:
 field = (FieldSymbol) builder.insertField(FieldType.FIELD_SYMBOL, true);

 // In Unicode, the infinity symbol occupies the "221E" code.
 field.setCharacterCode(Integer.toString(0x221E));
 field.isUnicode(true);

 // Change the font of our symbol after using the Windows Character Map
 // to ensure that the font can represent that symbol.
 field.setFontName("Calibri");
 field.setFontSize("24");

 // We can set this flag for tall symbols to make them not push down the rest of the text on their line.
 field.setDontAffectsLineSpacing(true);

 Assert.assertEquals(field.getFieldCode(), " SYMBOL  8734 \\u \\f Calibri \\s 24 \\h");

 builder.writeln("Line 2");

 // 3 -  Add a SYMBOL field which displays the あ character,
 // with a font that supports Shift-JIS (Windows-932) codepage:
 field = (FieldSymbol) builder.insertField(FieldType.FIELD_SYMBOL, true);
 field.setFontName("MS Gothic");
 field.setCharacterCode(Integer.toString(0x82A0));
 field.isShiftJis(true);

 Assert.assertEquals(field.getFieldCode(), " SYMBOL  33440 \\f \"MS Gothic\" \\j");

 builder.write("Line 3");

 doc.save(getArtifactsDir() + "Field.SYMBOL.docx");
 
 

Returns:

Whether the character retrieved by the field affects the line spacing of the paragraph.

setDontAffectsLineSpacing

public void setDontAffectsLineSpacing(boolean value)
                               throws java.lang.Exception

Sets whether the character retrieved by the field affects the line spacing of the paragraph.

Examples:

Shows how to use the SYMBOL field.

 
 Document doc = new Document();
 DocumentBuilder builder = new DocumentBuilder(doc);

 // Below are three ways to use a SYMBOL field to display a single character.
 // 1 -  Add a SYMBOL field which displays the © (Copyright) symbol, specified by an ANSI character code:
 FieldSymbol field = (FieldSymbol) builder.insertField(FieldType.FIELD_SYMBOL, true);

 // The ANSI character code "U+00A9", or "169" in integer form, is reserved for the copyright symbol.
 field.setCharacterCode(Integer.toString(0x00a9));
 field.isAnsi(true);

 Assert.assertEquals(field.getFieldCode(), " SYMBOL  169 \\a");

 builder.writeln(" Line 1");

 // 2 -  Add a SYMBOL field which displays the ∞ (Infinity) symbol, and modify its appearance:
 field = (FieldSymbol) builder.insertField(FieldType.FIELD_SYMBOL, true);

 // In Unicode, the infinity symbol occupies the "221E" code.
 field.setCharacterCode(Integer.toString(0x221E));
 field.isUnicode(true);

 // Change the font of our symbol after using the Windows Character Map
 // to ensure that the font can represent that symbol.
 field.setFontName("Calibri");
 field.setFontSize("24");

 // We can set this flag for tall symbols to make them not push down the rest of the text on their line.
 field.setDontAffectsLineSpacing(true);

 Assert.assertEquals(field.getFieldCode(), " SYMBOL  8734 \\u \\f Calibri \\s 24 \\h");

 builder.writeln("Line 2");

 // 3 -  Add a SYMBOL field which displays the あ character,
 // with a font that supports Shift-JIS (Windows-932) codepage:
 field = (FieldSymbol) builder.insertField(FieldType.FIELD_SYMBOL, true);
 field.setFontName("MS Gothic");
 field.setCharacterCode(Integer.toString(0x82A0));
 field.isShiftJis(true);

 Assert.assertEquals(field.getFieldCode(), " SYMBOL  33440 \\f \"MS Gothic\" \\j");

 builder.write("Line 3");

 doc.save(getArtifactsDir() + "Field.SYMBOL.docx");
 
 

Parameters:

value - Whether the character retrieved by the field affects the line spacing of the paragraph.

Throws:

java.lang.Exception