com.aspose.words
Class FieldLink

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

public class FieldLink 
extends Field

Implements the LINK field. For information copied from another application, this field links that information to its original source file.

Constructor Summary
FieldLink()
          
 
Property Getters/Setters Summary
booleangetAutoUpdate()
voidsetAutoUpdate(boolean value)
           Gets or sets whether to update this field automatically.
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.StringgetFormatUpdateType()
voidsetFormatUpdateType(java.lang.String value)
           Gets or sets a way the linked object updates its formatting.
booleangetInsertAsBitmap()
voidsetInsertAsBitmap(boolean value)
           Gets or sets whether to insert the linked object as a bitmap.
booleangetInsertAsHtml()
voidsetInsertAsHtml(boolean value)
           Gets or sets whether to insert the linked object as HTML format text.
booleangetInsertAsPicture()
voidsetInsertAsPicture(boolean value)
           Gets or sets whether to insert the linked object as a picture.
booleangetInsertAsRtf()
voidsetInsertAsRtf(boolean value)
           Gets or sets whether to insert the linked object in rich-text format (RTF).
booleangetInsertAsText()
voidsetInsertAsText(boolean value)
           Gets or sets whether to insert the linked object in text-only format.
booleangetInsertAsUnicode()
voidsetInsertAsUnicode(boolean value)
           Gets or sets whether to insert the linked object as Unicode text.
booleanisLinked()
voidisLinked(boolean value)
           Gets or sets whether to reduce the file size by not storing graphics data with the document.
booleanisLocked()→ inherited from Field
voidisLocked(boolean value)
           Gets or sets whether the field is locked (should not recalculate its result).
java.lang.StringgetProgId()
voidsetProgId(java.lang.String value)
           Gets or sets the application type of the link information.
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.StringgetSourceFullName()
voidsetSourceFullName(java.lang.String value)
           Gets or sets the name and location of the source file.
java.lang.StringgetSourceItem()
voidsetSourceItem(java.lang.String value)
           Gets or sets the portion of the source file that's being linked.
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).
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

FieldLink

public FieldLink()

Property Getters/Setters Detail

getAutoUpdate/setAutoUpdate

public boolean getAutoUpdate() / public void setAutoUpdate(boolean value)
Gets or sets whether to update this field automatically.

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.

getFormatUpdateType/setFormatUpdateType

public java.lang.String getFormatUpdateType() / public void setFormatUpdateType(java.lang.String value)
Gets or sets a way the linked object updates its formatting.

getInsertAsBitmap/setInsertAsBitmap

public boolean getInsertAsBitmap() / public void setInsertAsBitmap(boolean value)
Gets or sets whether to insert the linked object as a bitmap.

getInsertAsHtml/setInsertAsHtml

public boolean getInsertAsHtml() / public void setInsertAsHtml(boolean value)
Gets or sets whether to insert the linked object as HTML format text.

getInsertAsPicture/setInsertAsPicture

public boolean getInsertAsPicture() / public void setInsertAsPicture(boolean value)
Gets or sets whether to insert the linked object as a picture.

getInsertAsRtf/setInsertAsRtf

public boolean getInsertAsRtf() / public void setInsertAsRtf(boolean value)
Gets or sets whether to insert the linked object in rich-text format (RTF).

getInsertAsText/setInsertAsText

public boolean getInsertAsText() / public void setInsertAsText(boolean value)
Gets or sets whether to insert the linked object in text-only format.

getInsertAsUnicode/setInsertAsUnicode

public boolean getInsertAsUnicode() / public void setInsertAsUnicode(boolean value)
Gets or sets whether to insert the linked object as Unicode text.

isLinked/isLinked

public boolean isLinked() / public void isLinked(boolean value)
Gets or sets whether to reduce the file size by not storing graphics data with 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).

getProgId/setProgId

public java.lang.String getProgId() / public void setProgId(java.lang.String value)
Gets or sets the application type of the link information.

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.

getSourceFullName/setSourceFullName

public java.lang.String getSourceFullName() / public void setSourceFullName(java.lang.String value)
Gets or sets the name and location of the source file.

getSourceItem/setSourceItem

public java.lang.String getSourceItem() / public void setSourceItem(java.lang.String value)
Gets or sets the portion of the source file that's being linked.

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.

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.