PdfActionCollection Class

Namespace:
GemBox.Pdf.Actions
Assembly:
GemBox.Pdf.dll

Represents a collection of PdfActions.

note

This collection is implemented as singly linked list and therefore methods that use random access (index) are an O(n) operations, where n is Count.

public class PdfActionCollection : PdfCollection<PdfAction>, IList, ICollection, IList<PdfAction>, ICollection<PdfAction>, IReadOnlyList<PdfAction>, IReadOnlyCollection<PdfAction>, IEnumerable<PdfAction>, IEnumerable
Public Class PdfActionCollection
    Inherits PdfCollection(Of PdfAction)
    Implements IList, ICollection, IList(Of PdfAction), ICollection(Of PdfAction), IReadOnlyList(Of PdfAction), IReadOnlyCollection(Of PdfAction), IEnumerable(Of PdfAction), IEnumerable
Inheritance:
System.Object
PdfActionCollection
Derived
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

Methods

AddGoToPageView(PdfDestination)

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

public PdfGoToPageViewAction AddGoToPageView(PdfDestination destination)
Public Function AddGoToPageView(destination As PdfDestination) As PdfGoToPageViewAction
Parameters
destination
PdfDestination

The explicit destination that shall be displayed when the action is executed.

Returns
PdfGoToPageViewAction

A new PdfGoToPageViewAction with the explicit destination added to the PdfActionCollection.

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

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

parameters represent the following values depending on the viewType parameter:

public PdfGoToPageViewAction AddGoToPageView(PdfPage page, PdfDestinationViewType viewType, params double? [] parameters)
Public Function AddGoToPageView(page As PdfPage, viewType As PdfDestinationViewType, ParamArray parameters As Double?()) As PdfGoToPageViewAction
Parameters
page
PdfPage

The page that shall be displayed when this action is executed.

viewType
PdfDestinationViewType

Type of the view.

parameters
System.Nullable<System.Double>[]

The parameters of the view.

Returns
PdfGoToPageViewAction

A new PdfGoToPageViewAction with the explicit destination added to the PdfActionCollection.

AddGoToPageView(String)

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

public PdfGoToPageViewAction AddGoToPageView(string destinationName)
Public Function AddGoToPageView(destinationName As String) As PdfGoToPageViewAction
Parameters
destinationName
System.String

The named destination that shall be displayed when the action is executed.

Returns
PdfGoToPageViewAction

A new PdfGoToPageViewAction with the named destination added to the PdfActionCollection.

AddImportFormData(String)

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

public PdfImportFormDataAction AddImportFormData(string filePath)
Public Function AddImportFormData(filePath As String) As PdfImportFormDataAction
Parameters
filePath
System.String

The path of a file from which to import the data.

Returns
PdfImportFormDataAction

A new PdfImportFormDataAction with the import data file path added to the PdfActionCollection.

AddOpenFile(String)

Adds a new PdfOpenFileAction to the PdfActionCollection.

public PdfOpenFileAction AddOpenFile(string filePath)
Public Function AddOpenFile(filePath As String) As PdfOpenFileAction
Parameters
filePath
System.String

The application that shall be launched or the document that shall be opened or printed.

Returns
PdfOpenFileAction
Exceptions
System.ArgumentException

filePath is null or System.String.Empty.

AddOpenWebLink(String)

Adds a new PdfOpenWebLinkAction to the PdfActionCollection.

public PdfOpenWebLinkAction AddOpenWebLink(string url)
Public Function AddOpenWebLink(url As String) As PdfOpenWebLinkAction
Parameters
url
System.String

The uniform resource identifier to resolve, encoded in 7-bit ASCII.

Returns
PdfOpenWebLinkAction
Exceptions
System.ArgumentException

url is null or System.String.Empty.

AddResetForm()

Adds a new PdfResetFormAction to the PdfActionCollection.

public PdfResetFormAction AddResetForm()
Public Function AddResetForm As PdfResetFormAction
Returns
PdfResetFormAction

AddRunJavaScript(String)

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

public PdfRunJavaScriptAction AddRunJavaScript(string javaScript)
Public Function AddRunJavaScript(javaScript As String) As PdfRunJavaScriptAction
Parameters
javaScript
System.String

The JavaScript script to be executed.

Returns
PdfRunJavaScriptAction

A new PdfRunJavaScriptAction with the JavaScript script to be executed added to the PdfActionCollection.

Exceptions
System.ArgumentException

javaScript is null or System.String.Empty.

AddSubmitForm(String)

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

public PdfSubmitFormAction AddSubmitForm(string url)
Public Function AddSubmitForm(url As String) As PdfSubmitFormAction
Parameters
url
System.String

The uniform resource locator (URL) of the script at the Web server that will process the submission.

Returns
PdfSubmitFormAction

A new PdfSubmitFormAction with the Web server script's URL added to the PdfActionCollection.

GetEnumerator()

Returns an enumerator that iterates through the PdfActionCollection.

public PdfActionCollection.Enumerator GetEnumerator()
Public Function GetEnumerator As PdfActionCollection.Enumerator
Returns
PdfActionCollection.Enumerator

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

Clear()

Removes all elements from the PdfCollection.

(Inherited from PdfCollection)

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

See Also