Back to Devexpress

RepositoryItemHypertextLabel Members

windowsforms-devexpress-dot-xtraeditors-dot-repository-dot-repositoryitemhypertextlabel-dot-underscore-members.md

latest56.4 KB
Original Source

RepositoryItemHypertextLabel Members

When embedded in a container’s column/cell, allows cell text to be formatted using HTML tags. No editing is supported for these cells.

Constructors

NameDescription
RepositoryItemHypertextLabel()Initializes a new instance of the RepositoryItemHypertextLabel class.

Properties

NameDescription
AccessibleDefaultActionDescriptionGets or sets the default action description of the repository item for use by accessibility client applications. Inherited from RepositoryItem.
AccessibleDescriptionGets or sets the object’s description used by accessibility client applications. Inherited from RepositoryItem.
AccessibleNameGets or sets the object’s name used by accessibility client applications. Inherited from RepositoryItem.
AccessibleRoleGets or sets the object’s accessible role. Inherited from RepositoryItem.
AllowButtonNavigationGets or sets whether to allow users to focus ButtonEdit buttons with the keyboard. Inherited from RepositoryItemButtonEdit.
AllowContextImageChangeAnimationGets or sets whether the context image is changed using animation. This property is not in effect for in-place editors. Inherited from RepositoryItemTextEdit.
AllowFocusedGets or sets a value specifying whether the focus rectangle is displayed within the editor when it has focus. Inherited from RepositoryItem.
AllowFocusedAppearanceGets a value which indicates whether the appearance settings used to paint the editor when it’s focused can be used. Inherited from RepositoryItem.
AllowGlyphSkinningGets or sets whether this TextEdit can colorize its icons. Inherited from RepositoryItemTextEdit.
AllowHtmlDrawGets or sets whether HTML tags can be used to format an editor’s text or text of the editor’s items. Inherited from RepositoryItem.
AllowInplaceAutoFilterThis member supports the internal infrastructure, and is not intended to be used directly from your code. Inherited from RepositoryItem.
AllowInplaceBorderPainterThis member supports the internal infrastructure, and is not intended to be used directly from your code. Inherited from RepositoryItem.
AllowMouseWheelThis property is not supported by the RepositoryItemHypertextLabel class.
AllowNullInputThis property is not supported by the RepositoryItemHypertextLabel class.
AppearanceGets appearance settings used to paint the editor when it is enabled. Inherited from RepositoryItem.
AppearanceDisabledThis property is not supported by the RepositoryItemHypertextLabel class.
AppearanceFocusedThis property is not supported by the RepositoryItemHypertextLabel class.
AppearanceReadOnlyThis property is not supported by the RepositoryItemHypertextLabel class.
AutoHeightThis property is not supported by the RepositoryItemHypertextLabel class.
BeepOnErrorGets or sets whether the masked editor should play a system error sound when a user enters an invalid character (for example, a literal in an editor with a Numeric mask). This property replaces the DevExpress.XtraEditors.Mask.MaskProperties.BeepOnError property. Inherited from RepositoryItemTextEdit.
BestFitWidthGets or sets the editor’s best fit width. Inherited from RepositoryItem.
BorderStyleGets or sets the editor’s border style. Inherited from RepositoryItem.
BrowserWindowStyleGets or sets the window state to use when a browser is opened.
ButtonsReturns the collection of buttons in the current button editor. Inherited from RepositoryItemButtonEdit.
ButtonsBorderStyleObsolete. This member is not supported. Inherited from RepositoryItemButtonEdit.
ButtonsStyleGets or sets the style used to draw editor buttons. Inherited from RepositoryItemButtonEdit.
CanRaiseEvents protectedGets a value indicating whether the component can raise an event. Inherited from Component.
CharacterCasingGets or sets the character casing applied to the editor’s content. Inherited from RepositoryItemTextEdit.
ContainerGets the IContainer that contains the Component. Inherited from Component.
ContextImageGets or sets a custom image displayed in the editor. This property is obsolete. Use the ContextImageOptions property instead. Inherited from RepositoryItemTextEdit.
ContextImageAlignmentGets or sets the alignment of an image displayed by this editor. Inherited from RepositoryItemTextEdit.
ContextImageOptionsProvides access to all properties that allow you to assign and customize a custom image displayed at the editor’s edge. Inherited from RepositoryItemTextEdit.
ContextMenuGets or sets the context menu for the editor. Inherited from RepositoryItem.
DefaultAlignmentGets the default horizontal alignment of the editor’s content. Inherited from RepositoryItem.
DefaultBorderStyleInBarsThis member supports the internal infrastructure, and is not intended to be used directly from your code. Inherited from RepositoryItem.
DefaultBorderStyleInGridThis member supports the internal infrastructure, and is not intended to be used directly from your code. Inherited from RepositoryItem.
DesignMode protectedGets a value that indicates whether the Component is currently in design mode. Inherited from Component.
DisplayFormatThis property is not supported by the RepositoryItemHypertextLabel class.
EditableGets whether the editor’s value can be changed. Inherited from RepositoryItem.
EditFormatThis property is not supported by the RepositoryItemHypertextLabel class.
EditorTypeNameGets the class name of an edit control corresponding to the current repository item.
EditValueChangedDelayThis property is not supported by the RepositoryItemHypertextLabel class.
EditValueChangedFiringDelay staticGets or sets the default time interval between the moment when an end-user stops changing the editor’s value and the RepositoryItem.EditValueChanged event being raised. Inherited from RepositoryItem.
EditValueChangedFiringModeThis property is not supported by the RepositoryItemHypertextLabel class.
EnabledGets or sets a value indicating whether the edit control can respond to user actions. This property is supported for standalone editors. Inherited from RepositoryItem.
Events protectedGets the list of event handlers that are attached to this Component. Inherited from Component.
ExportModeGets whether the editor’s value or display text is exported when data is exported to XLS and CSV formats.
HideSelectionThis property is not supported by the RepositoryItemHypertextLabel class.
HtmlImagesGets or sets a collection of images that can be embedded in the editor’s display text or the display text of the editor’s items, using the image tag. Inherited from RepositoryItem.
InplaceModeImmediatePostChangesFor internal use. Gets or sets whether the in-place editor posts its value to the bound data source immediately after the value changes. Inherited from RepositoryItem.
IsDesignModeIndicates whether the editor is currently in design mode. Inherited from RepositoryItem.
IsDisposedGets a value indicating whether the control has been disposed of. Inherited from RepositoryItem.
IsEditValueChangedEventPendingGets whether the EditValueChanged event is postponed. Inherited from RepositoryItem.
IsFilterLookUpThis member supports the internal infrastructure, and is not intended to be used directly from your code. Inherited from RepositoryItem.
IsLoadingIndicates whether the editor is being loaded. Inherited from RepositoryItem.
IsLockUpdateGets a value indicating whether the editor is immediately updated in response to changing its settings. Inherited from RepositoryItem.
IsNonSortableEditorThis member supports the internal infrastructure, and is not intended to be used directly from your code. Inherited from RepositoryItem.
LinkCountGets the number of objects connected to the current repository item. Inherited from RepositoryItem.
LookAndFeelProvides access to the stand-alone editor’s look and feel settings. These settings are not in effect for the editor in a bar, ribbon, grid, etc. Inherited from RepositoryItem.
MaskThis property is not supported by the RepositoryItemHypertextLabel class.
MaskBoxPaddingGets or sets the amount of space around the text box embedded in the TextEdit. Inherited from RepositoryItemTextEdit.
MaskSettingsFor internal use.
MaxLengthThis property is not supported by the RepositoryItemHypertextLabel class.
MaxToolTipTextLength staticGets or sets the maximum number of characters in the automatically generated tooltip displayed for an in-place editor. Inherited from RepositoryItemTextEdit.
NameGets or sets the repository item name. Inherited from RepositoryItem.
NormalizeDisplayText staticSet the NormalizeDisplayText property to true to correctly process diacritics when selecting rows from a dropdown window in the LookUpEdit control. Inherited from RepositoryItem.
NullTextGets or sets the text that presents the editor’s null value ( null , System.DBNull.Value and RepositoryItemDateEdit.NullDate - for DateEdit). Inherited from RepositoryItem.
NullValuePromptThis property is not supported by the RepositoryItemHypertextLabel class.
NullValuePromptForeColorInherited from RepositoryItemTextEdit.
NullValuePromptShowForEmptyValueThis property is not supported by the RepositoryItemHypertextLabel class.
OwnerEditReturns an editor which owns the current repository item object. Inherited from RepositoryItemButtonEdit.
OwnerItemThis member supports the internal infrastructure, and is not intended to be used directly from your code. Inherited from RepositoryItem.
PaddingGets or sets the TextEdit padding. The MemoEdit does not fully support this property, use the MaskBoxPadding property instead. Inherited from RepositoryItemTextEdit.
PasswordCharThis property is not supported by the RepositoryItemHypertextLabel class.
PopupOffsetGets or sets the popup window’s location. Inherited from RepositoryItem.
PropertiesObsolete. Provides access to properties specific to the control.
ReadOnlyGets or sets a value specifying whether the editor’s value can be changed by end-users. Inherited from RepositoryItem.
RequireDisplayTextSortingThis member supports the internal infrastructure, and is not intended to be used directly from your code.
ResetTextEditStyleToStandardInFilterControlGets or sets whether the RepositoryItemButtonEdit.TextEditStyle property is automatically set to TextEditStyles.Standard, when the editor is displayed within a FilterControl and FilterEditorControl. Inherited from RepositoryItemButtonEdit.
ShowNullValuePromptFor internal use.
ShowNullValuePromptWhenFocusedThis property is not supported by the RepositoryItemHypertextLabel class.
ShowNullValuePromptWhenReadOnlyFor internal use.
SingleClickIf the label contains a hyperlink, gets or sets whether a single or double click opens a browser.
SiteGets or sets a ISite for the object. Inherited from RepositoryItem.
TagGets or sets the data associated with the repository item. Inherited from RepositoryItem.
TextEditStyleGets the style in which text is displayed the editor.
TextPaddingGets or sets the text (value) padding within the editor. Inherited from RepositoryItemTextEdit.
UseMaskAsDisplayFormatFor internal use.
UseParentBackgroundThis member supports the internal infrastructure, and is not intended to be used directly from your code. Inherited from RepositoryItem.
UseReadOnlyAppearanceThis property is not supported by the RepositoryItemHypertextLabel class.
UseSystemPasswordCharThis property is not supported by the RepositoryItemHypertextLabel class.
UseTextEditorForAutoFilterGets whether to substitute this editor with the single-line text editor in auto-filter rows. Inherited from RepositoryItemButtonEdit.
ValidateOnEnterKeyThis property is not supported by the RepositoryItemHypertextLabel class.
XlsxFormatStringGets or sets the native Excel format string used to format the editor’s value when exporting to XLSX. This property is in effect in WYSIWYG export mode. Inherited from RepositoryItemTextEdit.

Methods

NameDescription
Assign(RepositoryItem)Assigns property values of the specified RepositoryItem object to the corresponding properties of this object.
BeginInit()Performs specific actions before control initialization. Inherited from RepositoryItemButtonEdit.
BeginUpdate()Locks the RepositoryItem object by disallowing visual updates until the EndUpdate or CancelUpdate method is called. Inherited from RepositoryItem.
CancelUpdate()Unlocks the RepositoryItem object after it has been locked by the BeginUpdate method, without causing an immediate visual update. Inherited from RepositoryItem.
Clone()Creates a copy of the current repository item. Inherited from RepositoryItem.
Connect(Object)Connects the repository item to the specified object. Inherited from RepositoryItem.
CreateDefaultButton()This method is not supported by the RepositoryItemHypertextLabel class.
CreateEditor()Creates an editor whose type corresponds to the repository item’s type. Inherited from RepositoryItem.
CreateGroupPainter()Initializes a new instance of the DevExpress.XtraEditors.Drawing.BaseEditorGroupRowPainter class. Inherited from RepositoryItem.
CreateObjRef(Type)Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. Inherited from MarshalByRefObject.
CreatePainter()This member supports the editor library’s internal infrastructure and is not intended to be used in your applications. Inherited from RepositoryItem.
CreateViewInfo()This member supports the editors library’s internal infrastructure and is not intended to be used in your applications. Inherited from RepositoryItem.
Disconnect(Object)Removes the connection between the repository item and the specified object. Inherited from RepositoryItem.
Dispose()Releases all resources used by the Component. Inherited from Component.
EditMaskSettings(Object)Shows the Mask Editor dialog at runtime. Users can utilize this dialog to apply standard or custom masks to this editor. Inherited from RepositoryItemTextEdit.
EditMaskSettings(IWindowsFormsEditorService, Object)Inherited from RepositoryItemTextEdit.
EditMaskSettings(IWin32Window, Object)Inherited from RepositoryItemTextEdit.
EnableCustomMaskTextInput(Action<CustomTextMaskInputArgs>, Object)Allows you to manually control user edits, and modify them according to your custom logic. Inherited from RepositoryItemTextEdit.
EnableNonMaskedInput()Inherited from RepositoryItemTextEdit.
EndInit()Notifies the editor that the initialization has been completed. Inherited from RepositoryItem.
EndUpdate()Unlocks the RepositoryItem object after a call to the BeginUpdate method and causes an immediate visual update. Inherited from RepositoryItem.
Equals(Object, Object) staticDetermines whether the specified object instances are considered equal. Inherited from Object.
Equals(Object)Determines whether the specified object is equal to the current object. Inherited from Object.
GetBorderSides(Boolean, Boolean) staticThis member supports the internal infrastructure, and is not intended to be used directly from your code. Inherited from RepositoryItem.
GetBrick(PrintCellHelperInfo)Returns a brick object that contains information on how the current editor should be printed.
GetDisplayText(FormatInfo, Object)Returns the text representation of the specified value, formatted according to the specified settings. Inherited from RepositoryItem.
GetDisplayText(Object)Returns the text representation of the specified value formatted using the editor’s settings. Inherited from RepositoryItem.
GetEditorType()This member supports the internal infrastructure, and is not intended to be used directly from your code. Inherited from RepositoryItem.
GetEditValueForExportByOptions(Object, Object, Object, Object, Function3<String, Object, Object, Object>, ExportTarget)This member supports the internal infrastructure, and is not intended to be used directly from your code. Inherited from RepositoryItem.
GetHashCode()Returns a hash code. Inherited from RepositoryItem.
GetLifetimeService()Retrieves the current lifetime service object that controls the lifetime policy for this instance. Inherited from MarshalByRefObject.
GetNormalizedText(String) staticThis member supports the internal infrastructure, and is not intended to be used directly from your code. Inherited from RepositoryItem.
GetService(Type) protectedReturns an object that represents a service provided by the Component or by its Container. Inherited from Component.
GetType()Gets the Type of the current instance. Inherited from Object.
InitializeLifetimeService()Obtains a lifetime service object to control the lifetime policy for this instance. Inherited from MarshalByRefObject.
IsActivateKey(Keys)Indicates whether a particular key can activate the editor used as an inplace control. Inherited from RepositoryItem.
IsLockDefaultImmediateUpdateRowPosition()This member supports the internal infrastructure, and is not intended to be used directly from your code. Inherited from RepositoryItem.
IsNeededKey(Keys)Indicates whether the key is handled by the editor or the container control. Inherited from RepositoryItem.
LockEvents()This method supports the .NET Framework infrastructure and is not intended to be called from your code. Inherited from RepositoryItem.
MemberwiseClone() protectedCreates a shallow copy of the current Object. Inherited from Object.
MemberwiseClone(Boolean) protectedCreates a shallow copy of the current MarshalByRefObject object. Inherited from MarshalByRefObject.
ReferenceEquals(Object, Object) staticDetermines whether the specified Object instances are the same instance. Inherited from Object.
ResetEvents()This member supports the .NET Framework infrastructure and is not intended to be used in your applications. Inherited from RepositoryItem.
ResetMaskSettings()Reverts all MaskSettings properties to their default values, and removes an active input mask. Inherited from RepositoryItemTextEdit.
ScaleProperties(ScaleHelper)Updates the RepositoryItem according to current scale settings. This method is called automatically when the form’s runtime DPI settings differ from those in design-time. Inherited from RepositoryItem.
ShouldSerializeMaskSettings()Tests whether the MaskSettings object should be serialized. This member supports the internal .NET infrastructure and does not need to be called from your code. Inherited from RepositoryItemTextEdit.
SwitchMode()Inherited from RepositoryItemTextEdit.
ToString()Returns a string that represents the current object. Inherited from RepositoryItem.
UnLockEvents()This method supports the .NET Framework infrastructure and is not intended to be called from your code. Inherited from RepositoryItem.

Events

NameDescription
BeforeShowMenuOccurs before the editor’s context menu is displayed. Inherited from RepositoryItemTextEdit.
ButtonClickOccurs when an editor button is clicked. Inherited from RepositoryItemButtonEdit.
ButtonPressedOccurs when an edit button is pressed within a button editor. Inherited from RepositoryItemButtonEdit.
ClickFires when clicking the editor. Inherited from RepositoryItem.
CustomDisplayTextEnables custom display text to be provided for an editor. Inherited from RepositoryItem.
CustomDrawButtonAllows you to apply custom painting to specific RepositoryItemButtonEdit‘s buttons. Inherited from RepositoryItemButtonEdit.
CustomHighlightTextAllows you to highlight or custom paint strings within the control’s text. This event is supported in Advanced mode (see RepositoryItemTextEdit.UseAdvancedMode). Inherited from RepositoryItemTextEdit.
CustomizeAutoCompleteSourceAllows you to dynamically supply custom auto-complete text suggestions each time a user types a new word in the text box. This event is in effect in advanced mode when the AutoCompleteSource option is set to CustomSource, and the AutoCompleteMode option is set to SuggestSingleWord. Inherited from RepositoryItemTextEdit.
CustomTextLineHeightAllows you to specify the height of a line of text in Advanced Mode. Inherited from RepositoryItemTextEdit.
DisposedOccurs when the component is disposed by a call to the Dispose() method. Inherited from Component.
DoubleClickFires when the editor is double clicked. Inherited from RepositoryItem.
DragDropFires when an object is dropped onto the editor. Inherited from RepositoryItem.
DragEnterFires when a dragged object enters the editor’s area. Inherited from RepositoryItem.
DragLeaveFires when a dragged object leaves the editor’s area. Inherited from RepositoryItem.
DragOverFires repeatedly when dragging an object over the editor. Inherited from RepositoryItem.
EditValueChangedFires when the editor’s EditValue property changes. Inherited from RepositoryItem.
EditValueChangingFires when the editor’s value is about to be changed. Inherited from RepositoryItem.
EnterFires when the editor receives focus. Inherited from RepositoryItem.
FormatEditValueEnables you to format the editor’s value (change the editor’s value when the formatting mechanism is invoked). Inherited from RepositoryItem.
GiveFeedbackEnables you to specify the cursor appearance when dragging this editor’s data. Inherited from RepositoryItem.
HelpRequestedFires when the end-user requests help for the editor. Inherited from RepositoryItem.
KeyDownFires when a key is pressed while the editor has focus. Inherited from RepositoryItem.
KeyPressFires when a character key is pressed while the editor has focus. Inherited from RepositoryItem.
KeyUpFires when a key is released while the editor has focus. Inherited from RepositoryItem.
LeaveFires when the editor loses focus. Inherited from RepositoryItem.
ModifiedFires when the edit value is first changed since it was last validated. Inherited from RepositoryItem.
MouseDownFires when a mouse button is pressed while the mouse pointer is over the editor. Inherited from RepositoryItem.
MouseEnterFires when the mouse pointer enters the editor’s area. Inherited from RepositoryItem.
MouseHoverFires when hot-tracking an editor element. Inherited from RepositoryItem.
MouseLeaveFires when the mouse pointer leaves the editor’s area. Inherited from RepositoryItem.
MouseMoveFires when the mouse pointer moves over the editor’s area. Inherited from RepositoryItem.
MouseUpFires when the mouse button is released while the mouse pointer is over the editor. Inherited from RepositoryItem.
MouseWheelFires when the mouse wheel moves while the mouse pointer is within the editor. Inherited from RepositoryItem.
OpenHyperlinkFires when a hyperlink is clicked, and a browser is about to be opened.
ParseEditValueConverts an input value (entered by a user or assigned in code) to the value that the editor will store. Inherited from RepositoryItem.
PropertiesChangedFires immediately after a change to one of the editor’s properties. Inherited from RepositoryItem.
QueryAccessibilityHelpFires when the help is provided to accessibility applications. Inherited from RepositoryItem.
QueryContinueDragFires when dragging the editor’s data allowing you to specify whether dragging should be continued. Inherited from RepositoryItem.
QueryProcessKeyProvides the capability to specify whether the key pressed in the editor is processed by the editor or a container control (GridControl, TreeList, etc.) that displays this editor. Inherited from RepositoryItem.
SpinOccurs when either the UP or DOWN ARROW key is pressed or the mouse wheel is rotated. Inherited from RepositoryItemTextEdit.
ValidatingAllows you to specify whether the edit value is valid. This event does not occur if the editor’s CausesValidation property is disabled. Inherited from RepositoryItem.

See Also

RepositoryItemHypertextLabel Class

DevExpress.XtraEditors.Repository Namespace