com.aspose.words.SpecialCharFieldChar
com.aspose.words.FieldStart
public class FieldStart
A complete field in a Microsoft Word document is a complex structure consisting of
a field start character, field code, field separator character, field result
and field end character. Some fields only have field start, field code and field end. To easily insert a new field into a document, use the
Property Getters/Setters Summary | ||
---|---|---|
Aspose.Words.DocumentBase | getDocument() | → inherited from Aspose.Words.Node |
Gets the document to which this node belongs. | ||
int | getFieldType() | → inherited from FieldChar |
Returns the type of the field. The value of the property is FieldType integer constant. | ||
Aspose.Words.Font | getFont() | → inherited from Aspose.Words.Inline |
Provides access to the font formatting of this object. | ||
boolean | isComposite() | → inherited from Aspose.Words.Node |
Returns true if this node can contain other nodes. | ||
boolean | isDeleteRevision() | → inherited from Aspose.Words.Inline |
Returns true if this object was deleted in Microsoft Word while change tracking was enabled. | ||
boolean | isDirty() | → inherited from FieldChar |
void | isDirty(boolean value) | |
Gets or sets whether the current result of the field is no longer correct (stale) due to other modifications made to the document. | ||
boolean | isFormatRevision() | → inherited from Aspose.Words.Inline |
Returns true if formatting of the object was changed in Microsoft Word while change tracking was enabled. | ||
boolean | isInsertRevision() | → inherited from Aspose.Words.Inline |
Returns true if this object was inserted in Microsoft Word while change tracking was enabled. | ||
boolean | isLocked() | → inherited from FieldChar |
void | isLocked(boolean value) | |
Gets or sets whether the parent field is locked (should not recalculate its result). | ||
Aspose.Words.Node | getNextSibling() | → inherited from Aspose.Words.Node |
Gets the node immediately following this node. | ||
Aspose.Words.NodeType | getNodeType() | |
Returns |
||
Aspose.Words.CompositeNode | getParentNode() | → inherited from Aspose.Words.Node |
Gets the immediate parent of this node. | ||
Aspose.Words.Paragraph | getParentParagraph() | → inherited from Aspose.Words.Inline |
Retrieves the parent |
||
Aspose.Words.Node | getPreviousSibling() | → inherited from Aspose.Words.Node |
Gets the node immediately preceding this node. | ||
Aspose.Words.Range | getRange() | → inherited from Aspose.Words.Node |
Returns a Range object that represents the portion of a document that is contained in this node. |
Method Summary | ||
---|---|---|
void | clearRunAttrs() | → inherited from Aspose.Words.Inline |
Reserved for internal use. | ||
Aspose.Words.Node | deepClone(boolean isCloneChildren) | → inherited from Aspose.Words.Node |
Creates a duplicate of the node. | ||
java.lang.Object | fetchInheritedRunAttr(int fontAttr) | → inherited from Aspose.Words.Inline |
Reserved for internal use. | ||
Aspose.Words.CompositeNode | getAncestor(java.lang.Class ancestorType) | → inherited from Aspose.Words.Node |
Gets the first ancestor of the specified object type. | ||
aspose.obfuscated.type | getDeleteRevision() | → inherited from Aspose.Words.Inline |
Reserved for internal use. | ||
java.lang.Object | getDirectRunAttr(int fontAttr) | → inherited from Aspose.Words.Inline |
Reserved for internal use. | ||
int | getDirectRunAttrsCount() | → inherited from Aspose.Words.Inline |
Reserved for internal use. | ||
Aspose.Words.DocumentBase | getDocument_IInline() | → inherited from Aspose.Words.Inline |
Reserved for internal use. | ||
aspose.obfuscated.type | getExpandedRunPr_IInline(aspose.obfuscated.type flags) | → inherited from Aspose.Words.Inline |
Reserved for internal use. | ||
Field | getField() | → inherited from FieldChar |
Returns a field for the field char. | ||
aspose.obfuscated.type | getInsertRevision() | → inherited from Aspose.Words.Inline |
Reserved for internal use. | ||
Aspose.Words.Paragraph | getParentParagraph_IInline() | → inherited from Aspose.Words.Inline |
Reserved for internal use. | ||
aspose.obfuscated.type | getRunPr_IInline() | → inherited from Aspose.Words.Inline |
Reserved for internal use. | ||
java.lang.String | getText() | → inherited from Aspose.Words.SpecialChar |
Gets the special character that this node represents. | ||
void | remove() | → inherited from Aspose.Words.Node |
Removes itself from the parent. | ||
void | removeRunAttr(int key) | → inherited from Aspose.Words.Inline |
Reserved for internal use. | ||
void | setDeleteRevision(aspose.obfuscated.type value) | → inherited from Aspose.Words.Inline |
Reserved for internal use. | ||
void | setInsertRevision(aspose.obfuscated.type value) | → inherited from Aspose.Words.Inline |
Reserved for internal use. | ||
void | setRunAttr(int fontAttr, java.lang.Object value) | → inherited from Aspose.Words.Inline |
Reserved for internal use. | ||
void | setRunPr_IInline(aspose.obfuscated.type value) | → inherited from Aspose.Words.Inline |
Reserved for internal use. | ||
java.lang.String | toString(SaveOptions saveOptions) | → inherited from Aspose.Words.Node |
Exports the content of the node into a string using the specified save options. | ||
java.lang.String | toTxt() | → inherited from Aspose.Words.Node |
Exports the content of the node into a string in plain text format. |
Property Getters/Setters Detail |
---|
getDocument | → inherited from Aspose.Words.Node |
public Aspose.Words.DocumentBase getDocument() |
The node always belongs to a document even if it has just been created and not yet added to the tree, or if it has been removed from the tree.
getFieldType | → inherited from FieldChar |
public int getFieldType() |
getFont | → inherited from Aspose.Words.Inline |
public Aspose.Words.Font getFont() |
isComposite | → inherited from Aspose.Words.Node |
public boolean isComposite() |
isDeleteRevision | → inherited from Aspose.Words.Inline |
public boolean isDeleteRevision() |
isDirty/isDirty | → inherited from FieldChar |
public boolean isDirty() / public void isDirty(boolean value) |
isFormatRevision | → inherited from Aspose.Words.Inline |
public boolean isFormatRevision() |
isInsertRevision | → inherited from Aspose.Words.Inline |
public boolean isInsertRevision() |
isLocked/isLocked | → inherited from FieldChar |
public boolean isLocked() / public void isLocked(boolean value) |
getNextSibling | → inherited from Aspose.Words.Node |
public Aspose.Words.Node getNextSibling() |
getNodeType | |
public Aspose.Words.NodeType getNodeType() |
getParentNode | → inherited from Aspose.Words.Node |
public Aspose.Words.CompositeNode getParentNode() |
If a node has just been created and not yet added to the tree, or if it has been removed from the tree, the parent is null.
getParentParagraph | → inherited from Aspose.Words.Inline |
public Aspose.Words.Paragraph getParentParagraph() |
getPreviousSibling | → inherited from Aspose.Words.Node |
public Aspose.Words.Node getPreviousSibling() |
getRange | → inherited from Aspose.Words.Node |
public Aspose.Words.Range getRange() |
Method Detail |
---|
clearRunAttrs | → inherited from Aspose.Words.Inline |
public void clearRunAttrs() |
deepClone | → inherited from Aspose.Words.Node |
public Aspose.Words.Node deepClone(boolean isCloneChildren) |
This method serves as a copy constructor for nodes. The cloned node has no parent, but belongs to the same document as the original node.
This method always performs a deep copy of the node. The isCloneChildren parameter specifies whether to perform copy all child nodes as well.
isCloneChildren
- True to recursively clone the subtree under the specified node;
false to clone only the node itself.fetchInheritedRunAttr | → inherited from Aspose.Words.Inline |
public java.lang.Object fetchInheritedRunAttr(int fontAttr) |
getAncestor | → inherited from Aspose.Words.Node |
public Aspose.Words.CompositeNode getAncestor(java.lang.Class ancestorType) |
The ancestor type matches if it is equal to ancestorType or derived from ancestorType.
ancestorType
- The object type of the ancestor to retrieve.getDeleteRevision | → inherited from Aspose.Words.Inline |
public aspose.obfuscated.type getDeleteRevision() |
getDirectRunAttr | → inherited from Aspose.Words.Inline |
public java.lang.Object getDirectRunAttr(int fontAttr) |
getDirectRunAttrsCount | → inherited from Aspose.Words.Inline |
public int getDirectRunAttrsCount() |
getDocument_IInline | → inherited from Aspose.Words.Inline |
public Aspose.Words.DocumentBase getDocument_IInline() |
getExpandedRunPr_IInline | → inherited from Aspose.Words.Inline |
public aspose.obfuscated.type getExpandedRunPr_IInline(aspose.obfuscated.type flags) |
getField | → inherited from FieldChar |
public Field getField() |
getInsertRevision | → inherited from Aspose.Words.Inline |
public aspose.obfuscated.type getInsertRevision() |
getParentParagraph_IInline | → inherited from Aspose.Words.Inline |
public Aspose.Words.Paragraph getParentParagraph_IInline() |
getRunPr_IInline | → inherited from Aspose.Words.Inline |
public aspose.obfuscated.type getRunPr_IInline() |
getText | → inherited from Aspose.Words.SpecialChar |
public java.lang.String getText() |
remove | → inherited from Aspose.Words.Node |
public void remove() |
removeRunAttr | → inherited from Aspose.Words.Inline |
public void removeRunAttr(int key) |
setDeleteRevision | → inherited from Aspose.Words.Inline |
public void setDeleteRevision(aspose.obfuscated.type value) |
setInsertRevision | → inherited from Aspose.Words.Inline |
public void setInsertRevision(aspose.obfuscated.type value) |
setRunAttr | → inherited from Aspose.Words.Inline |
public void setRunAttr(int fontAttr, java.lang.Object value) |
setRunPr_IInline | → inherited from Aspose.Words.Inline |
public void setRunPr_IInline(aspose.obfuscated.type value) |
toString | → inherited from Aspose.Words.Node |
public java.lang.String toString(SaveOptions saveOptions) throws java.lang.Exception |
saveOptions
- Specifies the options that control how the node is saved.toTxt | → inherited from Aspose.Words.Node |
public java.lang.String toTxt() throws java.lang.Exception |
This method removes field codes and Microsoft Word control characters, uses CrLf
(or any other) combination of characters to mark ends of paragraphs in the resulting string.
It produces a different result from