RadToolbar.Net2
Utility class for Design - Time VisualStudio.NET project management.
Defines the common property categories' names
Gets the component's current version.
Gets or sets a value indicating whether to use the embedded JavaScript files or not.
True if embedded JavaScript files are to be used; otherwise
false. The default value is true.
Use this property for debugging purposes or to apply any modifications to the
JavaScript files.
The default contructor for RadToolBar
Searches the current naming container for a server control with the specified
id parameter
Gets or sets a value indicating whether validation is performed when the
RadToolbar control postbacks to the server.
By default, page validation is performed when a RadToolbar control is
clicked. Page validation determines whether the input controls associated with a
validation control on the page all pass the validation rules specified by the
validation control.
You can specify or determine whether validation is performed on both the
client and the server when a RadToolbar control is clicked by using the
CausesValidation property. To prevent validation from being performed, set the
CausesValidation property to false.
This property is commonly set to false for a reset or clear RadToolbar to
prevent validation from being performed when the RadToolbar is clicked.
When the value of the CausesValidation property is set to true, you can also
use the ValidationGroup property to specify the name of the validation group for
which the RadToolbar control causes validation.
Specifies an override location for the toolbar button images. By default
RadToolbar looks for the image files inside its
selected skin images folder. Using this property you can set a new location for the
files that is independent of the skins.
If this property is left blank the default location for the button images will be
inside the skin folder.
Default: string.Empty
Specifies wether to use a fading mouseover effect for the buttons (IE Only).
Only supported on Internet Explorer for windows.
Default: False
Microsoft Internet Explorer v5.5 or later.
Specifies wether to display skin specific ends for the toolbar.
Useful when integrating RadToolBar with RadDock
Boolean.
Gets or sets the relative path of the folder containing the skins.
If the skin folder is located in the project root and is named "Skins" the
SkinsPath property should be set to: "~/Skins". Then you can create subfolders for
individual skins e.g. Skins/Gold, Skins/Classic etc.
A string specifying the relative path to the folder which contains
RadToolBar skins. The default value is
"~/RadControls/toolbar/Skins".
RadToolBar ships with a set of predefined skins which are ready
to use. They are located in RadControls/toolbar/Skins.
The location (path + filename) of the XML content file used to populate the menu.
Default: string.Empty
This is an example content file.
<?xml version="1.0" encoding="utf-8" ?>
<radToolbar>
<Button ToolTip="New Document" CommandName="new" AutoPostBack="False" ButtonImage="new.gif" DisplayType="ImageOnly" />
<Button ToolTip="Open Document" CommandName="Open" AutoPostBack="False" ButtonImage="Open.gif" DisplayType="ImageOnly" />
<Button ToolTip="Save Document" CommandName="Save" AutoPostBack="False" ButtonImage="Save.gif" DisplayType="ImageOnly" />
<Separator />
<ToggleButton CommandName="toggle" AutoPostBack="False" DisplayType="TextOnly" Enabled="True" Width="90px" Toggled="True" ButtonText="toggle button" Visible="True" />
</radToolbar>
RadToolbarButton class is serilized to a <Button> element.
RadToolbarToggleButton is serialized to a <ToggleButton>
element.
Separators are serialized as <Separator>.
Specifies the data source to be used during data binding.
Here is an example code used to create a datasource and bind a
RadToolbar instance to it.
DataTable dt = new DataTable();
dt.Columns.Add("CommandName");
dt.Columns.Add("ToolTip");
dt.Columns.Add("ButtonImage");
DataRow dr = dt.NewRow();
dr["CommandName"] = "new";
dr["ToolTip"] = "New Document";
dr["ButtonImage"] = "new.gif";
dt.Rows.Add(dr);
DataRow dr1 = dt.NewRow();
dr1["CommandName"] = "open";
dr1["ToolTip"] = "Open Document";
dr1["ButtonImage"] = "open.gif";
dt.Rows.Add(dr1);
DataRow dr2 = dt.NewRow();
dr2["CommandName"] = "save";
dr2["ToolTip"] = "Save Document";
dr2["ButtonImage"] = "save.gif";
dt.Rows.Add(dr2);
toolbar1.DataSource = dt;
toolbar1.DataBind();
Dim dt As New DataTable
dt.Columns.Add("CommandName")
dt.Columns.Add("ToolTip")
dt.Columns.Add("ButtonImage")
Dim dr As DataRow = dt.NewRow()
dr("CommandName") = "new"
dr("ToolTip") = "New Document"
dr("ButtonImage") = "new.gif"
dt.Rows.Add(dr)
Dim dr1 As DataRow = dt.NewRow()
dr1("CommandName") = "open"
dr1("ToolTip") = "Open Document"
dr1("ButtonImage") = "open.gif"
dt.Rows.Add(dr1)
Dim dr2 As DataRow = dt.NewRow()
dr2("CommandName") = "save"
dr2("ToolTip") = "Save Document"
dr2("ButtonImage") = "save.gif"
dt.Rows.Add(dr2)
toolbar1.DataSource = dt
toolbar1.DataBind()
To bind a data source to a RadToolbar, you must
first use the control's DataBind method to ensure data binding. The data source
can either be of type IEnumerable, or it can be of type IListSource. If the
data source is of type IListSource, you can use the
DataMember field to specify which member to
extract.
RadToolbar fully supports binding to collections,
tables and datasets. Simply make sure you populate your collection from your
data-source and set the DataSource property of
RadToolbar to the instance of the the collection
and call the DataBind() method. In addition, you can specify the
ButtonTextFiled,
ButtonCommandField or
ButtonImageField of the data-source using
the respective RadToolbar properties.
If databinding to a dataset, this field indicates the table to bind data to.
Default: string.Empty
This property is only used if the value of the DataSource property is of type
IListSource, rather than of type IEnumerable.
To bind a data source to a toolbar, you must first use the control's
DataBind method to ensure data binding. The data source can either be of type
IEnumerable, or it can be of type IListSource. If the data source is of type
IListSource, you can use the DataMember field to specify which member to
extract.
Specifies which key to use for shortcut combinations.
Keyboard shortcut combination = ShortcutKey+RadToolbarButton.AccessKey
Default: ShortcutKeyButton.Alt (Alt key)
Instructs what datafield to use for the ButtonText
property of buttons during databinding.
Setting this property will automatically databind the ButtonText property of .
If you need to bind other properties please, consume the event.
Default: string.Empty
DataSource Property
Instructs what datafield to use for the ButtonCommand
property of buttons during databinding.
Setting this property will automatically databind the ButtonCommand property of .
If you need to bind other properties please, consume the event.
string.Empty
DataSource Property
Instructs what datafield to use for the
ButtonImageField property of buttons during databinding.
Setting this property will automatically databind the ButtonImageField property of .
If you need to bind other properties please, consume the event.
string.Empty
DataSource Property
Set this property to TRUE if you wish to enable server side events that depend on
postacks. Currently the event is .
Default: False
Here you can see how to consume server side events in code-behind.
Private void InitializeComponent()
{
toolbar1.OnClick += New Telerik.WebControls.RadToolbar.OnClickDelegate(toolbar1_OnClick);
}
Private void toolbar1_OnClick(Object sender, Telerik.WebControls.RadToolbarClickEventArgs e)
{
String text = e.Button.CommandName;
If(e.Button Is RadToolbarToggleButton)
{
If(((RadToolbarToggleButton)e.Button).Toggled)
{
text += " Toggled ON.";
}
Else
{
text += " Toggled OFF.";
}
}
Else
{
text += " Clicked.";
}
label1.Text = text;
}
Private Sub toolbar1_OnClick(ByVal sender As Object, ByVal e As Telerik.WebControls.RadToolbarClickEventArgs) Handles toolbar1.OnClick
Dim [text] As String = e.Button.CommandName
If Typeof e.Button Is RadToolbarToggleButton Then
If CType(e.Button, RadToolbarToggleButton).Toggled Then
[text] += " Toggled ON."
Else
[text] += " Toggled OFF."
End If
Else
[text] += " Clicked."
End If
label1.Text = [text]
End Sub 'toolbar1_OnClick
Specifies the default height of all child buttons. Can be overriden
by setting the property.
Default: 24(px)
Specifies the default width of all child buttons. Can be overriden
by setting the property.
Default: 24(px)
Specifies the location of the skins directory.
Normally you would want to leave this to the default.
Default: ~/RadControls/Toolbar/Skins/
If you change the default location of the RadControls folder, the value of this
property is not updated automatically. You need to change its value manually.
Specifies the skin to use with .
Default: default
Specifies the orientation
Default: RadToolbarOrientation.Horizontal
Other possible values: RadToolbarOrientation.Vertical
RadToolbarOrientation Enumeration
Contains a collection of objects.
This example explains how to bind the toolbar in code-behind.
RadToolbarButton button_new = new RadToolbarButton();
button_new.CommandName = "new";
button_new.ButtonImage = "new.gif";
button_new.ToolTip = "New Document";
RadToolbarButton button_open = new RadToolbarButton();
button_open.CommandName = "open";
button_open.ButtonImage = "open.gif";
button_open.ToolTip = "Open Document";
RadToolbarButton button_save = new RadToolbarButton();
button_save.CommandName = "save";
button_save.ButtonImage = "save.gif";
button_save.ToolTip = "Save Document";
RadToolbarSeparator separator1 = new RadToolbarSeparator();
RadToolbarToggleButton toggle1 = new RadToolbarToggleButton();
toggle1.CommandName = "toggle";
toggle1.Toggled = true;
toggle1.DisplayType = RadToolbarButton.ButtonDisplayType.TextOnly;
toggle1.ButtonText = "toggle button";
toggle1.Width = Unit.Pixel(90);
toolbar1.Items.Add(button_new);
toolbar1.Items.Add(button_open);
toolbar1.Items.Add(button_save);
toolbar1.Items.Add(separator1);
toolbar1.Items.Add(toggle1);
Dim button_new As New RadToolbarButton
button_new.CommandName = "new"
button_new.ButtonImage = "new.gif"
button_new.ToolTip = "New Document"
Dim button_open As New RadToolbarButton
button_open.CommandName = "open"
button_open.ButtonImage = "open.gif"
button_open.ToolTip = "Open Document"
Dim button_save As New RadToolbarButton
button_save.CommandName = "save"
button_save.ButtonImage = "save.gif"
button_save.ToolTip = "Save Document"
Dim separator1 As New RadToolbarSeparator
Dim toggle1 As New RadToolbarToggleButton
toggle1.CommandName = "toggle"
toggle1.Toggled = True
toggle1.DisplayType = RadToolbarButton.ButtonDisplayType.TextOnly
toggle1.ButtonText = "toggle button"
toggle1.Width = Unit.Pixel(90)
toolbar1.Items.Add(button_new)
toolbar1.Items.Add(button_open)
toolbar1.Items.Add(button_save)
toolbar1.Items.Add(separator1)
toolbar1.Items.Add(toggle1)
Use the Add() and Insert() methods of the collection to add new items. See the
examples for more details.
RadToolbarItemCollection Class
Note: This property is new in the .NET Framework version
2.0.
Gets or sets the name of the validation group to which this validation
control belongs.
The name of the validation group to which this validation control belongs. The
default is an empty string (""), which indicates that this property is not set.
This property works only when CausesValidation
is set to true.
Gets or sets the URL of the page to post to from the current page when a tab
from the tabstrip is clicked.
The URL of the Web page to post to from the current page when a tab from the
tabstrip control is clicked. The default value is an empty string (""), which causes
the page to post back to itself.
This event fires whenever a button is clicked on the client.
Note that you need to set the AutoPostback property
to true.
Here you can see how to consume server side events in code-behind.
Private void InitializeComponent()
{
toolbar1.OnClick += New Telerik.WebControls.RadToolbar.OnClickDelegate(toolbar1_OnClick);
}
Private void toolbar1_OnClick(Object sender, Telerik.WebControls.RadToolbarClickEventArgs e)
{
String text = e.Button.CommandName;
If(e.Button Is RadToolbarToggleButton)
{
If(((RadToolbarToggleButton)e.Button).Toggled)
{
text += " Toggled ON.";
}
Else
{
text += " Toggled OFF.";
}
}
Else
{
text += " Clicked.";
}
label1.Text = text;
}
Private Sub toolbar1_OnClick(ByVal sender As Object, ByVal e As Telerik.WebControls.RadToolbarClickEventArgs) Handles toolbar1.OnClick
Dim [text] As String = e.Button.CommandName
If Typeof e.Button Is RadToolbarToggleButton Then
If CType(e.Button, RadToolbarToggleButton).Toggled Then
[text] += " Toggled ON."
Else
[text] += " Toggled OFF."
End If
Else
[text] += " Clicked."
End If
label1.Text = [text]
End Sub 'toolbar1_OnClick
Fires whenever a button is added to the Items collection of
the toolbar.
Note that you need to set the AutoPostback property
to true.
Here is an example how to handle the ItemAdded event.
private void toolbar1_ItemAdded(object sender, Telerik.WebControls.RadToolbarItemAddedEventArgs e)
{
RadToolbarItem item = e.Item;
Response.Write(item.ItemType.ToString());
}
Fires whenever a button is being databound. You can use this event to bind
additional properties to the dataitem provided.
Note that you need to set the AutoPostback property
to true.
Here you can see how to perform custom databinding with
RadToolbar. By default the control will automatically
databind the ButtonText,
ButtonImage and
CommandName properties of
RadToolbarButton using the
ButtonTextField,
ButtonCommandField and
ButtonImageField properties of
RadToolbar.
private void toolbar1_ItemDataBound(object sender, RadToolbarItemDataBoundEventArgs e)
{
e.Button.ToolTip = Convert.ToString(DataBinder.GetPropertyValue(e.DataItem, "ToolTip"));
}
Private Sub toolbar1_ItemDataBound(ByVal sender As Object, ByVal e As RadToolbarItemDataBoundEventArgs) Handles toolbar1.ItemDataBound
e.Button.ToolTip = Convert.ToString(DataBinder.GetPropertyValue(e.DataItem, "ToolTip"))
End Sub 'toolbar1_ItemDataBound
Gets or sets a brief phrase that summarizes what a control does, for use in
ToolTips and catalogs of WebPart controls.
Gets or sets the title of a WebPart control.
Gets a string that is concatenated with the
Title
property value to form a complete title for a
WebPart
control.
The Subtitle property is used to return a default subtitle string for
a WebPart control that is appended to the control's title in the title
bar.
If you provide a default value for the Subtitle property in a control
that implements the
IWebPart interface,
the Web Parts control set automatically appends it to the value of the Title
property of the control at run time.
Gets or sets the URL to an image used to represent a Web Parts control in the
control's own title bar.
The TitleIconImageUrl property provides a way to associate an icon
with a WebPart
control. The icon appears in the control's own title bar. For thematic consistency,
application developers might want to make this icon similar to the image that
represents the control in a catalog of Web Parts controls (the image referenced in
the
CatalogIconImageUrl
property).
As it is implemented in the Web Parts control set, the
TitleIconImageUrl property can be personalized by end users to change the
image or icon that appears in a control's title bar.
Gets or sets a URL to supplemental information about a
WebPart
control.
When you assign a URL to the TitleUrl property, the title of the
control becomes a link. The purpose of this property is to provide a convenient way
for end users to access additional information about a control. The additional
information could provide copyright data, contact data, details about the creator
of the control, or a summary of the control's purpose.
Gets or sets the URL to an image that represents a
WebPart control in a
catalog of controls.
Web Parts applications often provide a catalog (or list) of controls that
users can add to a page. The CatalogIconImageUrl property on a control
contains the URL to an image that represents the control when it appears in a
catalog.
An abstract base class for all toolbar items.
Use the property to determine the type of the item and make casts as
necessary.
Indicates the type of the toolbar item.
The default constructor for RadToolbarButton
Read only. Returns an instance to the holding the button.
Specifies a command name to be used for bubbling events. This is used in the CommandEventArgs parameter for the RaiseBubbleEvent.
If this value is left unchanged (i.e. string.Empty) the toolbar control will not fire a bubble event when this button is clicked.
Also, AutoPostBack property of must be set to True.
Default: string.Empty
Specifies a command argument to be used for bubbling events. This is used in the CommandEventArgs parameter for the RaiseBubbleEvent.
For bubbled events to work, AutoPostBack property of must be set to True.
Default: string.Empty
Specifies a command argument to be used for bubbling events. This is used in the CommandEventArgs parameter for the RaiseBubbleEvent.
For bubbled events to work, AutoPostBack property of must be set to True.
Default: string.Empty
ItemType Property
(Telerik.WebControls.RadToolbarItem)ItemType
Property
(Telerik.WebControls.RadToolbarItem)RadToolbarItemType
EnumerationThis property is used in databinding. You should not assign values
to it.
Specifies how the is rendered.
Default: ButtonDisplayType.ImageOnly
Specifies the tooltip text that is displayed when the user hovers the mouse
pointer over the button.
Default: string.Empty
Specifies the command name of the button.
The button command name is should be an unique one-word string
that describes the purpose of the button.
A button that does not have its CommandName property set will raise an exception.
Save, New, Open...
Default: string.Empty
Specifies the text to be displayed on the button.
Will only be displayed if the
property is set to or
.
Default: string.Empty
Specifies the image to be displayed on the button.
Will only be displayed if the
property is set to or
.
Default: string.Empty
Gets or sets the visibility of the button.
Default: False
Hidden buttons will still render to HTML, but will not be visible in the
browser.
Specifies whether the button can respond to user interaction in the browser.
Default: True
When a button is disabled it will not generate any client-side or server-side
events.
Specifies the width of the button. Pixels.
If left blank it will be filled in by the default
value specified in
Specifies the height of the button. Pixels.
If left blank it will be filled in by the default
value specified in
Inherited. Gets the type of the ToolbarItem.
Always returns RadToolbarItemType.Button for this
type.RadToolbar Class
Specifies how to display the button.
Button is displayed as text-only.
Button is displayed as an image.
Button is displayed as a combination of image and text.
Summary description for ToolbarClickEventArgs.
Contains a reference to the button clicked.
An enumeration of different toolbar item types.
Event arguments for the event.
Gets a reference to the item being added.
A strongly typed collection of RadToolbar items.
Adds an item to the list.
RadToolbarButton button_new = New RadToolbarButton();
button_new.CommandName = "new";
button_new.ButtonImage = "new.gif";
button_new.ToolTip = "New Document";
RadToolbarButton button_open = New RadToolbarButton();
button_open.CommandName = "open";
button_open.ButtonImage = "open.gif";
button_open.ToolTip = "Open Document";
RadToolbarButton button_save = New RadToolbarButton();
button_save.CommandName = "save";
button_save.ButtonImage = "save.gif";
button_save.ToolTip = "Save Document";
RadToolbarSeparator separator1 = New RadToolbarSeparator();
RadToolbarToggleButton toggle1 = New RadToolbarToggleButton();
toggle1.CommandName = "toggle";
toggle1.Toggled = True;
toggle1.DisplayType = RadToolbarButton.ButtonDisplayType.TextOnly;
toggle1.ButtonText = "toggle button";
toggle1.Width = Unit.Pixel(90);
toolbar1.Items.Add(button_new);
toolbar1.Items.Add(button_open);
toolbar1.Items.Add(button_save);
toolbar1.Items.Add(separator1);
toolbar1.Items.Add(toggle1);
Dim button_new As New RadToolbarButton
button_new.CommandName = "new"
button_new.ButtonImage = "new.gif"
button_new.ToolTip = "New Document"
Dim button_open As New RadToolbarButton
button_open.CommandName = "open"
button_open.ButtonImage = "open.gif"
button_open.ToolTip = "Open Document"
Dim button_save As New RadToolbarButton
button_save.CommandName = "save"
button_save.ButtonImage = "save.gif"
button_save.ToolTip = "Save Document"
Dim separator1 As New RadToolbarSeparator
Dim toggle1 As New RadToolbarToggleButton
toggle1.CommandName = "toggle"
toggle1.Toggled = True
toggle1.DisplayType = RadToolbarButton.ButtonDisplayType.TextOnly
toggle1.ButtonText = "toggle button"
toggle1.Width = Unit.Pixel(90)
toolbar1.Items.Add(button_new)
toolbar1.Items.Add(button_open)
toolbar1.Items.Add(button_save)
toolbar1.Items.Add(separator1)
toolbar1.Items.Add(toggle1)
Removes all items from the list.
Inserts an item to the List at the specified index
Removes all items from the list.
Returns a collection of all instances of
RadToolbarTemplateButton in the toolbar
Returns a collection of all instances of
RadToolbarButton and RadToolbarToggleButton in the toolbar
Returns a collection of all instances of
RadToolbarToggleButton in the toolbar
Returns a collection of all instances of
RadToolbarSeparator in the toolbar
Returns a collection of all items in the toolbar.
Indexer for the collection.
Returns a count of all the items in the toolbar.
Summary description for RadToolbarItemDataBoundEventArgs.
This object represents the dataitem currently being databound.
A reference to the button that is being databound.
Implements separator functionality for
Inherited. Gets the type of the ToolbarItem.
Always returns RadToolbarItemType.Separator for this type.
Summary description for RadToolbarTemplateButton.
Returns a reference to a child control by the specified ID.
The id of the control to find.
Gets or sets the template for the items in the
RadToolbarTemplateButton Class control
Inherited. Gets the type of the ToolbarItem.
Always returns RadToolbarItemType.TemplateButton for this type.
Implements the templating functionality for class
Implements toggle button functionality
If you specify a button group through the ButtonGroup
property, will make sure there is only one
ToggleButton in the toggled state for that group.
Specifies wether the button is in a toggled state.
Default: False
Sets or gets the button group associated with the toggle button.
Default: string.Empty
Inherited. Gets the type of the ToolbarItem.
Always returns RadToolbarItemType.ToggleButton for this type.