Watermarker

Inheritance: java.lang.Object, com.aspose.words.Processor

public class Watermarker extends Processor

Provides methods intended to insert watermarks into the documents.

Methods

Method	Description
create(WatermarkerContext context)	Creates new instance of the watermarker processor.
execute()	Execute the processor action.
from(InputStream input)
from(InputStream input, LoadOptions loadOptions)	Specifies input document for processing.
from(String input)
from(String input, LoadOptions loadOptions)	Specifies input document for processing.
setImage(InputStream inputStream, OutputStream outputStream, SaveOptions saveOptions, BufferedImage watermarkImage)
setImage(InputStream inputStream, OutputStream outputStream, SaveOptions saveOptions, BufferedImage watermarkImage, ImageWatermarkOptions options)
setImage(InputStream inputStream, OutputStream outputStream, SaveOptions saveOptions, InputStream watermarkImageStream)
setImage(InputStream inputStream, OutputStream outputStream, SaveOptions saveOptions, InputStream watermarkImageStream, ImageWatermarkOptions options)
setImage(InputStream inputStream, OutputStream outputStream, int saveFormat, BufferedImage watermarkImage)
setImage(InputStream inputStream, OutputStream outputStream, int saveFormat, BufferedImage watermarkImage, ImageWatermarkOptions options)
setImage(InputStream inputStream, OutputStream outputStream, int saveFormat, InputStream watermarkImageStream)
setImage(InputStream inputStream, OutputStream outputStream, int saveFormat, InputStream watermarkImageStream, ImageWatermarkOptions options)
setImage(String inputFileName, String outputFileName, SaveOptions saveOptions, String watermarkImageFileName)
setImage(String inputFileName, String outputFileName, SaveOptions saveOptions, String watermarkImageFileName, ImageWatermarkOptions options)	Adds an image watermark into the document with options and specified save format.
setImage(String inputFileName, String outputFileName, int saveFormat, String watermarkImageFileName)
setImage(String inputFileName, String outputFileName, int saveFormat, String watermarkImageFileName, ImageWatermarkOptions options)
setImage(String inputFileName, String outputFileName, String watermarkImageFileName)	Adds an image watermark into the document.
setImage(String inputFileName, String outputFileName, String watermarkImageFileName, ImageWatermarkOptions options)	Adds an image watermark into the document with options.
setText(InputStream inputStream, OutputStream outputStream, SaveOptions saveOptions, String watermarkText)
setText(InputStream inputStream, OutputStream outputStream, SaveOptions saveOptions, String watermarkText, TextWatermarkOptions options)
setText(InputStream inputStream, OutputStream outputStream, int saveFormat, String watermarkText)
setText(InputStream inputStream, OutputStream outputStream, int saveFormat, String watermarkText, TextWatermarkOptions options)
setText(String inputFileName, String outputFileName, SaveOptions saveOptions, String watermarkText)
setText(String inputFileName, String outputFileName, SaveOptions saveOptions, String watermarkText, TextWatermarkOptions options)	Adds a text watermark into the document with options and specified save format.
setText(String inputFileName, String outputFileName, int saveFormat, String watermarkText)
setText(String inputFileName, String outputFileName, int saveFormat, String watermarkText, TextWatermarkOptions options)
setText(String inputFileName, String outputFileName, String watermarkText)	Adds a text watermark into the document.
setText(String inputFileName, String outputFileName, String watermarkText, TextWatermarkOptions options)	Adds a text watermark into the document with options.
setWatermarkToImages(InputStream inputStream, ImageSaveOptions saveOptions, InputStream watermarkImageStream)
setWatermarkToImages(InputStream inputStream, ImageSaveOptions saveOptions, InputStream watermarkImageStream, ImageWatermarkOptions options)	Adds an image watermark into the document with options.
setWatermarkToImages(InputStream inputStream, ImageSaveOptions saveOptions, String watermarkText)
setWatermarkToImages(InputStream inputStream, ImageSaveOptions saveOptions, String watermarkText, TextWatermarkOptions options)	Adds a text watermark into the document with options.
setWatermarkToImages(String inputFileName, ImageSaveOptions saveOptions, byte[] watermarkImageBytes)
setWatermarkToImages(String inputFileName, ImageSaveOptions saveOptions, byte[] watermarkImageBytes, ImageWatermarkOptions options)	Adds an image watermark into the document with options.
setWatermarkToImages(String inputFileName, ImageSaveOptions saveOptions, String watermarkText)
setWatermarkToImages(String inputFileName, ImageSaveOptions saveOptions, String watermarkText, TextWatermarkOptions options)	Adds a text watermark into the document with options.
to(OutputStream output, SaveOptions saveOptions)
to(OutputStream output, int saveFormat)
to(String output)
to(String output, SaveOptions saveOptions)	Specifies output file for the processor.
to(String output, int saveFormat)
to(ArrayList output, SaveOptions saveOptions)
to(ArrayList output, int saveFormat)
toOutput(ArrayList output, SaveOptions saveOptions)
toOutput(ArrayList output, int saveFormat)

create(WatermarkerContext context)

public static Watermarker create(WatermarkerContext context)

Creates new instance of the watermarker processor.

Examples:

Shows how to insert watermark text to the document using context.

 String doc = getMyDir() + "Big document.docx";
 String watermarkText = "This is a watermark";

 WatermarkerContext watermarkerContext = new WatermarkerContext();
 watermarkerContext.setTextWatermark(watermarkText);

 watermarkerContext.getTextWatermarkOptions().setColor(Color.RED);

 Watermarker.create(watermarkerContext)
         .from(doc)
         .to(getArtifactsDir() + "LowCode.WatermarkContextText.docx")
         .execute();
 

Shows how to insert watermark image to the document using context.

 String doc = getMyDir() + "Document.docx";
 String watermarkImage = getImageDir() + "Logo.jpg";

 WatermarkerContext watermarkerContext = new WatermarkerContext();
 watermarkerContext.setImageWatermark(Files.readAllBytes(Paths.get(watermarkImage)));

 watermarkerContext.getImageWatermarkOptions().setScale(50.0);

 Watermarker.create(watermarkerContext)
         .from(doc)
         .to(getArtifactsDir() + "LowCode.WatermarkContextImage.docx")
         .execute();
 

Shows how to insert watermark text to the document from the stream using context.

 String watermarkText = "This is a watermark";

 try (FileInputStream streamIn = new FileInputStream(getMyDir() + "Document.docx")) {
     WatermarkerContext watermarkerContext = new WatermarkerContext();
     watermarkerContext.setTextWatermark(watermarkText);

     watermarkerContext.getTextWatermarkOptions().setColor(Color.RED);

     try (FileOutputStream streamOut = new FileOutputStream(getArtifactsDir() + "LowCode.WatermarkContextTextStream.docx")) {
         Watermarker.create(watermarkerContext)
                 .from(streamIn)
                 .to(streamOut, SaveFormat.DOCX)
                 .execute();
     }
 }
 

Shows how to insert watermark image to the document from a stream using context.

 String watermarkImage = getImageDir() + "Logo.jpg";

 try (FileInputStream streamIn = new FileInputStream(getMyDir() + "Document.docx")) {
     WatermarkerContext watermarkerContext = new WatermarkerContext();
     watermarkerContext.setImageWatermark(Files.readAllBytes(Paths.get(watermarkImage)));

     watermarkerContext.getImageWatermarkOptions().setScale(50.0);

     try (FileOutputStream streamOut = new FileOutputStream(getArtifactsDir() + "LowCode.WatermarkContextImageStream.docx")) {
         Watermarker.create(watermarkerContext)
                 .from(streamIn)
                 .to(streamOut, SaveFormat.DOCX)
                 .execute();
     }
 }
 

Parameters:

Parameter	Type	Description
context	WatermarkerContext

Returns: Watermarker

execute()

public void execute()

Execute the processor action.

Examples:

Shows how to convert documents with a single line of code using context.

 String doc = getMyDir() + "Big document.docx";

 ConverterContext converterContext = new ConverterContext();

 Converter.create(converterContext)
         .from(doc)
         .to(getArtifactsDir() + "LowCode.ConvertContext.1.pdf")
         .execute();

 Converter.create(converterContext)
         .from(doc)
         .to(getArtifactsDir() + "LowCode.ConvertContext.2.pdf", SaveFormat.RTF)
         .execute();

 OoxmlSaveOptions saveOptions = new OoxmlSaveOptions();
 {
     saveOptions.setPassword("Aspose.Words");
 }
 LoadOptions loadOptions = new LoadOptions();
 {
     loadOptions.setIgnoreOleData(true);
 }
 Converter.create(converterContext)
         .from(doc, loadOptions)
         .to(getArtifactsDir() + "LowCode.ConvertContext.3.docx", saveOptions)
         .execute();

 Converter.create(converterContext)
         .from(doc)
         .to(getArtifactsDir() + "LowCode.ConvertContext.4.png", new ImageSaveOptions(SaveFormat.PNG))
         .execute();
 

Shows how to convert documents from a stream with a single line of code using context.

 String doc = getMyDir() + "Document.docx";
 ConverterContext converterContext = new ConverterContext();

 try (FileInputStream streamIn = new FileInputStream(doc)) {
     try (FileOutputStream streamOut = new FileOutputStream(getArtifactsDir() + "LowCode.ConvertContextStream.1.docx")) {
         Converter.create(converterContext)
                 .from(streamIn)
                 .to(streamOut, SaveFormat.RTF)
                 .execute();
     }

     OoxmlSaveOptions saveOptions = new OoxmlSaveOptions();
     {
         saveOptions.setPassword("Aspose.Words");
     }
     LoadOptions loadOptions = new LoadOptions();
     {
         loadOptions.setIgnoreOleData(true);
     }
     try (FileOutputStream streamOut1 = new FileOutputStream(getArtifactsDir() + "LowCode.ConvertContextStream.2.docx")) {
         Converter.create(converterContext)
                 .from(streamIn, loadOptions)
                 .to(streamOut1, saveOptions)
                 .execute();
     }
 }
 

Shows how to merge documents into a single output document using context.

 //There is a several ways to merge documents:
 String inputDoc1 = getMyDir() + "Big document.docx";
 String inputDoc2 = getMyDir() + "Tables.docx";

 MergerContext mergerContext = new MergerContext();
 mergerContext.setMergeFormatMode(MergeFormatMode.KEEP_SOURCE_FORMATTING);

 Merger.create(mergerContext)
         .from(inputDoc1)
         .from(inputDoc2)
         .to(getArtifactsDir() + "LowCode.MergeContextDocuments.1.docx")
         .execute();

 LoadOptions firstLoadOptions = new LoadOptions();
 {
     firstLoadOptions.setIgnoreOleData(true);
 }
 LoadOptions secondLoadOptions = new LoadOptions();
 {
     secondLoadOptions.setIgnoreOleData(false);
 }
 Merger.create(mergerContext)
         .from(inputDoc1, firstLoadOptions)
         .from(inputDoc2, secondLoadOptions)
         .to(getArtifactsDir() + "LowCode.MergeContextDocuments.2.docx", SaveFormat.DOCX)
         .execute();

 OoxmlSaveOptions saveOptions = new OoxmlSaveOptions();
 {
     saveOptions.setPassword("Aspose.Words");
 }
 Merger.create(mergerContext)
         .from(inputDoc1)
         .from(inputDoc2)
         .to(getArtifactsDir() + "LowCode.MergeContextDocuments.3.docx", saveOptions)
         .execute();
 

Shows how to merge documents from stream into a single output document using context.

 //There is a several ways to merge documents:
 String inputDoc1 = getMyDir() + "Big document.docx";
 String inputDoc2 = getMyDir() + "Tables.docx";

 MergerContext mergerContext = new MergerContext();
 mergerContext.setMergeFormatMode(MergeFormatMode.KEEP_SOURCE_FORMATTING);

 try (FileInputStream firstStreamIn = new FileInputStream(inputDoc1)) {
     try (FileInputStream secondStreamIn = new FileInputStream(inputDoc2)) {
         OoxmlSaveOptions saveOptions = new OoxmlSaveOptions();
         {
             saveOptions.setPassword("Aspose.Words");
         }
         try (FileOutputStream streamOut = new FileOutputStream(getArtifactsDir() + "LowCode.MergeStreamContextDocuments.1.docx")) {
             Merger.create(mergerContext)
                     .from(firstStreamIn)
                     .from(secondStreamIn)
                     .to(streamOut, saveOptions)
                     .execute();
         }

         LoadOptions firstLoadOptions = new LoadOptions();
         {
             firstLoadOptions.setIgnoreOleData(true);
         }
         LoadOptions secondLoadOptions = new LoadOptions();
         {
             secondLoadOptions.setIgnoreOleData(false);
         }
         try (FileOutputStream streamOut1 = new FileOutputStream(getArtifactsDir() + "LowCode.MergeStreamContextDocuments.2.docx")) {
             Merger.create(mergerContext)
                     .from(firstStreamIn, firstLoadOptions)
                     .from(secondStreamIn, secondLoadOptions)
                     .to(streamOut1, SaveFormat.DOCX)
                     .execute();
         }
     }
 }
 

from(InputStream input)

public Processor from(InputStream input)

Parameters:

Parameter	Type	Description
input	java.io.InputStream

Returns: Processor

from(InputStream input, LoadOptions loadOptions)

public Processor from(InputStream input, LoadOptions loadOptions)

Specifies input document for processing.

Remarks:

If the processor accepts only one file as an input, only the last specified file will be processed. Merger processor accepts multiple files as an input, as the result all the specified documents will be merged. Converter processor accepts only one file as an input, so only the last specified file will be converted.

Examples:

Shows how to convert documents from a stream with a single line of code using context.

 String doc = getMyDir() + "Document.docx";
 ConverterContext converterContext = new ConverterContext();

 try (FileInputStream streamIn = new FileInputStream(doc)) {
     try (FileOutputStream streamOut = new FileOutputStream(getArtifactsDir() + "LowCode.ConvertContextStream.1.docx")) {
         Converter.create(converterContext)
                 .from(streamIn)
                 .to(streamOut, SaveFormat.RTF)
                 .execute();
     }

     OoxmlSaveOptions saveOptions = new OoxmlSaveOptions();
     {
         saveOptions.setPassword("Aspose.Words");
     }
     LoadOptions loadOptions = new LoadOptions();
     {
         loadOptions.setIgnoreOleData(true);
     }
     try (FileOutputStream streamOut1 = new FileOutputStream(getArtifactsDir() + "LowCode.ConvertContextStream.2.docx")) {
         Converter.create(converterContext)
                 .from(streamIn, loadOptions)
                 .to(streamOut1, saveOptions)
                 .execute();
     }
 }
 

Shows how to merge documents from stream into a single output document using context.

 //There is a several ways to merge documents:
 String inputDoc1 = getMyDir() + "Big document.docx";
 String inputDoc2 = getMyDir() + "Tables.docx";

 MergerContext mergerContext = new MergerContext();
 mergerContext.setMergeFormatMode(MergeFormatMode.KEEP_SOURCE_FORMATTING);

 try (FileInputStream firstStreamIn = new FileInputStream(inputDoc1)) {
     try (FileInputStream secondStreamIn = new FileInputStream(inputDoc2)) {
         OoxmlSaveOptions saveOptions = new OoxmlSaveOptions();
         {
             saveOptions.setPassword("Aspose.Words");
         }
         try (FileOutputStream streamOut = new FileOutputStream(getArtifactsDir() + "LowCode.MergeStreamContextDocuments.1.docx")) {
             Merger.create(mergerContext)
                     .from(firstStreamIn)
                     .from(secondStreamIn)
                     .to(streamOut, saveOptions)
                     .execute();
         }

         LoadOptions firstLoadOptions = new LoadOptions();
         {
             firstLoadOptions.setIgnoreOleData(true);
         }
         LoadOptions secondLoadOptions = new LoadOptions();
         {
             secondLoadOptions.setIgnoreOleData(false);
         }
         try (FileOutputStream streamOut1 = new FileOutputStream(getArtifactsDir() + "LowCode.MergeStreamContextDocuments.2.docx")) {
             Merger.create(mergerContext)
                     .from(firstStreamIn, firstLoadOptions)
                     .from(secondStreamIn, secondLoadOptions)
                     .to(streamOut1, SaveFormat.DOCX)
                     .execute();
         }
     }
 }
 

Parameters:

Parameter	Type	Description
input	java.io.InputStream	Input document stream.
loadOptions	LoadOptions	Optional load options used to load the document.

Returns: Processor - Returns processor with specified input file stream.

from(String input)

public Processor from(String input)

Parameters:

Parameter	Type	Description
input	java.lang.String

Returns: Processor

from(String input, LoadOptions loadOptions)

public Processor from(String input, LoadOptions loadOptions)

Specifies input document for processing.

Remarks:

If the processor accepts only one file as an input, only the last specified file will be processed. Merger processor accepts multiple files as an input, as the result all the specified documents will be merged. Converter processor accepts only one file as an input, so only the last specified file will be converted.

Examples:

Shows how to convert documents with a single line of code using context.

 String doc = getMyDir() + "Big document.docx";

 ConverterContext converterContext = new ConverterContext();

 Converter.create(converterContext)
         .from(doc)
         .to(getArtifactsDir() + "LowCode.ConvertContext.1.pdf")
         .execute();

 Converter.create(converterContext)
         .from(doc)
         .to(getArtifactsDir() + "LowCode.ConvertContext.2.pdf", SaveFormat.RTF)
         .execute();

 OoxmlSaveOptions saveOptions = new OoxmlSaveOptions();
 {
     saveOptions.setPassword("Aspose.Words");
 }
 LoadOptions loadOptions = new LoadOptions();
 {
     loadOptions.setIgnoreOleData(true);
 }
 Converter.create(converterContext)
         .from(doc, loadOptions)
         .to(getArtifactsDir() + "LowCode.ConvertContext.3.docx", saveOptions)
         .execute();

 Converter.create(converterContext)
         .from(doc)
         .to(getArtifactsDir() + "LowCode.ConvertContext.4.png", new ImageSaveOptions(SaveFormat.PNG))
         .execute();
 

Shows how to merge documents into a single output document using context.

 //There is a several ways to merge documents:
 String inputDoc1 = getMyDir() + "Big document.docx";
 String inputDoc2 = getMyDir() + "Tables.docx";

 MergerContext mergerContext = new MergerContext();
 mergerContext.setMergeFormatMode(MergeFormatMode.KEEP_SOURCE_FORMATTING);

 Merger.create(mergerContext)
         .from(inputDoc1)
         .from(inputDoc2)
         .to(getArtifactsDir() + "LowCode.MergeContextDocuments.1.docx")
         .execute();

 LoadOptions firstLoadOptions = new LoadOptions();
 {
     firstLoadOptions.setIgnoreOleData(true);
 }
 LoadOptions secondLoadOptions = new LoadOptions();
 {
     secondLoadOptions.setIgnoreOleData(false);
 }
 Merger.create(mergerContext)
         .from(inputDoc1, firstLoadOptions)
         .from(inputDoc2, secondLoadOptions)
         .to(getArtifactsDir() + "LowCode.MergeContextDocuments.2.docx", SaveFormat.DOCX)
         .execute();

 OoxmlSaveOptions saveOptions = new OoxmlSaveOptions();
 {
     saveOptions.setPassword("Aspose.Words");
 }
 Merger.create(mergerContext)
         .from(inputDoc1)
         .from(inputDoc2)
         .to(getArtifactsDir() + "LowCode.MergeContextDocuments.3.docx", saveOptions)
         .execute();
 

Parameters:

Parameter	Type	Description
input	java.lang.String	Input document file name.
loadOptions	LoadOptions	Optional load options used to load the document.

Returns: Processor - Returns processor with specified input file.

setImage(InputStream inputStream, OutputStream outputStream, SaveOptions saveOptions, BufferedImage watermarkImage)

public static void setImage(InputStream inputStream, OutputStream outputStream, SaveOptions saveOptions, BufferedImage watermarkImage)

Parameters:

Parameter	Type	Description
inputStream	java.io.InputStream
outputStream	java.io.OutputStream
saveOptions	SaveOptions
watermarkImage	java.awt.image.BufferedImage

setImage(InputStream inputStream, OutputStream outputStream, SaveOptions saveOptions, BufferedImage watermarkImage, ImageWatermarkOptions options)

public static void setImage(InputStream inputStream, OutputStream outputStream, SaveOptions saveOptions, BufferedImage watermarkImage, ImageWatermarkOptions options)

Parameters:

Parameter	Type	Description
inputStream	java.io.InputStream
outputStream	java.io.OutputStream
saveOptions	SaveOptions
watermarkImage	java.awt.image.BufferedImage
options	ImageWatermarkOptions

setImage(InputStream inputStream, OutputStream outputStream, SaveOptions saveOptions, InputStream watermarkImageStream)

public static void setImage(InputStream inputStream, OutputStream outputStream, SaveOptions saveOptions, InputStream watermarkImageStream)

Parameters:

Parameter	Type	Description
inputStream	java.io.InputStream
outputStream	java.io.OutputStream
saveOptions	SaveOptions
watermarkImageStream	java.io.InputStream

setImage(InputStream inputStream, OutputStream outputStream, SaveOptions saveOptions, InputStream watermarkImageStream, ImageWatermarkOptions options)

public static void setImage(InputStream inputStream, OutputStream outputStream, SaveOptions saveOptions, InputStream watermarkImageStream, ImageWatermarkOptions options)

Parameters:

Parameter	Type	Description
inputStream	java.io.InputStream
outputStream	java.io.OutputStream
saveOptions	SaveOptions
watermarkImageStream	java.io.InputStream
options	ImageWatermarkOptions

setImage(InputStream inputStream, OutputStream outputStream, int saveFormat, BufferedImage watermarkImage)

public static void setImage(InputStream inputStream, OutputStream outputStream, int saveFormat, BufferedImage watermarkImage)

Parameters:

Parameter	Type	Description
inputStream	java.io.InputStream
outputStream	java.io.OutputStream
saveFormat	int
watermarkImage	java.awt.image.BufferedImage

setImage(InputStream inputStream, OutputStream outputStream, int saveFormat, BufferedImage watermarkImage, ImageWatermarkOptions options)

public static void setImage(InputStream inputStream, OutputStream outputStream, int saveFormat, BufferedImage watermarkImage, ImageWatermarkOptions options)

Parameters:

Parameter	Type	Description
inputStream	java.io.InputStream
outputStream	java.io.OutputStream
saveFormat	int
watermarkImage	java.awt.image.BufferedImage
options	ImageWatermarkOptions

setImage(InputStream inputStream, OutputStream outputStream, int saveFormat, InputStream watermarkImageStream)

public static void setImage(InputStream inputStream, OutputStream outputStream, int saveFormat, InputStream watermarkImageStream)

Parameters:

Parameter	Type	Description
inputStream	java.io.InputStream
outputStream	java.io.OutputStream
saveFormat	int
watermarkImageStream	java.io.InputStream

setImage(InputStream inputStream, OutputStream outputStream, int saveFormat, InputStream watermarkImageStream, ImageWatermarkOptions options)

public static void setImage(InputStream inputStream, OutputStream outputStream, int saveFormat, InputStream watermarkImageStream, ImageWatermarkOptions options)

Parameters:

Parameter	Type	Description
inputStream	java.io.InputStream
outputStream	java.io.OutputStream
saveFormat	int
watermarkImageStream	java.io.InputStream
options	ImageWatermarkOptions

setImage(String inputFileName, String outputFileName, SaveOptions saveOptions, String watermarkImageFileName)

public static void setImage(String inputFileName, String outputFileName, SaveOptions saveOptions, String watermarkImageFileName)

Parameters:

Parameter	Type	Description
inputFileName	java.lang.String
outputFileName	java.lang.String
saveOptions	SaveOptions
watermarkImageFileName	java.lang.String

setImage(String inputFileName, String outputFileName, SaveOptions saveOptions, String watermarkImageFileName, ImageWatermarkOptions options)

public static void setImage(String inputFileName, String outputFileName, SaveOptions saveOptions, String watermarkImageFileName, ImageWatermarkOptions options)

Adds an image watermark into the document with options and specified save format.

Remarks:

If the output format is an image (BMP, EMF, EPS, GIF, JPEG, PNG, or WebP), each page of the output will be saved as a separate file. The specified output file name will be used to generate file names for each part following the rule: outputFile_partIndex.extension.

If the output format is TIFF, the output will be saved as a single multi-frame TIFF file.

Parameters:

Parameter	Type	Description
inputFileName	java.lang.String	The input file name.
outputFileName	java.lang.String	The output file name.
saveOptions	SaveOptions	The save options.
watermarkImageFileName	java.lang.String	Image that is displayed as a watermark.
options	ImageWatermarkOptions	Defines additional options for the image watermark.

setImage(String inputFileName, String outputFileName, int saveFormat, String watermarkImageFileName)

public static void setImage(String inputFileName, String outputFileName, int saveFormat, String watermarkImageFileName)

Parameters:

Parameter	Type	Description
inputFileName	java.lang.String
outputFileName	java.lang.String
saveFormat	int
watermarkImageFileName	java.lang.String

setImage(String inputFileName, String outputFileName, int saveFormat, String watermarkImageFileName, ImageWatermarkOptions options)

public static void setImage(String inputFileName, String outputFileName, int saveFormat, String watermarkImageFileName, ImageWatermarkOptions options)

Parameters:

Parameter	Type	Description
inputFileName	java.lang.String
outputFileName	java.lang.String
saveFormat	int
watermarkImageFileName	java.lang.String
options	ImageWatermarkOptions

setImage(String inputFileName, String outputFileName, String watermarkImageFileName)

public static void setImage(String inputFileName, String outputFileName, String watermarkImageFileName)

Adds an image watermark into the document.

Remarks:

If the output format is an image (BMP, EMF, EPS, GIF, JPEG, PNG, or WebP), each page of the output will be saved as a separate file. The specified output file name will be used to generate file names for each part following the rule: outputFile_partIndex.extension.

If the output format is TIFF, the output will be saved as a single multi-frame TIFF file.

Parameters:

Parameter	Type	Description
inputFileName	java.lang.String	The input file name.
outputFileName	java.lang.String	The output file name.
watermarkImageFileName	java.lang.String	Image that is displayed as a watermark.

setImage(String inputFileName, String outputFileName, String watermarkImageFileName, ImageWatermarkOptions options)

public static void setImage(String inputFileName, String outputFileName, String watermarkImageFileName, ImageWatermarkOptions options)

Adds an image watermark into the document with options.

Remarks:

If the output format is an image (BMP, EMF, EPS, GIF, JPEG, PNG, or WebP), each page of the output will be saved as a separate file. The specified output file name will be used to generate file names for each part following the rule: outputFile_partIndex.extension.

If the output format is TIFF, the output will be saved as a single multi-frame TIFF file.

Examples:

Shows how to insert watermark image to the document.

 String doc = getMyDir() + "Document.docx";
 String watermarkImage = getImageDir() + "Logo.jpg";

 Watermarker.setImage(doc, getArtifactsDir() + "LowCode.SetWatermarkImage.1.docx", watermarkImage);
 Watermarker.setImage(doc, getArtifactsDir() + "LowCode.SetWatermarkText.2.docx", SaveFormat.DOCX, watermarkImage);
 ImageWatermarkOptions options = new ImageWatermarkOptions();
 options.setScale(50.0);
 Watermarker.setImage(doc, getArtifactsDir() + "LowCode.SetWatermarkText.3.docx", watermarkImage, options);
 Watermarker.setImage(doc, getArtifactsDir() + "LowCode.SetWatermarkText.4.docx", SaveFormat.DOCX, watermarkImage, options);
 

Parameters:

Parameter	Type	Description
inputFileName	java.lang.String	The input file name.
outputFileName	java.lang.String	The output file name.
watermarkImageFileName	java.lang.String	Image that is displayed as a watermark.
options	ImageWatermarkOptions	Defines additional options for the image watermark.

setText(InputStream inputStream, OutputStream outputStream, SaveOptions saveOptions, String watermarkText)

public static void setText(InputStream inputStream, OutputStream outputStream, SaveOptions saveOptions, String watermarkText)

Parameters:

Parameter	Type	Description
inputStream	java.io.InputStream
outputStream	java.io.OutputStream
saveOptions	SaveOptions
watermarkText	java.lang.String

setText(InputStream inputStream, OutputStream outputStream, SaveOptions saveOptions, String watermarkText, TextWatermarkOptions options)

public static void setText(InputStream inputStream, OutputStream outputStream, SaveOptions saveOptions, String watermarkText, TextWatermarkOptions options)

Parameters:

Parameter	Type	Description
inputStream	java.io.InputStream
outputStream	java.io.OutputStream
saveOptions	SaveOptions
watermarkText	java.lang.String
options	TextWatermarkOptions

setText(InputStream inputStream, OutputStream outputStream, int saveFormat, String watermarkText)

public static void setText(InputStream inputStream, OutputStream outputStream, int saveFormat, String watermarkText)

Parameters:

Parameter	Type	Description
inputStream	java.io.InputStream
outputStream	java.io.OutputStream
saveFormat	int
watermarkText	java.lang.String

setText(InputStream inputStream, OutputStream outputStream, int saveFormat, String watermarkText, TextWatermarkOptions options)

public static void setText(InputStream inputStream, OutputStream outputStream, int saveFormat, String watermarkText, TextWatermarkOptions options)

Parameters:

Parameter	Type	Description
inputStream	java.io.InputStream
outputStream	java.io.OutputStream
saveFormat	int
watermarkText	java.lang.String
options	TextWatermarkOptions

setText(String inputFileName, String outputFileName, SaveOptions saveOptions, String watermarkText)

public static void setText(String inputFileName, String outputFileName, SaveOptions saveOptions, String watermarkText)

Parameters:

Parameter	Type	Description
inputFileName	java.lang.String
outputFileName	java.lang.String
saveOptions	SaveOptions
watermarkText	java.lang.String

setText(String inputFileName, String outputFileName, SaveOptions saveOptions, String watermarkText, TextWatermarkOptions options)

public static void setText(String inputFileName, String outputFileName, SaveOptions saveOptions, String watermarkText, TextWatermarkOptions options)

Adds a text watermark into the document with options and specified save format.

Remarks:

If the output format is an image (BMP, EMF, EPS, GIF, JPEG, PNG, or WebP), each page of the output will be saved as a separate file. The specified output file name will be used to generate file names for each part following the rule: outputFile_partIndex.extension.

If the output format is TIFF, the output will be saved as a single multi-frame TIFF file.

Parameters:

Parameter	Type	Description
inputFileName	java.lang.String	The input file name.
outputFileName	java.lang.String	The output file name.
saveOptions	SaveOptions	The save options.
watermarkText	java.lang.String	Text that is displayed as a watermark.
options	TextWatermarkOptions	Defines additional options for the text watermark.

setText(String inputFileName, String outputFileName, int saveFormat, String watermarkText)

public static void setText(String inputFileName, String outputFileName, int saveFormat, String watermarkText)

Parameters:

Parameter	Type	Description
inputFileName	java.lang.String
outputFileName	java.lang.String
saveFormat	int
watermarkText	java.lang.String

setText(String inputFileName, String outputFileName, int saveFormat, String watermarkText, TextWatermarkOptions options)

public static void setText(String inputFileName, String outputFileName, int saveFormat, String watermarkText, TextWatermarkOptions options)

Parameters:

Parameter	Type	Description
inputFileName	java.lang.String
outputFileName	java.lang.String
saveFormat	int
watermarkText	java.lang.String
options	TextWatermarkOptions

setText(String inputFileName, String outputFileName, String watermarkText)

public static void setText(String inputFileName, String outputFileName, String watermarkText)

Adds a text watermark into the document.

Remarks:

If the output format is an image (BMP, EMF, EPS, GIF, JPEG, PNG, or WebP), each page of the output will be saved as a separate file. The specified output file name will be used to generate file names for each part following the rule: outputFile_partIndex.extension.

If the output format is TIFF, the output will be saved as a single multi-frame TIFF file.

Parameters:

Parameter	Type	Description
inputFileName	java.lang.String	The input file name.
outputFileName	java.lang.String	The output file name.
watermarkText	java.lang.String	Text that is displayed as a watermark.

setText(String inputFileName, String outputFileName, String watermarkText, TextWatermarkOptions options)

public static void setText(String inputFileName, String outputFileName, String watermarkText, TextWatermarkOptions options)

Adds a text watermark into the document with options.

Remarks:

If the output format is an image (BMP, EMF, EPS, GIF, JPEG, PNG, or WebP), each page of the output will be saved as a separate file. The specified output file name will be used to generate file names for each part following the rule: outputFile_partIndex.extension.

If the output format is TIFF, the output will be saved as a single multi-frame TIFF file.

Examples:

Shows how to insert watermark text to the document.

 String doc = getMyDir() + "Big document.docx";
 String watermarkText = "This is a watermark";

 Watermarker.setText(doc, getArtifactsDir() + "LowCode.WatermarkText.1.docx", watermarkText);
 Watermarker.setText(doc, getArtifactsDir() + "LowCode.WatermarkText.2.docx", SaveFormat.DOCX, watermarkText);
 TextWatermarkOptions options = new TextWatermarkOptions();
 options.setColor(Color.RED);
 Watermarker.setText(doc, getArtifactsDir() + "LowCode.WatermarkText.3.docx", watermarkText, options);
 Watermarker.setText(doc, getArtifactsDir() + "LowCode.WatermarkText.4.docx", SaveFormat.DOCX, watermarkText, options);
 

Parameters:

Parameter	Type	Description
inputFileName	java.lang.String	The input file name.
outputFileName	java.lang.String	The output file name.
watermarkText	java.lang.String	Text that is displayed as a watermark.
options	TextWatermarkOptions	Defines additional options for the text watermark.

setWatermarkToImages(InputStream inputStream, ImageSaveOptions saveOptions, InputStream watermarkImageStream)

public static OutputStream[] setWatermarkToImages(InputStream inputStream, ImageSaveOptions saveOptions, InputStream watermarkImageStream)

Parameters:

Parameter	Type	Description
inputStream	java.io.InputStream
saveOptions	ImageSaveOptions
watermarkImageStream	java.io.InputStream

Returns: java.io.OutputStream[]

setWatermarkToImages(InputStream inputStream, ImageSaveOptions saveOptions, InputStream watermarkImageStream, ImageWatermarkOptions options)

public static OutputStream[] setWatermarkToImages(InputStream inputStream, ImageSaveOptions saveOptions, InputStream watermarkImageStream, ImageWatermarkOptions options)

Adds an image watermark into the document with options. Renders the output to images.

Examples:

Shows how to insert watermark image to the document from a stream and save result to images.

 String watermarkImage = getImageDir() + "Logo.jpg";

 try (FileInputStream streamIn = new FileInputStream(getMyDir() + "Document.docx")) {
     try (FileInputStream imageStream = new FileInputStream(watermarkImage)) {
         Watermarker.setWatermarkToImages(streamIn, new ImageSaveOptions(SaveFormat.PNG), imageStream);
         ImageWatermarkOptions options = new ImageWatermarkOptions();
         options.setScale(50.0);
         Watermarker.setWatermarkToImages(streamIn, new ImageSaveOptions(SaveFormat.PNG), imageStream, options);
     }
 }
 

Parameters:

Parameter	Type	Description
inputStream	java.io.InputStream	The input stream.
saveOptions	ImageSaveOptions	The save options.
watermarkImageStream	java.io.InputStream	Image stream that is displayed as a watermark.
options	ImageWatermarkOptions	Defines additional options for the image watermark.

Returns: java.io.OutputStream[]

setWatermarkToImages(InputStream inputStream, ImageSaveOptions saveOptions, String watermarkText)

public static OutputStream[] setWatermarkToImages(InputStream inputStream, ImageSaveOptions saveOptions, String watermarkText)

Parameters:

Parameter	Type	Description
inputStream	java.io.InputStream
saveOptions	ImageSaveOptions
watermarkText	java.lang.String

Returns: java.io.OutputStream[]

setWatermarkToImages(InputStream inputStream, ImageSaveOptions saveOptions, String watermarkText, TextWatermarkOptions options)

public static OutputStream[] setWatermarkToImages(InputStream inputStream, ImageSaveOptions saveOptions, String watermarkText, TextWatermarkOptions options)

Adds a text watermark into the document with options. Renders the output to images.

Examples:

Shows how to insert watermark text to the document from the stream and save result to images.

 String watermarkText = "This is a watermark";

 try (FileInputStream streamIn = new FileInputStream(getMyDir() + "Document.docx")) {
     OutputStream[] images = Watermarker.setWatermarkToImages(streamIn, new ImageSaveOptions(SaveFormat.PNG), watermarkText);

     TextWatermarkOptions watermarkOptions = new TextWatermarkOptions();
     watermarkOptions.setColor(Color.RED);
     images = Watermarker.setWatermarkToImages(streamIn, new ImageSaveOptions(SaveFormat.PNG), watermarkText, watermarkOptions);
 }
 

Parameters:

Parameter	Type	Description
inputStream	java.io.InputStream	The input file stream.
saveOptions	ImageSaveOptions	The save options.
watermarkText	java.lang.String	Text that is displayed as a watermark.
options	TextWatermarkOptions	Defines additional options for the text watermark.

Returns: java.io.OutputStream[]

setWatermarkToImages(String inputFileName, ImageSaveOptions saveOptions, byte[] watermarkImageBytes)

public static OutputStream[] setWatermarkToImages(String inputFileName, ImageSaveOptions saveOptions, byte[] watermarkImageBytes)

Parameters:

Parameter	Type	Description
inputFileName	java.lang.String
saveOptions	ImageSaveOptions
watermarkImageBytes	byte[]

Returns: java.io.OutputStream[]

setWatermarkToImages(String inputFileName, ImageSaveOptions saveOptions, byte[] watermarkImageBytes, ImageWatermarkOptions options)

public static OutputStream[] setWatermarkToImages(String inputFileName, ImageSaveOptions saveOptions, byte[] watermarkImageBytes, ImageWatermarkOptions options)

Adds an image watermark into the document with options. Renders the output to images.

Examples:

Shows how to insert watermark image to the document and save result to images.

 String doc = getMyDir() + "Document.docx";
 String watermarkImage = getImageDir() + "Logo.jpg";
 Path watermarkImagePath = Paths.get(watermarkImage);

 Watermarker.setWatermarkToImages(doc, new ImageSaveOptions(SaveFormat.PNG), Files.readAllBytes(watermarkImagePath));

 ImageWatermarkOptions options = new ImageWatermarkOptions();
 options.setScale(50.0);
 Watermarker.setWatermarkToImages(doc, new ImageSaveOptions(SaveFormat.PNG), Files.readAllBytes(watermarkImagePath), options);
 

Parameters:

Parameter	Type	Description
inputFileName	java.lang.String	The input file name.
saveOptions	ImageSaveOptions	The save options.
watermarkImageBytes	byte[]	Image bytes that is displayed as a watermark.
options	ImageWatermarkOptions	Defines additional options for the image watermark.

Returns: java.io.OutputStream[]

setWatermarkToImages(String inputFileName, ImageSaveOptions saveOptions, String watermarkText)

public static OutputStream[] setWatermarkToImages(String inputFileName, ImageSaveOptions saveOptions, String watermarkText)

Parameters:

Parameter	Type	Description
inputFileName	java.lang.String
saveOptions	ImageSaveOptions
watermarkText	java.lang.String

Returns: java.io.OutputStream[]

setWatermarkToImages(String inputFileName, ImageSaveOptions saveOptions, String watermarkText, TextWatermarkOptions options)

public static OutputStream[] setWatermarkToImages(String inputFileName, ImageSaveOptions saveOptions, String watermarkText, TextWatermarkOptions options)

Adds a text watermark into the document with options. Renders the output to images.

Examples:

Shows how to insert watermark text to the document and save result to images.

 String doc = getMyDir() + "Big document.docx";
 String watermarkText = "This is a watermark";

 OutputStream[] images = Watermarker.setWatermarkToImages(doc, new ImageSaveOptions(SaveFormat.PNG), watermarkText);

 TextWatermarkOptions watermarkOptions = new TextWatermarkOptions();
 watermarkOptions.setColor(Color.RED);
 images = Watermarker.setWatermarkToImages(doc, new ImageSaveOptions(SaveFormat.PNG), watermarkText, watermarkOptions);
 

Parameters:

Parameter	Type	Description
inputFileName	java.lang.String	The input file name.
saveOptions	ImageSaveOptions	The save options.
watermarkText	java.lang.String	Text that is displayed as a watermark.
options	TextWatermarkOptions	Defines additional options for the text watermark.

Returns: java.io.OutputStream[]

to(OutputStream output, SaveOptions saveOptions)

public Processor to(OutputStream output, SaveOptions saveOptions)

Parameters:

Parameter	Type	Description
output	java.io.OutputStream
saveOptions	SaveOptions

Returns: Processor

to(OutputStream output, int saveFormat)

public Processor to(OutputStream output, int saveFormat)

Parameters:

Parameter	Type	Description
output	java.io.OutputStream
saveFormat	int

Returns: Processor

to(String output)

public Processor to(String output)

Parameters:

Parameter	Type	Description
output	java.lang.String

Returns: Processor

to(String output, SaveOptions saveOptions)

public Processor to(String output, SaveOptions saveOptions)

Specifies output file for the processor.

Remarks:

If the output consists of multiple files, the specified output file name is used to generate the file name for each part following the rule: ‘outputFile_partIndex.extension’.

Examples:

Shows how to convert documents with a single line of code using context.

 String doc = getMyDir() + "Big document.docx";

 ConverterContext converterContext = new ConverterContext();

 Converter.create(converterContext)
         .from(doc)
         .to(getArtifactsDir() + "LowCode.ConvertContext.1.pdf")
         .execute();

 Converter.create(converterContext)
         .from(doc)
         .to(getArtifactsDir() + "LowCode.ConvertContext.2.pdf", SaveFormat.RTF)
         .execute();

 OoxmlSaveOptions saveOptions = new OoxmlSaveOptions();
 {
     saveOptions.setPassword("Aspose.Words");
 }
 LoadOptions loadOptions = new LoadOptions();
 {
     loadOptions.setIgnoreOleData(true);
 }
 Converter.create(converterContext)
         .from(doc, loadOptions)
         .to(getArtifactsDir() + "LowCode.ConvertContext.3.docx", saveOptions)
         .execute();

 Converter.create(converterContext)
         .from(doc)
         .to(getArtifactsDir() + "LowCode.ConvertContext.4.png", new ImageSaveOptions(SaveFormat.PNG))
         .execute();
 

Shows how to merge documents into a single output document using context.

 //There is a several ways to merge documents:
 String inputDoc1 = getMyDir() + "Big document.docx";
 String inputDoc2 = getMyDir() + "Tables.docx";

 MergerContext mergerContext = new MergerContext();
 mergerContext.setMergeFormatMode(MergeFormatMode.KEEP_SOURCE_FORMATTING);

 Merger.create(mergerContext)
         .from(inputDoc1)
         .from(inputDoc2)
         .to(getArtifactsDir() + "LowCode.MergeContextDocuments.1.docx")
         .execute();

 LoadOptions firstLoadOptions = new LoadOptions();
 {
     firstLoadOptions.setIgnoreOleData(true);
 }
 LoadOptions secondLoadOptions = new LoadOptions();
 {
     secondLoadOptions.setIgnoreOleData(false);
 }
 Merger.create(mergerContext)
         .from(inputDoc1, firstLoadOptions)
         .from(inputDoc2, secondLoadOptions)
         .to(getArtifactsDir() + "LowCode.MergeContextDocuments.2.docx", SaveFormat.DOCX)
         .execute();

 OoxmlSaveOptions saveOptions = new OoxmlSaveOptions();
 {
     saveOptions.setPassword("Aspose.Words");
 }
 Merger.create(mergerContext)
         .from(inputDoc1)
         .from(inputDoc2)
         .to(getArtifactsDir() + "LowCode.MergeContextDocuments.3.docx", saveOptions)
         .execute();
 

Parameters:

Parameter	Type	Description
output	java.lang.String	Output file name.
saveOptions	SaveOptions	Optional save options. If not specified, save format is determined by the file extension.

Returns: Processor - Returns processor with specified output file.

to(String output, int saveFormat)

public Processor to(String output, int saveFormat)

Parameters:

Parameter	Type	Description
output	java.lang.String
saveFormat	int

Returns: Processor

to(ArrayList output, SaveOptions saveOptions)

public Processor to(ArrayList output, SaveOptions saveOptions)

Parameters:

Parameter	Type	Description
output	java.util.ArrayList
saveOptions	SaveOptions

Returns: Processor

to(ArrayList output, int saveFormat)

public Processor to(ArrayList output, int saveFormat)

Parameters:

Parameter	Type	Description
output	java.util.ArrayList
saveFormat	int

Returns: Processor

toOutput(ArrayList output, SaveOptions saveOptions)

public Processor toOutput(ArrayList output, SaveOptions saveOptions)

Parameters:

Parameter	Type	Description
output	java.util.ArrayList
saveOptions	SaveOptions

Returns: Processor

toOutput(ArrayList output, int saveFormat)

public Processor toOutput(ArrayList output, int saveFormat)

Parameters:

Parameter	Type	Description
output	java.util.ArrayList
saveFormat	int

Returns: Processor