AI OnAI Off

Class VersioningFileSummary

The internal EPiServer implementation of a versioned share.

Inheritance
System.Object
VersioningFileSummary
Implements
System.Collections.IDictionary
System.Collections.ICollection
System.Collections.IEnumerable
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: EPiServer.Web.Hosting.Versioning
Assembly: EPiServer.dll
Version: 8.11.0
Syntax
public class VersioningFileSummary : IFileSummary, IDictionary, ICollection, IEnumerable

Properties

Author

Gets or sets the file author.

Declaration
public string Author { get; set; }
Property Value
Type Description
System.String

The author.

Category

Gets or sets the categories for the file.

Declaration
public string Category { get; set; }
Property Value
Type Description
System.String

The category.

Comments

Gets or sets the comments for the file.

Declaration
public string Comments { get; set; }
Property Value
Type Description
System.String

The comments.

Count

Gets the number of elements contained in the System.Collections.ICollection.

Declaration
public int Count { get; }
Property Value
Type Description
System.Int32

IsFixedSize

Gets a value indicating whether the System.Collections.IDictionary object has a fixed size.

Declaration
public bool IsFixedSize { get; }
Property Value
Type Description
System.Boolean

IsReadOnly

Gets a value indicating whether the System.Collections.IDictionary object is read-only.

Declaration
public bool IsReadOnly { get; }
Property Value
Type Description
System.Boolean

IsSynchronized

Gets a value indicating whether access to the System.Collections.ICollection is synchronized (thread safe).

Declaration
public bool IsSynchronized { get; }
Property Value
Type Description
System.Boolean

Item[Object]

Gets or sets the System.Object with the specified key.

Declaration
public object this[object key] { get; set; }
Parameters
Type Name Description
System.Object key
Property Value
Type Description
System.Object

Keys

Gets an System.Collections.ICollection object containing the keys of the System.Collections.IDictionary object.

Declaration
public ICollection Keys { get; }
Property Value
Type Description
System.Collections.ICollection

Keywords

Gets or sets the keywords for the file.

Declaration
public string Keywords { get; set; }
Property Value
Type Description
System.String

The keywords.

Subject

Gets or sets the file subject.

Declaration
public string Subject { get; set; }
Property Value
Type Description
System.String

The subject.

SyncRoot

Gets an object that can be used to synchronize access to the System.Collections.ICollection.

Declaration
public object SyncRoot { get; }
Property Value
Type Description
System.Object

Title

Gets or sets the title for the file

Declaration
public string Title { get; set; }
Property Value
Type Description
System.String

The title.

Values

Gets an System.Collections.ICollection object containing the values in the System.Collections.IDictionary object.

Declaration
public ICollection Values { get; }
Property Value
Type Description
System.Collections.ICollection

Methods

Add(Object, Object)

Adds an element with the provided key and value to the System.Collections.IDictionary object.

Declaration
public void Add(object key, object value)
Parameters
Type Name Description
System.Object key

The System.Object to use as the key of the element to add.
System.Object value

The System.Object to use as the value of the element to add.
Exceptions
Type Condition
System.ArgumentException

An element with the same key already exists in the System.Collections.IDictionary object.

System.ArgumentNullException

key is null.

System.NotSupportedException

The System.Collections.IDictionary is read-only.-or- The System.Collections.IDictionary has a fixed size.

Clear()

Removes all elements from the System.Collections.IDictionary object.

Declaration
public void Clear()
Exceptions
Type Condition
System.NotSupportedException

The System.Collections.IDictionary object is read-only.

Contains(Object)

Determines whether the System.Collections.IDictionary object contains an element with the specified key.

Declaration
public bool Contains(object key)
Parameters
Type Name Description
System.Object key

The key to locate in the System.Collections.IDictionary object.
Returns
Type Description
System.Boolean

true if the System.Collections.IDictionary contains an element with the key; otherwise, false.
Exceptions
Type Condition
System.ArgumentNullException

key is null.

CopyTo(Array, Int32)

Copies the elements of the System.Collections.ICollection to an System.Array, starting at a particular System.Array index.

Declaration
public void CopyTo(Array array, int index)
Parameters
Type Name Description
System.Array array

The one-dimensional System.Array that is the destination of the elements copied from System.Collections.ICollection. The System.Array must have zero-based indexing.
System.Int32 index

The zero-based index in array at which copying begins.
Exceptions
Type Condition
System.ArgumentNullException

array is null.

System.ArgumentOutOfRangeException

index is less than zero.

System.ArgumentException

array is multidimensional.-or- index is equal to or greater than the length of array.-or- The number of elements in the source System.Collections.ICollection is greater than the available space from index to the end of the destination array.

System.InvalidCastException

The type of the source System.Collections.ICollection cannot be cast automatically to the type of the destination array.

GetEnumerator()

Returns an System.Collections.IDictionaryEnumerator object for the System.Collections.IDictionary object.

Declaration
public IDictionaryEnumerator GetEnumerator()
Returns
Type Description
System.Collections.IDictionaryEnumerator

An System.Collections.IDictionaryEnumerator object for the System.Collections.IDictionary object.

Remove(Object)

Removes the element with the specified key from the System.Collections.IDictionary object.

Declaration
public void Remove(object key)
Parameters
Type Name Description
System.Object key

The key of the element to remove.
Exceptions
Type Condition
System.NotSupportedException

The System.Collections.IDictionary object is read-only.-or- The System.Collections.IDictionary has a fixed size.

System.ArgumentNullException

key is null.

SaveChanges()

Saves the changes for the file summary.

Declaration
public void SaveChanges()

Explicit Interface Implementations

IEnumerable.GetEnumerator()

Returns an enumerator that iterates through a collection.

Declaration
IEnumerator IEnumerable.GetEnumerator()
Returns
Type Description
System.Collections.IEnumerator

An System.Collections.IEnumerator object that can be used to iterate through the collection.

Implements

System.Collections.IDictionary
System.Collections.ICollection
System.Collections.IEnumerable

Extension Methods