演练：使用 DesignerSerializationVisibilityAttribute 序列化标准类型的集合

更新：2007 年 11 月

有时您的自定义控件会将一个集合作为属性公开。本演练演示如何使用 DesignerSerializationVisibilityAttribute 类控制在设计时序列化集合的方式。将 Content 值应用于您的集合属性可确保序列化属性。

若要将此主题中的代码作为单个清单进行复制，请参见 如何：使用 DesignerSerializationVisibilityAttribute 序列化标准类型的集合。

说明：
显示的对话框和菜单命令可能会与“帮助”中的描述不同，具体取决于您的当前设置或版本。若要更改设置，请在“工具”菜单上选择“导入和导出设置”。有关更多信息，请参见 Visual Studio 设置。

先决条件

若要完成本演练，您需要：

• 足够的权限，以便能够在安装 Visual Studio 的计算机上创建和运行 Windows 窗体应用程序项目。

创建具有可序列化集合的控件

第一步是创建一个将可序列化集合作为属性的控件。可以使用“集合编辑器”编辑此集合的内容，该编辑器可以从“属性”窗口访问。

创建具有可序列化集合的控件

1. 创建一个名为 SerializationDemoControlLib 的 Windows 控件库项目。有关更多信息，请参见 Windows 控件库模板。

2. 将 UserControl1 重命名为 SerializationDemoControl。有关更多信息，请参见 如何：重命名标识符。

3. 在“属性”窗口中，将 Padding.All 属性的值设置为 10。

4. 在 SerializationDemoControl 中放置一个 TextBox 控件。

5. 选择 TextBox 控件。在“属性”窗口中，设置下列属性。

   属性	更改为
   Multiline	true
   Dock	Fill
   ScrollBars	Vertical
   ReadOnly	true

6. 在“代码编辑器”中，在 SerializationDemoControl 内声明一个名为 stringsValue 的字符串数组字段。

   ' 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;
   
   
   

7. 在 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 窗体设计器”会将代码发送至该文件中。

序列化集合

1. 将 Windows 应用程序项目添加到解决方案。有关更多信息，请参见“添加新项目”对话框。将项目命名为 SerializationDemoControlTest。

2. 在“工具箱”中找到名为“SerializationDemoControlLib 组件”的选项卡。在此选项卡可找到 SerializationDemoControl。有关更多信息，请参见演练：使用自定义组件自动填充工具箱。

3. 将 SerializationDemoControl 置于窗体中。

4. 在“属性”窗口中找到 Strings 属性。单击 Strings 属性，再单击省略号 () 按钮，以打开“字符串集合编辑器”。

5. 在“字符串集合编辑器”中键入几个字符串。在每个字符串的结尾按 Enter 键来分隔各字符串。字符串输入完成后，单击“确定”。

说明：
您键入的字符串将出现在 SerializationDemoControl 的 TextBox 中。

1. 在“解决方案资源管理器”中单击“显示全部文件”按钮。

2. 打开“Form1”节点。此节点下面是一个名为“Form1.Designer.cs”或“Form1.Designer.vb”的文件。“Windows 窗体设计器”将表示您的窗体及其子控件的设计时状态的代码发送至此文件。在“代码编辑器”中打开此文件。

3. 打开名为“Windows 窗体设计器生成的代码”的区域并找到标志为“serializationDemoControl1”的部分。在此标签下是表示您的控件的已序列化状态的代码。您在步骤 5 中键入的字符串会出现在对 Strings 属性的赋值中。下面的代码示例演示类似于您在键入字符串“red”、“orange”和“yellow”后将看到的代码。

4. [Visual Basic]

   Me.serializationDemoControl1.Strings = New String() {"red", "orange", "yellow"}
   

5. [C#]

   this.serializationDemoControl1.Strings = new string[] {
           "red",
           "orange",
           "yellow"};
   

6. 在“代码编辑器”中，将 Strings 属性上的 DesignerSerializationVisibilityAttribute 值更改为 Hidden。

7. [Visual Basic]

   <DesignerSerializationVisibility(DesignerSerializationVisibility.Hidden)> _
   

8. [C#]

   [DesignerSerializationVisibility(DesignerSerializationVisibility.Hidden)]
   

9. 重新生成解决方案并重复步骤 4 至 8。

说明：
在这种情况中，“Windows 窗体设计器”不向 Strings 属性发出赋值。

后续步骤

了解了如何序列化标准类型的集合以后，可考虑将自定义控件更深入地集成到设计时环境中。下列主题介绍如何增强自定义控件的设计时集成：

• 设计时结构

• Windows 窗体控件中的属性

• 设计器序列化概述

• 演练：创建一个利用 Visual Studio 设计时功能的 Windows 窗体控件

请参见

任务

如何：使用 DesignerSerializationVisibilityAttribute 序列化标准类型的集合

演练：使用自定义组件自动填充工具箱

概念

设计器序列化概述

参考

DesignerSerializationVisibilityAttribute