Documentation

Class TabStopCollection

Represents a collection of TabStop elements.

Inheritance
System.Object
TabStopCollection
Namespace: Telerik.Windows.Documents.Model
Assembly: Telerik.Windows.Controls.RichTextBox.dll

Syntax

public class TabStopCollection : Object, ICollection<TabStop>, IEnumerable<TabStop>, IEnumerable, IList, ICollection

Constructors

TabStopCollection()

Initializes a new instance of the TabStopCollection class.

Declaration
public TabStopCollection()

TabStopCollection(IEnumerable<TabStop>)

Initializes a new instance of the TabStopCollection class.

Declaration
public TabStopCollection(IEnumerable<TabStop> tabStops)
Parameters
System.Collections.Generic.IEnumerable<TabStop> tabStops

The tab stops to be added to the collection.

TabStopCollection(TabStopCollection)

Initializes a new instance of the TabStopCollection class.

Declaration
public TabStopCollection(TabStopCollection fromCollection)
Parameters
TabStopCollection fromCollection

A TabStopCollection whose TabStops will be added to the new collection.

Properties

Count

Gets the number of elements contained in the System.Collections.Generic.ICollection<>.

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

IsFixedSize

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

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

IsReadOnly

Gets a value indicating whether the System.Collections.Generic.ICollection<> is read-only.

Declaration
public bool IsReadOnly { get; }
Property Value
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
System.Boolean

Item[Int32]

Gets or sets the System.Object at the specified index.

Declaration
public object this[int index] { get; set; }
Parameters
System.Int32 index

The index.
Property Value
System.Object

The System.Object.
Exceptions
System.NotImplementedException

SyncRoot

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

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

Methods

Add(Object)

Adds an item to the System.Collections.IList.

Declaration
public int Add(object value)
Parameters
System.Object value

The object to add to the System.Collections.IList.
Returns
System.Int32

The position into which the new element was inserted, or -1 to indicate that the item was not inserted into the collection.

Add(TabStop)

Adds an item to the System.Collections.Generic.ICollection<>.

Declaration
public void Add(TabStop item)
Parameters
TabStop item

The TabStop to add to the System.Collections.Generic.ICollection<>.

AddRangeCopy(IEnumerable<TabStop>)

Adds a collection of TabStops. The items passed as a parameter are copied and their copies are inserted into the System.Collections.Generic.ICollection<>.

Declaration
public void AddRangeCopy(IEnumerable<TabStop> items)
Parameters
System.Collections.Generic.IEnumerable<TabStop> items

The tab stops to add.

Clear()

Removes all items from the System.Collections.Generic.ICollection<>.

Declaration
public void Clear()

Clone()

Clones this instance.

Declaration
public TabStopCollection Clone()
Returns
TabStopCollection

The cloned instance.

Contains(Object)

Determines whether this instance contains the object.

Declaration
public bool Contains(object value)
Parameters
System.Object value

The object to locate in the System.Collections.IList.
Returns
System.Boolean

true if the System.Object is found in the System.Collections.IList; otherwise, false.

Contains(TabStop)

Determines whether this instance contains the TabStop.

Declaration
public bool Contains(TabStop item)
Parameters
TabStop item

The TabStop to locate in the System.Collections.Generic.ICollection<>.
Returns
System.Boolean

true if item is found in the System.Collections.Generic.ICollection<>; otherwise, false.

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
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
System.NotImplementedException

CopyTo(TabStop[], Int32)

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

Declaration
public void CopyTo(TabStop[] array, int arrayIndex)
Parameters
TabStop[] array

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

The zero-based index in array at which copying begins.

GetEnumerator()

Returns an enumerator that iterates through the collection.

Declaration
public IEnumerator<TabStop> GetEnumerator()
Returns
System.Collections.Generic.IEnumerator<TabStop>

An enumerator that can be used to iterate through the collection.

GetTabStopsByWidth(Single)

Gets the tab stops whose Position is less than or equal to a specific width.

Declaration
public IEnumerable<TabStop> GetTabStopsByWidth(float width)
Parameters
System.Single width

The width.
Returns
System.Collections.Generic.IEnumerable<TabStop>

A collection of TabStops which fit in the specified width.

GetTrailingDefaultTabStopsByWidth(Single)

Gets the default tab stops by calculating the distance between a specified width and the last custom TabStop.

Declaration
public IEnumerable<TabStop> GetTrailingDefaultTabStopsByWidth(float width)
Parameters
System.Single width

The width.
Returns
System.Collections.Generic.IEnumerable<TabStop>

A collection of the TabStops fitting in the range/

IndexOf(Object)

Determines the index of a specific item in the System.Collections.IList.

Declaration
public int IndexOf(object value)
Parameters
System.Object value

The object to locate in the System.Collections.IList.
Returns
System.Int32

The index of value if found in the list; otherwise, -1.

Insert(Int32, Object)

Inserts an item to the System.Collections.IList at the specified index.

Declaration
public void Insert(int index, object value)
Parameters
System.Int32 index

The zero-based index at which value should be inserted.
System.Object value

The object to insert into the System.Collections.IList.
Exceptions
System.NotImplementedException

OnAdd(TabStop)

Called after adding a TabStop to the System.Collections.Generic.ICollection<>.

Declaration
protected virtual void OnAdd(TabStop item)
Parameters
TabStop item

The TabStop which is added.

OnChange()

Called after the collection has been changed by adding, removing TabStop, or changing one of the TabStop properties.

Declaration
protected virtual void OnChange()

OnRemove(TabStop)

Called after removing a TabStop from the System.Collections.Generic.ICollection<>.

Declaration
protected virtual void OnRemove(TabStop item)
Parameters
TabStop item

The TabStop which is removed.

Remove(Object)

Removes the first occurrence of a specific object from the System.Collections.IList.

Declaration
public void Remove(object value)
Parameters
System.Object value

The object to remove from the System.Collections.IList.

Remove(TabStop)

Removes the first occurrence of a specific TabStop from the System.Collections.Generic.ICollection<>.

Declaration
public bool Remove(TabStop item)
Parameters
TabStop item

The TabStop to remove from the System.Collections.Generic.ICollection<>.
Returns
System.Boolean

true if item was successfully removed from the System.Collections.Generic.ICollection<>; otherwise, false. This method also returns false if item is not found in the original System.Collections.Generic.ICollection<>.

RemoveAt(Int32)

Removes the System.Collections.IList item at the specified index.

Declaration
public void RemoveAt(int index)
Parameters
System.Int32 index

The zero-based index of the item to remove.

RemoveRange(IEnumerable<TabStop>)

Removes a bunch of TabStops from the System.Collections.Generic.ICollection<>.

Declaration
public void RemoveRange(IEnumerable<TabStop> items)
Parameters
System.Collections.Generic.IEnumerable<TabStop> items

The tab stops to remove.

Events

Changed

Occurs after the collection has been changed by adding, removing TabStop, or changing one of the TabStop properties.

Declaration
public event EventHandler Changed
Event Type
System.EventHandler

Extension Methods

See Also

System.Collections.Generic.ICollection<>
System.Collections.IList