C# Class PoshCode.Controls.ConsoleControl

Mostra file Open project: Jaykul/PoshConsole Class Usage Examples

Public Properties

Property	Type	Description
BackgroundColorProperty	System.Windows.DependencyProperty
CaretColorProperty	System.Windows.DependencyProperty
ForegroundColorProperty	System.Windows.DependencyProperty
TabExpansionTrace	TraceSource
TitleProperty	DependencyProperty
WaitingForInput	bool

Private Properties

Property	Type	Description
BackgroundColorPropertyChanged	void
ConsoleControl	System
ForegroundColorPropertyChanged	void
ISupportInitialize	void
InitializeCommands	void
OnApplicationStop	void
OnCanExecuteCut	void
OnCanExecutePaste	void
OnCommandFinished	void
OnDownPressed	void
OnEnterPressed	void
OnExecuteCut	void
OnExecutePaste	void
OnHistoryMenu	void
OnPageDownPressed	void
OnPageUpPressed	void
OnTabPressed	void
OnUpPressed	void
ScrollViewer_SizeChanged	void
ShouldEcho	void
UpdateCharacterWidth	void
Write	void
Write	void

Public Methods

Method	Description
ClearInput ( ) : void
ClearScreen ( ) : void	Implements the CLS command the way most command-lines do: Scroll the Window until the prompt is at the top ... (as opposed to clearing the screen and leaving the prompt at the bottom)
CompleteBackgroundWorkItems ( ) : void	Complete all work queued at background priority
Dispose ( ) : void
FindNext ( TextPointer &position, String input ) : TextRange	Find the input string within the document, starting at the specified position.
FindText ( String input ) : bool	Find all instances of the given text
FlushInputBuffer ( ) : void
FocusInput ( ) : void
GetBufferContents ( Rectangle rectangle ) : ].BufferCell[
NewParagraph ( ) : void	News the paragraph.
ReadKey ( ReadKeyOptions options ) : KeyInfo
ReadLine ( ) : string	Provides a way for scripts to request user input ...
ReadLineAsSecureString ( ) : SecureString
SetPrompt ( string prompt = null ) : void
Write ( string message, Block target = null ) : void
_commandBox_PreviewKeyDown ( object sender, KeyEventArgs e ) : void	Lets us intercept special keys for the control
_passwordBox_PreviewKeyDown ( object sender, KeyEventArgs e ) : void

Protected Methods

Method	Description
Dispose ( bool disposing ) : void
OnCommand ( CommandEventArgs command ) : void	Handles the CommandEntered event of the Console buffer
OnDragEnter ( System.Windows.DragEventArgs e ) : void
OnDrop ( System.Windows.DragEventArgs e ) : void
OnMouseRightButtonUp ( System.Windows.Input.MouseButtonEventArgs e ) : void	Implement right-click the way the normal console does: paste into the prompt.
OnPreviewKeyDown ( KeyEventArgs e ) : void
OnPreviewKeyUp ( KeyEventArgs e ) : void
OnPreviewMouseLeftButtonUp ( MouseButtonEventArgs e ) : void
OnPreviewMouseWheel ( MouseWheelEventArgs e ) : void
OnPreviewTextInput ( TextCompositionEventArgs e ) : void
OnRenderSizeChanged ( SizeChangedInfo sizeInfo ) : void

Private Methods

Method	Description
BackgroundColorPropertyChanged ( DependencyObject depObj, System.Windows.DependencyPropertyChangedEventArgs e ) : void
ConsoleControl ( ) : System
ForegroundColorPropertyChanged ( DependencyObject depObj, System.Windows.DependencyPropertyChangedEventArgs e ) : void
ISupportInitialize ( ) : void
InitializeCommands ( ) : void
OnApplicationStop ( object sender, System.Windows.Input.ExecutedRoutedEventArgs e ) : void	A handler for the Application.Stop event...
OnCanExecuteCut ( object target, System.Windows.Input.CanExecuteRoutedEventArgs args ) : void
OnCanExecutePaste ( object target, System.Windows.Input.CanExecuteRoutedEventArgs args ) : void
OnCommandFinished ( IEnumerable command, PipelineState results ) : void	Right before a prompt we want to insert a new paragraph... But we want to trim any whitespace off the end of the output first because the paragraph mark makes plenty of whitespace
OnDownPressed ( System.Windows.Input.KeyEventArgs e ) : void
OnEnterPressed ( System.Windows.Input.KeyEventArgs e ) : void
OnExecuteCut ( object sender, System.Windows.Input.ExecutedRoutedEventArgs e ) : void
OnExecutePaste ( object sender, System.Windows.Input.ExecutedRoutedEventArgs e ) : void
OnHistoryMenu ( System.Windows.Input.KeyEventArgs e ) : void
OnPageDownPressed ( KeyEventArgs e ) : void
OnPageUpPressed ( KeyEventArgs e ) : void
OnTabPressed ( KeyEventArgs e ) : void
OnUpPressed ( KeyEventArgs e ) : void
ScrollViewer_SizeChanged ( object sender, SizeChangedEventArgs e ) : void
ShouldEcho ( char ch, bool echo ) : void
UpdateCharacterWidth ( ) : void	Updates the value of the CharacterWidthRatio Called each time the font-family changes
Write ( Brush foreground, Brush background, string text, Block target = null ) : void
Write ( ConsoleColor foreground, ConsoleColor background, string text, Block target = null ) : void

Method Details

ClearInput() public method

public ClearInput ( ) : void
return	void

ClearScreen() public method

Implements the CLS command the way most command-lines do: Scroll the Window until the prompt is at the top ... (as opposed to clearing the screen and leaving the prompt at the bottom)

public ClearScreen ( ) : void
return	void

CompleteBackgroundWorkItems() public method

Complete all work queued at background priority

public CompleteBackgroundWorkItems ( ) : void
return	void

Dispose() public method

public Dispose ( ) : void
return	void

Dispose() protected method

protected Dispose ( bool disposing ) : void
disposing	bool
return	void

FindNext() public method

Find the input string within the document, starting at the specified position.

public FindNext ( TextPointer &position, String input ) : TextRange
position	TextPointer	the current text position
input	String	input text
return	TextRange

FindText() public method

Find all instances of the given text

public FindText ( String input ) : bool
input	String	text to search for (null or empty clears search)
return	bool

FlushInputBuffer() public method

public FlushInputBuffer ( ) : void
return	void

FocusInput() public method

public FocusInput ( ) : void
return	void

GetBufferContents() public method

public GetBufferContents ( Rectangle rectangle ) : ].BufferCell[
rectangle	Rectangle
return	].BufferCell[

NewParagraph() public method

News the paragraph.

public NewParagraph ( ) : void
return	void

OnCommand() protected method

Handles the CommandEntered event of the Console buffer

protected OnCommand ( CommandEventArgs command ) : void
command	CommandEventArgs	The command.
return	void

OnDragEnter() protected method

protected OnDragEnter ( System.Windows.DragEventArgs e ) : void
e	System.Windows.DragEventArgs
return	void

OnDrop() protected method

protected OnDrop ( System.Windows.DragEventArgs e ) : void
e	System.Windows.DragEventArgs
return	void

OnMouseRightButtonUp() protected method

Implement right-click the way the normal console does: paste into the prompt.

protected OnMouseRightButtonUp ( System.Windows.Input.MouseButtonEventArgs e ) : void
e	System.Windows.Input.MouseButtonEventArgs
return	void

OnPreviewKeyDown() protected method

protected OnPreviewKeyDown ( KeyEventArgs e ) : void
e	KeyEventArgs
return	void

OnPreviewKeyUp() protected method

protected OnPreviewKeyUp ( KeyEventArgs e ) : void
e	KeyEventArgs
return	void

OnPreviewMouseLeftButtonUp() protected method

protected OnPreviewMouseLeftButtonUp ( MouseButtonEventArgs e ) : void
e	MouseButtonEventArgs
return	void

OnPreviewMouseWheel() protected method

protected OnPreviewMouseWheel ( MouseWheelEventArgs e ) : void
e	MouseWheelEventArgs
return	void

OnPreviewTextInput() protected method

protected OnPreviewTextInput ( TextCompositionEventArgs e ) : void
e	TextCompositionEventArgs
return	void

OnRenderSizeChanged() protected method

protected OnRenderSizeChanged ( SizeChangedInfo sizeInfo ) : void
sizeInfo	SizeChangedInfo
return	void

ReadKey() public method

public ReadKey ( ReadKeyOptions options ) : KeyInfo
options	ReadKeyOptions
return	KeyInfo

ReadLine() public method

Provides a way for scripts to request user input ...

public ReadLine ( ) : string
return	string

ReadLineAsSecureString() public method

public ReadLineAsSecureString ( ) : SecureString
return	SecureString

SetPrompt() public method

public SetPrompt ( string prompt = null ) : void
prompt	string
return	void

Write() public method

public Write ( string message, Block target = null ) : void
message	string
target	Block
return	void

_commandBox_PreviewKeyDown() public method

Lets us intercept special keys for the control

public _commandBox_PreviewKeyDown ( object sender, KeyEventArgs e ) : void
sender	object
e	KeyEventArgs
return	void

_passwordBox_PreviewKeyDown() public method

public _passwordBox_PreviewKeyDown ( object sender, KeyEventArgs e ) : void
sender	object
e	KeyEventArgs
return	void

Property Details

BackgroundColorProperty public_oe static_oe property

public static DependencyProperty,System.Windows BackgroundColorProperty
return	System.Windows.DependencyProperty

CaretColorProperty public_oe static_oe property

public static DependencyProperty,System.Windows CaretColorProperty
return	System.Windows.DependencyProperty

ForegroundColorProperty public_oe static_oe property

public static DependencyProperty,System.Windows ForegroundColorProperty
return	System.Windows.DependencyProperty

TabExpansionTrace public_oe static_oe property

public static TraceSource TabExpansionTrace
return	TraceSource

TitleProperty public_oe static_oe property

public static DependencyProperty TitleProperty
return	DependencyProperty

WaitingForInput public_oe property

public bool WaitingForInput
return	bool