com.aspose.words
Class FieldSymbol

java.lang.Object
  extended by Field
      extended by com.aspose.words.FieldSymbol

public class FieldSymbol 
extends Field

Implements a SYMBOL field. Retrieves the character whose code point value is specified in decimal or hexadecimal.

Constructor Summary
FieldSymbol()
          
 
Property Getters/Setters Summary
java.lang.StringgetCharacterCode()
voidsetCharacterCode(java.lang.String value)
           Gets or sets the character's code point value in decimal or hexadecimal.
booleangetDontAffectsLineSpacing()
voidsetDontAffectsLineSpacing(boolean value)
           Gets or sets whether the character retrieved by the field affects the line spacing of the paragraph.
FieldEndgetEnd()→ inherited from Field
           Gets the node that represents the field end.
java.lang.StringgetFontName()
voidsetFontName(java.lang.String value)
           Gets or sets the name of the font of the character retrieved by the field.
java.lang.StringgetFontSize()
voidsetFontSize(java.lang.String value)
           Gets or sets the size in points of the font of the character retrieved by the field.
FieldFormatgetFormat()→ inherited from Field
           Gets a FieldFormat object that provides typed access to field's formatting.
booleanisAnsi()
voidisAnsi(boolean value)
           Gets or sets whether the character code is interpreted as the value of an ANSI character.
booleanisLocked()→ inherited from Field
voidisLocked(boolean value)
           Gets or sets whether the field is locked (should not recalculate its result).
booleanisShiftJis()
voidisShiftJis(boolean value)
           Gets or sets whether the character code is interpreted as the value of a SHIFT-JIS character.
booleanisUnicode()
voidisUnicode(boolean value)
           Gets or sets whether the character code is interpreted as the value of a Unicode character.
intgetLocaleId()→ inherited from Field
voidsetLocaleId(int value)
          
java.lang.StringgetResult()→ inherited from Field
voidsetResult(java.lang.String value)
           Gets or sets text that is between the field separator and field end.
FieldSeparatorgetSeparator()→ inherited from Field
           Gets the node that represents the field separator. Can be null.
FieldStartgetStart()→ inherited from Field
           Gets the node that represents the start of the field.
intgetType()→ inherited from Field
           Gets the Microsoft Word field type. The value of the property is FieldType integer constant.
 
Method Summary
java.lang.StringgetFieldCode()→ inherited from Field
           Returns text between field start and field separator (or field end if there is no separator). Both field code and field result of child fields are included.
java.lang.StringgetFieldCode(boolean includeChildFieldCodes)→ inherited from Field
           Returns text between field start and field separator (or field end if there is no separator).
aspose.obfuscated.typegetSwitchType(java.lang.String switchName)
          Reserved for internal use.
Aspose.Words.Noderemove()→ inherited from Field
           Removes the field from the document. Returns a node right after the field. If the field's end is the last child of its parent node, returns its parent paragraph. If the field is already removed, returns null.
booleanunlink()→ inherited from Field
           Performs the field unlink.
voidupdate()→ inherited from Field
           Performs the field update. Throws if the field is being updated already.
voidupdate(boolean ignoreMergeFormat)→ inherited from Field
           Performs a field update. Throws if the field is being updated already.
 

Constructor Detail

FieldSymbol

public FieldSymbol()

Property Getters/Setters Detail

getCharacterCode/setCharacterCode

public java.lang.String getCharacterCode() / public void setCharacterCode(java.lang.String value)
Gets or sets the character's code point value in decimal or hexadecimal.

getDontAffectsLineSpacing/setDontAffectsLineSpacing

public boolean getDontAffectsLineSpacing() / public void setDontAffectsLineSpacing(boolean value)
Gets or sets whether the character retrieved by the field affects the line spacing of the paragraph.

getEnd

→ inherited from Field
public FieldEnd getEnd()
Gets the node that represents the field end.

getFontName/setFontName

public java.lang.String getFontName() / public void setFontName(java.lang.String value)
Gets or sets the name of the font of the character retrieved by the field.

getFontSize/setFontSize

public java.lang.String getFontSize() / public void setFontSize(java.lang.String value)
Gets or sets the size in points of the font of the character retrieved by the field.

getFormat

→ inherited from Field
public FieldFormat getFormat()
Gets a FieldFormat object that provides typed access to field's formatting.

isAnsi/isAnsi

public boolean isAnsi() / public void isAnsi(boolean value)
Gets or sets whether the character code is interpreted as the value of an ANSI character.

isLocked/isLocked

→ inherited from Field
public boolean isLocked() / public void isLocked(boolean value)
Gets or sets whether the field is locked (should not recalculate its result).

isShiftJis/isShiftJis

public boolean isShiftJis() / public void isShiftJis(boolean value)
Gets or sets whether the character code is interpreted as the value of a SHIFT-JIS character.

isUnicode/isUnicode

public boolean isUnicode() / public void isUnicode(boolean value)
Gets or sets whether the character code is interpreted as the value of a Unicode character.

getLocaleId/setLocaleId

→ inherited from Field
public int getLocaleId() / public void setLocaleId(int value)

getResult/setResult

→ inherited from Field
public java.lang.String getResult() / public void setResult(java.lang.String value)
Gets or sets text that is between the field separator and field end.

getSeparator

→ inherited from Field
public FieldSeparator getSeparator()
Gets the node that represents the field separator. Can be null.

getStart

→ inherited from Field
public FieldStart getStart()
Gets the node that represents the start of the field.

getType

→ inherited from Field
public int getType()
Gets the Microsoft Word field type. The value of the property is FieldType integer constant.

Method Detail

getFieldCode

→ inherited from Field
public java.lang.String getFieldCode()
Returns text between field start and field separator (or field end if there is no separator). Both field code and field result of child fields are included.

getFieldCode

→ inherited from Field
public java.lang.String getFieldCode(boolean includeChildFieldCodes)
Returns text between field start and field separator (or field end if there is no separator).
Parameters:
includeChildFieldCodes - True if child field codes should be included.

getSwitchType

public aspose.obfuscated.type getSwitchType(java.lang.String switchName)
Reserved for internal use.

remove

→ inherited from Field
public Aspose.Words.Node remove()
           throws java.lang.Exception
Removes the field from the document. Returns a node right after the field. If the field's end is the last child of its parent node, returns its parent paragraph. If the field is already removed, returns null.

unlink

→ inherited from Field
public boolean unlink()
              throws java.lang.Exception
Performs the field unlink.

Replaces the field with its most recent result.

Some fields, such as XE (Index Entry) fields and SEQ (Sequence) fields, cannot be unlinked.

Returns:
True if the field has been unlinked, otherwise false.

update

→ inherited from Field
public void update()
           throws java.lang.Exception
Performs the field update. Throws if the field is being updated already.

update

→ inherited from Field
public void update(boolean ignoreMergeFormat)
           throws java.lang.Exception
Performs a field update. Throws if the field is being updated already.
Parameters:
ignoreMergeFormat - If true then direct field result formatting is abandoned, regardless of the MERGEFORMAT switch, otherwise normal update is performed.

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