# GrapeCity.ActiveReports.Document.Parameter

## Content

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



  <h1 id="GrapeCity_ActiveReports_Document_Parameter" data-uid="GrapeCity.ActiveReports.Document.Parameter" class="text-break">Parameter Class
</h1>
  <div class="markdown level0 summary"><p>Represents a parameter in a page report.</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>
  <h6><strong>Namespace</strong>: <a class="xref" href="GrapeCity.ActiveReports.Document.html">GrapeCity.ActiveReports.Document</a></h6>
  <h6><strong>Assembly</strong>: MESCIUS.ActiveReports.dll</h6>
  <h5 id="GrapeCity_ActiveReports_Document_Parameter_syntax">Syntax</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public sealed class Parameter</code></pre>
  </div>
  <h5 id="GrapeCity_ActiveReports_Document_Parameter_remarks"><strong>Remarks</strong></h5>
  <div class="markdown level0 remarks"><p>This class provides access to parameter properties, values, and validation state.</p>
</div>
  <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_Document_Parameter_AllowBlank" data-uid="GrapeCity.ActiveReports.Document.Parameter.AllowBlank">
          <a class="xref" href="GrapeCity.ActiveReports.Document.Parameter.AllowBlank.html#GrapeCity_ActiveReports_Document_Parameter_AllowBlank">AllowBlank</a>
        </td>
        <td class="markdown level1 summary"><p>Gets a value indicating whether an empty string is a valid value for the parameter.</p>
</td>
      </tr>
      <tr>
        <td id="GrapeCity_ActiveReports_Document_Parameter_CurrentValue" data-uid="GrapeCity.ActiveReports.Document.Parameter.CurrentValue">
          <a class="xref" href="GrapeCity.ActiveReports.Document.Parameter.CurrentValue.html#GrapeCity_ActiveReports_Document_Parameter_CurrentValue">CurrentValue</a>
        </td>
        <td class="markdown level1 summary"><p>Gets or sets the current value of the parameter.</p>
</td>
      </tr>
      <tr>
        <td id="GrapeCity_ActiveReports_Document_Parameter_DataType" data-uid="GrapeCity.ActiveReports.Document.Parameter.DataType">
          <a class="xref" href="GrapeCity.ActiveReports.Document.Parameter.DataType.html#GrapeCity_ActiveReports_Document_Parameter_DataType">DataType</a>
        </td>
        <td class="markdown level1 summary"><p>Gets the data type of the parameter.</p>
</td>
      </tr>
      <tr>
        <td id="GrapeCity_ActiveReports_Document_Parameter_DateOnly" data-uid="GrapeCity.ActiveReports.Document.Parameter.DateOnly">
          <a class="xref" href="GrapeCity.ActiveReports.Document.Parameter.DateOnly.html#GrapeCity_ActiveReports_Document_Parameter_DateOnly">DateOnly</a>
        </td>
        <td class="markdown level1 summary"><p>Gets a value indicating whether the user should be prompted only for the date (ignoring time).</p>
</td>
      </tr>
      <tr>
        <td id="GrapeCity_ActiveReports_Document_Parameter_DefaultValues" data-uid="GrapeCity.ActiveReports.Document.Parameter.DefaultValues">
          <a class="xref" href="GrapeCity.ActiveReports.Document.Parameter.DefaultValues.html#GrapeCity_ActiveReports_Document_Parameter_DefaultValues">DefaultValues</a>
        </td>
        <td class="markdown level1 summary"><p>Gets the collection of default values for this parameter.</p>
</td>
      </tr>
      <tr>
        <td id="GrapeCity_ActiveReports_Document_Parameter_DependentParameters" data-uid="GrapeCity.ActiveReports.Document.Parameter.DependentParameters">
          <a class="xref" href="GrapeCity.ActiveReports.Document.Parameter.DependentParameters.html#GrapeCity_ActiveReports_Document_Parameter_DependentParameters">DependentParameters</a>
        </td>
        <td class="markdown level1 summary"><p>Gets Parameter objects that cannot be evaluated until this Parameter is evaluated.</p>
</td>
      </tr>
      <tr>
        <td id="GrapeCity_ActiveReports_Document_Parameter_DisplayFormat" data-uid="GrapeCity.ActiveReports.Document.Parameter.DisplayFormat">
          <a class="xref" href="GrapeCity.ActiveReports.Document.Parameter.DisplayFormat.html#GrapeCity_ActiveReports_Document_Parameter_DisplayFormat">DisplayFormat</a>
        </td>
        <td class="markdown level1 summary"><p>Gets the display format string for the parameter.</p>
</td>
      </tr>
      <tr>
        <td id="GrapeCity_ActiveReports_Document_Parameter_ErrorMessage" data-uid="GrapeCity.ActiveReports.Document.Parameter.ErrorMessage">
          <a class="xref" href="GrapeCity.ActiveReports.Document.Parameter.ErrorMessage.html#GrapeCity_ActiveReports_Document_Parameter_ErrorMessage">ErrorMessage</a>
        </td>
        <td class="markdown level1 summary"><p>Gets the error message associated with this parameter, if the validation failed.</p>
</td>
      </tr>
      <tr>
        <td id="GrapeCity_ActiveReports_Document_Parameter_Hidden" data-uid="GrapeCity.ActiveReports.Document.Parameter.Hidden">
          <a class="xref" href="GrapeCity.ActiveReports.Document.Parameter.Hidden.html#GrapeCity_ActiveReports_Document_Parameter_Hidden">Hidden</a>
        </td>
        <td class="markdown level1 summary"><p>Gets a value indicating whether the parameter should be hidden from the user.</p>
</td>
      </tr>
      <tr>
        <td id="GrapeCity_ActiveReports_Document_Parameter_Label" data-uid="GrapeCity.ActiveReports.Document.Parameter.Label">
          <a class="xref" href="GrapeCity.ActiveReports.Document.Parameter.Label.html#GrapeCity_ActiveReports_Document_Parameter_Label">Label</a>
        </td>
        <td class="markdown level1 summary"><p>Gets or sets the label used to identify the parameter in the user interface.</p>
</td>
      </tr>
      <tr>
        <td id="GrapeCity_ActiveReports_Document_Parameter_MultiValue" data-uid="GrapeCity.ActiveReports.Document.Parameter.MultiValue">
          <a class="xref" href="GrapeCity.ActiveReports.Document.Parameter.MultiValue.html#GrapeCity_ActiveReports_Document_Parameter_MultiValue">MultiValue</a>
        </td>
        <td class="markdown level1 summary"><p>Gets a value indicating whether the parameter accepts multiple values.</p>
</td>
      </tr>
      <tr>
        <td id="GrapeCity_ActiveReports_Document_Parameter_Multiline" data-uid="GrapeCity.ActiveReports.Document.Parameter.Multiline">
          <a class="xref" href="GrapeCity.ActiveReports.Document.Parameter.Multiline.html#GrapeCity_ActiveReports_Document_Parameter_Multiline">Multiline</a>
        </td>
        <td class="markdown level1 summary"><p>Gets a value indicating whether the parameter value supports multiline text.</p>
</td>
      </tr>
      <tr>
        <td id="GrapeCity_ActiveReports_Document_Parameter_Name" data-uid="GrapeCity.ActiveReports.Document.Parameter.Name">
          <a class="xref" href="GrapeCity.ActiveReports.Document.Parameter.Name.html#GrapeCity_ActiveReports_Document_Parameter_Name">Name</a>
        </td>
        <td class="markdown level1 summary"><p>Gets the name of the parameter.</p>
</td>
      </tr>
      <tr>
        <td id="GrapeCity_ActiveReports_Document_Parameter_Nullable" data-uid="GrapeCity.ActiveReports.Document.Parameter.Nullable">
          <a class="xref" href="GrapeCity.ActiveReports.Document.Parameter.Nullable.html#GrapeCity_ActiveReports_Document_Parameter_Nullable">Nullable</a>
        </td>
        <td class="markdown level1 summary"><p>Gets a value indicating whether the parameter accepts null values.</p>
</td>
      </tr>
      <tr>
        <td id="GrapeCity_ActiveReports_Document_Parameter_Prompt" data-uid="GrapeCity.ActiveReports.Document.Parameter.Prompt">
          <a class="xref" href="GrapeCity.ActiveReports.Document.Parameter.Prompt.html#GrapeCity_ActiveReports_Document_Parameter_Prompt">Prompt</a>
        </td>
        <td class="markdown level1 summary"><p>Gets the prompt text displayed to the user when asking for parameter values.</p>
</td>
      </tr>
      <tr>
        <td id="GrapeCity_ActiveReports_Document_Parameter_PromptUser" data-uid="GrapeCity.ActiveReports.Document.Parameter.PromptUser">
          <a class="xref" href="GrapeCity.ActiveReports.Document.Parameter.PromptUser.html#GrapeCity_ActiveReports_Document_Parameter_PromptUser">PromptUser</a>
        </td>
        <td class="markdown level1 summary"><p>Gets a value indicating whether the user should be prompted for this parameter's value.</p>
</td>
      </tr>
      <tr>
        <td id="GrapeCity_ActiveReports_Document_Parameter_QueryParameter" data-uid="GrapeCity.ActiveReports.Document.Parameter.QueryParameter">
          <a class="xref" href="GrapeCity.ActiveReports.Document.Parameter.QueryParameter.html#GrapeCity_ActiveReports_Document_Parameter_QueryParameter">QueryParameter</a>
        </td>
        <td class="markdown level1 summary"><p>Gets a value indicating whether the parameter is used in a dataset query.</p>
</td>
      </tr>
      <tr>
        <td id="GrapeCity_ActiveReports_Document_Parameter_State" data-uid="GrapeCity.ActiveReports.Document.Parameter.State">
          <a class="xref" href="GrapeCity.ActiveReports.Document.Parameter.State.html#GrapeCity_ActiveReports_Document_Parameter_State">State</a>
        </td>
        <td class="markdown level1 summary"><p>Gets the current state of the parameter.</p>
</td>
      </tr>
      <tr>
        <td id="GrapeCity_ActiveReports_Document_Parameter_ValidValues" data-uid="GrapeCity.ActiveReports.Document.Parameter.ValidValues">
          <a class="xref" href="GrapeCity.ActiveReports.Document.Parameter.ValidValues.html#GrapeCity_ActiveReports_Document_Parameter_ValidValues">ValidValues</a>
        </td>
        <td class="markdown level1 summary"><p>Gets the collection of valid values defined for this parameter.</p>
</td>
      </tr>
      <tr>
        <td id="GrapeCity_ActiveReports_Document_Parameter_ValidationState" data-uid="GrapeCity.ActiveReports.Document.Parameter.ValidationState">
          <a class="xref" href="GrapeCity.ActiveReports.Document.Parameter.ValidationState.html#GrapeCity_ActiveReports_Document_Parameter_ValidationState">ValidationState</a>
        </td>
        <td class="markdown level1 summary"><p>Gets the validation error state of the parameter.</p>
</td>
      </tr>
      <tr>
        <td id="GrapeCity_ActiveReports_Document_Parameter_Values" data-uid="GrapeCity.ActiveReports.Document.Parameter.Values">
          <a class="xref" href="GrapeCity.ActiveReports.Document.Parameter.Values.html#GrapeCity_ActiveReports_Document_Parameter_Values">Values</a>
        </td>
        <td class="markdown level1 summary"><p>Gets the collection of currently assigned values.</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_Document_Parameter_Refresh" data-uid="GrapeCity.ActiveReports.Document.Parameter.Refresh">
          <a class="xref" href="GrapeCity.ActiveReports.Document.Parameter.Refresh.html#GrapeCity_ActiveReports_Document_Parameter_Refresh">Refresh()</a>
        </td>
        <td class="markdown level1 summary"><p>Refreshes the parameter values from the data source.</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>