Class
TabStopCollection

Represents a collection of TabStop elements.

Definition

Namespace:Telerik.Windows.Documents.Model

Assembly:Telerik.Windows.Controls.RichTextBox.dll

Syntax:

cs-api-definition
public class TabStopCollection : ICollection<TabStop>, IEnumerable<TabStop>, IList, ICollection, IEnumerable

Inheritance: objectTabStopCollection

Implements: ICollectionICollection<TabStop>IEnumerableIEnumerable<TabStop>IList

Constructors

TabStopCollection()

Initializes a new instance of the TabStopCollection class.

Declaration

cs-api-definition
public TabStopCollection()

TabStopCollection(IEnumerable<TabStop>)

Initializes a new instance of the TabStopCollection class.

Declaration

cs-api-definition
public TabStopCollection(IEnumerable<TabStop> tabStops)

Parameters

tabStops

IEnumerable<TabStop>

The tab stops to be added to the collection.

TabStopCollection(TabStopCollection)

Initializes a new instance of the TabStopCollection class.

Declaration

cs-api-definition
public TabStopCollection(TabStopCollection fromCollection)

Parameters

fromCollection

TabStopCollection

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

Properties

Count

Gets the number of elements contained in the ICollection<T>.

Declaration

cs-api-definition
public int Count { get; }

Property Value

int

Implements ICollection<TabStop>.CountICollection.Count

IsFixedSize

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

Declaration

cs-api-definition
public bool IsFixedSize { get; }

Property Value

bool

Implements IList.IsFixedSize

IsReadOnly

Gets a value indicating whether the ICollection<T> is read-only.

Declaration

cs-api-definition
public bool IsReadOnly { get; }

Property Value

bool

Implements ICollection<TabStop>.IsReadOnlyIList.IsReadOnly

IsSynchronized

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

Declaration

cs-api-definition
public bool IsSynchronized { get; }

Property Value

bool

Implements ICollection.IsSynchronized

SyncRoot

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

Declaration

cs-api-definition
public object SyncRoot { get; }

Property Value

object

Implements ICollection.SyncRoot

this[int]

Gets or sets the object at the specified index.

Declaration

cs-api-definition
public object this[int index] { get; set; }

Parameters

index

int

The index.

Property Value

object

The object.

Exceptions

NotImplementedException

Implements IList.this[int]

Methods

Add(TabStop)

Adds an item to the ICollection<T>.

Declaration

cs-api-definition
public void Add(TabStop item)

Parameters

item

TabStop

The TabStop to add to the ICollection<T>.

Implements ICollection<TabStop>.Add(TabStop)

Add(object)

Adds an item to the IList.

Declaration

cs-api-definition
public int Add(object value)

Parameters

value

object

The object to add to the IList.

Returns

int

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

Implements IList.Add(object)

AddRangeCopy(IEnumerable<TabStop>)

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

Declaration

cs-api-definition
public void AddRangeCopy(IEnumerable<TabStop> items)

Parameters

items

IEnumerable<TabStop>

The tab stops to add.

Clear()

Removes all items from the ICollection<T>.

Declaration

cs-api-definition
public void Clear()

Implements ICollection<TabStop>.Clear()IList.Clear()

Clone()

Clones this instance.

Declaration

cs-api-definition
public TabStopCollection Clone()

Returns

TabStopCollection

The cloned instance.

Contains(TabStop)

Determines whether this instance contains the TabStop.

Declaration

cs-api-definition
public bool Contains(TabStop item)

Parameters

item

TabStop

The TabStop to locate in the ICollection<T>.

Returns

bool

true if item is found in the ICollection<T>; otherwise, false.

Implements ICollection<TabStop>.Contains(TabStop)

Contains(object)

Determines whether this instance contains the object.

Declaration

cs-api-definition
public bool Contains(object value)

Parameters

value

object

The object to locate in the IList.

Returns

bool

true if the object is found in the IList; otherwise, false.

Implements IList.Contains(object)

CopyTo(Array, int)

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

Declaration

cs-api-definition
public void CopyTo(Array array, int index)

Parameters

array

Array

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

index

int

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

Exceptions

NotImplementedException

Implements ICollection.CopyTo(Array, int)

CopyTo(TabStop[], int)

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

Declaration

cs-api-definition
public void CopyTo(TabStop[] array, int arrayIndex)

Parameters

array

TabStop[]

The one-dimensional Array that is the destination of the elements copied from ICollection<T>. The Array must have zero-based indexing.

arrayIndex

int

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

Implements ICollection<TabStop>.CopyTo(TabStop[], int)

GetEnumerator()

Returns an enumerator that iterates through the collection.

Declaration

cs-api-definition
public IEnumerator<TabStop> GetEnumerator()

Returns

IEnumerator<TabStop>

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

Implements IEnumerable<TabStop>.GetEnumerator()

GetTabStopsByWidth(float)

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

Declaration

cs-api-definition
public IEnumerable<TabStop> GetTabStopsByWidth(float width)

Parameters

width

float

The width.

Returns

IEnumerable<TabStop>

A collection of TabStops which fit in the specified width.

GetTrailingDefaultTabStopsByWidth(float)

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

Declaration

cs-api-definition
public IEnumerable<TabStop> GetTrailingDefaultTabStopsByWidth(float width)

Parameters

width

float

The width.

Returns

IEnumerable<TabStop>

A collection of the TabStops fitting in the range/

IndexOf(object)

Determines the index of a specific item in the IList.

Declaration

cs-api-definition
public int IndexOf(object value)

Parameters

value

object

The object to locate in the IList.

Returns

int

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

Implements IList.IndexOf(object)

Insert(int, object)

Inserts an item to the IList at the specified index.

Declaration

cs-api-definition
public void Insert(int index, object value)

Parameters

index

int

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

value

object

The object to insert into the IList.

Exceptions

NotImplementedException

Implements IList.Insert(int, object)

OnAdd(TabStop)

Called after adding a TabStop to the ICollection<T>.

Declaration

cs-api-definition
protected virtual void OnAdd(TabStop item)

Parameters

item

TabStop

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

cs-api-definition
protected virtual void OnChange()

OnRemove(TabStop)

Called after removing a TabStop from the ICollection<T>.

Declaration

cs-api-definition
protected virtual void OnRemove(TabStop item)

Parameters

item

TabStop

The TabStop which is removed.

Remove(TabStop)

Removes the first occurrence of a specific TabStop from the ICollection<T>.

Declaration

cs-api-definition
public bool Remove(TabStop item)

Parameters

item

TabStop

The TabStop to remove from the ICollection<T>.

Returns

bool

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

Implements ICollection<TabStop>.Remove(TabStop)

Remove(object)

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

Declaration

cs-api-definition
public void Remove(object value)

Parameters

value

object

The object to remove from the IList.

Implements IList.Remove(object)

RemoveAt(int)

Removes the IList item at the specified index.

Declaration

cs-api-definition
public void RemoveAt(int index)

Parameters

index

int

The zero-based index of the item to remove.

Implements IList.RemoveAt(int)

RemoveRange(IEnumerable<TabStop>)

Removes a bunch of TabStops from the ICollection<T>.

Declaration

cs-api-definition
public void RemoveRange(IEnumerable<TabStop> items)

Parameters

items

IEnumerable<TabStop>

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

cs-api-definition
public event EventHandler Changed

Event Value

EventHandler