RibbonBarGallery
Displays categorized selectable gallery items (with optional expansion) and supports XML serialization plus configurable layout and item text positioning.
Definition
Namespace:Telerik.Web.UI
Assembly:Telerik.Web.UI.dll
Syntax:
public class RibbonBarGallery : RibbonBarItem, IComponent, IDisposable, IParserAccessor, IUrlResolutionService, IDataBindingsAccessor, IControlBuilderAccessor, IControlDesignerAccessor, IExpressionsAccessor, IAttributeAccessor, IRibbonBarSubComponent, IXmlSerializableInheritance: objectControlWebControlRibbonBarItemRibbonBarGallery
Implements:
Inherited Members
Constructors
public RibbonBarGallery()Properties
Gets a RibbonBarGalleryCategoryCollection object that contains the categories of the Gallery.
[PersistenceMode(PersistenceMode.InnerDefaultProperty)]
public RibbonBarGalleryCategoryCollection Categories { get; }A RibbonBarGalleryCategoryCollection that contains the categories of the Gallery. By default the collection is empty (the Gallery has no categories).
Use the Categories property to access the categories of the Gallery. You can also use the Categories property to manage the categories. You can add, remove or modify categories from the Categories collection.
Gets or sets the number of columns in the gallery.
public int Columns { get; set; }The the number of columns in the gallery. The default value is 5.
Use the property to set the number of columns in the gallery. The Columns property will determine the width of the Gallery.
Gets or sets the commandName of the gallery.
public string CommandName { get; set; }The commandName of the gallery. The default value is empty string.
Use the property to set commandName of the gallery. The CommandName will be passed as an argument when the gallery raises an event.
Gets or sets the number of columns in the expanded gallery.
public int ExpandedColumns { get; set; }The the number of columns in the expanded gallery. The default value is 5.
Use the property to set the number of columns in the expanded gallery. The ExpandedColumns property will determine the width of the Gallery when it is expanded.
Gets or sets the height of the gallery when expanedd.
public Unit ExpandedHeight { get; set; }Gets or sets the height of each RibbonBarGalleryItem in pixels.
public Unit ItemHeight { get; set; }Gets or sets the position of the item text relative to its image.
[ClientPersistedProperty]
public RibbonBarGalleryItemTextPosition ItemTextPosition { get; set; }The value is from the enum RibbonBarGalleryItemTextPosition. The default value is RibbonBarGalleryItemTextPosition.Bottom.
Use the ItemTextPosition property to specify the item's text position:
- Below the image - RibbonBarGalleryItemTextPosition.Bottom;
- Next to the image - RibbonBarGalleryItemTextPosition.Inline;
- Not visible - RibbonBarGalleryItemTextPosition.None.
Gets the type of the RibbonBarItem. Usefull when iterating through the Items collection of RibbonBarGroup
public override RibbonBarItemType ItemType { get; }Overrides:
Gets or sets the width of each RibbonBarGalleryItem in pixels.
public Unit ItemWidth { get; set; }Gets the selected gallery item of the RibbonBarGallery control.
[Browsable(false)]
public RibbonBarGalleryItem SelectedItem { get; }The gallery item that should be selected.
protected override HtmlTextWriterTag TagKey { get; }Overrides:
Methods
protected override void AddAttributesToRender(HtmlTextWriter writer)Overrides:
Clears the selection. The Selected property of all items is set to false.
public void ClearSelection()protected override void RenderContents(HtmlTextWriter writer)Overrides: