Xamarin.Forms

  • Code Examples
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class PdfStampCollection

    Show / Hide Table of Contents

    Class PdfStampCollection

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

    Inheritance
    System.Object
    PdfCollection
    PdfStampCollection
    Implements
    System.Collections.IEnumerable
    Inherited Members
    PdfCollection.Count
    PdfCollection.List
    Namespace: Syncfusion.Pdf
    Assembly: Syncfusion.Pdf.Portable.dll
    Syntax
    public class PdfStampCollection : PdfCollection, IEnumerable
    Remarks

    It is used only on PdfPageTemplateElement.

    Constructors

    PdfStampCollection()

    Creates a new instance of the PdfStampCollection class.

    Declaration
    public PdfStampCollection()

    Properties

    Item[Int32]

    Gets a stamp element by its index.

    Declaration
    public PdfPageTemplateElement this[int index] { get; }
    Parameters
    Type Name Description
    System.Int32 index
    Property Value
    Type Description
    PdfPageTemplateElement

    The PdfPageTemplateElement describes a page template object

    Methods

    Add(PdfPageTemplateElement)

    Adds a stamp element to the collection.

    Declaration
    public int Add(PdfPageTemplateElement template)
    Parameters
    Type Name Description
    PdfPageTemplateElement template

    The PdfPageTemplateElement used here to create stamp element.

    Returns
    Type Description
    System.Int32

    The index of the stamp element.

    Add(Single, Single, Single, Single)

    Creates a stamp element and adds it to the collection.

    Declaration
    public PdfPageTemplateElement Add(float x, float y, float width, float height)
    Parameters
    Type Name Description
    System.Single x

    X co-ordinate of the stamp.

    System.Single y

    Y co-ordinate of the stamp.

    System.Single width

    Width of the stamp.

    System.Single height

    Height of the stamp.

    Returns
    Type Description
    PdfPageTemplateElement

    The created stamp element.

    Clear()

    Clears the collection.

    Declaration
    public void Clear()

    Contains(PdfPageTemplateElement)

    Checks whether the stamp element exists in the collection.

    Declaration
    public bool Contains(PdfPageTemplateElement template)
    Parameters
    Type Name Description
    PdfPageTemplateElement template

    The PdfPageTemplateElement used here to create stamp element.

    Returns
    Type Description
    System.Boolean

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

    GetEnumerator()

    Returns an enumerator that iterates through a collection.

    Declaration
    public IEnumerator GetEnumerator()
    Returns
    Type Description
    System.Collections.IEnumerator

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

    Insert(Int32, PdfPageTemplateElement)

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

    Declaration
    public void Insert(int index, PdfPageTemplateElement template)
    Parameters
    Type Name Description
    System.Int32 index

    The index of the stamp in the collection.

    PdfPageTemplateElement template

    The PdfPageTemplateElement.

    Remove(PdfPageTemplateElement)

    Removes the stamp element from the collection.

    Declaration
    public void Remove(PdfPageTemplateElement template)
    Parameters
    Type Name Description
    PdfPageTemplateElement template

    The PdfPageTemplateElement.

    RemoveAt(Int32)

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

    Declaration
    public void RemoveAt(int index)
    Parameters
    Type Name Description
    System.Int32 index

    The index of the stamp in the collection.

    Implements

    System.Collections.IEnumerable
    Back to top Generated by DocFX
    Copyright © 2001 - 2023 Syncfusion Inc. All Rights Reserved