RepositoryItemRatingControl Members
Provides access to advanced RatingControl settings.Constructors
| Name | Description |
|---|---|
| RepositoryItemRatingControl() | Initializes a new instance of the RepositoryItemRatingControl class with the default settings. |
Properties
| Name | Description |
|---|---|
| AccessibleDefaultActionDescription | Gets or sets the default action description of the repository item for use by accessibility client applications. Inherited from RepositoryItem. |
| AccessibleDescription | Gets or sets the object’s description used by accessibility client applications. Inherited from RepositoryItem. |
| AccessibleName | Gets or sets the object’s name used by accessibility client applications. Inherited from RepositoryItem. |
| AccessibleRole | Gets or sets the object’s accessible role. Inherited from RepositoryItem. |
| AllowFocused | Gets or sets a value specifying whether the focus rectangle is displayed within the editor when it has focus. Inherited from RepositoryItem. |
| AllowFocusedAppearance | Gets a value which indicates whether the appearance settings used to paint the editor when it’s focused can be used. Inherited from RepositoryItem. |
| AllowHtmlDraw | Gets or sets whether this RatingControl‘s text can be formatted using HTML tags. |
| AllowInplaceAutoFilter | This member supports the internal infrastructure, and is not intended to be used directly from your code. Inherited from RepositoryItem. |
| AllowInplaceBorderPainter | This member supports the internal infrastructure, and is not intended to be used directly from your code. Inherited from RepositoryItem. |
| AllowMouseWheel | Gets or sets whether value scrolling via the Mouse Wheel is supported by the editor. Inherited from RepositoryItem. |
| Appearance | Gets the appearance settings used to paint the editor when it’s enabled. Inherited from RepositoryItem. |
| AppearanceDisabled | Gets the appearance settings used to paint the editor when it’s disabled. Inherited from RepositoryItem. |
| AppearanceFocused | Gets the appearance settings used to paint the current editor when it’s focused. Inherited from RepositoryItem. |
| AppearanceReadOnly | Gets the appearance settings used to paint the read-only editor. Inherited from RepositoryItem. |
| AutoHeight | Gets or sets whether the RatingControl height should be calculated automatically. |
| AutoSize | Gets or sets whether this RatingControl should be automatically sized. |
| BestFitWidth | Gets or sets the editor’s best fit width. Inherited from RepositoryItem. |
| BorderStyle | Gets or sets the this RatingControl‘s border style. |
| CanRaiseEvents protected | Gets a value indicating whether the component can raise an event. Inherited from Component. |
| CheckedGlyph | Gets or sets an image, displayed by a RatingControl item when this item is checked (selected). |
| Container | Gets the IContainer that contains the Component. Inherited from Component. |
| ContextMenu | Gets or sets the context menu for the editor. Inherited from RepositoryItem. |
| ContextMenuStrip | Gets or sets the shortcut menu for the editor. Inherited from RepositoryItem. |
| DefaultAlignment | Gets the default horizontal alignment of the editor’s content. Inherited from RepositoryItem. |
| DefaultBorderStyleInBars | This member supports the internal infrastructure, and is not intended to be used directly from your code. Inherited from RepositoryItem. |
| DefaultBorderStyleInGrid | This member supports the internal infrastructure, and is not intended to be used directly from your code. Inherited from RepositoryItem. |
| DesignMode protected | Gets a value that indicates whether the Component is currently in design mode. Inherited from Component. |
| DisplayFormat | Provides access to the format settings applied to the editor’s display text. These settings are in effect when the editor does not have input focus. Inherited from RepositoryItem. |
| Editable | Gets whether the editor’s value can be changed. Inherited from RepositoryItem. |
| EditFormat | Provides access to the settings used to format the edit value when the editor has input focus. Inherited from RepositoryItem. |
| EditorTypeName | Returns the textual representation of the type of the editor that owns this RepositoryItemRatingControl object. |
| EditValueChangedDelay | Gets 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 static | Gets 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. |
| EditValueChangedFiringMode | Gets or sets the RepositoryItem.EditValueChanged event’s firing mode. Inherited from RepositoryItem. |
| Enabled | Gets 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 protected | Gets the list of event handlers that are attached to this Component. Inherited from Component. |
| ExportMode | Specifies whether the editor’s value or display text is exported when data is exported to XLS and CSV formats. Inherited from RepositoryItem. |
| FillPrecision | Gets or sets whether partly checked glyphs are enabled. |
| FirstItemValue | Gets or sets the value assigned to the first RatingControl item. |
| Glyph | Gets or sets the regular rating glyph. |
| HoverGlyph | Gets or sets the image displayed by hovered items within this RatingControl. |
| HtmlImages | Gets 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. |
| IsDesignMode | Indicates whether the editor is currently in design mode. Inherited from RepositoryItem. |
| IsDirectionReversed | Gets or sets whether this RatingControl measures its rating in the opposite direction. |
| IsDisposed | Gets a value indicating whether the control has been disposed of. Inherited from RepositoryItem. |
| IsEditValueChangedEventPending | Gets whether the EditValueChanged event is postponed. Inherited from RepositoryItem. |
| IsFilterLookUp | This member supports the internal infrastructure, and is not intended to be used directly from your code. Inherited from RepositoryItem. |
| IsLoading | Indicates whether the editor is being loaded. Inherited from RepositoryItem. |
| IsLockUpdate | Gets a value indicating whether the editor is immediately updated in response to changing its settings. Inherited from RepositoryItem. |
| IsNonSortableEditor | This member supports the internal infrastructure, and is not intended to be used directly from your code. Inherited from RepositoryItem. |
| ItemCount | Gets or sets the number of rating items within this RatingControl. |
| ItemIndent | Gets or sets the distance between neighboring rating items. |
| LinkCount | Gets the number of objects connected to the current repository item. Inherited from RepositoryItem. |
| LookAndFeel | Provides 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. |
| Name | Gets or sets the repository item name. Inherited from RepositoryItem. |
| NormalizeDisplayText static | Set the NormalizeDisplayText property to true to correctly process diacritics when selecting rows from a dropdown window in the LookUpEdit control. Inherited from RepositoryItem. |
| NullText | Gets or sets the text that presents the editor’s null value (null, System.DBNull.Value and RepositoryItemDateEdit.NullDate - for DateEdit). Inherited from RepositoryItem. |
| OwnerEdit | Gets the editor that owns the repository item. Inherited from RepositoryItem. |
| OwnerItem | This member supports the internal infrastructure, and is not intended to be used directly from your code. Inherited from RepositoryItem. |
| Padding | Gets or sets this RatingControl‘s padding. |
| PopupOffset | Gets or sets the popup window’s location. Inherited from RepositoryItem. |
| Properties | Obsolete. This member supports the internal infrastructure, and is not intended to be used directly from your code. |
| RatingAlignment | Obsolete. Gets or sets the rating items’ alignment within the RatingControl. |
| RatingLocation | Gets or sets the rating item positioning within this RatingControl. |
| RatingOrientation | Gets or sets the rating items’ orientation within the RatingControl. |
| ReadOnly | Gets or sets a value specifying whether the editor’s value can be changed by end-users. Inherited from RepositoryItem. |
| RequireDisplayTextSorting | This member supports the .NET Framework infrastructure and is not intended to be used directly from your code. Inherited from RepositoryItem. |
| ShowText | Gets or sets whether the text assigned to the RatingControl.Text property should be visible. |
| ShowToolTips | Gets or sets whether a tooltip should be displayed when the mouse pointer is over the control. |
| Site | Gets or sets a ISite for the object. Inherited from RepositoryItem. |
| Tag | Gets or sets the data associated with the repository item. Inherited from RepositoryItem. |
| TextLocation | Gets or sets the RepositoryItemRatingControl‘s text position relative to the rating items. |
| TextToRatingIndent | Gets or sets the distance between the RatingControl‘s rating items and this control’s text. |
| UseParentBackground | This member supports the internal infrastructure, and is not intended to be used directly from your code. Inherited from RepositoryItem. |
| UseTextEditorForAutoFilter | Gets whether to substitute this editor with the single-line text editor in auto-filter rows. Inherited from RepositoryItem. |
| ValueInterval | Gets or sets the difference in two neighboring rating items’ values. |
Methods
| Name | Description |
|---|---|
| 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) static | Determines 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) static | This 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) static | This member supports the internal infrastructure, and is not intended to be used directly from your code. Inherited from RepositoryItem. |
| GetService(Type) protected | Returns 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() protected | Creates a shallow copy of the current Object. Inherited from Object. |
| MemberwiseClone(Boolean) protected | Creates a shallow copy of the current MarshalByRefObject object. Inherited from MarshalByRefObject. |
| ReferenceEquals(Object, Object) static | Determines 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. |
| SetCloned() | This member supports the internal infrastructure, and is not intended to be used directly from your code. Inherited from RepositoryItem. |
| SwitchMode() | 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
| Name | Description |
|---|---|
| BeforeShowToolTip | Occurs when the mouse pointer hovers over a rating scale item and allows you to display a unique hint for that item. |
| Click | Fires when clicking the editor. Inherited from RepositoryItem. |
| CustomDisplayText | Enables custom display text to be provided for an editor. Inherited from RepositoryItem. |
| Disposed | Occurs when the component is disposed by a call to the Dispose() method. Inherited from Component. |
| DoubleClick | Fires when the editor is double clicked. Inherited from RepositoryItem. |
| DragDrop | Fires when an object is dropped onto the editor. Inherited from RepositoryItem. |
| DragEnter | Fires when a dragged object enters the editor’s area. Inherited from RepositoryItem. |
| DragLeave | Fires when a dragged object leaves the editor’s area. Inherited from RepositoryItem. |
| DragOver | Fires repeatedly when dragging an object over the editor. Inherited from RepositoryItem. |
| EditValueChanged | Fires when the editor’s BaseEdit.EditValue property changes. Inherited from RepositoryItem. |
| EditValueChanging | Fires when the editor’s value is about to be changed. Inherited from RepositoryItem. |
| Enter | Fires when the editor receives focus. Inherited from RepositoryItem. |
| FormatEditValue | Enables you to format the editor’s value (change the editor’s value when the formatting mechanism is invoked). Inherited from RepositoryItem. |
| GiveFeedback | Enables you to specify the cursor appearance when dragging this editor’s data. Inherited from RepositoryItem. |
| HelpRequested | Fires when the end-user requests help for the editor. Inherited from RepositoryItem. |
| ItemClick | Fires whenever an end-user clicks a rating item within this RatingControl. |
| ItemMouseOut | Occurs when the mouse pointer leaves the rating item’s bounds. |
| ItemMouseOver | Occurs when an end-user hovers a rating item within this RatingControl. |
| KeyDown | Fires when a key is pressed while the editor has focus. Inherited from RepositoryItem. |
| KeyPress | Fires when a character key is pressed while the editor has focus. Inherited from RepositoryItem. |
| KeyUp | Fires when a key is released while the editor has focus. Inherited from RepositoryItem. |
| Leave | Fires when the editor loses focus. Inherited from RepositoryItem. |
| Modified | Fires when the edit value is first changed since it was last validated. Inherited from RepositoryItem. |
| MouseDown | Fires when a mouse button is pressed while the mouse pointer is over the editor. Inherited from RepositoryItem. |
| MouseEnter | Fires when the mouse pointer enters the editor’s area. Inherited from RepositoryItem. |
| MouseHover | Fires when hot-tracking an editor element. Inherited from RepositoryItem. |
| MouseLeave | Fires when the mouse pointer leaves the editor’s area. Inherited from RepositoryItem. |
| MouseMove | Fires when the mouse pointer moves over the editor’s area. Inherited from RepositoryItem. |
| MouseUp | Fires when the mouse button is released while the mouse pointer is over the editor. Inherited from RepositoryItem. |
| MouseWheel | Fires when the mouse wheel moves while the mouse pointer is within the editor. Inherited from RepositoryItem. |
| ParseEditValue | Converts an input value (entered by a user or assigned in code) to the value that the editor will store. Inherited from RepositoryItem. |
| PropertiesChanged | Fires immediately after a change to one of the editor’s properties. Inherited from RepositoryItem. |
| QueryAccessibilityHelp | Fires when the help is provided to accessibility applications. Inherited from RepositoryItem. |
| QueryContinueDrag | Fires when dragging the editor’s data allowing you to specify whether dragging should be continued. Inherited from RepositoryItem. |
| QueryProcessKey | Provides 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. |
| Validating | Allows 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