C# Class ComponentFactory.Krypton.Ribbon.KryptonRibbonGroupRichTextBox

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
OnRichTextBoxAcceptsTabChanged void
OnRichTextBoxGotFocus void
OnRichTextBoxHScroll void
OnRichTextBoxHideSelectionChanged void
OnRichTextBoxKeyDown void
OnRichTextBoxKeyPress void
OnRichTextBoxKeyUp void
OnRichTextBoxLinkClicked void
OnRichTextBoxLostFocus void
OnRichTextBoxModifiedChanged void
OnRichTextBoxMultilineChanged void
OnRichTextBoxPreviewKeyDown void
OnRichTextBoxProtected void
OnRichTextBoxReadOnlyChanged void
OnRichTextBoxSelectionChanged void
OnRichTextBoxTextChanged void
OnRichTextBoxVScroll 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.
CanPaste ( DataFormats clipFormat ) : bool

Determines whether you can paste information from the Clipboard in the specified data format.
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.
Find ( char characterSet ) : int

Searches the text of a RichTextBox control for the first instance of a character from a list of characters.
Find ( char characterSet, int start ) : int

Searches the text of a RichTextBox control, at a specific starting point, for the first instance of a character from a list of characters.
Find ( char characterSet, int start, int end ) : int

Searches a range of text in a RichTextBox control for the first instance of a character from a list of characters.
Find ( string str ) : int

Searches the text in a RichTextBox control for a string.
Find ( string str, RichTextBoxFinds options ) : int

Searches the text in a RichTextBox control for a string with specific options applied to the search.
Find ( string str, int start, RichTextBoxFinds options ) : int

Searches the text in a RichTextBox control for a string at a specific location within the control and with specific options applied to the search.
Find ( string str, int start, int end, RichTextBoxFinds options ) : int

Searches the text in a RichTextBox control for a string within a range of text within the control and with specific options applied to the search.
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 hidden.
KryptonRibbonGroupRichTextBox ( ) : System

Initialise a new instance of the KryptonRibbonGroupRichTextBox class.
LoadFile ( Stream data, RichTextBoxStreamType fileType ) : void

Loads the contents of an existing data stream into the RichTextBox control.
LoadFile ( string path ) : void

Loads a rich text format (RTF) or standard ASCII text file into the RichTextBox control.
LoadFile ( string path, RichTextBoxStreamType fileType ) : void

Loads a specific type of file into the RichTextBox control.
Paste ( ) : void

Replaces the current selection in the text box with the contents of the Clipboard.
Paste ( DataFormats clipFormat ) : void

Pastes the contents of the Clipboard in the specified Clipboard format.
Redo ( ) : void

Reapplies the last operation that was undone in the control.
ResetShortcutKeys ( ) : void

Resets the ShortcutKeys property to its default value.
SaveFile ( Stream data, RichTextBoxStreamType fileType ) : void

Saves the contents of a RichTextBox control to an open data stream.
SaveFile ( string path ) : void

Saves the contents of the RichTextBox to a rich text format (RTF) file.
SaveFile ( string path, RichTextBoxStreamType fileType ) : void

Saves the contents of the KryptonRichTextBox to a specific type of file.
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 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.
OnHScroll ( EventArgs e ) : void

Raises the HScroll 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.
OnLinkClicked ( System.Windows.Forms.LinkClickedEventArgs e ) : void

Raises the LinkClicked 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.
OnProtected ( EventArgs e ) : void

Raises the Protected event.
OnReadOnlyChanged ( EventArgs e ) : void

Raises the ReadOnlyChanged event.
OnSelectionChanged ( EventArgs e ) : void

Raises the SelectionChanged event.
OnTextChanged ( EventArgs e ) : void

Raises the TextChanged event.
OnVScroll ( EventArgs e ) : void

Raises the VScroll event.

Private Methods

Method Description
CreateView ( KryptonRibbon ribbon, NeedPaintHandler needPaint ) : ViewBase
MonitorControl ( KryptonRichTextBox 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
OnRichTextBoxAcceptsTabChanged ( object sender, EventArgs e ) : void
OnRichTextBoxGotFocus ( object sender, EventArgs e ) : void
OnRichTextBoxHScroll ( object sender, EventArgs e ) : void
OnRichTextBoxHideSelectionChanged ( object sender, EventArgs e ) : void
OnRichTextBoxKeyDown ( object sender, KeyEventArgs e ) : void
OnRichTextBoxKeyPress ( object sender, KeyPressEventArgs e ) : void
OnRichTextBoxKeyUp ( object sender, KeyEventArgs e ) : void
OnRichTextBoxLinkClicked ( object sender, System.Windows.Forms.LinkClickedEventArgs e ) : void
OnRichTextBoxLostFocus ( object sender, EventArgs e ) : void
OnRichTextBoxModifiedChanged ( object sender, EventArgs e ) : void
OnRichTextBoxMultilineChanged ( object sender, EventArgs e ) : void
OnRichTextBoxPreviewKeyDown ( object sender, PreviewKeyDownEventArgs e ) : void
OnRichTextBoxProtected ( object sender, EventArgs e ) : void
OnRichTextBoxReadOnlyChanged ( object sender, EventArgs e ) : void
OnRichTextBoxSelectionChanged ( object sender, EventArgs e ) : void
OnRichTextBoxTextChanged ( object sender, EventArgs e ) : void
OnRichTextBoxVScroll ( object sender, EventArgs e ) : void
ProcessCmdKey ( Message &msg, Keys keyData ) : bool
ShouldSerializeShortcutKeys ( ) : bool
UnmonitorControl ( KryptonRichTextBox 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

CanPaste() public method

Determines whether you can paste information from the Clipboard in the specified data format.
public CanPaste ( DataFormats clipFormat ) : bool
clipFormat System.Windows.Forms.DataFormats One of the System.Windows.Forms.DataFormats.Format values.
return bool

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

Find() public method

Searches the text of a RichTextBox control for the first instance of a character from a list of characters.
public Find ( char characterSet ) : int
characterSet char The array of characters to search for.
return int

Find() public method

Searches the text of a RichTextBox control, at a specific starting point, for the first instance of a character from a list of characters.
public Find ( char characterSet, int start ) : int
characterSet char The array of characters to search for.
start int The location within the control's text at which to begin searching.
return int

Find() public method

Searches a range of text in a RichTextBox control for the first instance of a character from a list of characters.
public Find ( char characterSet, int start, int end ) : int
characterSet char The array of characters to search for.
start int The location within the control's text at which to begin searching.
end int The location within the control's text at which to end searching.
return int

Find() public method

Searches the text in a RichTextBox control for a string.
public Find ( string str ) : int
str string The text to locate in the control.
return int

Find() public method

Searches the text in a RichTextBox control for a string with specific options applied to the search.
public Find ( string str, RichTextBoxFinds options ) : int
str string The text to locate in the control.
options RichTextBoxFinds A bitwise combination of the RichTextBoxFinds values.
return int

Find() public method

Searches the text in a RichTextBox control for a string at a specific location within the control and with specific options applied to the search.
public Find ( string str, int start, RichTextBoxFinds options ) : int
str string The text to locate in the control.
start int The location within the control's text at which to begin searching.
options RichTextBoxFinds A bitwise combination of the RichTextBoxFinds values.
return int

Find() public method

Searches the text in a RichTextBox control for a string within a range of text within the control and with specific options applied to the search.
public Find ( string str, int start, int end, RichTextBoxFinds options ) : int
str string The text to locate in the control.
start int The location within the control's text at which to begin searching.
end int The location within the control's text at which to end searching. This value must be equal to negative one (-1) or greater than or equal to the start parameter.
options RichTextBoxFinds A bitwise combination of the RichTextBoxFinds values.
return int

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 hidden.
public Hide ( ) : void
return void

KryptonRibbonGroupRichTextBox() public method

Initialise a new instance of the KryptonRibbonGroupRichTextBox class.
public KryptonRibbonGroupRichTextBox ( ) : System
return System

LoadFile() public method

Loads the contents of an existing data stream into the RichTextBox control.
public LoadFile ( Stream data, RichTextBoxStreamType fileType ) : void
data Stream A stream of data to load into the RichTextBox control.
fileType RichTextBoxStreamType One of the RichTextBoxStreamType values.
return void

LoadFile() public method

Loads a rich text format (RTF) or standard ASCII text file into the RichTextBox control.
public LoadFile ( string path ) : void
path string The name and location of the file to load into the control.
return void

LoadFile() public method

Loads a specific type of file into the RichTextBox control.
public LoadFile ( string path, RichTextBoxStreamType fileType ) : void
path string The name and location of the file to load into the control.
fileType RichTextBoxStreamType One of the RichTextBoxStreamType values.
return void

OnAcceptsTabChanged() protected method

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

OnGotFocus() protected method

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

OnHScroll() protected method

Raises the HScroll event.
protected OnHScroll ( EventArgs e ) : void
e System.EventArgs An EventArgs that contains the event data.
return void

OnHideSelectionChanged() protected method

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

OnKeyDown() protected method

Raises the KeyDown event.
protected OnKeyDown ( KeyEventArgs e ) : void
e System.Windows.Forms.KeyEventArgs An KeyEventArgs containing the event data.
return void

OnKeyPress() protected method

Raises the KeyPress event.
protected OnKeyPress ( KeyPressEventArgs e ) : void
e System.Windows.Forms.KeyPressEventArgs An KeyPressEventArgs containing the event data.
return void

OnKeyUp() protected method

Raises the KeyUp event.
protected OnKeyUp ( KeyEventArgs e ) : void
e System.Windows.Forms.KeyEventArgs An KeyEventArgs containing the event data.
return void

OnLinkClicked() protected method

Raises the LinkClicked event.
protected OnLinkClicked ( System.Windows.Forms.LinkClickedEventArgs e ) : void
e System.Windows.Forms.LinkClickedEventArgs A LinkClickedEventArgs that contains the event data.
return void

OnLostFocus() protected method

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

OnModifiedChanged() protected method

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

OnMultilineChanged() protected method

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

OnPreviewKeyDown() protected method

Raises the PreviewKeyDown event.
protected OnPreviewKeyDown ( PreviewKeyDownEventArgs e ) : void
e System.Windows.Forms.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

OnProtected() protected method

Raises the Protected event.
protected OnProtected ( EventArgs e ) : void
e System.EventArgs An EventArgs that contains the event data.
return void

OnReadOnlyChanged() protected method

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

OnSelectionChanged() protected method

Raises the SelectionChanged event.
protected OnSelectionChanged ( EventArgs e ) : void
e System.EventArgs An EventArgs that contains the event data.
return void

OnTextChanged() protected method

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

OnVScroll() protected method

Raises the VScroll event.
protected OnVScroll ( EventArgs e ) : void
e System.EventArgs An EventArgs that contains 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

Paste() public method

Pastes the contents of the Clipboard in the specified Clipboard format.
public Paste ( DataFormats clipFormat ) : void
clipFormat System.Windows.Forms.DataFormats The Clipboard format in which the data should be obtained from the Clipboard.
return void

Redo() public method

Reapplies the last operation that was undone in the control.
public Redo ( ) : void
return void

ResetShortcutKeys() public method

Resets the ShortcutKeys property to its default value.
public ResetShortcutKeys ( ) : void
return void

SaveFile() public method

Saves the contents of a RichTextBox control to an open data stream.
public SaveFile ( Stream data, RichTextBoxStreamType fileType ) : void
data Stream The data stream that contains the file to save to.
fileType RichTextBoxStreamType One of the RichTextBoxStreamType values.
return void

SaveFile() public method

Saves the contents of the RichTextBox to a rich text format (RTF) file.
public SaveFile ( string path ) : void
path string The name and location of the file to save.
return void

SaveFile() public method

Saves the contents of the KryptonRichTextBox to a specific type of file.
public SaveFile ( string path, RichTextBoxStreamType fileType ) : void
path string The name and location of the file to save.
fileType RichTextBoxStreamType One of the RichTextBoxStreamType values.
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 visible.
public Show ( ) : void
return void

Undo() public method

Undoes the last edit operation in the text box.
public Undo ( ) : void
return void