ImportCatalogPart Web 伺服器控制元件可匯入 WebPart 控制元件的說明檔案（或用作 WebPart 控制元件的其他 ASP.NET 伺服器控制元件）。這樣就可以將該控制元件通過預先指定的設定新增到網頁中。該說明檔案使使用者可以共享 WebPart 控制元件的設定。

說明檔案與控制元件本身不同。它是以 .WebPart 副檔名結尾的 XML 檔案，包含有描述控制元件的狀態的名稱/值對。除了描述控制元件的狀態以外，說明檔案還引用該控制元件名和包含該控制元件的程式集（或檔案）。

使用者匯入說明檔案之後，該檔案中引用的 WebPart 控制元件將會顯示在 ImportCatalogPart

控制元件中，使用者可以將該控制元件新增到頁面中。

將 Web 部件控制元件與 ImportCatalogPart Web 伺服器控制元件關聯

與 ImportCatalogPart 控制元件關聯的 Web 部件控制元件可以編譯為程式集，也可以是一個使用者控制元件（.ascx 檔案）。在任一情況下，匯入的說明檔案中引用的控制元件都必須存在於包含宿主網頁的 Web 伺服器上。

使用者可使用 ImportCatalogPart 控制元件將說明檔案及其關聯的伺服器控制元件匯入網頁。此控制元件必須已存在於頁面中。如果使用者將頁面切換到目錄顯示模式，則顯示 ImportCatalogPart 控制元件。然後，使用者就可以瀏覽到該控制元件的

.WebPart 說明檔案，並匯入該控制元件。控制元件的外觀和屬性在匯入的說明檔案中指定。

在匯入 WebPart 控制元件的說明檔案之前，使用者必須首先基於現有 WebPart 控制元件建立（匯出）該檔案。滿足以下條件時，可以為一個控制元件匯出說明檔案：

·該控制元件具有用 Personalizable 屬性 (Attribute) 標記的屬性 (Property)。

·Web.config 檔案已經在 webParts 元素中將 enableExport 屬性值設定為 true。

·您已經將控制元件的 ExportMode 屬性值設定為 None 預設值（該值禁止匯出）以外的值。

啟用 ImportCatalogPart Web 伺服器控制元件

當 Web 部件頁處於編輯模式以及使用者選擇某一關聯的 WebPart 控制元件進行編輯時，在執行時將顯示 ImportCatalogPart Web 伺服器控制元件。

一、ImportCatalogPart 類

匯入 WebPart 控制元件（或其他用作 WebPart 控制元件的 ASP.NET 伺服器控制元件）的說明檔案，以便使用者可以使用預定義的設定將控制元件新增到網頁中。無法繼承此類。

ImportCatalogPart 控制元件使使用者可以匯入說明檔案，該檔案描述了使用者希望新增到 WebPartZoneBase 區域的 WebPart 控制元件或伺服器控制元件的設定。

使用者匯入說明檔案之後，在該檔案中引用的 WebPart 控制元件出現在 ImportCatalogPart 控制元件中，並且使用者可以將該控制元件新增到頁面上。

說明檔案與控制元件本身不同。它是以 .WebPart 副檔名結尾的 XML 檔案，幷包含名稱/值對 -- 通常是屬性值 -- 描述控制元件的狀態。

說明檔案引用的控制元件既可以被編譯為程式集，也可以是 .ascx 檔案中定義的使用者控制元件。在任一情況下，匯入的說明檔案中引用的控制元件都必須存在於承載試圖匯入該控制元件的網頁的 Web 伺服器上。說明檔案引用該控制元件名和包含該控制元件的程式集（或檔案），並且說明檔案包含影響控制元件的屬性值、外觀和行為的設定。

ImportCatalogPart 控制元件使使用者可以共享控制元件的設定。複雜的控制元件可以有許多屬性和設定。例如，在一個大型公司的典型 Intranet 站點上，一個自定義的 WebPart 控制元件可能包含許多儲存特定於使用者環境的值的屬性，如資料庫連線、部門資訊等。該控制元件還可能包含許多影響其外觀的屬性。使用者可以個性化特定站點上的控制元件並使其正常工作，匯出該控制元件的說明檔案，然後與其他使用者共享該說明檔案，這些使用者可以匯入該檔案以將該完全配置的控制元件新增到允許他們個性化的其他 Intranet 站點。只要已編譯的程式集或包含控制元件的使用者控制元件檔案存在於承載其站點的 Web 伺服器上，使用者就可以將控制元件新增到其他網站中。

使用者將說明檔案（及其關聯的伺服器控制元件）匯入網頁的機制是 ImportCatalogPart 控制元件，網頁開發人員必須將此控制元件新增到網頁。當用戶將網頁切換到目錄顯示模式後，將出現 ImportCatalogPart 控制元件，使用者可以使用此控制元件瀏覽到與要匯入的伺服器控制元件相對應的 .WebPart 說明檔案。按照 ImportCatalogPart 控制元件提供的 UI 和說明，使用者可將所需的伺服器控制元件新增到網頁中，並將其外觀和屬性完全按照匯入的說明檔案中的說明進行配置。

在 WebPart 控制元件的說明檔案可以匯入之前，使用者必須首先基於已存在的 WebPart 控制元件建立（匯出）該檔案。滿足以下條件時，可以為一個控制元件匯出說明檔案：

·該控制元件具有用 Personalizable 屬性 (Attribute) 標記的屬性 (Property)。

·Web.config 檔案將 <webParts> 元素的 enableExport 屬性值設定為 true。

·開發人員將控制元件的 ExportMode 屬性值設定為預設值 None（該值禁止匯出）以外的值。如果 ExportMode 屬性 (Property) 值設定為 NonSensitiveData，則當用戶匯出說明檔案時，任何包含具有 Personalizable 屬性 (Attribute) 的 IsSensitive 引數的屬性 (Property) 都不會被匯出。這使得控制元件開發人員可以防止敏感資料（如連線字串）在某些情況下被匯出。

使用者可以匯出支援匯出的控制元件，方法是單擊出現在控制元件謂詞選單中的匯出謂詞，然後按照說明儲存該控制元件的 .WebPart 說明檔案。然後其他使用者可以匯入該檔案來配置他們各自的該控制元件例項。

ImportCatalogPart 類包含若干屬性。BrowseHelpText 屬性包含當用戶瀏覽到說明檔案時提供給使用者的說明文字。ImportedPartLabelText 屬性包含當匯入控制元件出現在 ImportCatalogPart 控制元件中時，用作該控制元件標籤的文字。PartImportErrorLabelText 包含當匯入控制元件說明發生錯誤時顯示的文字。如果開發人員沒有為 ImportCatalogPart 控制元件指定標題，則 Title 屬性重寫基屬性來為該控制元件指定一個預設標題。UploadButtonText 屬性包含使用者單擊以上載說明檔案的按鈕的文字，UploadHelpText 屬性包含上載過程的說明。

ImportCatalogPart 類還包含若干獨有的方法。GetAvailableWebPartDescriptions 方法檢索目錄中每個 WebPart 控制元件的 WebPartDescription 物件，這使得 ImportCatalogPart 控制元件無需建立每個伺服器控制元件的例項即可顯示其有關資訊。GetWebPart 方法根據傳遞給方法的說明獲取某個特定 WebPart 控制元件的例項。

存在與使用 ImportCatalogPart 控制元件關聯的某些內在風險。一個示例是，有人可能會將惡意資料通過用於匯入的說明檔案匯入到 Web 應用程式中。如果有人將惡意指令碼程式碼作為字串屬性的值放在說明檔案中，則當用戶匯入說明檔案並將引用的伺服器控制元件新增到網頁時，就有可能執行該指令碼。若要將匯入帶有惡意資料的說明檔案的風險降至最低，具有字串型別屬性的伺服器控制元件應該始終對屬性資料進行編碼。另一風險是通過說明檔案匯入型別。惡意使用者可以通過提交請求將許多程式集載入到 AppDomain 中，導致大量記憶體被佔用。

若要避免與匯入相關的風險，可以通過不使用匯入功能或 ImportCatalogPart 控制元件以完全禁用該功能。或者，可以限制哪些使用者可以訪問該控制元件。可以使用角色管理以程式設計方式實現此目的（請參見使用角色管理授權）。例如，載入網頁時，可以通過測試來檢視使用者是否屬於某一特定角色（如管理員角色）。如果使用者屬於該角色，則可以通過程式設計方式將 ImportCatalogPart 控制元件新增到網頁中供該使用者使用。還可通過宣告性方法來限制可以使用 ImportCatalogPart 控制元件的使用者集。在包含目錄的網頁中，可以放置兩個 CatalogZone 控制元件：一個用於可以匯入的使用者，另一個用於不可以匯入的使用者。可以匯入的使用者的區域將包含 ImportCatalogPart 控制元件。該區域本身可以置於 LoginView 控制元件的內部，這樣就可以限制該區域內的控制元件使用，使得只有經過驗證身份的使用者或指定的角色才能使用該控制元件。

1.1、示例

下面的程式碼示例演示如何以宣告和程式設計方式在網頁上使用 ImportCatalogPart 控制元件。此示例包含四部分：

·一個使用者控制元件，可用於更改 Web 部件頁上的顯示模式。

·一個網頁，包含一個 CatalogZone 控制元件和一個 ImportCatalogPart 控制元件。

·一個包含兩個自定義 WebPart 控制元件的原始碼檔案。

·對您在瀏覽器中載入頁面時示例的執行方式的說明。

此程式碼示例的第一部分是一個使用者控制元件，該控制元件使使用者能夠更改網頁上的顯示模式。應該將下面的原始碼放置在一個檔案中，並將它命名為 Displaymodemenucs.ascx 或 Displaymodemenuvb.ascx（具體取決於所使用的語言）。

<%@ control language="C#" classname="DisplayModeMenuCS"%>

<script runat="server">

// Use a field to reference the current WebPartManager.

WebPartManager _manager;

void Page_Init(object sender, EventArgs e)

{

Page.InitComplete += new EventHandler(InitComplete);

}

void InitComplete(object sender, System.EventArgs e)

{

_manager = WebPartManager.GetCurrentWebPartManager(Page);

String browseModeName = WebPartManager.BrowseDisplayMode.Name;

// Fill the dropdown with the names of supported display modes.

foreach (WebPartDisplayMode mode in _manager.SupportedDisplayModes)

{

String modeName = mode.Name;

// Make sure a mode is enabled before adding it.

if (mode.IsEnabled(_manager))

{

ListItem item = new ListItem(modeName, modeName);

DisplayModeDropdown.Items.Add(item);

}

}

// If shared scope is allowed for this user, display the scope-switching

// UI and select the appropriate radio button for the current user scope.

if (_manager.Personalization.CanEnterSharedScope)

{

Panel2.Visible = true;

if (_manager.Personalization.Scope == PersonalizationScope.User)

RadioButton1.Checked = true;

else

RadioButton2.Checked = true;

}

}

// Change the page to the selected display mode.

void DisplayModeDropdown_SelectedIndexChanged(object sender, EventArgs e)

{

String selectedMode = DisplayModeDropdown.SelectedValue;

WebPartDisplayMode mode = _manager.SupportedDisplayModes[selectedMode];

if (mode != null)

_manager.DisplayMode = mode;

}

// Set the selected item equal to the current display mode.

void Page_PreRender(object sender, EventArgs e)

{

ListItemCollection items = DisplayModeDropdown.Items;

int selectedIndex =

items.IndexOf(items.FindByText(_manager.DisplayMode.Name));

DisplayModeDropdown.SelectedIndex = selectedIndex;

}

// Reset all of a user's personalization data for the page.

protected void LinkButton1_Click(object sender, EventArgs e)

{

_manager.Personalization.ResetPersonalizationState();

}

// If not in User personalization scope, toggle into it.

protected void RadioButton1_CheckedChanged(object sender, EventArgs e)

{

if (_manager.Personalization.Scope == PersonalizationScope.Shared)

_manager.Personalization.ToggleScope();

}

// If not in Shared scope, and if user is allowed, toggle the scope.

protected void RadioButton2_CheckedChanged(object sender, EventArgs e)

{

if (_manager.Personalization.CanEnterSharedScope &&

_manager.Personalization.Scope == PersonalizationScope.User)

_manager.Personalization.ToggleScope();

}

</script>

<div>

<asp:Panel ID="Panel1" runat="server"

Borderwidth="1"

Width="230"

BackColor="lightgray"

Font-Names="Verdana, Arial, Sans Serif" >

<asp:Label ID="Label1" runat="server"

Text="&nbsp;Display Mode"

Font-Bold="true"

Font-Size="8"

Width="120"

AssociatedControlID="DisplayModeDropdown"/>

<asp:DropDownList ID="DisplayModeDropdown" runat="server"

AutoPostBack="true"

Width="120"

OnSelectedIndexChanged="DisplayModeDropdown_SelectedIndexChanged" />

<asp:LinkButton ID="LinkButton1" runat="server"

Text="Reset User State"

相關推薦