Settings Property

Returns/sets the settings that will be used for the GalleryItem.

Syntax

Visual Basic

'Declaration
 
Public Property Settings As GalleryItemSettings

C#

public GalleryItemSettings Settings {get; set;}

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 GalleryItemGroup.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 Settings property to specify the settings that will be used for the GalleryItem.

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
           
            Dim item As New GalleryItem()
            item.Key = "Item1"
            item.Text = "First Item"
            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;

            GalleryItem item = new GalleryItem();
            item.Key = "Item1";
            item.Text = "First Item";
            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="First Item" Image="\Images\ig_office_icon_16.png">
                            <!-- set only one item setting -->
                            <igRibbon:GalleryItem.Settings>
                                <igRibbon:GalleryItemSettings TextDisplayMode="Always" TextPlacement="AboveImage" 
                                                              HorizontalTextAlignment="Center" VerticalTextAlignment="Top"
                                                              SelectionDisplayMode="HighlightEntireItem"/>
                            </igRibbon:GalleryItem.Settings>
                        </igRibbon:GalleryItem>
                        
                        <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: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