New to Telerik UI for WinForms? Start a free 30-day trial

TabStopCollection

Class

Represents a collection of TabStop elements.

Definition

Namespace:Telerik.WinForms.Documents.Model

Assembly:Telerik.WinControls.RichTextEditor.dll

Syntax:

public class TabStopCollection : IList, ICollection, IEnumerable

Inheritance: objectTabStopCollection

Implements: ICollectionIEnumerableIList

Constructors

TabStopCollection()

Initializes a new instance of the TabStopCollection class.

public TabStopCollection()

TabStopCollection(IEnumerable<TabStop>)

Initializes a new instance of the TabStopCollection class.

public TabStopCollection(IEnumerable<TabStop> tabStops)

Parameters:tabStopsIEnumerable<TabStop>

The tab stops to be added to the collection.

TabStopCollection(TabStopCollection)

Initializes a new instance of the TabStopCollection class.

public TabStopCollection(TabStopCollection fromCollection)

Parameters:fromCollectionTabStopCollection

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

Properties

Count

int

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

public int Count { get; }

Implements: ICollection.Count

IsFixedSize

bool

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

public bool IsFixedSize { get; }

Implements: IList.IsFixedSize

IsReadOnly

bool

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

public bool IsReadOnly { get; }

Implements: IList.IsReadOnly

IsSynchronized

bool

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

public bool IsSynchronized { get; }

Implements: ICollection.IsSynchronized

SyncRoot

object

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

public object SyncRoot { get; }

Implements: ICollection.SyncRoot

this[int]

object

Gets or sets the object at the specified index.

public object this[int index] { get; set; }

Parameters:indexint

The index.

Property Value:

The object.

Exceptions:

NotImplementedException

Implements: IList.this[int]

Methods

Add(object)

Adds an item to the IList.

public int Add(object value)

Parameters:valueobject

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)

Add(TabStop)

Adds an item to the ICollection<T>.

public void Add(TabStop item)

Parameters:itemTabStop

The TabStop to add to the ICollection<T>.

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

public void AddRangeCopy(IEnumerable<TabStop> items)

Parameters:itemsIEnumerable<TabStop>

The tab stops to add.

Clear()

Removes all items from the ICollection<T>.

public void Clear()

Implements: IList.Clear()

Clone()

Clones this instance.

public TabStopCollection Clone()

Returns:

TabStopCollection

The cloned instance.

Contains(object)

Determines whether this instance contains the object.

public bool Contains(object value)

Parameters:valueobject

The object to locate in the IList.

Returns:

bool

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

Implements: IList.Contains(object)

Contains(TabStop)

Determines whether this instance contains the TabStop.

public bool Contains(TabStop item)

Parameters:itemTabStop

The TabStop to locate in the ICollection<T>.

Returns:

bool

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

CopyTo(Array, int)

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

public void CopyTo(Array array, int index)

Parameters:arrayArray

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

indexint

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.

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

Parameters:arrayTabStop[]

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

arrayIndexint

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

GetEnumerator()

Returns an enumerator that iterates through the collection.

public IEnumerator<TabStop> GetEnumerator()

Returns:

IEnumerator<TabStop>

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

GetTabStopsByWidth(float)

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

public IEnumerable<TabStop> GetTabStopsByWidth(float width)

Parameters:widthfloat

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.

public IEnumerable<TabStop> GetTrailingDefaultTabStopsByWidth(float width)

Parameters:widthfloat

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.

public int IndexOf(object value)

Parameters:valueobject

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.

public void Insert(int index, object value)

Parameters:indexint

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

valueobject

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

protected virtual void OnAdd(TabStop item)

Parameters:itemTabStop

The TabStop which is added.

OnChange()

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

protected virtual void OnChange()

OnRemove(TabStop)

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

protected virtual void OnRemove(TabStop item)

Parameters:itemTabStop

The TabStop which is removed.

Remove(object)

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

public void Remove(object value)

Parameters:valueobject

The object to remove from the IList.

Implements: IList.Remove(object)

Remove(TabStop)

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

public bool Remove(TabStop item)

Parameters:itemTabStop

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

RemoveAt(int)

Removes the IList item at the specified index.

public void RemoveAt(int index)

Parameters:indexint

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

public void RemoveRange(IEnumerable<TabStop> items)

Parameters:itemsIEnumerable<TabStop>

The tab stops to remove.

Events

Changed

EventHandler

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

public event EventHandler Changed