WebPart.SaveProperties - Propriété

Obtient ou définit une valeur qui indique si les propriétés d'un composant WebPart ont été modifiés et doivent être conservées à la fin du rendu des pages.

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

Syntaxe

'Déclaration
Protected Friend Property SaveProperties As Boolean
    Get
    Set
'Utilisation
Dim value As Boolean

value = Me.SaveProperties

Me.SaveProperties = value
protected internal bool SaveProperties { get; set; }

Valeur de propriété

Type : System.Boolean
true si les propriétés de composant WebPart doivent être persistante ; dans le cas contraire, false.

Remarques

La propriété SaveProperties est initialement définie à false au début du rendu des pages. Cette propriété est utile uniquement pendant le rendu de page. Par exemple, cette propriété n'a aucun effet lorsqu'un composant WebPart est accessible via le modèle objet.

La propriété de SaveProperties peut être utilisée pour les composants WebPart lors de leurs propriétés modifier après restitué dans une Page de composants WebPart. Après la modification d'une propriété, une classe WebPart peut définir la propriété SaveProperties à true pour spécifier que toutes les propriétés modifiées seront enregistrées. La valeur de la propriété SaveProperties est lue par l'infrastructure de composant WebPart après la survenue de l'événement System.Web.UI.Control.UnLoad du composant WebPart, point auquel propriété toutes les valeurs sont effectuées et stockées dans la base de données SharePoint. Si cette propriété n'est pas définie, les propriétés revenir à leurs valeurs d'origine la prochaine fois que le composant WebPart est instancié.

La valeur de la propriété SaveProperties est ignorée sauf si un composant WebPart est rendu activement. Par exemple, l'instanciation d'un nouveau composant WebPart, modification d'une valeur de la propriété, puis sur paramètre SaveProperties à true est sans effet. La propriété SaveProperties doit être utilisée par un composant WebPart qui doit enregistrer une propriété qui a été modifié après avoir restitué. Si une propriété est définie de manière externe, il est la responsabilité de l'agent externe soit enregistrer le composant WebPart explicitement ou au cours d'un cycle de rendu pour définir la propriété SaveProperties au nom du composant WebPart.

Si la propriété SaveProperties est définie sur un composant WebPart statique (un composant WebPart qui ne se trouve pas dans une zone), ou pour un composant WebPart dans laquelle l'utilisateur ne dispose pas des autorisations suffisantes pour enregistrer les modifications (par exemple, pour un utilisateur anonyme), une exception est levée lorsqu'une tentative est effectuée pour enregistrer ce composant WebPart. Un composant WebPart doit vérifier la propriété Permissions avant d'afficher une interface utilisateur pour l'enregistrement des valeurs de propriété et la définition de SaveProperties à true.

Pour consulter un exemple de code qui fournit un exemple illustrant comment utiliser la propriété SaveProperties , voir WebPart.

Voir aussi

Référence

WebPart classe

WebPart - Membres

Microsoft.SharePoint.WebPartPages - Espace de noms