Abstract base for interactive (clickable) Ribbon items that can render text, images, sizes and participate in Quick Access / sizing logic through shared renderer infrastructure.
Definition
Namespace:Telerik.Web.UI
Assembly:Telerik.Web.UI.dll
Syntax:
public abstract class RibbonBarClickableItem : RibbonBarItem, IComponent, IDisposable, IParserAccessor, IUrlResolutionService, IDataBindingsAccessor, IControlBuilderAccessor, IControlDesignerAccessor, IExpressionsAccessor, IAttributeAccessor, IRibbonBarSubComponentInheritance: objectControlWebControlRibbonBarItemRibbonBarClickableItem
Derived Classes:
Implements:
Inherited Members
Constructors
protected RibbonBarClickableItem()Properties
Gets or sets the small (or in Clip ImageRenderingMode both small and large) disabled image's URL of a certain item.
public string DisabledImageUrl { get; set; }The URL to the image. The default value is empty string.
Use the DisabledImageUrl property to specify a custom image that will be used when the item has Size = RibbonBarItemSize.Small or RibbonBarItemSize.Medium, when in Dual mode and all sizes in Clip mode and at the same time disabled.
Gets or sets the large image's URL of a certain item for disabled state.
public string DisabledImageUrlLarge { get; set; }The URL to the image. The default value is empty string.
Use the DisabledImageUrlLarge property to specify a custom image that will be used when the item has Size = RibbonBarItemSize.Large and is disabled.
Gets or sets the rendered alt text of the item's image dom element.
public string ImageAltText { get; set; }alt text of an item's image. The default value is empty string.
Use the property to set the alt text for the item's image element, when needed for accessibility.
Gets/sets the Image Rendering Mode, localy for the item.
[ClientPersistedProperty]
public virtual RibbonBarImageRenderingMode ImageRenderingMode { get; set; }The value is from the enum RibbonBarImageRenderingMode. It depends of the value of ImageRenderingMode property of RadRibbonBar.
In case ImageRenderingMode is not explicitly set (meaning RibbonBar's ImageRenderingMode is Auto), it's considered as follows:
- If ImageUrl is set and ImageUrlLarge is not set - the mode is Clip;
- Any other case - Dual.
Gets or sets the small (or in Clip ImageRenderingMode both small and large) image's URL of a certain item.
[ClientPersistedProperty]
public string ImageUrl { get; set; }The URL to the image. The default value is empty string.
Use the ImageUrl property to specify a custom image that will be used when the item has Size = RibbonBarItemSize.Small or RibbonBarItemSize.Medium, when in Dual mode and all sizes in Clip mode.
Gets or sets the large image's URL of a certain item.
[ClientPersistedProperty]
public string ImageUrlLarge { get; set; }The URL to the image. The default value is empty string.
Use the ImageUrlLarge property to specify a custom image that will be used when the item has Size = RibbonBarItemSize.Large.
public RibbonBarItemQuickAccess QuickAccess { get; set; }Gets or sets the size of a certain item. This property is used to determine a combination of Text, ImageUrl and ImageUrlLarge which should be displayed at initial load of the RibbonBar for a specific item.
[ClientPersistedProperty]
public virtual RibbonBarItemSize Size { get; set; }The value is from the enum RibbonBarItemSize. The default value is RibbonBarItemSize.Small.
Use the Size property to specify the item's initial size:
- For small icon - RibbonBarItemSize.Small;
- For small icon with text - RibbonBarItemSize.Medium;
- For large icon with text - RibbonBarItemSize.Large.
protected override HtmlTextWriterTag TagKey { get; }Overrides:
Gets or sets the text of a certain item.
public string Text { get; set; }The text of an item. The default value is empty string.
Use the property to set the displayed text for an item.
Gets or sets the tooltip of a certain item.
public override string ToolTip { get; set; }The text displayed in the RibbonbBar's enhanced ToolTip. The default value is empty string.
Overrides:
When the ToolTip value is empty, the default ASP ToolTip is displayed with the Text of the item as a value. When ToolTip is set, the enhanced RibbonBar tooltip is shown instead of the default one.
Methods
protected override void AddAttributesToRender(HtmlTextWriter writer)Overrides:
public override void RenderBeginTag(HtmlTextWriter writer)Overrides:
protected override void RenderContents(HtmlTextWriter writer)Overrides: