# C1.Document.Parameter

## Content

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



  <h1 id="C1_Document_Parameter" data-uid="C1.Document.Parameter" class="text-break">Parameter Class
</h1>
  <div class="markdown level0 summary"><p>Represents a user-defined parameter.</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">OwnedObject</span></div>
    <div class="level2"><span class="xref">NamedObject</span></div>
    <div class="level3"><span class="xref">Parameter</span></div>
  </div>
  <h6><strong>Namespace</strong>: <a class="xref" href="C1.Document.html">C1.Document</a></h6>
  <h6><strong>Assembly</strong>: C1.Document.dll</h6>
  <h5 id="C1_Document_Parameter_syntax">Syntax</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public class Parameter : NamedObject</code></pre>
  </div>
  <div class="codewrapper">
    <pre><code class="lang-vbnet hljs">Public Class Parameter
    Inherits NamedObject</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="C1_Document_Parameter__ctor" data-uid="C1.Document.Parameter.#ctor">
          <a class="xref" href="C1.Document.Parameter.-ctor.html#C1_Document_Parameter__ctor">Parameter()</a>
        </td>
        <td class="markdown level1 summary"></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="C1_Document_Parameter_AllowBlank" data-uid="C1.Document.Parameter.AllowBlank">
          <a class="xref" href="C1.Document.Parameter.AllowBlank.html#C1_Document_Parameter_AllowBlank">AllowBlank</a>
        </td>
        <td class="markdown level1 summary"><p>Gets or sets a value indicating whether the value of this parameter can be an empty string.
Ignored unless <a class="xref" href="C1.Document.Parameter.DataType.html#C1_Document_Parameter_DataType">DataType</a> is <b>String</b>.</p>
</td>
      </tr>
      <tr>
        <td id="C1_Document_Parameter_AllowedValues" data-uid="C1.Document.Parameter.AllowedValues">
          <a class="xref" href="C1.Document.Parameter.AllowedValues.html#C1_Document_Parameter_AllowedValues">AllowedValues</a>
        </td>
        <td class="markdown level1 summary"><p>Gets a list of allowed parameter values.</p>
<p>This can be null, which means that the list of allowed values is not supported.</p>
<p>This can also be an empty list, which means that the list of allowed values is empty
(possible if for example the list is filled by a query, and the query returned an empty result).</p>
</td>
      </tr>
      <tr>
        <td id="C1_Document_Parameter_DataType" data-uid="C1.Document.Parameter.DataType">
          <a class="xref" href="C1.Document.Parameter.DataType.html#C1_Document_Parameter_DataType">DataType</a>
        </td>
        <td class="markdown level1 summary"><p>Gets or sets the data type of this parameter.</p>
</td>
      </tr>
      <tr>
        <td id="C1_Document_Parameter_DocumentSource" data-uid="C1.Document.Parameter.DocumentSource">
          <a class="xref" href="C1.Document.Parameter.DocumentSource.html#C1_Document_Parameter_DocumentSource">DocumentSource</a>
        </td>
        <td class="markdown level1 summary"><p>Gets a <a class="xref" href="C1.Document.C1DocumentSource.html">C1DocumentSource</a> owning this <a class="xref" href="C1.Document.Parameter.html">Parameter</a> object.</p>
</td>
      </tr>
      <tr>
        <td id="C1_Document_Parameter_Hidden" data-uid="C1.Document.Parameter.Hidden">
          <a class="xref" href="C1.Document.Parameter.Hidden.html#C1_Document_Parameter_Hidden">Hidden</a>
        </td>
        <td class="markdown level1 summary"><p>Gets or sets a value indicating whether this parameter should be hidden from user interface.
(Hidden parameters can be used for programmatic control of subreports, drillthrough reports etc.)</p>
</td>
      </tr>
      <tr>
        <td id="C1_Document_Parameter_MaxLength" data-uid="C1.Document.Parameter.MaxLength">
          <a class="xref" href="C1.Document.Parameter.MaxLength.html#C1_Document_Parameter_MaxLength">MaxLength</a>
        </td>
        <td class="markdown level1 summary"><p>Gets or sets the maximum length of a string parameter (0 means unlimited length).
This property is ignored for non-string parameters.</p>
</td>
      </tr>
      <tr>
        <td id="C1_Document_Parameter_MultiValue" data-uid="C1.Document.Parameter.MultiValue">
          <a class="xref" href="C1.Document.Parameter.MultiValue.html#C1_Document_Parameter_MultiValue">MultiValue</a>
        </td>
        <td class="markdown level1 summary"><p>Gets or sets a value indicating whether this parameter can be used to pass multiple values.</p>
</td>
      </tr>
      <tr>
        <td id="C1_Document_Parameter_Nullable" data-uid="C1.Document.Parameter.Nullable">
          <a class="xref" href="C1.Document.Parameter.Nullable.html#C1_Document_Parameter_Nullable">Nullable</a>
        </td>
        <td class="markdown level1 summary"><p>Gets or sets a value indicating whether the value of this parameter can be null.
Cannot be true if this is a multi-value parameter.</p>
</td>
      </tr>
      <tr>
        <td id="C1_Document_Parameter_Owner" data-uid="C1.Document.Parameter.Owner">
          <a class="xref" href="C1.Document.Parameter.Owner.html#C1_Document_Parameter_Owner">Owner</a>
        </td>
        <td class="markdown level1 summary"><p>Gets a <a class="xref" href="C1.Document.ParameterCollection.html">ParameterCollection</a> containing this <a class="xref" href="C1.Document.Parameter.html">Parameter</a> object.</p>
</td>
      </tr>
      <tr>
        <td id="C1_Document_Parameter_Prompt" data-uid="C1.Document.Parameter.Prompt">
          <a class="xref" href="C1.Document.Parameter.Prompt.html#C1_Document_Parameter_Prompt">Prompt</a>
        </td>
        <td class="markdown level1 summary"><p>Gets or sets the prompt shown to the user when asking to enter a value for the parameter.</p>
</td>
      </tr>
      <tr>
        <td id="C1_Document_Parameter_Text" data-uid="C1.Document.Parameter.Text">
          <a class="xref" href="C1.Document.Parameter.Text.html#C1_Document_Parameter_Text">Text</a>
        </td>
        <td class="markdown level1 summary"><p>Gets the string representation of <a class="xref" href="C1.Document.Parameter.Value.html#C1_Document_Parameter_Value">Value</a></p>
</td>
      </tr>
      <tr>
        <td id="C1_Document_Parameter_Value" data-uid="C1.Document.Parameter.Value">
          <a class="xref" href="C1.Document.Parameter.Value.html#C1_Document_Parameter_Value">Value</a>
        </td>
        <td class="markdown level1 summary"><p>Gets or sets the parameter value.</p>
If <a class="xref" href="C1.Document.Parameter.MultiValue.html#C1_Document_Parameter_MultiValue">MultiValue</a> is true, the parameter value can be an array,
in which case all items in that array must have the same type, and cannot be arrays.
</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="C1_Document_Parameter_AssignFrom_System_Object_" data-uid="C1.Document.Parameter.AssignFrom(System.Object)">
          <a class="xref" href="C1.Document.Parameter.AssignFrom.html#C1_Document_Parameter_AssignFrom_System_Object_">AssignFrom(object)</a>
        </td>
        <td class="markdown level1 summary"><p>Assigns all from another object.</p>
</td>
      </tr>
      <tr>
        <td id="C1_Document_Parameter_CreateSame" data-uid="C1.Document.Parameter.CreateSame">
          <a class="xref" href="C1.Document.Parameter.CreateSame.html#C1_Document_Parameter_CreateSame">CreateSame()</a>
        </td>
        <td class="markdown level1 summary"><p>Creates a new instance of the same class as this one.</p>
</td>
      </tr>
      <tr>
        <td id="C1_Document_Parameter_GetPropsTable" data-uid="C1.Document.Parameter.GetPropsTable">
          <a class="xref" href="C1.Document.Parameter.GetPropsTable.html#C1_Document_Parameter_GetPropsTable">GetPropsTable()</a>
        </td>
        <td class="markdown level1 summary"><p>Gets the <span class="xref">C1.Document.Serialization.IC1PropsTable</span>.</p>
</td>
      </tr>
      <tr>
        <td id="C1_Document_Parameter_OnPropertyChanged" data-uid="C1.Document.Parameter.OnPropertyChanged">
          <a class="xref" href="C1.Document.Parameter.OnPropertyChanged.html#C1_Document_Parameter_OnPropertyChanged">OnPropertyChanged()</a>
        </td>
        <td class="markdown level1 summary"><p>Called when property of <a class="xref" href="C1.Document.Parameter.html">Parameter</a> is changed.</p>
</td>
      </tr>
      <tr>
        <td id="C1_Document_Parameter_SelectAllValues" data-uid="C1.Document.Parameter.SelectAllValues">
          <a class="xref" href="C1.Document.Parameter.SelectAllValues.html#C1_Document_Parameter_SelectAllValues">SelectAllValues()</a>
        </td>
        <td class="markdown level1 summary"><p>Assigns all <a class="xref" href="C1.Document.Parameter.AllowedValues.html#C1_Document_Parameter_AllowedValues">AllowedValues</a> to <a class="xref" href="C1.Document.Parameter.Value.html#C1_Document_Parameter_Value">Value</a>.</p>
</td>
      </tr>
    </tbody>
  </table>

</div>