Collapse All Expand All Code: All Code: Multiple Code: C# Code: Visual Basic Members: Show All Members: Filtered Members: Filtered Members: Filtered

C#
Visual Basic
Include Protected Members
Include Inherited Members

Azuki 1.7 Documentation
AzukiControl Members
AzukiControl Class Constructors Methods Properties Events See Also Send Feedback

The AzukiControl type exposes the following members.

# Constructors

| Name | Description
--- | --- | ---
| AzukiControl | Creates a new instance.

# Methods

| Name | Description
--- | --- | ---
| ClearHistory | Clears all stacked edit histories in currently active document.
| Copy | Executes copy action.
| Cut | Executes cut action.
| Delete | Executes delete action.
| Dispose | Disposes resources used by this AzukiControl. (Overrides Control..::..Dispose(Boolean).)
| GetCharIndexFromLineColumnIndex | Calculates char-index from screen line/column index.
| GetHRulerIndex(Int32) | Calculates location of character at specified index in horizontal ruler index.
| GetHRulerIndex(Int32, Int32) | Calculates location of character at specified index in horizontal ruler index.
| GetIGraphics | Gets a graphic interface.
| GetIndexFromPosition | Gets char-index of the char at the point specified by screen location.
| GetKeyBind(UInt32) | Gets an action which is already associated with given key. If no action was associate with given key, returns null.
| GetKeyBind(Keys) | Gets an action which is already associated with given key. If no action was associate with given key, returns null.
| GetLineColumnIndexFromCharIndex | Calculates screen line/column index from char-index.
| GetLineHeadIndex | Gets the index of the first char in the line.
| GetLineHeadIndexFromCharIndex | Gets the index of the first char in the screen line which contains the specified char-index.
| GetLineIndexFromCharIndex | Calculates screen line index from char-index.
| GetLineLength | Gets length of the specified line.
| GetPositionFromIndex(Int32) | Calculates screen location of the character at specified index.
| GetPositionFromIndex(Int32, Int32) | Calculates screen location of the character at specified index.
| GetSelectedText()()()() | Gets currently selected text.
| GetSelectedText(String) | Gets currently selected text.
| GetSelectedTextLength | Gets number of characters currently selected.
| GetSelection | Gets range of current selection. Note that this method does not return [anchor, caret) pair but [begin, end) pair.
| GetTextInRange | Gets text in the range [begin, end).
| GetWordAt | Gets a word at specified index.
| HandleTextInput | Processes specified text as an input by user.
| Invalidate()()()() | Invalidate graphic of whole area (force to be redrawn by next paint event message).
| Invalidate(Rectangle) | Invalidate graphic of the specified area (force to be redrawn by next paint event message).
| InvokeCaretMoved | (For internal use only) Invokes CaretMoved event.
| InvokeHScroll | (Internal use only.) Invokes HScroll event.
| InvokeIsRectSelectModeChanged | Obsolete. (For internal use only) Invokes IsRectSelectModeChanged event.
| InvokeLineDrawing | Invokes LineDrawing event.
| InvokeLineDrawn | Invokes LineDrawn event.
| InvokeOverwriteModeChanged | (For internal use only) Invokes OverwriteModeChanged event.
| InvokeVScroll | (Internal use only.) Invokes VScroll event.
| IsInputChar | This defines the characters which must be treated as input for this control. This affects mnemonic key event in a dialog and does not affect to KeyPress (WM_CHAR) event. (Overrides Control..::..IsInputChar(Char).)
| IsInputKey | This defines the keys which must be treated as input for this control. This affects mnemonic key event in a dialog and does not affect to KeyPress (WM_CHAR) event. (Overrides Control..::..IsInputKey(Keys).)
| OnClick | Invokes Click event with additional information through IMouseEventArgs. (Overrides Control..::..OnClick(EventArgs).)
| OnDoubleClick | Invokes DoubleClick event with additional information through IMouseEventArgs. (Overrides Control..::..OnDoubleClick(EventArgs).)
| OnGotFocus | Invokes GotFocus event. (Overrides Control..::..OnGotFocus(EventArgs).)
| OnHandleCreated | Invokes HandleCreated event. (Overrides Control..::..OnHandleCreated(EventArgs).)
| OnHandleDestroyed | Invokes HandleDestroyed event. (Overrides Control..::..OnHandleDestroyed(EventArgs).)
| OnKeyDown | Invokes KeyDown event. (Overrides Control..::..OnKeyDown(KeyEventArgs).)
| OnKeyPress | Invokes KeyPress event. (Overrides Control..::..OnKeyPress(KeyPressEventArgs).)
| OnLostFocus | Invokes LostFocus event. (Overrides Control..::..OnLostFocus(EventArgs).)
| OnMouseClick | Invokes MouseClick event with additional information through IMouseEventArgs. (Overrides Control..::..OnMouseClick(MouseEventArgs).)
| OnMouseDoubleClick | Invokes MouseDoubleClick event with additional information through IMouseEventArgs. (Overrides Control..::..OnMouseDoubleClick(MouseEventArgs).)
| OnMouseDown | Invokes MouseDown event with additional information through IMouseEventArgs. (Overrides Control..::..OnMouseDown(MouseEventArgs).)
| OnMouseMove | Invokes MouseMove event with additional information through IMouseEventArgs. (Overrides Control..::..OnMouseMove(MouseEventArgs).)
| OnMouseUp | Invokes MouseUp event with additional information through IMouseEventArgs. (Overrides Control..::..OnMouseUp(MouseEventArgs).)
| OnPaintBackground | Erases background. Note that Azuki does nothing on an event of redrawing background so just ignores WM_ERASEBKGND message. (Overrides Control..::..OnPaintBackground(PaintEventArgs).)
| OnResize | Invokes Resize event. (Overrides Control..::..OnResize(EventArgs).)
| Paste | Executes paste action.
| PreProcessMessage | Pre-processes window messages to override system default behavior. (Overrides Control..::..PreProcessMessage(Message%).)
| ProcessDialogKey | This overrides focusing strategy. (Overrides Control..::..ProcessDialogKey(Keys).)
| Redo | Executes REDO.
| RescheduleHighlighting | (Internal use only.) Make a highlighter run after a little moment.
| ResetKeyBind | Reset keybind to default.
| Scroll | Scrolls a portion of the window.
| ScrollToCaret | Scrolls to where the caret is.
| SelectAll | Selects all text.
| SetCursorGraphic | Sets graphic of mouse cursor.
| SetKeyBind(UInt32, ActionProc) | Sets or removes key-bind entry. Note that giving null to action will remove the key-bind.
| SetKeyBind(Keys, ActionProc) | Sets or removes key-bind entry. Note that giving null to action will remove the key-bind.
| SetSelection | Sets selection range and update the desired column.
| Undo | Executes UNDO.
| UpdateCaretGraphic()()()() | Updates size and position of the caret graphic.
| UpdateCaretGraphic(Rectangle) | Updates size and position of the caret graphic.
| UpdateScrollBarRange | Updates scrollbar's range.

# Properties

| Name | Description
--- | --- | ---
| AcceptsReturn | If this is true, treats Enter key as an input and prevent pressing dialog default button.
| AcceptsTab | If this is true, treats Tab key as an input and prevent moving focus to other control in a dialog.
| AutoIndentHook | Gets or sets hook delegate to execute auto-indentation. If null, auto-indentation will not be performed.
| BackColor | Gets or sets default background color. (Overrides Control..::..BackColor.)
| BorderStyle | Gets or sets graphical style of border of this control.
| CanCopy | Gets whether copy action can be executed or not.
| CanCut | Gets whether cut action can be executed or not.
| CanPaste | Gets whether paste action can be executed or not.
| CanRedo | Gets whether an available REDO action exists or not.
| CanUndo | Gets whether an available UNDO action exists or not.
| CaretIndex | Gets the index of where the caret is at (in char-index).
| ColorScheme | Color set used for displaying text.
| ConvertsFullWidthSpaceToSpace | Gets or sets whether to automatically convert an input full-width space to a space.
| ConvertsTabToSpaces | Gets or sets whether tab characters are used for indentation, instead of space characters.
| Document | Gets or sets the document which is the current editing target.
| DrawingOption | Gets or sets drawing options.
| DrawsEofMark | Gets or sets whether to show EOF mark or not.
| DrawsEolCode | Gets or sets whether to show EOL code with special graphic or not.
| DrawsFullWidthSpace | Gets or sets whether to show full-width space with special graphic or not.
| DrawsSpace | Gets or sets whether to show half-width space with special graphic or not.
| DrawsTab | Gets or sets whether to show tab character with special graphic or not.
| FirstVisibleLine | Gets or sets the index of the first visible (graphically top most) line of currently active document.
| Font | Gets or sets font to be used for displaying text. (Overrides Control..::..Font.)
| FontInfo | Gets or sets raw font information to be used for displaying text.
| ForeColor | Gets or sets default text color. (Overrides Control..::..ForeColor.)
| Highlighter | Gets or sets highlighter object to highlight currently active document or null to disable highlighting.
| HighlightsCurrentLine | Gets or sets whether the current line would be drawn with underline or not.
| HighlightsMatchedBracket | Gets or sets whether to highlight matched bracket or not.
| HRulerIndicatorType | Gets or sets type of the indicator on the horizontal ruler.
| IsLineSelectMode | Gets whether Azuki is in line selection mode or not.
| IsOverwriteMode | Gets or sets whether overwrite mode is enabled or not. In overwrite mode, input character will not be inserted but replaces a character at where the caret is on.
| IsReadOnly | Gets or sets whether this document is read-only or not.
| IsRecordingHistory | Gets or sets whether the edit actions will be recorded or not.
| IsRectSelectMode | Gets or sets whether Azuki is in rectangle selection mode or not.
| IsSingleLineMode | Gets or sets whether the content should be limited to a single line.
| LeftMargin | Gets or sets left margin of the view in pixel.
| LineCount | Gets number of lines currently inputted.
| LineHeight | Gets height of each lines in pixel.
| LinePadding | Gets or sets size of padding between lines in pixel.
| LineSpacing | Gets distance between lines in pixel.
| MarksUri | Gets or sets whether URIs in the active document should be marked automatically with built-in URI marker or not.
| ScrollPos | Gets or sets virtual location of currently visible area.
| ScrollsBeyondLastLine | Gets or sets whether to scroll beyond the last line of the document or not.
| SelectionMode | Gets or sets how to select text.
| ShowsDirtBar | Gets or sets whether to show 'dirt bar' or not.
| ShowsHRuler | Gets or sets whether to show horizontal ruler or not.
| ShowsHScrollBar | Gets or sets whether to show horizontal scroll bar or not.
| ShowsLineNumber | Gets or sets whether to show line number or not.
| ShowsVScrollBar | Whether to show vertical scroll bar or not.
| TabWidth | Gets or sets tab width in count of space characters.
| Text | Gets or sets currently inputted text. (Overrides Control..::..Text.)
| TextLength | Gets number of (UTF-16) characters in the currently active document.
| TopMargin | Gets or sets top margin of the view in pixel.
| UnindentsWithBackspace | Gets or sets whether to reduce an indent level with Backspace key rather than removing a single space character.
| UseCtrlTabToMoveFocus | Gets or sets whether this control uses Ctrl+Tab and Ctrl+Shift+Tab for moving focus to other controls in a dialog.
| UsesStickyCaret | Gets or sets whether caret behavior is 'sticky' or not.
| UsesTabForIndent | Gets or sets whether a tab character should be used for indentation, instead of space characters.
| Version | Gets version of Azuki.dll.
| View | Gets the associated view object.
| ViewType | Gets or sets type of the view which determines how to render text content.
| ViewWidth | Gets or sets width of the content area (including line number area).

# Events

| Name | Description
--- | --- | ---
| CaretMoved | Occurs soon after the document's caret was moved.
| HScroll | Occurres after horizontal scroll happened.
| IsRectSelectModeChanged | Obsolete. Occures soon after rectangular selection mode was changed.
| LineDrawing | Occurres before a screen line was drawn.
| LineDrawn | Occurres after a screen line was drawn.
| OverwriteModeChanged | Occurs soon after the overwrite mode was changed.
| VScroll | Occurres after vertical scroll happened.

# See Also

AzukiControl Class
Sgry.Azuki.WinForms Namespace