com.aspose.words
Class FieldCitation

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

public class FieldCitation 
extends Field

Implements the CITATION field. Inserts the contents of the Source element with a specified Tag element using a bibliographic style.

Constructor Summary
FieldCitation()
          
 
Property Getters/Setters Summary
java.lang.StringgetAnotherSourceTag()
voidsetAnotherSourceTag(java.lang.String value)
           Gets or sets a value that mathes the Tag element's value of another source to be included in the citation.
FieldEndgetEnd()→ inherited from Field
           Gets the node that represents the field end.
FieldFormatgetFormat()→ inherited from Field
           Gets a FieldFormat object that provides typed access to field's formatting.
java.lang.StringgetFormatLanguageId()
voidsetFormatLanguageId(java.lang.String value)
           Gets or sets the language ID that is used in conjunction with the specified bibliographic style to format the citation in the document.
booleanisLocked()→ inherited from Field
voidisLocked(boolean value)
           Gets or sets whether the field is locked (should not recalculate its result).
java.lang.StringgetPageNumber()
voidsetPageNumber(java.lang.String value)
           Gets or sets a page number associated with the citation.
java.lang.StringgetPrefix()
voidsetPrefix(java.lang.String value)
           Gets or sets a prefix that is prepended to the citation.
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.
java.lang.StringgetSourceTag()
voidsetSourceTag(java.lang.String value)
           Gets or sets a value that mathes the Tag element's value of the source to insert.
FieldStartgetStart()→ inherited from Field
           Gets the node that represents the start of the field.
java.lang.StringgetSuffix()
voidsetSuffix(java.lang.String value)
           Gets or sets a suffix that is appended to the citation.
booleangetSuppressAuthor()
voidsetSuppressAuthor(boolean value)
           Gets or sets whether the author information is suppressed from the citation.
booleangetSuppressTitle()
voidsetSuppressTitle(boolean value)
           Gets or sets whether the title information is suppressed from the citation.
booleangetSuppressYear()
voidsetSuppressYear(boolean value)
           Gets or sets whether the year information is suppressed from the citation.
intgetType()→ inherited from Field
           Gets the Microsoft Word field type. The value of the property is FieldType integer constant.
java.lang.StringgetVolumeNumber()
voidsetVolumeNumber(java.lang.String value)
           Gets or sets a volume number associated with the citation.
 
Method Summary
java.lang.StringgetFieldCode()→ inherited from Field
           Returns text between field start and field separator (or field end if there is no separator).
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.
voidupdate()→ inherited from Field
           Performs the field update. Throws if the field is being updated already.
 

Constructor Detail

FieldCitation

public FieldCitation()

Property Getters/Setters Detail

getAnotherSourceTag/setAnotherSourceTag

public java.lang.String getAnotherSourceTag() / public void setAnotherSourceTag(java.lang.String value)
Gets or sets a value that mathes the Tag element's value of another source to be included in the citation.

getEnd

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

getFormat

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

getFormatLanguageId/setFormatLanguageId

public java.lang.String getFormatLanguageId() / public void setFormatLanguageId(java.lang.String value)
Gets or sets the language ID that is used in conjunction with the specified bibliographic style to format the citation in the document.

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).

getPageNumber/setPageNumber

public java.lang.String getPageNumber() / public void setPageNumber(java.lang.String value)
Gets or sets a page number associated with the citation.

getPrefix/setPrefix

public java.lang.String getPrefix() / public void setPrefix(java.lang.String value)
Gets or sets a prefix that is prepended to the citation.

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.

Example:

Inserts a field into a document using DocumentBuilder.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);

// Insert a simple Date field into the document.
// When we insert a field through the DocumentBuilder class we can get the
// special Field object which contains information about the field.
Field dateField = builder.insertField("DATE \\* MERGEFORMAT");

// Update this particular field in the document so we can get the FieldResult.
dateField.update();

// Display some information from this field.
// The field result is where the last evaluated value is stored. This is what is displayed in the document
// When field codes are not showing.
System.out.println(MessageFormat.format("FieldResult: {0}", dateField.getResult()));

// Display the field code which defines the behaviour of the field. This can been seen in Microsoft Word by pressing ALT+F9.
System.out.println(MessageFormat.format("FieldCode: {0}", dateField.getFieldCode()));

// The field type defines what type of field in the Document this is. In this case the type is "FieldDate"
System.out.println(MessageFormat.format("FieldType: {0}", dateField.getType()));

// Finally let's completely remove the field from the document. This can easily be done by invoking the Remove method on the object.
dateField.remove();

getSeparator

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

getSourceTag/setSourceTag

public java.lang.String getSourceTag() / public void setSourceTag(java.lang.String value)
Gets or sets a value that mathes the Tag element's value of the source to insert.

getStart

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

getSuffix/setSuffix

public java.lang.String getSuffix() / public void setSuffix(java.lang.String value)
Gets or sets a suffix that is appended to the citation.

getSuppressAuthor/setSuppressAuthor

public boolean getSuppressAuthor() / public void setSuppressAuthor(boolean value)
Gets or sets whether the author information is suppressed from the citation.

getSuppressTitle/setSuppressTitle

public boolean getSuppressTitle() / public void setSuppressTitle(boolean value)
Gets or sets whether the title information is suppressed from the citation.

getSuppressYear/setSuppressYear

public boolean getSuppressYear() / public void setSuppressYear(boolean value)
Gets or sets whether the year information is suppressed from the citation.

getType

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

Example:

Inserts a field into a document using DocumentBuilder.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);

// Insert a simple Date field into the document.
// When we insert a field through the DocumentBuilder class we can get the
// special Field object which contains information about the field.
Field dateField = builder.insertField("DATE \\* MERGEFORMAT");

// Update this particular field in the document so we can get the FieldResult.
dateField.update();

// Display some information from this field.
// The field result is where the last evaluated value is stored. This is what is displayed in the document
// When field codes are not showing.
System.out.println(MessageFormat.format("FieldResult: {0}", dateField.getResult()));

// Display the field code which defines the behaviour of the field. This can been seen in Microsoft Word by pressing ALT+F9.
System.out.println(MessageFormat.format("FieldCode: {0}", dateField.getFieldCode()));

// The field type defines what type of field in the Document this is. In this case the type is "FieldDate"
System.out.println(MessageFormat.format("FieldType: {0}", dateField.getType()));

// Finally let's completely remove the field from the document. This can easily be done by invoking the Remove method on the object.
dateField.remove();

getVolumeNumber/setVolumeNumber

public java.lang.String getVolumeNumber() / public void setVolumeNumber(java.lang.String value)
Gets or sets a volume number associated with the citation.

Method Detail

getFieldCode

→ inherited from Field
public java.lang.String getFieldCode()
                   throws java.lang.Exception
Returns text between field start and field separator (or field end if there is no separator).

Example:

Inserts a field into a document using DocumentBuilder.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);

// Insert a simple Date field into the document.
// When we insert a field through the DocumentBuilder class we can get the
// special Field object which contains information about the field.
Field dateField = builder.insertField("DATE \\* MERGEFORMAT");

// Update this particular field in the document so we can get the FieldResult.
dateField.update();

// Display some information from this field.
// The field result is where the last evaluated value is stored. This is what is displayed in the document
// When field codes are not showing.
System.out.println(MessageFormat.format("FieldResult: {0}", dateField.getResult()));

// Display the field code which defines the behaviour of the field. This can been seen in Microsoft Word by pressing ALT+F9.
System.out.println(MessageFormat.format("FieldCode: {0}", dateField.getFieldCode()));

// The field type defines what type of field in the Document this is. In this case the type is "FieldDate"
System.out.println(MessageFormat.format("FieldType: {0}", dateField.getType()));

// Finally let's completely remove the field from the document. This can easily be done by invoking the Remove method on the object.
dateField.remove();

remove

→ inherited from Field
public 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.

Example:

Inserts a field into a document using DocumentBuilder.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);

// Insert a simple Date field into the document.
// When we insert a field through the DocumentBuilder class we can get the
// special Field object which contains information about the field.
Field dateField = builder.insertField("DATE \\* MERGEFORMAT");

// Update this particular field in the document so we can get the FieldResult.
dateField.update();

// Display some information from this field.
// The field result is where the last evaluated value is stored. This is what is displayed in the document
// When field codes are not showing.
System.out.println(MessageFormat.format("FieldResult: {0}", dateField.getResult()));

// Display the field code which defines the behaviour of the field. This can been seen in Microsoft Word by pressing ALT+F9.
System.out.println(MessageFormat.format("FieldCode: {0}", dateField.getFieldCode()));

// The field type defines what type of field in the Document this is. In this case the type is "FieldDate"
System.out.println(MessageFormat.format("FieldType: {0}", dateField.getType()));

// Finally let's completely remove the field from the document. This can easily be done by invoking the Remove method on the object.
dateField.remove();

update

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

Example:

Inserts a field into a document using DocumentBuilder.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);

// Insert a simple Date field into the document.
// When we insert a field through the DocumentBuilder class we can get the
// special Field object which contains information about the field.
Field dateField = builder.insertField("DATE \\* MERGEFORMAT");

// Update this particular field in the document so we can get the FieldResult.
dateField.update();

// Display some information from this field.
// The field result is where the last evaluated value is stored. This is what is displayed in the document
// When field codes are not showing.
System.out.println(MessageFormat.format("FieldResult: {0}", dateField.getResult()));

// Display the field code which defines the behaviour of the field. This can been seen in Microsoft Word by pressing ALT+F9.
System.out.println(MessageFormat.format("FieldCode: {0}", dateField.getFieldCode()));

// The field type defines what type of field in the Document this is. In this case the type is "FieldDate"
System.out.println(MessageFormat.format("FieldType: {0}", dateField.getType()));

// Finally let's completely remove the field from the document. This can easily be done by invoking the Remove method on the object.
dateField.remove();

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