com.aspose.words
Class FieldDatabase

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

public class FieldDatabase 
extends Field

Implements the DATABASE field. Inserts the results of a database query into a WordprocessingML table.

Constructor Summary
FieldDatabase()
          
 
Property Getters/Setters Summary
java.lang.StringgetConnection()
voidsetConnection(java.lang.String value)
           Gets or sets a connection to the data.
FieldEndgetEnd()→ inherited from Field
           Gets the node that represents the field end.
java.lang.StringgetFileName()
voidsetFileName(java.lang.String value)
           Gets or sets the complete path and file name of the database
java.lang.StringgetFirstRecord()
voidsetFirstRecord(java.lang.String value)
           Gets or sets the integral record number of the first data record to insert.
FieldFormatgetFormat()→ inherited from Field
           Gets a FieldFormat object that provides typed access to field's formatting.
java.lang.StringgetFormatAttributes()
voidsetFormatAttributes(java.lang.String value)
           Gets or sets which attributes of the format are to be applied to the table.
booleangetInsertHeadings()
voidsetInsertHeadings(boolean value)
           Gets or sets whether to insert the field names from the database as column headings in the resulting table.
booleangetInsertOnceOnMailMerge()
voidsetInsertOnceOnMailMerge(boolean value)
           Gets or sets whether to insert data at the beginning of a merge.
booleanisLocked()→ inherited from Field
voidisLocked(boolean value)
           Gets or sets whether the field is locked (should not recalculate its result).
java.lang.StringgetLastRecord()
voidsetLastRecord(java.lang.String value)
           Gets or sets the integral record number of the last data record to insert.
java.lang.StringgetQuery()
voidsetQuery(java.lang.String value)
           Gets or sets a set of SQL instructions that query the database.
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.
java.lang.StringgetTableFormat()
voidsetTableFormat(java.lang.String value)
           Gets or sets the format that is to be applied to the result of the database query.
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).
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

FieldDatabase

public FieldDatabase()

Property Getters/Setters Detail

getConnection/setConnection

public java.lang.String getConnection() / public void setConnection(java.lang.String value)
Gets or sets a connection to the data.

getEnd

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

getFileName/setFileName

public java.lang.String getFileName() / public void setFileName(java.lang.String value)
Gets or sets the complete path and file name of the database

getFirstRecord/setFirstRecord

public java.lang.String getFirstRecord() / public void setFirstRecord(java.lang.String value)
Gets or sets the integral record number of the first data record to insert.

getFormat

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

getFormatAttributes/setFormatAttributes

public java.lang.String getFormatAttributes() / public void setFormatAttributes(java.lang.String value)
Gets or sets which attributes of the format are to be applied to the table.

getInsertHeadings/setInsertHeadings

public boolean getInsertHeadings() / public void setInsertHeadings(boolean value)
Gets or sets whether to insert the field names from the database as column headings in the resulting table.

getInsertOnceOnMailMerge/setInsertOnceOnMailMerge

public boolean getInsertOnceOnMailMerge() / public void setInsertOnceOnMailMerge(boolean value)
Gets or sets whether to insert data at the beginning of a merge.

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

getLastRecord/setLastRecord

public java.lang.String getLastRecord() / public void setLastRecord(java.lang.String value)
Gets or sets the integral record number of the last data record to insert.

getQuery/setQuery

public java.lang.String getQuery() / public void setQuery(java.lang.String value)
Gets or sets a set of SQL instructions that query the database.

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.

getStart

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

getTableFormat/setTableFormat

public java.lang.String getTableFormat() / public void setTableFormat(java.lang.String value)
Gets or sets the format that is to be applied to the result of the database query.

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();

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.