Class AddInFunctionsCollection
Represents a collection of AddInFunctions.
Inheritance
AddInFunctionsCollection
Implements
Inherited Members
Namespace: Syncfusion.XlsIO.Implementation.Collections
Assembly: Syncfusion.XlsIO.NET.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. |
| 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 |
|---|
| int |
Properties
this[int]
Gets Add-in function from the collection based on index.
Declaration
public IAddInFunction this[int index] { get; }
Parameters
| Type | Name | Description |
|---|---|---|
| int | index |
Property Value
| Type |
|---|
| IAddInFunction |
Methods
Add(int, int)
Adds new local function to the collection.
Declaration
public void Add(int iExternBookIndex, int iNameIndex)
Parameters
| Type | Name | Description |
|---|---|---|
| int | iExternBookIndex | External book index. |
| int | iNameIndex | Name index. |
Add(string)
Adds new local function to the collection.
Declaration
public int Add(string strFunctionName)
Parameters
| Type | Name | Description |
|---|---|---|
| string | strFunctionName | Function to add. |
Returns
| Type | Description |
|---|---|
| int | Index of the added function. |
Contains(string)
Indicates whether collection contains workbook with specified name.
Declaration
public bool Contains(string strBookName)
Parameters
| Type | Name | Description |
|---|---|---|
| string | strBookName | Name to check. |
Returns
| Type | Description |
|---|---|
| bool | 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(int)
Removes add-in collection with specified index.
Declaration
public void RemoveAt(int index)
Parameters
| Type | Name | Description |
|---|---|---|
| int | index | Item to remove. |