ComponentOne

Themes for WinForms

Copyright 1987-2015 GrapeCity, Inc. All rights reserved.

ComponentOne, a division of GrapeCity

201 South Highland Avenue, Third Floor
Pittsburgh, PA 15206 USA

Website:
Sales:
Telephone:

http://www.componentone.com
[email protected]
1.800.858.2739 or 1.412.681.4343 (Pittsburgh, PA USA Office)

Trademarks
The ComponentOne product name is a trademark and ComponentOne is a registered trademark of GrapeCity, Inc.
All other trademarks used herein are the properties of their respective owners.

Warranty
ComponentOne warrants that the media on which the software is delivered is free from defects in material and
workmanship, assuming normal use, for a period of 90 days from the date of purchase. If a defect occurs during this
time, you may return the defective media to ComponentOne, along with a dated proof of purchase, and
ComponentOne will replace it at no charge. After 90 days, you can obtain a replacement for the defective media by
sending it and a check for $25 (to cover postage and handling) to ComponentOne.
Except for the express warranty of the original media on which the software is delivered is set forth here,
ComponentOne makes no other warranties, express or implied. Every attempt has been made to ensure that the
information contained in this manual is correct as of the time it was written. ComponentOne is not responsible for
any errors or omissions. ComponentOnes liability is limited to the amount you paid for the product. ComponentOne
is not liable for any special, consequential, or other damages for any reason.

Copying and Distribution

While you are welcome to make backup copies of the software for your own use and protection, you are not
permitted to make copies for the use of anyone else. We put a lot of time and effort into creating this product, and
we appreciate your support in seeing that it is used by licensed users only.

Table of Contents
Themes for WinForms Overview.............................................................................................. 6
Help with WinForms Edition ................................................................................................ 6
Themes for WinForms Key Features ........................................................................................ 6
Themes for WinForms Quick Start ........................................................................................... 7
Applying a Built-In Theme to your Application ..................................................................... 7
Creating a Custom Theme .................................................................................................. 10
Step 1 of 2: Creating a New Theme in the Theme Designer ............................................ 10
Step 2 of 2: Using Themes in Visual Studio ..................................................................... 12
ThemeController Overview.................................................................................................... 12
Themeable ComponentOne WinForms Controls ................................................................ 13
Themeable Microsoft Controls........................................................................................... 14
Theme Concepts ................................................................................................................ 15
Theme Sources .................................................................................................................. 15
Theme Names ................................................................................................................... 16
C1Themes and the Visual Style Property ............................................................................ 17
Design-Time Support ......................................................................................................... 18
C1ThemeController Context Menu................................................................................. 18
C1ThemeController Smart Tag ....................................................................................... 20
C1ThemeController Dialog Box ...................................................................................... 21
C1Theme Designer Application Overview .............................................................................. 22
Theme Designer Ribbon Menu........................................................................................... 24
File Tab .......................................................................................................................... 24
Main Tab........................................................................................................................ 25
Edit Group.................................................................................................................. 30
Find Group ................................................................................................................. 31
Filter Group................................................................................................................ 32
Form Preview............................................................................................................. 33
Theme Preview .......................................................................................................... 33
Theme Designer Dialog Boxes ............................................................................................ 35
New Theme Dialog Box .................................................................................................. 36
New Property Dialog Box ............................................................................................... 37
Adding New Property in Theme Tree ................................................................................. 38

Navigating Property Items in Theme Tree .......................................................................... 40

Searching and Filtering Property Items in Theme Tree ....................................................... 41
Specifying Theme Property by Reference ........................................................................... 43
API Reference ........................................................................................................................ 45
C1.Win.C1Themes.4 Assembly ........................................................................................... 45
Namespaces .................................................................................................................. 45
C1.Win.C1Themes Namespace ................................................................................... 45
Overview................................................................................................................ 45
Classes ................................................................................................................... 46
C1Theme ............................................................................................................ 46
Overview ........................................................................................................ 46
Members ........................................................................................................ 47
C1Theme Constructor ..................................................................................... 50
Methods ......................................................................................................... 51
ApplyThemeToControlTree Method............................................................ 53
ApplyThemeToObject Method .................................................................... 54
AssignAttrsFrom Method ............................................................................ 55
AssignFrom Method.................................................................................... 55
GetBlend Method ....................................................................................... 56
GetBool Method ......................................................................................... 57
GetBool(String) Method .......................................................................... 57
GetBool(String,Boolean) Method ............................................................ 58
GetColor Method ........................................................................................ 59
GetColor(String) Method......................................................................... 60
GetColor(String,Color) Method ............................................................... 60
GetColorBlend Method ............................................................................... 61
GetDouble Method ..................................................................................... 62
GetEnum Method ....................................................................................... 63
GetEnum(String) Method ........................................................................ 63
GetEnum<T>(String,T) Method ............................................................... 64
GetEnumStr Method................................................................................... 65
GetFont Method ......................................................................................... 66
GetFont(String) Method .......................................................................... 67
GetFont(String,Font) Method .................................................................. 67

GetImage Method ...................................................................................... 68

GetImage(String) Method ....................................................................... 69
GetImage(String,Image) Method ............................................................. 70
GetInt Method............................................................................................ 71
GetInt(String) Method............................................................................. 71
GetInt(String,Int32) Method.................................................................... 72
GetPoint Method ........................................................................................ 73
GetString Method ....................................................................................... 74
GetThemeName Method ............................................................................ 74
GetThemeName(Stream) Method ........................................................... 75
GetThemeName(Stream,C1ThemeFormat) Method ................................ 76
GetThemeName(String) Method ............................................................. 77
GetThemeName(String,C1ThemeFormat) Method .................................. 78
GetThickness Method ................................................................................. 79
GetUsedFonts Method................................................................................ 80
HasValue Method ....................................................................................... 80
IsEmpty Method ......................................................................................... 81
IsTreeEmpty Method .................................................................................. 82
IsTreeEmpty(String) Method ................................................................... 82
Load Method .............................................................................................. 83
Load(Stream) Method ............................................................................. 83
Load(Stream,C1ThemeFormat) Method .................................................. 84
Load(String) Method ............................................................................... 85
Load(String,C1ThemeFormat) Method .................................................... 86
Save Method .............................................................................................. 87
Save(Stream) Method ............................................................................. 87
Save(Stream,C1ThemeFormat) Method .................................................. 88
Save(String,C1ThemeFormat) Method .................................................... 89
Save(String) Method ............................................................................... 90
Properties ....................................................................................................... 91
Attrs Property ............................................................................................. 91
FormatVersion Property ............................................................................. 92
Icon Property .............................................................................................. 92
OriginalThemeVersion Property .................................................................. 93

Template Property ...................................................................................... 93

ThemeVersion Property .............................................................................. 94
C1ThemeCollection ............................................................................................ 94
Overview ........................................................................................................ 95
Members ........................................................................................................ 96
C1ThemeCollection Constructor ..................................................................... 97
Methods ......................................................................................................... 98
TryGetValue Method .................................................................................. 99
C1ThemeController ...........................................................................................100
Overview .......................................................................................................100
Members.......................................................................................................101
C1ThemeController Constructor ....................................................................106
Methods ........................................................................................................107
ApplyThemeToControlTree Method...........................................................109
ApplyThemeToObject Method ...................................................................110
GetTheme Method ....................................................................................112
GetThemeByName Method .......................................................................112
GetThemes Method ...................................................................................113
IsObjectThemeable Method.......................................................................114
IsPreviewControlInsideC1PrintPreviewControl Method .............................115
IsThemeRegistered Method .......................................................................115
RegisterTheme Method .............................................................................116
RegisterTheme(Stream,C1ThemeFormat) Method .................................117
RegisterTheme(Stream) Method ............................................................118
RegisterTheme(String) Method ..............................................................119
RegisterThemes Method ............................................................................120
SetTheme Method .....................................................................................121
UnregisterTheme Method..........................................................................122
Properties ......................................................................................................123
ApplicationTheme Property .......................................................................124
Theme Property .........................................................................................124
Fields .............................................................................................................125
DefaultThemeName Field ..........................................................................125
NoTheme Field ..........................................................................................126

Events............................................................................................................126
ApplicationThemeChanged Event ..............................................................128
ApplicationThemeChanging Event..............................................................128
ObjectThemeApplied Event .......................................................................129
ObjectThemeApplying Event ......................................................................130
ObjectThemeChanged Event ......................................................................130
ObjectThemeChanging Event .....................................................................131
ThemeChanged Event ................................................................................131
ThemeChanging Event ...............................................................................132
C1ThemeVersion ...............................................................................................132
Overview .......................................................................................................133
Members .......................................................................................................134
C1ThemeVersion Constructor ........................................................................135
C1ThemeVersion Constructor() ..................................................................135
C1ThemeVersion Constructor(String,String) ...............................................136
C1ThemeVersion Constructor(Version,Version) .........................................137
Methods ........................................................................................................138
Parse Method ............................................................................................138
ToString Method........................................................................................139
Properties ......................................................................................................140
AssemblyVersion Property .........................................................................140
FormatVersion Property ............................................................................141

Themes for WinForms Overview

Themes for WinForms makes it easy to theme your WinForms controls with many built-in
themes and an easy to use Theme designer to create your own themes or modify the existing
ones. This product enables you to easily provide a consistent customized look to WinForms
applications which use other ComponentOne WinForms products such as C1Ribbon,
C1Scheduler, C1FlexGrid and others. Themes for WinForms includes one component,
C1ThemeController, and a Theme designer.
The C1Themes product physically consists of two separate parts:

C1.Win.C1Themes.2/C1.Win.C1Themes.4 assembly

This assembly provides the C1ThemeController component, which is used to load and apply
themes to controls at design and runtime. Besides, the assembly contains (as embedded
resources) a set of predefined themes which can be used as is, or customized to better serve
your purposes. Projects using this assembly need to have a reference to C1.C1Zip.2/4.dll.

C1ThemeDesigner application

This application can be used to create new, or customize existing themes (including those
embedded into the C1.Win.C1Themes.2/4 assembly as mentioned above).

Getting Started
- Themes for WinForms Quick Start
- ThemeController Overview
- C1Theme Designer Application Overview

Help with WinForms Edition

Themes for WinForms Overview > Help with WinForms Edition

For information on installing ComponentOne Studio WinForms Edition, licensing, technical

support, namespaces and creating a project with the control, please visit Getting Started with
WinForms Edition.

Themes for WinForms Key Features

C1Themes includes the following key features:

C1Themes allow to provide a consistent customized look to your applications that use
ComponentOne WinForms controls.

The look of an application can be changed with a single click at design or run time.
The look of your applications can be designed/modified by visual designers (not
programmers) independently of actual coding, using the easy to use
C1ThemeDesigner.

Use one of the pre-built themes, or create your own either from scratch, or by
modifying a pre-built theme.

Themes can be deployed independently of applications, and used by different

applications throughout your company as long as the applications are built using C1
WinForms controls.

Within a theme, a common repository of properties (Base Theme Properties) can be

referenced throughout the theme to enable creation of consistent and easily modifiable
themes.

Themes for WinForms Quick Start

Themes for WinForms enables users to quickly create many prebuilt themes using the
C1ThemeDesigner so they can easily apply those themes to any of their ComponentOne
WinForms or Standard WinForms controls. C1Themes for WinForms includes a
C1ThemeController.Theme property that enables users to get their theme created by the
C1ThemesDesigner so they can apply it to all supporting ComponentOne WinForm or
Standard WinForms controls or they can apply different themes to invidual ComponentOne
WinForms or Standard WinForms controls using the C1ThemeController.Theme property.
In this quick start you will learn how to apply a built-in theme to your application and you will
also learn how to create or modify existing themes using the C1ThemeDesigner.

See Also
Applying a Built-In Theme to your Application
Creating a Custom Theme

Applying a Built-In Theme to your

Application
Themes for WinForms Quick Start > Applying a Built-In Theme to your Application

To simply theme the controls in your application use C1ThemeController like the following:
1.

Open a form belonging to your application in the Visual Studio's forms designer. In this
example we will open a ComponentOne WinForms sample, SimpleTextEditor.

2.

From the designer's toolbox, drag a C1ThemeController and drop it on your form. (The
C1ThemeController is provided by the C1.Win.C1Themes.2/4 assembly; if you don't see
it in your toolbox you can add it manually).
Note: Reference to C1.C1Zip.4.dll is required in a project that uses C1ThemeController.

3.

A ThemeController dialog box appears.

This enables you to select the application-wide default theme, the current controllers default
theme, and themes for all supporting controls already on the form. Note: The same dialog is
also available via the Set Themes action on the C1ThemeController tasks menu.
Initially in the dialog that pops up, the theme is specified as "(none)" for all supporting controls
already on the form. This is done to prevent unintentional loss of property settings on those
controls.
3.

Click the All to (default) button in the dialog so that the default theme is set on all
controls. If you have deliberately customized some of the controls already this will not
need to be done.

(When new controls are dropped on the form already containing a C1ThemeController
component, theme is set to "(default)" on them automatically.)

4.

Select the default application theme from the list of available prebuilt themes. For
example, This theme name will be automatically stored in the App.config file.

4.

5.
6.
7.

Leave the theme on the current theme controller ('c1ThemeController1 theme') at its
default "(default)" value (which means that the application theme, GreenHouse, will be
used).
Click the All to (default) button as mentioned above, to set the default theme on all
supporting controls on the form.
Finally, click the OK button to close the dialog and apply the specified theme to the
controls on the form.
If your application contains multiple forms, repeat the steps above (with the exception
of specifying the default ApplicationTheme as it will already be pre-selected for you) for
all forms in your application.

When you are done, the selected application theme will be applied to controls on your forms
both at design and runtime.
The following image illustrates the GreenHouse theme applied to the SimpleTextEditor
application:

Creating a Custom Theme

Themes for WinForms Quick Start > Creating a Custom Theme

This QuickStart guide will walk you through creating a new theme based on a built-in theme
template using the C1ThemeDesigner. You will modify the built in theme template using the
C1ThemeDesigner.

See Also
Step 1 of 2: Creating a New Theme in the Theme Designer
Step 2 of 2: Using Themes in Visual Studio

Step 1 of 2: Creating a New Theme in the

Theme Designer
Themes for WinForms Quick Start > Creating a Custom Theme > Step 1 of 2: Creating a New Theme in the
Theme Designer

In this step, you will create a new theme based on the Standard built-in theme template. You
will also modify some Theme Base Properties and add a reference to another theme base
property. For more information see C1ThemeDesigner Application Overview.

1.
2.
3.
4.
5.
6.
7.
8.

Double-click on the C1ThemeDesigner from the C:\Program

Files\ComponentOne\WinForms Edition\bin\v2\Designer folder.
Click on Create New Theme from the Topic Bar. The New Theme dialog box appears.
Select the Standard built-in theme template and enter BlueandPink for the theme
Name and Click OK.
Select Control Text from the BaseThemeProperties in the Theme tree.
Click on the Control Text dropdown arrow and click the Custom tab.
Set the BackColor to 151; 45; 85.
Click on the dropdown arrow next to Window Text and select the Reference tab.
Select the Control Text in the Reference tab.

Notice the icon appears as a visual indicator that the Window Text property is referenced from
the BaseThemeProperties Control Text.

9. Expand C1Command| C1MainMenu| | Bar| BackColor.

10. Click on the BackColor dropdown arrow and select the Custom tab.
11. Select the Light pink so the numbers appear as 255; 231; 242.

Notice the new settings appear in the Preview pane.

12. Select File| Save As from the File menu and save and name your file. For example,
BlueandPink. The new location appears at the top of the C1Theme Designer.

Step 2 of 2: Using Themes in Visual Studio

Themes for WinForms Quick Start > Creating a Custom Theme > Step 2 of 2: Using Themes in Visual
Studio

In this step, you'll add the custom theme to your application.

1.
2.
3.

4.

Open a form belonging to your application in the Visual Studio's forms designer. In this
example we will open a ComponentOne WinForms sample, SimpleTextEditor2.
Add the C1ThemeController from the toolbox onto your form. Also, provide reference
to C1.C1Zip.4.dll in your project.
Click on the C1ThemeController component's Add theme... action item. This will show
a file open dialog. Select the theme file and click OK.
The selected theme will be added to your C# or VB project as an embedded resource in
a Themes folder, and will be available for selection from the themes list provided by
the C1ThemeController.
Run and observe your changes.

ThemeController Overview
C1ThemeController is a component that loads and manages visual themes and applies them to
forms and controls. C1ThemeController can be used in any of the following ways:

Applies the same theme to all supporting ComponentOne controls in your

application

Use the C1ThemeController.ApplicationTheme property to accomplish this method.

Applies the same theme to all supporting ComponentOne controls on your form

- Use the C1ThemeController.Theme property to accomplish this method.

Applies a different theme to all supporting ComponentOne controls on your form

- Set the extender property Theme on c1ThemeController1 on individual controls on your

form.

See Also
Themeable ComponentOne WinForms Controls
Theme Concepts
Theme Sources
Theme Names
C1Themes and the Visual Style Property

Themeable ComponentOne WinForms

Controls
To effectively use Themes for WinForms you need the C1ThemeController component and the
supported versions of the ComponentOne WinForms controls. The Theme designer application
is not necessary for applying themes to your WinForms controls, but can be used to customize
and/or create new themes.

Themes for WinForms supports the following ComponentOne WinForms controls:

ComponentOne WinForms Product

Controls

Chart for WinForms

C1Chart and C1Chart3D

FlexGrid for WinForms

C1FlexGrid

GannttView for WinForms

C1GanttView

Input for WinForms

C1Textbox, C1DateEdit, C1NumericEdit,

C1DropDownControl, C1DbNavigator,
C1CheckBox, C1Button, C1Label, C1PictureBox,
C1SplitButton, C1ComboBox

InputPanel for WinForms

C1InputPanel

Menus and ToolBars for WinForms

C1DockingTab, C1MainMenu,
C1ContextMenu, C1ToolBar, C1TopicBar,
C1NavBar, C1OutBar, C1RadialMenu

Report for WinForms

C1Report, C1PrintPreview, C1PreviewPane,

C1PreviewThumbnailView,
C1PreviewOutlineView,
C1PreviewTextSearchPanel, and
C1PrintPreviewDialog.
C1ReportDesigner

Ribbon for WinForms

C1Ribbon and C1StatusBar

Scheduler for WinForms

C1Schedule and C1Calendar

SplitContainer for WinForms

C1SplitContainer

SuperToolTip for WinForms

C1SuperToolTip, C1SuperErrorProvider,
C1SuperLabel

TileControl for WinForms

C1TileControl

TrueDBGrid for WinForms

C1TrueDBGrid

Themeable Microsoft Controls

You can easily customize your applications by applying C1Themes even to the Microsoft
controls used within the application. C1Theme in WPF supports following Microsoft controls:

Button
CheckBox
CheckedListBox

ComboBox
DomainUpDown
Form
GroupBox
Label
LinkLabel
ListBox
ListView
MaskedTextBox
NumericUpDown
Panel
PropertyGrid
RadioButton
SplitContainer
Splitter
StatusStrip
TextBox
ToolStrip
TrackBar
TreeView
UserControl

Theme Concepts
A theme is an XML document (with the .c1theme extension when saved in a file) that contains a
consistent set of values for properties determining the look and feel of supporting controls.
When applied to a form in an application (at runtime and/or design time, using the
C1ThemeController component), the theme changes the look of controls on that form so that
they all comply with the theme.
Internally, a theme is divided into sections corresponding to different ComponentOne products,
so that each product only uses its own section when the theme is applied. This allows to
provide a customized "themed" look for even the smallest and most specialized details of a
control. Consistency within a theme is achieved via a mechanism of references, which enables
properties such as colors and fonts in individual controls to reference a common repository
accessible to all other sections of the theme, which is called the "Base Theme Properties".
Properties in that repository are not directly applied to controls' properties, but they can be
referenced by the theme author when specifying the actual properties used by the controls.
Additionally, a theme includes a section that is used by C1ThemeController to apply the theme
to standard WinForms forms and controls such as buttons and labels.

Theme Sources
In an application, themes can come from the following sources:

Standard C1 themes embedded as resources into the C1.Win.C1Themes.2/4 assembly;

Themes which you create using the C1ThemeDesigner application, and add as
embedded resources into your own assemblies;
Themes which are loaded at runtime from .c1theme file(s).

The first two theme sources are available at design time via the C1ThemeController properties
and designer actions. At runtime, you can also load themes in code from .c1theme files on disk
using methods available on the C1ThemeController component.
For example the following code shows how to programatically apply the built-in theme using
the Register and SetTheme methods:
C#

Copy Code

//Register the theme file with the C1ThemeController;

C1.Win.C1Themes.C1ThemeController.RegisterTheme(@"C:\Users\Documents\Visual Studio
2010\Projects\ThemesBuild6\ThemesBuild6\NewOffice2013White.c1theme");
//Apply it to a control and use the theme name
this.c1ThemeController1.SetTheme(c1MainMenu1, "NewOffice2013White")

Visual Basic

Copy Code

'Register the theme file with the C1ThemeController

C1.Win.C1Themes.C1ThemeController.RegisterTheme("C:\Users\Documents\Visual Studio
2010\Projects\ThemesBuild6\ThemesBuild6\NewOffice2013White.c1theme")
'Apply it to a control, use the theme name, not the file name
Me.c1ThemeController1.SetTheme(someControl, "NewOffice2013White")

Theme Names
In C1Themes, themes are identified by their names. Names are case-sensitive, and must be
unique within an application.
Themes for WinForms includes the following regular theme names which are located in the
Themes folder:

BeigeOne.c1theme
ExpressionDark.c1theme
ExpressionLight.c1theme
GreenHouse.c1theme
Office2007Black.c1theme
Office2007Silver.c1theme

Office2010Black.c1theme
Office2010Blue.c1theme
Office2010Silver.c1theme
Office2013DarkGray.c1theme
Office2013LightGray.c1theme
Office2013White.c1theme
RanierOrange.c1theme
ShinyBlue.c1theme
Violette.c1theme
VisualStyleOffice2010Black.c1theme
VisualStyleOffice2010Blue.c1theme
VisualStyleOffice2010Silver.c1theme
VS2013Blue.c1theme
VS2013Dark.c1theme
VS2013DarkSolar.c1theme
VS2013Green.c1theme
VS2013Light.c1theme
VS2013Purple.c1theme
VS2013Red.c1theme
VS2013Tan.c1theme
MacBlue.c1theme
MacSilver.c1theme
Office2010Barbie.c1theme
Office2010Green.c1theme
Office2010Red.c1theme
Office2013Green.c1theme
Office2013Grey.c1theme
Office2013HighContrast.c1theme
Office2013Red.c1theme
Windows8Blue.c1theme
Windows8Brown.c1theme
Windows8Gray.c1theme
Windows8Green.c1theme
Windows8Red.c1theme

Themes for WinForms includes the following non-regular theme names:

"(default)": specifies the default theme in the current context;

"(none)": specifies that no theme should be applied.

C1Themes and the Visual Style Property

Many ComponentOne WinForms controls include a property called VisualStyle, of an enum
type defined in the control assembly, but following a common naming pattern for the type and
possible values. Typically, the enum type is called VisualStyle, with values such as
Office2010Blue, Office2010Black, and so on. C1Themes are designed to provide a more
powerful and flexible mechanism for adjusting the look of controls. Still there is obvious overlap
between the two mechanisms, with the possibility of conflicts. The rules for dealing with this
overlap are as follows:

Theme sections for all C1 controls include a VisualStyle property that can be specified
by the theme.
By default and in all supplied themes, those properties are set to 'Custom' so that the
VisualStyle does not interfere with applying other properties.
Setting VisualStyle in a theme to anything other than custom sets the corresponding
property on the target control and disables applying all other theme properties. (In the
C1ThemeDesigner, this actually disables the rest of the theme tree for the control.)

While we recognize that backward compatibility or other considerations may require the use of
VisualStyle rather than themes to customize the look of your application, we recommend that if
possible you use C1Themes as they provide a more powerful and flexible mechanism for that.
Support for visual styles in new controls will be phased out as themes will replace it

Design-Time Support
C1ThemeController includes a smart tag and dialog boxes to simplify design-time tasks when
using the C1ThemeController component.
The following topics describe how to use C1ThemeControllers design-time environment to
configure C1ThemeController.

See Also
C1ThemeController Context Menu
C1ThemeController Smart Tag
C1ThemeController Dialog Box

C1ThemeController Context Menu

ThemeController Overview > Design-Time Support > C1ThemeController Context Menu

The C1ThemeController component provides a context menu for additional functionality to

use at design time.
To access C1ThemeControllers context menu, right-click on the C1ThemeController control and
the context menu for it appears like the following:

The C1ThemeController Context menu operates as follows:

Set themes..
Clicking Set themes opens the C1ThemeController dialog box. For more information
see C1ThemeController Dialog Box.

Add theme
Clicking Add theme opens the Select Theme dialog box where you can browse to the
location of your theme and add it to the C1ThemeController. Once you select your theme, it will
be registered to your project and in Visual Studio a Themes folder will appear in the Solution
Explorer. Once the theme has been added you apply it to the Theme or ApplicationTheme
properties.
Reload themes
Clicking Reload themes reloads all themes used by the current application.
About C1ThemeController..
Clicking About C1ThemeController reveals the About dialog box. This dialog box displays the
version number and licensing information for the ThemeController product.

C1ThemeController Smart Tag

ThemeController Overview > Design-Time Support > C1ThemeController Smart Tag

In Visual Studio, the C1ThemeController component in Themes for WinForms includes a smart
tag. A smart tag represents a short-cut tasks menu that provides the most commonly used
properties in each control.
To access the C1ThemeController Tasks menu, click the smart tag in the upper right corner of
the C1ThemeController component. This will open the C1ThemeController Tasks menu.

The C1ThemeController Tasks menu operates as follows:

Set themes..

Clicking Set themes opens the C1ThemeController dialog box. For more information
see C1Theme Controller Dialog Box.

Add theme

Clicking Add theme opens the Select Theme dialog box where you can browse to the
location of your theme and add it to the C1ThemeController. Once you select your theme, it will
be registered to your project and in Visual Studio a Themes folder will appear in the Solution
Explorer. Once the theme has been added you apply it to the Theme or ApplicationTheme
properties.

Reload themes

Clicking Reload themes reloads all themes used by the current applicatioin.

About C1ThemeController..

Clicking About C1ThemeController reveals the About dialog box. This dialog box displays the
version number and licensing information for the ThemeController product.

C1ThemeController Dialog Box

ThemeController Overview > Design-Time Support > C1ThemeController Dialog Box

Once you drag and drop the C1ThemeController 2.0 component onto the component tray a
C1ThemeController dialog box appears. The ThemeController dialog box is used to quickly to
apply the theme to all themeable controls in the application, all themeable controls on the form,
or different themes on different controls.
The following image illustrates the main properties used to theme your application:

If you have themeable controls on your form before you add the C1ThemeController the dialog
box lists all of the components on your form. Each control/component is initially set to none to
prevent unintentional loss of property settings on those controls.
The following items in the C1ThemeControllder dialog box function as follows:

Application theme dropdown listbox - Used to specify the application-wide (default)

theme. The name of this theme is stored in the App.config file.

C1ThemeController1 theme: dropdown listbox - Specifies the default theme for the
current C1ThemeController. The value "(default)" indicates that the application-wide
theme specified by ApplicationTheme will be used.
Theme on selection: dropdown listbox - A 'Theme on c1ThemeController1' extender
property is added to all supporting controls on the form. When set to a specific theme
name, this property will apply that theme to the current control regardless of the theme
controller's default theme. This allows to apply different themes to different controls on
the same form if needed. This property supports two special values: 'default' and 'none'.
The default value implies that the default theme specified for the C1ThemeController
on the current form will be used for this control. 'None' implies no theme will be
applied to this control.
All to (default) button - Sets the default theme for all controls on the form.
Add to (none) button - Sets the theme to none so no themes will be applied to the
controls on the form.

C1Theme Designer Application

Overview
Easily design new themes for any of the controls in WinForms Edition controls using the
C1ThemeDesigner application. When the C1ThemeDesigner.2.exe is opened a TopicBar
appears:

The Topic Bar includes the following groups:

Open/Create Theme
In the Open/Create Theme group can do either one of the following:

Create new theme... - Clicking this item opens the New Theme dialog box.
Open existing theme... - Clicking this item opens the Open Theme dialog box where
you last saved your recent theme. Select the theme and then click Open. The existing
theme will be opened in the Theme Designer.
Recent Themes

The recent themes lists the themes you have recently created using the Theme designer.

Information

An information group box provides information about the product, C1ThemeDesigner, and a
link to the online help.

The ThemeDesigner includes a Ribbon menu which consists of a File tab and a Main tab.

See Also
Theme Designer Ribbon Menu
Theme Designer Dialog Boxes
Adding New Property in Theme Tree
Navigating Property Items in Theme Tree
Searching and Filtering Property Items in Theme Tree
Specifying Theme Property by Reference

Theme Designer Ribbon Menu

In this topic you will explore the different commands in C1Theme designer ribbon.

The Theme Designer has two tabs: File and Main.

See Also
File Tab
Main Tab

File Tab
C1Theme Designer Application Overview > Theme Designer Ribbon Menu > File Tab

The File menu includes the following options: New..., Open..., Close, Save, and Save As. Recent
themes that were created appear to the right under Recent themes.

The File menu operates as follows:

Command Button

Description

New...

Opens the New Theme dialog box where you can

create a new theme from scratch or base it on an
existing theme file.

Open...

Opens the Open Theme dialog box where you can

open your existing .c1theme file.

Close

Closes the current theme, but keeps the Theme

designer open.

Save

Saves the current theme.

Save As...

Saves the current theme in a different file.

Theme Properties... Opens the Edit theme dialog box where you
can view or edit theme name and other
properties.

Main Tab
C1Theme Designer Application Overview > Theme Designer Ribbon Menu > Main Tab

The Main tab includes the following groups Navigation, Edit, Search, Filter, and Preview.

Navigation Group

In the Navigation group you can quickly navigate the Theme tree by selecting the section you
wish to edit from the Section menu. The Navigation group consists of the following command
buttons:

Command Button

Description

Section

Go directly to the theme section for a specific

product.

Back

Go back in history to the next position in the

theme tree.

Forward

Go forward in history to the next position in the

theme tree.

Section Menu
In the Section menu you can choose what section of the Theme tree you wish to edit such as
Base theme properties, C1Command, C1FlexGrid, C1GanttView, C1Input, C1Preview, C1Schedule,
C1SuperToolTip, C1TrueDBGrid, and WinForms.

Base theme properties View

When the Base theme properties section is selected the Main Properties Navigation Bar
appears to the right of the Theme tree.

The Navigation Bar includes three categories: Main Properties, Styles, and Clickable Styles.
Main Properties
In the Main Properties category you can modify the FontStyle properties for the Default Font,
Control Text, and Window Text items.

Styles
In the Styles button you can modify the Font, Background, ForeColor, and BorderColor
properties for the Header, Content, Hightlighted text, and Disabled text items.

Clickable Styles
In the Clickable Styles category you can modify the Font, Background, ForeColor, and
BorderColor properties for the Default, Hot, Pressed, and Hot & Pressed items.

See Also
Edit Group
Find Group
Filter Group
Form Preview
Theme Preview

Edit Group
C1Theme Designer Application Overview > Theme Designer Ribbon Menu > Main Tab > Edit Group

The Edit Group in the Ribbon menu of the C1ThemeDesigner appears like the following:

The following command buttons are included in the Edit group:

Command
Button
Add

Description

The Add command is active when any of the items in the Base Theme Properties
section are selected. Click on the Add button to open a submenu of command
items. Below command adds the new property immediately below the selected property.
Above command adds the new property immediately above the selected property. As
Child add the new property as a child of the selected property.

Edit

Edits the attributes (name etc.) of the current Base Theme Properties tree item. The
Edit command is active when any of the items in the Base Theme Properties
section are selected. Select an item in the Base Theme Properties that you wish to
edit and then click on the Edit button. Clicking on the Edit button opens the dialog
box:

Reference Clicking on the Reference command button opens the Edit Reference dialog box
where you can edit, add, or remove the selected reference on the theme tree item.
Clear

Clears the property value on the selected theme tree item.

Reset

Resets the property value on the selected theme tree item.

Paste

Pastes the item into the Base Theme properties tree. Click on the Paste button to
open a submenu of command items: Paste after, Paste before, Paste as child, and
Paste value. The Paste after pastes the properties after the selected property.
Paste before pastes the properties before the selected property. Paste as child
pastes properties as child for the selected property. Paste value replaces the value
of selected properties with data from the clipboard.

Cut

Cuts the selected Base Theme properties item(s) and puts them on the clipboard.

Copy

Copies the selected Base Theme tree properties item(s) and puts them on the
clipboard.

Delete

Deletes the selected Base Theme tree properties item(s).

Undo

Undo the last edit.

Redo

Redo the last undone edit.

Find Group
C1Theme Designer Application Overview > Theme Designer Ribbon Menu > Main Tab > Find Group

The Find groupbox includes a Find textbox, Find Next command button, Find Previous
command button, Match case checkbox, and Match whole word checkbox.

The items in the Find group operate as follows:

Item

Description

Find textbox

Finds the nodes with names matching the

search string in the theme tree.

Find Next

Finds the next property with a matching name in

the theme tree.

Find Previous

Find the previous property with a matching name

in the theme tree.

Match case

Treats all search queries as case-sensitive.

Match whole word

Finds the exact word that you enter in the

search textbox.

For more information see Searching and Filtering Property Items in Theme Tree.

Filter Group
C1Theme Designer Application Overview > Theme Designer Ribbon Menu > Main Tab > Filter Group

The Filter group appears on the Theme designer's Main ribbon menu.

The following table describes each item inside the Filter Group:
Item

Description

Name Filter

Filters nodes visible in the theme tree by

textbox

property names.

Visible Sections

Select which sections to show in the theme tree.

Filter button

Turn the property name in the theme tree on or

off.

For more information see Searching and Filtering Property Items in Theme Tree.

Form Preview
C1Theme Designer Application Overview > Theme Designer Ribbon Menu > Main Tab > Form Preview

The Form Preview groupbox appears on the Theme designer's Ribbon menu. Two buttons
appear in the Form preview groupbox: Ribbon Form and Regular Form.

The following table describes each item inside the Form Preview:
Item

Description

Ribbon Form

Preview current theme applied to C1Controls

(C1FlexGrid, C1Schedule, C1TrueDBGrid) in a
C1RibbonForm. This opens in a new window.

Regular Form

Preview current theme applied to C1Controls

(C1FlexGrid, C1Schedule, C1TrueDBGrid) in a
WinForms with C1Command UI elements. This
opens in a new window.

Theme Preview
C1Theme Designer Application Overview > Theme Designer Ribbon Menu > Main Tab > Theme Preview

The Form Preview groupbox appears on the Theme designer's Ribbon menu.

The following table describes each item inside the Form Preview:
Item

Description

BTP Editor

Preview current theme applied to

C1Controls (C1FlexGrid, C1Schedule,
C1TrueDBGrid) in a C1RibbonForm.
This opens in a new window.

Auto Preview

Preview current theme applied to

C1Controls (C1FlexGrid, C1Schedule,
C1TrueDBGrid) in a WinForms with
C1Command UI elements. This opens in
a new window.

C1Command UI

Preview current theme applied to

various C1Controls (C1TrueDBGrid,
C1FlexGrid, C1Schedule) with

C1Command menu and other UI

elements.
C1Ribbon UI

Preview current theme applied to

various C1Controls (C1TrueDBGrid,
C1FlexGrid, C1Schedule) with a
Ribbon-based UI.

C1Input (C1Command UI) Preview current theme applied to

various C1Input controls with
C1Command menus and other UI
elements.
C1Input (C1Ribbon UI)

Preview current theme applied to

various C1Input controls with a
C1Ribbon-based UI.

C1RadialMenu

Preview current theme applied to a

C1RadialMenu.

C1GanttView

Preview current theme applied to a

C1GanttView.

C1Report

Preview currrent theme applied to

C1Report print preview controls.

C1SuperTooltip

Preview current theme applied to

C1SuperTooltip and C1SuperLabel.

WinForms Controls

Preview current theme applied to

standard winform controls.

Theme Designer Dialog Boxes

C1Theme Designer Application Overview > Theme Designer Dialog Boxes

Theme Designer provides the following dialog box:

New Theme Dialog Box

Add Property Dialog Box

See Also
New Theme Dialog Box
New Property Dialog Box

New Theme Dialog Box

C1Theme Designer Application Overview > Theme Designer Dialog Boxes > New Theme Dialog Box

The New Theme dialog box can be used to create a new theme.
To Access the New Theme Dialog Box
Click on the Create New Theme link in the Topic Bar:

The New Theme dialog box appears:

The New Theme dialog box consists of the following items:

Theme name: - A textbox is provided for you to enter the name of your new theme.
Theme icon: Initially an empty picturebox appears and is filled when you click the
Browse button to open your theme icon.
Base Theme: -Choose from one of the following three items to base your theme from:
o Standard built-in theme template
o ComponentOne theme Select from one of the existing built-in themes.
o Loade base theme file: You can open an existing base theme you created to
add it to your WinForms theme. When you enter a Theme name in the Theme
name: textbox the new Theme name will appear at the top of the Theme
Designer:

New Property Dialog Box

C1Theme Designer Application Overview > Theme Designer Dialog Boxes > New Property Dialog Box

When you click on the Add command button from the Edit group, the New Property dialog
box appears:

You can specify the name, proeprty type, caption and description for the new property. For
more information see Adding New Property in Theme Tree.

Adding New Property in Theme Tree

C1Theme Designer Application Overview > Adding New Property in Theme Tree

A new property can be inserted at a specific position in the Theme tree via the Add command
button from the Edit group in the C1Theme Designer Ribbon menu.
To add a new property in the Theme Tree, complete the following:
1.
2.
3.

Open the C1Theme designer and create a new theme based from any of the office
themes such as Office2010Blue.
Select the Styles under the BaseThemeProperties.
Click Below from the Add dropdown menu in the Edit group.

The Add Property dialog box appears:

4.
5.
6.
7.

Enter Emptybackground in the Name: textbox.

Select Background from the Type dropdown listbox.
In the Description richtextbox enter "Background for empty window areas."
Click OK in the Add Property dialog box.

The new property, Emptybackground, appears below the Styles property in the
BaseThemeProperties Theme Tree.

Navigating Property Items in Theme Tree

C1Theme Designer Application Overview > Navigating Property Items in Theme Tree

To quickly navigate to a section in the Theme tree, click on the dropdown arrow and select the
section you wish to navigate in the Theme tree.

Clicking the Back button will move back to the last item selected in the Theme tree. Clicking
the Forward button will move to the next item in the Theme tree.

Searching and Filtering Property Items in

Theme Tree
C1Theme Designer Application Overview > Searching and Filtering Property Items in Theme Tree

The C1Theme Designer has a Search and Filter group. Use the Search textbox when you
know what you want to find and use the Filter textbox when you dont know exactly what you
want to find. Filtering is benefiical when you need to find common information.
Find Group
The following illustration labels each command inside the Find group.

When you type something into the Search textbox, it automatically searches for the the first
few letters and once it finds a match, the node or item in the Theme tree is highlighted and
ready for your edit. If the highlighted item in the Theme tree is not the property you want to
edit then you can click the Find next property or Find previous property button.

The following image illustrates the item, Separator, found in the Theme tree.

Filter Group
The following illustration labels each command inside the Filter group.

How to use the Filter:

To use the filter, complete the following:
Enter a property name like, Font, in the Filter search textbox.
Only the nodes in the Theme tree containing that text are shown.
Click the dropdown arrow in the Visible sections dropdown listbox and deselect all items
except, C1FlexGrid and C1Input.

Click the Filter button in the Filter group.

This will expand the C1FlexGrid section with only the Font properties showing and the C1Input
section with only the Font properties showing.
Note: When the Filter button is enabled the button will appear highlighted.
How to view past filters:
Past filters go into the history which can be brought up by clicking the dropdown in the
Filter textbox. The following example shows the past filters:

Specifying Theme Property by Reference

C1Theme Designer Application Overview > Specifying Theme Property by Reference

To specify a theme property by reference, complete the following:

1.

Double-click on the C1ThemeDesigner from the C:\Program

Files\ComponentOne\WinForms Edition\bin\v2\Designer folder.

2.
3.

Click on Create New Theme from the Topic Bar. The New Theme dialog box appears.
Select the Standard built-in theme template and enter BlueandPink for the theme
Name and Click OK.
Select Control Text from the BaseThemeProperties in the Theme tree.
Click on the Control Text dropdown arrow and click the Custom tab.
Set the BackColor to 151; 45; 85.
Click on the dropdown arrow next to Window Text and select the Reference tab.
Select the Control Text in the Reference tab.

4.
5.
6.
7.
8.

Notice the icon appears as a visual indicator that the Window Text property is referenced from
the BaseThemeProperties Control Text.

API Reference
The following topics contain the API reference for Themes for WinForms.

See Also
C1.Win.C1Themes.4 Assembly

C1.Win.C1Themes.4 Assembly
Namespaces
C1.Win.C1Themes Namespace
Overview
Inheritance Hierarchy
C1.Win.C1Themes.4 Assembly : C1.Win.C1Themes Namespace

Classes
Class

Description

C1Theme

Represents a theme that can be applied to WinForms controls to

modify their appearance.

C1ThemeCollection Represents a collection of C1Theme objects, keyed by their names.

C1ThemeController Represents a component that loads and manages C1 visual themes,
and applies them to forms and controls.
C1ThemeVersion

Represents theme XML format's, and theme assembly's version info.

See Also
Reference
C1.Win.C1Themes.4 Assembly

Classes
C1Theme
Members
C1.Win.C1Themes.4 Assembly > C1.Win.C1Themes Namespace : C1Theme Class

Represents a theme that can be applied to WinForms controls to modify their appearance.

Object Model

Syntax
Visual Basic (Declaration)
Public Class C1Theme
Inherits ThemeItem
C#
public class C1Theme : ThemeItem

Inheritance Hierarchy
System.Object
C1.Win.C1Themes.C1Theme

See Also
Reference
C1Theme Members
C1.Win.C1Themes Namespace

Overview
Members
C1.Win.C1Themes.4 Assembly > C1.Win.C1Themes Namespace : C1Theme Class

Represents a theme that can be applied to WinForms controls to modify their appearance.

Object Model

Syntax
Visual Basic (Declaration)
Public Class C1Theme
Inherits ThemeItem
C#
public class C1Theme : ThemeItem

Inheritance Hierarchy
System.Object
C1.Win.C1Themes.C1Theme

See Also
Reference
C1Theme Members
C1.Win.C1Themes Namespace

Members
Properties Methods
C1.Win.C1Themes.4 Assembly > C1.Win.C1Themes Namespace : C1Theme Class

The following tables list the members exposed by C1Theme.

Public Constructors
Name

Description

C1Theme Constructor Initializes a new instance of the C1Theme class.

Top

Public Properties
Name

Description

Attrs

Overridden. Gets the theme attributes.

FormatVersion
Icon

Gets or sets the theme icon.

OriginalThemeVersion Gets an original theme version that was defined in loaded xml.
Template

For internal use. Gets an internal theme template.

ThemeVersion
Top

Public Methods
Name

Description

ApplyThemeToControlTree Recursively applies a theme to a control and its children.

Controls that do not support themes are ignored (but the
theme is applied to their children).
ApplyThemeToObject

Applies a theme to an object.

The target object must be either a C1 control supporting
themes, or a standard control (such as Button, Label etc) for
which basic theming is provided by this library.

AssignAttrsFrom

Overridden.

AssignFrom

Overridden. Loads the current theme from a ThemeItem.

GetBlend

Gets a System.Drawing.Drawing2D.Blend specified by a

path.

GetBool

Overloaded. Gets a boolean value specified by a path.

GetColor

Overloaded. Gets a System.Drawing.Color value specified

by a path.

GetColorBlend

Gets a System.Drawing.Drawing2D.ColorBlend specified

by a path.

GetDouble

Gets a double value specified by a path.

GetEnum

Overloaded. Gets an enumeration value specified by a

path.

GetEnumStr

Gets a string representation of an enumeration value

specified by a path.

GetFont

Overloaded. Gets a System.Drawing.Font specified by a

path.

GetImage

Overloaded. Gets an image specified by a path.

GetInt

Overloaded. Gets an integer value specified by a path.

GetPoint

Gets a System.Drawing.Point specified by a path.

GetString

Gets a string specified by a path.

GetThemeName

Overloaded. Retrieves the name of a theme stored in a

stream. This method assumes that stream contains theme in
C1ThemeFormat.Xml format.

GetThickness

Gets a System.Windows.Forms.Padding specified by a

path.

GetUsedFonts

Retrieves names of all fonts used in the current theme.

HasValue

Tests whether a path specifies a value.

Note that a path may be empty (i.e. IsEmpty returns true)
and still specify a value via a reference on one of its parents
(i.e. this method will return true).

IsEmpty
IsTreeEmpty

Overloaded. Recursively checks whether the specified path

including all its children contain neither values nor
references.

Load

Overloaded. Loads the current theme from a stream. This

method assumes that stream contains theme in
C1ThemeFormat.Xml format.

Save

Overloaded. Saves the current theme to a stream. This

method saves theme in the C1ThemeFormat.Xml format.

Top

See Also
Reference
C1Theme Class
C1.Win.C1Themes Namespace

C1Theme Constructor
C1.Win.C1Themes.4 Assembly > C1.Win.C1Themes Namespace > C1Theme Class : C1Theme Constructor

Initializes a new instance of the C1Theme class.

Syntax
Visual Basic (Declaration)
Public Function New()
C#
public C1Theme()

See Also
Reference
C1Theme Class
C1Theme Members

Methods
C1.Win.C1Themes.4 Assembly > C1.Win.C1Themes Namespace : C1Theme Class

For a list of all members of this type, see C1Theme members.

Public Methods
Name

Description

ApplyThemeToControlTree Recursively applies a theme to a control and its children.

Controls that do not support themes are ignored (but the
theme is applied to their children).
ApplyThemeToObject

Applies a theme to an object.

The target object must be either a C1 control supporting
themes, or a standard control (such as Button, Label etc) for
which basic theming is provided by this library.

AssignAttrsFrom

Overridden.

AssignFrom

Overridden. Loads the current theme from a ThemeItem.

GetBlend

Gets a System.Drawing.Drawing2D.Blend specified by a

path.

GetBool

Overloaded. Gets a boolean value specified by a path.

GetColor

Overloaded. Gets a System.Drawing.Color value specified

by a path.

GetColorBlend

Gets a System.Drawing.Drawing2D.ColorBlend specified

by a path.

GetDouble

Gets a double value specified by a path.

GetEnum

Overloaded. Gets an enumeration value specified by a

path.
GetEnumStr

Gets a string representation of an enumeration value

specified by a path.

GetFont

Overloaded. Gets a System.Drawing.Font specified by a

path.

GetImage

Overloaded. Gets an image specified by a path.

GetInt

Overloaded. Gets an integer value specified by a path.

GetPoint

Gets a System.Drawing.Point specified by a path.

GetString

Gets a string specified by a path.

GetThemeName

Overloaded. Retrieves the name of a theme stored in a

stream. This method assumes that stream contains theme in
C1ThemeFormat.Xml format.

GetThickness

Gets a System.Windows.Forms.Padding specified by a

path.

GetUsedFonts

Retrieves names of all fonts used in the current theme.

HasValue

Tests whether a path specifies a value.

Note that a path may be empty (i.e. IsEmpty returns true)
and still specify a value via a reference on one of its parents
(i.e. this method will return true).

IsEmpty
IsTreeEmpty

Overloaded. Recursively checks whether the specified path

including all its children contain neither values nor
references.

Load

Overloaded. Loads the current theme from a stream. This

method assumes that stream contains theme in
C1ThemeFormat.Xml format.

Save

Overloaded. Saves the current theme to a stream. This

method saves theme in the C1ThemeFormat.Xml format.

Top

See Also
Reference
C1Theme Class
C1.Win.C1Themes Namespace

ApplyThemeToControlTree Method
C1.Win.C1Themes.4 Assembly > C1.Win.C1Themes Namespace > C1Theme Class :
ApplyThemeToControlTree Method

The root control to apply the theme to.

Predicate which, if specified, allows to break theme application on certain nodes in the tree if it
returns false.
Recursively applies a theme to a control and its children. Controls that do not support themes
are ignored (but the theme is applied to their children).

Syntax
Visual Basic (Declaration)
Public Sub ApplyThemeToControlTree( _
ByVal root As System.Windows.Forms.Control, _
Optional ByVal applyThemeToSubTree As System.Predicate(Of Control) _
)
C#
public void ApplyThemeToControlTree(
System.Windows.Forms.Control root,
System.Predicate<Control> applyThemeToSubTree
)

Parameters

root
The root control to apply the theme to.
applyThemeToSubTree
Predicate which, if specified, allows to break theme application on certain nodes in the
tree if it returns false.

See Also
Reference
C1Theme Class
C1Theme Members

ApplyThemeToObject Method
C1.Win.C1Themes.4 Assembly > C1.Win.C1Themes Namespace > C1Theme Class : ApplyThemeToObject
Method

The object to apply the theme to.

Applies a theme to an object.
The target object must be either a C1 control supporting themes, or a standard control (such as
Button, Label etc) for which basic theming is provided by this library.

Syntax
Visual Basic (Declaration)
Public Function ApplyThemeToObject( _
ByVal obj As System.Object _
) As System.Boolean
C#
public System.bool ApplyThemeToObject(
System.object obj
)

Parameters
obj
The object to apply the theme to.

Return Value

True of the theme was successfully applied, false otherwise (i.e. if the object does not
support theming).

See Also
Reference
C1Theme Class
C1Theme Members

AssignAttrsFrom Method
C1.Win.C1Themes.4 Assembly > C1.Win.C1Themes Namespace > C1Theme Class : AssignAttrsFrom
Method

Syntax
Visual Basic (Declaration)
Public Overrides Sub AssignAttrsFrom( _
ByVal source As ThemeItem _
)
C#
public override void AssignAttrsFrom(
ThemeItem source
)

Parameters
source

See Also
Reference
C1Theme Class
C1Theme Members

AssignFrom Method
C1.Win.C1Themes.4 Assembly > C1.Win.C1Themes Namespace > C1Theme Class : AssignFrom Method

The source theme item.

Loads the current theme from a ThemeItem.

Syntax

Visual Basic (Declaration)

Public Overrides Sub AssignFrom( _
ByVal source As ThemeItem _
)
C#
public override void AssignFrom(
ThemeItem source
)

Parameters
source
The source theme item.

See Also
Reference
C1Theme Class
C1Theme Members

GetBlend Method
C1.Win.C1Themes.4 Assembly > C1.Win.C1Themes Namespace > C1Theme Class : GetBlend Method

The target path.

Gets a System.Drawing.Drawing2D.Blend specified by a path.

Syntax
Visual Basic (Declaration)
Public Function GetBlend( _
ByVal path As System.String _
) As System.Drawing.Drawing2D.Blend
C#
public System.Drawing.Drawing2D.Blend GetBlend(
System.string path
)

Parameters

path
The target path.

Return Value
The blend specified by path.

See Also
Reference
C1Theme Class
C1Theme Members

GetBool Method
C1.Win.C1Themes.4 Assembly > C1.Win.C1Themes Namespace > C1Theme Class : GetBool Method

Gets a boolean value specified by a path.

Overload List
Overload

Description

GetBool(String)

Gets a boolean value specified by a path.

GetBool(String,Boolean) Gets a boolean value specified by a path.

See Also
Reference
C1Theme Class
C1Theme Members

GetBool(String) Method
C1.Win.C1Themes.4 Assembly > C1.Win.C1Themes Namespace > C1Theme Class > GetBool Method :
GetBool(String) Method

The target path.

Gets a boolean value specified by a path.

Syntax
Visual Basic (Declaration)

Public Overloads Function GetBool( _

ByVal path As System.String _
) As System.Boolean
C#
public System.bool GetBool(
System.string path
)

Parameters
path
The target path.

Return Value
The boolean value specified by path.

See Also
Reference
C1Theme Class
C1Theme Members
Overload List

GetBool(String,Boolean) Method
C1.Win.C1Themes.4 Assembly > C1.Win.C1Themes Namespace > C1Theme Class > GetBool Method :
GetBool(String,Boolean) Method

The target path.

Used if value at specified path does not exist.
Gets a boolean value specified by a path.

Syntax
Visual Basic (Declaration)
Public Overloads Function GetBool( _
ByVal path As System.String, _
ByVal defaultValue As System.Boolean _
) As System.Boolean
C#

public System.bool GetBool(

System.string path,
System.bool defaultValue
)

Parameters
path
The target path.
defaultValue
Used if value at specified path does not exist.

Return Value
The boolean value specified by path or %% if value at specified path does not exist.

See Also
Reference
C1Theme Class
C1Theme Members
Overload List

GetColor Method
C1.Win.C1Themes.4 Assembly > C1.Win.C1Themes Namespace > C1Theme Class : GetColor Method

Gets a System.Drawing.Color value specified by a path.

Overload List
Overload

Description

GetColor(String)

Gets a System.Drawing.Color value specified by a path.

GetColor(String,Color) Gets a System.Drawing.Color value specified by a path.

See Also
Reference
C1Theme Class
C1Theme Members

GetColor(String) Method
C1.Win.C1Themes.4 Assembly > C1.Win.C1Themes Namespace > C1Theme Class > GetColor Method :
GetColor(String) Method

The target path.

Gets a System.Drawing.Color value specified by a path.

Syntax
Visual Basic (Declaration)
Public Overloads Function GetColor( _
ByVal path As System.String _
) As System.Drawing.Color
C#
public System.Drawing.Color GetColor(
System.string path
)

Parameters
path
The target path.

Return Value
The color specified by path.

See Also
Reference
C1Theme Class
C1Theme Members
Overload List

GetColor(String,Color) Method
C1.Win.C1Themes.4 Assembly > C1.Win.C1Themes Namespace > C1Theme Class > GetColor Method :
GetColor(String,Color) Method

The target path.

Used if value at specified path does not exist.
Gets a System.Drawing.Color value specified by a path.

Syntax
Visual Basic (Declaration)
Public Overloads Function GetColor( _
ByVal path As System.String, _
ByVal defaultValue As System.Drawing.Color _
) As System.Drawing.Color
C#
public System.Drawing.Color GetColor(
System.string path,
System.Drawing.Color defaultValue
)

Parameters
path
The target path.
defaultValue
Used if value at specified path does not exist.

Return Value
The color specified by path or %% if value at specified path does not exist.

See Also
Reference
C1Theme Class
C1Theme Members
Overload List

GetColorBlend Method
C1.Win.C1Themes.4 Assembly > C1.Win.C1Themes Namespace > C1Theme Class : GetColorBlend Method

The target path.

Gets a System.Drawing.Drawing2D.ColorBlend specified by a path.

Syntax

Visual Basic (Declaration)

Public Function GetColorBlend( _
ByVal path As System.String _
) As System.Drawing.Drawing2D.ColorBlend
C#
public System.Drawing.Drawing2D.ColorBlend GetColorBlend(
System.string path
)

Parameters
path
The target path.

Return Value
The color blend specified by path.

See Also
Reference
C1Theme Class
C1Theme Members

GetDouble Method
C1.Win.C1Themes.4 Assembly > C1.Win.C1Themes Namespace > C1Theme Class : GetDouble Method

The target path.

Gets a double value specified by a path.

Syntax
Visual Basic (Declaration)
Public Function GetDouble( _
ByVal path As System.String _
) As System.Double
C#
public System.double GetDouble(

System.string path
)

Parameters
path
The target path.

Return Value
The double value specified by path.

See Also
Reference
C1Theme Class
C1Theme Members

GetEnum Method
C1.Win.C1Themes.4 Assembly > C1.Win.C1Themes Namespace > C1Theme Class : GetEnum Method

Gets an enumeration value specified by a path.

Overload List
Overload

Description

GetEnum(String)

Gets an enumeration value specified by a path.

GetEnum<T>(String,T) Gets an enumeration value specified by a path.

See Also
Reference
C1Theme Class
C1Theme Members

GetEnum(String) Method
C1.Win.C1Themes.4 Assembly > C1.Win.C1Themes Namespace > C1Theme Class > GetEnum Method :
GetEnum(String) Method

The target path.

Gets an enumeration value specified by a path.

Syntax
Visual Basic (Declaration)
Public Overloads Function GetEnum( _
ByVal path As System.String _
) As System.Object
C#
public System.object GetEnum(
System.string path
)

Parameters
path
The target path.

Return Value
The enum value specified by path.

See Also
Reference
C1Theme Class
C1Theme Members
Overload List

GetEnum<T>(String,T) Method
C1.Win.C1Themes.4 Assembly > C1.Win.C1Themes Namespace > C1Theme Class > GetEnum Method :
GetEnum<T>(String,T) Method

The target path.

Used if value at specified path does not exist.
Gets an enumeration value specified by a path.

Syntax
Visual Basic (Declaration)
Public Overloads Function GetEnum(Of T)( _
ByVal path As System.String, _

ByVal defaultValue As T _
) As T
C#
public T GetEnum<T>(
System.string path,
T defaultValue
)

Parameters
path
The target path.
defaultValue
Used if value at specified path does not exist.

Type Parameters
T

Return Value
The enum value specified by path or %% if value at specified path does not
exist.

See Also
Reference
C1Theme Class
C1Theme Members
Overload List

GetEnumStr Method
C1.Win.C1Themes.4 Assembly > C1.Win.C1Themes Namespace > C1Theme Class : GetEnumStr Method

The target path.

Gets a string representation of an enumeration value specified by a path.

Syntax
Visual Basic (Declaration)
Public Function GetEnumStr( _

ByVal path As System.String _

) As System.String
C#
public System.string GetEnumStr(
System.string path
)

Parameters
path
The target path.

Return Value
The enum string specified by path.

See Also
Reference
C1Theme Class
C1Theme Members

GetFont Method
C1.Win.C1Themes.4 Assembly > C1.Win.C1Themes Namespace > C1Theme Class : GetFont Method

Gets a System.Drawing.Font specified by a path.

Overload List
Overload

Description

GetFont(String)

Gets a System.Drawing.Font specified by a path.

GetFont(String,Font) Gets a System.Drawing.Font specified by a path.

See Also
Reference
C1Theme Class
C1Theme Members

GetFont(String) Method
C1.Win.C1Themes.4 Assembly > C1.Win.C1Themes Namespace > C1Theme Class > GetFont Method :
GetFont(String) Method

The target path.

Gets a System.Drawing.Font specified by a path.

Syntax
Visual Basic (Declaration)
Public Overloads Function GetFont( _
ByVal path As System.String _
) As System.Drawing.Font
C#
public System.Drawing.Font GetFont(
System.string path
)

Parameters
path
The target path.

Return Value
The font specified by path.

See Also
Reference
C1Theme Class
C1Theme Members
Overload List

GetFont(String,Font) Method
C1.Win.C1Themes.4 Assembly > C1.Win.C1Themes Namespace > C1Theme Class > GetFont Method :
GetFont(String,Font) Method

The target path.

Used if value at specified path does not exist.
Gets a System.Drawing.Font specified by a path.

Syntax
Visual Basic (Declaration)
Public Overloads Function GetFont( _
ByVal path As System.String, _
ByVal defaultValue As System.Drawing.Font _
) As System.Drawing.Font
C#
public System.Drawing.Font GetFont(
System.string path,
System.Drawing.Font defaultValue
)

Parameters
path
The target path.
defaultValue
Used if value at specified path does not exist.

Return Value
The font specified by path or %% if font at specified path does not exist.

See Also
Reference
C1Theme Class
C1Theme Members
Overload List

GetImage Method
C1.Win.C1Themes.4 Assembly > C1.Win.C1Themes Namespace > C1Theme Class : GetImage Method

Gets an image specified by a path.

Overload List
Overload

Description

GetImage(String)

Gets an image specified by a path.

GetImage(String,Image) Gets an image specified by a path.

See Also
Reference
C1Theme Class
C1Theme Members

GetImage(String) Method
C1.Win.C1Themes.4 Assembly > C1.Win.C1Themes Namespace > C1Theme Class > GetImage Method :
GetImage(String) Method

The target path.

Gets an image specified by a path.

Syntax
Visual Basic (Declaration)
Public Overloads Function GetImage( _
ByVal path As System.String _
) As System.Drawing.Image
C#
public System.Drawing.Image GetImage(
System.string path
)

Parameters
path
The target path.

Return Value
The image specified by path, or null.

See Also
Reference

C1Theme Class
C1Theme Members
Overload List

GetImage(String,Image) Method
C1.Win.C1Themes.4 Assembly > C1.Win.C1Themes Namespace > C1Theme Class > GetImage Method :
GetImage(String,Image) Method

The target path.

Used if value at specified path does not exist.
Gets an image specified by a path.

Syntax
Visual Basic (Declaration)
Public Overloads Function GetImage( _
ByVal path As System.String, _
ByVal defaultValue As System.Drawing.Image _
) As System.Drawing.Image
C#
public System.Drawing.Image GetImage(
System.string path,
System.Drawing.Image defaultValue
)

Parameters
path
The target path.
defaultValue
Used if value at specified path does not exist.

Return Value
The image specified by path or %% if image at specified path does not exist.

See Also
Reference

C1Theme Class
C1Theme Members
Overload List

GetInt Method
C1.Win.C1Themes.4 Assembly > C1.Win.C1Themes Namespace > C1Theme Class : GetInt Method

Gets an integer value specified by a path.

Overload List
Overload

Description

GetInt(String)

Gets an integer value specified by a path.

GetInt(String,Int32) Gets an integer value specified by a path.

See Also
Reference
C1Theme Class
C1Theme Members

GetInt(String) Method
C1.Win.C1Themes.4 Assembly > C1.Win.C1Themes Namespace > C1Theme Class > GetInt Method :
GetInt(String) Method

The target path.

Gets an integer value specified by a path.

Syntax
Visual Basic (Declaration)
Public Overloads Function GetInt( _
ByVal path As System.String _
) As System.Integer
C#
public System.int GetInt(
System.string path
)

Parameters
path
The target path.

Return Value
The integer value specified by path.

See Also
Reference
C1Theme Class
C1Theme Members
Overload List

GetInt(String,Int32) Method
C1.Win.C1Themes.4 Assembly > C1.Win.C1Themes Namespace > C1Theme Class > GetInt Method :
GetInt(String,Int32) Method

The target path.

Used if value at specified path does not exist.
Gets an integer value specified by a path.

Syntax
Visual Basic (Declaration)
Public Overloads Function GetInt( _
ByVal path As System.String, _
ByVal defaultValue As System.Integer _
) As System.Integer
C#
public System.int GetInt(
System.string path,
System.int defaultValue
)

Parameters
path
The target path.

defaultValue
Used if value at specified path does not exist.

Return Value
The integer value specified by path or %% if value at specified path does not exist.

See Also
Reference
C1Theme Class
C1Theme Members
Overload List

GetPoint Method
C1.Win.C1Themes.4 Assembly > C1.Win.C1Themes Namespace > C1Theme Class : GetPoint Method

The target path.

Gets a System.Drawing.Point specified by a path.

Syntax
Visual Basic (Declaration)
Public Function GetPoint( _
ByVal path As System.String _
) As System.Drawing.Point
C#
public System.Drawing.Point GetPoint(
System.string path
)

Parameters
path
The target path.

Return Value
The point specified by path.

See Also

Reference
C1Theme Class
C1Theme Members

GetString Method
C1.Win.C1Themes.4 Assembly > C1.Win.C1Themes Namespace > C1Theme Class : GetString Method

The target path.

Gets a string specified by a path.

Syntax
Visual Basic (Declaration)
Public Function GetString( _
ByVal path As System.String _
) As System.String
C#
public System.string GetString(
System.string path
)

Parameters
path
The target path.

Return Value
The string specified by path.

See Also
Reference
C1Theme Class
C1Theme Members

GetThemeName Method
C1.Win.C1Themes.4 Assembly > C1.Win.C1Themes Namespace > C1Theme Class : GetThemeName
Method

Retrieves the name of a theme stored in a stream. This method assumes that stream contains
theme in C1ThemeFormat.Xml format.

Overload List
Overload

Description

GetThemeName(Stream)

Retrieves the name of a theme stored in a stream.

This method assumes that stream contains theme in
C1ThemeFormat.Xml format.

GetThemeName(Stream,C1ThemeFormat) Retrieves the name of a theme stored in a stream.

GetThemeName(String)

Retrieves the name of a theme stored in a stream.

The theme format determined on the base of the file
extension.

GetThemeName(String,C1ThemeFormat)

Retrieves the name of a theme stored in a stream.

See Also
Reference
C1Theme Class
C1Theme Members

GetThemeName(Stream) Method
C1.Win.C1Themes.4 Assembly > C1.Win.C1Themes Namespace > C1Theme Class > GetThemeName
Method : GetThemeName(Stream) Method

The stream containing the theme XML.

Retrieves the name of a theme stored in a stream. This method assumes that stream contains
theme in C1ThemeFormat.Xml format.

Syntax
Visual Basic (Declaration)
Public Overloads Shared Function GetThemeName( _
ByVal stream As System.IO.Stream _
) As System.String
C#
public static System.string GetThemeName(

System.IO.Stream stream
)

Parameters
stream
The stream containing the theme XML.

Return Value
The name of the theme, or null if no theme could be found in the stream.

See Also
Reference
C1Theme Class
C1Theme Members
Overload List

GetThemeName(Stream,C1ThemeFormat) Method
C1.Win.C1Themes.4 Assembly > C1.Win.C1Themes Namespace > C1Theme Class > GetThemeName
Method : GetThemeName(Stream,C1ThemeFormat) Method

The stream containing the theme XML.

The document persistence format to use.
Retrieves the name of a theme stored in a stream.

Syntax
Visual Basic (Declaration)
Public Overloads Shared Function GetThemeName( _
ByVal stream As System.IO.Stream, _
ByVal format As C1ThemeFormat _
) As System.String
C#
public static System.string GetThemeName(
System.IO.Stream stream,
C1ThemeFormat format
)

Parameters

stream
The stream containing the theme XML.
format
The document persistence format to use.

Return Value
The name of the theme, or null if no theme could be found in the stream.

See Also
Reference
C1Theme Class
C1Theme Members
Overload List

GetThemeName(String) Method
C1.Win.C1Themes.4 Assembly > C1.Win.C1Themes Namespace > C1Theme Class > GetThemeName
Method : GetThemeName(String) Method

The file containing the theme XML.

Retrieves the name of a theme stored in a stream. The theme format determined on the base of
the file extension.

Syntax
Visual Basic (Declaration)
Public Overloads Shared Function GetThemeName( _
ByVal fileName As System.String _
) As System.String
C#
public static System.string GetThemeName(
System.string fileName
)

Parameters
fileName
The file containing the theme XML.

Return Value

The name of the theme, or null if no theme could be found in the file.

See Also
Reference
C1Theme Class
C1Theme Members
Overload List

GetThemeName(String,C1ThemeFormat) Method
C1.Win.C1Themes.4 Assembly > C1.Win.C1Themes Namespace > C1Theme Class > GetThemeName
Method : GetThemeName(String,C1ThemeFormat) Method

The file containing the theme XML.

The document persistence format to use.
Retrieves the name of a theme stored in a stream.

Syntax
Visual Basic (Declaration)
Public Overloads Shared Function GetThemeName( _
ByVal fileName As System.String, _
ByVal format As C1ThemeFormat _
) As System.String
C#
public static System.string GetThemeName(
System.string fileName,
C1ThemeFormat format
)

Parameters
fileName
The file containing the theme XML.
format
The document persistence format to use.

Return Value
The name of the theme, or null if no theme could be found in the file.

See Also
Reference
C1Theme Class
C1Theme Members
Overload List

GetThickness Method
C1.Win.C1Themes.4 Assembly > C1.Win.C1Themes Namespace > C1Theme Class : GetThickness Method

The target path.

Gets a System.Windows.Forms.Padding specified by a path.

Syntax
Visual Basic (Declaration)
Public Function GetThickness( _
ByVal path As System.String _
) As System.Windows.Forms.Padding
C#
public System.Windows.Forms.Padding GetThickness(
System.string path
)

Parameters
path
The target path.

Return Value
The padding specified by path.

See Also
Reference
C1Theme Class
C1Theme Members

GetUsedFonts Method
C1.Win.C1Themes.4 Assembly > C1.Win.C1Themes Namespace > C1Theme Class : GetUsedFonts Method

Retrieves names of all fonts used in the current theme.

Syntax
Visual Basic (Declaration)
Public Function GetUsedFonts() As System.String()
C#
public System.string[] GetUsedFonts()

Return Value
An array of strings containing names of all fonts used in the current theme.

See Also
Reference
C1Theme Class
C1Theme Members

HasValue Method
C1.Win.C1Themes.4 Assembly > C1.Win.C1Themes Namespace > C1Theme Class : HasValue Method

The path to test.

Tests whether a path specifies a value.
Note that a path may be empty (i.e. IsEmpty returns true) and still specify a value via a reference
on one of its parents (i.e. this method will return true).

Syntax
Visual Basic (Declaration)
Public Function HasValue( _
ByVal path As System.String _
) As System.Boolean
C#
public System.bool HasValue(

System.string path
)

Parameters
path
The path to test.

Return Value
True if the path specifies a value, false otherwise.

See Also
Reference
C1Theme Class
C1Theme Members

IsEmpty Method
C1.Win.C1Themes.4 Assembly > C1.Win.C1Themes Namespace > C1Theme Class : IsEmpty Method

The target path.

Syntax
Visual Basic (Declaration)
Public Function IsEmpty( _
ByVal path As System.String _
) As System.Boolean
C#
public System.bool IsEmpty(
System.string path
)

Parameters
path
The target path.

See Also
Reference

C1Theme Class
C1Theme Members

IsTreeEmpty Method
C1.Win.C1Themes.4 Assembly > C1.Win.C1Themes Namespace > C1Theme Class : IsTreeEmpty Method

Recursively checks whether the specified path including all its children contain neither values
nor references.

Overload List
Overload

Description

IsTreeEmpty(String) Recursively checks whether the specified path including all its children
contain neither values nor references.

See Also
Reference
C1Theme Class
C1Theme Members

IsTreeEmpty(String) Method
C1.Win.C1Themes.4 Assembly > C1.Win.C1Themes Namespace > C1Theme Class > IsTreeEmpty Method :
IsTreeEmpty(String) Method

The target path.

Recursively checks whether the specified path including all its children contain neither values
nor references.

Syntax
Visual Basic (Declaration)
Public Overloads Function IsTreeEmpty( _
ByVal path As System.String _
) As System.Boolean
C#
public System.bool IsTreeEmpty(
System.string path
)

Parameters

path
The target path.

Return Value
True if neither the path, nor any of its children contain values or references, false otherwise.

See Also
Reference
C1Theme Class
C1Theme Members
Overload List

Load Method
C1.Win.C1Themes.4 Assembly > C1.Win.C1Themes Namespace > C1Theme Class : Load Method

Loads the current theme from a stream. This method assumes that stream contains theme in
C1ThemeFormat.Xml format.

Overload List
Overload

Description

Load(Stream)

Loads the current theme from a stream. This method assumes

that stream contains theme in C1ThemeFormat.Xml format.

Load(Stream,C1ThemeFormat) Loads the current theme from a stream.

Load(String)

Loads the current theme from a file. The theme format

determined on the base of the file extension.

Load(String,C1ThemeFormat)

Loads the current theme from a file.

See Also
Reference
C1Theme Class
C1Theme Members

Load(Stream) Method
C1.Win.C1Themes.4 Assembly > C1.Win.C1Themes Namespace > C1Theme Class > Load Method :

Load(Stream) Method

The source stream.

Loads the current theme from a stream. This method assumes that stream contains theme in
C1ThemeFormat.Xml format.

Syntax
Visual Basic (Declaration)
Public Overloads Sub Load( _
ByVal stream As System.IO.Stream _
)
C#
public void Load(
System.IO.Stream stream
)

Parameters
stream
The source stream.

See Also
Reference
C1Theme Class
C1Theme Members
Overload List

Load(Stream,C1ThemeFormat) Method
C1.Win.C1Themes.4 Assembly > C1.Win.C1Themes Namespace > C1Theme Class > Load Method :
Load(Stream,C1ThemeFormat) Method

The source stream.

The theme persistence format to use.
Loads the current theme from a stream.

Syntax
Visual Basic (Declaration)

Public Overloads Sub Load( _

ByVal stream As System.IO.Stream, _
ByVal format As C1ThemeFormat _
)
C#
public void Load(
System.IO.Stream stream,
C1ThemeFormat format
)

Parameters
stream
The source stream.
format
The theme persistence format to use.

See Also
Reference
C1Theme Class
C1Theme Members
Overload List

Load(String) Method
C1.Win.C1Themes.4 Assembly > C1.Win.C1Themes Namespace > C1Theme Class > Load Method :
Load(String) Method

The source file name.

Loads the current theme from a file. The theme format determined on the base of the file
extension.

Syntax
Visual Basic (Declaration)
Public Overloads Sub Load( _
ByVal fileName As System.String _
)

C#
public void Load(
System.string fileName
)

Parameters
fileName
The source file name.

See Also
Reference
C1Theme Class
C1Theme Members
Overload List

Load(String,C1ThemeFormat) Method
C1.Win.C1Themes.4 Assembly > C1.Win.C1Themes Namespace > C1Theme Class > Load Method :
Load(String,C1ThemeFormat) Method

The theme persistence format to use.

Loads the current theme from a file.

Syntax
Visual Basic (Declaration)
Public Overloads Sub Load( _
ByVal fileName As System.String, _
ByVal format As C1ThemeFormat _
)
C#
public void Load(
System.string fileName,
C1ThemeFormat format
)

Parameters
fileName

format
The theme persistence format to use.

See Also
Reference
C1Theme Class
C1Theme Members
Overload List

Save Method
C1.Win.C1Themes.4 Assembly > C1.Win.C1Themes Namespace > C1Theme Class : Save Method

Saves the current theme to a stream. This method saves theme in the C1ThemeFormat.Xml
format.

Overload List
Overload

Description

Save(Stream)

Saves the current theme to a stream. This method saves theme

in the C1ThemeFormat.Xml format.

Save(Stream,C1ThemeFormat) Saves the current theme to a stream.

Save(String,C1ThemeFormat)

Saves the current theme to a file.

Save(String)

Saves the current theme to a file. The theme format determined

on the base of the file extension.

See Also
Reference
C1Theme Class
C1Theme Members

Save(Stream) Method
C1.Win.C1Themes.4 Assembly > C1.Win.C1Themes Namespace > C1Theme Class > Save Method :
Save(Stream) Method

The target stream.

Saves the current theme to a stream. This method saves theme in the C1ThemeFormat.Xml
format.

Syntax
Visual Basic (Declaration)
Public Overloads Sub Save( _
ByVal stream As System.IO.Stream _
)
C#
public void Save(
System.IO.Stream stream
)

Parameters
stream
The target stream.

See Also
Reference
C1Theme Class
C1Theme Members
Overload List

Save(Stream,C1ThemeFormat) Method
C1.Win.C1Themes.4 Assembly > C1.Win.C1Themes Namespace > C1Theme Class > Save Method :
Save(Stream,C1ThemeFormat) Method

The target stream.

The theme persistence format to use.
Saves the current theme to a stream.

Syntax
Visual Basic (Declaration)
Public Overloads Sub Save( _
ByVal stream As System.IO.Stream, _

ByVal format As C1ThemeFormat _

)
C#
public void Save(
System.IO.Stream stream,
C1ThemeFormat format
)

Parameters
stream
The target stream.
format
The theme persistence format to use.

See Also
Reference
C1Theme Class
C1Theme Members
Overload List

Save(String,C1ThemeFormat) Method
C1.Win.C1Themes.4 Assembly > C1.Win.C1Themes Namespace > C1Theme Class > Save Method :
Save(String,C1ThemeFormat) Method

The target file name.

The theme persistence format to use.
Saves the current theme to a file.

Syntax
Visual Basic (Declaration)
Public Overloads Sub Save( _
ByVal fileName As System.String, _
ByVal format As C1ThemeFormat _
)
C#

public void Save(

System.string fileName,
C1ThemeFormat format
)

Parameters
fileName
The target file name.
format
The theme persistence format to use.

See Also
Reference
C1Theme Class
C1Theme Members
Overload List

Save(String) Method
C1.Win.C1Themes.4 Assembly > C1.Win.C1Themes Namespace > C1Theme Class > Save Method :
Save(String) Method

The target file name.

Saves the current theme to a file. The theme format determined on the base of the file
extension.

Syntax
Visual Basic (Declaration)
Public Overloads Sub Save( _
ByVal fileName As System.String _
)
C#
public void Save(
System.string fileName
)

Parameters
fileName

The target file name.

See Also
Reference
C1Theme Class
C1Theme Members
Overload List

Properties
C1.Win.C1Themes.4 Assembly > C1.Win.C1Themes Namespace : C1Theme Class

For a list of all members of this type, see C1Theme members.

Public Properties
Name

Description

Attrs

Overridden. Gets the theme attributes.

FormatVersion
Icon

Gets or sets the theme icon.

OriginalThemeVersion Gets an original theme version that was defined in loaded xml.
Template

For internal use. Gets an internal theme template.

ThemeVersion
Top

See Also
Reference
C1Theme Class
C1.Win.C1Themes Namespace

Attrs Property
C1.Win.C1Themes.4 Assembly > C1.Win.C1Themes Namespace > C1Theme Class : Attrs Property

Gets the theme attributes.

Syntax
Visual Basic (Declaration)
Public Overrides ReadOnly Property Attrs As ThemeItemAttrs
C#
public override ThemeItemAttrs Attrs {get;}

See Also
Reference
C1Theme Class
C1Theme Members

FormatVersion Property
C1.Win.C1Themes.4 Assembly > C1.Win.C1Themes Namespace > C1Theme Class : FormatVersion Property

Syntax
Visual Basic (Declaration)
Public Shared ReadOnly Property FormatVersion As System.Version
C#
public static System.Version FormatVersion {get;}

See Also
Reference
C1Theme Class
C1Theme Members

Icon Property
C1.Win.C1Themes.4 Assembly > C1.Win.C1Themes Namespace > C1Theme Class : Icon Property

Gets or sets the theme icon.

Syntax
Visual Basic (Declaration)

Public Property Icon As System.Drawing.Icon

C#
public System.Drawing.Icon Icon {get; set;}

See Also
Reference
C1Theme Class
C1Theme Members

OriginalThemeVersion Property
C1.Win.C1Themes.4 Assembly > C1.Win.C1Themes Namespace > C1Theme Class : OriginalThemeVersion
Property

Gets an original theme version that was defined in loaded xml.

Syntax
Visual Basic (Declaration)
Public ReadOnly Property OriginalThemeVersion As C1ThemeVersion
C#
public C1ThemeVersion OriginalThemeVersion {get;}

See Also
Reference
C1Theme Class
C1Theme Members

Template Property
C1.Win.C1Themes.4 Assembly > C1.Win.C1Themes Namespace > C1Theme Class : Template Property

For internal use. Gets an internal theme template.

Syntax
Visual Basic (Declaration)
Public Shared ReadOnly Property Template As C1Theme

C#
public static C1Theme Template {get;}

See Also
Reference
C1Theme Class
C1Theme Members

ThemeVersion Property
C1.Win.C1Themes.4 Assembly > C1.Win.C1Themes Namespace > C1Theme Class : ThemeVersion Property

Syntax
Visual Basic (Declaration)
Public Shared ReadOnly Property ThemeVersion As C1ThemeVersion
C#
public static C1ThemeVersion ThemeVersion {get;}

See Also
Reference
C1Theme Class
C1Theme Members

C1ThemeCollection
Members
C1.Win.C1Themes.4 Assembly > C1.Win.C1Themes Namespace : C1ThemeCollection Class

Represents a collection of C1Theme objects, keyed by their names.

Object Model

Syntax
Visual Basic (Declaration)

Public Class C1ThemeCollection

Inherits System.Collections.ObjectModel.KeyedCollection(Of String,C1Theme)
C#
public class C1ThemeCollection :
System.Collections.ObjectModel.KeyedCollection<string,C1Theme>

Inheritance Hierarchy
System.Object
System.Collections.ObjectModel.Collection<T>
System.Collections.ObjectModel.KeyedCollection<TKey,TItem>
C1.Win.C1Themes.C1ThemeCollection

See Also
Reference
C1ThemeCollection Members
C1.Win.C1Themes Namespace

Overview
Members
C1.Win.C1Themes.4 Assembly > C1.Win.C1Themes Namespace : C1ThemeCollection Class

Represents a collection of C1Theme objects, keyed by their names.

Object Model

Syntax
Visual Basic (Declaration)
Public Class C1ThemeCollection
Inherits System.Collections.ObjectModel.KeyedCollection(Of String,C1Theme)
C#
public class C1ThemeCollection :
System.Collections.ObjectModel.KeyedCollection<string,C1Theme>

Inheritance Hierarchy

System.Object
System.Collections.ObjectModel.Collection<T>
System.Collections.ObjectModel.KeyedCollection<TKey,TItem>
C1.Win.C1Themes.C1ThemeCollection

See Also
Reference
C1ThemeCollection Members
C1.Win.C1Themes Namespace

Members
Properties Methods
C1.Win.C1Themes.4 Assembly > C1.Win.C1Themes Namespace : C1ThemeCollection Class

The following tables list the members exposed by C1ThemeCollection.

Public Constructors
Name

Description

C1ThemeCollection Constructor
Top

Public Properties
Name

Description

Comparer

(Inherited from
System.Collections.ObjectModel.KeyedCollection<string,C1Theme>)

Count

(Inherited from System.Collections.ObjectModel.Collection<C1Theme>)

Item

Overloaded. (Inherited from

System.Collections.ObjectModel.KeyedCollection<string,C1Theme>)

Top

Public Methods

Name

Description

Add

(Inherited from System.Collections.ObjectModel.Collection<C1Theme>)

Clear

(Inherited from System.Collections.ObjectModel.Collection<C1Theme>)

Contains

Overloaded. (Inherited from

System.Collections.ObjectModel.KeyedCollection<string,C1Theme>)

CopyTo

(Inherited from System.Collections.ObjectModel.Collection<C1Theme>)

IndexOf

(Inherited from System.Collections.ObjectModel.Collection<C1Theme>)

Insert

(Inherited from System.Collections.ObjectModel.Collection<C1Theme>)

Remove

Overloaded. (Inherited from

System.Collections.ObjectModel.KeyedCollection<string,C1Theme>)

RemoveAt

(Inherited from System.Collections.ObjectModel.Collection<C1Theme>)

TryGetValue

Retrieves a theme by its name.

Top

See Also
Reference
C1ThemeCollection Class
C1.Win.C1Themes Namespace

C1ThemeCollection Constructor
C1.Win.C1Themes.4 Assembly > C1.Win.C1Themes Namespace > C1ThemeCollection Class :
C1ThemeCollection Constructor

Syntax
Visual Basic (Declaration)
Public Function New()

C#
public C1ThemeCollection()

See Also
Reference
C1ThemeCollection Class
C1ThemeCollection Members

Methods
C1.Win.C1Themes.4 Assembly > C1.Win.C1Themes Namespace : C1ThemeCollection Class

For a list of all members of this type, see C1ThemeCollection members.

Public Methods
Name

Description

Add

(Inherited from System.Collections.ObjectModel.Collection<C1Theme>)

Clear

(Inherited from System.Collections.ObjectModel.Collection<C1Theme>)

Contains

Overloaded. (Inherited from

System.Collections.ObjectModel.KeyedCollection<string,C1Theme>)

CopyTo

(Inherited from System.Collections.ObjectModel.Collection<C1Theme>)

IndexOf

(Inherited from System.Collections.ObjectModel.Collection<C1Theme>)

Insert

(Inherited from System.Collections.ObjectModel.Collection<C1Theme>)

Remove

Overloaded. (Inherited from

System.Collections.ObjectModel.KeyedCollection<string,C1Theme>)

Top

RemoveAt

(Inherited from System.Collections.ObjectModel.Collection<C1Theme>)

TryGetValue

Retrieves a theme by its name.

See Also
Reference
C1ThemeCollection Class
C1.Win.C1Themes Namespace

TryGetValue Method
C1.Win.C1Themes.4 Assembly > C1.Win.C1Themes Namespace > C1ThemeCollection Class : TryGetValue
Method

The name of the theme to get.

OUT: the theme with the specified name, or null if none could be found.
Retrieves a theme by its name.

Syntax
Visual Basic (Declaration)
Public Function TryGetValue( _
ByVal key As System.String, _
ByRef theme As C1Theme _
) As System.Boolean
C#
public System.bool TryGetValue(
System.string key,
out C1Theme theme
)

Parameters
key
The name of the theme to get.
theme
OUT: the theme with the specified name, or null if none could be found.

Return Value
True if the theme was found, false otherwise.

See Also

Reference
C1ThemeCollection Class
C1ThemeCollection Members

C1ThemeController
Members
C1.Win.C1Themes.4 Assembly > C1.Win.C1Themes Namespace : C1ThemeController Class

Represents a component that loads and manages C1 visual themes, and applies them to forms
and controls.

Object Model

Syntax
Visual Basic (Declaration)
Public Class C1ThemeController
Inherits System.ComponentModel.Component
C#
public class C1ThemeController : System.ComponentModel.Component

Inheritance Hierarchy
System.Object
System.MarshalByRefObject
System.ComponentModel.Component
C1.Win.C1Themes.C1ThemeController

See Also
Reference
C1ThemeController Members
C1.Win.C1Themes Namespace

Overview
Members
C1.Win.C1Themes.4 Assembly > C1.Win.C1Themes Namespace : C1ThemeController Class

Represents a component that loads and manages C1 visual themes, and applies them to forms
and controls.

Object Model

Syntax
Visual Basic (Declaration)
Public Class C1ThemeController
Inherits System.ComponentModel.Component
C#
public class C1ThemeController : System.ComponentModel.Component

Inheritance Hierarchy
System.Object
System.MarshalByRefObject
System.ComponentModel.Component
C1.Win.C1Themes.C1ThemeController

See Also
Reference
C1ThemeController Members
C1.Win.C1Themes Namespace

Members
Fields Properties Methods Events
C1.Win.C1Themes.4 Assembly > C1.Win.C1Themes Namespace : C1ThemeController Class

The following tables list the members exposed by C1ThemeController.

Public Constructors
Name

Description

C1ThemeController Constructor Initializes a new instance of the C1ThemeController class.

Top

Public Fields
Name

Description

DefaultThemeName The default theme name id.

When assigned to the Theme property of a theme controller,
indicates that it should use the default application theme.

NoTheme

The empty theme name id.

When assigned to the "Theme" extender property (provided by
C1ThemeController) on a control, indicates that no theme should be
applied to that control by the theme controller.

Top

Public Properties
Name

Description

ApplicationTheme Gets or sets the application-wide default theme name.

All theme controllers which have "(default)" set as Theme property
value will use this theme.
This name is persisted with key "C1ApplicationTheme" in the
application config file (app.config).

Container

(Inherited from System.ComponentModel.Component)

Site

(Inherited from System.ComponentModel.Component)

Theme

Gets or sets the name of the default theme for all objects on the
form or user control managed by the current theme controller.

Top

Public Methods
Name

Description

ApplyThemeToControlTree

Recursively applies a theme to a control

and its children. Controls that do not
support themes are ignored (but the
theme is applied to their children).

ApplyThemeToObject

Applies a theme to an object.

The target object must be either a C1
control supporting themes, or a standard
control (such as Button, Label etc) for
which basic theming is provided by this
library.

CreateObjRef

(Inherited from
System.MarshalByRefObject)

Dispose

(Inherited from
System.ComponentModel.Component)

GetLifetimeService

(Inherited from
System.MarshalByRefObject)

GetTheme

Gets the name of a theme set on an

object by this theme controller.

GetThemeByName

Retrieves a theme registered with the

application, by its name.

GetThemes

Retrieves the names of all themes

registered with the application.

InitializeLifetimeService

(Inherited from
System.MarshalByRefObject)

IsObjectThemeable

Checks whether an object supports

ComponentOne themes.

IsPreviewControlInsideC1PrintPreviewControl
IsThemeRegistered

Checks whether a theme with a specified

name has been registered.

RegisterTheme

Overloaded. Loads a theme from a

stream, and registeres it for use by theme
controllers in the application.
After this method completes, the theme
can be set via ApplicationTheme and
Theme properties.
his method throws an exception if a
theme with same name has already been
registered.

RegisterThemes

Loads all themes from an assembly, and

registeres them for use by theme
controllers in the current application.
This method scans all resources in the
specified assembly, and selects those with
names ending in ".c1theme" (case
insensitive). If a theme cannot be loaded
(e.g. due to a duplicate name or other
error), it is skipped (i.e. no exception is
thrown).

SetTheme

Sets a theme name on an object.

ToString

(Inherited from
System.ComponentModel.Component)

UnregisterTheme

Unregisters the theme with a specified

name.
This method does nothing if a matching
theme could not be found.
An exception is thrown if the specified
theme is currently in use.

Top

Public Events
Name

Description

ApplicationThemeChanged Occurs after a new value has been assigned to the

ApplicationTheme property.
ApplicationThemeChanging Occurs before a new value is assigned to the
ApplicationTheme property.
Disposed

(Inherited from System.ComponentModel.Component)

ObjectThemeApplied

Occurs after a theme has been applied to an object managed

by the current theme controller.
See remarks for details.

ObjectThemeApplying

Occurs when a theme is about to be applied to an object

managed by the current theme controller.

See remarks in ObjectThemeApplied for details.

ObjectThemeChanged

Occurs after a theme on an object managed by the current

theme controller has been changed.
See remarks in ObjectThemeApplied for details.

ObjectThemeChanging

Occurs when a theme on an object managed by the current

theme controller is about to be changed.
See remarks in ObjectThemeApplied for details.

ThemeChanged

Occurs after a new value has been assigned to the Theme

property.

ThemeChanging

Occurs before a new value is assigned to the Theme

property.

Top

See Also
Reference
C1ThemeController Class
C1.Win.C1Themes Namespace

C1ThemeController Constructor
C1.Win.C1Themes.4 Assembly > C1.Win.C1Themes Namespace > C1ThemeController Class :
C1ThemeController Constructor

Initializes a new instance of the C1ThemeController class.

Syntax
Visual Basic (Declaration)

Public Function New()

C#
public C1ThemeController()

See Also
Reference
C1ThemeController Class
C1ThemeController Members

Methods
C1.Win.C1Themes.4 Assembly > C1.Win.C1Themes Namespace : C1ThemeController Class

For a list of all members of this type, see C1ThemeController members.

Public Methods
Name

Description

ApplyThemeToControlTree

Recursively applies a theme to a control

and its children. Controls that do not
support themes are ignored (but the
theme is applied to their children).

ApplyThemeToObject

Applies a theme to an object.

The target object must be either a C1
control supporting themes, or a standard
control (such as Button, Label etc) for
which basic theming is provided by this
library.

CreateObjRef

(Inherited from
System.MarshalByRefObject)

Dispose

(Inherited from
System.ComponentModel.Component)

GetLifetimeService

(Inherited from
System.MarshalByRefObject)

GetTheme

Gets the name of a theme set on an

object by this theme controller.

GetThemeByName

Retrieves a theme registered with the

application, by its name.

GetThemes

Retrieves the names of all themes

registered with the application.

InitializeLifetimeService

(Inherited from
System.MarshalByRefObject)

IsObjectThemeable

Checks whether an object supports

ComponentOne themes.

IsPreviewControlInsideC1PrintPreviewControl
IsThemeRegistered

Checks whether a theme with a specified

name has been registered.

RegisterTheme

Overloaded. Loads a theme from a

stream, and registeres it for use by theme
controllers in the application.
After this method completes, the theme
can be set via ApplicationTheme and
Theme properties.
his method throws an exception if a
theme with same name has already been
registered.

RegisterThemes

Loads all themes from an assembly, and

registeres them for use by theme

controllers in the current application.

This method scans all resources in the
specified assembly, and selects those with
names ending in ".c1theme" (case
insensitive). If a theme cannot be loaded
(e.g. due to a duplicate name or other
error), it is skipped (i.e. no exception is
thrown).

SetTheme

Sets a theme name on an object.

ToString

(Inherited from
System.ComponentModel.Component)

UnregisterTheme

Unregisters the theme with a specified

name.
This method does nothing if a matching
theme could not be found.
An exception is thrown if the specified
theme is currently in use.

Top

See Also
Reference
C1ThemeController Class
C1.Win.C1Themes Namespace

ApplyThemeToControlTree Method
C1.Win.C1Themes.4 Assembly > C1.Win.C1Themes Namespace > C1ThemeController Class :
ApplyThemeToControlTree Method

The root control to apply the theme to.

The theme to apply.

Predicate which, if specified, allows to break theme application on certain nodes in the tree if it
returns false.
Recursively applies a theme to a control and its children. Controls that do not support themes
are ignored (but the theme is applied to their children).

Syntax
Visual Basic (Declaration)
Public Shared Sub ApplyThemeToControlTree( _
ByVal root As System.Windows.Forms.Control, _
ByVal theme As C1Theme, _
Optional ByVal applyThemeToSubTree As System.Predicate(Of Control) _
)
C#
public static void ApplyThemeToControlTree(
System.Windows.Forms.Control root,
C1Theme theme,
System.Predicate<Control> applyThemeToSubTree
)

Parameters
root
The root control to apply the theme to.
theme
The theme to apply.
applyThemeToSubTree
Predicate which, if specified, allows to break theme application on certain nodes in the
tree if it returns false.

See Also
Reference
C1ThemeController Class
C1ThemeController Members

ApplyThemeToObject Method
C1.Win.C1Themes.4 Assembly > C1.Win.C1Themes Namespace > C1ThemeController Class :

ApplyThemeToObject Method

The object to apply the theme to.

The theme to apply.
Applies a theme to an object.
The target object must be either a C1 control supporting themes, or a standard control (such as
Button, Label etc) for which basic theming is provided by this library.

Syntax
Visual Basic (Declaration)
Public Shared Function ApplyThemeToObject( _
ByVal obj As System.Object, _
ByVal theme As C1Theme _
) As System.Boolean
C#
public static System.bool ApplyThemeToObject(
System.object obj,
C1Theme theme
)

Parameters
obj
The object to apply the theme to.
theme
The theme to apply.

Return Value
True of the theme was successfully applied, false otherwise (i.e. if the object does not
support theming).

See Also
Reference
C1ThemeController Class
C1ThemeController Members

GetTheme Method
C1.Win.C1Themes.4 Assembly > C1.Win.C1Themes Namespace > C1ThemeController Class : GetTheme
Method

The object to get the theme name for.

Gets the name of a theme set on an object by this theme controller.

Syntax
Visual Basic (Declaration)
Public Function GetTheme( _
ByVal control As System.Object _
) As System.String
C#
public System.string GetTheme(
System.object control
)

Parameters
control
The object to get the theme name for.

Return Value
The name of the theme set on the object. The "(none)" string is returned if no theme was
set on the object.

See Also
Reference
C1ThemeController Class
C1ThemeController Members

GetThemeByName Method
C1.Win.C1Themes.4 Assembly > C1.Win.C1Themes Namespace > C1ThemeController Class :
GetThemeByName Method

The name of the theme to get.

Indicates whether an exception should be thrown if the specified theme cannot be found.
Retrieves a theme registered with the application, by its name.

Syntax
Visual Basic (Declaration)
Public Shared Function GetThemeByName( _
ByVal themeName As System.String, _
ByVal throwException As System.Boolean _
) As C1Theme
C#
public static C1Theme GetThemeByName(
System.string themeName,
System.bool throwException
)

Parameters
themeName
The name of the theme to get.
throwException
Indicates whether an exception should be thrown if the specified theme cannot be
found.

Return Value
The theme with the specified name, or null if a matching theme could not be found
while throwException is false.

See Also
Reference
C1ThemeController Class
C1ThemeController Members

GetThemes Method
C1.Win.C1Themes.4 Assembly > C1.Win.C1Themes Namespace > C1ThemeController Class : GetThemes
Method

Retrieves the names of all themes registered with the application.

Syntax

Visual Basic (Declaration)

Public Shared Function GetThemes() As System.String()
C#
public static System.string[] GetThemes()

Return Value
An array of strings containing names of all registered themes.

See Also
Reference
C1ThemeController Class
C1ThemeController Members

IsObjectThemeable Method
C1.Win.C1Themes.4 Assembly > C1.Win.C1Themes Namespace > C1ThemeController Class :
IsObjectThemeable Method

The object to check.

Checks whether an object supports ComponentOne themes.

Syntax
Visual Basic (Declaration)
Public Shared Function IsObjectThemeable( _
ByVal obj As System.Object _
) As System.Boolean
C#
public static System.bool IsObjectThemeable(
System.object obj
)

Parameters
obj
The object to check.

Return Value

True if the object supports themes, false otherwise.

See Also
Reference
C1ThemeController Class
C1ThemeController Members

IsPreviewControlInsideC1PrintPreviewControl Method
C1.Win.C1Themes.4 Assembly > C1.Win.C1Themes Namespace > C1ThemeController Class :
IsPreviewControlInsideC1PrintPreviewControl Method

Syntax
Visual Basic (Declaration)
Public Shared Function IsPreviewControlInsideC1PrintPreviewControl( _
ByVal obj As System.Object _
) As System.Boolean
C#
public static System.bool IsPreviewControlInsideC1PrintPreviewControl(
System.object obj
)

Parameters
obj

See Also
Reference
C1ThemeController Class
C1ThemeController Members

IsThemeRegistered Method
C1.Win.C1Themes.4 Assembly > C1.Win.C1Themes Namespace > C1ThemeController Class :
IsThemeRegistered Method

The name of the theme to check.

Checks whether a theme with a specified name has been registered.

Syntax

Visual Basic (Declaration)

Public Shared Function IsThemeRegistered( _
ByVal themeName As System.String _
) As System.Boolean
C#
public static System.bool IsThemeRegistered(
System.string themeName
)

Parameters
themeName
The name of the theme to check.

Return Value
True if the theme has been registered, false otherwise.

See Also
Reference
C1ThemeController Class
C1ThemeController Members

RegisterTheme Method
C1.Win.C1Themes.4 Assembly > C1.Win.C1Themes Namespace > C1ThemeController Class :
RegisterTheme Method

Loads a theme from a stream, and registeres it for use by theme controllers in the application.
After this method completes, the theme can be set via ApplicationTheme and Theme properties.
his method throws an exception if a theme with same name has already been registered.

Overload List
Overload

Description

RegisterTheme(Stream,C1ThemeFormat) Loads a theme from a stream, and registeres it for use

by theme controllers in the application.
After this method completes, the theme can be set via

ApplicationTheme and Theme properties.

his method throws an exception if a theme with same
name has already been registered.

RegisterTheme(Stream)

Loads a theme from a stream, and registeres it for use

by theme controllers in the application.
After this method completes, the theme can be set via
ApplicationTheme and Theme properties.
his method throws an exception if a theme with same
name has already been registered.

RegisterTheme(String)

Loads a theme from a file, and registeres it for use by

theme controllers in the application.
After this method completes, the theme can be set via
ApplicationTheme and Theme properties.
his method throws an exception if a theme with same
name has already been registered.

See Also
Reference
C1ThemeController Class
C1ThemeController Members

RegisterTheme(Stream,C1ThemeFormat) Method
C1.Win.C1Themes.4 Assembly > C1.Win.C1Themes Namespace > C1ThemeController Class >
RegisterTheme Method : RegisterTheme(Stream,C1ThemeFormat) Method

A stream containing the theme to load/register.

The theme persitence format to use.
Loads a theme from a stream, and registeres it for use by theme controllers in the application.

After this method completes, the theme can be set via ApplicationTheme and Theme properties.
his method throws an exception if a theme with same name has already been registered.

Syntax
Visual Basic (Declaration)
Public Overloads Shared Function RegisterTheme( _
ByVal stream As System.IO.Stream, _
ByVal format As C1ThemeFormat _
) As System.String
C#
public static System.string RegisterTheme(
System.IO.Stream stream,
C1ThemeFormat format
)

Parameters
stream
A stream containing the theme to load/register.
format
The theme persitence format to use.

Return Value
A name of registered theme.

See Also
Reference
C1ThemeController Class
C1ThemeController Members
Overload List

RegisterTheme(Stream) Method
C1.Win.C1Themes.4 Assembly > C1.Win.C1Themes Namespace > C1ThemeController Class >
RegisterTheme Method : RegisterTheme(Stream) Method

A stream containing the theme to load/register.

Loads a theme from a stream, and registeres it for use by theme controllers in the application.

After this method completes, the theme can be set via ApplicationTheme and Theme properties.
his method throws an exception if a theme with same name has already been registered.

Syntax
Visual Basic (Declaration)
Public Overloads Shared Function RegisterTheme( _
ByVal stream As System.IO.Stream _
) As System.String
C#
public static System.string RegisterTheme(
System.IO.Stream stream
)

Parameters
stream
A stream containing the theme to load/register.

Return Value
A name of registered theme.

See Also
Reference
C1ThemeController Class
C1ThemeController Members
Overload List

RegisterTheme(String) Method
C1.Win.C1Themes.4 Assembly > C1.Win.C1Themes Namespace > C1ThemeController Class >
RegisterTheme Method : RegisterTheme(String) Method

The file containing the theme to load/register.

Loads a theme from a file, and registeres it for use by theme controllers in the application.
After this method completes, the theme can be set via ApplicationTheme and Theme properties.
his method throws an exception if a theme with same name has already been registered.

Syntax

Visual Basic (Declaration)

Public Overloads Shared Function RegisterTheme( _
ByVal fileName As System.String _
) As System.String
C#
public static System.string RegisterTheme(
System.string fileName
)

Parameters
fileName
The file containing the theme to load/register.

Return Value
A name of registered theme.

See Also
Reference
C1ThemeController Class
C1ThemeController Members
Overload List

RegisterThemes Method
C1.Win.C1Themes.4 Assembly > C1.Win.C1Themes Namespace > C1ThemeController Class :
RegisterThemes Method

The assembly to load/register themes from.

Loads all themes from an assembly, and registeres them for use by theme controllers in the
current application.
This method scans all resources in the specified assembly, and selects those with names ending
in ".c1theme" (case insensitive). If a theme cannot be loaded (e.g. due to a duplicate name or
other error), it is skipped (i.e. no exception is thrown).

Syntax
Visual Basic (Declaration)
Public Shared Function RegisterThemes( _

ByVal assembly As System.Reflection.Assembly _

) As System.String()
C#
public static System.string[] RegisterThemes(
System.Reflection.Assembly assembly
)

Parameters
assembly
The assembly to load/register themes from.

Return Value
The array of names of all loaded/registered themes.

See Also
Reference
C1ThemeController Class
C1ThemeController Members

SetTheme Method
C1.Win.C1Themes.4 Assembly > C1.Win.C1Themes Namespace > C1ThemeController Class : SetTheme
Method

The object on which to set the theme name.

The name of the theme.
Sets a theme name on an object.

Syntax
Visual Basic (Declaration)
Public Sub SetTheme( _
ByVal control As System.Object, _
ByVal value As System.String _
)
C#
public void SetTheme(

System.object control,
System.string value
)

Parameters
control
The object on which to set the theme name.
value
The name of the theme.

See Also
Reference
C1ThemeController Class
C1ThemeController Members

UnregisterTheme Method
C1.Win.C1Themes.4 Assembly > C1.Win.C1Themes Namespace > C1ThemeController Class :
UnregisterTheme Method

The name of the theme to unregister.

Unregisters the theme with a specified name.
This method does nothing if a matching theme could not be found.
An exception is thrown if the specified theme is currently in use.

Syntax
Visual Basic (Declaration)
Public Shared Sub UnregisterTheme( _
ByVal themeName As System.String _
)
C#
public static void UnregisterTheme(
System.string themeName
)

Parameters

themeName
The name of the theme to unregister.

See Also
Reference
C1ThemeController Class
C1ThemeController Members

Properties
C1.Win.C1Themes.4 Assembly > C1.Win.C1Themes Namespace : C1ThemeController Class

For a list of all members of this type, see C1ThemeController members.

Public Properties
Name

Description

ApplicationTheme Gets or sets the application-wide default theme name.

All theme controllers which have "(default)" set as Theme property
value will use this theme.
This name is persisted with key "C1ApplicationTheme" in the
application config file (app.config).

Container

(Inherited from System.ComponentModel.Component)

Site

(Inherited from System.ComponentModel.Component)

Theme

Gets or sets the name of the default theme for all objects on the
form or user control managed by the current theme controller.

Top

See Also
Reference
C1ThemeController Class
C1.Win.C1Themes Namespace

ApplicationTheme Property
C1.Win.C1Themes.4 Assembly > C1.Win.C1Themes Namespace > C1ThemeController Class :
ApplicationTheme Property

Gets or sets the application-wide default theme name.

All theme controllers which have "(default)" set as Theme property value will use this theme.
This name is persisted with key "C1ApplicationTheme" in the application config file (app.config).

Syntax
Visual Basic (Declaration)
Public Shared Property ApplicationTheme As System.String
C#
public static System.string ApplicationTheme {get; set;}

See Also
Reference
C1ThemeController Class
C1ThemeController Members

Theme Property
C1.Win.C1Themes.4 Assembly > C1.Win.C1Themes Namespace > C1ThemeController Class : Theme
Property

Gets or sets the name of the default theme for all objects on the form or user control managed
by the current theme controller.

Syntax
Visual Basic (Declaration)
Public Property Theme As System.String
C#
public System.string Theme {get; set;}

See Also
Reference

C1ThemeController Class
C1ThemeController Members

Fields
C1.Win.C1Themes.4 Assembly > C1.Win.C1Themes Namespace : C1ThemeController Class

For a list of all members of this type, see C1ThemeController members.

Public Fields
Name

Description

DefaultThemeName The default theme name id.

When assigned to the Theme property of a theme controller, indicates
that it should use the default application theme.

NoTheme

The empty theme name id.

When assigned to the "Theme" extender property (provided by
C1ThemeController) on a control, indicates that no theme should be
applied to that control by the theme controller.

Top

See Also
Reference
C1ThemeController Class
C1.Win.C1Themes Namespace

DefaultThemeName Field
C1.Win.C1Themes.4 Assembly > C1.Win.C1Themes Namespace > C1ThemeController Class :
DefaultThemeName Field

The default theme name id.

When assigned to the Theme property of a theme controller, indicates that it should use the
default application theme.

Syntax

Visual Basic (Declaration)

Public Const DefaultThemeName As System.String
C#
public const System.string DefaultThemeName

See Also
Reference
C1ThemeController Class
C1ThemeController Members

NoTheme Field
C1.Win.C1Themes.4 Assembly > C1.Win.C1Themes Namespace > C1ThemeController Class : NoTheme
Field

The empty theme name id.

When assigned to the "Theme" extender property (provided by C1ThemeController) on a
control, indicates that no theme should be applied to that control by the theme controller.

Syntax
Visual Basic (Declaration)
Public Const NoTheme As System.String
C#
public const System.string NoTheme

See Also
Reference
C1ThemeController Class
C1ThemeController Members

Events
C1.Win.C1Themes.4 Assembly > C1.Win.C1Themes Namespace : C1ThemeController Class

For a list of all members of this type, see C1ThemeController members.

Public Events

Name

Description

ApplicationThemeChanged Occurs after a new value has been assigned to the

ApplicationTheme property.
ApplicationThemeChanging Occurs before a new value is assigned to the
ApplicationTheme property.
Disposed

(Inherited from System.ComponentModel.Component)

ObjectThemeApplied

Occurs after a theme has been applied to an object managed

by the current theme controller.
See remarks for details.

ObjectThemeApplying

Occurs when a theme is about to be applied to an object

managed by the current theme controller.
See remarks in ObjectThemeApplied for details.

ObjectThemeChanged

Occurs after a theme on an object managed by the current

theme controller has been changed.
See remarks in ObjectThemeApplied for details.

ObjectThemeChanging

Occurs when a theme on an object managed by the current

theme controller is about to be changed.
See remarks in ObjectThemeApplied for details.

ThemeChanged

Occurs after a new value has been assigned to the Theme

property.

ThemeChanging

Occurs before a new value is assigned to the Theme

property.

Top

See Also
Reference
C1ThemeController Class
C1.Win.C1Themes Namespace

ApplicationThemeChanged Event
C1.Win.C1Themes.4 Assembly > C1.Win.C1Themes Namespace > C1ThemeController Class :
ApplicationThemeChanged Event

Occurs after a new value has been assigned to the ApplicationTheme property.

Syntax
Visual Basic (Declaration)
Public Event ApplicationThemeChanged As ApplicationThemeEventHandler
C#
public event ApplicationThemeEventHandler ApplicationThemeChanged

See Also
Reference
C1ThemeController Class
C1ThemeController Members
ApplicationThemeChanging Event

ApplicationThemeChanging Event
C1.Win.C1Themes.4 Assembly > C1.Win.C1Themes Namespace > C1ThemeController Class :
ApplicationThemeChanging Event

Occurs before a new value is assigned to the ApplicationTheme property.

Syntax
Visual Basic (Declaration)

Public Event ApplicationThemeChanging As ApplicationThemeEventHandler

C#
public event ApplicationThemeEventHandler ApplicationThemeChanging

See Also
Reference
C1ThemeController Class
C1ThemeController Members
ApplicationThemeChanged Event

ObjectThemeApplied Event
C1.Win.C1Themes.4 Assembly > C1.Win.C1Themes Namespace > C1ThemeController Class :
ObjectThemeApplied Event

Occurs after a theme has been applied to an object managed by the current theme controller.
See remarks for details.

Syntax
Visual Basic (Declaration)
Public Event ObjectThemeApplied As ObjectThemeEventHandler
C#
public event ObjectThemeEventHandler ObjectThemeApplied

Remarks
The ObjectThemeChanging and ObjectThemeChanged events occur when the value of the
Theme extender property on an object changes. The ObjectThemeApplying and
ObjectThemeApplied events occur when a new theme is applied to the object - which may
happen even without changing the Theme property on the object. For instance, if the object
uses the default theme specified for the containing form, and the form's theme is changed the
Applying/Applied events on the object will fire but the Changing/Changed events will not.

See Also
Reference
C1ThemeController Class
C1ThemeController Members
ObjectThemeChanging Event

ObjectThemeChanged Event
ObjectThemeApplying Event

ObjectThemeApplying Event
C1.Win.C1Themes.4 Assembly > C1.Win.C1Themes Namespace > C1ThemeController Class :
ObjectThemeApplying Event

Occurs when a theme is about to be applied to an object managed by the current theme
controller.
See remarks in ObjectThemeApplied for details.

Syntax
Visual Basic (Declaration)
Public Event ObjectThemeApplying As ObjectThemeEventHandler
C#
public event ObjectThemeEventHandler ObjectThemeApplying

See Also
Reference
C1ThemeController Class
C1ThemeController Members
ObjectThemeChanging Event
ObjectThemeChanged Event
ObjectThemeApplied Event

ObjectThemeChanged Event
C1.Win.C1Themes.4 Assembly > C1.Win.C1Themes Namespace > C1ThemeController Class :
ObjectThemeChanged Event

Occurs after a theme on an object managed by the current theme controller has been changed.
See remarks in ObjectThemeApplied for details.

Syntax
Visual Basic (Declaration)
Public Event ObjectThemeChanged As ObjectThemeEventHandler
C#

public event ObjectThemeEventHandler ObjectThemeChanged

See Also
Reference
C1ThemeController Class
C1ThemeController Members
ObjectThemeChanging Event
ObjectThemeApplying Event
ObjectThemeApplied Event

ObjectThemeChanging Event
C1.Win.C1Themes.4 Assembly > C1.Win.C1Themes Namespace > C1ThemeController Class :
ObjectThemeChanging Event

Occurs when a theme on an object managed by the current theme controller is about to be
changed.
See remarks in ObjectThemeApplied for details.

Syntax
Visual Basic (Declaration)
Public Event ObjectThemeChanging As ObjectThemeEventHandler
C#
public event ObjectThemeEventHandler ObjectThemeChanging

See Also
Reference
C1ThemeController Class
C1ThemeController Members
ObjectThemeChanged Event
ObjectThemeApplying Event
ObjectThemeApplied Event

ThemeChanged Event
C1.Win.C1Themes.4 Assembly > C1.Win.C1Themes Namespace > C1ThemeController Class :
ThemeChanged Event

Occurs after a new value has been assigned to the Theme property.

Syntax

Visual Basic (Declaration)

Public Event ThemeChanged As ThemeEventHandler
C#
public event ThemeEventHandler ThemeChanged

See Also
Reference
C1ThemeController Class
C1ThemeController Members
ThemeChanging Event

ThemeChanging Event
C1.Win.C1Themes.4 Assembly > C1.Win.C1Themes Namespace > C1ThemeController Class :
ThemeChanging Event

Occurs before a new value is assigned to the Theme property.

Syntax
Visual Basic (Declaration)
Public Event ThemeChanging As ThemeEventHandler
C#
public event ThemeEventHandler ThemeChanging

See Also
Reference
C1ThemeController Class
C1ThemeController Members
ThemeChanged Event

C1ThemeVersion
Members
C1.Win.C1Themes.4 Assembly > C1.Win.C1Themes Namespace : C1ThemeVersion Class

Represents theme XML format's, and theme assembly's version info.

Object Model

Syntax
Visual Basic (Declaration)
Public Class C1ThemeVersion
C#
public class C1ThemeVersion

Inheritance Hierarchy
System.Object
C1.Win.C1Themes.C1ThemeVersion

See Also
Reference
C1ThemeVersion Members
C1.Win.C1Themes Namespace

Overview
Members
C1.Win.C1Themes.4 Assembly > C1.Win.C1Themes Namespace : C1ThemeVersion Class

Represents theme XML format's, and theme assembly's version info.

Object Model

Syntax
Visual Basic (Declaration)
Public Class C1ThemeVersion
C#
public class C1ThemeVersion

Inheritance Hierarchy

System.Object
C1.Win.C1Themes.C1ThemeVersion

See Also
Reference
C1ThemeVersion Members
C1.Win.C1Themes Namespace

Members
Properties Methods
C1.Win.C1Themes.4 Assembly > C1.Win.C1Themes Namespace : C1ThemeVersion Class

The following tables list the members exposed by C1ThemeVersion.

Public Constructors
Name

Description

C1ThemeVersion Constructor Overloaded.

Top

Public Properties
Name

Description

AssemblyVersion Gets the C1.Win.C1Themes assembly version.

FormatVersion

Gets the theme XML format version.

Top

Public Methods

Top

Name

Description

Parse

Converts a string to a C1ThemeVersion object.

ToString

Overridden. Returns a string that represents the current object.

See Also
Reference
C1ThemeVersion Class
C1.Win.C1Themes Namespace

C1ThemeVersion Constructor
C1.Win.C1Themes.4 Assembly > C1.Win.C1Themes Namespace > C1ThemeVersion Class :
C1ThemeVersion Constructor

Overload List
Overload

Description

C1ThemeVersion Constructor()

Initializes a new instance of the

C1ThemeVersion class.

C1ThemeVersion Constructor(String,String)

Initializes a new instance of the

C1ThemeVersion class with the specified theme
XML format and theme assembly versions.

C1ThemeVersion Constructor(Version,Version) Initializes a new instance of the

C1ThemeVersion class with the specified theme
XML format and theme assembly versions.

See Also
Reference
C1ThemeVersion Class
C1ThemeVersion Members

C1ThemeVersion Constructor()
C1.Win.C1Themes.4 Assembly > C1.Win.C1Themes Namespace > C1ThemeVersion Class >
C1ThemeVersion Constructor : C1ThemeVersion Constructor()

Initializes a new instance of the C1ThemeVersion class.

Syntax
Visual Basic (Declaration)

Public Function New()

C#
public C1ThemeVersion()

See Also
Reference
C1ThemeVersion Class
C1ThemeVersion Members
Overload List

C1ThemeVersion Constructor(String,String)
C1.Win.C1Themes.4 Assembly > C1.Win.C1Themes Namespace > C1ThemeVersion Class >
C1ThemeVersion Constructor : C1ThemeVersion Constructor(String,String)

The theme XML format version.

The C1.Win.C1Themes assembly version.
Initializes a new instance of the C1ThemeVersion class with the specified theme XML format and
theme assembly versions.

Syntax
Visual Basic (Declaration)
Public Function New( _
ByVal formatVersion As System.String, _
ByVal assemblyVersion As System.String _
)
C#
public C1ThemeVersion(
System.string formatVersion,
System.string assemblyVersion
)

Parameters
formatVersion
The theme XML format version.
assemblyVersion

The C1.Win.C1Themes assembly version.

See Also
Reference
C1ThemeVersion Class
C1ThemeVersion Members
Overload List

C1ThemeVersion Constructor(Version,Version)
C1.Win.C1Themes.4 Assembly > C1.Win.C1Themes Namespace > C1ThemeVersion Class >
C1ThemeVersion Constructor : C1ThemeVersion Constructor(Version,Version)

The theme XML format version.

The C1.Win.C1Themes assembly version.
Initializes a new instance of the C1ThemeVersion class with the specified theme XML format and
theme assembly versions.

Syntax
Visual Basic (Declaration)
Public Function New( _
ByVal formatVersion As System.Version, _
ByVal assemblyVersion As System.Version _
)
C#
public C1ThemeVersion(
System.Version formatVersion,
System.Version assemblyVersion
)

Parameters
formatVersion
The theme XML format version.
assemblyVersion
The C1.Win.C1Themes assembly version.

See Also

Reference
C1ThemeVersion Class
C1ThemeVersion Members
Overload List

Methods
C1.Win.C1Themes.4 Assembly > C1.Win.C1Themes Namespace : C1ThemeVersion Class

For a list of all members of this type, see C1ThemeVersion members.

Public Methods
Name

Description

Parse

Converts a string to a C1ThemeVersion object.

ToString

Overridden. Returns a string that represents the current object.

Top

See Also
Reference
C1ThemeVersion Class
C1.Win.C1Themes Namespace

Parse Method
C1.Win.C1Themes.4 Assembly > C1.Win.C1Themes Namespace > C1ThemeVersion Class : Parse Method

The string to convert.

Indicates whether an exception should be thrown if the specified string cannot be converted.
The default version (used if the version could not be parsed, and throwException is false).
Converts a string to a C1ThemeVersion object.

Syntax
Visual Basic (Declaration)
Public Shared Function Parse( _
ByVal s As System.String, _
ByVal throwException As System.Boolean, _

ByVal defaultValue As C1ThemeVersion _

) As C1ThemeVersion
C#
public static C1ThemeVersion Parse(
System.string s,
System.bool throwException,
C1ThemeVersion defaultValue
)

Parameters
s
The string to convert.
throwException
Indicates whether an exception should be thrown if the specified string cannot be
converted.
defaultValue
The default version (used if the version could not be parsed, and throwException is
false).

Return Value
The newly created instance of C1ThemeVersion type, or null.

See Also
Reference
C1ThemeVersion Class
C1ThemeVersion Members

ToString Method
C1.Win.C1Themes.4 Assembly > C1.Win.C1Themes Namespace > C1ThemeVersion Class : ToString
Method

Overridden. Returns a string that represents the current object.

Syntax
Visual Basic (Declaration)

Public Overrides Function ToString() As System.String

C#
public override System.string ToString()

See Also
Reference
C1ThemeVersion Class
C1ThemeVersion Members

Properties
C1.Win.C1Themes.4 Assembly > C1.Win.C1Themes Namespace : C1ThemeVersion Class

For a list of all members of this type, see C1ThemeVersion members.

Public Properties
Name

Description

AssemblyVersion Gets the C1.Win.C1Themes assembly version.

FormatVersion

Gets the theme XML format version.

Top

See Also
Reference
C1ThemeVersion Class
C1.Win.C1Themes Namespace

AssemblyVersion Property
C1.Win.C1Themes.4 Assembly > C1.Win.C1Themes Namespace > C1ThemeVersion Class :
AssemblyVersion Property

Gets the C1.Win.C1Themes assembly version.

Syntax
Visual Basic (Declaration)
Public ReadOnly Property AssemblyVersion As System.Version

C#
public System.Version AssemblyVersion {get;}

See Also
Reference
C1ThemeVersion Class
C1ThemeVersion Members

FormatVersion Property
C1.Win.C1Themes.4 Assembly > C1.Win.C1Themes Namespace > C1ThemeVersion Class : FormatVersion
Property

Gets the theme XML format version.

Syntax
Visual Basic (Declaration)
Public ReadOnly Property FormatVersion As System.Version
C#
public System.Version FormatVersion {get;}

See Also
Reference
C1ThemeVersion Class
C1ThemeVersion Members