Export (0) Print
Expand All

PersonalizationDictionary Class

Encapsulates basic validation rules that indicate whether a piece of custom data is considered personalizable in either User or Shared scope.

System.Object
  System.Web.UI.WebControls.WebParts.PersonalizationDictionary

Namespace:  System.Web.UI.WebControls.WebParts
Assembly:  System.Web (in System.Web.dll)

public class PersonalizationDictionary : IDictionary, 
	ICollection, IEnumerable

The PersonalizationDictionary type exposes the following members.

  NameDescription
Public methodPersonalizationDictionary()Initializes a new instance of the PersonalizationDictionary class.
Public methodPersonalizationDictionary(Int32)Initializes a new instance of the PersonalizationDictionary class using the provided parameter.
Top

  NameDescription
Public propertyCountGets the number of entries in the dictionary.
Public propertyIsFixedSizeGets whether the personalization dictionary is of a fixed size.
Public propertyIsReadOnlyGets whether the personalization dictionary is read-only.
Public propertyIsSynchronizedGets whether the personalization dictionary is synchronized.
Public propertyItemGets or sets an entry in the personalization dictionary.
Public propertyKeysGets a reference to an ICollection object containing the keys for the personalization dictionary.
Public propertySyncRootGets an object that can be used to synchronize access to the personalization dictionary.
Public propertyValuesGets a reference to an ICollection object containing the values in the personalization dictionary.
Top

  NameDescription
Public methodAddAdds personalization entries to the personalization dictionary.
Public methodClearRemoves all custom state information from the current PersonalizationDictionary object.
Public methodContainsReturns a value indicating whether a piece of custom state information with the same key is contained in the personalization dictionary.
Public methodCopyToCopies the personalization dictionary state entries as DictionaryEntry instances into the specified array.
Public methodEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetEnumeratorReturns an enumerator that can be used to iterate through the entries in the personalization dictionary.
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodRemoveRemoves a custom state entry based on the provided key.
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Top

  NameDescription
Public Extension MethodAsParallelEnables parallelization of a query. (Defined by ParallelEnumerable.)
Public Extension MethodAsQueryableConverts an IEnumerable to an IQueryable. (Defined by Queryable.)
Public Extension MethodCast<TResult>Casts the elements of an IEnumerable to the specified type. (Defined by Enumerable.)
Public Extension MethodOfType<TResult>Filters the elements of an IEnumerable based on a specified type. (Defined by Enumerable.)
Top

  NameDescription
Explicit interface implemetationPrivate methodICollection.CopyToImplements the ICollection.CopyTo method for the PersonalizationDictionary class.
Explicit interface implemetationPrivate methodIDictionary.AddImplements the IDictionary.Add method for the PersonalizationDictionary class.
Explicit interface implemetationPrivate methodIDictionary.ContainsImplements the IDictionary.Contains method for the PersonalizationDictionary class.
Explicit interface implemetationPrivate propertyIDictionary.ItemGets or sets the Item property value for the PersonalizationDictionary class.
Explicit interface implemetationPrivate methodIDictionary.RemoveImplements the IDictionary.Remove method for the PersonalizationDictionary class.
Explicit interface implemetationPrivate methodIEnumerable.GetEnumeratorImplements the IEnumerable.GetEnumerator method for the PersonalizationDictionary class.
Top

A PersonalizationDictionary instance is a collection of PersonalizationEntry objects, which consist of a personalization scope and an object value. These entries are assigned a key in the PersonalizationDictionary object.

A good practice is to add all properties to the dictionary using the Save method, regardless of the scope of the page. The .NET Framework saves the information in the appropriate way; for example, shared data is saved when the page is in Shared scope. However, shared properties are not saved when a Web Parts value is being saved, the page is in User scope, and the WebPart control was added with the page in Shared scope.

.NET Framework

Supported in: 4.5, 4, 3.5, 3.0, 2.0

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Show:
© 2014 Microsoft