ActiveReports 8
Key Property
See Also  Example
GrapeCity.ActiveReports.v8 Assembly > GrapeCity.ActiveReports.SectionReportModel Namespace > Parameter Class : Key Property

Glossary Item Box

Unique name of the parameter.

Syntax

Visual Basic (Declaration) 
Public Property Key As System.String
C# 
public System.string Key {get; set;}

Property Value

A string value that represents the unique name of the parameter.

Remarks

Used to reference the parameter in the parameters collection and to locate the different placeholder locations in the SQL query where the parameter value will be inserted.

Example

C#Copy Code
private void SectionReport1_ReportStart(object sender, System.EventArgs eArgs)
{
    this.Parameters[0].DefaultValue = "Germany";
    this.Parameters[0].Key = "country";
    this.Parameters[0].Prompt = "Country: ";
    this.Parameters[0].Tag = "some extra data";
    this.Parameters[0].Type = GrapeCity.ActiveReports.SectionReportModel.Parameter.DataType.String;
}
Visual BasicCopy Code
Private Sub SectionReport1_ReportStart(ByVal sender As Object, ByVal e As System.EventArgs) Handles MyBase.ReportStart
    Me.Parameters(0).DefaultValue = "Germany"
    Me.Parameters(0).Key = "country"
    Me.Parameters(0).Prompt = "Country: "
    Me.Parameters(0).Tag = "Some extra data"
    Me.Parameters(0).Type = GrapeCity.ActiveReports.SectionReportModel.Parameter.DataType.String
End Sub

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

See Also