DesignerSerializationVisibilityAttribute Klasse

Definition

Namespace:

System.ComponentModel

Assembly:

System.ComponentModel.Primitives.dll

Quelle:

DesignerSerializationVisibilityAttribute.cs

Gibt den Typ der Dauerhaftigkeit an, der bei der Serialisierung einer Eigenschaft für eine Komponente zur Entwurfszeit verwendet werden soll.

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

Vererbung

Object

Attribute

DesignerSerializationVisibilityAttribute

Attribute

AttributeUsageAttribute

Beispiele

Im folgenden Codebeispiel wird die Verwendung einer DesignerSerializationVisibilityAttribute Gruppe auf Contentveranschaulicht. Die Werte einer öffentlichen Eigenschaft eines Benutzersteuerelements, die zur Entwurfszeit konfiguriert werden können, werden beibehalten. Um das Beispiel zu verwenden, kompilieren Sie zunächst den folgenden Code in eine Benutzersteuerelementbibliothek. Fügen Sie als Nächstes einen Verweis auf die kompilierte .dll-Datei in einem neuen Windows-Anwendungsprojekt hinzu. Wenn Sie Visual Studio verwenden, wird automatisch ContentSerializationExampleControl der Toolbox hinzugefügt.

Ziehen Sie das Steuerelement aus der Toolbox in ein Formular, und legen Sie die Eigenschaften des DimensionData im Eigenschaftenfenster aufgeführten Objekts fest. Wenn Sie den Code für das Formular anzeigen, wurde der -Methode des InitializeComponent übergeordneten Formulars Code hinzugefügt. Dieser Code legt die Werte der Eigenschaften des Steuerelements auf die Werte fest, die Sie im Entwurfsmodus festgelegt haben.

#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;
using System.Collections;
using System.ComponentModel;
using System.ComponentModel.Design;
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 : System.Windows.Forms.UserControl
    {
    private System.ComponentModel.Container components = null;				
    
    [DesignerSerializationVisibility(DesignerSerializationVisibility.Content)]
    public DimensionData Dimensions
    {
        get 
        {
        return new DimensionData(this);
        }		
    }

    public ContentSerializationExampleControl()
    {
            InitializeComponent();		
    }
        
    protected override void Dispose( bool disposing )
    {
        if( disposing )
        {
        if( components != null )
            components.Dispose();
        }
        base.Dispose( disposing );
    }

    private void InitializeComponent()
    {
        components = new System.ComponentModel.Container();
    }
    }

    [TypeConverterAttribute(typeof(System.ComponentModel.ExpandableObjectConverter))]
    // This attribute indicates that the public properties of this object should be listed in the property grid.
    public class DimensionData
    {		
    private 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
        {
        return owner.Location;
        }
        set
        {
        owner.Location = value;
        }
    }

    public Size FormSize
    {
        get
            {
        return 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

Hinweise

Wenn ein Serialisierer den dauerhaften Zustand eines Entwurfsmodusdokuments beibehalten, fügt er der Initialisierungsmethode von Komponenten häufig Code hinzu, um Werte von Eigenschaften beizubehalten, die zur Entwurfszeit festgelegt wurden. Dies geschieht standardmäßig für die meisten grundlegenden Typen, wenn kein Attribut auf andere Verhaltensweisen festgelegt wurde.

DesignerSerializationVisibilityAttributeMit können Sie angeben, ob der Wert für eine Eigenschaft ist Visibleund im Initialisierungscode beibehalten werden soll, Hiddenund nicht im Initialisierungscode beibehalten werden soll, oder ob der Initialisierungscode Contentfür jede öffentliche, nicht ausgeblendete Eigenschaft des Objekts generiert werden soll, das der Eigenschaft zugewiesen ist.

Member, die nicht über einen DesignerSerializationVisibilityAttribute verfügen, werden so behandelt, als hätten sie einen DesignerSerializationVisibilityAttribute mit dem Wert .Visible Die Werte einer als Visible markierten Eigenschaft werden nach Möglichkeit von einem Serialisierer für den Typ serialisiert. Um die benutzerdefinierte Serialisierung für einen bestimmten Typ oder eine bestimmte Eigenschaft anzugeben, verwenden Sie die DesignerSerializerAttribute.

Weitere Informationen finden Sie unter Attribute.

Konstruktoren

DesignerSerializationVisibilityAttribute(DesignerSerializationVisibility)

Initialisiert eine neue Instanz der DesignerSerializationVisibilityAttribute-Klasse unter Verwendung des angegebenen DesignerSerializationVisibility-Werts.

Felder

Content	Gibt an, dass ein Serialisierungsprogramm nicht die Eigenschaft selbst, sondern den Inhalt der Eigenschaft serialisieren soll. Dieses Feld ist schreibgeschützt.
Default	Gibt den Standardwert Visible an, d. h. ein visueller Designer verwendet Standardregeln zum Generieren des Werts einer Eigenschaft. Dieses static-Feld ist schreibgeschützt.
Hidden	Gibt an, dass ein Serialisierungsprogramm den Wert der Eigenschaft nicht serialisieren soll. Dieses static-Feld ist schreibgeschützt.
Visible	Gibt an, dass die Serialisierung des Werts der Eigenschaft durch ein Serialisierungsprogramm zugelassen werden soll. Dieses static-Feld ist schreibgeschützt.

Eigenschaften

TypeId	Ruft bei Implementierung in einer abgeleiteten Klasse einen eindeutigen Bezeichner für dieses Attribute ab. (Geerbt von Attribute)
Visibility	Ruft einen Wert ab, der den grundlegenden Serialisierungsmodus angibt, den ein Serialisierungsprogramm verwenden soll, wenn bestimmt wird, ob und wie der Wert einer Eigenschaft beibehalten wird.

Methoden

Equals(Object)	Gibt an, ob diese Instanz und ein angegebenes Objekt gleich sind.
GetHashCode()	Gibt den Hashcode für dieses Objekt zurück.
GetType()	Ruft den Type der aktuellen Instanz ab. (Geerbt von Object)
IsDefaultAttribute()	Ruft einen Wert ab, der angibt, ob der aktuelle Wert des Attributs dessen Standardwert ist.
Match(Object)	Beim Überschreiben in einer abgeleiteten Klasse wird ein Wert zurückgegeben, der angibt, ob diese Instanz einem bestimmten Objekt entspricht. (Geerbt von Attribute)
MemberwiseClone()	Erstellt eine flache Kopie des aktuellen Object. (Geerbt von Object)
ToString()	Gibt eine Zeichenfolge zurück, die das aktuelle Objekt darstellt. (Geerbt von Object)

Weitere Informationen

• Attribute
• PropertyDescriptor
• AttributeCollection
• PropertyDescriptorCollection
• Gewusst wie: Serialisieren von Auflistungen der Standardtypen mit dem DesignerSerializationVisibilityAttribute