com.aspose.words

Class FieldIncludePicture

java.lang.Object

com.aspose.words.Field

com.aspose.words.FieldIncludePicture

public class FieldIncludePicture
extends Field

Implements the INCLUDEPICTURE field.

To learn more, visit the Working with Fields documentation article.

Remarks:

Retrieves a picture and displays it as the field result.

Examples:

Shows how to insert images using IMPORT and INCLUDEPICTURE fields.

 
 Document doc = new Document();
 DocumentBuilder builder = new DocumentBuilder(doc);

 // Below are two similar field types that we can use to display images linked from the local file system.
 // 1 -  The INCLUDEPICTURE field:
 FieldIncludePicture fieldIncludePicture = (FieldIncludePicture) builder.insertField(FieldType.FIELD_INCLUDE_PICTURE, true);
 fieldIncludePicture.setSourceFullName(getImageDir() + "Transparent background logo.png");

 Assert.assertTrue(fieldIncludePicture.getFieldCode().matches(" INCLUDEPICTURE  .*"));

 // Apply the PNG32.FLT filter.
 fieldIncludePicture.setGraphicFilter("PNG32");
 fieldIncludePicture.isLinked(true);
 fieldIncludePicture.setResizeHorizontally(true);
 fieldIncludePicture.setResizeVertically(true);

 // 2 -  The IMPORT field:
 FieldImport fieldImport = (FieldImport) builder.insertField(FieldType.FIELD_IMPORT, true);
 fieldImport.setSourceFullName(getImageDir() + "Transparent background logo.png");
 fieldImport.setGraphicFilter("PNG32");
 fieldImport.isLinked(true);

 Assert.assertTrue(fieldImport.getFieldCode().matches(" IMPORT  .* \\\\c PNG32 \\\\d"));

 doc.updateFields();
 doc.save(getArtifactsDir() + "Field.IMPORT.INCLUDEPICTURE.docx");
 
 

Method Summary

Modifier and Type	Method and Description
java.lang.String	getGraphicFilter() Gets the name of the filter for the format of the graphic that is to be inserted.
boolean	getResizeHorizontally() Gets whether to resize the picture horizontally from the source.
boolean	getResizeVertically() Gets whether to resize the picture vertically from the source.
java.lang.String	getSourceFullName() Gets the location of the picture using an IRI.
int	getSwitchType(java.lang.String switchName)
boolean	isLinked() Gets whether to reduce the file size by not storing graphics data with the document.
void	isLinked(boolean value) Sets whether to reduce the file size by not storing graphics data with the document.
void	setGraphicFilter(java.lang.String value) Sets the name of the filter for the format of the graphic that is to be inserted.
void	setResizeHorizontally(boolean value) Sets whether to resize the picture horizontally from the source.
void	setResizeVertically(boolean value) Sets whether to resize the picture vertically from the source.
void	setSourceFullName(java.lang.String value) Sets the location of the picture using an IRI.

Methods inherited from class com.aspose.words.Field

getDisplayResult, getEnd, getFieldCode, getFieldCode, getFormat, getLocaleId, getResult, getSeparator, getStart, getType, isDirty, isDirty, isLocked, isLocked, needStoreOldResultNodes, remove, setLocaleId, setResult, unlink, update, update

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getSwitchType

public int getSwitchType(java.lang.String switchName)

getSourceFullName

public java.lang.String getSourceFullName()

Gets the location of the picture using an IRI.

Examples:

Shows how to insert images using IMPORT and INCLUDEPICTURE fields.

 
 Document doc = new Document();
 DocumentBuilder builder = new DocumentBuilder(doc);

 // Below are two similar field types that we can use to display images linked from the local file system.
 // 1 -  The INCLUDEPICTURE field:
 FieldIncludePicture fieldIncludePicture = (FieldIncludePicture) builder.insertField(FieldType.FIELD_INCLUDE_PICTURE, true);
 fieldIncludePicture.setSourceFullName(getImageDir() + "Transparent background logo.png");

 Assert.assertTrue(fieldIncludePicture.getFieldCode().matches(" INCLUDEPICTURE  .*"));

 // Apply the PNG32.FLT filter.
 fieldIncludePicture.setGraphicFilter("PNG32");
 fieldIncludePicture.isLinked(true);
 fieldIncludePicture.setResizeHorizontally(true);
 fieldIncludePicture.setResizeVertically(true);

 // 2 -  The IMPORT field:
 FieldImport fieldImport = (FieldImport) builder.insertField(FieldType.FIELD_IMPORT, true);
 fieldImport.setSourceFullName(getImageDir() + "Transparent background logo.png");
 fieldImport.setGraphicFilter("PNG32");
 fieldImport.isLinked(true);

 Assert.assertTrue(fieldImport.getFieldCode().matches(" IMPORT  .* \\\\c PNG32 \\\\d"));

 doc.updateFields();
 doc.save(getArtifactsDir() + "Field.IMPORT.INCLUDEPICTURE.docx");
 
 

Returns:

The location of the picture using an IRI.

setSourceFullName

public void setSourceFullName(java.lang.String value)
                       throws java.lang.Exception

Sets the location of the picture using an IRI.

Examples:

Shows how to insert images using IMPORT and INCLUDEPICTURE fields.

 
 Document doc = new Document();
 DocumentBuilder builder = new DocumentBuilder(doc);

 // Below are two similar field types that we can use to display images linked from the local file system.
 // 1 -  The INCLUDEPICTURE field:
 FieldIncludePicture fieldIncludePicture = (FieldIncludePicture) builder.insertField(FieldType.FIELD_INCLUDE_PICTURE, true);
 fieldIncludePicture.setSourceFullName(getImageDir() + "Transparent background logo.png");

 Assert.assertTrue(fieldIncludePicture.getFieldCode().matches(" INCLUDEPICTURE  .*"));

 // Apply the PNG32.FLT filter.
 fieldIncludePicture.setGraphicFilter("PNG32");
 fieldIncludePicture.isLinked(true);
 fieldIncludePicture.setResizeHorizontally(true);
 fieldIncludePicture.setResizeVertically(true);

 // 2 -  The IMPORT field:
 FieldImport fieldImport = (FieldImport) builder.insertField(FieldType.FIELD_IMPORT, true);
 fieldImport.setSourceFullName(getImageDir() + "Transparent background logo.png");
 fieldImport.setGraphicFilter("PNG32");
 fieldImport.isLinked(true);

 Assert.assertTrue(fieldImport.getFieldCode().matches(" IMPORT  .* \\\\c PNG32 \\\\d"));

 doc.updateFields();
 doc.save(getArtifactsDir() + "Field.IMPORT.INCLUDEPICTURE.docx");
 
 

Parameters:

value - The location of the picture using an IRI.

Throws:

java.lang.Exception

getGraphicFilter

public java.lang.String getGraphicFilter()

Gets the name of the filter for the format of the graphic that is to be inserted.

Examples:

Shows how to insert images using IMPORT and INCLUDEPICTURE fields.

 
 Document doc = new Document();
 DocumentBuilder builder = new DocumentBuilder(doc);

 // Below are two similar field types that we can use to display images linked from the local file system.
 // 1 -  The INCLUDEPICTURE field:
 FieldIncludePicture fieldIncludePicture = (FieldIncludePicture) builder.insertField(FieldType.FIELD_INCLUDE_PICTURE, true);
 fieldIncludePicture.setSourceFullName(getImageDir() + "Transparent background logo.png");

 Assert.assertTrue(fieldIncludePicture.getFieldCode().matches(" INCLUDEPICTURE  .*"));

 // Apply the PNG32.FLT filter.
 fieldIncludePicture.setGraphicFilter("PNG32");
 fieldIncludePicture.isLinked(true);
 fieldIncludePicture.setResizeHorizontally(true);
 fieldIncludePicture.setResizeVertically(true);

 // 2 -  The IMPORT field:
 FieldImport fieldImport = (FieldImport) builder.insertField(FieldType.FIELD_IMPORT, true);
 fieldImport.setSourceFullName(getImageDir() + "Transparent background logo.png");
 fieldImport.setGraphicFilter("PNG32");
 fieldImport.isLinked(true);

 Assert.assertTrue(fieldImport.getFieldCode().matches(" IMPORT  .* \\\\c PNG32 \\\\d"));

 doc.updateFields();
 doc.save(getArtifactsDir() + "Field.IMPORT.INCLUDEPICTURE.docx");
 
 

Returns:

The name of the filter for the format of the graphic that is to be inserted.

setGraphicFilter

public void setGraphicFilter(java.lang.String value)
                      throws java.lang.Exception

Sets the name of the filter for the format of the graphic that is to be inserted.

Examples:

Shows how to insert images using IMPORT and INCLUDEPICTURE fields.

 
 Document doc = new Document();
 DocumentBuilder builder = new DocumentBuilder(doc);

 // Below are two similar field types that we can use to display images linked from the local file system.
 // 1 -  The INCLUDEPICTURE field:
 FieldIncludePicture fieldIncludePicture = (FieldIncludePicture) builder.insertField(FieldType.FIELD_INCLUDE_PICTURE, true);
 fieldIncludePicture.setSourceFullName(getImageDir() + "Transparent background logo.png");

 Assert.assertTrue(fieldIncludePicture.getFieldCode().matches(" INCLUDEPICTURE  .*"));

 // Apply the PNG32.FLT filter.
 fieldIncludePicture.setGraphicFilter("PNG32");
 fieldIncludePicture.isLinked(true);
 fieldIncludePicture.setResizeHorizontally(true);
 fieldIncludePicture.setResizeVertically(true);

 // 2 -  The IMPORT field:
 FieldImport fieldImport = (FieldImport) builder.insertField(FieldType.FIELD_IMPORT, true);
 fieldImport.setSourceFullName(getImageDir() + "Transparent background logo.png");
 fieldImport.setGraphicFilter("PNG32");
 fieldImport.isLinked(true);

 Assert.assertTrue(fieldImport.getFieldCode().matches(" IMPORT  .* \\\\c PNG32 \\\\d"));

 doc.updateFields();
 doc.save(getArtifactsDir() + "Field.IMPORT.INCLUDEPICTURE.docx");
 
 

Parameters:

value - The name of the filter for the format of the graphic that is to be inserted.

Throws:

java.lang.Exception

isLinked

public boolean isLinked()

Gets whether to reduce the file size by not storing graphics data with the document.

Examples:

Shows how to insert images using IMPORT and INCLUDEPICTURE fields.

 
 Document doc = new Document();
 DocumentBuilder builder = new DocumentBuilder(doc);

 // Below are two similar field types that we can use to display images linked from the local file system.
 // 1 -  The INCLUDEPICTURE field:
 FieldIncludePicture fieldIncludePicture = (FieldIncludePicture) builder.insertField(FieldType.FIELD_INCLUDE_PICTURE, true);
 fieldIncludePicture.setSourceFullName(getImageDir() + "Transparent background logo.png");

 Assert.assertTrue(fieldIncludePicture.getFieldCode().matches(" INCLUDEPICTURE  .*"));

 // Apply the PNG32.FLT filter.
 fieldIncludePicture.setGraphicFilter("PNG32");
 fieldIncludePicture.isLinked(true);
 fieldIncludePicture.setResizeHorizontally(true);
 fieldIncludePicture.setResizeVertically(true);

 // 2 -  The IMPORT field:
 FieldImport fieldImport = (FieldImport) builder.insertField(FieldType.FIELD_IMPORT, true);
 fieldImport.setSourceFullName(getImageDir() + "Transparent background logo.png");
 fieldImport.setGraphicFilter("PNG32");
 fieldImport.isLinked(true);

 Assert.assertTrue(fieldImport.getFieldCode().matches(" IMPORT  .* \\\\c PNG32 \\\\d"));

 doc.updateFields();
 doc.save(getArtifactsDir() + "Field.IMPORT.INCLUDEPICTURE.docx");
 
 

Returns:

Whether to reduce the file size by not storing graphics data with the document.

isLinked

public void isLinked(boolean value)
              throws java.lang.Exception

Sets whether to reduce the file size by not storing graphics data with the document.

Examples:

Shows how to insert images using IMPORT and INCLUDEPICTURE fields.

 
 Document doc = new Document();
 DocumentBuilder builder = new DocumentBuilder(doc);

 // Below are two similar field types that we can use to display images linked from the local file system.
 // 1 -  The INCLUDEPICTURE field:
 FieldIncludePicture fieldIncludePicture = (FieldIncludePicture) builder.insertField(FieldType.FIELD_INCLUDE_PICTURE, true);
 fieldIncludePicture.setSourceFullName(getImageDir() + "Transparent background logo.png");

 Assert.assertTrue(fieldIncludePicture.getFieldCode().matches(" INCLUDEPICTURE  .*"));

 // Apply the PNG32.FLT filter.
 fieldIncludePicture.setGraphicFilter("PNG32");
 fieldIncludePicture.isLinked(true);
 fieldIncludePicture.setResizeHorizontally(true);
 fieldIncludePicture.setResizeVertically(true);

 // 2 -  The IMPORT field:
 FieldImport fieldImport = (FieldImport) builder.insertField(FieldType.FIELD_IMPORT, true);
 fieldImport.setSourceFullName(getImageDir() + "Transparent background logo.png");
 fieldImport.setGraphicFilter("PNG32");
 fieldImport.isLinked(true);

 Assert.assertTrue(fieldImport.getFieldCode().matches(" IMPORT  .* \\\\c PNG32 \\\\d"));

 doc.updateFields();
 doc.save(getArtifactsDir() + "Field.IMPORT.INCLUDEPICTURE.docx");
 
 

Parameters:

value - Whether to reduce the file size by not storing graphics data with the document.

Throws:

java.lang.Exception

getResizeHorizontally

public boolean getResizeHorizontally()

Gets whether to resize the picture horizontally from the source.

Examples:

Shows how to insert images using IMPORT and INCLUDEPICTURE fields.

 
 Document doc = new Document();
 DocumentBuilder builder = new DocumentBuilder(doc);

 // Below are two similar field types that we can use to display images linked from the local file system.
 // 1 -  The INCLUDEPICTURE field:
 FieldIncludePicture fieldIncludePicture = (FieldIncludePicture) builder.insertField(FieldType.FIELD_INCLUDE_PICTURE, true);
 fieldIncludePicture.setSourceFullName(getImageDir() + "Transparent background logo.png");

 Assert.assertTrue(fieldIncludePicture.getFieldCode().matches(" INCLUDEPICTURE  .*"));

 // Apply the PNG32.FLT filter.
 fieldIncludePicture.setGraphicFilter("PNG32");
 fieldIncludePicture.isLinked(true);
 fieldIncludePicture.setResizeHorizontally(true);
 fieldIncludePicture.setResizeVertically(true);

 // 2 -  The IMPORT field:
 FieldImport fieldImport = (FieldImport) builder.insertField(FieldType.FIELD_IMPORT, true);
 fieldImport.setSourceFullName(getImageDir() + "Transparent background logo.png");
 fieldImport.setGraphicFilter("PNG32");
 fieldImport.isLinked(true);

 Assert.assertTrue(fieldImport.getFieldCode().matches(" IMPORT  .* \\\\c PNG32 \\\\d"));

 doc.updateFields();
 doc.save(getArtifactsDir() + "Field.IMPORT.INCLUDEPICTURE.docx");
 
 

Returns:

Whether to resize the picture horizontally from the source.

setResizeHorizontally

public void setResizeHorizontally(boolean value)
                           throws java.lang.Exception

Sets whether to resize the picture horizontally from the source.

Examples:

Shows how to insert images using IMPORT and INCLUDEPICTURE fields.

 
 Document doc = new Document();
 DocumentBuilder builder = new DocumentBuilder(doc);

 // Below are two similar field types that we can use to display images linked from the local file system.
 // 1 -  The INCLUDEPICTURE field:
 FieldIncludePicture fieldIncludePicture = (FieldIncludePicture) builder.insertField(FieldType.FIELD_INCLUDE_PICTURE, true);
 fieldIncludePicture.setSourceFullName(getImageDir() + "Transparent background logo.png");

 Assert.assertTrue(fieldIncludePicture.getFieldCode().matches(" INCLUDEPICTURE  .*"));

 // Apply the PNG32.FLT filter.
 fieldIncludePicture.setGraphicFilter("PNG32");
 fieldIncludePicture.isLinked(true);
 fieldIncludePicture.setResizeHorizontally(true);
 fieldIncludePicture.setResizeVertically(true);

 // 2 -  The IMPORT field:
 FieldImport fieldImport = (FieldImport) builder.insertField(FieldType.FIELD_IMPORT, true);
 fieldImport.setSourceFullName(getImageDir() + "Transparent background logo.png");
 fieldImport.setGraphicFilter("PNG32");
 fieldImport.isLinked(true);

 Assert.assertTrue(fieldImport.getFieldCode().matches(" IMPORT  .* \\\\c PNG32 \\\\d"));

 doc.updateFields();
 doc.save(getArtifactsDir() + "Field.IMPORT.INCLUDEPICTURE.docx");
 
 

Parameters:

value - Whether to resize the picture horizontally from the source.

Throws:

java.lang.Exception

getResizeVertically

public boolean getResizeVertically()

Gets whether to resize the picture vertically from the source.

Examples:

Shows how to insert images using IMPORT and INCLUDEPICTURE fields.

 
 Document doc = new Document();
 DocumentBuilder builder = new DocumentBuilder(doc);

 // Below are two similar field types that we can use to display images linked from the local file system.
 // 1 -  The INCLUDEPICTURE field:
 FieldIncludePicture fieldIncludePicture = (FieldIncludePicture) builder.insertField(FieldType.FIELD_INCLUDE_PICTURE, true);
 fieldIncludePicture.setSourceFullName(getImageDir() + "Transparent background logo.png");

 Assert.assertTrue(fieldIncludePicture.getFieldCode().matches(" INCLUDEPICTURE  .*"));

 // Apply the PNG32.FLT filter.
 fieldIncludePicture.setGraphicFilter("PNG32");
 fieldIncludePicture.isLinked(true);
 fieldIncludePicture.setResizeHorizontally(true);
 fieldIncludePicture.setResizeVertically(true);

 // 2 -  The IMPORT field:
 FieldImport fieldImport = (FieldImport) builder.insertField(FieldType.FIELD_IMPORT, true);
 fieldImport.setSourceFullName(getImageDir() + "Transparent background logo.png");
 fieldImport.setGraphicFilter("PNG32");
 fieldImport.isLinked(true);

 Assert.assertTrue(fieldImport.getFieldCode().matches(" IMPORT  .* \\\\c PNG32 \\\\d"));

 doc.updateFields();
 doc.save(getArtifactsDir() + "Field.IMPORT.INCLUDEPICTURE.docx");
 
 

Returns:

Whether to resize the picture vertically from the source.

setResizeVertically

public void setResizeVertically(boolean value)
                         throws java.lang.Exception

Sets whether to resize the picture vertically from the source.

Examples:

Shows how to insert images using IMPORT and INCLUDEPICTURE fields.

 
 Document doc = new Document();
 DocumentBuilder builder = new DocumentBuilder(doc);

 // Below are two similar field types that we can use to display images linked from the local file system.
 // 1 -  The INCLUDEPICTURE field:
 FieldIncludePicture fieldIncludePicture = (FieldIncludePicture) builder.insertField(FieldType.FIELD_INCLUDE_PICTURE, true);
 fieldIncludePicture.setSourceFullName(getImageDir() + "Transparent background logo.png");

 Assert.assertTrue(fieldIncludePicture.getFieldCode().matches(" INCLUDEPICTURE  .*"));

 // Apply the PNG32.FLT filter.
 fieldIncludePicture.setGraphicFilter("PNG32");
 fieldIncludePicture.isLinked(true);
 fieldIncludePicture.setResizeHorizontally(true);
 fieldIncludePicture.setResizeVertically(true);

 // 2 -  The IMPORT field:
 FieldImport fieldImport = (FieldImport) builder.insertField(FieldType.FIELD_IMPORT, true);
 fieldImport.setSourceFullName(getImageDir() + "Transparent background logo.png");
 fieldImport.setGraphicFilter("PNG32");
 fieldImport.isLinked(true);

 Assert.assertTrue(fieldImport.getFieldCode().matches(" IMPORT  .* \\\\c PNG32 \\\\d"));

 doc.updateFields();
 doc.save(getArtifactsDir() + "Field.IMPORT.INCLUDEPICTURE.docx");
 
 

Parameters:

value - Whether to resize the picture vertically from the source.

Throws:

java.lang.Exception