Setting or Obtaining Active Selection’s Formatting (XamSpreadsheet)

Purpose

This topic explains how to set or obtain active selection’s formatting.

Required background

The following table lists the concept and topics required as a prerequisite to understanding this topic.

Type	Content
Concept	Infragistics Excel Engine

Topic	Purpose
About Infragistics Excel Engine	In this section you will find information that will help you to better understand the object model and the functionalities of the Infragistics Excel Engine .
Features Overview (XamSpreadsheet)	This topic explains in details the features of the XamSpreadsheet control from developer perspective.
Visual Elements Overview (XamSpreadsheet)	This topic provides an overview of the visual elements of the XamSpreadsheet control.

In this topic

This topic contains the following sections:

Introduction
Code Example: Binding a ToggleButton to the Formatting Object’s Bold Property
Related Content

Introduction

Feature summary

The XamSpreadsheet control provides a special property named ActiveSelectionCellRangeFormat of type SpreadsheetCellRangeFormat which can be used to set or obtain different formatting aspects of the active selection, like font properties, alignments, indentation and more.

You can bind some of the properties of this object to different UI elements (like toggle buttons or text boxes) and they will reflect or manipulate the formatting of the active selection’s content.

Note	Note All changes made to the formatting object will also affect all selected worksheets by the user.

Code Example: Binding a ToggleButton to the Formatting Object’s Bold Property

Description

The following example demonstrates how to bind a ToggleButton to the formatting object’s Bold property and control the active selection text’s bold state using the toggle button.

Code

Define converter code:

In C#:

namespace IGSpreadsheet.Converters
{
    public class ExcelBoolConverter : IValueConverter
    {
        public object Convert(object value, Type targetType, object parameter,
          System.Globalization.CultureInfo culture)
        {
            if (value is ExcelDefaultableBoolean)
            {
                switch ((ExcelDefaultableBoolean)value)
                {
                    case ExcelDefaultableBoolean.True: return true;
                    case ExcelDefaultableBoolean.False: return false;
                }
            }
            return null;
        }
        public object ConvertBack(object value, Type targetType, object parameter,
          System.Globalization.CultureInfo culture)
        {
            if (value is bool)
            {
                if (targetType == typeof (ExcelDefaultableBoolean))
                {
                    return (bool)value ? ExcelDefaultableBoolean.True : ExcelDefaultableBoolean.False;
                }
            }
            return null;
        }
    }
}

In Visual Basic:

Namespace IGSpreadsheet.Converters
        Public Class ExcelBoolConverter
                Implements IValueConverter
                Public Function Convert(value As Object, targetType As Type, parameter As Object, culture As System.Globalization.CultureInfo) As Object
                        If TypeOf value Is ExcelDefaultableBoolean Then
                                Select Case DirectCast(value, ExcelDefaultableBoolean)
                                        Case ExcelDefaultableBoolean.[True]
                                                Return True
                                        Case ExcelDefaultableBoolean.[False]
                                                Return False
                                End Select
                        End If
                        Return Nothing
                End Function
                Public Function ConvertBack(value As Object, targetType As Type, parameter As Object, culture As System.Globalization.CultureInfo) As Object
                        If TypeOf value Is Boolean Then
                                If targetType = GetType(ExcelDefaultableBoolean) Then
                                        Return If(CBool(value), ExcelDefaultableBoolean.[True], ExcelDefaultableBoolean.[False])
                                End If
                        End If
                        Return Nothing
                End Function
        End Class
End Namespace

Bind a toggle button optionset to the formatting object’s bold property using the converter:

In XAML:

<Page
  …
 xmlns:conv="clr-namspace:IGSpreadsheet.Converters"
  …>
<Page.Resources>
  <ResourceDictionary>
    <conv:ExcelBoolConverter x:Key="ExBoolConv" />
  </ResourceDictionary>
</Page.Resources>
…
<ToggleButton Content="Bold"
  IsChecked="{Binding ElementName=xamSpreadsheet1, Path=ActiveSelectionCellRangeFormat.Font.Bold,
    Converter={StaticResource ExBoolConv}}" />
…
</Page>

Note:

Note	Note Most of the properties of the formatting object are complex and will need converters when binding to them. You can look at the XamSpreadsheet’s "Content Editing" sample, which demonstrates how to bind to most of the formatting object’s properties.

Topic	Purpose
Working with Activation (XamSpreadsheet)	This topic explains the activation feature from developer perspective.
Working with Selection (XamSpreadsheet)	This topic explains the selection feature from developer perspective.

WPF | Help Topics