com.aspose.words
Class FieldInclude

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

public class FieldInclude 
extends Field

Implements the INCLUDE field. Inserts all or part of the text and graphics contained in another document.

Constructor Summary
FieldInclude()
          
 
Property Getters/Setters Summary
java.lang.StringgetBookmarkName()
voidsetBookmarkName(java.lang.String value)
           Gets or sets the name of the bookmark in the document to include.
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.
booleanisLocked()→ inherited from Field
voidisLocked(boolean value)
           Gets or sets whether the field is locked (should not recalculate its result).
intgetLocaleId()→ inherited from Field
voidsetLocaleId(int value)
          
booleangetLockFields()
voidsetLockFields(boolean value)
           Gets or sets whether to prevent fields in the included document from being updated.
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 location of the document.
FieldStartgetStart()→ inherited from Field
           Gets the node that represents the start of the field.
java.lang.StringgetTextConverter()
voidsetTextConverter(java.lang.String value)
           Gets or sets the name of the text converter for the format of the included file.
intgetType()→ inherited from Field
           Gets the Microsoft Word field type. The value of the property is FieldType integer constant.
 
Method Summary
java.lang.StringgetBookmarkName()
          Reserved for internal use.
java.lang.StringgetFieldCode()→ inherited from Field
           Returns text between field start and field separator (or field end if there is no separator). Both field code and field result of child fields are included.
java.lang.StringgetFieldCode(boolean includeChildFieldCodes)→ inherited from Field
           Returns text between field start and field separator (or field end if there is no separator).
booleangetLockFields()
          Reserved for internal use.
java.lang.StringgetNamespaceMappings()
          Reserved for internal use.
java.lang.StringgetSourceFullName()
          Reserved for internal use.
intgetSourceFullNameArgumentIndex()
          Reserved for internal use.
aspose.obfuscated.typegetSwitchType(java.lang.String switchName)
          Reserved for internal use.
java.lang.StringgetXPath()
          Reserved for internal use.
Aspose.Words.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.
booleanunlink()→ inherited from Field
           Performs the field unlink.
voidupdate()→ inherited from Field
           Performs the field update. Throws if the field is being updated already.
voidupdate(boolean ignoreMergeFormat)→ inherited from Field
           Performs a field update. Throws if the field is being updated already.
 

Constructor Detail

FieldInclude

public FieldInclude()

Property Getters/Setters Detail

getBookmarkName/setBookmarkName

public java.lang.String getBookmarkName() / public void setBookmarkName(java.lang.String value)
Gets or sets the name of the bookmark in the document to include.

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.

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

getLocaleId/setLocaleId

→ inherited from Field
public int getLocaleId() / public void setLocaleId(int value)

getLockFields/setLockFields

public boolean getLockFields() / public void setLockFields(boolean value)
Gets or sets whether to prevent fields in the included document from being updated.

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.

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 location of the document.

getStart

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

getTextConverter/setTextConverter

public java.lang.String getTextConverter() / public void setTextConverter(java.lang.String value)
Gets or sets the name of the text converter for the format of the included file.

getType

→ inherited from Field
public int getType()
Gets the Microsoft Word field type. The value of the property is FieldType integer constant.

Method Detail

getBookmarkName

public java.lang.String getBookmarkName()
Reserved for internal use.

getFieldCode

→ inherited from Field
public java.lang.String getFieldCode()
Returns text between field start and field separator (or field end if there is no separator). Both field code and field result of child fields are included.

getFieldCode

→ inherited from Field
public java.lang.String getFieldCode(boolean includeChildFieldCodes)
Returns text between field start and field separator (or field end if there is no separator).
Parameters:
includeChildFieldCodes - True if child field codes should be included.

getLockFields

public boolean getLockFields()
Reserved for internal use.

getNamespaceMappings

public java.lang.String getNamespaceMappings()
Reserved for internal use.

getSourceFullName

public java.lang.String getSourceFullName()
Reserved for internal use.

getSourceFullNameArgumentIndex

public int getSourceFullNameArgumentIndex()
Reserved for internal use.

getSwitchType

public aspose.obfuscated.type getSwitchType(java.lang.String switchName)
Reserved for internal use.

getXPath

public java.lang.String getXPath()
Reserved for internal use.

remove

→ inherited from Field
public Aspose.Words.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.

unlink

→ inherited from Field
public boolean unlink()
              throws java.lang.Exception
Performs the field unlink.

Replaces the field with its most recent result.

Some fields, such as XE (Index Entry) fields and SEQ (Sequence) fields, cannot be unlinked.

Returns:
True if the field has been unlinked, otherwise false.

update

→ inherited from Field
public void update()
           throws java.lang.Exception
Performs the field update. Throws if the field is being updated already.

update

→ inherited from Field
public void update(boolean ignoreMergeFormat)
           throws java.lang.Exception
Performs a field update. Throws if the field is being updated already.
Parameters:
ignoreMergeFormat - If true then direct field result formatting is abandoned, regardless of the MERGEFORMAT switch, otherwise normal update is performed.

See Also:
          Aspose.Words Documentation - the home page for the Aspose.Words Product Documentation.
          Aspose.Words Support Forum - our preferred method of support.