Back to Devexpress

RichEditControl Properties

windowsforms-devexpress-dot-xtrarichedit-dot-richeditcontrol-dot-underscore-properties.md

latest42.3 KB
Original Source

RichEditControl Properties

Represents a RichEdit control which is a container for the rich-text document providing all the necessary functionality.

NameDescription
AcceptsEscapeGets or sets a value indicating whether pressing the ESC key is processed by the RichEditControl.
AcceptsReturnGets or sets a value indicating whether pressing the RETURN key is processed by the RichEditControl.
AcceptsTabGets or sets a value indicating whether pressing the TAB key types a TAB character instead of moving the focus to the next control in the tab order.
AccessibilityObjectGets the AccessibleObject assigned to the control. Inherited from Control.
AccessibleDefaultActionDescriptionGets or sets the default action description of the control for use by accessibility client applications. Inherited from Control.
AccessibleDescriptionGets or sets the description of the control used by accessibility client applications. Inherited from Control.
AccessibleNameGets or sets the name of the control used by accessibility client applications. Inherited from Control.
AccessibleRoleGets or sets the accessible role of the control. Inherited from Control.
ActiveViewGets the View currently used by the RichEditControl to display the document.
ActiveViewTypeGets or sets the type of the RichEditControl’s View.
ActualDpiScaleFor internal use.
AllowDropGets or sets a value indicating whether the control allows drag-and-drop operations. This member supports the internal infrastructure and is not intended to be used directly from your code.
AnchorGets or sets the edges of the container to which a control is bound and determines how a control is resized with its parent. Inherited from Control.
AppearanceProvides access to the object containing appearance settings for the control.
AutoScrollOffsetGets or sets where this control is scrolled to in ScrollControlIntoView(Control). Inherited from Control.
AutoSizeThis property is not relevant for this class. Inherited from Control.
AutoSizeModeGets or sets whether the RichEditControl resizes to accommodate the displayed text.
BackColorThis property is not in effect for the RichEditControl class.
BackgroundImageThis property is not in effect for the RichEditControl class.
BackgroundImageLayoutThis property is not in effect for the RichEditControl class.
BindingContextGets or sets the BindingContext for the control. Inherited from Control.
BorderStyleGets or sets the border style for the RichEdit control.
BottomGets the distance, in pixels, between the bottom edge of the control and the top edge of its container’s client area. Inherited from Control.
BoundsGets or sets the size and location of the control including its nonclient elements, in pixels, relative to the parent control. Inherited from Control.
CanEnableIme protectedGets a value indicating whether the ImeMode property can be set to an active value, to enable IME support. Inherited from Control.
CanFocusGets a value indicating whether the control can receive focus. Inherited from Control.
CanRaiseEvents protectedDetermines if events can be raised on the control. Inherited from Control.
CanRedoIndicates whether there are actions that occurred recently within the control that can be reapplied.
CanSelectGets a value indicating whether the control can be selected. Inherited from Control.
CanUndoIndicates whether the user can undo the previous operation.
CaptureGets or sets a value indicating whether the control has captured the mouse. Inherited from Control.
CausesValidationGets or sets a value indicating whether the control causes validation to be performed on any controls that require validation when it receives focus. Inherited from Control.
CheckForIllegalCrossThreadCalls staticGets or sets a value indicating whether to catch calls on the wrong thread that access a control’s Handle property when an application is being debugged. Inherited from Control.
ClientRectangleGets the rectangle that represents the client area of the control. Inherited from Control.
ClientSizeGets or sets the height and width of the client area of the control. Inherited from Control.
CompanyNameGets the name of the company or creator of the application containing the control. Inherited from Control.
ContainerGets the IContainer that contains the Component. Inherited from Component.
ContainsFocusGets a value indicating whether the control, or one of its child controls, currently has the input focus. Inherited from Control.
ContextMenuGets or sets the shortcut menu associated with the control. Inherited from Control.
ControlsGets the collection of controls contained within the control. Inherited from Control.
CreatedGets a value indicating whether the control has been created. Inherited from Control.
CreateParams protectedGets the required creation parameters when the control handle is created. Inherited from Control.
CursorGets or sets the cursor that is displayed when the mouse pointer is over the control. Inherited from Control.
DataBindingsGets the data bindings for the control. Inherited from Control.
DefaultBackColor staticGets the default background color of the control. Inherited from Control.
DefaultCursor protectedGets or sets the default cursor for the control. Inherited from Control.
DefaultFont staticGets the default font of the control. Inherited from Control.
DefaultForeColor staticGets the default foreground color of the control. Inherited from Control.
DefaultImeMode protectedGets the default Input Method Editor (IME) mode supported by the control. Inherited from Control.
DefaultMargin protectedGets the space, in pixels, that is specified by default between controls. Inherited from Control.
DefaultMaximumSize protectedGets the length and height, in pixels, that is specified as the default maximum size of a control. Inherited from Control.
DefaultMinimumSize protectedGets the length and height, in pixels, that is specified as the default minimum size of a control. Inherited from Control.
DefaultPadding protectedGets the internal spacing, in pixels, of the contents of a control. Inherited from Control.
DefaultViewTypeGets the default view type used by the RichEdit control.
DesignMode protectedGets a value that indicates whether the Component is currently in design mode. Inherited from Component.
DisplayRectangleGets the rectangle that represents the display area of the control. Inherited from Control.
DisposingGets a value indicating whether the base Control class is in the process of disposing. Inherited from Control.
DocBytesGets or sets the document content as an array of bytes in Microsoft Word 97-2003 format (Doc) format.
DockGets or sets which control borders are docked to its parent control and determines how a control is resized with its parent. Inherited from Control.
DocmBytesGets or sets the document content in DOCM (Microsoft Office Open XML Macro-Enabled Document) format.
DocumentProvides access to a Document interface specifying the control’s document.
DocumentLayoutProvides access to Layout API.
DocumentViewDirectionSpecifies the page order in Print Layout view and in Print Preview.
DocxBytesGets or sets the control’s content as an array of bytes in Office Open XML (DOCX) format.
DotBytesGets or sets the document content in DOT (Microsoft Word 97-2003 Template) format.
DotmBytesGets or sets the document content in DOTM (Microsoft Office Open XML Macro-Enabled Template) format.
DotxBytesGets or sets the document content in DOTX (Microsoft Office Open XML Template) format.
DoubleBuffered protectedGets or sets a value indicating whether this control should redraw its surface using a secondary buffer to reduce or prevent flicker. Inherited from Control.
DpiXGets the current dpi value for the X-coordinate.
DpiYGets the current dpi value for the Y-coordinate.
DragDropModeGets or sets the drag-and-drop mode which is active in the RichEditControl.
EnabledGets or sets a value indicating whether the control can respond to user interaction. Inherited from Control.
EnableToolTipsGets or sets whether to display tooltips for data fields in documents.
Events protectedGets the list of event handlers that are attached to this Component. Inherited from Component.
FlatOpcBytesGets or sets the document content in FlatOpc (Microsoft Word XML Document) format.
FlatOpcMacroEnabledBytesGets or sets the document content in FlatOpcMacroEnabled (Microsoft Word XML Macro-Enabled Document) format.
FlatOpcMacroEnabledTemplateBytesGets or sets the document content in FlatOpcMacroEnabledTemplate (Microsoft Word XML Macro-Enabled Template) format.
FlatOpcTemplateBytesGets or sets the document content in FlatOpcTemplate (Microsoft Word XML Template ) format.
FocusedGets a value indicating whether the control has input focus. Inherited from Control.
FontGets or sets the font of the text that has no direct font formatting or style applied.
FontHeight protectedGets or sets the height of the font of the control. Inherited from Control.
ForeColorGets or sets the color of the text that has no direct font formatting or style applied.
HandleGets the window handle that the control is bound to. Inherited from Control.
HasChildrenGets a value indicating whether the control contains one or more child controls. Inherited from Control.
HeightGets or sets the height of the control. Inherited from Control.
HtmlTextGets or sets the control’s content as HTML text.
HyphenationDictionariesProvides access to the collection of hyphenation dictionaries.
ImeModeGets or sets the Input Method Editor (IME) mode of the control. Inherited from Control.
ImeModeBase protectedGets or sets the IME mode of a control. Inherited from Control.
InvokeRequiredGets a value indicating whether the caller must call an invoke method when making method calls to the control because the caller is on a different thread than the one the control was created on. Inherited from Control.
IsAccessibleGets or sets a value indicating whether the control is visible to accessibility applications. Inherited from Control.
IsDisposedGets a value indicating whether the control has been disposed of. Inherited from Control.
IsFloatingObjectSelectedIndicates whether any floating object in the document is selected.
IsHandleCreatedGets a value indicating whether the control has a handle associated with it. Inherited from Control.
IsMirroredGets a value indicating whether the control is mirrored. Inherited from Control.
IsPrintingAvailableIndicates whether the RichEditControl can be printed or exported.
IsSelectionInCommentIndicates whether the selection (CaretPosition) is located in a comment.
IsSelectionInFooterIndicates whether the selection (CaretPosition) is located in the document footer.
IsSelectionInHeaderIndicates whether the selection (CaretPosition) is located in the document header.
IsSelectionInHeaderOrFooterIndicates whether the selection (CaretPosition) is located in the main document or the header or footer.
IsSelectionInTextBoxIndicates whether the selection (CaretPosition) is located in a text box.
IsUpdateLockedReturns a value indicating whether the RichEditControl is locked for update.
LayoutEngineGets a cached instance of the control’s layout engine. Inherited from Control.
LayoutUnitGets or sets a unit of measure used for a document layout. Starting from v18.1, the property has no effect.
LeftGets or sets the distance, in pixels, between the left edge of the control and the left edge of its container’s client area. Inherited from Control.
LocationGets or sets the coordinates of the upper-left corner of the control relative to the upper-left corner of its container. Inherited from Control.
LookAndFeelProvides access to the settings that specify the RichEdit control’s look and feel.
MarginGets or sets the space between controls. Inherited from Control.
MaximumSizeGets or sets the size that is the upper limit that GetPreferredSize(Size) can specify. Inherited from Control.
MenuManagerGets or sets the menu manager which controls the look and feel of context menus.
MhtTextGets or sets the control’s content as MHT text.
MinimumSizeGets or sets the size that is the lower limit that GetPreferredSize(Size) can specify. Inherited from Control.
ModelFor internal use.
ModifiedGets or sets whether the control’s content was modified since it was last saved.
ModifierKeys staticGets a value indicating which of the modifier keys (SHIFT, CTRL, and ALT) is in a pressed state. Inherited from Control.
MouseButtons staticGets a value indicating which of the mouse buttons is in a pressed state. Inherited from Control.
MousePosition staticGets the position of the mouse cursor in screen coordinates. Inherited from Control.
NameGets or sets the name of the control. Inherited from Control.
OdtBytesGets or sets the control’s content as an array of bytes in Open Office Text (.odt) format.
OpenDocumentBytesGets or sets the control’s content as an array of bytes in Open Office Text (.odt) format.
OpenXmlBytesGets or sets the control’s content as an array of bytes in Office Open XML (Docx) format.
OptionsProvides access to the variety of options which can be specified for the RichEditControl.
OvertypeSpecifies whether or not the overtype mode is enabled for the RichEdit control.
PaddingGets or sets padding within the control. Inherited from Control.
ParentGets or sets the parent container of the control. Inherited from Control.
PreferredSizeGets the size of a rectangular area into which the control can fit. Inherited from Control.
ProductNameGets the product name of the assembly containing the control. Inherited from Control.
ProductVersionGets the version of the assembly containing the control. Inherited from Control.
PropagatingImeMode protected staticGets an object that represents a propagating IME mode. Inherited from Control.
ReadOnlyGets or sets whether document modifications are prohibited.
RecreatingHandleGets a value indicating whether the control is currently re-creating its handle. Inherited from Control.
RegionGets or sets the window region associated with the control. Inherited from Control.
RenderRightToLeft protectedThis property is now obsolete. Inherited from Control.
ResizeRedraw protectedGets or sets a value indicating whether the control redraws itself when resized. Inherited from Control.
RightGets the distance, in pixels, between the right edge of the control and the left edge of its container’s client area. Inherited from Control.
RightToLeftThis property is not in effect for the RichEditControl class.
RtfTextGets or sets the formatted text content of the control.
ShowCaretInReadOnlyGets or sets whether the caret is shown if a RichEditControl’s content is read-only.
ShowFocusCues protectedGets a value indicating whether the control should display focus rectangles. Inherited from Control.
ShowKeyboardCues protectedGets a value indicating whether the user interface is in the appropriate state to show or hide keyboard accelerators. Inherited from Control.
SiteGets or sets the site of the control. Inherited from Control.
SizeGets or sets the height and width of the control. Inherited from Control.
SpellCheckerGets or sets the component used for spelling check by the RichEdit control.
TabIndexGets or sets the tab order of the control within its container. Inherited from Control.
TabStopGets or sets a value indicating whether the user can give the focus to this control using the TAB key. Inherited from Control.
TagGets or sets the object that contains data about the control. Inherited from Control.
TextGets or sets the control’s content as a plain text.
ToolTipControllerGets or sets the tooltip controller component that controls the appearance, position and the content of the hints displayed by the RichEditControl.
TopGets or sets the distance, in pixels, between the top edge of the control and the top edge of its container’s client area. Inherited from Control.
TopLevelControlGets the parent control that is not parented by another Windows Forms control. Typically, this is the outermost Form that the control is contained in. Inherited from Control.
UnitGets or sets a measure unit used within the control.
UseDeferredDataBindingNotificationsEnables you to fire data binding events immediately for several text properties, resolving issues with multiple RichEdit controls bound to the same data source.
UseWaitCursorGets or sets a value indicating whether to use the wait cursor for the current control and all child controls. Inherited from Control.
VerticalScrollPositionObsolete. Gets or sets the top visible position in the scrolled document.
VerticalScrollValueGets or sets the top visible position in the scrolled document.
ViewsContains settings of the Views that are used to display a document in the RichEdit Control.
VisibleGets or sets a value indicating whether the control and all its child controls are displayed. Inherited from Control.
WidthGets or sets the width of the control. Inherited from Control.
WindowTargetThis property is not relevant for this class. Inherited from Control.
WordMLTextGets or sets the control’s content as the text in WordProcessingML (Microsoft Office Word 2003 XML) format.

See Also

RichEditControl Class

RichEditControl Members

DevExpress.XtraRichEdit Namespace