Partager via


WebPart.ShouldSerializeDescription - Méthode

Renvoie si la propriété Description a été modifiée à partir de sa valeur par défaut.

Espace de noms :  Microsoft.SharePoint.WebPartPages
Assembly :  Microsoft.SharePoint (dans Microsoft.SharePoint.dll)

Syntaxe

'Déclaration
Public Overridable Function ShouldSerializeDescription As Boolean
'Utilisation
Dim instance As WebPart
Dim returnValue As Boolean

returnValue = instance.ShouldSerializeDescription()
public virtual bool ShouldSerializeDescription()

Valeur renvoyée

Type : System.Boolean
true si la valeur de la propriété a été modifiée à partir de la valeur par défaut ; dans le cas contraire, false.

Remarques

La méthode ShouldSerializeDescription est fournie car la propriété Description n'a pas de valeur par défaut simple. Cette méthode indique si la propriété a été modifiée à partir de sa valeur par défaut. Vous généralement appelez cette méthode si vous développez un concepteur pour la classe WebPart , ou créez votre propre composant WebPart ou une partie de l'outil, afin que vous pouvez éviter de persistance inutilement les valeurs par défaut.

Si vous remplacez cette fonction, votre fonction doit renvoyer true si la propriété correspondante a changé la valeur par défaut ou si la propriété SerializeAll est true. Par exemple :

public override bool ShouldSerializeDescription()
{
    return SerializeAll || defaultDescription != _description;
}

Voir aussi

Référence

WebPart classe

WebPart - Membres

Microsoft.SharePoint.WebPartPages - Espace de noms