Class NamedDestinationsCollection

Represents collection of named destinations.

Inheritance

System.Object

NamedDestinationsCollection

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: Telerik.Windows.Documents.Fixed.Model.Collections

Assembly: Telerik.Windows.Documents.Fixed.dll

Syntax

public sealed class NamedDestinationsCollection : IEnumerable<NamedDestination>, IEnumerable

Constructors

NamedDestinationsCollection(IDestinationContainer)

Initializes a new instance of the NamedDestinationsCollection class.

Declaration

public NamedDestinationsCollection(IDestinationContainer parent)

Parameters

IDestinationContainer parent The parent.

Properties

Count

Gets the number of named destinations contained in the collection.

Declaration

public int Count { get; }

Property Value

System.Int32

Item[String]

Gets the named destination associated with the specified name.

Declaration

public NamedDestination this[string name] { get; }

Parameters

System.String name The name of the named destination to get.

Property Value

NamedDestination The named destination associated with the specified name.

Exceptions

System.Collections.Generic.KeyNotFoundException If the specified name is not found.

Names

Gets a collection containing the names in the collection.

Declaration

public IEnumerable<string> Names { get; }

Property Value

System.Collections.Generic.IEnumerable<System.String>

Methods

Add(String, GoToAction)

Adds a named destination with the specified name and value to the collection and returns it.

Declaration

public NamedDestination Add(string name, GoToAction goToAction)

Parameters

System.String name The name of the named destination.

GoToAction goToAction The GoToAction for the named destination.

Returns

NamedDestination The created named destination.

Exceptions

System.ArgumentNullException name is null.

System.ArgumentNullException An element with the same name already exists in the collection.

Add(String, Destination)

Adds a named destination with the specified name and value to the collection and returns it.

Declaration

public NamedDestination Add(string name, Destination destination)

Parameters

System.String name The name of the named destination.

Destination destination The Destination for the named destination.

Returns

NamedDestination The created named destination.

Exceptions

System.ArgumentNullException name is null.

System.ArgumentNullException An element with the same name already exists in the collection.

Clear()

Removes all named destination from the collection.

Declaration

public void Clear()

ContainsName(String)

Determines whether the collection contains the specified name.

Declaration

public bool ContainsName(string name)

Parameters

System.String name The name to locate in the collection.

Returns

System.Boolean true if the collection contains an element with the specified name; otherwise, false

Exceptions

System.ArgumentNullException name is null

GetEnumerator()

Returns an enumerator that iterates through the collection.

Declaration

public IEnumerator<NamedDestination> GetEnumerator()

Returns

System.Collections.Generic.IEnumerator<NamedDestination> A numerator for the collection

Implements

System.Collections.Generic.IEnumerable<T>.GetEnumerator()

Remove(String)

Removes the named destination with the specified name from the collection.

Declaration

public bool Remove(string name)

Parameters

System.String name The name of the named destination to remove

Returns

System.Boolean true if the named destination is successfully found and removed; otherwise, false. This method returns false if name is not found in the collection.

Exceptions

System.ArgumentException name is null.

Rename(String, String)

Renames a named destination in the collection.

Declaration

public void Rename(string oldName, string newName)

Parameters

System.String oldName The old name of the destination.

System.String newName The new name of the destination.

TryGetValue(String, out NamedDestination)

Gets the named destination associated with the specified name.

Declaration

public bool TryGetValue(string name, out NamedDestination value)

Parameters

System.String name The name of the destination to get.

NamedDestination value When this method returns, contains the destination associated with the specified name if the name is found; otherwise, null. This parameter is passed uninitialized.

Returns

System.Boolean true if the collection contains a named destination with the specified name; otherwise, false.

Exceptions

System.ArgumentException name is null

Explicit Interface Implementations

IEnumerable.GetEnumerator()

Declaration

IEnumerator IEnumerable.GetEnumerator()

Returns

System.Collections.IEnumerator

Implements

System.Collections.IEnumerable.GetEnumerator()