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

YieldMat

Class

Implements the YIELDMAT financial function, which calculates the annual yield for a security that pays interest at maturity.

Definition

Namespace:Telerik.Windows.Documents.Spreadsheet.Expressions.Functions

Assembly:Telerik.Windows.Documents.Spreadsheet.dll

Syntax:

public class YieldMat : NumbersInFunction

Inheritance: objectFunctionBaseFunctionWithArgumentsFunctionWithSameTypeArguments<double>NumbersInFunctionYieldMat...

Inherited Members FunctionWithSameTypeArguments<double>.EvaluateOverride(FunctionEvaluationContext<object>)FunctionWithArguments.EvaluateOverride(FunctionEvaluationContext<RadExpression>)FunctionBase.Evaluate(FunctionEvaluationContext<RadExpression>)FunctionBase.IsArgumentNumberValid(int)

Constructors

YieldMat()

Initializes a new YIELDMAT function instance for calculating annual yield on securities that pay all interest at maturity.

public YieldMat()

Fields

FunctionName

string

The name of the function.

public static readonly string FunctionName

Methods

EvaluateOverride(FunctionEvaluationContext<double>)

RadExpression

Evaluates the YIELDMAT function using the provided settlement date, maturity, issue date, interest rate, price, 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>)

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 "YIELDMAT" used in formulas.

public override string Name { get; }

Property Value:

The name as String.

Overrides: FunctionBase.Name