Back to Devexpress

RichEditControl Properties

wpf-devexpress-dot-xpf-dot-richedit-dot-richeditcontrol-dot-underscore-properties.md

latest65.8 KB
Original Source

RichEditControl Properties

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

NameDescription
ActiveViewGets the View currently used in the RichEditControl to display the document.
ActiveViewTypeGets or sets the type of the View , currently used by the RichEditControl to show the document. This is a dependency property.
ActualHeightGets the rendered height of this element. Inherited from FrameworkElement.
ActualWidthGets the rendered width of this element. Inherited from FrameworkElement.
AllowDropGets or sets a value indicating whether this element can be used as the target of a drag-and-drop operation. This is a dependency property. Inherited from UIElement.
AnnotationOptionsProvides access to options for displaying annotations in a document. This is a dependency property.
AreAnyTouchesCapturedGets a value that indicates whether at least one touch is captured to this element. Inherited from UIElement.
AreAnyTouchesCapturedWithinGets a value that indicates whether at least one touch is captured to this element or to any child elements in its visual tree. Inherited from UIElement.
AreAnyTouchesDirectlyOverGets a value that indicates whether at least one touch is pressed over this element. Inherited from UIElement.
AreAnyTouchesOverGets a value that indicates whether at least one touch is pressed over this element or any child elements in its visual tree. Inherited from UIElement.
AuthenticationOptionsGets or sets the identity parameters for range editing permissions. This is a dependency property.
AutoBackgroundSpecifies the default color value that is used when the background color is set to Auto. This is a dependency property.
AutoCorrectOptionsProvides access to an object used to configure autocorrect features. This is a dependency property.
AutoForegroundSpecifies the default color value that is used when the foreground color is set to Auto. This is a dependency property.
AutoSizeModeFor internal use.
BackgroundGets or sets a brush that describes the background of a control. Inherited from Control.
BarManagerGets or sets the main component that provides the Bars functionality. This is a dependency property.
BehaviorOptionsGets or sets the options for applying restrictions on different editor operations. This is a dependency property.
BindingGroupGets or sets the BindingGroup that is used for the element. Inherited from FrameworkElement.
BitmapEffectGets or sets a bitmap effect that applies directly to the rendered content for this element. This is a dependency property. Inherited from UIElement.
BitmapEffectInputGets or sets an input source for the bitmap effect that applies directly to the rendered content for this element. This is a dependency property. Inherited from UIElement.
BookmarkOptionsGets or sets the options for document bookmarks. This is a dependency property.
BorderBrushGets or sets a brush that describes the border background of a control. Inherited from Control.
BorderThicknessGets or sets the border thickness of a control. Inherited from Control.
CacheModeGets or sets a cached representation of the UIElement. Inherited from UIElement.
CanRedoIndicates whether there are actions that occurred recently within the control that can be reapplied.
CanUndoIndicates whether the user can undo the previous operation.
CharCountGets the number of characters in a document.
CharsCountObsolete. Gets the number of characters in the document.
ClipGets or sets the geometry used to define the outline of the contents of an element. This is a dependency property. Inherited from UIElement.
ClipboardFormatOptionsGets or sets an object used to specify the data formats available on the Clipboard. This is a dependency property.
ClipToBoundsGets or sets a value indicating whether to clip the content of this element (or content coming from the child elements of this element) to fit into the size of the containing element. This is a dependency property. Inherited from UIElement.
CommandBarStyleGets or sets the command bar for the RichEditControl. This is a dependency property.
CommandBindingsGets a collection of CommandBinding objects associated with this element. A CommandBinding enables command handling for this element, and declares the linkage between a command, its events, and the handlers attached by this element. Inherited from UIElement.
CommandProviderGets or sets a RichEditControl’s command provider. This is a dependency property.
CommentOptionsGets or sets the options for displaying comments in the document. This is a dependency property.
ContentGets or sets the control’s content. This is a dependency property.
ContextMenuGets or sets the context menu element that should appear whenever the context menu is requested through user interface (UI) from within this element. Inherited from FrameworkElement.
CopyPasteOptionsGets or sets the options affecting certain copy-paste scenarios. This is a dependency property.
CornerBoxVisibilityGets or sets whether the corner box element is displayed. This is a dependency property.
CursorGets or sets the cursor that displays when the mouse pointer is over this element. Inherited from FrameworkElement.
DataContextGets or sets the data context for an element when it participates in data binding. Inherited from FrameworkElement.
DefaultStyleKey protectedGets or sets the key to use to reference the style for this control, when theme styles are used or defined. Inherited from FrameworkElement.
DefaultViewTypeGets the default view type used by the RichEdit control.
DependencyObjectTypeGets the DependencyObjectType that wraps the CLR type of this instance. Inherited from DependencyObject.
DesiredSizeGets the size that this element computed during the measure pass of the layout process. Inherited from UIElement.
DispatcherGets the Dispatcher this DispatcherObject is associated with. Inherited from DispatcherObject.
DocBytesGets or sets the document content as an array of bytes in DOC (Microsoft Word 97-2003) format.
DocmBytesGets or sets the document content as an array of bytes in DOCM (Microsoft Word 97-2003 Macro-Enabled) format.
DocumentProvides access to a Document interface representing the control’s document.
DocumentCapabilitiesOptionsGets or sets an object used to configure document restrictions. This is a dependency property.
DocumentLayoutProvides access to Layout API.
DocumentLoaderGets or sets the object that provides the IRichEditDocumentLoader interface and can be used to load a document.
DocumentSaveOptionsGets or sets an object used to specify the control’s document saving options. This is a dependency property.
DocumentSourceGets or sets a document supplier for RichEditControl. This is a dependency property.
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 as an array of bytes in DOT (Microsoft Word 97-2003 Template) format.
DotmBytesGets or sets the document content as an array of bytes in DOTM (Microsoft Word 97-2003 Macro-Enabled Template) format.
DotxBytesGets or sets the document content as an array of bytes in DOTX (Microsoft Word Template) format.
DpiXGets the current dpi value for the X-coordinate.
DpiYGets the current dpi value for the Y-coordinate.
EffectGets or sets the bitmap effect to apply to the UIElement. This is a dependency property. Inherited from UIElement.
ExportOptionsProvides access to options used to export the document to different formats. This is a dependency property.
FieldOptionsGets or sets the options specific to document fields. This is a dependency property.
FlatOpcBytesGets or sets the document content as an array of bytes in FlatOpc (Microsoft Word XML Document, .xml) format.
FlatOpcMacroEnabledBytesGets or sets the document content as an array of bytes in FlatOpcMacroEnabled (Microsoft Word Macro-Enabled XML Document, .xml) format.
FlatOpcMacroEnabledTemplateBytesGets or sets the document content as an array of bytes in FlatOpcMacroEnabledTemplate (Microsoft Word Macro-Enabled XML Template, .xml) format.
FlatOpcTemplateBytesGets or sets the document content as an array of bytes in FlatOpcTemplate (Microsoft Word XML Template, .xml) format.
FlowDirectionGets or sets the direction that text and other user interface (UI) elements flow within any parent element that controls their layout. Inherited from FrameworkElement.
FocusableGets or sets a value that indicates whether the element can receive focus. This is a dependency property. Inherited from UIElement.
FocusElementGets the element with logical focus.
FocusVisualStyleGets or sets a property that enables customization of appearance, effects, or other style characteristics that will apply to this element when it captures keyboard focus. Inherited from FrameworkElement.
FontFamilyGets or sets the font family of the control. Inherited from Control.
FontSizeGets or sets the font size. Inherited from Control.
FontStretchGets or sets the degree to which a font is condensed or expanded on the screen. Inherited from Control.
FontStyleGets or sets the font style. Inherited from Control.
FontWeightGets or sets the weight or thickness of the specified font. Inherited from Control.
ForceCursorGets or sets a value that indicates whether this FrameworkElement should force the user interface (UI) to render the cursor as declared by the Cursor property. Inherited from FrameworkElement.
ForegroundGets or sets a brush that describes the foreground color. Inherited from Control.
FormattingMarkVisibilityOptionsGets or sets the options for displaying the formatting marks. This is a dependency property.
HandlesScrolling protectedGets a value that indicates whether a control supports scrolling. Inherited from Control.
HandleWindowCloseGets or sets whether RichEditControl should be disposed of when a window is closed.
HasAnimatedPropertiesGets a value indicating whether this element has any animated properties. Inherited from UIElement.
HasEffectiveKeyboardFocus protectedGets a value that indicates whether the UIElement has focus. Inherited from UIElement.
HasToolTipThis member supports the internal infrastructure and is not intended to be used directly from your code.
HeightGets or sets the suggested height of the element. Inherited from FrameworkElement.
HorizontalAlignmentGets or sets the horizontal alignment characteristics applied to this element when it is composed within a parent element, such as a panel or items control. Inherited from FrameworkElement.
HorizontalContentAlignmentGets or sets the horizontal alignment of the control’s content. Inherited from Control.
HorizontalRulerThis member supports the internal infrastructure and is not intended to be used directly from your code.
HorizontalRulerOptionsGets or sets the options specific to the RichEditControl horizontal ruler element. This is a dependency property.
HorizontalRulerVisibilityFor internal use only. To specify whether the horizontal ruler is displayed, use the DXRichEditHorizontalRulerOptions.Visibility property.
HorizontalScrollBarProvides access to a horizontal scroll bar of the RichEditControl.
HorizontalScrollBarVisibilityGets or sets whether the horizontal scroll bar is displayed. This is a dependency property.
HorizontalScrollValueGets or sets the current position of the scroll bar box on the horizontal scroll bar. This is a dependency property.
HoverMenuCalculatorThis member supports the internal infrastructure and is not intended to be used directly from your code.
HtmlTextGets or sets the control’s content as HTML text.
HyperlinkOptionsGets or sets the options specific to hyperlinks. This is a dependency property.
HyphenationDictionariesProvides access to the collection of hyphenation dictionaries.
ImportOptionsProvides access to options used to import the document from different formats. This is a dependency property.
InheritanceBehavior protectedGets or sets the scope limits for property value inheritance, resource key lookup, and RelativeSource FindAncestor lookup. Inherited from FrameworkElement.
InputBindingsGets the collection of input bindings associated with this element. Inherited from UIElement.
InputScopeGets or sets the context for input used by this FrameworkElement. Inherited from FrameworkElement.
IsArrangeValidGets a value indicating whether the computed size and position of child elements in this element’s layout are valid. Inherited from UIElement.
IsCaretVisibleGets or sets whether the caret is displayed.
IsEnabledGets or sets a value indicating whether this element is enabled in the user interface (UI). This is a dependency property. Inherited from UIElement.
IsEnabledCore protectedGets a value that becomes the return value of IsEnabled in derived classes. Inherited from UIElement.
IsFloatingObjectSelectedIndicates whether any floating object in the document is selected.
IsFocusedGets a value that determines whether this element has logical focus. This is a dependency property. Inherited from UIElement.
IsHitTestVisibleGets or sets a value that declares whether this element can possibly be returned as a hit test result from some portion of its rendered content. This is a dependency property. Inherited from UIElement.
IsInitializedGets a value that indicates whether this element has been initialized, either during processing by a XAML processor, or by explicitly having its EndInit() method called. Inherited from FrameworkElement.
IsInputMethodEnabledGets a value indicating whether an input method system, such as an Input Method Editor (IME), is enabled for processing the input to this element. Inherited from UIElement.
IsKeyboardFocusedGets a value indicating whether this element has keyboard focus. This is a dependency property. Inherited from UIElement.
IsKeyboardFocusWithinGets a value indicating whether keyboard focus is anywhere within the element or its visual tree child elements. This is a dependency property. Inherited from UIElement.
IsLoadedGets a value that indicates whether this element has been loaded for presentation. Inherited from FrameworkElement.
IsManipulationEnabledGets or sets a value that indicates whether manipulation events are enabled on this UIElement. Inherited from UIElement.
IsMeasureValidGets a value indicating whether the current size returned by layout measure is valid. Inherited from UIElement.
IsMouseCapturedGets a value indicating whether the mouse is captured to this element. This is a dependency property. Inherited from UIElement.
IsMouseCaptureWithinGets a value that determines whether mouse capture is held by this element or by child elements in its visual tree. This is a dependency property. Inherited from UIElement.
IsMouseDirectlyOverGets a value that indicates whether the position of the mouse pointer corresponds to hit test results, which take element compositing into account. This is a dependency property. Inherited from UIElement.
IsMouseOverGets a value indicating whether the mouse pointer is located over this element (including child elements in the visual tree). This is a dependency property. Inherited from UIElement.
IsSealedGets a value that indicates whether this instance is currently sealed (read-only). Inherited from DependencyObject.
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.
IsStylusCapturedGets a value indicating whether the stylus is captured by this element. This is a dependency property. Inherited from UIElement.
IsStylusCaptureWithinGets a value that determines whether stylus capture is held by this element, or an element within the element bounds and its visual tree. This is a dependency property. Inherited from UIElement.
IsStylusDirectlyOverGets a value that indicates whether the stylus position corresponds to hit test results, which take element compositing into account. This is a dependency property. Inherited from UIElement.
IsStylusOverGets a value indicating whether the stylus cursor is located over this element (including visual child elements). This is a dependency property. Inherited from UIElement.
IsTabStopGets or sets a value that indicates whether a control is included in tab navigation. Inherited from Control.
IsUpdateLockedReturns a value indicating whether the RichEditControl is locked for update.
IsVisibleGets a value indicating whether this element is visible in the user interface (UI). This is a dependency property. Inherited from UIElement.
KeyCodeConverterThis member supports the internal infrastructure and is not intended to be used directly from your code.
LanguageGets or sets localization/globalization language information that applies to an element. Inherited from FrameworkElement.
LayoutOptionsGets or sets an object used to set the options that affect the layout of the RichEditControl views. This is a dependency property.
LayoutTransformGets or sets a graphics transformation that should apply to this element when layout is performed. Inherited from FrameworkElement.
LayoutUnitGets or sets a unit of measure used for a control’s layout. Starting from v18.1, this property has no effect.
MailMergeOptionsObtains common mail merge options. This is a dependency property.
MarginGets or sets the outer margin of an element. Inherited from FrameworkElement.
MaxHeightGets or sets the maximum height constraint of the element. Inherited from FrameworkElement.
MaxWidthGets or sets the maximum width constraint of the element. Inherited from FrameworkElement.
MenuCustomizationsAllows you to customize the Rich Text Editor’s context menus. This is a dependency property.
MhtTextGets or sets the control’s content as MHT text.
MinHeightGets or sets the minimum height constraint of the element. Inherited from FrameworkElement.
MinWidthGets or sets the minimum width constraint of the element. Inherited from FrameworkElement.
ModelThis member supports the internal infrastructure, and is not intended to be used directly from your code.
ModifiedGets or sets a value that indicates that the RichEdit control content was modified since it was last saved.
NameGets or sets the identifying name of the element. The name provides a reference so that code-behind, such as event handler code, can refer to a markup element after it is constructed during processing by a XAML processor. Inherited from FrameworkElement.
OdtBytesGets or sets the document content as an array of bytes in Open Office Text (.odt) format.
OpacityGets or sets the opacity factor applied to the entire UIElement when it is rendered in the user interface (UI). This is a dependency property. Inherited from UIElement.
OpacityMaskGets or sets an opacity mask, as a Brush implementation that is applied to any alpha-channel masking for the rendered content of this element. This is a dependency property. Inherited from UIElement.
OpenDocumentBytesGets or sets the document 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 various options of the RichEditControl.
OverridesDefaultStyleGets or sets a value that indicates whether this element incorporates style properties from theme styles. Inherited from FrameworkElement.
OvertypeSpecifies whether the overtype mode is enabled for the RichEdit control.
PaddingGets or sets the padding inside a control. Inherited from Control.
ParagraphCountGets the number of paragraphs in a document.
ParagraphsCountObsolete. Gets the number of paragraphs in the document.
ParentGets the logical parent element of this element. Inherited from FrameworkElement.
PersistIdGets a value that uniquely identifies this element. Inherited from UIElement.
PlainTextObsolete. Gets the plain text content of the control. Use the Text property instead.
PrintingOptionsGets or sets the document printing options. This is a dependency property.
RangePermissionOptionsGets or sets the options specific to ranges with permission. This is a dependency property.
ReadOnlyGets or sets whether document modifications are prohibited.
RenderSizeGets (or sets) the final render size of this element. Inherited from UIElement.
RenderTransformGets or sets transform information that affects the rendering position of this element. This is a dependency property. Inherited from UIElement.
RenderTransformOriginGets or sets the center point of any possible render transform declared by RenderTransform, relative to the bounds of the element. This is a dependency property. Inherited from UIElement.
ResourcesGets or sets the locally-defined resource dictionary. Inherited from FrameworkElement.
RibbonGets or sets the Ribbon control containing command controls for use with the current RichEditControl.
RibbonActionsProvides access to the collection of actions when using an integrated Ribbon Command UI.
RtfTextGets or sets the formatted text content of the control.
SearchOptionsProvides access to an object used to specify parameters affecting a search in a document. This is a dependency property.
SearchPanelProvides access to a Search Panel of the RichEditControl.
SectionCountGets the number of sections in a document.
SectionsCountObsolete. Gets the number of sections in the document.
SelectionGets the plain text of the selected range.
SelectionRTFGets the formatted text of the selected range.
ShowBorderGets or sets whether to display the border of the RichEditControl. This is a dependency property.
ShowCaretInReadOnlyGets or sets whether the caret is displayed if the control is read-only.
ShowHoverMenuGets or sets whether the hover menu can be shown. This is a dependency property.
ShowReviewingPaneGets or sets whether the Reviewing Pane should be displayed. This is a dependency property.
SnapsToDevicePixelsGets or sets a value that determines whether rendering for this element should use device-specific pixel settings during rendering. This is a dependency property. Inherited from UIElement.
SpellCheckerGets or sets a spell checker component used with the RichEdit control.
SpellCheckerOptionsProvides access to the options which control how spell checking is performed. This is a dependency property.
StyleGets or sets the style used by this element when it is rendered. Inherited from FrameworkElement.
StylusPlugIns protectedGets a collection of all stylus plug-in (customization) objects associated with this element. Inherited from UIElement.
SurfaceThis member supports the internal infrastructure and is not intended to be used directly from your code.
TabIndexGets or sets a value that determines the order in which elements receive focus when the user navigates through controls by using the TAB key. Inherited from Control.
TableOptionsProvides access to an object used to specify options for the document tables. This is a dependency property.
TagGets or sets an arbitrary object value that can be used to store custom information about this element. Inherited from FrameworkElement.
TemplateGets or sets a control template. Inherited from Control.
TemplatedParentGets a reference to the template parent of this element. This property is not relevant if the element was not created through a template. Inherited from FrameworkElement.
TextGets or sets the plain text content of the control.
ToolTipGets or sets the tool-tip object that is displayed for this element in the user interface (UI). Inherited from FrameworkElement.
TouchesCapturedGets all touch devices that are captured to this element. Inherited from UIElement.
TouchesCapturedWithinGets all touch devices that are captured to this element or any child elements in its visual tree. Inherited from UIElement.
TouchesDirectlyOverGets all touch devices that are over this element. Inherited from UIElement.
TouchesOverGets all touch devices that are over this element or any child elements in its visual tree. Inherited from UIElement.
TriggersGets the collection of triggers established directly on this element, or in child elements. Inherited from FrameworkElement.
UidGets or sets the unique identifier (for localization) for this element. This is a dependency property. Inherited from UIElement.
UnitGets or sets a unit of measure used within the control.
UseBuiltInReviewingPaneGets or sets whether to use an integrated Reviewing Pane. This is a dependency property.
UseDeferredDataBindingNotificationsEnables you to fire data binding events immediately for several text properties, resolving issues with multiple RichEdit controls bound to the same data source.
UseGlyphRendering staticGets or sets whether to adjust glyph rendering.
UseLayoutRoundingGets or sets a value that indicates whether layout rounding should be applied to this element’s size and position during layout. Inherited from FrameworkElement.
VerticalAlignmentGets or sets the vertical alignment characteristics applied to this element when it is composed within a parent element such as a panel or items control. Inherited from FrameworkElement.
VerticalContentAlignmentGets or sets the vertical alignment of the control’s content. Inherited from Control.
VerticalRulerThis member supports the internal infrastructure and is not intended to be used directly from your code.
VerticalRulerOptionsGets or sets the object used to set the options specific to the RichEditCotnrol vertical ruler element. This is a dependency property.
VerticalRulerVisibilityFor internal use only. To specify whether the vertical ruler is displayed, use the DXRichEditVerticalRulerOptions.Visibility property.
VerticalScrollBarProvides access to a horizontal scroll bar of the RichEditControl.
VerticalScrollBarVisibilityGets or sets whether the vertical ruler is displayed. This is a dependency property.
VerticalScrollPositionObsolete. Gets or sets the top visible position in the scrolled document.
VerticalScrollValueGets or sets a numeric value that represents the current position of the scroll bar box on the vertical scroll bar. This is a dependency property.
ViewBoundsGets the bounds of the RichEditControl client region.
ViewsContains settings of the Views that are used to display a document in the RichEdit Control.
VisibilityGets or sets the user interface (UI) visibility of this element. This is a dependency property. Inherited from UIElement.
VisualBitmapEffect protectedGets or sets the BitmapEffect value for the Visual. Inherited from Visual.
VisualBitmapEffectInput protectedGets or sets the BitmapEffectInput value for the Visual. Inherited from Visual.
VisualBitmapScalingMode protectedGets or sets the BitmapScalingMode for the Visual. Inherited from Visual.
VisualCacheMode protectedGets or sets a cached representation of the Visual. Inherited from Visual.
VisualChildrenCount protectedGets the number of visual child elements within this element. Inherited from FrameworkElement.
VisualClearTypeHint protectedGets or sets the ClearTypeHint that determines how ClearType is rendered in the Visual. Inherited from Visual.
VisualClip protectedGets or sets the clip region of the Visual as a Geometry value. Inherited from Visual.
VisualEdgeMode protectedGets or sets the edge mode of the Visual as an EdgeMode value. Inherited from Visual.
VisualEffect protectedGets or sets the bitmap effect to apply to the Visual. Inherited from Visual.
VisualOffset protectedGets or sets the offset value of the visual object. Inherited from Visual.
VisualOpacity protectedGets or sets the opacity of the Visual. Inherited from Visual.
VisualOpacityMask protectedGets or sets the Brush value that represents the opacity mask of the Visual. Inherited from Visual.
VisualParent protectedGets the visual tree parent of the visual object. Inherited from Visual.
VisualScrollableAreaClip protectedGets or sets a clipped scrollable area for the Visual. Inherited from Visual.
VisualTextHintingMode protectedGets or sets the TextHintingMode of the Visual. Inherited from Visual.
VisualTextRenderingMode protectedGets or sets the TextRenderingMode of the Visual. Inherited from Visual.
VisualTransform protectedGets or sets the Transform value for the Visual. Inherited from Visual.
VisualXSnappingGuidelines protectedGets or sets the x-coordinate (vertical) guideline collection. Inherited from Visual.
VisualYSnappingGuidelines protectedGets or sets the y-coordinate (horizontal) guideline collection. Inherited from Visual.
WidthGets or sets the width of the element. Inherited from FrameworkElement.
WordCountGets the number of words in a document.
WordMLTextGets or sets the control’s content in WordProcessingML (Microsoft Office Word 2003 XML) format.
WordsCountObsolete. Gets the number of words in the current document.

See Also

RichEditControl Class

RichEditControl Members

DevExpress.Xpf.RichEdit Namespace