AddScriptObject(String,Object) Method

Adds an object to the report's script context.

Syntax

Visual Basic
C#

'Declaration
 
Public Overloads Sub AddScriptObject( _
   ByVal name As String, _
   ByVal value As Object _
)

public void AddScriptObject( 
   string name,
   object value
)

Parameters

name: Name of the new object (case-insensitive).
value: Value of the new object.

Remarks

This method allows you to add custom objects to the context of the C1Report script interpreter.

The script interpreter context is cleared whenever a report starts rendering, so this method should always be called from the C1Report.StartReport event handler.

Example

The code below uses the C1Report.StartReport event to add a variable called "mainForm" to the script context. It then attaches some script to the report's C1Report.OnOpen event to show the caption of the form when the report starts rendering.

private void _c1r_StartReport(object sender, System.EventArgs e)
{
    _c1r.AddScriptObject("mainForm", this);
}
private void button1_Click(object sender, System.EventArgs e)
{
    _c1r.OnOpen = "msgbox(mainForm.Text)";
    _c1r.Render();
}

Requirements

Target Platforms: 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

Reference

C1Report Class
C1Report Members
Overload List