Utilisation de la fonction ICustomFunction
Cet article offre une compréhension détaillée de l’utilisation de la fonction ICustomFunction pour implémenter des fonctions personnalisées avec les API Aspose.Cells.
L’interface ICustomFunction permet d’ajouter des fonctions de calcul de formule personnalisées pour étendre le moteur de calcul central d’Aspose.Cells afin de répondre à certaines exigences. Cette fonctionnalité est utile pour définir des fonctions personnalisées (définies par l’utilisateur) dans un fichier modèle ou dans un code où la fonction personnalisée peut être mise en œuvre et évaluée à l’aide des API Aspose.Cells comme toute autre fonction par défaut d’Excel.
Veuillez noter que cette interface a été remplacée par AbstractCalculationEngine et sera supprimée à l’avenir. Quelques articles/exemples techniques sur la nouvelle API : ici et ici
Création et évaluation d’une fonction définie par l’utilisateur
Cet article présente la mise en œuvre de l’interface ICustomFunction pour écrire une fonction personnalisée et l’utiliser dans la feuille de calcul pour obtenir les résultats. Nous définirons une fonction personnalisée nommée MyFunc qui acceptera 2 paramètres avec les détails suivants.
- Le 1er paramètre fait référence à une seule cellule
- Le 2ème paramètre fait référence à une plage de cellules
La fonction personnalisée ajoutera toutes les valeurs de la plage de cellules spécifiée en tant que 2ème paramètre et divisera le résultat par la valeur du 1er paramètre.
Voici comment nous avons implémenté la méthode calculateCustomFunction.
Java
public class CustomFunction implements ICustomFunction
{
@Override
public Object calculateCustomFunction(String functionName, java.util.ArrayList paramsList, java.util.ArrayList contextObjects)
{
double result = 0f;
double sum = 0;
//Get the value of 1st parameter
Object firstParamB1 = paramsList.get(0);
if (firstParamB1 instanceof ReferredArea)
{
ReferredArea ra = (ReferredArea)firstParamB1;
firstParamB1 = ra.getValue(0, 0);
}
//Get values of 2nd parameter
Object secondParamC1C5 = paramsList.get(1);
if (secondParamC1C5 instanceof ReferredArea)
{
ReferredArea ra = (ReferredArea)secondParamC1C5;
for (int i = ra.getStartRow(); i <= ra.getEndRow(); i++)
{
//Add all values
sum += (double)ra.getValue(i, 0);
}
}
result = sum / (double)firstParamB1;
// Return result of the function
return result;
}
}
Voici comment utiliser la nouvelle fonction définie dans une feuille de calcul
Java
//Open the workbook
Workbook workbook = new Workbook();
//Obtaining the reference of the first worksheet
Worksheet worksheet = workbook.getWorksheets().get(0);
//Adding a sample value to "A1" cell
worksheet.getCells().get("B1").putValue(5);
//Adding a sample value to "A2" cell
worksheet.getCells().get("C1").putValue(100);
//Adding a sample value to "A3" cell
worksheet.getCells().get("C2").putValue(150);
//Adding a sample value to "B1" cell
worksheet.getCells().get("C3").putValue(60);
//Adding a sample value to "B2" cell
worksheet.getCells().get("C4").putValue(32);
//Adding a sample value to "B2" cell
worksheet.getCells().get("C5").putValue(62);
//Adding custom formula to Cell A1
worksheet.getCells().get("A1").setFormula("=MyFunc(B1,C1:C5)");
//Calcualating Formulas
workbook.calculateFormula(false, new CustomFunction());
//Assign resultant value to Cell A1
worksheet.getCells().get("A1").putValue(worksheet.getCells().get("A1").getValue());
//Save the file
workbook.save(dir + "UsingICustomFunction.xls");
Vue d’ensemble
Les API Aspose.Cells placent simplement l’objet ReferredArea dans la liste “paramsList” lorsque le paramètre correspondant est une référence ou son résultat calculé est une référence. Si vous avez besoin de la référence elle-même, vous pouvez utiliser directement ReferredArea. Si vous avez besoin de la valeur d’une seule cellule de la référence correspondant à la position de la formule, vous pouvez utiliser la méthode ReferredArea.getValue(rowOffset, int colOffset). Si vous avez besoin d’un tableau de valeurs de cellules pour toute la zone, vous pouvez utiliser la méthode ReferredArea.getValues.
Comme les API Aspose.Cells fournissent ReferredArea dans “paramsList”, la collection ReferredArea dans “contextObjects” ne sera plus nécessaire (dans les anciennes versions, elle n’était pas toujours capable de donner une correspondance un à un avec les paramètres de la fonction personnalisée) et a donc été supprimée des “contextObjects”.
public Object calculateCustomFunction(String functionName, ArrayList paramsList, ArrayList contextObjects)
{
...
Object o = paramsList.get(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...
...
}