Interface IParameter
Represents the parameter used in a query table.
Namespace: Syncfusion.XlsIO
Assembly: Syncfusion.XlsIO.Base.dll
Syntax
public interface IParameter : IParentApplicationProperties
DataType
Gets or sets the data type of the query parameter.
Declaration
ExcelParameterDataType DataType { get; set; }Property Value
| Type |
|---|
| ExcelParameterDataType |
Name
Returns or sets the name of the object.
Declaration
string Name { get; set; }Property Value
| Type |
|---|
| System.String |
PromptString
Returns the phrase that prompts the user for a parameter value in a parameter query.
Declaration
string PromptString { get; }Property Value
| Type |
|---|
| System.String |
RefreshOnChange
True if the specified query table is refreshed whenever you change the parameter value of a parameter query.
Declaration
bool RefreshOnChange { get; set; }Property Value
| Type |
|---|
| System.Boolean |
SourceRange
Returns a Range object that represents the cell that contains the value of the specified query parameter.
Declaration
IRange SourceRange { get; }Property Value
| Type |
|---|
| IRange |
Type
Gets or sets the parameter type.
Declaration
ExcelParameterType Type { get; }Property Value
| Type |
|---|
| ExcelParameterType |
Value
The parameter value.
Declaration
object Value { get; }Property Value
| Type |
|---|
| System.Object |
Methods
SetParam(ExcelParameterType, Object)
Set parameter type and value.
Declaration
void SetParam(ExcelParameterType Type, object Value)Parameters
| Type | Name | Description |
|---|---|---|
| ExcelParameterType | Type | |
| System.Object | Value |
Events
Prompt
Occurs while refresh the table whenever the parameter type is set as prompt.
Declaration
event PromptEventHandler PromptEvent Type
| Type |
|---|
| PromptEventHandler |