Class PdfStampCollection

Namespace

Syncfusion.Pdf

Assembly

Syncfusion.Pdf.Portable.dll

A collection of stamps that are applied to the page templates.

public class PdfStampCollection : PdfCollection, IEnumerable

Inheritance

object

PdfCollection

PdfStampCollection

Implements

IEnumerable

Inherited Members

PdfCollection.Count

PdfCollection.List

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Remarks

It is used only on PdfPageTemplateElement.

Constructors

PdfStampCollection()

Creates a new instance of the PdfStampCollection class.

public PdfStampCollection()

Properties

this[int]

Gets a stamp element by its index.

public PdfPageTemplateElement this[int index] { get; }

Parameters

index int

Property Value

PdfPageTemplateElement

The PdfPageTemplateElement describes a page template object

Methods

Add(PdfPageTemplateElement)

Adds a stamp element to the collection.

public int Add(PdfPageTemplateElement template)

Parameters

template PdfPageTemplateElement

The PdfPageTemplateElement used here to create stamp element.

Returns

int

The index of the stamp element.

Add(float, float, float, float)

Creates a stamp element and adds it to the collection.

public PdfPageTemplateElement Add(float x, float y, float width, float height)

Parameters

x float

X co-ordinate of the stamp.

y float

Y co-ordinate of the stamp.

width float

Width of the stamp.

height float

Height of the stamp.

Returns

PdfPageTemplateElement

The created stamp element.

Clear()

Clears the collection.

public void Clear()

Contains(PdfPageTemplateElement)

Checks whether the stamp element exists in the collection.

public bool Contains(PdfPageTemplateElement template)

Parameters

template PdfPageTemplateElement

The PdfPageTemplateElement used here to create stamp element.

Returns

bool

True - if stamp element exists in the collection, False otherwise.

GetEnumerator()

Returns an enumerator that iterates through a collection.

public IEnumerator GetEnumerator()

Returns

IEnumerator

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

Insert(int, PdfPageTemplateElement)

Inserts a stamp element to the collection at the specified position.

public void Insert(int index, PdfPageTemplateElement template)

Parameters

index int

The index of the stamp in the collection.

template PdfPageTemplateElement

The PdfPageTemplateElement.

Remove(PdfPageTemplateElement)

Removes the stamp element from the collection.

public void Remove(PdfPageTemplateElement template)

Parameters

template PdfPageTemplateElement

The PdfPageTemplateElement.

RemoveAt(int)

Removes a stamp element from the specified position in the collection.

public void RemoveAt(int index)

Parameters

index int

The index of the stamp in the collection.