DesignerSerializationVisibilityAttribute DesignerSerializationVisibilityAttribute DesignerSerializationVisibilityAttribute DesignerSerializationVisibilityAttribute Class

Définition

Spécifie le type de persistance à utiliser lors de la sérialisation de la propriété d'un composant au moment du design.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
Héritage
DesignerSerializationVisibilityAttributeDesignerSerializationVisibilityAttributeDesignerSerializationVisibilityAttributeDesignerSerializationVisibilityAttribute
Attributs

Exemples

L’exemple de code suivant illustre l’utilisation d' DesignerSerializationVisibilityAttribute un défini Contentsur.The following code example demonstrates the use of a DesignerSerializationVisibilityAttribute set to Content. Il conserve les valeurs d’une propriété publique d’un contrôle utilisateur, qui peut être configuré au moment de la conception.It persists the values of a public property of a user control, which can be configured at design time. Pour utiliser l’exemple, commencez par compiler le code suivant dans une bibliothèque de contrôles utilisateur.To use the example, first compile the following code into a user control library. Ensuite, ajoutez une référence au fichier. dll compilé dans un nouveau projet d’application Windows.Next, add a reference to the compiled .dll file in a new Windows Application project. Si vous utilisez Visual Studio, ContentSerializationExampleControl est automatiquement ajouté à la boîte à outils.If you are using Visual Studio, the ContentSerializationExampleControl is automatically added to the Toolbox.

Faites glisser le contrôle de la boîte à outils vers un formulaire, puis définissez les DimensionData propriétés de l’objet figurant dans la fenêtre Propriétés.Drag the control from the Toolbox to a form, and set the properties of the DimensionData object listed in the Properties window. Lorsque vous affichez le code du formulaire, du code est ajouté à la InitializeComponent méthode du formulaire parent.When you view the code for the form, code will have been added to the InitializeComponent method of the parent form. Ce code définit les valeurs des propriétés du contrôle sur celles que vous avez définies en mode création.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 'ContentSerializationExampleControl

    ' 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 'DimensionData
End Namespace 'DesignerSerializationVisibilityTest

Remarques

Lorsqu’un sérialiseur conserve l’état persistant d’un document en mode Design, il ajoute souvent du code à la méthode d’initialisation des composants pour conserver les valeurs des propriétés qui ont été définies au moment de la conception.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. Cela se produit par défaut pour la plupart des types de base, si aucun attribut n’a été défini pour diriger un autre comportement.This happens by default for most basic types, if no attribute has been set to direct other behavior.

Avec, vous pouvez indiquer si la valeur d’une propriété est Visibleet si elle doit être rendue persistante dans le code d' Hiddeninitialisation,, et ne doit pas être rendue persistante dans le code d' Contentinitialisation, ou se compose de, qui doit avoir DesignerSerializationVisibilityAttribute code d’initialisation généré pour chaque propriété publique, non masquée de l’objet assigné à la propriété.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.

Les membres qui n’ont pas DesignerSerializationVisibilityAttribute de et sont traités comme s’ils avaient DesignerSerializationVisibilityAttribute un avec la valeur Visible.Members that do not have a DesignerSerializationVisibilityAttribute will be treated as though they have a DesignerSerializationVisibilityAttribute with a value of Visible. Les valeurs d’une propriété marquée comme Visible seront sérialisées, si possible, par un sérialiseur pour le type.The values of a property marked as Visible will be serialized, if possible, by a serializer for the type. Pour spécifier une sérialisation personnalisée pour un type ou une propriété particulière, utilisez DesignerSerializerAttribute.To specify custom serialization for a particular type or property, use the DesignerSerializerAttribute.

Pour plus d’informations, consultez Attributs.For more information, see Attributes.

Constructeurs

DesignerSerializationVisibilityAttribute(DesignerSerializationVisibility) DesignerSerializationVisibilityAttribute(DesignerSerializationVisibility) DesignerSerializationVisibilityAttribute(DesignerSerializationVisibility) DesignerSerializationVisibilityAttribute(DesignerSerializationVisibility)

Initialise une nouvelle instance de la classe DesignerSerializationVisibilityAttribute avec la valeur DesignerSerializationVisibility spécifiée.Initializes a new instance of the DesignerSerializationVisibilityAttribute class using the specified DesignerSerializationVisibility value.

Champs

Content Content Content Content

Spécifie qu'un sérialiseur doit sérialiser le contenu de la propriété, plutôt que la propriété elle-même.Specifies that a serializer should serialize the contents of the property, rather than the property itself. Ce champ est en lecture seule.This field is read-only.

Default Default Default Default

Spécifie la valeur par défaut qui est Visible, autrement dit, un concepteur visuel utilise des règles par défaut pour générer la valeur d'une propriété.Specifies the default value, which is Visible, that is, a visual designer uses default rules to generate the value of a property. Ce champ static est en lecture seule.This static field is read-only.

Hidden Hidden Hidden Hidden

Spécifie qu'un sérialiseur ne doit pas sérialiser la valeur de la propriété.Specifies that a serializer should not serialize the value of the property. Ce champ static est en lecture seule.This static field is read-only.

Visible Visible Visible Visible

Spécifie qu'un sérialiseur ne doit pas être autorisé à sérialiser la valeur de la propriété.Specifies that a serializer should be allowed to serialize the value of the property. Ce champ static est en lecture seule.This static field is read-only.

Propriétés

TypeId TypeId TypeId TypeId

Lors de l'implémentation dans une classe dérivée, obtient un identificateur unique pour l'objet Attribute.When implemented in a derived class, gets a unique identifier for this Attribute.

(Inherited from Attribute)
Visibility Visibility Visibility Visibility

Obtient une valeur indiquant le mode de sérialisation de base qu'un sérialiseur doit utiliser lorsqu'il détermine si la valeur d'une propriété doit être rendue persistante et comment.Gets a value indicating the basic serialization mode a serializer should use when determining whether and how to persist the value of a property.

Méthodes

Equals(Object) Equals(Object) Equals(Object) Equals(Object)

Indique si cette instance et un objet spécifié sont égaux.Indicates whether this instance and a specified object are equal.

GetHashCode() GetHashCode() GetHashCode() GetHashCode()

Retourne le code de hachage de cet objet.Returns the hash code for this object.

GetType() GetType() GetType() GetType()

Obtient le Type de l'instance actuelle.Gets the Type of the current instance.

(Inherited from Object)
IsDefaultAttribute() IsDefaultAttribute() IsDefaultAttribute() IsDefaultAttribute()

Obtient une valeur indiquant si la valeur actuelle de l'attribut est sa valeur par défaut.Gets a value indicating whether the current value of the attribute is the default value for the attribute.

Match(Object) Match(Object) Match(Object) Match(Object)

En cas de substitution dans une classe dérivée, retourne une valeur indiquant si cette instance équivaut à un objet spécifié.When overridden in a derived class, returns a value that indicates whether this instance equals a specified object.

(Inherited from Attribute)
MemberwiseClone() MemberwiseClone() MemberwiseClone() MemberwiseClone()

Crée une copie superficielle de l'objet Object actuel.Creates a shallow copy of the current Object.

(Inherited from Object)
ToString() ToString() ToString() ToString()

Retourne une chaîne qui représente l'objet actuel.Returns a string that represents the current object.

(Inherited from Object)

Implémentations d’interfaces explicites

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

Mappe un jeu de noms avec un jeu correspondant d'identificateurs de dispatch.Maps a set of names to a corresponding set of dispatch identifiers.

(Inherited from Attribute)
_Attribute.GetTypeInfo(UInt32, UInt32, IntPtr) _Attribute.GetTypeInfo(UInt32, UInt32, IntPtr) _Attribute.GetTypeInfo(UInt32, UInt32, IntPtr) _Attribute.GetTypeInfo(UInt32, UInt32, IntPtr)

Récupère les informations de type pour un objet, qui peuvent être utilisées pour obtenir les informations de type d'une interface.Retrieves the type information for an object, which can be used to get the type information for an interface.

(Inherited from Attribute)
_Attribute.GetTypeInfoCount(UInt32) _Attribute.GetTypeInfoCount(UInt32) _Attribute.GetTypeInfoCount(UInt32) _Attribute.GetTypeInfoCount(UInt32)

Récupère le nombre d'interfaces d'informations de type fourni par un objet (0 ou 1).Retrieves the number of type information interfaces that an object provides (either 0 or 1).

(Inherited from Attribute)
_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr) _Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr) _Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr) _Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)

Fournit l'accès aux propriétés et aux méthodes exposées par un objet.Provides access to properties and methods exposed by an object.

(Inherited from Attribute)

S’applique à

Voir aussi