# GrapeCity.ActiveReports.SectionReportModel.Parameter

## Content

<div class="doc-site-dotnet-api-container">



  <h1 id="GrapeCity_ActiveReports_SectionReportModel_Parameter" data-uid="GrapeCity.ActiveReports.SectionReportModel.Parameter" class="text-break">Parameter Class
</h1>
  <div class="markdown level0 summary"><p>A Parameter is used to substitute values for parameter placeholders in the report's data source SQL query text.</p>
</div>
  <div class="markdown level0 conceptual"></div>
  <div class="inheritance">
    <h5>Inheritance</h5>
    <div class="level0"><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></div>
    <div class="level1"><span class="xref">Parameter</span></div>
  </div>
  <div class="implements">
    <h5>Implements</h5>
    <div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.componentmodel.icomponent">IComponent</a></div>
    <div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.idisposable">IDisposable</a></div>
    <div><a class="xref" href="GrapeCity.ActiveReports.Controls.Design.IPersistControl.html">IPersistControl</a></div>
  </div>
  <h6><strong>Namespace</strong>: <a class="xref" href="GrapeCity.ActiveReports.SectionReportModel.html">GrapeCity.ActiveReports.SectionReportModel</a></h6>
  <h6><strong>Assembly</strong>: MESCIUS.ActiveReports.dll</h6>
  <h5 id="GrapeCity_ActiveReports_SectionReportModel_Parameter_syntax">Syntax</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">[TypeConverter(typeof(ParameterTypeConverter))]
public class Parameter : IComponent, IDisposable, IPersistControl</code></pre>
  </div>
  <h3 id="constructors">Constructors
</h3>
  <table class="table table-bordered table-condensed">
    <thead>
      <tr>
        <th>Name</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td id="GrapeCity_ActiveReports_SectionReportModel_Parameter__ctor" data-uid="GrapeCity.ActiveReports.SectionReportModel.Parameter.#ctor">
          <a class="xref" href="GrapeCity.ActiveReports.SectionReportModel.Parameter.-ctor.html#GrapeCity_ActiveReports_SectionReportModel_Parameter__ctor">Parameter()</a>
        </td>
        <td class="markdown level1 summary"><p>Initializes a new instance of the <a class="xref" href="GrapeCity.ActiveReports.SectionReportModel.Parameter.html">Parameter</a> class.</p>
</td>
      </tr>
    </tbody>
  </table>
  <h3 id="properties">Properties
</h3>
  <table class="table table-bordered table-condensed">
    <thead>
      <tr>
        <th>Name</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td id="GrapeCity_ActiveReports_SectionReportModel_Parameter_DefaultValue" data-uid="GrapeCity.ActiveReports.SectionReportModel.Parameter.DefaultValue">
          <a class="xref" href="GrapeCity.ActiveReports.SectionReportModel.Parameter.DefaultValue.html#GrapeCity_ActiveReports_SectionReportModel_Parameter_DefaultValue">DefaultValue</a>
        </td>
        <td class="markdown level1 summary"><p>Gets or sets a value to be used as the default value in the parameters input dialog.</p>
</td>
      </tr>
      <tr>
        <td id="GrapeCity_ActiveReports_SectionReportModel_Parameter_DisplayFormat" data-uid="GrapeCity.ActiveReports.SectionReportModel.Parameter.DisplayFormat">
          <a class="xref" href="GrapeCity.ActiveReports.SectionReportModel.Parameter.DisplayFormat.html#GrapeCity_ActiveReports_SectionReportModel_Parameter_DisplayFormat">DisplayFormat</a>
        </td>
        <td class="markdown level1 summary"><p>Parameter display format.</p>
</td>
      </tr>
      <tr>
        <td id="GrapeCity_ActiveReports_SectionReportModel_Parameter_Key" data-uid="GrapeCity.ActiveReports.SectionReportModel.Parameter.Key">
          <a class="xref" href="GrapeCity.ActiveReports.SectionReportModel.Parameter.Key.html#GrapeCity_ActiveReports_SectionReportModel_Parameter_Key">Key</a>
        </td>
        <td class="markdown level1 summary"><p>Gets or sets the unique name of the parameter.</p>
</td>
      </tr>
      <tr>
        <td id="GrapeCity_ActiveReports_SectionReportModel_Parameter_Prompt" data-uid="GrapeCity.ActiveReports.SectionReportModel.Parameter.Prompt">
          <a class="xref" href="GrapeCity.ActiveReports.SectionReportModel.Parameter.Prompt.html#GrapeCity_ActiveReports_SectionReportModel_Parameter_Prompt">Prompt</a>
        </td>
        <td class="markdown level1 summary"><p>Parameter caption used in the parameters input dialog to prompt the user to input a parameter value.</p>
</td>
      </tr>
      <tr>
        <td id="GrapeCity_ActiveReports_SectionReportModel_Parameter_PromptUser" data-uid="GrapeCity.ActiveReports.SectionReportModel.Parameter.PromptUser">
          <a class="xref" href="GrapeCity.ActiveReports.SectionReportModel.Parameter.PromptUser.html#GrapeCity_ActiveReports_SectionReportModel_Parameter_PromptUser">PromptUser</a>
        </td>
        <td class="markdown level1 summary"><p>Determines whether to prompt the user to input a parameter value.</p>
</td>
      </tr>
      <tr>
        <td id="GrapeCity_ActiveReports_SectionReportModel_Parameter_QueryCreated" data-uid="GrapeCity.ActiveReports.SectionReportModel.Parameter.QueryCreated">
          <a class="xref" href="GrapeCity.ActiveReports.SectionReportModel.Parameter.QueryCreated.html#GrapeCity_ActiveReports_SectionReportModel_Parameter_QueryCreated">QueryCreated</a>
        </td>
        <td class="markdown level1 summary"><p>Determines whether the query is created from the data source query string or user created.</p>
</td>
      </tr>
      <tr>
        <td id="GrapeCity_ActiveReports_SectionReportModel_Parameter_Tag" data-uid="GrapeCity.ActiveReports.SectionReportModel.Parameter.Tag">
          <a class="xref" href="GrapeCity.ActiveReports.SectionReportModel.Parameter.Tag.html#GrapeCity_ActiveReports_SectionReportModel_Parameter_Tag">Tag</a>
        </td>
        <td class="markdown level1 summary"><p>User-defined value.</p>
</td>
      </tr>
      <tr>
        <td id="GrapeCity_ActiveReports_SectionReportModel_Parameter_Type" data-uid="GrapeCity.ActiveReports.SectionReportModel.Parameter.Type">
          <a class="xref" href="GrapeCity.ActiveReports.SectionReportModel.Parameter.Type.html#GrapeCity_ActiveReports_SectionReportModel_Parameter_Type">Type</a>
        </td>
        <td class="markdown level1 summary"><p>Gets or sets a value that determines the type of input control to be created to collect the parameter value from the user.</p>
</td>
      </tr>
      <tr>
        <td id="GrapeCity_ActiveReports_SectionReportModel_Parameter_Value" data-uid="GrapeCity.ActiveReports.SectionReportModel.Parameter.Value">
          <a class="xref" href="GrapeCity.ActiveReports.SectionReportModel.Parameter.Value.html#GrapeCity_ActiveReports_SectionReportModel_Parameter_Value">Value</a>
        </td>
        <td class="markdown level1 summary"><p>Gets or sets the value of the parameter to be used in parameter placeholder substitution.</p>
</td>
      </tr>
    </tbody>
  </table>
  <h3 id="methods">Methods
</h3>
  <table class="table table-bordered table-condensed">
    <thead>
      <tr>
        <th>Name</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td id="GrapeCity_ActiveReports_SectionReportModel_Parameter_Clone" data-uid="GrapeCity.ActiveReports.SectionReportModel.Parameter.Clone">
          <a class="xref" href="GrapeCity.ActiveReports.SectionReportModel.Parameter.Clone.html#GrapeCity_ActiveReports_SectionReportModel_Parameter_Clone">Clone()</a>
        </td>
        <td class="markdown level1 summary"><p>Clones this instance.</p>
</td>
      </tr>
      <tr>
        <td id="GrapeCity_ActiveReports_SectionReportModel_Parameter_Dispose" data-uid="GrapeCity.ActiveReports.SectionReportModel.Parameter.Dispose">
          <a class="xref" href="GrapeCity.ActiveReports.SectionReportModel.Parameter.Dispose.html#GrapeCity_ActiveReports_SectionReportModel_Parameter_Dispose">Dispose()</a>
        </td>
        <td class="markdown level1 summary"><p>Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.</p>
</td>
      </tr>
      <tr>
        <td id="GrapeCity_ActiveReports_SectionReportModel_Parameter_Dispose_System_Boolean_" data-uid="GrapeCity.ActiveReports.SectionReportModel.Parameter.Dispose(System.Boolean)">
          <a class="xref" href="GrapeCity.ActiveReports.SectionReportModel.Parameter.Dispose.html#GrapeCity_ActiveReports_SectionReportModel_Parameter_Dispose_System_Boolean_">Dispose(bool)</a>
        </td>
        <td class="markdown level1 summary"><p>Releases unmanaged and - optionally - managed resources.</p>
</td>
      </tr>
      <tr>
        <td id="GrapeCity_ActiveReports_SectionReportModel_Parameter_ReadXml_System_Xml_XmlNode_" data-uid="GrapeCity.ActiveReports.SectionReportModel.Parameter.ReadXml(System.Xml.XmlNode)">
          <a class="xref" href="GrapeCity.ActiveReports.SectionReportModel.Parameter.ReadXml.html#GrapeCity_ActiveReports_SectionReportModel_Parameter_ReadXml_System_Xml_XmlNode_">ReadXml(XmlNode)</a>
        </td>
        <td class="markdown level1 summary"><p>Reads the XML.</p>
</td>
      </tr>
      <tr>
        <td id="GrapeCity_ActiveReports_SectionReportModel_Parameter_ToString" data-uid="GrapeCity.ActiveReports.SectionReportModel.Parameter.ToString">
          <a class="xref" href="GrapeCity.ActiveReports.SectionReportModel.Parameter.ToString.html#GrapeCity_ActiveReports_SectionReportModel_Parameter_ToString">ToString()</a>
        </td>
        <td class="markdown level1 summary"><p>Returns a <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a> that represents this instance.</p>
</td>
      </tr>
      <tr>
        <td id="GrapeCity_ActiveReports_SectionReportModel_Parameter_WriteXml_System_Xml_XmlElement_" data-uid="GrapeCity.ActiveReports.SectionReportModel.Parameter.WriteXml(System.Xml.XmlElement)">
          <a class="xref" href="GrapeCity.ActiveReports.SectionReportModel.Parameter.WriteXml.html#GrapeCity_ActiveReports_SectionReportModel_Parameter_WriteXml_System_Xml_XmlElement_">WriteXml(XmlElement)</a>
        </td>
        <td class="markdown level1 summary"><p>Writes the XML.</p>
</td>
      </tr>
    </tbody>
  </table>
  <h3 id="events">Events
</h3>
  <table class="table table-bordered table-condensed">
    <thead>
      <tr>
        <th>Name</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td id="GrapeCity_ActiveReports_SectionReportModel_Parameter_Disposed" data-uid="GrapeCity.ActiveReports.SectionReportModel.Parameter.Disposed">
          <a class="xref" href="GrapeCity.ActiveReports.SectionReportModel.Parameter.Disposed.html">Disposed</a>
        </td>
        <td class="markdown level1 summary"><p>Represents the method that handles the <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.componentmodel.icomponent.disposed">Disposed</a> event of a component.</p>
</td>
      </tr>
    </tbody>
  </table>
  <h3 id="extensionmethods">Extension Methods</h3>
  <div>
      <a class="xref" href="GrapeCity.ActiveReports.ReportsCore.Tools.ObjectExtensions.ApplyDefaults.html#GrapeCity_ActiveReports_ReportsCore_Tools_ObjectExtensions_ApplyDefaults__1___0_">ObjectExtensions.ApplyDefaults&lt;TObject&gt;(TObject)</a>
  </div>
  <div>
      <a class="xref" href="GrapeCity.ActiveReports.ReportsCore.Tools.ObjectExtensions.SetValue.html#GrapeCity_ActiveReports_ReportsCore_Tools_ObjectExtensions_SetValue__1___0_System_ComponentModel_PropertyDescriptor_System_String_">ObjectExtensions.SetValue&lt;TObject&gt;(TObject, PropertyDescriptor, string)</a>
  </div>
  <div>
      <a class="xref" href="GrapeCity.ActiveReports.ReportsCore.Tools.ObjectExtensions.ToNameValueCollection.html#GrapeCity_ActiveReports_ReportsCore_Tools_ObjectExtensions_ToNameValueCollection_System_Object_">ObjectExtensions.ToNameValueCollection(object)</a>
  </div>

</div>