DesignerSerializationVisibilityAttribute Класс

Определение

Пространство имен:

System.ComponentModel

Сборки:

netstandard.dll, System.ComponentModel.Primitives.dll

Исходный код:

DesignerSerializationVisibilityAttribute.cs

Указывает тип сохраняемости, используемый при сериализации свойства в компоненте во время разработки.

public ref class DesignerSerializationVisibilityAttribute sealed : Attribute

[System.AttributeUsage(System.AttributeTargets.Event | System.AttributeTargets.Field | System.AttributeTargets.Method | System.AttributeTargets.Property)]
public sealed class DesignerSerializationVisibilityAttribute : Attribute

[<System.AttributeUsage(System.AttributeTargets.Event | System.AttributeTargets.Field | System.AttributeTargets.Method | System.AttributeTargets.Property)>]
type DesignerSerializationVisibilityAttribute = class
    inherit Attribute

Public NotInheritable Class DesignerSerializationVisibilityAttribute
Inherits Attribute

Наследование

Object

Attribute

DesignerSerializationVisibilityAttribute

Атрибуты

AttributeUsageAttribute

Примеры

В следующем примере кода показано использование DesignerSerializationVisibilityAttribute набора Content. Он сохраняет значения общедоступного свойства пользовательского элемента управления, которое можно настроить во время разработки. Чтобы использовать пример, сначала скомпилируйте следующий код в библиотеку пользовательского элемента управления. Затем добавьте ссылку на скомпилированный файл .dll в новом проекте приложения Windows. Если вы используете Visual Studio, ContentSerializationExampleControl автоматически добавляется в Toolbox.

Перетащите элемент управления из Toolbox в форму и задайте свойства объекта DimensionData, перечисленных в окно свойств. При просмотре кода формы код будет добавлен в InitializeComponent метод родительской формы. Этот код задает значения свойств элемента управления тем, которые вы установили в режиме конструктора.

#using <System.Windows.Forms.dll>
#using <System.Drawing.dll>
#using <System.dll>

using namespace System;
using namespace System::Collections;
using namespace System::ComponentModel;
using namespace System::ComponentModel::Design;
using namespace System::Drawing;
using namespace System::Windows::Forms;

// This attribute indicates that the public properties of this object should be listed in the property grid.

[TypeConverterAttribute(System::ComponentModel::ExpandableObjectConverter::typeid)]
public ref class DimensionData
{
private:
   Control^ owner;

internal:

   // This class reads and writes the Location and Size properties from the Control which it is initialized to.
   DimensionData( Control^ owner )
   {
      this->owner = owner;
   }

public:

   property Point Location 
   {
      Point get()
      {
         return owner->Location;
      }

      void set( Point value )
      {
         owner->Location = value;
      }

   }

   property Size FormSize 
   {
      Size get()
      {
         return owner->Size;
      }

      void set( Size value )
      {
         owner->Size = value;
      }
   }
};

// The code for this user control declares a public property of type DimensionData with a DesignerSerializationVisibility 
// attribute set to DesignerSerializationVisibility.Content, indicating that the properties of the object should be serialized.
// The public, not hidden properties of the object that are set at design time will be persisted in the initialization code
// for the class object. Content persistence will not work for structs without a custom TypeConverter.  
public ref class ContentSerializationExampleControl: public System::Windows::Forms::UserControl
{
private:
   System::ComponentModel::Container^ components;

public:

   property DimensionData^ Dimensions 
   {
      [DesignerSerializationVisibility(DesignerSerializationVisibility::Content)]
      DimensionData^ get()
      {
         return gcnew DimensionData( this );
      }
   }
   ContentSerializationExampleControl()
   {
      InitializeComponent();
   }

public:
   ~ContentSerializationExampleControl()
   {
      if ( components != nullptr )
      {
         delete components;
      }
   }

private:
   void InitializeComponent()
   {
      components = gcnew System::ComponentModel::Container;
   }
};

using System.ComponentModel;
using System.Drawing;
using System.Windows.Forms;

namespace DesignerSerializationVisibilityTest;

// The code for this user control declares a public property of type DimensionData with a DesignerSerializationVisibility
// attribute set to DesignerSerializationVisibility.Content, indicating that the properties of the object should be serialized.

// The public, not hidden properties of the object that are set at design time will be persisted in the initialization code
// for the class object. Content persistence will not work for structs without a custom TypeConverter.

public class ContentSerializationExampleControl : UserControl
{
    Container components;

    [DesignerSerializationVisibility(DesignerSerializationVisibility.Content)]
    public DimensionData Dimensions => new(this);

    public ContentSerializationExampleControl() => InitializeComponent();

    protected override void Dispose(bool disposing)
    {
        if (disposing)
        {
            components?.Dispose();
        }
        base.Dispose(disposing);
    }

    void InitializeComponent() => components = new Container();
}

[TypeConverter(typeof(ExpandableObjectConverter))]
// This attribute indicates that the public properties of this object should be listed in the property grid.
public class DimensionData
{
    readonly Control owner;

    // This class reads and writes the Location and Size properties from the Control which it is initialized to.
    internal DimensionData(Control owner) => this.owner = owner;

    public Point Location
    {
        get => owner.Location;
        set => owner.Location = value;
    }

    public Size FormSize
    {
        get => owner.Size;
        set => owner.Size = value;
    }
}

Imports System.Collections
Imports System.ComponentModel
Imports System.ComponentModel.Design
Imports System.Drawing
Imports System.Windows.Forms

Namespace DesignerSerializationVisibilityTest
    _
    ' The code for this user control declares a public property of type DimensionData with a DesignerSerializationVisibility 
    ' attribute set to DesignerSerializationVisibility.Content, indicating that the properties of the object should be serialized.

    ' The public, not hidden properties of the object that are set at design time will be persisted in the initialization code
    ' for the class object. Content persistence will not work for structs without a custom TypeConverter.		
    Public Class ContentSerializationExampleControl
        Inherits System.Windows.Forms.UserControl
        Private components As System.ComponentModel.Container = Nothing


        <DesignerSerializationVisibility(DesignerSerializationVisibility.Content)> _
        Public ReadOnly Property Dimensions() As DimensionData
            Get
                Return New DimensionData(Me)
            End Get
        End Property


        Public Sub New()
            InitializeComponent()
        End Sub


        Protected Overloads Sub Dispose(ByVal disposing As Boolean)
            If disposing Then
                If (components IsNot Nothing) Then
                    components.Dispose()
                End If
            End If
            MyBase.Dispose(disposing)
        End Sub


        Private Sub InitializeComponent()
        End Sub
    End Class

    ' This attribute indicates that the public properties of this object should be listed in the property grid.
   <TypeConverterAttribute(GetType(System.ComponentModel.ExpandableObjectConverter))> _   
    Public Class DimensionData
        Private owner As Control

        ' This class reads and writes the Location and Size properties from the Control which it is initialized to.
        Friend Sub New(ByVal owner As Control)
            Me.owner = owner
        End Sub


        Public Property Location() As Point
            Get
                Return owner.Location
            End Get
            Set(ByVal Value As Point)
                owner.Location = Value
            End Set
        End Property


        Public Property FormSize() As Size
            Get
                Return owner.Size
            End Get
            Set(ByVal Value As Size)
                owner.Size = Value
            End Set
        End Property
    End Class
End Namespace 'DesignerSerializationVisibilityTest

Комментарии

При сохранении сохраняемого состояния документа режима разработки сериализатор часто добавляет код в метод инициализации компонентов для сохранения значений свойств, заданных во время разработки. Это происходит по умолчанию для большинства основных типов, если атрибут не задан для прямого другого поведения.

DesignerSerializationVisibilityAttributeС помощью функции можно указать, является Visibleли значение свойства и должно быть сохранено в коде Hiddenинициализации, и не следует сохраняться в коде инициализации или Contentсостоит из него, который должен иметь код инициализации, созданный для каждого общедоступного, а не скрытого свойства объекта, назначенного свойству.

Члены, у которых нет, DesignerSerializationVisibilityAttribute будут рассматриваться, как если бы они имели DesignerSerializationVisibilityAttribute значение Visible. Значения свойства, помеченного как Visible сериализуемые по возможности, сериализатором для типа. Чтобы указать настраиваемую сериализацию для определенного типа или свойства, используйте параметр DesignerSerializerAttribute.

Дополнительные сведения см. в разделе Атрибуты.

Конструкторы

Имя	Описание
DesignerSerializationVisibilityAttribute(DesignerSerializationVisibility)	Инициализирует новый экземпляр класса с помощью указанного DesignerSerializationVisibilityAttributeDesignerSerializationVisibility значения.

Поля

Имя	Описание
Content	Указывает, что сериализатор должен сериализовать содержимое свойства, а не самого свойства. Это поле доступно только для чтения.
Default	Указывает значение по умолчанию, то Visibleесть визуальный конструктор использует правила по умолчанию для создания значения свойства. Это static поле доступно только для чтения.
Hidden	Указывает, что сериализатор не должен сериализовать значение свойства. Это static поле доступно только для чтения.
Visible	Указывает, что сериализатор должен быть разрешен для сериализации значения свойства. Это static поле доступно только для чтения.

Свойства

Имя	Описание
TypeId	При реализации в производном классе получает уникальный идентификатор для этого Attribute. (Унаследовано от Attribute)
Visibility	Возвращает значение, указывающее базовый режим сериализации, который сериализатор должен использовать при определении того, следует ли и как сохранить значение свойства.

Методы

Имя	Описание
Equals(Object)	Указывает, равны ли этот экземпляр и указанный объект.
GetHashCode()	Возвращает хэш-код для этого объекта.
GetType()	Возвращает Type текущего экземпляра. (Унаследовано от Object)
IsDefaultAttribute()	Возвращает значение, указывающее, является ли текущее значение атрибута значением по умолчанию для атрибута.
Match(Object)	При переопределении в производном классе возвращает значение, указывающее, равен ли этот экземпляр указанному объекту. (Унаследовано от Attribute)
MemberwiseClone()	Создает неглубокую копию текущей Object. (Унаследовано от Object)
ToString()	Возвращает строку, представляющую текущий объект. (Унаследовано от Object)

См. также раздел

• Attribute
• PropertyDescriptor
• AttributeCollection
• PropertyDescriptorCollection