RouteParameter RouteParameter RouteParameter RouteParameter Class

定義

URL セグメントの値をパラメーター オブジェクトにバインドします。Binds the value of a URL segment to a parameter object.

public ref class RouteParameter : System::Web::UI::WebControls::Parameter
public class RouteParameter : System.Web.UI.WebControls.Parameter
type RouteParameter = class
    inherit Parameter
Public Class RouteParameter
Inherits Parameter
継承
RouteParameterRouteParameterRouteParameterRouteParameter

このセクションの例では、マークアップRouteParameter内のオブジェクトを使用して、データソースコントロールに対して指定されたクエリに URL パラメーター値を渡す方法を示します。The examples in this section show how to use RouteParameter objects in markup to pass URL parameter values to a query that is specified for a data source control.

次の例は、という名前ProductRouteのルートを定義する global.asax ページのコードを示しています。The following example shows code in the Global.asax page that defines a route that is named ProductRoute. ルートでは、という名前productnameの URL パラメーターを定義します。The route defines a URL parameter that is named productname. ルートは、という名前cultureの省略可能な汎用パラメーターも定義します。このパラメーターを使用して、製品の説明を表示する言語を指定できます。The route also defines an optional catchall parameter that is named culture, which can be used to specify the language in which the product description is displayed. このルートの要求は、default.aspx ページによって処理されます。The Product.aspx page handles requests for this route.

次の例は、default.aspx ページを示しています。The following example shows the Product.aspx page. このページにはSqlDataSource 、2つのパラメーターを必要とするクエリを含むコントロールが含まれています。1つは製品の名前、もう1つは製品の説明の言語です。The page contains a SqlDataSource control that has a query that requires two parameters, one for the name of the product and one for the language of the product description. RouteParameterオブジェクトは、クエリパラメーターの値を指定するために使用されます。RouteParameter objects are used to supply the values for the query parameters. ルート URL パラメーター productnameの値は、クエリパラメーター @productnameに渡されます。The value of the route URL parameter productname is passed to the query parameter @productname. ルート URL パラメーター cultureの値は、クエリパラメーター @cultureに渡されます。The value of the route URL parameter culture is passed to the query parameter @culture. ルート url に url パラメーター cultureが含まれていない場合は、既定値の "en" が使用されます。If a route URL does not include the URL parameter culture, a default value of "en" is used.

次の例は、ProductLinks という名前のページを示しています。このページには、ルート Url を使用して、default.aspx ページにリンクするハイパーリンクが含まれています。The following example shows a page that is named ProductLinks.aspx, which contains hyperlinks that link to the Product.aspx page by using route URLs. これらのハイパーリンクRouteUrlは、式を使用してルート url を作成します。These hyperlinks use RouteUrl expressions to create route URLs. 最初のリンクには、ルートcultureパラメーターは含まれません。The first link does not include a culture route parameter. そのため、クエリパラメーターのRouteParameter @cultureオブジェクトで定義されている "en" の既定値がクエリで使用されます。Therefore, the default value of "en" that is defined in the RouteParameter object for @culture query parameter will be used in the query. 2番目のリンクcultureは "fr" の値を提供します。これにより、説明がフランス語で表示されます。The second link provides a culture value of "fr", which causes the description to be displayed in French. 式の使用RouteUrl方法の詳細については、「方法:ルートから url を構築します。For more information about how to use RouteUrl expressions, see How to: Construct URLs from Routes.

最初のハイパーリンクをクリックすると、 GridViewコントロールに次の値を含む default.aspx ページが表示されます。When you click the first hyperlink, you see the Product.aspx page with the following values in the GridView control:

ProductIDProductID nameName 説明Description
994 LL Bottom Bracket Chromoly steel.

2番目のハイパーリンクをクリックすると、 GridViewコントロールに次の値が表示されます。When you click the second hyperlink, you see the following values in the GridView control:

ProductIDProductID nameName 説明Description
994 LL Bottom Bracket Acier chromé.

この例を実行するには、2つの .aspx ページと、global.asax ファイル内のコードを、AdventureWorksLT データベースのというAdventureWorksLTConnectionString接続文字列を定義する ASP.NET web サイトまたは web アプリケーションに追加します。To run this example, add the two .aspx pages and the code in the Global.asax file to an ASP.NET Web site or Web application that defines a connection string named AdventureWorksLTConnectionString for the AdventureWorksLT database. AdventureWorksLT データベースへの接続を設定する方法の詳細については、「」を参照してください。ASP.NET 開発用の AdventureWorksLT サンプルデータベースを設定します。For information about how to set up a connection to the AdventureWorksLT database, see How to: Set Up an AdventureWorksLT Sample Database for ASP.NET Development.

ASP.NET ルーティングの詳細については、「 ASP.NET routing」を参照してください。For more information about ASP.NET routing, see ASP.NET Routing.

注釈

Web サイトで ASP.NET routing を実装する場合は、 RouteParameterオブジェクトを使用して、要求された URL のセグメントの値をデータベースクエリまたはコマンドにバインドできます。If you implement ASP.NET routing in a Web site, you can use the RouteParameter object to bind the value of a segment of the requested URL to a database query or command. データソースコントロールRouteParameter QueryExtenderまたはコントロールのマークアップでオブジェクトを宣言できます。You can declare RouteParameter objects in markup for data source controls or the QueryExtender control.

このトピックには、ソースコードが含まれた Visual Studio Web サイトプロジェクトが用意されています。をダウンロードします。A Visual Studio Web site project with source code is available to accompany this topic: Download.

コンストラクター

RouteParameter() RouteParameter() RouteParameter() RouteParameter()

RouteParameter クラスの新しいインスタンスを初期化します。Initializes a new instance of the RouteParameter class.

RouteParameter(RouteParameter) RouteParameter(RouteParameter) RouteParameter(RouteParameter) RouteParameter(RouteParameter)

指定したインスタンスの値を使用して、RouteParameter クラスの新しいインスタンスを初期化します。Initializes a new instance of the RouteParameter class by using the values of the specified instance.

RouteParameter(String, DbType, String) RouteParameter(String, DbType, String) RouteParameter(String, DbType, String) RouteParameter(String, DbType, String)

指定したパラメーターの名前とデータベース型を使用し、さらに指定したルート データのキーを使用して、RouteParameter クラスの新しいインスタンスを初期化します。Initializes a new instance of the RouteParameter class by using the specified name and database type for the parameter, and by using the specified key for the route data.

RouteParameter(String, String) RouteParameter(String, String) RouteParameter(String, String) RouteParameter(String, String)

指定したパラメーターの名前を使用し、さらに指定したルート データのキーを使用して、RouteParameter クラスの新しいインスタンスを初期化します。Initializes a new instance of the RouteParameter class by using the specified name for the parameter and the specified key for route data.

RouteParameter(String, TypeCode, String) RouteParameter(String, TypeCode, String) RouteParameter(String, TypeCode, String) RouteParameter(String, TypeCode, String)

指定したパラメーターの名前と型を使用し、さらに指定したルート データのキーを使用して、RouteParameter クラスの新しいインスタンスを初期化します。Initializes a new instance of the RouteParameter class by using the specified name and type for the parameter, and by using the specified key for the route data.

プロパティ

ConvertEmptyStringToNull ConvertEmptyStringToNull ConvertEmptyStringToNull ConvertEmptyStringToNull

Parameter オブジェクトのバインド先の値が Empty の場合に、その値を null に変換する必要があるかどうかを示す値を取得または設定します。Gets or sets a value indicating whether the value that the Parameter object is bound to should be converted to null if it is Empty.

(Inherited from Parameter)
DbType DbType DbType DbType

パラメーターのデータベース型を取得または設定します。Gets or sets the database type of the parameter.

(Inherited from Parameter)
DefaultValue DefaultValue DefaultValue DefaultValue

パラメーターの既定値を指定します。Evaluate(HttpContext, Control) メソッドの呼び出し時に、パラメーターはこの値にバインドされ、初期化前の状態に戻されます。Specifies a default value for the parameter, should the value that the parameter is bound to be uninitialized when the Evaluate(HttpContext, Control) method is called.

(Inherited from Parameter)
Direction Direction Direction Direction

Parameter オブジェクトを使用して値をコントロールにバインドするかどうか、またはそのコントロールを使用して値を変更できるかどうかを示します。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)
IStateManager.IsTrackingViewState IStateManager.IsTrackingViewState IStateManager.IsTrackingViewState IStateManager.IsTrackingViewState

Parameter オブジェクトがビューステートへの変更を保存しているかどうかを示す値を取得します。Gets a value indicating whether the Parameter object is saving changes to its view state.

(Inherited from Parameter)
IsTrackingViewState IsTrackingViewState IsTrackingViewState IsTrackingViewState

Parameter オブジェクトがビューステートへの変更を保存しているかどうかを示す値を取得します。Gets a value indicating whether the Parameter object is saving changes to its view state.

(Inherited from Parameter)
Name Name Name Name

パラメーターの名前を取得または設定します。Gets or sets the name of the parameter.

(Inherited from Parameter)
RouteKey RouteKey RouteKey RouteKey

ルートのパラメーターの値が取得されるルート セグメントの名前を取得または設定します。Gets or sets the name of the route segment from which to retrieve the value for the route parameter.

Size Size Size Size

パラメーターのサイズを取得または設定します。Gets or sets the size of the parameter.

(Inherited from Parameter)
Type Type Type Type

パラメーターの型を取得または設定します。Gets or sets the type of the parameter.

(Inherited from Parameter)
ViewState ViewState ViewState ViewState

同一のページに対する複数の要求にわたって、Parameter オブジェクトのビューステートを保存し、復元できるようにする状態情報のディクショナリを取得します。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)

メソッド

Clone() Clone() Clone() Clone()

現在の RouteParameter インスタンスの複製を返します。Returns a duplicate of the current RouteParameter instance.

Equals(Object) Equals(Object) Equals(Object) Equals(Object)

指定したオブジェクトが、現在のオブジェクトと等しいかどうかを判断します。Determines whether the specified object is equal to the current object.

(Inherited from Object)
Evaluate(HttpContext, Control) Evaluate(HttpContext, Control) Evaluate(HttpContext, Control) Evaluate(HttpContext, Control)

要求 URL を評価し、パラメーターの値を返します。Evaluates the request URL and returns the value of the parameter.

GetDatabaseType() GetDatabaseType() GetDatabaseType() GetDatabaseType()

現在の DbType インスタンスの CLR 型と等価な Parameter 値を取得します。Gets the DbType value that is equivalent to the CLR type of the current Parameter instance.

(Inherited from Parameter)
GetHashCode() GetHashCode() GetHashCode() GetHashCode()

既定のハッシュ関数として機能します。Serves as the default hash function.

(Inherited from Object)
GetType() GetType() GetType() GetType()

現在のインスタンスの Type を取得します。Gets the Type of the current instance.

(Inherited from Object)
LoadViewState(Object) LoadViewState(Object) LoadViewState(Object) LoadViewState(Object)

データ ソース ビューの、以前保存したビューステートを復元します。Restores the data source view's previously saved view state.

(Inherited from Parameter)
MemberwiseClone() MemberwiseClone() MemberwiseClone() MemberwiseClone()

現在の Object の簡易コピーを作成します。Creates a shallow copy of the current Object.

(Inherited from Object)
OnParameterChanged() OnParameterChanged() OnParameterChanged() OnParameterChanged()

OnParametersChanged(EventArgs) オブジェクトを格納する ParameterCollection コレクションの Parameter メソッドを呼び出します。Calls the OnParametersChanged(EventArgs) method of the ParameterCollection collection that contains the Parameter object.

(Inherited from Parameter)
SaveViewState() SaveViewState() SaveViewState() SaveViewState()

ページがサーバーにポスト バックされた時間以降に発生した、Parameter オブジェクトのビューステートへの変更を保存します。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() SetDirty() SetDirty() SetDirty()

Parameter オブジェクトの状態がビューステートで記録されるように、このオブジェクトをマークします。Marks the Parameter object so its state will be recorded in view state.

(Inherited from Parameter)
ToString() ToString() ToString() ToString()

このインスタンスの値を、それと等価の文字列形式に変換します。Converts the value of this instance to its equivalent string representation.

(Inherited from Parameter)
TrackViewState() TrackViewState() TrackViewState() TrackViewState()

Parameter オブジェクトがビューステートの変更を追跡するようにします。それにより、変更をコントロールの ViewState オブジェクトに格納して、同じページに対する複数の要求にわたって永続化できます。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)

明示的なインターフェイスの実装

ICloneable.Clone() ICloneable.Clone() ICloneable.Clone() ICloneable.Clone()

現在の Parameter インスタンスの複製を返します。Returns a duplicate of the current Parameter instance.

(Inherited from Parameter)
IStateManager.LoadViewState(Object) IStateManager.LoadViewState(Object) IStateManager.LoadViewState(Object) IStateManager.LoadViewState(Object)

データ ソース ビューの、以前保存したビューステートを復元します。Restores the data source view's previously saved view state.

(Inherited from Parameter)
IStateManager.SaveViewState() IStateManager.SaveViewState() IStateManager.SaveViewState() IStateManager.SaveViewState()

ページがサーバーにポスト バックされた時間以降に発生した、Parameter オブジェクトのビューステートへの変更を保存します。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() IStateManager.TrackViewState() IStateManager.TrackViewState() IStateManager.TrackViewState()

Parameter オブジェクトがビューステートの変更を追跡するようにします。それにより、変更をコントロールの ViewState オブジェクトに格納して、同じページに対する複数の要求にわたって永続化できます。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)

適用対象

こちらもご覧ください