Skip to main content
All docs
V24.1

WatermarkFormat Interface

Contains watermark settings.

Namespace: DevExpress.XtraRichEdit.API.Native

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

NuGet Packages: DevExpress.RichEdit.Core, DevExpress.Win.Navigation

Declaration

public interface WatermarkFormat

The following members return WatermarkFormat objects:

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.
See Also