New to Telerik Document Processing? Start a free 30-day trial

Yield

Class

Implements the YIELD financial function, which calculates the annual yield for a security with periodic interest payments.

Definition

Namespace:Telerik.Documents.Spreadsheet.Expressions.Functions

Assembly:Telerik.Windows.Documents.Spreadsheet.dll

Syntax:

public class Yield : NumbersInFunction

Inheritance: objectFunctionBaseFunctionWithArgumentsFunctionWithSameTypeArguments<double>NumbersInFunctionYield...

Inherited Members FunctionWithSameTypeArguments<double>.EvaluateOverride(FunctionEvaluationContext<object>)FunctionWithArguments.EvaluateOverride(FunctionEvaluationContext<RadExpression>)FunctionWithArguments.EvaluateLiftedElement(FunctionEvaluationContext<RadExpression>, RadExpression[], int, int)FunctionBase.IsSpillingArgument(int, RadExpression)FunctionBase.Evaluate(FunctionEvaluationContext<RadExpression>)FunctionBase.IsArgumentNumberValid(int)FunctionBase.LiftsOverArrays...

Constructors

Yield()

Initializes a new YIELD function instance for calculating annual yield on securities with periodic coupon payments.

public Yield()

Fields

FunctionName

string

The name of the function.

public static readonly string FunctionName

Properties

ArgumentConversionRules

Specifies the conversion rules applied to function arguments, excluding boolean-to-number conversions for financial calculations.

public override ArgumentConversionRules ArgumentConversionRules { get; }

Property Value:

The argument conversion rules as ArgumentConversionRules.

Overrides: NumbersInFunction.ArgumentConversionRules

FunctionInfo

Provides metadata describing the function's category, arguments, and help documentation.

public override FunctionInfo FunctionInfo { get; }

Property Value:

The function info as FunctionInfo.

Overrides: FunctionBase.FunctionInfo

Name

string

Returns the function name "YIELD" used in formulas.

public override string Name { get; }

Property Value:

The name as String.

Overrides: FunctionBase.Name

Evaluates the YIELD function using the provided settlement date, maturity, coupon rate, price, redemption value, frequency, and optional basis, returning the annual yield as a numeric expression or an error.

protected override RadExpression EvaluateOverride(FunctionEvaluationContext<double> context)

Parameters:contextFunctionEvaluationContext<double>

The context.

Returns:

RadExpression

Functions result as RadExpression.

Overrides: FunctionWithSameTypeArguments<double>.EvaluateOverride(FunctionEvaluationContext<double>)