GemBox.Pdf
  • Overview
  • Examples
  • Free version
  • Support
  • Pricelist

    Show / Hide Table of Contents

    PdfFieldActionCollection Class

    Namespace:
    GemBox.Pdf.Forms
    Assembly:
    GemBox.Pdf.dll

    Represents a collection of PdfField's actions performed when the mouse button is released inside the field's annotation active area.

    This collection also exposes actions for other trigger events (beside mouse button release) via MouseEnter, MouseExit, MouseDown, OnFocus and OnBlur properties.

    • C#
    • VB.NET
    public sealed class PdfFieldActionCollection : PdfActionCollection, IList, ICollection, IList<PdfAction>, ICollection<PdfAction>, IReadOnlyList<PdfAction>, IReadOnlyCollection<PdfAction>, IEnumerable<PdfAction>, IEnumerable
    Public NotInheritable Class PdfFieldActionCollection
        Inherits PdfActionCollection
        Implements IList, ICollection, IList(Of PdfAction), ICollection(Of PdfAction), IReadOnlyList(Of PdfAction), IReadOnlyCollection(Of PdfAction), IEnumerable(Of PdfAction), IEnumerable
    Inheritance:
    System.Object
    PdfObject
    PdfCollection
    PdfCollection<PdfAction>
    PdfActionCollection
    PdfFieldActionCollection
    Implements
    System.Collections.IList
    System.Collections.ICollection
    System.Collections.Generic.IList<PdfAction>
    System.Collections.Generic.ICollection<PdfAction>
    System.Collections.Generic.IReadOnlyList<PdfAction>
    System.Collections.Generic.IReadOnlyCollection<PdfAction>
    System.Collections.Generic.IEnumerable<PdfAction>
    System.Collections.IEnumerable

    Properties

    MouseDown

    (Optional; PDF 1.2) An action that shall be performed when the mouse button is pressed inside the field's annotation active area.

    • C#
    • VB.NET
    public PdfActionCollection MouseDown { get; }
    Public ReadOnly Property MouseDown As PdfActionCollection
    Property Value
    PdfActionCollection

    An action that shall be performed when the mouse button is pressed inside the field's annotation active area.

    See Also
    PDF Specification ISO 32000-1:2008, section '12.6.3 Trigger Events'

    MouseEnter

    (Optional; PDF 1.2) An action that shall be performed when the cursor enters the field's annotation active area.

    • C#
    • VB.NET
    public PdfActionCollection MouseEnter { get; }
    Public ReadOnly Property MouseEnter As PdfActionCollection
    Property Value
    PdfActionCollection

    An action that shall be performed when the cursor enters the field's annotation active area.

    See Also
    PDF Specification ISO 32000-1:2008, section '12.6.3 Trigger Events'

    MouseExit

    (Optional; PDF 1.2) An action that shall be performed when the cursor exits the field's annotation active area.

    • C#
    • VB.NET
    public PdfActionCollection MouseExit { get; }
    Public ReadOnly Property MouseExit As PdfActionCollection
    Property Value
    PdfActionCollection

    An action that shall be performed when the cursor exits the field's annotation active area.

    See Also
    PDF Specification ISO 32000-1:2008, section '12.6.3 Trigger Events'

    OnBlur

    (Optional; PDF 1.2; widget annotations only) An action that shall be performed when the field's annotation loses the input focus.

    • C#
    • VB.NET
    public PdfActionCollection OnBlur { get; }
    Public ReadOnly Property OnBlur As PdfActionCollection
    Property Value
    PdfActionCollection

    An action that shall be performed when the field's annotation loses the input focus.

    See Also
    PDF Specification ISO 32000-1:2008, section '12.6.3 Trigger Events'

    OnFocus

    (Optional; PDF 1.2; widget annotations only) An action that shall be performed when the field's annotation receives the input focus.

    • C#
    • VB.NET
    public PdfActionCollection OnFocus { get; }
    Public ReadOnly Property OnFocus As PdfActionCollection
    Property Value
    PdfActionCollection

    An action that shall be performed when the field's annotation receives the input focus.

    See Also
    PDF Specification ISO 32000-1:2008, section '12.6.3 Trigger Events'

    Inherited Properties

    Count

    Gets the number of elements contained in the PdfCollection.

    (Inherited from PdfCollection)

    Metadata

    (Optional; PDF 1.4) A metadata stream containing metadata for the component.

    (Inherited from PdfObject)

    Inherited Methods

    AddGoToPageView(PdfDestination)

    Adds a new PdfGoToPageViewAction with the explicit destination to the PdfActionCollection.

    (Inherited from PdfActionCollection)

    AddGoToPageView(PdfPage, PdfDestinationViewType, System.Nullable<System.Double>[])

    Adds a new PdfGoToPageViewAction with the explicit destination to the PdfActionCollection.

    parameters represent the following values depending on the viewType parameter:

    • FitRectangle

      Left, Bottom, Right and Top.

    • LeftTopZoom

      Left, Top and Zoom.

    • FitPageVertical and FitContentVertical Left.
    • FitPageHorizontal and FitContentHorizontal Top.
    • FitPage and FitContentNone.

    (Inherited from PdfActionCollection)

    AddGoToPageView(System.String)

    Adds a new PdfGoToPageViewAction with the named destination to the PdfActionCollection.

    (Inherited from PdfActionCollection)

    AddImportFormData(System.String)

    Adds a new PdfImportFormDataAction with the import data file path to the PdfActionCollection.

    (Inherited from PdfActionCollection)

    AddOpenFile(System.String)

    Adds a new PdfOpenFileAction to the PdfActionCollection.

    (Inherited from PdfActionCollection)

    AddOpenWebLink(System.String)

    Adds a new PdfOpenWebLinkAction to the PdfActionCollection.

    (Inherited from PdfActionCollection)

    AddResetForm()

    Adds a new PdfResetFormAction to the PdfActionCollection.

    (Inherited from PdfActionCollection)

    AddRunJavaScript(System.String)

    Adds a new PdfRunJavaScriptAction with the JavaScript script to be executed to the PdfActionCollection.

    (Inherited from PdfActionCollection)

    AddSubmitForm(System.String)

    Adds a new PdfSubmitFormAction with the Web server script's URL to the PdfActionCollection.

    (Inherited from PdfActionCollection)

    Clear()

    Removes all elements from the PdfCollection.

    (Inherited from PdfCollection)

    GetEnumerator()

    Returns an enumerator that iterates through the PdfActionCollection.

    (Inherited from PdfActionCollection)

    RemoveAt(System.Int32)

    Removes the element at the specified index of the PdfCollection.

    (Inherited from PdfCollection)

    Implements

    System.Collections.IList
    System.Collections.ICollection
    System.Collections.Generic.IList<T>
    System.Collections.Generic.ICollection<T>
    System.Collections.Generic.IReadOnlyList<T>
    System.Collections.Generic.IReadOnlyCollection<T>
    System.Collections.Generic.IEnumerable<T>
    System.Collections.IEnumerable

    Extension Methods

    PdfObjectExtensions.GetDictionary(PdfObject)
    PdfObjectExtensions.GetOrAddDictionary(PdfObject)
    PdfObjectExtensions.GetArray(PdfObject)
    PdfObjectExtensions.GetArray(PdfCollection)
    PdfObjectExtensions.GetOrAddArray(PdfCollection)

    Examples

    Form Actions example

    See Also

    PDF Specification ISO 32000-1:2008, section '12.6.3 Trigger Events'
    Back to top

    Facebook • Twitter • LinkedIn

    © GemBox Ltd. — All rights reserved.