BarCommandLink Class

public abstract class BarCommandLink : UIElement, IInputElement, IUIElement, ILogicalTreeNode, IDpiAwareElement, IDisposable, IImageListProvider

public BarCommandLink(BarCommand command)

Parameter	Type	Description
command	BarCommand	The BarCommand upon which the link is based.

[Browsable(false)]
public IBarControl BarControl { get; }

Property Value

IBarControl:

The IBarControl that contains the link.

public bool BeginAGroup { get; set; }

Property Value

bool:

true if the command link begins a group; otherwise, false.

[Browsable(false)]
public BarCommand CommandCore { get; }

Property Value

BarCommand:

The BarCommand to link to.

[Browsable(false)]
public Image DefaultImage { get; set; }

Property Value

Image:

The default Image displayed for the bar command link that overrides the default bar command image. The default value is null.

[Browsable(false)]
public string DefaultText { get; set; }

Property Value

string:

The default text of the bar command link that overrides the default bar command text.

public BarCommandLinkDisplayStyle DisplayStyle { get; set; }

Property Value

BarCommandLinkDisplayStyle:

A BarCommandLinkDisplayStyle specifying the display style of the command link.

public DefaultableBoolean Enabled { get; set; }

Property Value

DefaultableBoolean:

A DefaultableBoolean indicating if the command link is enabled. If its value is Default, then the value of the Enabled property is used.

[Browsable(false)]
public virtual bool HasImage { get; }

Property Value

bool:

true if the command link has an image that can be displayed; otherwise, false.

public Image Image { get; set; }

Property Value

Image:

The Image displayed for the bar command link that overrides the default bar command image. The default value is null.

[ImageIndex]
[TypeConverter(typeof(ImageIndexConverter))]
public int ImageIndex { get; set; }

Property Value

int:

The index of an image within an ImageList that overrides the default bar command image. The default value is -1.

protected override bool InvalidateOnMouseEvents { get; }

Property Value

bool:

true if the element should be invalidated when mouse events occur.

protected virtual bool IsClickableInCustomizeMode { get; }

Property Value

bool:

true if the link is clickable in customize mode; otherwise, false.

[Browsable(false)]
public bool IsMergeModified { get; }

Property Value

bool:

true if the command link has been modified from a merge operation; otherwise, false.

[Browsable(false)]
public bool IsSelected { get; }

Property Value

bool:

true if the command link is selected in its parent IBarControl; otherwise, false.

public BarMergeAction MergeAction { get; set; }

Property Value

BarMergeAction:

A BarMergeAction indicating the type of merge action to perform on the link when it is merged onto another IBarControl.

public string MergeKey { get; set; }

Property Value

string:

The key to use when merging links, if the command's full name should not be used.

Remarks

The resolved merge key defaults to the command's full name, unless this property overrides it. If the command link is a merge source command link, the resolved merge key looks for a match on the target command link collection. If the command link is a merge target command link, the resolved merge key is used for matching against source command links.

[Browsable(false)]
public char Mnemonic { get; }

Property Value

char:

A character that represents the mnemonic character associated with this command link. Returns the null character '\0' if no mnemonic character is specified in the text of the command link.

[Browsable(false)]
public Rectangle ScreenBounds { get; }

Property Value

Rectangle:

The screen bounds of the command link.

[TypeConverter(typeof(StringConverter))]
public object Tag { get; set; }

Property Value

object:

An object that contains user-defined data about the control. The default is null.

Remarks

Any type derived from the object class can be assigned to this property.

public string Text { get; set; }

Property Value

string:

The text of the bar command link that overrides the default bar command text.

public bool Visible { get; set; }

Property Value

bool:

true if the command link should be visible if space permits; otherwise, false.

protected virtual bool VisibleCore { get; set; }

Property Value

bool:

true if the command link is visible; otherwise, false.

public virtual BarCommandLink Clone()

Returns

BarCommandLink:

The copy of the BarCommandLink.

public virtual bool GetEnabled()

Returns

bool:

true if the command link is enabled; otherwise, false.

Remarks

This method resolves Enabled property with the Enabled setting on the bar command.

public virtual Image GetImage()

Returns

Image:

The Image to use for the command link.

public virtual Size GetImageSize()

Returns

Size:

The size of the Image to use for the command link.

protected virtual char GetMnemonic()

Returns

char:

The mnemonic character for this link.

Remarks

This method is called after a command's Text property changes.

public virtual string GetText()

Returns

string:

The text to use for the command link.

Remarks

This method resolves the text to display in the user interface for the command link.

public virtual string GetToolTipText()

Returns

string:

The text to use for the command link tooltips.

protected virtual bool IsDifferentFromDefault(BarCommandLink defaultCommandLink)

Parameter	Type	Description
defaultCommandLink	BarCommandLink	The BarCommandLink to examine.

Returns

bool:

true if the command link is different from the specified BarCommandLink.

protected override Size MeasureOverride(Graphics g, Size availableSize)

Parameter	Type	Description
g	Graphics	The Graphics object to use for measurement.
availableSize	Size	The available size that this element can give to child elements. Infinity can be specified as a value to indicate that the element will size to whatever content is available.

Returns

Size:

The size that this element determines it needs during layout, based on its calculations of child element sizes.

Remarks

Element authors should override this method, call Measure on each visible child element and determine the total size required.

protected virtual void OnEnabledChanged(EventArgs e)

Parameter	Type	Description
e	EventArgs	An EventArgs that contains the event data.

protected virtual void OnIsSelectedChanged(EventArgs e)

Parameter	Type	Description
e	EventArgs	An EventArgs that contains the event data.

protected override void OnMouseEnter(MouseEventArgs e)

Parameter	Type	Description
e	MouseEventArgs	A MouseEventArgs that contains the event data.

protected override void OnMouseLeave(MouseEventArgs e)

Parameter	Type	Description
e	MouseEventArgs	A MouseEventArgs that contains the event data.

protected override void OnParentChanged()

protected virtual void Process(BarProcessEventArgs e)

Parameter	Type	Description
e	BarProcessEventArgs	A BarProcessEventArgs that contains the event data.

protected virtual DefaultableBoolean ProcessKeyDown(Keys key)

Parameter	Type	Description
key	Keys	A Keys indicating the key that was pressed.

Returns

DefaultableBoolean:

DefaultableBoolean.True if the key was handled. DefaultableBoolean.Default if the key was not handled but should be allowed to process to the appropriate control. DefaultableBoolean.False if the key was not handled and the BarManager should process the key.

protected virtual void ReadAttributesFromXml(BarLayoutXmlSerializer serializer)

Parameter	Type	Description
serializer	BarLayoutXmlSerializer	The BarLayoutXmlSerializer to use.

protected virtual void ReadElementFromXml(BarLayoutXmlSerializer serializer)

Parameter	Type	Description
serializer	BarLayoutXmlSerializer	The BarLayoutXmlSerializer to use.

public virtual void ResetBeginAGroup()

public virtual void ResetDefaultImage()

public virtual void ResetDefaultText()

public virtual void ResetDisplayStyle()

public virtual void ResetEnabled()

public virtual void ResetImage()

public virtual void ResetImageIndex()

public virtual void ResetMergeAction()

public virtual void ResetMergeKey()

public virtual void ResetText()

public virtual void ResetVisible()

public bool ShouldDisplayImage()

Returns

bool:

true if an image should be displayed; otherwise, false.

public bool ShouldDisplayText()

Returns

bool:

true if text should be displayed; otherwise, false.

public virtual bool ShouldSerializeBeginAGroup()

Returns

bool:

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

public virtual bool ShouldSerializeDefaultImage()

Returns

bool:

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

public virtual bool ShouldSerializeDefaultText()

Returns

bool:

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

public virtual bool ShouldSerializeDisplayStyle()

Returns

bool:

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

public virtual bool ShouldSerializeEnabled()

Returns

bool:

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

public virtual bool ShouldSerializeImage()

Returns

bool:

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

public virtual bool ShouldSerializeImageIndex()

Returns

bool:

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

public virtual bool ShouldSerializeMergeAction()

Returns

bool:

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

public virtual bool ShouldSerializeMergeKey()

Returns

bool:

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

public virtual bool ShouldSerializeText()

Returns

bool:

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

public virtual bool ShouldSerializeVisible()

Returns

bool:

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

protected virtual void WriteAttributesToXml(BarLayoutXmlSerializer serializer, BarCommandLink defaultCommandLink)

Parameter	Type	Description
serializer	BarLayoutXmlSerializer	The BarLayoutXmlSerializer to use.
defaultCommandLink	BarCommandLink	The default BarCommandLink that is used for differential layout comparison.

protected virtual void WriteElementsToXml(BarLayoutXmlSerializer serializer, BarCommandLink defaultCommandLink)

Parameter	Type	Description
serializer	BarLayoutXmlSerializer	The BarLayoutXmlSerializer to use.
defaultCommandLink	BarCommandLink	The default BarCommandLink that is used for differential layout comparison.