RadGalleryElement
Hosts gallery items in a compact in-ribbon view and displays the gallery's items, groups, filters, and tools in a popup.
Definition
Namespace:Telerik.WinControls.UI
Assembly:Telerik.WinControls.UI.dll
Syntax:
public class RadGalleryElement : RadItem, INotifyPropertyChanged, ICustomTypeDescriptor, ISupportSystemSkin, IBindableComponent, IComponent, IDisposable, ISupportDrag, ISupportDrop, IShortcutProvider, IStylableElement, IStylableNode, IDropDownMenuOwner, IItemsOwner
Inheritance: objectDisposableObjectRadObjectRadElementVisualElementRadComponentElementRadItemRadGalleryElement...
Derived Classes:
Implements:
Inherited Members
Constructors
public RadGalleryElement()
Fields
public static RadProperty IsSelectedProperty
Identifies the MaxColumns property that limits the columns shown in the in-ribbon view.
public static RadProperty MaxColumnsProperty
Identifies the MaxDropDownColumns property that limits the columns shown in the popup.
public static RadProperty MaxDropDownColumnsProperty
Identifies the MaxRows property that limits the rows shown in the in-ribbon view.
public static RadProperty MaxRowsProperty
Identifies the MinDropDownColumns property that sets the minimum number of popup columns.
public static RadProperty MinDropDownColumnsProperty
Properties
Gets tne RadImageButtonElement that represents the down button in the gallery element.
[Browsable(false)]
public RadImageButtonElement DownButton { get; }
Gets or sets value indicating whether DropDownMenu will have the same class name as the owner control or its own. True means that the same class name will be used as the control that opened the dropdown.
public bool DropDownInheritsThemeClassName { get; set; }
Implements:
Gets or sets the resize directions offered by the drop-down popup's sizing grip.
[Browsable(true)]
public SizingMode DropDownSizingMode { get; set; }
Gets or sets a value indicating whether group filtering is enbled when filters are defined.
[Browsable(true)]
public bool FilterEnabled { get; set; }
Gets a collection representing the group filters defined in this gallery.
public RadItemOwnerCollection Filters { get; }
Gets an instance of the RadGalleryDropDownclass that represents the popup control which hosts the RadGalleryPopupElement displayed to the user when he/she clicks on the drop-down button of the gallery.
[Browsable(false)]
public RadGalleryDropDown GalleryDropDown { get; }
Gets an instance of the RadGalleryPopupElementclass that represents the main element put in the RadGalleryDropDown when it is shown to the user. This element holds the content of the gallery, as well as some additional elements like sizing grip etc.
[Browsable(false)]
public RadGalleryPopupElement GalleryPopupElement { get; }
Gets a collection representing the groups contained in this gallery.
public RadItemOwnerCollection Groups { get; }
Gets the BorderPrimitiveinstance that represents the Gallery Element's border.
[Browsable(false)]
public BorderPrimitive InRibbonBorder { get; }
Gets the FillPrimitiveinstance that represents the Gallery Element's fill.
[Browsable(false)]
public FillPrimitive InRibbonFill { get; }
Returns whether the gallery is currently dropped down.
[Browsable(false)]
public bool IsDroppedDown { get; }
Gets a collection representing the items contained in this gallery.
[RadNewItem("", false)]
public RadItemOwnerCollection Items { get; }
Implements:
Gets or sets a value indicating whether the selection of the gallery items is enabled or not.
[Browsable(true)]
public bool ItemSelection { get; set; }
Gets or sets the maximum number of columns to be shown in the in-ribbon portion of the gallery.
public int MaxColumns { get; set; }
Gets or sets the maximum number of columns to be shown in the drop-down portion of the gallery.
public int MaxDropDownColumns { get; set; }
Gets or sets the maximum number of rows to be shown in the in-ribbon portion of the gallery.
public int MaxRows { get; set; }
Gets or sets the minimum number of columns to be shown in the drop-down portion of the gallery.
public int MinDropDownColumns { get; set; }
Gets tne RadImageButtonElement that represents the show popup button in the gallery element.
[Browsable(false)]
public RadImageButtonElement PopupButton { get; }
Gets or sets the currently selected item.
[Browsable(false)]
public RadGalleryItem SelectedItem { get; set; }
Gets the Tools menu items collection where you can add and remove items from the Tools part of the gallery
[RadEditItemsAction]
public RadItemOwnerCollection Tools { get; }
Gets tne RadImageButtonElement that represents the up button in the gallery element.
[Browsable(false)]
public RadImageButtonElement UpButton { get; }
Methods
Closes the gallery's drop-down popup if it is open.
public void CloseDropDown()
Creates the in-ribbon controls and the drop-down elements used to display gallery content.
protected override void CreateChildElements()
Overrides:
Unsubscribes from the drop-down menu events before releasing managed resources.
protected override void DisposeManagedResources()
Overrides:
Initializes the gallery's typed item collections, clipping, and hover-zoom behavior.
protected override void InitializeFields()
Overrides:
Raises the DropDownClosed event.
protected virtual void OnDropDownClosed(RadPopupClosedEventArgs e)
Raises the DropDownClosing event.
protected virtual void OnDropDownClosing(RadPopupClosingEventArgs e)
Raises the DropDownOpened event.
Raises the DropDownOpening event.
Raises the GalleryItemHover event.
protected virtual void OnGalleryItemHover(GalleryItemHoverEventArgs e)
Scrolls the in-ribbon items in response to the mouse wheel and marks a handled-mouse event as handled while the popup is visible.
protected override void OnMouseWheel(MouseEventArgs e)
The mouse-wheel event data.
Overrides:
Transfers focus to the popup button when the gallery element itself receives focus.
protected override void OnPropertyChanged(RadPropertyChangedEventArgs e)
The property-change event data.
Overrides:
Updates the drop-down menu's image list when an image-list change is routed through the element tree.
protected override void OnTunnelEvent(RadElement sender, RoutedEventArgs args)
The element from which the routed event originated.
argsRoutedEventArgsThe routed event data.
Overrides:
Scrolls the in-ribbon items toward the following row and refreshes the scroll-button states.
public void ScrollLineDown()
Scrolls the in-ribbon items toward the preceding row and refreshes the scroll-button states.
public void ScrollLineUp()
Rebuilds and displays the popup from the gallery's current items, groups, filters, and tools. The popup size is constrained by the available screen area and uses DropDownSizingMode.
public void ShowDropDown()
Events
Occurs when the drop-down window has closed.
[Browsable(true)]
public event RadPopupClosedEventHandler DropDownClosed
Occurs when the drop-down is about to be closed.
[Browsable(true)]
public event RadPopupClosingEventHandler DropDownClosing
Occurs when the drop-down has opened.
[Browsable(true)]
public event EventHandler DropDownOpened
Occurs when the drop-down is opening.
[Browsable(true)]
public event CancelEventHandler DropDownOpening
Occurs when the mouse pointer rests on the gallery item.
[Browsable(true)]
public event GalleryItemHoverEventHandler GalleryItemHover