WatermarkerContext

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

public class WatermarkerContext extends ProcessorContext

Document watermarker context.

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();
     }
 }

Constructors

Constructor	Description
WatermarkerContext()	Initializes a new instance of this class.

Methods

Method	Description
getFontSettings()	Font settings used by the processor.
getImageWatermark()	Image bytes to be used as a watermark.
getImageWatermarkOptions()	Options for the text watermark.
getLayoutOptions()	Document layout options used by the processor.
getTextWatermark()	Text to be used as a watermark.
getTextWatermarkOptions()	Options for the image watermark.
getWarningCallback()	Warning callback used by the processor.
setFontSettings(FontSettings value)	Font settings used by the processor.
setImageWatermark(byte[] value)	Image bytes to be used as a watermark.
setTextWatermark(String value)	Text to be used as a watermark.
setWarningCallback(IWarningCallback value)	Warning callback used by the processor.

WatermarkerContext()

public WatermarkerContext()

Initializes a new instance of this class.

getFontSettings()

public FontSettings getFontSettings()

Font settings used by the processor.

Returns: FontSettings - The corresponding FontSettings value.

getImageWatermark()

public byte[] getImageWatermark()

Image bytes to be used as a watermark.

Remarks:

If both getImageWatermark() / setImageWatermark(byte[]) and getTextWatermark() / setTextWatermark(java.lang.String) are specified, text watermark overrides image watermark.

Examples:

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 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();
     }
 }

Returns: byte[] - The corresponding byte[] value.

getImageWatermarkOptions()

public ImageWatermarkOptions getImageWatermarkOptions()

Options for the text watermark.

Examples:

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 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();
     }
 }

Returns: ImageWatermarkOptions - The corresponding ImageWatermarkOptions value.

getLayoutOptions()

public LayoutOptions getLayoutOptions()

Document layout options used by the processor.

Returns: LayoutOptions - The corresponding LayoutOptions value.

getTextWatermark()

public String getTextWatermark()

Text to be used as a watermark.

Remarks:

If both getImageWatermark() / setImageWatermark(byte[]) and getTextWatermark() / setTextWatermark(java.lang.String) are specified, text watermark overrides image watermark.

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 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();
     }
 }

Returns: java.lang.String - The corresponding java.lang.String value.

getTextWatermarkOptions()

public TextWatermarkOptions getTextWatermarkOptions()

Options for the image watermark.

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 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();
     }
 }

Returns: TextWatermarkOptions - The corresponding TextWatermarkOptions value.

getWarningCallback()

public IWarningCallback getWarningCallback()

Warning callback used by the processor.

Returns: IWarningCallback - The corresponding IWarningCallback value.

setFontSettings(FontSettings value)

public void setFontSettings(FontSettings value)

Font settings used by the processor.

Parameters:

Parameter	Type	Description
value	FontSettings	The corresponding FontSettings value.

setImageWatermark(byte[] value)

public void setImageWatermark(byte[] value)

Image bytes to be used as a watermark.

Remarks:

If both getImageWatermark() / setImageWatermark(byte[]) and getTextWatermark() / setTextWatermark(java.lang.String) are specified, text watermark overrides image watermark.

Examples:

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 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
value	byte[]	The corresponding byte[] value.

setTextWatermark(String value)

public void setTextWatermark(String value)

Text to be used as a watermark.

Remarks:

If both getImageWatermark() / setImageWatermark(byte[]) and getTextWatermark() / setTextWatermark(java.lang.String) are specified, text watermark overrides image watermark.

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 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();
     }
 }

Parameters:

Parameter	Type	Description
value	java.lang.String	The corresponding java.lang.String value.

setWarningCallback(IWarningCallback value)

public void setWarningCallback(IWarningCallback value)

Warning callback used by the processor.

Parameters:

Parameter	Type	Description
value	IWarningCallback	The corresponding IWarningCallback value.

Watermarker WebExtension