チュートリアル : DesignerSerializationVisibilityAttribute を使用した、標準データ型のコレクションのシリアル化
更新 : 2007 年 11 月
カスタム コントロールは、コレクションをプロパティとして公開することがあります。このチュートリアルでは、DesignerSerializationVisibilityAttribute クラスを使用して、デザイン時にコレクションのシリアル化を制御する方法について説明します。コレクション プロパティに Content 値を適用すると、プロパティが確実にシリアル化されます。
このトピックのコードを単一のリストとしてコピーするには、「方法 : 標準の型のコレクションを DesignerSerializationVisibilityAttribute でシリアル化する」を参照してください。
.gif "メモ") メモ : |
|---|
使用している設定またはエディションによっては、表示されるダイアログ ボックスやメニュー コマンドがヘルプに記載されている内容と異なる場合があります。設定を変更するには、[ツール] メニューの [設定のインポートとエクスポート] をクリックします。詳細については、「Visual Studio の設定」を参照してください。 |
前提条件
このチュートリアルを実行するための要件は次のとおりです。
- Visual Studio がインストールされているコンピュータで、Windows フォーム アプリケーション プロジェクトを作成および実行するための十分なアクセス許可が付与されていること。
シリアル化可能なコレクションを持つコントロールの作成
最初に、シリアル化可能なコレクションをプロパティとして持つコントロールを作成します。このコレクションの内容は、コレクション エディタを使用して編集できます。コレクション エディタには、[プロパティ] ウィンドウがからアクセスできます。
シリアル化可能なコレクションを持つコントロールを作成するには
SerializationDemoControlLib という名前の Windows コントロール ライブラリ プロジェクトを作成します。詳細については、「Windows コントロール ライブラリ テンプレート」を参照してください。
UserControl1 の名前を SerializationDemoControl に変更します。詳細については、「方法 : 識別子の名前を変更する」を参照してください。
[プロパティ] ウィンドウで、Padding.All プロパティの値を 10 に設定します。
TextBox コントロールを SerializationDemoControl に配置します。
TextBox コントロールを選択します。[プロパティ] ウィンドウで、次のプロパティを設定します。
プロパティ
変更後の値
Multiline
true
Dock
ScrollBars
ReadOnly
true
コード エディタを使用して、stringsValue という名前の文字列配列フィールドを SerializationDemoControl で宣言します。
' This field backs the Strings property. Private stringsValue(1) As String// This field backs the Strings property. private String[] stringsValue = new String[1];// This field backs the Strings property. private: array<String^>^ stringsValue;SerializationDemoControl の Strings プロパティを定義します。
| メモ : |
|---|
Content 値を使用して、コレクションのシリアル化を有効にします。 |
' When the DesignerSerializationVisibility attribute has
' a value of "Content" or "Visible" the designer will
' serialize the property. This property can also be edited
' at design time with a CollectionEditor.
<DesignerSerializationVisibility( _
DesignerSerializationVisibility.Content)> _
Public Property Strings() As String()
Get
Return Me.stringsValue
End Get
Set(ByVal value As String())
Me.stringsValue = Value
' Populate the contained TextBox with the values
' in the stringsValue array.
Dim sb As New StringBuilder(Me.stringsValue.Length)
Dim i As Integer
For i = 0 To (Me.stringsValue.Length) - 1
sb.Append(Me.stringsValue(i))
sb.Append(ControlChars.Cr + ControlChars.Lf)
Next i
Me.textBox1.Text = sb.ToString()
End Set
End Property
// When the DesignerSerializationVisibility attribute has
// a value of "Content" or "Visible" the designer will
// serialize the property. This property can also be edited
// at design time with a CollectionEditor.
[DesignerSerializationVisibility(
DesignerSerializationVisibility.Content )]
public String[] Strings
{
get
{
return this.stringsValue;
}
set
{
this.stringsValue = value;
// Populate the contained TextBox with the values
// in the stringsValue array.
StringBuilder sb =
new StringBuilder(this.stringsValue.Length);
for (int i = 0; i < this.stringsValue.Length; i++)
{
sb.Append(this.stringsValue[i]);
sb.Append("\r\n");
}
this.textBox1.Text = sb.ToString();
}
}
// When the DesignerSerializationVisibility attribute has
// a value of "Content" or "Visible" the designer will
// serialize the property. This property can also be edited
// at design time with a CollectionEditor.
public:
[DesignerSerializationVisibility(
DesignerSerializationVisibility::Content)]
property array<String^>^ Strings
{
array<String^>^ get()
{
return this->stringsValue;
}
void set(array<String^>^ value)
{
this->stringsValue = value;
// Populate the contained TextBox with the values
// in the stringsValue array.
StringBuilder^ sb =
gcnew StringBuilder(this->stringsValue->Length);
for (int i = 0; i < this->stringsValue->Length; i++)
{
sb->Append(this->stringsValue[i]);
sb->Append(Environment::NewLine);
}
this->demoControlTextBox->Text = sb->ToString();
}
}
| メモ : |
|---|
入力した文字列が SerializationDemoControl の TextBox に表示されます。 |
コレクション プロパティのシリアル化
コントロールのシリアル化動作をテストするには、コントロールをフォームに配置し、コレクション エディタを使用してコレクションの内容を変更します。シリアル化されたコレクションの状態は、Windows フォーム デザイナによるコードの出力先となる特別なデザイナ ファイルで確認できます。
コレクションをシリアル化するには
Windows アプリケーション プロジェクトをソリューションに追加します。詳細については、「[新しいプロジェクトの追加] ダイアログ ボックス」を参照してください。プロジェクトに SerializationDemoControlTest という名前を付けます。
[ツールボックス] で、[SerializationDemoControlLib コンポーネント] という名前のタブを見つけます。このタブで、SerializationDemoControl を探します。詳細については、「チュートリアル : ツールボックスへのカスタム コンポーネントの自動設定」を参照してください。
SerializationDemoControl をフォームに配置します。
[プロパティ] ウィンドウで、Strings プロパティを見つけます。Strings プロパティをクリックし、省略記号ボタン (
.gif)
) をクリックして、文字列コレクション エディタを開きます。文字列コレクション エディタにいくつかの文字列を入力します。各文字列の末尾で Enter キーを押して区切ります。文字列を入力したら、[OK] をクリックします。
| メモ : |
|---|
入力した文字列が SerializationDemoControl の TextBox に表示されます。 |
ソリューション エクスプローラの [すべてのファイルを表示] をクリックします。
[Form1] ノードを開きます。このノードの下に、Form1.Designer.cs または Form1.Designer.vb というファイルが表示されます。Windows フォーム デザイナは、このファイルにフォームと子コントロールのデザイン時の状態を表すコードを出力します。コード エディタでこのファイルを開きます。
Windows Form Designer generated code という領域を開き、serializationDemoControl1 というラベルが付けられたセクションを見つけます。このラベルの下が、コントロールのシリアル化状態を表すコードです。手順 5. で入力した文字列が、Strings プロパティへの代入として表示されます。たとえば、文字列として "red"、"orange"、および "yellow" を入力した場合には、次のようなコードが表示されます。
[Visual Basic]
Me.serializationDemoControl1.Strings = New String() {"red", "orange", "yellow"}[C#]
this.serializationDemoControl1.Strings = new string[] { "red", "orange", "yellow"};コード エディタで、Strings プロパティの DesignerSerializationVisibilityAttribute の値を Hidden に変更します。
[Visual Basic]
<DesignerSerializationVisibility(DesignerSerializationVisibility.Hidden)> _[C#]
[DesignerSerializationVisibility(DesignerSerializationVisibility.Hidden)]ソリューションを再度ビルドし、手順 4. から 8. を繰り返します。
| メモ : |
|---|
この場合、Windows フォーム デザイナは、Strings プロパティへの代入を出力しません。 |
次の手順
標準データ型のコレクションをシリアル化する方法がわかったら、カスタム コントロールをデザイン時環境により深く統合することを検討してください。以下のトピックでは、カスタム コントロールのデザイン時の統合を強化する方法について説明しています。
参照
処理手順
方法 : 標準の型のコレクションを DesignerSerializationVisibilityAttribute でシリアル化する
チュートリアル : ツールボックスへのカスタム コンポーネントの自動設定