BarCustomControlCommand Class
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 an instance of the class.
public BarCustomControlCommand(string category, string name, string? text = null, int imageIndex = -1)| 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 |
Properties
ControlValue
The string value of the custom control.
SupportsVerticalDisplay
Indicates whether the bar command supports a vertical display.
protected override sealed bool SupportsVerticalDisplay { get; }Property Value
- bool:
trueif the bar command supports a vertical display; otherwise,false.
Width
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:
trueif 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:
trueif 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:
trueif 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.
Inherited Members
- BarCommand.ResetCanCustomizeCreate()
- BarCommand.ShouldSerializeCanCustomizeCreate()
- BarCommand.ResetCanCustomizeKeyboardShortcuts()
- BarCommand.ShouldSerializeCanCustomizeKeyboardShortcuts()
- BarCommand.ResetCategory()
- BarCommand.ShouldSerializeCategory()
- BarCommand.CreateCommandLink()
- BarCommand.ResetCustomizeListText()
- BarCommand.ShouldSerializeCustomizeListText()
- BarCommand.ResetEnabled()
- BarCommand.ShouldSerializeEnabled()
- BarCommand.ResetImage()
- BarCommand.ShouldSerializeImage()
- BarCommand.ResetImageIndex()
- BarCommand.ShouldSerializeImageIndex()
- BarCommand.OnEnabledChanged(EventArgs)
- BarCommand.OnProcessingRequested(BarProcessEventArgs)
- BarCommand.Process(BarProcessEventArgs)
- BarCommand.ReadElementFromXml(BarLayoutXmlSerializer)
- BarCommand.ResetStaysOpenOnClick()
- BarCommand.ShouldSerializeStaysOpenOnClick()
- BarCommand.ResetText()
- BarCommand.ShouldSerializeText()
- BarCommand.ResetToolTipEnabled()
- BarCommand.ShouldSerializeToolTipEnabled()
- BarCommand.ResetToolTipText()
- BarCommand.ShouldSerializeToolTipText()
- BarCommand.UpdateState(BarCommandLinkEventArgs)
- BarCommand.WriteElementsToXml(BarLayoutXmlSerializer)
- BarCommand.BarManager
- BarCommand.CanCustomizeCreate
- BarCommand.CanCustomizeKeyboardShortcuts
- BarCommand.Category
- BarCommand.CustomizeListText
- BarCommand.Enabled
- BarCommand.FullName
- BarCommand.Image
- BarCommand.ImageIndex
- BarCommand.KeyboardShortcuts
- BarCommand.Name
- BarCommand.StaysOpenOnClick
- BarCommand.Tag
- BarCommand.Text
- BarCommand.ToolTipEnabled
- BarCommand.ToolTipText
- BarCommand.EnabledChanged
- BarCommand.ProcessingRequested
- object.GetType()
- object.MemberwiseClone()
- object.ToString()
- object.Equals(object)
- object.Equals(object, object)
- object.ReferenceEquals(object, object)
- object.GetHashCode()