Skip to main content
All docs
V24.2

DevExpress v24.2 Update — Your Feedback Matters

Our What's New in v24.2 webpage includes product-specific surveys. Your response to our survey questions will help us measure product satisfaction for features released in this major update and help us refine our plans for our next major release.

Take the survey Not interested

WatermarkManager.SetImage(Image, ImageWatermarkOptions) Method

Adds an image watermark to all document pages.

Namespace: DevExpress.XtraRichEdit.API.Native

Assembly: DevExpress.RichEdit.v24.2.Core.dll

NuGet Package: DevExpress.RichEdit.Core

#Declaration

[Browsable(false)]
void SetImage(
    Image image,
    ImageWatermarkOptions options
)

#Parameters

Name Type Description
image Image

A watermark image.

options ImageWatermarkOptions

An object that contains image watermark options.

#Remarks

Watermarks are located in section headers. If a document does not contain headers, a SetImage method call adds headers of the Primary type to all document sections.

If the document has multiple sections, this method adds the same watermark to each section and each existing section header (first, primary, odd, or even).

The WatermarkManager.Type property indicates whether the document has watermarks. The property returns WatermarkType.None if the document does not contain watermarks.

#Example

The code sample below adds an image watermark to all document pages.

result

using (RichEditDocumentServer wordProcessor = new RichEditDocumentServer())
{
    wordProcessor.LoadDocument("DocumentProtection.docx");

    ImageWatermarkOptions imageWatermarkOptions = new ImageWatermarkOptions();
    imageWatermarkOptions.Washout = false;
    imageWatermarkOptions.Scale = 1.5;

    wordProcessor.Document.WatermarkManager.SetImage(Image.FromFile("DevExpress.png"), imageWatermarkOptions);
    wordProcessor.SaveDocument("DocumentProtection_new.docx", DocumentFormat.OpenXml);
}

The following code snippets (auto-collected from DevExpress Examples) contain references to the SetImage(Image, ImageWatermarkOptions) method.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

See Also