TextWatermarkOptions Class

Contains text watermark options.

Namespace: DevExpress.XtraRichEdit.API.Native

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

Declaration

C#

public class TextWatermarkOptions

VB.NET

Public Class TextWatermarkOptions

Related API Members

The following members accept/return TextWatermarkOptions objects:

• WatermarkFormat.TextOptions

Example

The code sample below adds a text watermark to all document pages.

C#

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

    TextWatermarkOptions textWatermarkOptions = new TextWatermarkOptions();
    textWatermarkOptions.Color = System.Drawing.Color.LightGray;
    textWatermarkOptions.FontFamily = "Calibri";
    textWatermarkOptions.Layout = WatermarkLayout.Diagonal;
    textWatermarkOptions.Semitransparent = true;

    wordProcessor.Document.WatermarkManager.SetText("CONFIDENTIAL", textWatermarkOptions);
    wordProcessor.SaveDocument("DocumentProtection_new.docx", DocumentFormat.OpenXml);
}

VB.NET

Using wordProcessor As New RichEditDocumentServer()
    wordProcessor.LoadDocument("DocumentProtection.docx")

    Dim textWatermarkOptions As New TextWatermarkOptions()
    textWatermarkOptions.Color = System.Drawing.Color.LightGray
    textWatermarkOptions.FontFamily = "Calibri"
    textWatermarkOptions.Layout = WatermarkLayout.Diagonal
    textWatermarkOptions.Semitransparent = True

    wordProcessor.Document.WatermarkManager.SetText("CONFIDENTIAL", textWatermarkOptions)
    wordProcessor.SaveDocument("DocumentProtection_new.docx", DocumentFormat.OpenXml)
End Using

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the TextWatermarkOptions class.

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.

C#

word-processing-document-api-examples-t418535/CS/CodeExamples/WatermarkActions.cs#L27

}
TextWatermarkOptions textWatermarkOptions = new TextWatermarkOptions();
textWatermarkOptions.Color = System.Drawing.Color.LightGray;

wpf-richedit-document-api-t213968/CS/DXRichEditControlAPISample/CodeExamples/WatermarkActions.cs#L26

}
TextWatermarkOptions textWatermarkOptions = new TextWatermarkOptions();
textWatermarkOptions.Color = System.Drawing.Color.LightGray;

word-document-api-examples/CS/CodeExamples/WatermarkActions.cs#L34

// Specify text watermark options.
TextWatermarkOptions textWatermarkOptions = new TextWatermarkOptions();
textWatermarkOptions.Color = System.Drawing.Color.LightGray;

VB.NET

word-document-api-examples/VB/CodeExamples/WatermarkActions.vb#L32

' Specify text watermark options.
Dim textWatermarkOptions As DevExpress.XtraRichEdit.API.Native.TextWatermarkOptions = New DevExpress.XtraRichEdit.API.Native.TextWatermarkOptions()
textWatermarkOptions.Color = System.Drawing.Color.LightGray

Inheritance

Object

TextWatermarkOptions