Not logged in▾
Log In Register
Forgot Password Resend Validation E-mail
In This Article

BarSplitButtonCommand Class

Namespace:
ActiproSoftware.UI.WinForms.Controls.Bars
Assembly:
ActiproSoftware.Bars.WinForms.dll

Represents a bar button command with a split drop-down.

public class BarSplitButtonCommand : BarCommand, IImageListProvider, IBarCheckableCommand, IBarClickableCommand, IBarPopupCommand, IHasDefaultCommandLinks
Inheritance:
object Command BarCommand object
Implements:
IImageListProvider IBarCheckableCommand IBarClickableCommand IBarPopupCommand IHasDefaultCommandLinks

Constructors

BarSplitButtonCommand(string, string, string?, int)

Initializes an instance of the class.

public BarSplitButtonCommand(string category, string name, string? text, int imageIndex)
Parameter Type Description
category string

The category of the bar command.
name string

The name of the bar command.
text string

The text caption.
imageIndex int

The index of an image within an ImageList.

BarSplitButtonCommand(string, string, string?, int, bool?, bool?, bool?)

Initializes an instance of the class.

public BarSplitButtonCommand(string category, string name, string? text = null, int imageIndex = -1, bool? enabled = null, bool? checkable = null, bool? isChecked = null)
Parameter Type Description
category string

The category of the bar command.
name string

The name of the bar command.
text string

The text caption.
imageIndex int

The index of an image within an ImageList.
enabled bool?

Whether the button is enabled. When null, the default value is assigned (which is true unless overridden by a derived class).
checkable bool?

Whether the button is checkable. When null, the default value is assigned (which is false unless overridden by a derived class).
isChecked bool?

Whether the button is currently checked. When null, the default value is assigned (which is false unless overridden by a derived class).

Properties

CanTearOff

Indicates whether the popup menu can be torn-off onto a DockableToolBar.

public bool CanTearOff { get; set; }

Property Value

bool:

true if the popup menu can be torn-off onto a DockableToolBar; otherwise, false.

CheckGroupName

The name of the check group.

public string? CheckGroupName { get; set; }

Property Value

string

Checkable

Indicates whether the button is checkable.

public bool Checkable { get; set; }

Property Value

bool:

true if the button is checkable; otherwise, false.

Checked

Indicates whether the button is checked.

public bool Checked { get; set; }

Property Value

bool:

true if the button is checked; otherwise, false.

The BarCommandLinkCollection containing the default command links for use with the object.

public BarCommandLinkCollection DefaultCommandLinks { get; }

Property Value

BarCommandLinkCollection

TearOffDockableToolBarKey

The key of the DockableToolBar that is created if a tear-off occurs.

public string? TearOffDockableToolBarKey { get; set; }

Property Value

string

UseToolBarStyleForPopupMenu

Indicates whether to display the popup menu using a toolbar style.

public bool UseToolBarStyleForPopupMenu { get; set; }

Property Value

bool:

true if a toolbar style should be used; otherwise, false.

Methods

CloneToType(Type)

Creates a copy of the BarCommand.

protected override BarCommand CloneToType(Type targetType)
Parameter Type Description
targetType Type

The target Type.

Returns

BarCommand

Creates a new BarCommandLink for the command.

public override BarCommandLink CreateCommandLink()

Returns

BarCommandLink

OnClick(BarCommandLinkEventArgs)

Raises the Click event.

protected virtual void OnClick(BarCommandLinkEventArgs e)
Parameter Type Description
e BarCommandLinkEventArgs

The event data.

Process(BarProcessEventArgs)

Performs processing based on some sort of event.

protected override void Process(BarProcessEventArgs e)
Parameter Type Description
e BarProcessEventArgs

The event data.

ReadAttributesFromXml(BarLayoutXmlSerializer)

Deserializes the attribute data for the BarCommandLink from XML.

protected override void ReadAttributesFromXml(BarLayoutXmlSerializer serializer)
Parameter Type Description
serializer BarLayoutXmlSerializer

The BarLayoutXmlSerializer to use.

ReadElementFromXml(BarLayoutXmlSerializer)

Deserializes a child element for the BarCommandLink from XML.

protected override void ReadElementFromXml(BarLayoutXmlSerializer serializer)
Parameter Type Description
serializer BarLayoutXmlSerializer

The BarLayoutXmlSerializer to use.

ResetCanCustomizeKeyboardShortcuts()

Resets the CanCustomizeKeyboardShortcuts property to its default value.

public override void ResetCanCustomizeKeyboardShortcuts()

ResetCanTearOff()

Resets the CanTearOff property to its default value.

public virtual void ResetCanTearOff()

ResetCheckGroupName()

Resets the CheckGroupName property to its default value.

public virtual void ResetCheckGroupName()

ResetCheckable()

Resets the Checkable property to its default value.

public virtual void ResetCheckable()

ResetChecked()

Resets the Checked property to its default value.

public virtual void ResetChecked()

ResetTearOffDockableToolBarKey()

Resets the TearOffDockableToolBarKey property to its default value.

public virtual void ResetTearOffDockableToolBarKey()

ResetUseToolBarStyleForPopupMenu()

Resets the UseToolBarStyleForPopupMenu property to its default value.

public virtual void ResetUseToolBarStyleForPopupMenu()

ShouldSerializeCanCustomizeKeyboardShortcuts()

Indicates whether the CanCustomizeKeyboardShortcuts property should be persisted.

public override bool ShouldSerializeCanCustomizeKeyboardShortcuts()

Returns

bool:

true if the property value has changed from its default; otherwise, false.

ShouldSerializeCanTearOff()

Indicates whether the CanTearOff property should be persisted.

public virtual bool ShouldSerializeCanTearOff()

Returns

bool:

true if the property value has changed from its default; otherwise, false.

ShouldSerializeCheckGroupName()

Indicates whether the CheckGroupName property should be persisted.

public virtual bool ShouldSerializeCheckGroupName()

Returns

bool:

true if the property value has changed from its default; otherwise, false.

ShouldSerializeCheckable()

Indicates whether the Checkable property should be persisted.

public virtual bool ShouldSerializeCheckable()

Returns

bool:

true if the property value has changed from its default; otherwise, false.

ShouldSerializeChecked()

Indicates whether the Checked property should be persisted.

public virtual bool ShouldSerializeChecked()

Returns

bool:

true if the property value has changed from its default; otherwise, false.

ShouldSerializeTearOffDockableToolBarKey()

Indicates whether the TearOffDockableToolBarKey property should be persisted.

public virtual bool ShouldSerializeTearOffDockableToolBarKey()

Returns

bool:

true if the property value has changed from its default; otherwise, false.

ShouldSerializeUseToolBarStyleForPopupMenu()

Indicates whether the UseToolBarStyleForPopupMenu property should be persisted.

public virtual bool ShouldSerializeUseToolBarStyleForPopupMenu()

Returns

bool:

true if the property value has changed from its default; otherwise, false.

WriteAttributesToXml(BarLayoutXmlSerializer)

Serializes the attribute data for the BarCommand to XML.

protected override void WriteAttributesToXml(BarLayoutXmlSerializer serializer)
Parameter Type Description
serializer BarLayoutXmlSerializer

The BarLayoutXmlSerializer to use.

WriteElementsToXml(BarLayoutXmlSerializer)

Serializes the child element data for the BarCommand to XML.

protected override void WriteElementsToXml(BarLayoutXmlSerializer serializer)
Parameter Type Description
serializer BarLayoutXmlSerializer

The BarLayoutXmlSerializer to use.

Events

Click

Occurs when a BarCommand is clicked.

public event BarCommandLinkEventHandler? Click

Event Type

BarCommandLinkEventHandler

Inherited Members

Extension Methods