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

BarCustomControlCommand Class

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

Represents a bar custom control command.

public abstract class BarCustomControlCommand : BarCommand, IImageListProvider
Inheritance:
object Command BarCommand object
Derived:
BarComboBoxCommand BarTextBoxCommand
Implements:
IImageListProvider

Constructors

BarCustomControlCommand(string, string, string, int)

Initializes a new instance of the BarCustomControlCommand class.

public BarCustomControlCommand(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.

Properties

ControlValue

Gets or sets the string value of the custom control.

public virtual string ControlValue { get; set; }

Property Value

string:

The string value of the custom control.

SupportsVerticalDisplay

Gets whether the bar command supports a vertical display.

protected override sealed bool SupportsVerticalDisplay { get; }

Property Value

bool:

true if the bar command supports a vertical display; otherwise, false.

Width

Gets or sets the width of the control.

public int Width { get; set; }

Property Value

int:

The width of the control.

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.

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.

ResetControlValue()

Resets the ControlValue property to its default value.

public virtual void ResetControlValue()

ResetTextVisibleOnToolBars()

Resets the ActiproSoftware.UI.WinForms.Controls.Bars.BarCustomControlCommand.TextVisibleOnToolBars property to its default value.

public virtual void ResetTextVisibleOnToolBars()

ResetWidth()

Resets the Width property to its default value.

public virtual void ResetWidth()

ShouldSerializeControlValue()

Indicates whether the ControlValue property should be persisted.

public virtual bool ShouldSerializeControlValue()

Returns

bool:

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

ShouldSerializeTextVisibleOnToolBars()

Indicates whether the ActiproSoftware.UI.WinForms.Controls.Bars.BarCustomControlCommand.TextVisibleOnToolBars property should be persisted.

public virtual bool ShouldSerializeTextVisibleOnToolBars()

Returns

bool:

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

ShouldSerializeWidth()

Indicates whether the Width property should be persisted.

public virtual bool ShouldSerializeWidth()

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.

Events

ControlValueChanged

Occurs when the ControlValue property is changed.

public event EventHandler ControlValueChanged

Event Type

EventHandler

Inherited Members