DesignerSerializationVisibilityAttribute Klasa

Definicja

Określa typ trwałości do użycia podczas serializacji właściwości w składniku w czasie projektowania.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)]
public sealed class DesignerSerializationVisibilityAttribute : Attribute
public sealed class DesignerSerializationVisibilityAttribute : 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)>]
type DesignerSerializationVisibilityAttribute = class
    inherit Attribute
type DesignerSerializationVisibilityAttribute = class
    inherit Attribute
[<System.AttributeUsage(System.AttributeTargets.Method | System.AttributeTargets.Property)>]
type DesignerSerializationVisibilityAttribute = class
    inherit Attribute
Public NotInheritable Class DesignerSerializationVisibilityAttribute
Inherits Attribute
Dziedziczenie
DesignerSerializationVisibilityAttribute
Atrybuty

Przykłady

Poniższy przykład kodu demonstruje użycie DesignerSerializationVisibilityAttribute zestawu do Content .The following code example demonstrates the use of a DesignerSerializationVisibilityAttribute set to Content. Zachowuje ona wartości właściwości publicznej kontrolki użytkownika, którą można skonfigurować w czasie projektowania.It persists the values of a public property of a user control, which can be configured at design time. Aby użyć tego przykładu, należy najpierw skompilować następujący kod do biblioteki kontrolki użytkownika.To use the example, first compile the following code into a user control library. Następnie Dodaj odwołanie do skompilowanego pliku DLL w nowym projekcie aplikacji systemu Windows.Next, add a reference to the compiled .dll file in a new Windows Application project. Jeśli używasz programu Visual Studio, jest on ContentSerializationExampleControl automatycznie dodawany do przybornika.If you are using Visual Studio, the ContentSerializationExampleControl is automatically added to the Toolbox.

Przeciągnij formant z przybornika do formularza i ustaw właściwości DimensionData obiektu wymienionego w okno właściwości.Drag the control from the Toolbox to a form, and set the properties of the DimensionData object listed in the Properties window. Podczas wyświetlania kodu formularza, kod zostanie dodany do InitializeComponent metody formularza nadrzędnego.When you view the code for the form, code will have been added to the InitializeComponent method of the parent form. Ten kod ustawia wartości właściwości kontrolki na te, które zostały ustawione w trybie projektowania.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

Uwagi

Gdy serializator utrzymuje stan trwały dokumentu trybu projektowania, często dodaje kod do metody inicjującej składników, aby utrzymać wartości właściwości, które zostały ustawione w czasie projektowania.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. Jest to wykonywane domyślnie w przypadku większości typów podstawowych, jeśli żaden atrybut nie został ustawiony do bezpośredniego inne zachowanie.This happens by default for most basic types, if no attribute has been set to direct other behavior.

Za pomocą DesignerSerializationVisibilityAttribute , można wskazać, czy wartość właściwości jest Visible , i powinna być utrwalana w kodzie inicjującym, Hidden i nie powinna być utrwalana w kodzie inicjującym lub składa się z Content , który powinien mieć kod inicjujący wygenerowany dla każdej publicznej, nieukrytej właściwości obiektu przypisanego do właściwości.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.

Elementy członkowskie, które nie mają, DesignerSerializationVisibilityAttribute będą traktowane jako chociaż mają DesignerSerializationVisibilityAttribute wartość Visible .Members that do not have a DesignerSerializationVisibilityAttribute will be treated as though they have a DesignerSerializationVisibilityAttribute with a value of Visible. Wartości właściwości oznaczonej jako Visible będą serializowane, jeśli jest to możliwe, przez serializator dla tego typu.The values of a property marked as Visible will be serialized, if possible, by a serializer for the type. Aby określić niestandardową serializację dla określonego typu lub właściwości, użyj DesignerSerializerAttribute .To specify custom serialization for a particular type or property, use the DesignerSerializerAttribute.

Aby uzyskać więcej informacji, zobacz atrybuty.For more information, see Attributes.

Konstruktory

DesignerSerializationVisibilityAttribute(DesignerSerializationVisibility)

Inicjuje nowe wystąpienie DesignerSerializationVisibilityAttribute klasy przy użyciu określonej DesignerSerializationVisibility wartości.Initializes a new instance of the DesignerSerializationVisibilityAttribute class using the specified DesignerSerializationVisibility value.

Pola

Content

Określa, że serializator powinien serializować zawartość właściwości, a nie samą właściwość.Specifies that a serializer should serialize the contents of the property, rather than the property itself. To pole jest tylko do odczytu.This field is read-only.

Default

Określa wartość domyślną, czyli, Visible czyli projektant wizualny używa reguł domyślnych do generowania wartości właściwości.Specifies the default value, which is Visible, that is, a visual designer uses default rules to generate the value of a property. To static pole jest tylko do odczytu.This static field is read-only.

Hidden

Określa, że serializator nie powinien serializować wartości właściwości.Specifies that a serializer should not serialize the value of the property. To static pole jest tylko do odczytu.This static field is read-only.

Visible

Określa, że serializator powinien być dozwolony do serializacji wartości właściwości.Specifies that a serializer should be allowed to serialize the value of the property. To static pole jest tylko do odczytu.This static field is read-only.

Właściwości

TypeId

Po zaimplementowaniu w klasie pochodnej pobiera unikatowy identyfikator dla tego elementu Attribute .When implemented in a derived class, gets a unique identifier for this Attribute.

(Odziedziczone po Attribute)
Visibility

Pobiera wartość wskazującą podstawowy tryb serializacji, którego serializator powinien używać przy określaniu, czy i jak zachować wartość właściwości.Gets a value indicating the basic serialization mode a serializer should use when determining whether and how to persist the value of a property.

Metody

Equals(Object)

Wskazuje, czy to wystąpienie oraz określony obiekt są równe.Indicates whether this instance and a specified object are equal.

GetHashCode()

Zwraca kod skrótu dla tego obiektu.Returns the hash code for this object.

GetType()

Pobiera Type bieżące wystąpienie.Gets the Type of the current instance.

(Odziedziczone po Object)
IsDefaultAttribute()

Pobiera wartość wskazującą, czy bieżąca wartość atrybutu jest wartością domyślną dla atrybutu.Gets a value indicating whether the current value of the attribute is the default value for the attribute.

IsDefaultAttribute()

Gdy jest zastępowany w klasie pochodnej, wskazuje, czy wartość tego wystąpienia jest wartością domyślną klasy pochodnej.When overridden in a derived class, indicates whether the value of this instance is the default value for the derived class.

(Odziedziczone po Attribute)
Match(Object)

Gdy jest zastępowany w klasie pochodnej, zwraca wartość wskazującą, czy to wystąpienie jest zgodne z określonym obiektem.When overridden in a derived class, returns a value that indicates whether this instance equals a specified object.

(Odziedziczone po Attribute)
MemberwiseClone()

Tworzy skróconą kopię bieżącego elementu Object .Creates a shallow copy of the current Object.

(Odziedziczone po Object)
ToString()

Zwraca ciąg reprezentujący bieżący obiekt.Returns a string that represents the current object.

(Odziedziczone po Object)

Jawne implementacje interfejsu

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

Zestaw nazw jest mapowany na odpowiedni zestaw identyfikatorów wysyłania.Maps a set of names to a corresponding set of dispatch identifiers.

(Odziedziczone po Attribute)
_Attribute.GetTypeInfo(UInt32, UInt32, IntPtr)

Pobiera informacje o typie dla obiektu, którego można użyć do uzyskania informacji o typie dla interfejsu.Retrieves the type information for an object, which can be used to get the type information for an interface.

(Odziedziczone po Attribute)
_Attribute.GetTypeInfoCount(UInt32)

Pobiera informację o liczbie typów interfejsów, jakie zawiera obiekt (0 lub 1).Retrieves the number of type information interfaces that an object provides (either 0 or 1).

(Odziedziczone po Attribute)
_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)

Umożliwia dostęp do właściwości i metod udostępnianych przez obiekt.Provides access to properties and methods exposed by an object.

(Odziedziczone po Attribute)

Dotyczy

Zobacz też