Använda funktionen ICustomFunction

Den här artikeln ger en detaljerad förståelse för hur man använder ICustomFunction-funktionen för att implementera anpassade funktioner med Aspose.Cells API:er.

ICustomFunction-gränssnittet tillåter att lägga till anpassade formelberäkningsfunktioner för att utöka Aspose.Cells kärnberäkningsmotor för att uppfylla vissa krav. Denna funktion är användbar för att definiera anpassade (användardefinierade) funktioner i en mallfil eller i kod där den anpassade funktionen kan implementeras och utvärderas med Aspose.Cells API:er som vilken annan standardfunktion som helst i Microsoft Excel.

Observera att detta gränssnitt har ersatts av AbstractCalculationEngine och kommer att tas bort i framtiden. Några tekniska artiklar/exempel om den nya API:en: här och här

Skapa och utvärdera en användardefinierad funktion

Den här artikeln demonstrerar implementeringen av ICustomFunction-gränssnittet för att skriva en anpassad funktion och använda den i kalkylarket för att få resultaten. Vi kommer att definiera en anpassad funktion vid namn MyFunc som kommer att acceptera 2 parametrar med följande detaljer.

• Första parametern hänvisar till en enda cell
• Andra parametern hänvisar till en rad av celler

Den anpassade funktionen kommer att lägga till alla värden från cellområdet som anges som 2: a parameter och dela resultatet med värdet i den första parametern.

Här är hur vi har implementerat metoden CalculateCustomFunction.

// For complete examples and data files, please go to https://github.com/aspose-cells/Aspose.Cells-for-.NET
public class CustomFunction : ICustomFunction
{
    public object CalculateCustomFunction(string functionName, System.Collections.ArrayList paramsList, System.Collections.ArrayList contextObjects)
    {
        decimal total = 0M;
        try
        {
            // Get value of first parameter
            decimal firstParamB1 = System.Convert.ToDecimal(paramsList[0]);

            // Get value of second parameter
            Array secondParamC1C5 = (Array)(paramsList[1]);

            // get every item value of second parameter
            foreach (object[] value in secondParamC1C5)
            {
                total += System.Convert.ToDecimal(value[0]);
            }

            total = total / firstParamB1;
        }
        catch
        {

        }

        // Return result of the function
        return total;
    }
}

Här är hur du använder den nyligen definierade funktionen i ett kalkylblad

// For complete examples and data files, please go to https://github.com/aspose-cells/Aspose.Cells-for-.NET
// The path to the documents directory.
string dataDir = RunExamples.GetDataDir(System.Reflection.MethodBase.GetCurrentMethod().DeclaringType);

// Open the workbook
Workbook workbook = new Workbook();

// Obtaining the reference of the first worksheet
Worksheet worksheet = workbook.Worksheets[0];

// Adding sample values to cells
worksheet.Cells["B1"].PutValue(5);
worksheet.Cells["C1"].PutValue(100);
worksheet.Cells["C2"].PutValue(150);
worksheet.Cells["C3"].PutValue(60);
worksheet.Cells["C4"].PutValue(32);
worksheet.Cells["C5"].PutValue(62);

// Adding custom formula to Cell A1
workbook.Worksheets[0].Cells["A1"].Formula = "=MyFunc(B1,C1:C5)";

// Calcualting Formulas
workbook.CalculateFormula(false, new CustomFunction());

// Assign resultant value to Cell A1
workbook.Worksheets[0].Cells["A1"].PutValue(workbook.Worksheets[0].Cells["A1"].Value);

// Save the file
workbook.Save(dataDir + "UsingICustomFunction_out.xls");

Översikt

Aspose.Cells-API:erna sätter helt enkelt in ReferredArea-objektet i “paramsList” när det motsvarande parametern är en referens eller dess beräknade resultat är en referens. Om du behöver referensen själv kan du använda ReferredArea direkt. Om du behöver få värdet av en enskild cell från referensen som motsvarar formelns position kan du använda ReferredArea.GetValue(rowOffset, int colOffset) metoden. Om du behöver en array av cellvärden för hela området kan du använda ReferredArea.GetValues-metoden.

Eftersom Aspose.Cells API: er ger ReferredArea i “paramsList”, kommer ReferredAreaCollection i “contextObjects” inte längre att behövas (i äldre versioner kunde den inte ge en-ett-karts till anpassade funktioners parametrar alltid) därför har den tagits bort från “contextObjects”.

 public object CalculateCustomFunction(string functionName, ArrayList paramsList, ArrayList contextObjects)

{

    ...

    object o = paramsList[i];

    if(o is ReferredArea) //fetch data from reference

    {

        ReferredArea ra = (ReferredArea)o;

        if(ra.IsArea)

        {

            o = ra.GetValues();

        }

        else

        {

            o = ra.GetValue(0, 0);

        }

    }

    if (o is Array)

    {

        ...

    }

    else if...

    ...

}