[]
        
(Showing Draft Content)

GrapeCity.Wpf.SpreadSheet.CellType.Editors.EditBase

EditBase Class

Represents the base class for the text editors control.

Namespace: GrapeCity.Wpf.SpreadSheet.CellType.Editors
Assembly: GrapeCity.Wpf.SpreadSheet.CellType.dll
Syntax
[Localizability(LocalizationCategory.Text)]
[TemplatePart(Name = "PART_ContentHost", Type = typeof(FrameworkElement))]
[TemplateVisualState(Name = "Disabled", GroupName = "CommonStates")]
[TemplateVisualState(Name = "ReadOnly", GroupName = "CommonStates")]
[TemplateVisualState(Name = "MouseOver", GroupName = "CommonStates")]
[TemplateVisualState(Name = "Normal", GroupName = "CommonStates")]
public abstract class EditBase : ControlBase, IAnimatable, IFrameworkInputElement, IInputElement, IQueryAmbient, IAddChild, ISupportInitialize
<Localizability(LocalizationCategory.Text)>
<TemplatePart(Name:="PART_ContentHost", Type:=GetType(FrameworkElement))>
<TemplateVisualState(Name:="Disabled", GroupName:="CommonStates")>
<TemplateVisualState(Name:="ReadOnly", GroupName:="CommonStates")>
<TemplateVisualState(Name:="MouseOver", GroupName:="CommonStates")>
<TemplateVisualState(Name:="Normal", GroupName:="CommonStates")>
Public MustInherit Class EditBase
    Inherits ControlBase
    Implements IAnimatable, IFrameworkInputElement, IInputElement, IQueryAmbient, IAddChild, ISupportInitialize

Constructors

Name Description
EditBase()

Initialize a new instance of the EditBase class.

Fields

Name Description
CaretBrushProperty

Indentifies the CaretBrush dependency property.

DisabledBackgroundProperty

Identifies the DisabledBackground dependency property.

DisabledForegroundProperty

Identifies the DisabledForeground dependency property.

EditModeProperty

Identifies the EditMode dependency property.

EditStatusChangedEvent

Identifies the EditStatusChanged routed event.

ExitOnLeftRightKeyProperty

Identifies the ExitOnLeftRightKey dependency property.

HideSelectionProperty

Identifies the HideSelection dependency property.

InvalidInputEvent

Identifies the InvalidInput routed event.

IsModifiedChangedEvent

Identifies the IsModifiedChanged routed event.

IsModifiedProperty

Identifies the IsModified dependency property.

IsOverwriteProperty

Identifies the IsOverwrite dependency property.

IsReadOnlyCaretVisibleProperty

Indentifies the IsReadOnlyCaretVisible dependency property.

IsReadOnlyProperty

Identifies the IsReadOnly dependency property.

KeyExitEvent

Identifies the KeyExit routed event.

SelectionBrushProperty

Indentifies the SelectionBrush dependency property.

SelectionChangedEvent

Identifies the SelectionChanged routed event.

SelectionOpacityProperty

Indentifies the SelectionOpacity dependency property.

TextChangedEvent

Identifies the TextChanged routed event.

TextDecorationsProperty

Identifies the TextDecorations dependency property.

TextProperty

Identifies the Text dependency property.

Properties

Name Description
CanUndo

Gets a value indicating whether the control can undo the previous operation in a control.

CaretBrush

Gets or sets the brush that is used to paint the caret of the editor control. This is a dependency property.

CaretIndex

Gets or sets the insertion position index of the caret.

DisabledBackground

Gets or sets a brush that describes the background of a control when it is disabled.

DisabledForeground

Gets or sets a brush that describes the foreground of a control when it is disabled.

EditMode

Gets or sets the edit mode of the control.

ExitOnLeftRightKey

Gets or sets whether the focus automatically moves to the previous or next tab ordering control when pressing the left, right arrow keys.

HideSelection

Gets or sets a value indicating whether hide selection when the control has no focus.

IsModified

Gets or sets a value that indicates that the control has been modified by the user since the control was created or its contents were last set.

IsOverwrite

Gets the current edit status of the control.

IsReadOnly

Gets or sets a value indicating whether this control is read only.

IsReadOnlyCaretVisible

Gets or sets a value that indicates whether a read-only editor control displays a cursor. This is a dependency property.

SelectedText

Gets or sets a value indicating the currently selected text in the control.

SelectionBrush

Gets or sets the brush that highlights the selected text. This is a dependency property.

SelectionLength

Gets or sets the number of characters selected in the control.

SelectionOpacity

Gets or sets the opacity factor of the GrapeCity.Windows.InputMan.Primitives.EditBase.SelectionBrush. This is a dependency property.

SelectionStart

Gets or sets the number of character's position started to select.

Text

Gets or sets the text associated with this control. This is a dependency property.

TextDecorations

Gets the text decorations to apply to the text box. This is a dependency property.

Methods

Name Description
AppendText(string)

Appends text to the current text of the edit control.

BeginInit()

Invoked when the initialization process for this element starts.

Clear()

Clear all text of the control.

ClearUndo()

Clears information about the most recent operation from the undo buffer of the control.

Copy()

Copies the current selection in the control to the Clipboard.

Cut()

Removes the current selection from the control and copies it to the Clipboard.

EndInit()

Invoked when the initialization process for the element ends.

OnEditStatusChanged(RoutedEventArgs)

Raise the EditStatusChanged event.

OnGotKeyboardFocus(KeyboardFocusChangedEventArgs)

Invoked when an unhandled System.Windows.Input.Keyboard.GotKeyboardFocus attached event reaches an element in its route that is derived from this class. Implement this method to add class handling for this event.

OnInitialized(EventArgs)

Raises the Initialized event. This method is invoked whenever IsInitialized is set to true internally.

OnInvalidInput(RoutedEventArgs)

Raises the InvalidInput event.

OnIsActiveChanged(RoutedEventArgs)

Invoked when an unhandled IsActiveChanged event is raised on this element. Implement this method to add class handling for this event.

OnIsModifiedChanged(RoutedEventArgs)

Raises the IsModifiedChanged event.

OnKeyExit(KeyExitEventArgs)

Raises the KeyExit event.

OnLostKeyboardFocus(KeyboardFocusChangedEventArgs)

Invoked when an unhandled System.Windows.Input.Keyboard.LostKeyboardFocus attached event reaches an element in its route that is derived from this class. Implement this method to add class handling for this event.

OnPropertyChanged(DependencyPropertyChangedEventArgs)

Invoked whenever the effective value of any dependency property on this FrameworkElement has been updated. The specific dependency property that changed is reported in the arguments parameter. Overrides System.Windows.DependencyObject.OnPropertyChanged(System.Windows.DependencyPropertyChangedEventArgs).

OnQueryCursor(QueryCursorEventArgs)

Invoked when an unhandled System.Windows.Input.Mouse.QueryCursor attached event reaches an element in its route that is derived from this class. Implement this method to add class handling for this event.

OnSelectionChanged(RoutedEventArgs)

Is called when the caret or current selection changes position.

OnTemplateChanged(ControlTemplate, ControlTemplate)

Called whenever the control's template changes.

OnTextChanged(TextChangedEventArgs)

Is called when content in this control changes.

OnTextChanging(TextChangingEventArgs)

Raises the TextChanging event.

OnTextInput(TextCompositionEventArgs)

Invoked when an unhandled System.Windows.Input.TextCompositionManager.TextInput attached event reaches an element in its route that is derived from this class. Implement this method to add class handling for this event.

Paste()

Pastes the contents of the Clipboard over the current selection in the control.

ScrollToCaret()

Scrolls the contents of the control to the current caret position.

Select(int, int)

Selects a range of text in the control.

SelectAll()

Selects all text of the control.

Undo()

Undoes the last edit operation in the control.

Events

Name Description
EditStatusChanged

Occurs when edit status changed.

InvalidInput

Occurs when input some invalid characters.

IsModifiedChanged

Occurs when IsModified property changed.

KeyExit

Occurs when input some special keys to make the control lose focus.

SelectionChanged

Occurs when the text selection has changed.

TextChanged

Occurs when content changes in the text element.

TextChanging

Occurs just before the text is changed in the control.