Class RadLabel

Represents a label control that provides run-time information or descriptive text for a control.

Inheritance
System.Object
RadControl
RadLabel
Inherited Members
Namespace: Telerik.WinControls.UI
Assembly: Telerik.WinControls.UI.dll

Syntax

public class RadLabel : RadControl, INotifyPropertyChanged, ISupportInitializeNotification, ISupportInitialize, IComponentTreeHandler, ILayoutHandler, IPCHost, IAnalyticsProvider, ISupportRootUIAutomation

Constructors

RadLabel()

Initializes a new instance of the RadLabel class.

Declaration
public RadLabel()

Properties

AutoSize

Gets or sets a value indicating whether the control is automatically resized to display its entire contents.

Declaration
public override bool AutoSize { get; set; }
Property Value
System.Boolean

Overrides

BorderVisible

Gets or sets a value indicating whether the border is visible.

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

DefaultSize

Gets the default size of the control.

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

EnableUIAutomation

Gets or sets a value indicating whether UI Automation support is enabled for the label. Default value is true.

Declaration
public override bool EnableUIAutomation { get; set; }
Property Value
System.Boolean

Overrides
Implements

Image

Gets or sets the image that is displayed on the label.

Declaration
public Image Image { get; set; }
Property Value
System.Drawing.Image

ImageAlignment

Gets or sets the alignment of image content on the drawing surface.

Declaration
public ContentAlignment ImageAlignment { get; set; }
Property Value
System.Drawing.ContentAlignment

ImageIndex

Gets or sets the image list index value of the image displayed on the label control.

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

ImageKey

Gets or sets the key accessor for the image in the label.

Declaration
public virtual string ImageKey { get; set; }
Property Value
System.String

LabelElement

Gets the RadLabelElement that represents the visual element of this label control.

Declaration
public RadLabelElement LabelElement { get; }
Property Value
RadLabelElement

SvgImage

Gets or sets the SVG image displayed on the label.

Declaration
public RadSvgImage SvgImage { get; set; }
Property Value
RadSvgImage

SvgImageXml

Gets or sets the SVG image as an XML.

Declaration
public string SvgImageXml { get; set; }
Property Value
System.String

TabStop

Gets or sets a value indicating whether the user can give the focus to this control using the TAB key.

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

TextAlignment

Gets or sets the alignment of text content on the drawing surface.

Declaration
public ContentAlignment TextAlignment { get; set; }
Property Value
System.Drawing.ContentAlignment

TextImageRelation

Gets or sets the position of text and image relative to each other.

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

TextWrap

Gets or sets a value indicating whether the text should wrap to the available layout rectangle.

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

UseMnemonic

Gets or sets a value indicating whether the first character preceded by an ampersand will be used as the label's mnemonic key.

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

Methods

CreateAccessibilityInstance()

Creates the RadLabelAccessibleObject instance for this control.

Declaration
protected override AccessibleObject CreateAccessibilityInstance()
Returns
System.Windows.Forms.AccessibleObject

An AccessibleObject instance for this control.

CreateChildItems(RadElement)

Creates the child items within the specified parent element.

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

The parent element that will contain the child items.
Overrides

CreateLabelElement()

Creates the RadLabelElement for this control.

Declaration
protected virtual RadLabelElement CreateLabelElement()
Returns
RadLabelElement

A new RadLabelElement instance.

CreateRootElement()

Creates the root element for RadLabel control.

Declaration
protected override RootRadElement CreateRootElement()
Returns
RootRadElement

A new RadLabelRootElement instance.
Overrides

OnNotifyPropertyChanged(String)

Raises the NotifyPropertyChanged event for the specified property.

Declaration
protected override void OnNotifyPropertyChanged(string propertyName)
Parameters
System.String propertyName

The name of the property that changed.
Overrides

OnTextChanged(EventArgs)

Raises the TextChanged event.

Declaration
protected override void OnTextChanged(EventArgs e)
Parameters
System.EventArgs e

An EventArgs that contains the event data.

ProcessMnemonic(Char)

Processes a mnemonic character and activates the next control in the tab order.

Declaration
protected override bool ProcessMnemonic(char charCode)
Parameters
System.Char charCode

The character to process.
Returns
System.Boolean

True if the character was processed as a mnemonic by the control; otherwise, false.
Overrides

ResetBackColorThemeOverrides()

Resets the background color theme overrides for the label element.

Declaration
protected override void ResetBackColorThemeOverrides()
Overrides

ResetForeColorThemeOverrides()

Resets the fore color theme overrides for the label element.

Declaration
protected override void ResetForeColorThemeOverrides()
Overrides

SetBackColorThemeOverrides()

Sets the background color theme overrides for the label element.

Declaration
protected override void SetBackColorThemeOverrides()
Overrides

SetForeColorThemeOverrides()

Sets the fore color theme overrides for the label element.

Declaration
protected override void SetForeColorThemeOverrides()
Overrides

WndProc(ref Message)

Processes Windows messages sent to the control.

Declaration
protected override void WndProc(ref Message m)
Parameters
System.Windows.Forms.Message m

The Windows message to process.
Overrides

Explicit Interface Implementations

ISupportRootUIAutomation.DisposeUIAutomationProvider()

Clears the UI Automation provider for this control.

Declaration
void ISupportRootUIAutomation.DisposeUIAutomationProvider()
Implements

ISupportRootUIAutomation.InitializeUIAutomationProvider()

Creates the UI Automation provider for this control.

Declaration
void ISupportRootUIAutomation.InitializeUIAutomationProvider()
Implements

ISupportRootUIAutomation.RootUIAutomationManager

Gets the UI Automation Manager.

Declaration
IRootUIAutomationManager ISupportRootUIAutomation.RootUIAutomationManager { get; }
Returns
IRootUIAutomationManager

Implements

ISupportRootUIAutomation.UIAutomationProvider

Gets the UI Automation Provider.

Declaration
IRadRawElementProviderFragmentRoot ISupportRootUIAutomation.UIAutomationProvider { get; }
Returns
IRadRawElementProviderFragmentRoot

Implements

Extension Methods