java.lang.ObjectField
com.aspose.words.FieldDdeAuto
public class FieldDdeAuto
Constructor Summary |
---|
FieldDdeAuto()
|
Property Getters/Setters Summary | ||
---|---|---|
FieldEnd | getEnd() | → inherited from Field |
Gets the node that represents the field end. | ||
FieldFormat | getFormat() | → inherited from Field |
Gets a |
||
boolean | getInsertAsBitmap() | |
void | setInsertAsBitmap(boolean value) | |
Gets or sets whether to insert the linked object as a bitmap. | ||
boolean | getInsertAsHtml() | |
void | setInsertAsHtml(boolean value) | |
Gets or sets whether to insert the linked object as HTML format text. | ||
boolean | getInsertAsPicture() | |
void | setInsertAsPicture(boolean value) | |
Gets or sets whether to insert the linked object as a picture. | ||
boolean | getInsertAsRtf() | |
void | setInsertAsRtf(boolean value) | |
Gets or sets whether to insert the linked object in rich-text format (RTF). | ||
boolean | getInsertAsText() | |
void | setInsertAsText(boolean value) | |
Gets or sets whether to insert the linked object in text-only format. | ||
boolean | getInsertAsUnicode() | |
void | setInsertAsUnicode(boolean value) | |
Gets or sets whether to insert the linked object as Unicode text. | ||
boolean | isLinked() | |
void | isLinked(boolean value) | |
Gets or sets whether to reduce the file size by not storing graphics data with the document. | ||
boolean | isLocked() | → inherited from Field |
void | isLocked(boolean value) | |
Gets or sets whether the field is locked (should not recalculate its result). | ||
java.lang.String | getProgId() | |
void | setProgId(java.lang.String value) | |
Gets or sets the application type of the link information. | ||
java.lang.String | getResult() | → inherited from Field |
void | setResult(java.lang.String value) | |
Gets or sets text that is between the field separator and field end. | ||
FieldSeparator | getSeparator() | → inherited from Field |
Gets the node that represents the field separator. Can be null. | ||
java.lang.String | getSourceFullName() | |
void | setSourceFullName(java.lang.String value) | |
Gets or sets the name and location of the source file. | ||
java.lang.String | getSourceItem() | |
void | setSourceItem(java.lang.String value) | |
Gets or sets the portion of the source file that's being linked. | ||
FieldStart | getStart() | → inherited from Field |
Gets the node that represents the start of the field. | ||
int | getType() | → inherited from Field |
Gets the Microsoft Word field type. The value of the property is FieldType integer constant. |
Method Summary | ||
---|---|---|
java.lang.String | getFieldCode() | → inherited from Field |
Returns text between field start and field separator (or field end if there is no separator). | ||
Node | remove() | → 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. | ||
void | update() | → inherited from Field |
Performs the field update. Throws if the field is being updated already. |
Constructor Detail |
---|
public FieldDdeAuto()
Property Getters/Setters Detail |
---|
getEnd | → inherited from Field |
public FieldEnd getEnd() |
getFormat | → inherited from Field |
public FieldFormat getFormat() |
getInsertAsBitmap/setInsertAsBitmap | |
public boolean getInsertAsBitmap() / public void setInsertAsBitmap(boolean value) |
getInsertAsHtml/setInsertAsHtml | |
public boolean getInsertAsHtml() / public void setInsertAsHtml(boolean value) |
getInsertAsPicture/setInsertAsPicture | |
public boolean getInsertAsPicture() / public void setInsertAsPicture(boolean value) |
getInsertAsRtf/setInsertAsRtf | |
public boolean getInsertAsRtf() / public void setInsertAsRtf(boolean value) |
getInsertAsText/setInsertAsText | |
public boolean getInsertAsText() / public void setInsertAsText(boolean value) |
getInsertAsUnicode/setInsertAsUnicode | |
public boolean getInsertAsUnicode() / public void setInsertAsUnicode(boolean value) |
isLinked/isLinked | |
public boolean isLinked() / public void isLinked(boolean value) |
isLocked/isLocked | → inherited from Field |
public boolean isLocked() / public void isLocked(boolean value) |
getProgId/setProgId | |
public java.lang.String getProgId() / public void setProgId(java.lang.String value) |
getResult/setResult | → inherited from Field |
public java.lang.String getResult() / public void setResult(java.lang.String value) |
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() |
getSourceFullName/setSourceFullName | |
public java.lang.String getSourceFullName() / public void setSourceFullName(java.lang.String value) |
getSourceItem/setSourceItem | |
public java.lang.String getSourceItem() / public void setSourceItem(java.lang.String value) |
getStart | → inherited from Field |
public FieldStart getStart() |
getType | → inherited from Field |
public int getType() |
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 |
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 |
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 |
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();