DynamicQueryStringParameter Class

.NET Framework (current version)

Automatically generates a collection of parameters that is used to create the Where clause for the data source control by retrieving query string values.

Namespace: System.Web.DynamicData
Assembly: System.Web.DynamicData (in System.Web.DynamicData.dll)

Inheritance Hierarchy

System::Object
System.Web.UI.WebControls::Parameter
System.Web.DynamicData::DynamicQueryStringParameter

Syntax

C++

public ref class DynamicQueryStringParameter : Parameter, IWhereParametersProvider

Constructors

	Name	Description
	DynamicQueryStringParameter()	Initializes a new instance of the DynamicQueryStringParameter class.

Properties

	Name	Description
	ConvertEmptyStringToNull	Gets or sets a value indicating whether the value that the Parameter object is bound to should be converted to null if it is String::Empty.(Inherited from Parameter.)
	DbType	Gets or sets the database type of the parameter.(Inherited from Parameter.)
	DefaultValue	Specifies a default value for the parameter, should the value that the parameter is bound to be uninitialized when the Evaluate method is called.(Inherited from Parameter.)
	Direction	Indicates whether the Parameter object is used to bind a value to a control, or the control can be used to change the value.(Inherited from Parameter.)
	IsTrackingViewState	Gets a value indicating whether the Parameter object is saving changes to its view state.(Inherited from Parameter.)
	Name	Gets or sets the name of the parameter.(Inherited from Parameter.)
	Size	Gets or sets the size of the parameter.(Inherited from Parameter.)
	Type	Gets or sets the type of the parameter.(Inherited from Parameter.)
	ViewState	Gets a dictionary of state information that allows you to save and restore the view state of a Parameter object across multiple requests for the same page.(Inherited from Parameter.)

Methods

	Name	Description
	Clone()	Returns a duplicate of the current Parameter instance.(Inherited from Parameter.)
	Equals(Object^)	Determines whether the specified object is equal to the current object.(Inherited from Object.)
	Evaluate(HttpContext^, Control^)	Throws an InvalidOperationException exception in all cases.(Overrides Parameter::Evaluate(HttpContext^, Control^).)
	Finalize()	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)
	GetDatabaseType()	Gets the DbType value that is equivalent to the CLR type of the current Parameter instance.(Inherited from Parameter.)
	GetHashCode()	Serves as the default hash function. (Inherited from Object.)
	GetType()	Gets the Type of the current instance.(Inherited from Object.)
	GetWhereParameters(IDynamicDataSource^)	Returns a collection of Parameter objects that are automatically generated for the columns of a table by retrieving query string values.
	LoadViewState(Object^)	Restores the data source view's previously saved view state.(Inherited from Parameter.)
	MemberwiseClone()	Creates a shallow copy of the current Object.(Inherited from Object.)
	OnParameterChanged()	Calls the OnParametersChanged method of the ParameterCollection collection that contains the Parameter object.(Inherited from Parameter.)
	SaveViewState()	Saves the changes to the Parameter object's view state since the time the page was posted back to the server.(Inherited from Parameter.)
	SetDirty()	Marks the Parameter object so its state will be recorded in view state.(Inherited from Parameter.)
	ToString()	Converts the value of this instance to its equivalent string representation.(Inherited from Parameter.)
	TrackViewState()	Causes the Parameter object to track changes to its view state so they can be stored in the control's ViewState object and persisted across requests for the same page.(Inherited from Parameter.)

Explicit Interface Implementations

	Name	Description
	ICloneable::Clone()	Returns a duplicate of the current Parameter instance.(Inherited from Parameter.)
	IStateManager::LoadViewState(Object^)	This API supports the product infrastructure and is not intended to be used directly from your code. Restores the data source view's previously saved view state.(Inherited from Parameter.)
	IStateManager::SaveViewState()	This API supports the product infrastructure and is not intended to be used directly from your code. Saves the changes to the Parameter object's view state since the time the page was posted back to the server.(Inherited from Parameter.)
	IStateManager::TrackViewState()	This API supports the product infrastructure and is not intended to be used directly from your code. Causes the Parameter object to track changes to its view state so they can be stored in the control's ViewState object and persisted across requests for the same page.(Inherited from Parameter.)
	IStateManager::IsTrackingViewState	This API supports the product infrastructure and is not intended to be used directly from your code. Gets a value indicating whether the Parameter object is saving changes to its view state.(Inherited from Parameter.)

The DynamicQueryStringParameter class is used by pages that are using ASP.NET Dynamic Data features. The DynamicQueryStringParameter class will generate a collection of Parameter objects for the primary keys, foreign keys, and Boolean columns of a table by retrieving query string values.

For primary keys, you can simply add a DynamicQueryStringParameter object without supplying any other parameters. Dynamic Data will generate the parameters for the primary key or keys. For foreign keys or Boolean columns, you must set the Name property to the name of the column you want to filter.

In order to use the DynamicQueryStringParameter class, you must add a DynamicDataManager control to the page and you must register the data-bound control with the DynamicDataManager control by using the DynamicDataManager::RegisterControl method.

See a run-time code example of this feature: Run.

Examples

The following example shows how to use the DynamicQueryStringParameter object as filter when displaying data in a GridView control. The GridView control contains a TemplateField object that creates a link that sets the query string value by using the foreign key value.

C++

No code example is currently available or this language may not be supported.

Version Information

.NET Framework
Available since 3.5

Thread Safety

Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.