DesignerSerializationVisibilityAttribute Osztály

Definíció

Névtér:

System.ComponentModel

Szerelvények:

netstandard.dll, System.ComponentModel.Primitives.dll

Forrás:

DesignerSerializationVisibilityAttribute.cs

Meghatározza, hogy milyen típusú adatmegőrzést használjon egy összetevő tulajdonságának szerializálása a tervezéskor.

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

Öröklődés

Object

Attribute

DesignerSerializationVisibilityAttribute

Attribútumok

AttributeUsageAttribute

Példák

Az alábbi példakód bemutatja a következő halmaz használatát: .> Megőrzi egy felhasználói vezérlő nyilvános tulajdonságának értékeit, amely a tervezéskor konfigurálható. A példa használatához először fordítsa le a következő kódot egy felhasználói vezérlőtárba. Ezután adjon hozzá egy hivatkozást a lefordított .dll fájlhoz egy új Windows alkalmazásprojektben. Ha Visual Studio használ, a ContentSerializationExampleControl automatikusan hozzáadódik a Toolbox.

Húzza a vezérlőt a Toolbox egy űrlapra, és állítsa be a Tulajdonságok ablak felsorolt DimensionData objektum tulajdonságait. Az űrlap kódjának megtekintésekor a rendszer hozzáadja a kódot a InitializeComponent szülőűrlap metódusához. Ez a kód a vezérlő tulajdonságainak értékeit a tervező módban beállított értékekre állítja.

#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

Megjegyzések

Ha a szerializáló megőrzi egy tervezési módú dokumentum megőrizhető állapotát, gyakran kódot ad hozzá az összetevők inicializálási módszeréhez, hogy megőrizze a tervezési időben beállított tulajdonságok értékeit. Ez alapértelmezés szerint a legtöbb alaptípus esetében fordul elő, ha nincs olyan attribútum, amely más viselkedést irányít.

DesignerSerializationVisibilityAttributeA beállítással jelezheti, hogy egy tulajdonság Visibleértéke az, és az inicializálási kódban kell-e megmaradnia, Hiddenés nem szabad az inicializálási kódban megmaradnia, vagy olyan elemekből állContent, amelyeknek inicializálási kóddal kell rendelkezniük minden egyes nyilvános objektumhoz, nem pedig a tulajdonsághoz rendelt objektum rejtett tulajdonságának.

A nem rendelkező DesignerSerializationVisibilityAttribute tagok úgy lesznek kezelve, mintha értékük DesignerSerializationVisibilityAttributelenneVisible. Ha lehetséges, a típus szerializálója szerializálja a tulajdonságként Visible megjelölt értékeket. Ha egyéni szerializálást szeretne megadni egy adott típushoz vagy tulajdonsághoz, használja a DesignerSerializerAttribute.

További információ: Attribútumok.

Konstruktorok

Name	Description
DesignerSerializationVisibilityAttribute(DesignerSerializationVisibility)	Inicializálja az osztály új példányát DesignerSerializationVisibilityAttribute a megadott DesignerSerializationVisibility érték használatával.

Mezők

Name	Description
Content	Azt határozza meg, hogy a szerializálónak szerializálnia kell a tulajdonság tartalmát, nem pedig magát a tulajdonságot. Ez a mező csak olvasható.
Default	Megadja az alapértelmezett értéket, azaz Visibleegy vizualizációtervező alapértelmezett szabályokat használ egy tulajdonság értékének létrehozásához. Ez static a mező írásvédett.
Hidden	Azt határozza meg, hogy a szerializáló ne szerializálja a tulajdonság értékét. Ez static a mező írásvédett.
Visible	Megadja, hogy a szerializálónak engedélyeznie kell a tulajdonság értékének szerializálását. Ez static a mező írásvédett.

Tulajdonságok

Name	Description
TypeId	Ha származtatott osztályban implementálják, ehhez egy egyedi azonosítót Attributekap. (Öröklődés forrása Attribute)
Visibility	Egy olyan értéket kap, amely azt jelzi, hogy a szerializálónak milyen alapszintű szerializálási módot kell használnia annak meghatározásához, hogy egy tulajdonság értéke megőrizve van-e és hogyan.

Metódusok

Name	Description
Equals(Object)	Azt jelzi, hogy ez a példány és egy megadott objektum egyenlő-e.
GetHashCode()	Az objektum kivonatkódját adja vissza.
GetType()	Lekéri az Type aktuális példányt. (Öröklődés forrása Object)
IsDefaultAttribute()	Beolvas egy értéket, amely jelzi, hogy az attribútum aktuális értéke-e az attribútum alapértelmezett értéke.
Match(Object)	Származtatott osztály felülírásakor egy olyan értéket ad vissza, amely jelzi, hogy ez a példány egy adott objektummal egyenlő-e. (Öröklődés forrása Attribute)
MemberwiseClone()	Az aktuális Objectpéldány sekély másolatát hozza létre. (Öröklődés forrása Object)
ToString()	Az aktuális objektumot jelképező sztringet ad vissza. (Öröklődés forrása Object)

Lásd még

• Attribute
• PropertyDescriptor
• AttributeCollection
• PropertyDescriptorCollection
• Útmutató: Standard típusú gyűjtemények szerializálása a DesignerSerializationVisibilityAttribute használatával