Class AddInFunctionsCollection

Represents a collection of AddInFunctions.

Inheritance
System.Object
CollectionBase<AddInFunctionImpl>
CollectionBaseEx<AddInFunctionImpl>
AddInFunctionsCollection
Implements
System.Collections.Generic.IList<AddInFunctionImpl>
System.Collections.Generic.ICollection<AddInFunctionImpl>
System.Collections.Generic.IEnumerable<AddInFunctionImpl>
System.Collections.IEnumerable
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Syncfusion.XlsIO.Implementation.Collections
Assembly: Syncfusion.XlsIO.Base.dll
Syntax
public class AddInFunctionsCollection : CollectionBaseEx<AddInFunctionImpl>, IList<AddInFunctionImpl>, ICollection<AddInFunctionImpl>, IEnumerable<AddInFunctionImpl>, IEnumerable, ICloneParent, IAddInFunctions, IParentApplication

Constructors

AddInFunctionsCollection(IApplication, Object)

Creates a collection and sets its Application and Parent properties.

Declaration
public AddInFunctionsCollection(IApplication application, object parent)
Parameters
Type Name Description
IApplication application

Application object for the collection.
System.Object parent

Parent object for the collection.

Fields

DEF_LOCAL_BOOK_INDEX

Local workbook index.

Declaration
public const int DEF_LOCAL_BOOK_INDEX = -1
Field Value
Type Description
System.Int32

Properties

Item[Int32]

Gets Add-in function from the collection based on index.

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

Methods

Add(Int32, Int32)

Adds new local function to the collection.

Declaration
public void Add(int iExternBookIndex, int iNameIndex)
Parameters
Type Name Description
System.Int32 iExternBookIndex

External book index.
System.Int32 iNameIndex

Name index.

Add(String)

Adds new local function to the collection.

Declaration
public int Add(string strFunctionName)
Parameters
Type Name Description
System.String strFunctionName

Function to add.
Returns
Type Description
System.Int32

Index of the added function.

Add(String, String)

Adds new add-in function to the collection.

Declaration
public int Add(string fileName, string functionName)
Parameters
Type Name Description
System.String fileName

File with add-in function.
System.String functionName

Function name.
Returns
Type Description
System.Int32

Index of the new function.

Contains(String)

Indicates whether collection contains workbook with specified name.

Declaration
public bool Contains(string strBookName)
Parameters
Type Name Description
System.String strBookName

Name to check.
Returns
Type Description
System.Boolean

True if collections contains book with specified name.

CopyFrom(AddInFunctionsCollection)

Represents a copying of add-in functions.

Declaration
public void CopyFrom(AddInFunctionsCollection addinFunctions)
Parameters
Type Name Description
AddInFunctionsCollection addinFunctions

Add-in function to be copied.

RemoveAt(Int32)

Removes add-in collection with specified index.

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

Item to remove.

Implements

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