Back to Devexpress

RepositoryItemRatingControl Members

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

latest44.6 KB
Original Source

RepositoryItemRatingControl Members

Provides access to advanced RatingControl settings.

Constructors

NameDescription
RepositoryItemRatingControl()Initializes a new instance of the RepositoryItemRatingControl class with the default settings.

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.
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.
AllowHtmlDrawGets or sets whether this RatingControl‘s text can be formatted using HTML tags.
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.
AllowMouseWheelGets or sets whether value scrolling via the Mouse Wheel is supported by the editor. Inherited from RepositoryItem.
AppearanceGets appearance settings used to paint the editor when it is enabled. Inherited from RepositoryItem.
AppearanceDisabledGets appearance settings used to paint the editor when it is disabled. Inherited from RepositoryItem.
AppearanceFocusedGets appearance settings used to paint the current editor when it is focused. Inherited from RepositoryItem.
AppearanceReadOnlyGets appearance settings used to paint the read-only editor. Inherited from RepositoryItem.
AutoHeightGets or sets whether the RatingControl height should be calculated automatically.
AutoSizeGets or sets whether this RatingControl should be automatically sized.
BestFitWidthGets or sets the editor’s best fit width. Inherited from RepositoryItem.
BorderStyleGets or sets the this RatingControl‘s border style.
CanRaiseEvents protectedGets a value indicating whether the component can raise an event. Inherited from Component.
CheckedGlyphGets or sets an image, displayed by a RatingControl item when this item is checked (selected).
ContainerGets the IContainer that contains the Component. Inherited from Component.
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.
DisplayFormatGets format settings applied to the editor’s value. Inherited from RepositoryItem.
EditableGets whether the editor’s value can be changed. Inherited from RepositoryItem.
EditFormatProvides access to the settings used to format the edit value when the editor has input focus. Inherited from RepositoryItem.
EditorTypeNameReturns the textual representation of the type of the editor that owns this RepositoryItemRatingControl object.
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. Inherited from RepositoryItem.
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.
EditValueChangedFiringModeGets or sets the RepositoryItem.EditValueChanged event’s firing mode. Inherited from RepositoryItem.
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.
ExportModeSpecifies whether the editor’s value or display text is exported when data is exported to XLS and CSV formats. Inherited from RepositoryItem.
FillPrecisionGets or sets whether partly checked glyphs are enabled.
FirstItemValueGets or sets the value assigned to the first RatingControl item.
GlyphGets or sets the regular rating glyph.
HoverGlyphGets or sets the image displayed by hovered items within this RatingControl.
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.
InplaceModeImmediatePostChangesGets 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. Inherited from RepositoryItem.
IsDirectionReversedGets or sets whether this RatingControl measures its rating in the opposite direction.
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.
ItemCountGets or sets the number of rating items within this RatingControl.
ItemIndentGets or sets the distance between neighboring rating items.
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.
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.
OwnerEditGets the editor that owns the repository item. Inherited from RepositoryItem.
OwnerItemThis member supports the internal infrastructure, and is not intended to be used directly from your code. Inherited from RepositoryItem.
PaddingGets or sets this RatingControl‘s padding.
PopupOffsetGets or sets the popup window’s location. Inherited from RepositoryItem.
PropertiesObsolete. This member supports the internal infrastructure, and is not intended to be used directly from your code.
RatingAlignmentObsolete. Gets or sets the rating items’ alignment within the RatingControl.
RatingLocationGets or sets the rating item positioning within this RatingControl.
RatingOrientationGets or sets the rating items’ orientation within the RatingControl.
ReadOnlyGets or sets a value specifying whether the editor’s value can be changed by end-users. Inherited from RepositoryItem.
RequireDisplayTextSortingThis member supports the .NET Framework infrastructure and is not intended to be used directly from your code. Inherited from RepositoryItem.
ShowTextGets or sets whether the text assigned to the RatingControl.Text property should be visible.
ShowToolTipsGets or sets whether a tooltip should be displayed when the mouse pointer is over the control.
SiteGets or sets a ISite for the object. Inherited from RepositoryItem.
TagGets or sets the data associated with the repository item. Inherited from RepositoryItem.
TextLocationGets or sets the RepositoryItemRatingControl‘s text position relative to the rating items.
TextToRatingIndentGets or sets the distance between the RatingControl‘s rating items and this control’s text.
UseParentBackgroundThis member supports the internal infrastructure, and is not intended to be used directly from your code. Inherited from RepositoryItem.
UseTextEditorForAutoFilterGets whether to substitute this editor with the single-line text editor in auto-filter rows. Inherited from RepositoryItem.
ValueIntervalGets or sets the difference in two neighboring rating items’ values.

Methods

NameDescription
Assign(RepositoryItem)Copies all the settings from the target RepositoryItem to this RepositoryItemRatingControl.
BeginInit()Notifies the editor that the initialization has been started. Inherited from RepositoryItem.
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.
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.
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 this RatingControl should be printed.
GetDisplayText(FormatInfo, Object)
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.
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.
SwitchMode()For internal use. Inherited from RepositoryItem.
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
BeforeShowToolTipOccurs when the mouse pointer hovers over a rating scale item and allows you to display a unique hint for that item.
ClickFires when clicking the editor. Inherited from RepositoryItem.
CustomDisplayTextEnables custom display text to be provided for an editor. Inherited from RepositoryItem.
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.
ItemClickFires whenever an end-user clicks a rating item within this RatingControl.
ItemMouseOutOccurs when the mouse pointer leaves the rating item’s bounds.
ItemMouseOverOccurs when an end-user hovers a rating item within this RatingControl.
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.
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.
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

RepositoryItemRatingControl Class

DevExpress.XtraEditors.Repository Namespace