Class RadToolbarFormControl

Inheritance
System.Object
RadControl
RadNonClientUIControl
RadNCEnabledControl
RadToolbarFormControl
Inherited Members
Namespace: Telerik.WinControls.UI
Assembly: Telerik.WinControls.UI.dll

Syntax

public class RadToolbarFormControl : RadNCEnabledControl, INotifyPropertyChanged, ISupportInitializeNotification, ISupportInitialize, IComponentTreeHandler, ILayoutHandler, IPCHost, IAnalyticsProvider

Constructors

RadToolbarFormControl()

Initializes a new instance of the RadToolbarFormControl class. Sets up default properties including System.Windows.Forms.Control.AutoSize, System.Windows.Forms.Control.CausesValidation, and System.Windows.Forms.Control.Dock behavior.

Declaration
public RadToolbarFormControl()

Properties

CaptionHeight

Gets or sets the height of the extended title bar.

Declaration
public virtual int CaptionHeight { get; set; }
Property Value
System.Int32

CenterItems

Gets the collection of items positioned in the center of the toolbar form control.

Declaration
[RadDescription("CenterItems", typeof(RadToolbarFormControlElement))]
[RadNewItem("Type here", true, false)]
[RadEditItemsAction]
public virtual RadItemOwnerCollection CenterItems { get; }
Property Value
RadItemOwnerCollection

A RadItemOwnerCollection containing the center-positioned toolbar items.

CenterItemsMargin

Gets or sets the margin that defines the margin of the WrapLayoutPanel holding the center items.

Declaration
public Padding CenterItemsMargin { get; set; }
Property Value
System.Windows.Forms.Padding

CenterItemsVerticalAlignment

Gets or sets the vertical alignment of the center toolbar items.

Declaration
public RadVerticalAlignment CenterItemsVerticalAlignment { get; set; }
Property Value
RadVerticalAlignment

CenterItemsWrapWeight

Gets or sets the wrap weight while performing the layout of the CenterItems container. The property is only relevant in the Weight wrap mode. The value is in percentage and determines what part of the available space is dedicated to the container.

Declaration
public int? CenterItemsWrapWeight { get; set; }
Property Value
System.Nullable<System.Int32>

DefaultSize

Gets the default size of the control.

Declaration
protected override Size DefaultSize { get; }
Property Value
System.Drawing.Size

A System.Drawing.Size representing the default dimensions (400x40) of the control.

FarItems

Gets the collection of items positioned on the far side (typically right) of the toolbar form control.

Declaration
[RadDescription("FarItems", typeof(RadToolbarFormControlElement))]
[RadNewItem("Type here", true, false)]
[RadEditItemsAction]
public virtual RadItemOwnerCollection FarItems { get; }
Property Value
RadItemOwnerCollection

A RadItemOwnerCollection containing the far-positioned toolbar items.

FarItemsMargin

Gets or sets the margin that defines the margin of the WrapLayoutPanel holding the far items.

Declaration
public Padding FarItemsMargin { get; set; }
Property Value
System.Windows.Forms.Padding

FarItemsVerticalAlignment

Gets or sets the vertical alignment of the far toolbar items.

Declaration
public RadVerticalAlignment FarItemsVerticalAlignment { get; set; }
Property Value
RadVerticalAlignment

FarItemsWrapWeight

Gets or sets the wrap weight while performing the layout of the FarItems container. The property is only relevant in the Weight wrap mode. The value is in percentage and determines what part of the available space is dedicated to the container.

Declaration
public int? FarItemsWrapWeight { get; set; }
Property Value
System.Nullable<System.Int32>

HelpButtonElement

Gets the help button element in the form's caption bar.

Declaration
public override RadItem HelpButtonElement { get; }
Property Value
RadItem

The RadItem representing the help button element.
Overrides

IconCaptionElement

Gets the icon element displayed in the caption bar of the form.

Declaration
public override ImagePrimitive IconCaptionElement { get; }
Property Value
ImagePrimitive

The ImagePrimitive representing the icon element.
Overrides

MaximizeButtonElement

Gets the maximize button element in the form's caption bar.

Declaration
public override RadItem MaximizeButtonElement { get; }
Property Value
RadItem

The RadItem representing the maximize button element.
Overrides

MinimizeButtonElement

Gets the minimize button element in the form's caption bar.

Declaration
public override RadItem MinimizeButtonElement { get; }
Property Value
RadItem

The RadItem representing the minimize button element.
Overrides

NearItems

Gets the collection of items positioned on the near side (typically left) of the toolbar form control.

Declaration
[RadDescription("NearItems", typeof(RadToolbarFormControlElement))]
[RadNewItem("Type here", true, false)]
[RadEditItemsAction]
public virtual RadItemOwnerCollection NearItems { get; }
Property Value
RadItemOwnerCollection

A RadItemOwnerCollection containing the near-positioned toolbar items.

NearItemsMargin

Gets or sets the margin that defines the margin of the WrapLayoutPanel holding the near items.

Declaration
public Padding NearItemsMargin { get; set; }
Property Value
System.Windows.Forms.Padding

NearItemsVerticalAlignment

Gets or sets the vertical alignment of the near toolbar items.

Declaration
public RadVerticalAlignment NearItemsVerticalAlignment { get; set; }
Property Value
RadVerticalAlignment

NearItemsWrapWeight

Gets or sets the wrap weight while performing the layout of the NearItems container. The property is only relevant in the Weight wrap mode. The value is in percentage and determines what part of the available space is dedicated to the container.

Declaration
public int? NearItemsWrapWeight { get; set; }
Property Value
System.Nullable<System.Int32>

ShowIcon

Gets or sets a value indicating whether an icon is displayed in the caption bar of the form.

Declaration
public virtual bool ShowIcon { get; set; }
Property Value
System.Boolean

ShowText

Gets or sets whether the element holding the text is visible.

Declaration
public virtual bool ShowText { get; set; }
Property Value
System.Boolean

SystemButtonsElement

Gets the system buttons element containing the minimize, maximize, and close buttons in the form's caption bar.

Declaration
public override RadItem SystemButtonsElement { get; }
Property Value
RadItem

The RadItem representing the system buttons element.
Overrides

TextCaptionElement

Gets the text element displayed in the caption bar of the form.

Declaration
public override RadElement TextCaptionElement { get; }
Property Value
RadElement

The RadElement representing the text caption element.
Overrides

TextPosition

Gets or sets the position of the text inside the title bar.

Declaration
public ToolbarTextPosition TextPosition { get; set; }
Property Value
ToolbarTextPosition

ToolbarFormControlElement

Gets the instance of RadToolbarFormControlElement wrapped by this control. The RadToolbarFormControlElement is the main element in the hierarchy tree and encapsulates the actual functionality of RadToolbarFormControlElement.

Declaration
public RadToolbarFormControlElement ToolbarFormControlElement { get; }
Property Value
RadToolbarFormControlElement

WrapMode

Determines how the element containers are wrapped in relation to the available space. Both options will allocate the space for each of the containers proportionally from the totally available space. The DesiredSize will calculate the proportion depending on the DesiredSize of the element containers. The Weight option will calculate the proportion depending on the items count or the explicitly specified items weight.

Declaration
public ToolbarWrapMode WrapMode { get; set; }
Property Value
ToolbarWrapMode

Methods

CreateChildItems(RadElement)

Creates the child elements of this control by adding the main RadToolbarFormControlElement to the root element.

Declaration
protected override void CreateChildItems(RadElement parent)
Parameters
RadElement parent

The parent element to which child elements will be added.
Overrides

CreateToolbarFormControlElement()

Creates and returns a new instance of RadToolbarFormControlElement. This method can be overridden to provide custom element implementations.

Declaration
protected virtual RadToolbarFormControlElement CreateToolbarFormControlElement()
Returns
RadToolbarFormControlElement

A new instance of RadToolbarFormControlElement.

InitializeRootElement(RootRadElement)

Initializes the root element of the control by setting its vertical stretch behavior.

Declaration
protected override void InitializeRootElement(RootRadElement rootElement)
Parameters
RootRadElement rootElement

The root element to initialize.
Overrides

ProcessAutoSizeChanged(Boolean)

Processes changes to the System.Windows.Forms.Control.AutoSize property. This method is intentionally empty for this control as auto-sizing behavior is handled differently.

Declaration
protected override void ProcessAutoSizeChanged(bool value)
Parameters
System.Boolean value

The new value of the AutoSize property.
Overrides

Extension Methods