Back to Devexpress

RepositoryItem Members

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

latest29.0 KB
Original Source

RepositoryItem Members

Serves as the base for all repository items.

Constructors

NameDescription
RepositoryItem()Creates a new RepositoryItem object.

Properties

NameDescription
AccessibleDefaultActionDescriptionGets or sets the default action description of the repository item for use by accessibility client applications.
AccessibleDescriptionGets or sets the object’s description used by accessibility client applications.
AccessibleNameGets or sets the object’s name used by accessibility client applications.
AccessibleRoleGets or sets the object’s accessible role.
AllowFocusedGets or sets a value specifying whether the focus rectangle is displayed within the editor when it has focus.
AllowFocusedAppearanceGets a value which indicates whether the appearance settings used to paint the editor when it’s focused can be used.
AllowHtmlDrawGets or sets whether HTML tags can be used to format an editor’s text or text of the editor’s items.
AllowInplaceAutoFilterThis member supports the internal infrastructure, and is not intended to be used directly from your code.
AllowInplaceBorderPainterThis member supports the internal infrastructure, and is not intended to be used directly from your code.
AllowMouseWheelGets or sets whether value scrolling via the Mouse Wheel is supported by the editor.
AppearanceGets appearance settings used to paint the editor when it is enabled.
AppearanceDisabledGets appearance settings used to paint the editor when it is disabled.
AppearanceFocusedGets appearance settings used to paint the current editor when it is focused.
AppearanceReadOnlyGets appearance settings used to paint the read-only editor.
AutoHeightGets or sets a value specifying whether the editor’s height is calculated automatically to fit the editor’s content.
BestFitWidthGets or sets the editor’s best fit width.
BorderStyleGets or sets the editor’s border style.
CanRaiseEvents protectedGets a value indicating whether the component can raise an event. Inherited from Component.
ContainerGets the IContainer that contains the Component. Inherited from Component.
ContextMenuGets or sets the context menu for the editor.
DefaultAlignmentGets the default horizontal alignment of the editor’s content.
DefaultBorderStyleInBarsThis member supports the internal infrastructure, and is not intended to be used directly from your code.
DefaultBorderStyleInGridThis member supports the internal infrastructure, and is not intended to be used directly from your code.
DesignMode protectedGets a value that indicates whether the Component is currently in design mode. Inherited from Component.
DisplayFormatGets format settings applied to the editor’s value.
EditableGets whether the editor’s value can be changed.
EditFormatProvides access to the settings used to format the edit value when the editor has input focus.
EditorTypeNameGets the class name of the editor corresponding to the repository item.
EditValueChangedDelayGets or sets the time interval between the moment when an end-user stops changing the editor’s value and the RepositoryItem.EditValueChanged event being raised.
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.
EditValueChangedFiringModeGets or sets the RepositoryItem.EditValueChanged event’s firing mode.
EnabledGets or sets a value indicating whether the edit control can respond to user actions. This property is supported for standalone editors.
Events protectedGets the list of event handlers that are attached to this Component. Inherited from Component.
ExportModeSpecifies whether the editor’s value or display text is exported when data is exported to XLS and CSV formats.
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.
InplaceModeImmediatePostChangesFor internal use. Gets or sets whether the in-place editor posts its value to the bound data source immediately after the value changes.
IsDesignModeIndicates whether the editor is currently in design mode.
IsDisposedGets a value indicating whether the control has been disposed of.
IsEditValueChangedEventPendingGets whether the EditValueChanged event is postponed.
IsFilterLookUpThis member supports the internal infrastructure, and is not intended to be used directly from your code.
IsLoadingIndicates whether the editor is being loaded.
IsLockUpdateGets a value indicating whether the editor is immediately updated in response to changing its settings.
IsNonSortableEditorThis member supports the internal infrastructure, and is not intended to be used directly from your code.
LinkCountGets the number of objects connected to the current repository item.
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.
NameGets or sets the repository item name.
NormalizeDisplayText staticSet the NormalizeDisplayText property to true to correctly process diacritics when selecting rows from a dropdown window in the LookUpEdit control.
NullTextGets or sets the text that presents the editor’s null value ( null , System.DBNull.Value and RepositoryItemDateEdit.NullDate - for DateEdit).
OwnerEditGets the editor that owns the repository item.
OwnerItemThis member supports the internal infrastructure, and is not intended to be used directly from your code.
PopupOffsetGets or sets the popup window’s location.
PropertiesObsolete. Gets an object providing properties specific to all editors that can be used inplace within a container control.
ReadOnlyGets or sets a value specifying whether the editor’s value can be changed by end-users.
RequireDisplayTextSortingThis member supports the .NET Framework infrastructure and is not intended to be used directly from your code.
SiteGets or sets a ISite for the object.
TagGets or sets the data associated with the repository item.
UseParentBackgroundThis member supports the internal infrastructure, and is not intended to be used directly from your code.
UseTextEditorForAutoFilterGets whether to substitute this editor with the single-line text editor in auto-filter rows.

Methods

NameDescription
Assign(RepositoryItem)Copies settings from the repository item specified as a parameter.
BeginInit()Notifies the editor that the initialization has been started.
BeginUpdate()Locks the RepositoryItem object by disallowing visual updates until the EndUpdate or CancelUpdate method is called.
CancelUpdate()Unlocks the RepositoryItem object after it has been locked by the BeginUpdate method, without causing an immediate visual update.
Clone()Creates a copy of the current repository item.
Connect(Object)Connects the repository item to the specified object.
CreateEditor()Creates an editor whose type corresponds to the repository item’s type.
CreateGroupPainter()Initializes a new instance of the DevExpress.XtraEditors.Drawing.BaseEditorGroupRowPainter class.
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.
CreateViewInfo()This member supports the editors library’s internal infrastructure and is not intended to be used in your applications.
Disconnect(Object)Removes the connection between the repository item and the specified object.
Dispose()Releases all resources used by the Component. Inherited from Component.
EndInit()Notifies the editor that the initialization has been completed.
EndUpdate()Unlocks the RepositoryItem object after a call to the BeginUpdate method and causes an immediate visual update.
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.
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.
GetDisplayText(Object)Returns the text representation of the specified value formatted using the editor’s settings.
GetEditorType()This member supports the internal infrastructure, and is not intended to be used directly from your code.
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.
GetHashCode()Returns a hash code.
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.
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.
IsLockDefaultImmediateUpdateRowPosition()This member supports the internal infrastructure, and is not intended to be used directly from your code.
IsNeededKey(Keys)Indicates whether the key is handled by the editor or the container control.
LockEvents()This method supports the .NET Framework infrastructure and is not intended to be called from your code.
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.
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.
SwitchMode()For internal use.
ToString()Returns a string that represents the current object.
UnLockEvents()This method supports the .NET Framework infrastructure and is not intended to be called from your code.

Events

NameDescription
ClickFires when clicking the editor.
CustomDisplayTextEnables custom display text to be provided for an editor.
DisposedOccurs when the component is disposed by a call to the Dispose() method. Inherited from Component.
DoubleClickFires when the editor is double clicked.
DragDropFires when an object is dropped onto the editor.
DragEnterFires when a dragged object enters the editor’s area.
DragLeaveFires when a dragged object leaves the editor’s area.
DragOverFires repeatedly when dragging an object over the editor.
EditValueChangedFires when the editor’s EditValue property changes.
EditValueChangingFires when the editor’s value is about to be changed.
EnterFires when the editor receives focus.
FormatEditValueEnables you to format the editor’s value (change the editor’s value when the formatting mechanism is invoked).
GiveFeedbackEnables you to specify the cursor appearance when dragging this editor’s data.
HelpRequestedFires when the end-user requests help for the editor.
KeyDownFires when a key is pressed while the editor has focus.
KeyPressFires when a character key is pressed while the editor has focus.
KeyUpFires when a key is released while the editor has focus.
LeaveFires when the editor loses focus.
ModifiedFires when the edit value is first changed since it was last validated.
MouseDownFires when a mouse button is pressed while the mouse pointer is over the editor.
MouseEnterFires when the mouse pointer enters the editor’s area.
MouseHoverFires when hot-tracking an editor element.
MouseLeaveFires when the mouse pointer leaves the editor’s area.
MouseMoveFires when the mouse pointer moves over the editor’s area.
MouseUpFires when the mouse button is released while the mouse pointer is over the editor.
MouseWheelFires when the mouse wheel moves while the mouse pointer is within the editor.
ParseEditValueConverts an input value (entered by a user or assigned in code) to the value that the editor will store.
PropertiesChangedFires immediately after a change to one of the editor’s properties.
QueryAccessibilityHelpFires when the help is provided to accessibility applications.
QueryContinueDragFires when dragging the editor’s data allowing you to specify whether dragging should be continued.
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.
ValidatingAllows you to specify whether the edit value is valid. This event does not occur if the editor’s CausesValidation property is disabled.

See Also

RepositoryItem Class

DevExpress.XtraEditors.Repository Namespace