ImportCatalogPart.UploadHelpText プロパティ

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

ImportCatalogPart.UploadHelpText プロパティ

メモ : このプロパティは、.NET Framework version 2.0 で新しく追加されたものです。

ユーザーに記述ファイルをアップロードする方法を通知するメッセージのテキストを取得または設定します。

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

Visual Basic (宣言)

Public Property UploadHelpText As
 String

Visual Basic (使用法)

Dim instance As ImportCatalogPart
Dim value As String

value = instance.UploadHelpText

instance.UploadHelpText = value

C#

public string UploadHelpText { get;
 set; }

C++

public:
property String^ UploadHelpText {
    String^ get ();
    void set (String^ value);
}

J#

/** @property */
public String get_UploadHelpText ()

/** @property */
public void set_UploadHelpText (String value)

JScript

public function get UploadHelpText
 () : String

public function set UploadHelpText
 (value : String)

プロパティ値
ユーザーが記述ファイルをアップロードするときの指示として使用される文字列。既定値は、Web パーツ コントロール セットによって提供されるカルチャ固有の文字列です。

解説

UploadHelpText プロパティは、ボタンをクリックして記述ファイルをアップロードするように通知する簡単な文または語句による指示をユーザーに提供します。このプロパティ、または UploadButtonText プロパティにカスタムのテキストを代入する場合は、ユーザーがアップロードするのが記述ファイルであることを明確に示すテキストにする必要があります。アップロード プロセスが実際にアップロードしているのがコントロール自体であることを記述または意味するテキストにはしないでください。

使用例

UploadHelpText プロパティの使用方法を次のコード例に示します。宣言を使用した方法とプログラムを使用した方法の 2 とおりの方法を紹介します。例の実行に必要なコード全体については、ImportCatalogPart クラスの概要の「例」を参照してください。

次のコードのセクションでは、コントロールの UploadHelpText プロパティ値が宣言で設定されます。

Visual Basic

<asp:CatalogZone ID="CatalogZone1" runat="server">
  <ZoneTemplate>
    <asp:ImportCatalogPart ID="ImportCatalogPart1"
 
      runat="server" 
      Title="My ImportCatalogPart" 
      OnPreRender="ImportCatalogPart1_PreRender"
      BrowseHelpText="Type a path or browse to
 find a control's 
        description file." 
      UploadButtonText="Upload Description File" 
      UploadHelpText="Click the button to upload the description
 
        file."
      ImportedPartLabelText="My User Information WebPart"
 
      PartImportErrorLabelText="An error occurred while
 trying 
        to import a description file."  />
  </ZoneTemplate>
</asp:CatalogZone>

C#

<asp:CatalogZone ID="CatalogZone1" runat="server">
  <ZoneTemplate>
    <asp:ImportCatalogPart ID="ImportCatalogPart1" 
      runat="server" 
      Title="My ImportCatalogPart" 
      OnPreRender="ImportCatalogPart1_PreRender"
      BrowseHelpText="Type a path or browse to find a control's 
        description file." 
      UploadButtonText="Upload Description File" 
      UploadHelpText="Click the button to upload the description 
        file."
      ImportedPartLabelText="My User Information WebPart" 
      PartImportErrorLabelText="An error occurred while trying
 
        to import a description file."  />
  </ZoneTemplate>
</asp:CatalogZone>

このコードのセクションでは、UploadHelpText プロパティ値がプログラムで代入されます。

Visual Basic

Protected Sub Button1_Click(ByVal
 sender As Object, _
  ByVal e As EventArgs)
    ImportCatalogPart1.Title = "Import Server Controls"
    ImportCatalogPart1.BrowseHelpText = "Enter the path to a "
 _
      & "description file."
    ImportCatalogPart1.UploadButtonText = "Upload Description"
    ImportCatalogPart1.UploadHelpText = "Upload a description
 file."
    ImportCatalogPart1.ImportedPartLabelText = "Imported Controls"
    ImportCatalogPart1.PartImportErrorLabelText = "An error occured
 " _
      & "during the import process."
End Sub

C#

protected void Button1_Click(object sender,
 EventArgs e)
{
  ImportCatalogPart1.Title = "Import Server Controls";
  ImportCatalogPart1.BrowseHelpText = "Enter the path to a "
    + "description file.";
  ImportCatalogPart1.UploadButtonText = "Upload Description";
  ImportCatalogPart1.UploadHelpText = "Upload a description file.";
  ImportCatalogPart1.ImportedPartLabelText = "Imported Controls";
  ImportCatalogPart1.PartImportErrorLabelText = "An error occured " 
    + "during the import process.";

}

ブラウザでページを読み込む場合は、[Display Mode] ドロップダウン リスト コントロールを使って [Catalog Mode] を選択し、ページをカタログ モードに切り替えることができます。ページがカタログ モードのとき、記述ファイルがアップロードされている場合は、ImportCatalogPart コントロールのユーザー インターフェイス (UI) に各種のテキスト文字列が表示される点に注意してください。[Upload Description File] ボタンをクリックすると、UploadHelpText プロパティのテキストなど、UI の一部のプロパティのテキストが変更されます。

プラットフォーム

Windows 98, Windows 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0

参照

関連項目
ImportCatalogPart クラス
ImportCatalogPart メンバ
System.Web.UI.WebControls.WebParts 名前空間
その他の技術情報
ASP.NET Web パーツ ページ