WebPartPersonalization.ToggleScope メソッドとは何？わかりやすく解説 Weblio辞書

.NET Framework クラスライブラリリファレンス

索引トップ用語の索引ランキング

WebPartPersonalization.ToggleScope メソッド

メモ : このメソッドは、.NET Framework version 2.0 で新しく追加されたものです。

現在のページのパーソナル化スコープを、User から Shared に、または Shared から User に切り替えます。

名前空間: System.Web.UI.WebControls.WebParts
アセンブリ: System.Web (system.web.dll 内)
構文

Visual Basic (宣言)

Public Overridable Sub ToggleScope

Visual Basic (使用法)

Dim instance As WebPartPersonalization

instance.ToggleScope

public virtual void ToggleScope ()

C++

public:
virtual void ToggleScope ()

public void ToggleScope ()

JScript

public function ToggleScope ()

例外

例外の種類	条件
InvalidOperationException	User スコープから Shared スコープに切り替えようとしたときに、現在のユーザーに Shared スコープを入力するためのユーザー機能がありませんでした。または WebPartPersonalization インスタンスの初期化が完了していません。または関連する WebPartManager の Page インスタンスが null 参照 (Visual Basic では Nothing) です。または WebPartManager コントロールの関連する Page インスタンスの Request プロパティの値が null 参照 (Visual Basic では Nothing) です。
ArgumentOutOfRangeException	PersonalizationScope 列挙体で定義されていないスコープに切り替えようとしました。技術的には、この状況は発生しません。

例外の種類

条件

InvalidOperationException

User スコープから Shared スコープに切り替えようとしたときに、現在のユーザーに Shared スコープを入力するためのユーザー機能がありませんでした。

または

WebPartPersonalization インスタンスの初期化が完了していません。

または

関連する WebPartManager の Page インスタンスが null 参照 (Visual Basic では Nothing) です。

または

WebPartManager コントロールの関連する Page インスタンスの Request プロパティの値が null 参照 (Visual Basic では Nothing) です。

ArgumentOutOfRangeException

PersonalizationScope 列挙体で定義されていないスコープに切り替えようとしました。技術的には、この状況は発生しません。

解説

このメソッドは、現在実行中のページのパーソナル化スコープを切り替えます。スコープを切り替えると、Transfer で現在実行中のページに戻ります。

このメソッドは、Web パーツコントロールのエクスポートまたはインポートの処理中に呼び出されると、操作が実行されません。

POST 要求で送信されたページに対してスコープの切り替え要求が発生した場合、クエリ文字列の値は転送の間も保持されます。ページが、GET 要求で送信された場合は、クエリ文字列のパラメータは保持されません。

使用例

ToggleScope メソッドを使用するコード例を次に示します。このコードは、WebPartPersonalization クラスの説明で取り上げている、より長いコード例の一部です。

Visual Basic

' Allows authorized user to change personalization scope.
Protected Sub Toggle_Scope_Button_Click(ByVal
 sender As Object, ByVal
 e As EventArgs) 
    If _manager.Personalization.CanEnterSharedScope Then
        _manager.Personalization.ToggleScope()
    End If

End Sub 'Toggle_Scope_Button_Click

// Allows authorized user to change personalization scope.
protected void Toggle_Scope_Button_Click(object
 sender, EventArgs e)
{
    if (_manager.Personalization.CanEnterSharedScope)
    {
        _manager.Personalization.ToggleScope();
    }
    
}