DesignerSerializationVisibilityAttribute Klasse

Definition

Gibt den Typ der Dauerhaftigkeit an, der bei der Serialisierung einer Eigenschaft für eine Komponente zur Entwurfszeit verwendet werden soll.Specifies the type of persistence to use when serializing a property on a component at design time.

public ref class DesignerSerializationVisibilityAttribute sealed : Attribute
[System.AttributeUsage(System.AttributeTargets.Event | System.AttributeTargets.Field | System.AttributeTargets.Method | System.AttributeTargets.Property)]
[System.AttributeUsage(System.AttributeTargets.Method | System.AttributeTargets.Property)]
public sealed class DesignerSerializationVisibilityAttribute : Attribute
type DesignerSerializationVisibilityAttribute = class
    inherit Attribute
Public NotInheritable Class DesignerSerializationVisibilityAttribute
Inherits Attribute
Vererbung
DesignerSerializationVisibilityAttribute
Attribute

Beispiele

Im folgenden Codebeispiel wird die Verwendung einer DesignerSerializationVisibilityAttribute auf Contentfestgelegten veranschaulicht.The following code example demonstrates the use of a DesignerSerializationVisibilityAttribute set to Content. Die Werte einer öffentlichen Eigenschaft eines Benutzer Steuer Elements, die zur Entwurfszeit konfiguriert werden können, werden beibehalten.It persists the values of a public property of a user control, which can be configured at design time. Um das Beispiel zu verwenden, kompilieren Sie zunächst den folgenden Code in eine Benutzer Steuerelement Bibliothek.To use the example, first compile the following code into a user control library. Fügen Sie als nächstes einen Verweis auf die kompilierte DLL-Datei in einem neuen Windows-Anwendungsprojekt hinzu.Next, add a reference to the compiled .dll file in a new Windows Application project. Wenn Sie Visual Studio verwenden, wird das ContentSerializationExampleControl automatisch der Toolboxhinzugefügt.If you are using Visual Studio, the ContentSerializationExampleControl is automatically added to the Toolbox.

Ziehen Sie das Steuerelement aus der Toolbox auf ein Formular, und legen Sie die DimensionData Eigenschaften des im Eigenschaftenfenster aufgelisteten Objekts fest.Drag the control from the Toolbox to a form, and set the properties of the DimensionData object listed in the Properties window. Wenn Sie den Code für das Formular anzeigen, wird der InitializeComponent -Methode des übergeordneten Formulars Code hinzugefügt.When you view the code for the form, code will have been added to the InitializeComponent method of the parent form. Dieser Code legt die Werte der-Eigenschaften des-Steuer Elements auf die Werte fest, die Sie im Entwurfs Modus festgelegt haben.This code sets the values of the control's properties to those which you have set in design mode.

#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 Serialisierungsprogramm den dauerhaften Zustand eines Entwurfs Modus-Dokuments beibehält, wird der Initialisierungs Methode von Komponenten häufig Code hinzugefügt, um Werte von Eigenschaften beizubehalten, die zur Entwurfszeit festgelegt wurden.When a serializer persists the persistable state of a design mode document, it often adds code to the initialization method of components to persist values of properties that have been set at design time. Dies geschieht standardmäßig für die meisten grundlegenden Typen, wenn kein Attribut für das direkte Verhalten festgelegt wurde.This happens by default for most basic types, if no attribute has been set to direct other behavior.

Mit dem DesignerSerializationVisibilityAttributekönnen Sie angeben, ob der Wert für eine-Eigenschaft Visibleist, und Hiddenim Initialisierungs Code beibehalten werden soll, und nicht Contentim Initialisierungs Code beibehalten werden sollen, oder besteht aus. Initialisierungs Code, der für jede öffentliche, nicht verborgene Eigenschaft des Objekts generiert wird, das der Eigenschaft zugewiesen ist.With the DesignerSerializationVisibilityAttribute, you can indicate whether the value for a property is Visible, and should be persisted in initialization code, Hidden, and should not be persisted in initialization code, or consists of Content, which should have initialization code generated for each public, not hidden property of the object assigned to the property.

Member, die nicht über verfügen DesignerSerializationVisibilityAttribute , werden so behandelt, als wären Sie DesignerSerializationVisibilityAttribute mit dem Wert Visible.Members that do not have a DesignerSerializationVisibilityAttribute will be treated as though they have a DesignerSerializationVisibilityAttribute with a value of Visible. Die Werte einer Eigenschaft, die als Visible markiert ist, werden, falls möglich, von einem Serialisierungsprogramm für den Typ serialisiert.The values of a property marked as Visible will be serialized, if possible, by a serializer for the type. Verwenden Sie zum Angeben der DesignerSerializerAttributebenutzerdefinierten Serialisierung für einen bestimmten Typ oder eine bestimmte Eigenschaft.To specify custom serialization for a particular type or property, use the DesignerSerializerAttribute.

Weitere Informationen finden Sie unter Attribute.For more information, see Attributes.

Konstruktoren

DesignerSerializationVisibilityAttribute(DesignerSerializationVisibility)

Initialisiert eine neue Instanz der DesignerSerializationVisibilityAttribute-Klasse unter Verwendung des angegebenen DesignerSerializationVisibility-Werts.Initializes a new instance of the DesignerSerializationVisibilityAttribute class using the specified DesignerSerializationVisibility value.

Felder

Content

Gibt an, dass ein Serialisierungsprogramm nicht die Eigenschaft selbst, sondern den Inhalt der Eigenschaft serialisieren soll.Specifies that a serializer should serialize the contents of the property, rather than the property itself. Dieses Feld ist schreibgeschützt.This field is read-only.

Default

Gibt den Standardwert Visible an, d. h. ein visueller Designer verwendet Standardregeln zum Generieren des Werts einer Eigenschaft.Specifies the default value, which is Visible, that is, a visual designer uses default rules to generate the value of a property. Dieses static-Feld ist schreibgeschützt.This static field is read-only.

Hidden

Gibt an, dass ein Serialisierungsprogramm den Wert der Eigenschaft nicht serialisieren soll.Specifies that a serializer should not serialize the value of the property. Dieses static-Feld ist schreibgeschützt.This static field is read-only.

Visible

Gibt an, dass die Serialisierung des Werts der Eigenschaft durch ein Serialisierungsprogramm zugelassen werden soll.Specifies that a serializer should be allowed to serialize the value of the property. Dieses static-Feld ist schreibgeschützt.This static field is read-only.

Eigenschaften

TypeId

Ruft bei Implementierung in einer abgeleiteten Klasse einen eindeutigen Bezeichner für dieses Attribute ab.When implemented in a derived class, gets a unique identifier for this Attribute.

(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.Gets a value indicating the basic serialization mode a serializer should use when determining whether and how to persist the value of a property.

Methoden

Equals(Object)

Gibt an, ob diese Instanz und ein angegebenes Objekt gleich sind.Indicates whether this instance and a specified object are equal.

GetHashCode()

Gibt den Hashcode für dieses Objekt zurück.Returns the hash code for this object.

GetType()

Ruft den Type der aktuellen Instanz ab.Gets the Type of the current instance.

(Geerbt von Object)
IsDefaultAttribute()

Ruft einen Wert ab, der angibt, ob der aktuelle Wert des Attributs dessen Standardwert ist.Gets a value indicating whether the current value of the attribute is the default value for the attribute.

Match(Object)

Beim Überschreiben in einer abgeleiteten Klasse wird ein Wert zurückgegeben, der angibt, ob diese Instanz einem bestimmten Objekt entspricht.When overridden in a derived class, returns a value that indicates whether this instance equals a specified object.

(Geerbt von Attribute)
MemberwiseClone()

Erstellt eine flache Kopie des aktuellen Object.Creates a shallow copy of the current Object.

(Geerbt von Object)
ToString()

Gibt eine Zeichenfolge zurück, die das aktuelle Objekt darstellt.Returns a string that represents the current object.

(Geerbt von Object)

Explizite Schnittstellenimplementierungen

_Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr)

Ordnet eine Reihe von Namen einer entsprechenden Reihe von Dispatchbezeichnern zu.Maps a set of names to a corresponding set of dispatch identifiers.

(Geerbt von Attribute)
_Attribute.GetTypeInfo(UInt32, UInt32, IntPtr)

Ruft die Typinformationen für ein Objekt ab, mit deren Hilfe die Typinformationen für eine Schnittstelle abgerufen werden können.Retrieves the type information for an object, which can be used to get the type information for an interface.

(Geerbt von Attribute)
_Attribute.GetTypeInfoCount(UInt32)

Ruft die Anzahl der Schnittstellen mit Typinformationen ab, die von einem Objekt bereitgestellt werden (0 oder 1).Retrieves the number of type information interfaces that an object provides (either 0 or 1).

(Geerbt von Attribute)
_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)

Stellt den Zugriff auf von einem Objekt verfügbar gemachte Eigenschaften und Methoden bereit.Provides access to properties and methods exposed by an object.

(Geerbt von Attribute)

Gilt für:

Siehe auch