Class
WatermarkCollection

Manages the collection of watermarks in a document, supporting registration, removal, and enumeration.

Definition

Namespace:Telerik.Windows.Documents.Flow.Model.Watermarks

Assembly:Telerik.Windows.Documents.Flow.dll

Syntax:

cs-api-definition
public class WatermarkCollection : IEnumerable

Inheritance: objectWatermarkCollection

Implements: IEnumerable

Constructors

WatermarkCollection(RadFlowDocument)

Creates a new watermark collection for the specified document.

Declaration

cs-api-definition
public WatermarkCollection(RadFlowDocument document)

Parameters

document

RadFlowDocument

The document.

Properties

this[int]

Gets the watermark at the specified zero-based index.

Declaration

cs-api-definition
public Watermark this[int index] { get; }

Parameters

index

int

Property Value

Watermark

The watermark.

Methods

Add(Watermark)

Registers the specified watermark in the collection and associates it with this document.

Declaration

cs-api-definition
public void Add(Watermark watermark)

Parameters

watermark

Watermark

The watermark.

Clear()

Removes all watermarks from the collection.

Declaration

cs-api-definition
public void Clear()

GetEnumerator()

Returns an enumerator for iterating through all watermarks in the collection.

Declaration

cs-api-definition
public IEnumerator GetEnumerator()

Returns

IEnumerator

An IEnumerator object that can be used to iterate through the collection.

Implements IEnumerable.GetEnumerator()

Remove(Watermark)

Unregisters the specified watermark from the collection and returns true if successful.

Declaration

cs-api-definition
public bool Remove(Watermark watermark)

Parameters

watermark

Watermark

The watermark.

Returns

bool