Interface IParameter

Represents the parameter used in a query table.

Inherited Members

IParentApplication.Application

IParentApplication.Parent

Namespace: Syncfusion.XlsIO

Assembly: Syncfusion.XlsIO.Portable.dll

Syntax

public interface IParameter : IParentApplication

Properties

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

add_Prompt(PromptEventHandler)

Declaration

void add_Prompt(PromptEventHandler value)

Parameters

Type	Name	Description
PromptEventHandler	value

remove_Prompt(PromptEventHandler)

Declaration

void remove_Prompt(PromptEventHandler value)

Parameters

Type	Name	Description
PromptEventHandler	value

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 Prompt

Event Type

Type
PromptEventHandler