Label

Namespace: Wisej.Web

Assembly: Wisej.Framework (4.1.0.0)

• Control
  • Label

Represents a label control.

C#

public class Label : Control, IButtonControl, IImage, IErrorProvider, ICommandSource

VB.NET

Public Class Label
    Inherits Control
    Implements IButtonControl, IImage, IErrorProvider, ICommandSource

Constructors

Label()

Initializes a new instance of the Label class.

Label(text)

Initializes a new instance of the Label class.

Name	Type	Description
text	String	Initial text.

Label(text, location, size)

Initializes a new instance of the Label class.

Name	Type	Description
text	String	Initial text.
location	Point	Initial location.
size	Size	Initial size.

Properties

AllowHtml

Boolean: Returns or sets a value indicating that the control can display HTML in the Text property. (Default: False)

Newlines (CRLF) are converted to <BR/> when AllowHtml is false, or when AllowHtml is true and the text doesn't contain any HTML.

AllowMarkdown

Boolean: Returns or sets a value indicating that the control can display markdown text as HTML in the Text property. (Default: False)

Anchor

AnchorStyles: Returns or sets the edges of the container to which a control is bound and determines how a control is resized with its parent. (Default: Top, Left)

AutoEllipsis

Boolean: Returns or sets whether the ellipsis character (...) appears at the right edge of the label, denoting that the text extends beyond the size of the label. (Default: False)

AutoSize

Boolean: Returns or sets a value that indicates whether the control resizes based on its contents. (Default: False)

Since 3.5.6

Auto sizing behavior in the Label control is slightly different from other controls. When the label is a child of a standard container (i.e. Panel, Form, Page, GroupBox) and it's anchored to the right, auto sizing grows or shrinks the label's width preserving the left position.

When the label is a child of a container with a custom LayoutEngine (i.e. FlexLayoutPanel, FlowLayoutPanel, TableLayoutPanel) the auto sizing behavior is the same as all other controls.

You can change the default behavior using the AppContext switch "LabelSelfSize". See System.AppContext to learn how to set the switch. In code, you can set it in a static Program constructor:

class Program {
  static void Program() {
    AppContext.SetSwitch("LabelSelfSize", false);
  }
}

AutoToolTip

Boolean: Returns or sets whether a tooltip is displayed when the text extends beyond the size of the label. (Default: False)

The auto tooltip is set on the browser using the title attribute managed by the browser, does not use the themed tooltip managed by Wisej.NET.

BorderStyle

BorderStyle: Indicates the border style for the control. (Default: None)

CharacterCasing

CharacterCasing: Returns or sets the case of the text to display to the user. (Default: Normal)

Command

ICommand: Returns or sets the ICommand implementation to invoke. (Default: null)

DefaultSize

Size:

DialogResult

DialogResult: Returns or sets a value that is returned to the parent form when the button is clicked. (Default: None)

Dock

DockStyle: Returns or sets which control borders are docked to its parent control and determines how a control is resized with its parent. (Default: None)

EnableNativeContextMenu

Boolean: Enables or disables the browser's context menu. (Default: False)

Image

Image: Returns or sets the image that is displayed on a Label.

ImageAlign

ContentAlignment: Returns or sets the alignment of an image that is displayed in the control. (Default: MiddleCenter)

ImageIndex

Int32: Returns or sets the image list index value of the image displayed on the label control. (Default: -1)

Throws:

• ArgumentOutOfRangeException The specified index is less than -1.

ImageKey

String: Returns or sets the key accessor for the image in the ImageList. (Default: "")

ImageList

ImageList: Returns or sets the ImageList that contains the images to display in the Label control. (Default: null)

ImageSource

String: Returns or sets the theme name or URL for the image to display in the Label.

SelfSize

Boolean: Returns or sets whether the label resize itself when AutoSize is true and it's in a container using the default layout engine: i.e.: Panel, Form, Page, GroupBox, UserControl. Since 3.5.6 (Default: True)

When self sizing is active (default for standard containers) an auto sizing label will always grow to the right side, even when anchored right, preserving it's left position. This is the default behavior in WinForms applications.

SelfSizeDefault

Boolean: Default value for the SelfSize property. Since 3.5.6

The default is true. You can set the value by code or using AppContext switches: AppContext.SetSwitch("LabelSelfSize", false);

Text

String: Returns or sets the text associated with this control. (Default: "")

Newlines (CRLF) are converted to <BR/> when AllowHtml is false, or when AllowHtml is true and the text doesn't contain any HTML.

TextAlign

ContentAlignment: Returns or sets the alignment of text in the label. (Default: TopLeft)

UseMnemonic

Boolean: Returns or sets whether the first character that is preceded by an ampersand (&) is used as the mnemonic key of the control. (Default: True)

Methods

OnClick(e)

Fires the Click event.

Parameter	Type	Description
e	EventArgs	An EventArgs that contains the event data.

OnCommandChanged(e)

Fires the CommandChanged event.

Parameter	Type	Description
e	EventArgs	A EventArgs that contains the event data.

OnFontChanged(e)

Parameter	Type	Description
e	EventArgs

OnParentChanged(e)

Parameter	Type	Description
e	EventArgs

OnTextChanged(e)

Parameter	Type	Description
e	EventArgs

OnWebEvent(e)

Processes the event from the client.

Parameter	Type	Description
e	WisejEventArgs	Event arguments.

OnWebRender(config)

Renders the client component.

Parameter	Type	Description
config	Object	Dynamic configuration object.

PerformClick()

Generates a Click event for the LinkLabel control.

SetBoundsCore(x, y, width, height, specified)

Sets the specified bounds of the label.

Parameter	Type	Description
x	Int32	The new Left property value of the control.
y	Int32	The new Top property value of the control.
width	Int32	The new Width property value of the control.
height	Int32	The new Height property value of the control.
specified	BoundsSpecified	A bitwise combination of the BoundsSpecified values. For any parameter not specified, the current value will be used.

Events

CommandChanged

EventHandler Fired when the Command property value changes.

Inherited By

Name	Description
LinkLabel	Represents an hyper-link control.

Implements

Name	Description
IUserData	Provides access to the UserData and Tag properties associated to the component implementing this interface.
IBindableComponent	Bindable components implement this interface.
IButtonControl	Allows a control to act like a button on a Form.
ICommandSource	Defines an object that can invoke a Command.
IDropTarget	Controls that support drag & drop operations implement this interface.
IErrorProvider	Exposes a common api implemented by components that can collect errors in relation to a Control.
IImage	Provides access to common image properties across the controls that implement this interface.
IWisejComponent	All wisej components implement this interface.
IWisejControl	All wisej controls derived from the Control class must implement this interface.
IWisejSerializable	Allows an object to serialize itself.