Add(String,String) Method

Adds a new NamedReference with the specified Key and specified Formula.

Syntax

Visual Basic

'Declaration
 
Public Overloads Function Add( _
   ByVal namedReferenceKey As String, _
   ByVal formula As String _
) As NamedReference

C#

public NamedReference Add( 
   string namedReferenceKey,
   string formula
)

Parameters

namedReferenceKey

Key of the new NamedReference.

formula

The Formula (or constant) to be referenced by this name.

Return Value

Returns the new NamedReference.

Remarks

This method creates a new new NamedReference with the specified Key and specified Formula. The new NamedReference is then added to the NamedReferencesCollection and returned.

Example

Demonstrates setting up references for 2 TextBoxes which wil represent the height and width of a rectangle. The area of the rectangle is then calculated in a NamedReference. When the calculations are completed, the area is displayed in a third textbox.

For an overview of how to handle events in Visual Basic or Visual C#, see Event Handlers in Visual Basic and Visual C#. For specific information and code examples illustrating how to consume events in your application, see Consuming Events in the .NET Framework Developer's Guide.

Visual Basic

Imports Infragistics.CalcEngine
Imports Infragistics.Win.UltraWinCalcManager

Private Sub Form1_Load(ByVal sender As System.Object, ByVal e As System.EventArgs) Handles MyBase.Load

        'Suspend calculation while we are adding new items into the calc network
        Me.UltraCalcManager1.SuspendCalc()

        Dim calcSettings As CalcSettings

        'Set CalcSettings properties on TextBox1
        calcSettings = Me.UltraCalcManager1.GetCalcSettings(Me.textBox1)
        calcSettings.PropertyName = "Text"
        calcSettings.Alias = "Height"
        calcSettings.ErrorValue = 1

        'Set CalcSettings properties on TextBox2
        calcSettings = Me.UltraCalcManager1.GetCalcSettings(Me.textBox2)
        calcSettings.PropertyName = "Text"
        calcSettings.Alias = "Width"
        calcSettings.ErrorValue = 1

        'Create a NamedReference to calulate the area. 
        Dim namedReference As NamedReference
        namedReference = Me.UltraCalcManager1.NamedReferences.Add("Area", "[//Height] * [//Width]")
        namedReference.ErrorValue = "Error"

        'Everything is added, so resume
        Me.UltraCalcManager1.ResumeCalc()

    End Sub

    Private Sub UltraCalcManager1_CalculationsCompleted(ByVal sender As Object, ByVal e As System.EventArgs) Handles UltraCalcManager1.CalculationsCompleted
        If (Me.UltraCalcManager1.NamedReferences.Exists("Area")) Then
            Me.textBox3.Text = Me.UltraCalcManager1.NamedReferences("Area").FormulaResult.Value.ToString()
        End If
    End Sub

C#

using Infragistics.CalcEngine;
using Infragistics.Win.UltraWinCalcManager;


	private void Form1_Load(object sender, System.EventArgs e)
		{
			//Suspend calculation while we are adding new items into the calc network
			this.ultraCalcManager1.SuspendCalc();

			CalcSettings calcSettings = null;

			//Set CalcSettings properties on TextBox1
			calcSettings = this.ultraCalcManager1.GetCalcSettings(this.textBox1);       
			calcSettings.PropertyName = "Text";
			calcSettings.Alias = "Height";
			calcSettings.ErrorValue = 1;
			
			//Set CalcSettings properties on TextBox2
			calcSettings = this.ultraCalcManager1.GetCalcSettings(this.textBox2);       
			calcSettings.PropertyName = "Text";
			calcSettings.Alias = "Width";
			calcSettings.ErrorValue = 1;
			
			//Create a NamedReference to calulate the area. 
			NamedReference namedReference = null;
			namedReference = this.ultraCalcManager1.NamedReferences.Add("Area", "[//Height] * [//Width]");
			namedReference.ErrorValue = "Error";

			//Everything is added, so resume
			this.ultraCalcManager1.ResumeCalc();
		}

		private void ultraCalcManager1_CalculationsCompleted(object sender, System.EventArgs e)
		{
			if ( this.ultraCalcManager1.NamedReferences.Exists("Area") )
			{
				this.textBox3.Text = this.ultraCalcManager1.NamedReferences["Area"].FormulaResult.Value.ToString();
			}
		}

Requirements

Target Platforms: Windows 10, Windows 8.1, Windows 8, Windows 7, Windows Server 2012, Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2