WatermarkFormat Interface

Contains watermark settings.

Namespace: DevExpress.XtraRichEdit.API.Native

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

NuGet Package: DevExpress.RichEdit.Core

Declaration

C#

public interface WatermarkFormat

VB.NET

Public Interface WatermarkFormat

Related API Members

The following members return WatermarkFormat objects:

• DrawingObject.WatermarkFormat

Remarks

Watermarks are stored in shape collections (ShapeCollection) of section headers. Call the Section.BeginUpdateHeader method to access a specific section header. Use the header’s SubDocument.Shapes property to return a collection of shapes located in the header. Use the Shape.Type property to find a watermark in the collection. This property returns the Watermark value if a shape is a watermark.

The Shape.WatermarkFormat property allows you to obtain and modify watermark settings, as described in the table below.

Member	Description
WatermarkFormat.Type	Returns the watermark type.
WatermarkFormat.TextOptions	Allows you to change text watermark settings.
WatermarkFormat.ImageOptions	Allows you to change image watermark settings.
WatermarkFormat.SetText	Allows you to replace watermark text.
WatermarkFormat.SetImage	Allows you to replace a watermark image.