com.aspose.words
Class FieldIncludePicture

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

public class FieldIncludePicture 
extends Field

Implements the INCLUDEPICTURE field. Retrieves a picture and displays it as the field result.

Constructor Summary
FieldIncludePicture()
          
 
Property Getters/Setters Summary
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.StringgetGraphicFilter()
voidsetGraphicFilter(java.lang.String value)
           Gets or sets the name of the filter for the format of the graphic that is to be inserted.
booleanisDirty()→ inherited from Field
voidisDirty(boolean value)
          
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).
intgetLocaleId()→ inherited from Field
voidsetLocaleId(int value)
           Gets or sets the LCID of the field.
booleangetResizeHorizontally()
voidsetResizeHorizontally(boolean value)
           Gets or sets whether to resize the picture horizontally from the source.
booleangetResizeVertically()
voidsetResizeVertically(boolean value)
           Gets or sets whether to resize the picture vertically from the source.
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 picture using an IRI.
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). 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).
java.lang.StringgetSourceFullName()
          Reserved for internal use.
aspose.obfuscated.typegetSwitchType(java.lang.String switchName)
          Reserved for internal use.
booleanisLinked()
          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

FieldIncludePicture

public FieldIncludePicture()

Property Getters/Setters Detail

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.

getGraphicFilter/setGraphicFilter

public java.lang.String getGraphicFilter() / public void setGraphicFilter(java.lang.String value)
Gets or sets the name of the filter for the format of the graphic that is to be inserted.

isDirty/isDirty

→ inherited from Field
public boolean isDirty() / public void isDirty(boolean value)

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

getLocaleId/setLocaleId

→ inherited from Field
public int getLocaleId() / public void setLocaleId(int value)
Gets or sets the LCID of the field.
See Also:
FieldUpdateCultureSource.FIELD_CODE

getResizeHorizontally/setResizeHorizontally

public boolean getResizeHorizontally() / public void setResizeHorizontally(boolean value)
Gets or sets whether to resize the picture horizontally from the source.

getResizeVertically/setResizeVertically

public boolean getResizeVertically() / public void setResizeVertically(boolean value)
Gets or sets whether to resize the picture vertically from the source.

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 picture using an IRI.

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.

Method Detail

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.

getSourceFullName

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

getSwitchType

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

isLinked

public boolean isLinked()
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.