C# Class ComponentFactory.Krypton.Ribbon.KryptonRibbonGroupTextBox

Inheritance: KryptonRibbonGroupItem

Show file Open project: ComponentFactory/Krypton Class Usage Examples

Private Properties

Property	Type	Description
CreateView	ViewBase
MonitorControl	void
OnControlEnter	void
OnControlLeave	void
OnDesignTimeContextMenu	void
OnPaletteNeedPaint	void
OnRibbonPaletteChanged	void
OnTextBoxAcceptsTabChanged	void
OnTextBoxGotFocus	void
OnTextBoxHideSelectionChanged	void
OnTextBoxKeyDown	void
OnTextBoxKeyPress	void
OnTextBoxKeyUp	void
OnTextBoxLostFocus	void
OnTextBoxModifiedChanged	void
OnTextBoxMultilineChanged	void
OnTextBoxPreviewKeyDown	void
OnTextBoxReadOnlyChanged	void
OnTextBoxTextAlignChanged	void
OnTextBoxTextChanged	void
ProcessCmdKey	bool
ShouldSerializeShortcutKeys	bool
UnmonitorControl	void

Public Methods

Method	Description
AppendText ( string text ) : void	Appends text to the current text of a rich text box.
Clear ( ) : void	Clears all text from the text box control.
ClearUndo ( ) : void	Clears information about the most recent operation from the undo buffer of the rich text box.
Copy ( ) : void	Copies the current selection in the text box to the Clipboard.
Cut ( ) : void	Moves the current selection in the text box to the Clipboard.
DeselectAll ( ) : void	Specifies that the value of the SelectionLength property is zero so that no characters are selected in the control.
GetCharFromPosition ( Point pt ) : int	Retrieves the character that is closest to the specified location within the control.
GetCharIndexFromPosition ( Point pt ) : int	Retrieves the index of the character nearest to the specified location.
GetFirstCharIndexFromLine ( int lineNumber ) : int	Retrieves the index of the first character of a given line.
GetFirstCharIndexOfCurrentLine ( ) : int	Retrieves the index of the first character of the current line.
GetLineFromCharIndex ( int index ) : int	Retrieves the line number from the specified character position within the text of the RichTextBox control.
GetPositionFromCharIndex ( int index ) : Point	Retrieves the location within the control at the specified character index.
Hide ( ) : void	Make the ribbon group textbox hidden.
KryptonRibbonGroupTextBox ( ) : System	Initialise a new instance of the KryptonRibbonGroupTextBox class.
Paste ( ) : void	Replaces the current selection in the text box with the contents of the Clipboard.
ResetShortcutKeys ( ) : void	Resets the ShortcutKeys property to its default value.
ScrollToCaret ( ) : void	Scrolls the contents of the control to the current caret position.
Select ( int start, int length ) : void	Selects a range of text in the control.
SelectAll ( ) : void	Selects all text in the control.
Show ( ) : void	Make the ribbon group textbox visible.
Undo ( ) : void	Undoes the last edit operation in the text box.

Protected Methods

Method	Description
Dispose ( bool disposing ) : void	Clean up any resources being used.
OnAcceptsTabChanged ( EventArgs e ) : void	Raises the AcceptsTabChanged event.
OnGotFocus ( EventArgs e ) : void	Raises the GotFocus event.
OnHideSelectionChanged ( EventArgs e ) : void	Raises the HideSelectionChanged event.
OnKeyDown ( KeyEventArgs e ) : void	Raises the KeyDown event.
OnKeyPress ( KeyPressEventArgs e ) : void	Raises the KeyPress event.
OnKeyUp ( KeyEventArgs e ) : void	Raises the KeyUp event.
OnLostFocus ( EventArgs e ) : void	Raises the LostFocus event.
OnModifiedChanged ( EventArgs e ) : void	Raises the ModifiedChanged event.
OnMultilineChanged ( EventArgs e ) : void	Raises the MultilineChanged event.
OnPreviewKeyDown ( PreviewKeyDownEventArgs e ) : void	Raises the PreviewKeyDown event.
OnPropertyChanged ( string propertyName ) : void	Raises the PropertyChanged event.
OnReadOnlyChanged ( EventArgs e ) : void	Raises the ReadOnlyChanged event.
OnTextAlignChanged ( EventArgs e ) : void	Raises the TextAlignChanged event.
OnTextChanged ( EventArgs e ) : void	Raises the TextChanged event.

Private Methods

Method	Description
CreateView ( KryptonRibbon ribbon, NeedPaintHandler needPaint ) : ViewBase
MonitorControl ( KryptonTextBox c ) : void
OnControlEnter ( object sender, EventArgs e ) : void
OnControlLeave ( object sender, EventArgs e ) : void
OnDesignTimeContextMenu ( MouseEventArgs e ) : void
OnPaletteNeedPaint ( object sender, NeedLayoutEventArgs e ) : void
OnRibbonPaletteChanged ( object sender, EventArgs e ) : void
OnTextBoxAcceptsTabChanged ( object sender, EventArgs e ) : void
OnTextBoxGotFocus ( object sender, EventArgs e ) : void
OnTextBoxHideSelectionChanged ( object sender, EventArgs e ) : void
OnTextBoxKeyDown ( object sender, KeyEventArgs e ) : void
OnTextBoxKeyPress ( object sender, KeyPressEventArgs e ) : void
OnTextBoxKeyUp ( object sender, KeyEventArgs e ) : void
OnTextBoxLostFocus ( object sender, EventArgs e ) : void
OnTextBoxModifiedChanged ( object sender, EventArgs e ) : void
OnTextBoxMultilineChanged ( object sender, EventArgs e ) : void
OnTextBoxPreviewKeyDown ( object sender, PreviewKeyDownEventArgs e ) : void
OnTextBoxReadOnlyChanged ( object sender, EventArgs e ) : void
OnTextBoxTextAlignChanged ( object sender, EventArgs e ) : void
OnTextBoxTextChanged ( object sender, EventArgs e ) : void
ProcessCmdKey ( Message &msg, Keys keyData ) : bool
ShouldSerializeShortcutKeys ( ) : bool
UnmonitorControl ( KryptonTextBox c ) : void

Method Details

AppendText() public method

Appends text to the current text of a rich text box.

public AppendText ( string text ) : void
text	string	The text to append to the current contents of the text box.
return	void

Clear() public method

Clears all text from the text box control.

public Clear ( ) : void
return	void

ClearUndo() public method

Clears information about the most recent operation from the undo buffer of the rich text box.

public ClearUndo ( ) : void
return	void

Copy() public method

Copies the current selection in the text box to the Clipboard.

public Copy ( ) : void
return	void

Cut() public method

Moves the current selection in the text box to the Clipboard.

public Cut ( ) : void
return	void

DeselectAll() public method

Specifies that the value of the SelectionLength property is zero so that no characters are selected in the control.

public DeselectAll ( ) : void
return	void

Dispose() protected method

Clean up any resources being used.

protected Dispose ( bool disposing ) : void
disposing	bool	true if managed resources should be disposed; otherwise, false.
return	void

GetCharFromPosition() public method

Retrieves the character that is closest to the specified location within the control.

public GetCharFromPosition ( Point pt ) : int
pt	Point	The location from which to seek the nearest character.
return	int

GetCharIndexFromPosition() public method

Retrieves the index of the character nearest to the specified location.

public GetCharIndexFromPosition ( Point pt ) : int
pt	Point	The location to search.
return	int

GetFirstCharIndexFromLine() public method

Retrieves the index of the first character of a given line.

public GetFirstCharIndexFromLine ( int lineNumber ) : int
lineNumber	int	The line for which to get the index of its first character.
return	int

GetFirstCharIndexOfCurrentLine() public method

Retrieves the index of the first character of the current line.

public GetFirstCharIndexOfCurrentLine ( ) : int
return	int

GetLineFromCharIndex() public method

Retrieves the line number from the specified character position within the text of the RichTextBox control.

public GetLineFromCharIndex ( int index ) : int
index	int	The character index position to search.
return	int

GetPositionFromCharIndex() public method

Retrieves the location within the control at the specified character index.

public GetPositionFromCharIndex ( int index ) : Point
index	int	The index of the character for which to retrieve the location.
return	Point

Hide() public method

Make the ribbon group textbox hidden.

public Hide ( ) : void
return	void

KryptonRibbonGroupTextBox() public method

Initialise a new instance of the KryptonRibbonGroupTextBox class.

public KryptonRibbonGroupTextBox ( ) : System
return	System

OnAcceptsTabChanged() protected method

Raises the AcceptsTabChanged event.

protected OnAcceptsTabChanged ( EventArgs e ) : void
e	EventArgs	An EventArgs containing the event data.
return	void

OnGotFocus() protected method

Raises the GotFocus event.

protected OnGotFocus ( EventArgs e ) : void
e	EventArgs	An EventArgs containing the event data.
return	void

OnHideSelectionChanged() protected method

Raises the HideSelectionChanged event.

protected OnHideSelectionChanged ( EventArgs e ) : void
e	EventArgs	An EventArgs that contains the event data.
return	void

OnKeyDown() protected method

Raises the KeyDown event.

protected OnKeyDown ( KeyEventArgs e ) : void
e	KeyEventArgs	An KeyEventArgs containing the event data.
return	void

OnKeyPress() protected method

Raises the KeyPress event.

protected OnKeyPress ( KeyPressEventArgs e ) : void
e	KeyPressEventArgs	An KeyPressEventArgs containing the event data.
return	void

OnKeyUp() protected method

Raises the KeyUp event.

protected OnKeyUp ( KeyEventArgs e ) : void
e	KeyEventArgs	An KeyEventArgs containing the event data.
return	void

OnLostFocus() protected method

Raises the LostFocus event.

protected OnLostFocus ( EventArgs e ) : void
e	EventArgs	An EventArgs containing the event data.
return	void

OnModifiedChanged() protected method

Raises the ModifiedChanged event.

protected OnModifiedChanged ( EventArgs e ) : void
e	EventArgs	An EventArgs that contains the event data.
return	void

OnMultilineChanged() protected method

Raises the MultilineChanged event.

protected OnMultilineChanged ( EventArgs e ) : void
e	EventArgs	An EventArgs that contains the event data.
return	void

OnPreviewKeyDown() protected method

Raises the PreviewKeyDown event.

protected OnPreviewKeyDown ( PreviewKeyDownEventArgs e ) : void
e	PreviewKeyDownEventArgs	An PreviewKeyDownEventArgs containing the event data.
return	void

OnPropertyChanged() protected method

Raises the PropertyChanged event.

protected OnPropertyChanged ( string propertyName ) : void
propertyName	string	Name of property that has changed.
return	void

OnReadOnlyChanged() protected method

Raises the ReadOnlyChanged event.

protected OnReadOnlyChanged ( EventArgs e ) : void
e	EventArgs	An EventArgs that contains the event data.
return	void

OnTextAlignChanged() protected method

Raises the TextAlignChanged event.

protected OnTextAlignChanged ( EventArgs e ) : void
e	EventArgs	An EventArgs containing the event data.
return	void

OnTextChanged() protected method

Raises the TextChanged event.

protected OnTextChanged ( EventArgs e ) : void
e	EventArgs	An EventArgs containing the event data.
return	void

Paste() public method

Replaces the current selection in the text box with the contents of the Clipboard.

public Paste ( ) : void
return	void

ResetShortcutKeys() public method

Resets the ShortcutKeys property to its default value.

public ResetShortcutKeys ( ) : void
return	void

ScrollToCaret() public method

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

public ScrollToCaret ( ) : void
return	void

Select() public method

Selects a range of text in the control.

public Select ( int start, int length ) : void
start	int	The position of the first character in the current text selection within the text box.
length	int	The number of characters to select.
return	void

SelectAll() public method

Selects all text in the control.

public SelectAll ( ) : void
return	void

Show() public method

Make the ribbon group textbox visible.

public Show ( ) : void
return	void

Undo() public method

Undoes the last edit operation in the text box.

public Undo ( ) : void
return	void