Share via

CachedDataItemCollection Class

  • Article

Represents a collection of CachedDataItem objects in a document-level customization that was created by using the Office development tools in Visual Studio.

Inheritance Hierarchy

System.Object
  System.Collections.ObjectModel.Collection<CachedDataItem>
    Microsoft.VisualStudio.Tools.Applications.CachedDataItemCollection

Namespace:  Microsoft.VisualStudio.Tools.Applications
Assembly:  Microsoft.VisualStudio.Tools.Applications.ServerDocument (in Microsoft.VisualStudio.Tools.Applications.ServerDocument.dll)

Syntax

'Declaration
<SerializableAttribute> _
<PermissionSetAttribute(SecurityAction.Demand, Name := "FullTrust")> _
Public NotInheritable Class CachedDataItemCollection _
    Inherits Collection(Of CachedDataItem)

[SerializableAttribute]
[PermissionSetAttribute(SecurityAction.Demand, Name = "FullTrust")]
public sealed class CachedDataItemCollection : Collection<CachedDataItem>

The CachedDataItemCollection type exposes the following members.

Properties

  Name Description
Public property Count Gets the number of elements actually contained in the Collection<T>. (Inherited from Collection<CachedDataItem>.)
Public property Item[Int32] Gets or sets the element at the specified index. (Inherited from Collection<CachedDataItem>.)
Public property Item[String] Gets the CachedDataItem identified by the name of the cached data object.
Protected property Items Gets a IList<T> wrapper around the Collection<T>. (Inherited from Collection<CachedDataItem>.)

Top

Methods

  Name Description
Public method Add(T) Adds an object to the end of the Collection<T>. (Inherited from Collection<CachedDataItem>.)
Public method Add(String, String) Adds the specified CachedDataItem to the end of the collection.
Public method Clear Removes all elements from the Collection<T>. (Inherited from Collection<CachedDataItem>.)
Protected method ClearItems Removes all elements from the Collection<T>. (Inherited from Collection<CachedDataItem>.)
Public method Contains(String) Returns a value that indicates whether the collection contains the specified CachedDataItem.
Public method Contains(T) Determines whether an element is in the Collection<T>. (Inherited from Collection<CachedDataItem>.)
Public method CopyTo Copies the entire Collection<T> to a compatible one-dimensional Array, starting at the specified index of the target array. (Inherited from Collection<CachedDataItem>.)
Public method Equals Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public method GetEnumerator Returns a CachedDataItemEnumerator that can be used to iterate through the contents of the collection.
Public method GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Public method IndexOf Searches for the specified object and returns the zero-based index of the first occurrence within the entire Collection<T>. (Inherited from Collection<CachedDataItem>.)
Public method Insert Inserts an element into the Collection<T> at the specified index. (Inherited from Collection<CachedDataItem>.)
Protected method InsertItem Inserts an element into the Collection<T> at the specified index. (Inherited from Collection<CachedDataItem>.)
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public method Remove(String) Removes the specified CachedDataItem, identified by the name of the cached data object, from the collection.
Public method Remove(T) Removes the first occurrence of a specific object from the Collection<T>. (Inherited from Collection<CachedDataItem>.)
Public method RemoveAt Removes the element at the specified index of the Collection<T>. (Inherited from Collection<CachedDataItem>.)
Protected method RemoveItem Removes the element at the specified index of the Collection<T>. (Inherited from Collection<CachedDataItem>.)
Protected method SetItem Replaces the element at the specified index. (Inherited from Collection<CachedDataItem>.)
Public method ToString Returns a string that represents the current object. (Inherited from Object.)

Top

Explicit Interface Implementations

  Name Description
Explicit interface implemetationPrivate method IList.Add Adds an item to the IList. (Inherited from Collection<CachedDataItem>.)
Explicit interface implemetationPrivate method IList.Contains Determines whether the IList contains a specific value. (Inherited from Collection<CachedDataItem>.)
Explicit interface implemetationPrivate method ICollection.CopyTo Copies the elements of the ICollection to an Array, starting at a particular Array index. (Inherited from Collection<CachedDataItem>.)
Explicit interface implemetationPrivate method IEnumerable.GetEnumerator Returns an enumerator that iterates through a collection. (Inherited from Collection<CachedDataItem>.)
Explicit interface implemetationPrivate method IList.IndexOf Determines the index of a specific item in the IList. (Inherited from Collection<CachedDataItem>.)
Explicit interface implemetationPrivate method IList.Insert Inserts an item into the IList at the specified index. (Inherited from Collection<CachedDataItem>.)
Explicit interface implemetationPrivate property IList.IsFixedSize Gets a value indicating whether the IList has a fixed size. (Inherited from Collection<CachedDataItem>.)
Explicit interface implemetationPrivate property ICollection<T>.IsReadOnly Gets a value indicating whether the ICollection<T> is read-only. (Inherited from Collection<CachedDataItem>.)
Explicit interface implemetationPrivate property IList.IsReadOnly Gets a value indicating whether the IList is read-only. (Inherited from Collection<CachedDataItem>.)
Explicit interface implemetationPrivate property ICollection.IsSynchronized Gets a value indicating whether access to the ICollection is synchronized (thread safe). (Inherited from Collection<CachedDataItem>.)
Explicit interface implemetationPrivate property IList.Item Gets or sets the element at the specified index. (Inherited from Collection<CachedDataItem>.)
Explicit interface implemetationPrivate method IList.Remove Removes the first occurrence of a specific object from the IList. (Inherited from Collection<CachedDataItem>.)
Explicit interface implemetationPrivate property ICollection.SyncRoot Gets an object that can be used to synchronize access to the ICollection. (Inherited from Collection<CachedDataItem>.)

Top

Remarks

Use the CachedData property to obtain a CachedDataItemCollection for an Office solution document that has cached data.

For more information about caching data in document-level customizations, see Caching Data and Accessing Data in Documents on the Server.

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.

See Also

Reference

Microsoft.VisualStudio.Tools.Applications Namespace

Other Resources

Managing Documents on a Server by Using the ServerDocument Class

Caching Data

Accessing Data in Documents on the Server