Back to Devexpress

WorkbookFunctions.OverrideFunction(String, ICustomFunction, Boolean) Method

officefileapi-devexpress-dot-spreadsheet-dot-functions-dot-workbookfunctions-dot-overridefunction-x28-system-dot-string-devexpress-dot-spreadsheet-dot-functions-dot-icustomfunction-system-dot-boolean-x29.md

latest2.3 KB
Original Source

WorkbookFunctions.OverrideFunction(String, ICustomFunction, Boolean) Method

Replaces the built-in function specified by its name with a custom function.

Namespace : DevExpress.Spreadsheet.Functions

Assembly : DevExpress.Spreadsheet.v25.2.Core.dll

NuGet Package : DevExpress.Spreadsheet.Core

Declaration

csharp
void OverrideFunction(
    string name,
    ICustomFunction function,
    bool skipIfExists
)
vb
Sub OverrideFunction(
    name As String,
    function As ICustomFunction,
    skipIfExists As Boolean
)

Parameters

NameTypeDescription
nameString

A name of the function to replace.

| | function | ICustomFunction |

An ICustomFunction descendant that is the custom function.

| | skipIfExists | Boolean |

true , to cancel the function replacement if the built-in function with the specified name exists; otherwise, false.

|

Remarks

Use this OverrideFunction method overload with the skipIfExists parameter set to true to add a custom implementation of the built-in function not currently supported by the Spreadsheet Suite. When the function becomes available in future versions, it won’t be replaced, so the native implementation will be used instead of a custom one.

See Also

WorkbookFunctions Interface

WorkbookFunctions Members

DevExpress.Spreadsheet.Functions Namespace