DesignerSerializationVisibilityAttribute Klas

Definitie

public ref class DesignerSerializationVisibilityAttribute sealed : Attribute

[System.AttributeUsage(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)]
public sealed class DesignerSerializationVisibilityAttribute : Attribute

[<System.AttributeUsage(System.AttributeTargets.Method | System.AttributeTargets.Property)>]
type DesignerSerializationVisibilityAttribute = class
    inherit 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

Overname

Object

Attribute

DesignerSerializationVisibilityAttribute

Kenmerken

AttributeUsageAttribute

Voorbeelden

In het volgende codevoorbeeld ziet u hoe een DesignerSerializationVisibilityAttribute set wordt gebruikt.Content Hiermee blijven de waarden van een openbare eigenschap van een gebruikersbesturingselement behouden, die tijdens het ontwerp kunnen worden geconfigureerd. Als u het voorbeeld wilt gebruiken, compileert u eerst de volgende code in een gebruikersbeheerbibliotheek. Voeg vervolgens een verwijzing toe naar het gecompileerde .dll-bestand in een nieuw Windows Toepassingsproject. Als u Visual Studio gebruikt, wordt de ContentSerializationExampleControl automatisch toegevoegd aan de Toolbox.

Sleep het besturingselement van het Toolbox naar een formulier en stel de eigenschappen in van het DimensionData-object dat wordt vermeld in de venster Eigenschappen. Wanneer u de code voor het formulier bekijkt, is code toegevoegd aan de InitializeComponent methode van het bovenliggende formulier. Met deze code worden de waarden van de eigenschappen van het besturingselement ingesteld op de waarden die u in de ontwerpmodus hebt ingesteld.

#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

Opmerkingen

Wanneer een serializer de persistente status van een ontwerpmodusdocument behoudt, wordt vaak code toegevoegd aan de initialisatiemethode van onderdelen om waarden van eigenschappen vast te leggen die tijdens het ontwerptijd zijn ingesteld. Dit gebeurt standaard voor de meeste basistypen, als er geen kenmerk is ingesteld om ander gedrag te leiden.

Met de DesignerSerializationVisibilityAttribute, kunt u aangeven of de waarde voor een eigenschap is Visible, en moet worden bewaard in initialisatiecode, Hiddenen mag niet worden bewaard in initialisatiecode, of bestaat uit Content, die moet worden gegenereerd voor elke openbare, niet verborgen eigenschap van het object dat is toegewezen aan de eigenschap.

Leden die geen zullen hebben DesignerSerializationVisibilityAttribute , worden behandeld alsof ze een DesignerSerializationVisibilityAttribute waarde hebben van Visible. De waarden van een eigenschap die als zodanig is gemarkeerd Visible , worden geserialiseerd door een serialisatiefunctie voor het type. Als u aangepaste serialisatie voor een bepaald type of een bepaalde eigenschap wilt opgeven, gebruikt u de DesignerSerializerAttribute.

Zie Kenmerken voor meer informatie.

Zie ook

• Attribute
• PropertyDescriptor
• AttributeCollection
• PropertyDescriptorCollection
• Procedure: Verzamelingen van standaardtypen serialiseren met designerSerializationVisibilityAttribute