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

BarExpanderButtonCommand Class

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

Represents a bar button command that causes a popup when in a toolbar or expands when in a menu.

public class BarExpanderButtonCommand : BarCommand, IImageListProvider
Inheritance:
Object Command BarCommand Object
Implements:
IImageListProvider

Constructors

BarExpanderButtonCommand(String, String, String, Int32)

Initializes a new instance of the BarExpanderButtonCommand class.

public BarExpanderButtonCommand(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 Int32

The index of an image within an ImageList.

BarExpanderButtonCommand(String, String, String, Int32, Boolean)

Initializes a new instance of the BarExpanderButtonCommand class.

public BarExpanderButtonCommand(string category, string name, string text, int imageIndex, bool enabled)
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 Int32

The index of an image within an ImageList.
enabled Boolean

Whether the button is enabled.

Properties

Gets the BarCommandLinkCollection containing the command links for use in the button's popup.

public BarCommandLinkCollection CommandLinks { get; }

Property Value

BarCommandLinkCollection:

The BarCommandLinkCollection containing the command links for use in the button's popup.

PopulationStyle

Gets or sets the child command link population style.

public BarExpanderButtonCommandPopulationStyle PopulationStyle { get; set; }

Property Value

BarExpanderButtonCommandPopulationStyle:

A BarExpanderButtonCommandPopulationStyle indicating the child command link population style.

UseToolBarStyleForPopupMenu

Gets or sets whether to display the popup menu using a toolbar style.

public bool UseToolBarStyleForPopupMenu { get; set; }

Property Value

Boolean:

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:

The copy of the BarCommand.

Creates a new BarCommandLink for the command.

public override BarCommandLink CreateCommandLink()

Returns

BarCommandLink:

The BarCommandLink that was created.

Process(BarProcessEventArgs)

Performs processing based on some sort of event.

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

A BarProcessEventArgs that contains 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.

ResetPopulationStyle()

Resets the PopulationStyle property to its default value.

public virtual void ResetPopulationStyle()

ResetUseToolBarStyleForPopupMenu()

Resets the UseToolBarStyleForPopupMenu property to its default value.

public virtual void ResetUseToolBarStyleForPopupMenu()

ShouldSerializePopulationStyle()

Indicates whether the PopulationStyle property should be persisted.

public virtual bool ShouldSerializePopulationStyle()

Returns

Boolean:

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

Boolean:

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.

Inherited Members