Control External Resources using WorkbookSetting.StreamProvider

Possible Usage Scenarios

Sometimes, your Excel file contains external resources e.g. linked images, etc. Aspose.Cells allows you to control these external resources using Workbook.Settings.StreamProvider which takes the implementation of IStreamProvider interface. Whenever you will try to render your worksheet containing external resources e.g. linked images, the methods of IStreamProvider interface will be invoked which will enable you to take appropriate actions for your external resources.

Control External Resources using WorkbookSetting.StreamProvider

The following sample code explains the usage of Workbook.Settings.StreamProvider. It loads the sample Excel file containing a linked image. The code replaces the linked image with Aspose Logo and renders the entire sheet into a single image using SheetRender class. The following screenshot shows the sample Excel file and its rendered output image for a reference. As you can see, the broken linked image is replaced with Aspose Logo.

Sample Code

// For complete examples and data files, please go to https://github.com/aspose-cells/Aspose.Cells-for-Java
//Implementation of IStreamProvider
class SP implements IStreamProvider
{
	public void closeStream(StreamProviderOptions arg0) throws Exception {
	}

	public void initStream(StreamProviderOptions options) throws Exception {

		//Open the filestream of Aspose Logo and assign it to StreamProviderOptions.Stream property
		File imgFile = new File(srcDir + "sampleControlExternalResourcesUsingWorkbookSetting_StreamProvider.png");

		byte[] bts = new byte[(int) imgFile.length()];

		FileInputStream fin = new FileInputStream(imgFile);
		fin.read(bts);
		fin.close();

		ByteArrayOutputStream baout = new ByteArrayOutputStream();
		baout.write(bts);
		baout.close();
		
		options.setStream(baout);
	}
}


public void Run() throws Exception {
	System.out.println("Aspose.Cells for Java Version: " + CellsHelper.getVersion());

	//String srcDir = Utils.Get_SourceDirectory();
	//String outDir = Utils.Get_OutputDirectory();

	//Load sample Excel file containing the external resource e.g. linked image etc.
	Workbook wb = new Workbook(srcDir + "sampleControlExternalResourcesUsingWorkbookSetting_StreamProvider.xlsx");

	//Provide your implementation of IStreamProvider
	wb.getSettings().setStreamProvider(new SP());

	//Access first worksheet
	Worksheet ws = wb.getWorksheets().get(0);

	//Specify image or print options, we need one page per sheet and png output
	ImageOrPrintOptions opts = new ImageOrPrintOptions();
	opts.setOnePagePerSheet(true);
	opts.setImageType(ImageType.PNG);

	//Create sheet render by passing required parameters
	SheetRender sr = new SheetRender(ws, opts);

	//Convert your entire worksheet into png image
	sr.toImage(0, outDir + "outputControlExternalResourcesUsingWorkbookSettingStreamProvider.png");

	// Print the message
	System.out.println("ControlExternalResourcesUsingWorkbookSetting_StreamProvider executed successfully.");
}

public static void main(String[] args) throws Exception {
	new ControlExternalResourcesUsingWorkbookSetting_StreamProvider().Run();
}