Working with Images

Aspose.Words allows users to work with images in a very flexible way. In this article, you can explore only some of the possibilities of working with images.

How to Extract Images from a Document

All images are stored inside Shape nodes in a Document. To extract all images or images having a specific type from the document, follow these steps:

• Use the getChildNodes method to select all Shape nodes.
• Iterate through resulting node collections.
• Check the hasImage boolean property.
• Extract image data using the ImageData property.
• Save image data to a file.

// For complete examples and data files, please go to https://github.com/aspose-words/Aspose.Words-for-Java
// The path to the documents directory.
String dataDir = Utils.getDataDir(ExtractImagesToFiles.class);

Document doc = new Document(dataDir + "Image.SampleImages.doc");

NodeCollection<Shape> shapes = (NodeCollection<Shape>) doc.getChildNodes(NodeType.SHAPE, true);
int imageIndex = 0;
for (Shape shape : shapes
        ) {
    if (shape.hasImage()) {
        String imageFileName = String.format(
                "Image.ExportImages.{0}_out_{1}", imageIndex, FileFormatUtil.imageTypeToExtension(shape.getImageData().getImageType()));
        shape.getImageData().save(dataDir + imageFileName);
        imageIndex++;
    }
}

How to Insert Barcode on each Document Page

This example lets you add the same or different barcodes on all or specific pages of a Word document. There is no direct way to add barcodes on all pages of a document but you can use moveToSection, moveToHeaderFooter and insertImage methods to move to any section or headers/footers and insert the barcode images as you can see in the following code. 

The following code example shows how to insert a barcode image on each page of a document:

// For complete examples and data files, please go to https://github.com/aspose-words/Aspose.Words-for-Java
// The path to the documents directory.
String dataDir = Utils.getDataDir(InsertBarcodeImage.class);

Document doc = new Document(dataDir + "Image.SampleImages.doc");
DocumentBuilder builder = new DocumentBuilder(doc);

// The number of pages the document should have.
int numPages = 4;
// The document starts with one section, insert the barcode into this existing section.
InsertBarcodeIntoFooter(builder, doc.getFirstSection(), 1, HeaderFooterType.FOOTER_PRIMARY);
InsertBarcodeIntoFooter(builder, doc.getFirstSection(), 1, HeaderFooterType.FOOTER_PRIMARY);

for (int i = 1; i < numPages; i++) {
    // Clone the first section and add it into the end of the document.
    Section cloneSection = (Section) doc.getFirstSection().deepClone(false);
    // cloneSection.getPageSetup().getSectionStart() = SectionStart.NEW_PAGE;
    doc.appendChild(cloneSection);

    // Insert the barcode and other information into the footer of the section.
    InsertBarcodeIntoFooter(builder, cloneSection, i, HeaderFooterType.FOOTER_PRIMARY);
}

dataDir = dataDir + "Document_out_.docx";
// Save the document as a PDF to disk. You can also save this directly to a stream.
doc.save(dataDir);

// For complete examples and data files, please go to https://github.com/aspose-words/Aspose.Words-for-Java
private static void InsertBarcodeIntoFooter(DocumentBuilder builder, Section section, int pageId, int footerType) {
    // Move to the footer type in the specific section.
    try {
        builder.moveToSection(section.getDocument().indexOf(section));
        builder.moveToHeaderFooter(footerType);

        String dataDir = Utils.getDataDir(InsertBarcodeImage.class);

        // Insert the barcode, then move to the next line and insert the ID along with the page number.
        // Use pageId if you need to insert a different barcode on each page. 0 = First page, 1 = Second page etc.
        builder.insertImage(dataDir + "Barcode1.png");
        builder.writeln();
        builder.write("1234567890");
        builder.insertField("PAGE");

        // Create a right aligned tab at the right margin.
        double tabPos = section.getPageSetup().getPageWidth() - section.getPageSetup().getRightMargin() - section.getPageSetup().getLeftMargin();
        builder.getCurrentParagraph().getParagraphFormat().getTabStops().add(new TabStop(tabPos, TabAlignment.RIGHT, TabLeader.NONE));

        // Move to the right hand side of the page and insert the page and page total.
        builder.write(ControlChar.TAB);
        builder.insertField("PAGE");
        builder.write(" of ");
        builder.insertField("NUMPAGES");
    } catch (Exception x) {

    }
}

Lock Aspect Ratio of Image

The aspect ratio of a geometric shape is the ratio of its sizes in different dimensions. You can lock the aspect ratio of an image using AspectRatioLocked. The default value of the shape’s aspect ratio depends on the ShapeType. It is true for ShapeType.Image and false for other shape types.

The following code example shows how to work with aspect ratio:

// For complete examples and data files, please go to https://github.com/aspose-words/Aspose.Words-for-Java
// The path to the documents directory.
String dataDir = Utils.getDataDir(DocumentBuilderSetImageAspectRatioLocked.class);

// Open the document.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
Shape shape = builder.insertImage(dataDir + "Test.png");
shape.setAspectRatioLocked(false);

doc.save(dataDir + "output.doc");

How to Get Actual Bounds of Shape in Points

If you want the actual bounding box of the shape as rendered on the page, you can achieve this by using the BoundsInPoints property.

The following code example shows how to use this property:

// For complete examples and data files, please go to https://github.com/aspose-words/Aspose.Words-for-Java
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
Shape shape = builder.insertImage(dataDir + "Test.png");
shape.setAspectRatioLocked(false);

System.out.print("\nGets the actual bounds of the shape in points. ");
System.out.println(shape.getShapeRenderer().getBoundsInPoints());

Crop Images

The cropping of an image usually refers to the removal of the unwanted outer parts of an image to help improve the framing. It is also used for the removal of some of the portions of an image to increase the focus on a particular area.

The following code example shows how to achieve this using Aspose.Words API:

// For complete examples and data files, please go to https://github.com/aspose-words/Aspose.Words-for-Java
// The path to the documents directory.
String dataDir = Utils.getDataDir(CropImages.class);
        
String inputPath = dataDir + "ch63_Fig0013.jpg";
String outputPath = dataDir + "cropped-1.jpg";
        
cropImage(inputPath, outputPath, 124, 90, 570, 571);

// For complete examples and data files, please go to https://github.com/aspose-words/Aspose.Words-for-Java
public static void cropImage(String inPath, String outPath, int left, int top, int width, int height) throws Exception {

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

	BufferedImage img = ImageIO.read(new File(inPath));

	int effectiveWidth = img.getWidth() - width;
	int effectiveHeight = img.getHeight() - height;

	Shape croppedImage = builder.insertImage(img,
	ConvertUtil.pixelToPoint(img.getWidth() - effectiveWidth),
	ConvertUtil.pixelToPoint(img.getHeight() - effectiveHeight));
	
	double widthRatio = croppedImage.getWidth() / ConvertUtil.pixelToPoint(img.getWidth());
	double heightRatio = croppedImage.getHeight() / ConvertUtil.pixelToPoint(img.getHeight());
	
	if (widthRatio < 1)
	croppedImage.getImageData().setCropRight(1 - widthRatio);
	
	if (heightRatio < 1)
	croppedImage.getImageData().setCropBottom(1 - heightRatio);
	
	float leftToWidth = (float) left / img.getWidth();
	float topToHeight = (float) top / img.getHeight();
	
	croppedImage.getImageData().setCropLeft(leftToWidth);
	croppedImage.getImageData().setCropRight(croppedImage.getImageData().getCropRight() - leftToWidth);
	
	croppedImage.getImageData().setCropTop(topToHeight);
	croppedImage.getImageData().setCropBottom(croppedImage.getImageData().getCropBottom() - topToHeight);
	
	croppedImage.getShapeRenderer().save(outPath, new ImageSaveOptions(SaveFormat.JPEG));
}

Saving Images as WMF

Aspose.Words provides functionality to save all the available images in a document to WMF format while converting DOCX to RTF.

The following code example shows how to save images as WMF with RTF save options:

// For complete examples and data files, please go to https://github.com/aspose-words/Aspose.Words-for-Java
String fileName = "TestFile.doc";
Document doc = new Document(dataDir + fileName);

RtfSaveOptions saveOpts = new RtfSaveOptions();
saveOpts.setSaveImagesAsWmf(true);

doc.save(dataDir + "output.rtf", saveOpts);