C# Класс ComponentFactory.Krypton.Ribbon.KryptonRibbonGroupRichTextBox

Наследование: KryptonRibbonGroupItem
Показать файл Открыть проект Примеры использования класса

Private Properties

Свойство Тип Описание
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

Открытые методы

Метод Описание
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.

Защищенные методы

Метод Описание
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.

Приватные методы

Метод Описание
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

Описание методов

AppendText() публичный Метод

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.
Результат void

CanPaste() публичный Метод

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.
Результат bool

Clear() публичный Метод

Clears all text from the text box control.
public Clear ( ) : void
Результат void

ClearUndo() публичный Метод

Clears information about the most recent operation from the undo buffer of the rich text box.
public ClearUndo ( ) : void
Результат void

Copy() публичный Метод

Copies the current selection in the text box to the Clipboard.
public Copy ( ) : void
Результат void

Cut() публичный Метод

Moves the current selection in the text box to the Clipboard.
public Cut ( ) : void
Результат void

DeselectAll() публичный Метод

Specifies that the value of the SelectionLength property is zero so that no characters are selected in the control.
public DeselectAll ( ) : void
Результат void

Dispose() защищенный Метод

Clean up any resources being used.
protected Dispose ( bool disposing ) : void
disposing bool true if managed resources should be disposed; otherwise, false.
Результат void

Find() публичный Метод

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.
Результат int

Find() публичный Метод

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.
Результат int

Find() публичный Метод

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.
Результат int

Find() публичный Метод

Searches the text in a RichTextBox control for a string.
public Find ( string str ) : int
str string The text to locate in the control.
Результат int

Find() публичный Метод

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.
Результат int

Find() публичный Метод

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.
Результат int

Find() публичный Метод

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.
Результат int

GetCharFromPosition() публичный Метод

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.
Результат int

GetCharIndexFromPosition() публичный Метод

Retrieves the index of the character nearest to the specified location.
public GetCharIndexFromPosition ( Point pt ) : int
pt Point The location to search.
Результат int

GetFirstCharIndexFromLine() публичный Метод

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.
Результат int

GetFirstCharIndexOfCurrentLine() публичный Метод

Retrieves the index of the first character of the current line.
public GetFirstCharIndexOfCurrentLine ( ) : int
Результат int

GetLineFromCharIndex() публичный Метод

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.
Результат int

GetPositionFromCharIndex() публичный Метод

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.
Результат Point

Hide() публичный Метод

Make the ribbon group hidden.
public Hide ( ) : void
Результат void

KryptonRibbonGroupRichTextBox() публичный Метод

Initialise a new instance of the KryptonRibbonGroupRichTextBox class.
public KryptonRibbonGroupRichTextBox ( ) : System
Результат System

LoadFile() публичный Метод

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.
Результат void

LoadFile() публичный Метод

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.
Результат void

LoadFile() публичный Метод

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.
Результат void

OnAcceptsTabChanged() защищенный Метод

Raises the AcceptsTabChanged event.
protected OnAcceptsTabChanged ( EventArgs e ) : void
e System.EventArgs An EventArgs containing the event data.
Результат void

OnGotFocus() защищенный Метод

Raises the GotFocus event.
protected OnGotFocus ( EventArgs e ) : void
e System.EventArgs An EventArgs containing the event data.
Результат void

OnHScroll() защищенный Метод

Raises the HScroll event.
protected OnHScroll ( EventArgs e ) : void
e System.EventArgs An EventArgs that contains the event data.
Результат void

OnHideSelectionChanged() защищенный Метод

Raises the HideSelectionChanged event.
protected OnHideSelectionChanged ( EventArgs e ) : void
e System.EventArgs An EventArgs that contains the event data.
Результат void

OnKeyDown() защищенный Метод

Raises the KeyDown event.
protected OnKeyDown ( KeyEventArgs e ) : void
e System.Windows.Forms.KeyEventArgs An KeyEventArgs containing the event data.
Результат void

OnKeyPress() защищенный Метод

Raises the KeyPress event.
protected OnKeyPress ( KeyPressEventArgs e ) : void
e System.Windows.Forms.KeyPressEventArgs An KeyPressEventArgs containing the event data.
Результат void

OnKeyUp() защищенный Метод

Raises the KeyUp event.
protected OnKeyUp ( KeyEventArgs e ) : void
e System.Windows.Forms.KeyEventArgs An KeyEventArgs containing the event data.
Результат void

OnLinkClicked() защищенный Метод

Raises the LinkClicked event.
protected OnLinkClicked ( System.Windows.Forms.LinkClickedEventArgs e ) : void
e System.Windows.Forms.LinkClickedEventArgs A LinkClickedEventArgs that contains the event data.
Результат void

OnLostFocus() защищенный Метод

Raises the LostFocus event.
protected OnLostFocus ( EventArgs e ) : void
e System.EventArgs An EventArgs containing the event data.
Результат void

OnModifiedChanged() защищенный Метод

Raises the ModifiedChanged event.
protected OnModifiedChanged ( EventArgs e ) : void
e System.EventArgs An EventArgs that contains the event data.
Результат void

OnMultilineChanged() защищенный Метод

Raises the MultilineChanged event.
protected OnMultilineChanged ( EventArgs e ) : void
e System.EventArgs An EventArgs that contains the event data.
Результат void

OnPreviewKeyDown() защищенный Метод

Raises the PreviewKeyDown event.
protected OnPreviewKeyDown ( PreviewKeyDownEventArgs e ) : void
e System.Windows.Forms.PreviewKeyDownEventArgs An PreviewKeyDownEventArgs containing the event data.
Результат void

OnPropertyChanged() защищенный Метод

Raises the PropertyChanged event.
protected OnPropertyChanged ( string propertyName ) : void
propertyName string Name of property that has changed.
Результат void

OnProtected() защищенный Метод

Raises the Protected event.
protected OnProtected ( EventArgs e ) : void
e System.EventArgs An EventArgs that contains the event data.
Результат void

OnReadOnlyChanged() защищенный Метод

Raises the ReadOnlyChanged event.
protected OnReadOnlyChanged ( EventArgs e ) : void
e System.EventArgs An EventArgs that contains the event data.
Результат void

OnSelectionChanged() защищенный Метод

Raises the SelectionChanged event.
protected OnSelectionChanged ( EventArgs e ) : void
e System.EventArgs An EventArgs that contains the event data.
Результат void

OnTextChanged() защищенный Метод

Raises the TextChanged event.
protected OnTextChanged ( EventArgs e ) : void
e System.EventArgs An EventArgs containing the event data.
Результат void

OnVScroll() защищенный Метод

Raises the VScroll event.
protected OnVScroll ( EventArgs e ) : void
e System.EventArgs An EventArgs that contains the event data.
Результат void

Paste() публичный Метод

Replaces the current selection in the text box with the contents of the Clipboard.
public Paste ( ) : void
Результат void

Paste() публичный Метод

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.
Результат void

Redo() публичный Метод

Reapplies the last operation that was undone in the control.
public Redo ( ) : void
Результат void

ResetShortcutKeys() публичный Метод

Resets the ShortcutKeys property to its default value.
public ResetShortcutKeys ( ) : void
Результат void

SaveFile() публичный Метод

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.
Результат void

SaveFile() публичный Метод

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.
Результат void

SaveFile() публичный Метод

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.
Результат void

ScrollToCaret() публичный Метод

Scrolls the contents of the control to the current caret position.
public ScrollToCaret ( ) : void
Результат void

Select() публичный Метод

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.
Результат void

SelectAll() публичный Метод

Selects all text in the control.
public SelectAll ( ) : void
Результат void

Show() публичный Метод

Make the ribbon group visible.
public Show ( ) : void
Результат void

Undo() публичный Метод

Undoes the last edit operation in the text box.
public Undo ( ) : void
Результат void