TdxRibbonSkinSelector Class
A Ribbon Skin Selector component.
Declaration
TdxRibbonSkinSelector = class(
TdxRibbonCompositeItem,
IdxLocalizerListener
)Remarks
A Ribbon Skin Selector is a gallery-like component that allows users to switch between skins and color schemes (vector skin palettes) in an application. The Ribbon Skin Selector requires a TdxSkinController component to load and manage skins in an application. Ribbon Skin Selector and Skin Controller states are always synchronized.
The Ribbon Skin Selector automatically loads all skins and corresponding color palettes from resources when the application starts. You can customize the lists of available skins and palettes in code.
Main API Members
The list below outlines key members of the TdxRibbonSkinSelector class that allow you to configure a Skin Selector in a Ribbon UI and manage lists of available skins and color schemes.
Appearance and Behavior Settings
- PaletteChooserOptions | SkinChooserOptions
- Provide access to skin and palette chooser gallery settings.
Content Management APIs
- LoadFromFile | LoadFromStream
- Load skins from a SKINRES file or a stream.
- OnAddSkin | OnAddPalette
- Allow you to exclude certain skins and palettes from the lists of available options. The SkinChooserOptions.VisibleGroups property defines the base list of visible skin groups.
- Refresh
- Reloads all skins from the current skin source (an application resource, SKINRES file, or stream).
- Reset
- Clears the Ribbon Skin Selector and reloads all skins from resources.
General-Purpose API Members
- CreateSkinSelector
- Creates a Ribbon Skin Selector component in the specified parent toolbar in a Ribbon UI.
- BeginUpdate | EndUpdate
- Allow you to avoid excessive redraw operations during batch data and appearance changes.
- Enabled
- Specifies if the Ribbon Skin Selector is enabled.
Create a Ribbon Skin Selector at Design Time
To add a Ribbon Skin Selector component to your Ribbon UI, right-click a toolbar, move the mouse pointer to the Add Item context menu item to display the corresponding submenu, and click the TdxRibbonSkinSelector item.
The created Ribbon Skin Selector automatically loads skins from application resources according to SkinChooserOptions.VisibleGroups and SkinChooserOptions.VisibleLookAndFeelStyles property values at application startup.
Make sure that your application project includes a TdxSkinController component. Without it, the Ribbon Skin Selector is unable to load and apply skins and color palettes.