Class CaptionButtonsCollection

Caption Buttons collection.

Inheritance

System.Object

CaptionButtonsCollection

Namespace: Syncfusion.Windows.Forms.Tools

Assembly: Syncfusion.Tools.Windows.dll

Syntax

public class CaptionButtonsCollection : CollectionBase

Constructors

CaptionButtonsCollection()

Declaration

public CaptionButtonsCollection()

Properties

Item[Int32]

Gets /Sets the index of the caption button.

Declaration

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

Parameters

Type	Name	Description
System.Int32	index	The index of the caption button

Property Value

Type
CaptionButton

Item[String]

Gets / Sets the name of the caption button.

Declaration

public CaptionButton this[string name] { get; set; }

Parameters

Type	Name	Description
System.String	name	The name of the caption button.

Property Value

Type
CaptionButton

Methods

Add(CaptionButton)

Adds the caption button to the control.

Declaration

public virtual void Add(CaptionButton button)

Parameters

Type	Name	Description
CaptionButton	button	The CaptionButton instance.

button_TypeChanging(Object, CancelEventArgs)

Declaration

protected virtual void button_TypeChanging(object sender, CancelEventArgs e)

Parameters

Type	Name	Description
System.Object	sender
System.ComponentModel.CancelEventArgs	e

Clone()

Returns the cloned CaptionButtonsCollection.

Declaration

public CaptionButtonsCollection Clone()

Returns

Type
CaptionButtonsCollection

Contains(CaptionButton)

Returns whether the CaptionButtonsCollection contains the Caption button.

Declaration

public bool Contains(CaptionButton button)

Parameters

Type	Name	Description
CaptionButton	button	The Caption Button instance.

Returns

Type
System.Boolean

ContainsButtonType(CaptionButtonType)

Declaration

protected bool ContainsButtonType(CaptionButtonType type)

Parameters

Type	Name	Description
CaptionButtonType	type

Returns

Type
System.Boolean

ContainsName(String)

Declaration

protected bool ContainsName(string name)

Parameters

Type	Name	Description
System.String	name

Returns

Type
System.Boolean

Dispose()

Dispose the caption button.

Declaration

public void Dispose()

ExcludeCommonButtonsWith(CaptionButtonsCollection)

Exclude the common buttons

Declaration

public void ExcludeCommonButtonsWith(CaptionButtonsCollection collection)

Parameters

Type	Name	Description
CaptionButtonsCollection	collection	The CaptionButtonsCollection instance.

GetCaptionButtonDefaultName()

Declaration

protected string GetCaptionButtonDefaultName()

Returns

Type
System.String

IndexOf(CaptionButton)

Returns the index of the Caption button.

Declaration

public int IndexOf(CaptionButton button)

Parameters

Type	Name	Description
CaptionButton	button	The Caption Button instance.

Returns

Type
System.Int32

Insert(Int32, CaptionButton)

Insert the Caption button in specified index.

Declaration

public virtual void Insert(int index, CaptionButton button)

Parameters

Type	Name	Description
System.Int32	index
CaptionButton	button	The Caption Button instance.

MergeWith(CaptionButtonsCollection, Boolean)

Serves to merge with caption buttons collection.

Declaration

public void MergeWith(CaptionButtonsCollection collection, bool bCloneButtons)

Parameters

Type	Name	Description
CaptionButtonsCollection	collection	The CaptionButtonsCollection instance.
System.Boolean	bCloneButtons	Indicates whether the CaptionButtonsCollection are cloned.

OnClear()

Declaration

protected override void OnClear()

OnClearComplete()

Declaration

protected override void OnClearComplete()

OnCollectionChanged()

Declaration

protected void OnCollectionChanged()

OnCollectionItemChanged()

Declaration

protected void OnCollectionItemChanged()

OnInsertComplete(Int32, Object)

Declaration

protected override void OnInsertComplete(int index, object value)

Parameters

Type	Name	Description
System.Int32	index
System.Object	value

OnRemove(Int32, Object)

Declaration

protected override void OnRemove(int index, object value)

Parameters

Type	Name	Description
System.Int32	index
System.Object	value

OnRemoveComplete(Int32, Object)

Declaration

protected override void OnRemoveComplete(int index, object value)

Parameters

Type	Name	Description
System.Int32	index
System.Object	value

Remove(CaptionButton)

Remove the Caption button.

Declaration

public void Remove(CaptionButton button)

Parameters

Type	Name	Description
CaptionButton	button	The Caption Button instance.

Events

CollectionChanged

Occurs when the collection changed.

Declaration

public event EventHandler CollectionChanged

Event Type

Type
System.EventHandler

CollectionItemChanged

Occurs when the Collection Item changed.

Declaration

public event EventHandler CollectionItemChanged

Event Type

Type
System.EventHandler