GalleryItemSettings Class

Contains settings that are applied to a GalleryItem. GalleryItemSettings can be set directly on a GalleryItem via its Settings property or on the GalleryTool.ItemSettings property to serve as a default for all GalleryItems.

Syntax

Visual Basic

'Declaration
 
Public Class GalleryItemSettings 
   Inherits Infragistics.DependencyObjectNotifier

C#

public class GalleryItemSettings : Infragistics.DependencyObjectNotifier 

Remarks

The various property values in the GalleryItemSettings specified at the GalleryTool level (via the GalleryTool.ItemSettings property) serve as the ultimate defaults for all GalleryItems. These values can be overridden at two lower levels:

• at the GalleryItemGroup level via the ItemSettings property. The values specified there will override corresponding values set at the GalleryTool level, but could be further overridden at the GalleryItem level (see next bullet)
• at the GalleryItem level via the Settings property. The values specified here will override corresponding values set at the GalleryTool and GalleryItemGroup levels

Example

The following example shows how to use the GalleryItemSettings calss.

Visual Basic

Imports System
 Imports System.Windows
 Imports Infragistics.Windows.Ribbon


Namespace MyNamespace
	Public Partial Class MyWindow
		Inherits XamRibbonWindow
		Public Sub New()
			InitializeComponent()
		End Sub

		Protected Sub LoadGalleryTool()
			Dim setting As New GalleryItemSettings()
			setting.TextDisplayMode = GalleryItemTextDisplayMode.Always
			setting.TextPlacement = TextPlacement.AboveImage
			setting.SelectionDisplayMode = GalleryItemSelectionDisplayMode.HighlightEntireItem
			setting.HorizontalTextAlignment = TextAlignment.Center
			setting.VerticalTextAlignment = VerticalAlignment.Top

			....

			Dim item As New GalleryItem()
			item.Key = "Item10
			item.Text = "Item10"
			item.Image = New BitmapImage(New Uri("\Images\ig_office_icon_16.png", UriKind.Relative))
			item.Tag = "myTag"
			item.Settings = settings
			galleryTool.Items.Add(item)

			.....

		End Sub
	End Class
End Namespace

C#

using System;
using System.Windows;
using Infragistics.Windows.Ribbon;


namespace MyNamespace
{
    public partial class MyWindow : XamRibbonWindow
    {
        public MyWindow()
        {
            InitializeComponent();
        }

        protected void LoadGalleryTool()
        {
            GalleryItemSettings setting = new GalleryItemSettings();
            setting.TextDisplayMode = GalleryItemTextDisplayMode.Always;
            setting.TextPlacement = TextPlacement.AboveImage;
            setting.SelectionDisplayMode = GalleryItemSelectionDisplayMode.HighlightEntireItem;
            setting.HorizontalTextAlignment = TextAlignment.Center;
            setting.VerticalTextAlignment = VerticalAlignment.Top;

            GalleryItem item = new GalleryItem();
            item.Key = "Item10";
            item.Text = "Item10";
            item.Image = new BitmapImage(new Uri("\\Images\\ig_office_icon_16.png", UriKind.Relative));
            item.Tag = "myTag";
            item.Settings = settings;

            galleryTool.Items.Add(item);
        }
    }
}

XAML

<igRibbon:XamRibbonWindow x:Class="MyWindow"
    xmlns:igRibbon="http://infragistics.com/Ribbon"
    xmlns:s="clr-namespace:System;assembly=mscorlib">

  ....

    <igRibbon:RibbonGroup Id="groupId" Caption="Group">
        <igRibbon:MenuTool ShouldDisplayGalleryPreview="True" Caption="GalleryToolMenu">
            <igRibbon:GalleryTool Name="galleryToolItems" >
                <igRibbon:GalleryTool.Items> 
                    <igRibbon:GalleryItem Key="Item1" Text="Item1" Image="\Images\ig_office_icon_16.png"/>
                    <igRibbon:GalleryItem Key="Item2" Text="Item2" Image="\Images\ig_office_icon_16.png"/>
                    <igRibbon:GalleryItem Key="Item3" Text="Item3" Image="\Images\ig_office_icon_16.png"/>
                    <igRibbon:GalleryItem Key="Item4" Text="Item4" Image="\Images\ig_office_icon_16.png"/>
                    <igRibbon:GalleryItem Key="Item5" Text="Item5" Image="\Images\ig_office_icon_16.png" ColumnSpan="3"/>
                    <igRibbon:GalleryItem Key="Item6" Text="Item6" Image="\Images\ig_office_icon_16.png"/>
                    <igRibbon:GalleryItem Key="Item7" Text="Item7" Image="\Images\ig_office_icon_16.png" Tag="myTag"/>
                    <igRibbon:GalleryItem Key="Item8" Text="Item8" Image="\Images\ig_office_icon_16.png"/>
                    <igRibbon:GalleryItem Key="Item9" Text="Item9" Image="\Images\ig_office_icon_16.png" IsSelected="True"/>
                    
                    <!-- set only one item setting -->
                    <igRibbon:GalleryItem Key="Item10" Text="Item10" Image="\Images\ig_office_icon_16.png">
                        <igRibbon:GalleryItem.Settings>
                            <igRibbon:GalleryItemSettings 
                                TextDisplayMode="Always" 
                                TextPlacement="AboveImage" 
                                HorizontalTextAlignment="Center"
                                VerticalTextAlignment="Top"
                                SelectionDisplayMode="HighlightEntireItem"/>
                        </igRibbon:GalleryItem.Settings>
                    </igRibbon:GalleryItem>
                    
                    <igRibbon:GalleryItem Key="Item11" Text="Item11" Image="\Images\ig_office_icon_16.png"/>
                </igRibbon:GalleryTool.Items>
            </igRibbon:GalleryTool>
        </igRibbon:MenuTool>
    </igRibbon:RibbonGroup> 

  ....

</igRibbon:XamRibbonWindow>

Requirements

Target Platforms: Windows 10, Windows 8.1, Windows 8, Windows 7, Windows Server 2012, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2