PersonalizationDictionary Class

.NET Framework (current version)

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

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

Inheritance Hierarchy

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

Syntax

C++

public ref class PersonalizationDictionary : IDictionary, ICollection, 
	IEnumerable

Constructors

	Name	Description
	PersonalizationDictionary()	Initializes a new instance of the PersonalizationDictionary class.
	PersonalizationDictionary(Int32)	Initializes a new instance of the PersonalizationDictionary class using the provided parameter.

Properties

	Name	Description
	Count	Gets the number of entries in the dictionary.
	IsFixedSize	Gets whether the personalization dictionary is of a fixed size.
	IsReadOnly	Gets whether the personalization dictionary is read-only.
	IsSynchronized	Gets whether the personalization dictionary is synchronized.
	Item[String^]	Gets or sets an entry in the personalization dictionary.
	Keys	Gets a reference to an ICollection object containing the keys for the personalization dictionary.
	SyncRoot	Gets an object that can be used to synchronize access to the personalization dictionary.
	Values	Gets a reference to an ICollection object containing the values in the personalization dictionary.

Methods

	Name	Description
	Add(String^, PersonalizationEntry^)	Adds personalization entries to the personalization dictionary.
	Clear()	Removes all custom state information from the current PersonalizationDictionary object.
	Contains(String^)	Returns a value indicating whether a piece of custom state information with the same key is contained in the personalization dictionary.
	CopyTo(array<DictionaryEntry>^, Int32)	Copies the personalization dictionary state entries as DictionaryEntry instances into the specified array.
	Equals(Object^)	Determines whether the specified object is equal to the current object.(Inherited from Object.)
	Finalize()	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)
	GetEnumerator()	Returns an enumerator that can be used to iterate through the entries in the personalization dictionary.
	GetHashCode()	Serves as the default hash function. (Inherited from Object.)
	GetType()	Gets the Type of the current instance.(Inherited from Object.)
	MemberwiseClone()	Creates a shallow copy of the current Object.(Inherited from Object.)
	Remove(String^)	Removes a custom state entry based on the provided key.
	ToString()	Returns a string that represents the current object.(Inherited from Object.)

Explicit Interface Implementations

	Name	Description
	ICollection::CopyTo(Array^, Int32)	Implements the ICollection::CopyTo method for the PersonalizationDictionary class.
	IDictionary::Add(Object^, Object^)	Implements the IDictionary::Add method for the PersonalizationDictionary class.
	IDictionary::Contains(Object^)	Implements the IDictionary::Contains method for the PersonalizationDictionary class.
	IDictionary::Remove(Object^)	Implements the IDictionary::Remove method for the PersonalizationDictionary class.
	IEnumerable::GetEnumerator()	Implements the IEnumerable::GetEnumerator method for the PersonalizationDictionary class.
	IDictionary::Item[Object^]	Gets or sets the Item property value for the PersonalizationDictionary class.

Extension Methods

	Name	Description
	AsParallel()	Overloaded. Enables parallelization of a query.(Defined by ParallelEnumerable.)
	AsQueryable()	Overloaded. Converts an IEnumerable to an IQueryable.(Defined by Queryable.)
	Cast<TResult>()	Casts the elements of an IEnumerable to the specified type.(Defined by Enumerable.)
	OfType<TResult>()	Filters the elements of an IEnumerable based on a specified type.(Defined by Enumerable.)

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.

Version Information

.NET Framework
Available since 2.0

Thread Safety

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