java.lang.Object
com.aspose.words.Field
public class Field
- extends java.lang.Object
[The properties and methods of this class are subject to change.]
Represents a Microsoft Word field.
At the moment objects of this class are only returned by
MergeFieldEventArgsBase.Field
to allow using DocumentBuilder.moveToField(com.aspose.words.Field, boolean)
to move to a merge field quickly in a custom mail merge event handler.
There will be more methods and properties added to the Field class later.
Property Getters/Setters Summary |
FieldEnd | getEnd() | |
|
Gets the node that represents the field end.
|
java.lang.String | getResult() | |
void | setResult(java.lang.String value) | |
|
Gets or sets text that is between field separator and field end.
|
FieldSeparator | getSeparator() | |
|
Gets the node that represents the field separator. Can be null.
|
FieldStart | getStart() | |
|
Gets the node that represents the start of the field.
|
int | getType() | |
|
Gets the Microsoft Word field type.
The value of the property is FieldType integer constant. |
Method Summary |
java.lang.String | getFieldCode() | |
Returns text between field start and field separator (or field end if there is no separator).
|
void | remove() | |
Removes the field from the document.
|
Property Getters/Setters Detail |
-
Gets the node that represents the start of the field.
-
Gets the node that represents the field separator. Can be null.
-
Gets the node that represents the field end.
getType | |
public int getType()
|
-
Gets the Microsoft Word field type.
The value of the property is FieldType integer constant.
getResult/setResult | |
public java.lang.String getResult() / public void setResult(java.lang.String value)
|
-
Gets or sets text that is between field separator and field end.
getFieldCode | |
public java.lang.String getFieldCode() |
-
Returns text between field start and field separator (or field end if there is no separator).
remove | |
public void remove()
throws java.lang.Exception |
-
Removes the field from the document.
See Also:
Aspose.Words Documentation - the home page for the Aspose.Words Product Documentation.
Aspose.Words Support Forum - our preferred method of support.