Bozho.PowerShell.AnsiColorOut.XML
|
<?xml version="1.0"?>
<doc> <assembly> <name>Bozho.PowerShell.AnsiColorOut</name> </assembly> <members> <member name="F:Bozho.PowerShell.AnsiColorOut.sFileInfoColorMatcher"> <summary> A lazily initialized FilSystemInfo color matcher. Used for better performance, to avoid calling into MatchManager for every GetFileInfoAnsiColor call. </summary> </member> <member name="F:Bozho.PowerShell.AnsiColorOut.sProcessColorMatcher"> <summary> A lazily initialized System.Diagnostics.Process color matcher. Used for better performance, to avoid calling into MatchManager for every GetFileInfoAnsiColor call. </summary> </member> <member name="F:Bozho.PowerShell.AnsiColorOut.sForegroundAnsiColors"> <summary> Foreground ANSI color escape strings. </summary> </member> <member name="F:Bozho.PowerShell.AnsiColorOut.sBackgroundAnsiColors"> <summary> Background ANSI color escape strings. </summary> </member> <member name="P:Bozho.PowerShell.AnsiColorOut.MatcherManager"> <summary> Global matcher manager. </summary> </member> <member name="P:Bozho.PowerShell.AnsiColorOut.ForegroundColorReset"> <summary> Foreground color reset ANSI escape sequence. </summary> </member> <member name="P:Bozho.PowerShell.AnsiColorOut.BackgroundColorReset"> <summary> Background color reset ANSI escape sequence. </summary> </member> <member name="P:Bozho.PowerShell.AnsiColorOut.ColorReset"> <summary> Color reset ANSI escape sequence </summary> </member> <member name="T:Bozho.PowerShell.SetMatcherColors`1"> <summary> A base class for color matchers' Set-XXXColors cmdlets. </summary> </member> <member name="T:Bozho.PowerShell.GetMatcherColors`1"> <summary> A base class for color matchers' Get-XXXColors cmdlets. </summary> </member> <member name="T:Bozho.PowerShell.SetFileSystemColors"> <summary> <para type="synopsis">Configures color mappings for file and directory output.</para> <para type="description">Use this cmdlet to configure color mappings for file and directory output.</para> <para type="description">The input parameter is an array of hashtables. Each hashtable has two members: Match and Color.</para> <para type="description">Match can be one of the following: * An array of strings, which are matched against extensions * A System.IO.FileAttributes (or a combination), which are matched against file/dir attributes * A regular expression, which is matched against file/dir name(just the name, not the full path) * A script block with a single System.IO.FileSystemInfo parameter returning bool. </para> <para type="description">When using Format-Custom to output files and directories (e.g. using Get-ChildItems | Format-Custom), matching items will have ANSI foreground color codes embedded in output strings. These codes can then be interpreted by ANSI-aware tools, like GNU less or AnsiCon. PowerShell 5 is able to interpret ANSI escape sequences natively.</para> <example> <code> $fileSystemColors = @( # this entry will match directories @{ Match = [System.IO.FileAttributes]::Directory; Color = [System.ConsoleColor]::Gray }, # alternatively, we could've used a script block to match directories @{ Match = { param($f) $f.PSIsContainer }; Color = [System.ConsoleColor]::Gray }, # this entry will match files with extensions log, err or out # (it won't get a chance to match directories, since they'll # all be matched by the first entry) @{ Match = @("log", "err", "out"); Color = [System.ConsoleColor]::DarkGreen }, # this entry will match all files with a leading . in the name @{ Match = [regex] "^\..*"; Color = [System.ConsoleColor]::DarkGray } ) Set-FileSystemColors -Colors $fileSystemColors </code> <para>A simple example demonstrating supported matchers</para> </example> </summary> </member> <member name="T:Bozho.PowerShell.GetFileSystemColors"> <summary> <para type="synopsis">Gets a copy of currently configured color mappings for file and directory output.</para> <para type="description">This cmdlet will return a copy of currently configured color mappings for file and directory output.</para> </summary> </member> <member name="T:Bozho.PowerShell.SetProcessColors"> <summary> <para type="synopsis">Configures color mappings for process output.</para> <para type="description">Use this cmdlet to configure color mappings for process output.</para> <para type="description">The input parameter is an array of hashtables. Each hashtable has two members: Match and Color.</para> <para type="description">Match can be one of the following: * ProcessPriorityClass (Idle, BelowNormal, Normal, AboveNormal, High, RealTime) </para> <para type="description">When using Format-XXX to output process data (e.g. using Get-Process | Format-XXX), matching items will have ANSI foreground color codes embedded in output strings. These codes can then be interpreted by ANSI-aware tools, like GNU less or AnsiCon. PowerShell 5 is able to interpret ANSI escape sequences natively.</para> <example> <code> $processColors = @( @{ Match = "Idle" Color = [System.ConsoleColor]::DarkMagenta } @{ Match = "BelowNormal" Color = [System.ConsoleColor]::DarkGray } @{ Match = "BelowNormal" Color = [System.ConsoleColor]::DarkCyan } @{ Match = "Normal" Color = [System.ConsoleColor]::White } @{ Match = "AboveNormal" Color = [System.ConsoleColor]::Green } @{ Match = "High" Color = [System.ConsoleColor]::Yellow } @{ Match = "RealTime" Color = [System.ConsoleColor]::Red } ) Set-ProcessColors -Colors $processColors </code> <para>A simple example demonstrating supported matchers</para> </example> </summary> </member> <member name="T:Bozho.PowerShell.GetProcessColors"> <summary> <para type="synopsis">Gets a copy of currently configured color mappings for process output.</para> <para type="description">This cmdlet will return a copy of currently configured color mappings for process output.</para> </summary> </member> <member name="T:Bozho.PowerShell.SetFileInfoAttributePattern"> <summary> <para type="synopsis">Configures attribute string pattern for file and directory custom property, ExtendedMode.</para> <para type="description">Configures attribute string pattern for file and directory custom property, ExtendedMode. It can also be used to reset current pattern to the default one.</para> <para type="description">Currently supported attributes: A - Archive C - Compressed D - Directory E - Encrypted H - Hidden G - IntegrityStream N - Normal B - NoScrubData I - NotContentIndexed O - Offline R - ReadOnly J - ReparsePoint P - SparseFile S - System T - Temporary </para> <example> <code> Set-FileInfoAttributePattern -AttributePattern DARHS </code> <para>Setting a custom parameter to indicated directories, archive, read=only, hidden and system attributes</para> </example> <example> <code> Set-FileInfoAttributePattern -DefaultPattern </code> <para>Setting the default pattern</para> </example> </summary> </member> <member name="P:Bozho.PowerShell.SetFileInfoAttributePattern.AttributePattern"> <summary> <para type="description">Used to specify custom attribute pattern for ExtendedMode property</para> </summary> </member> <member name="P:Bozho.PowerShell.SetFileInfoAttributePattern.DefaultPattern"> <summary> <para type="description">Resets the ExtendedMode attribute pattern to the default one.</para> </summary> </member> <member name="T:Bozho.PowerShell.GetFileInfoAttributePattern"> <summary> <para type="synopsis">Returns currently configured attribute string pattern for file and directory custom property, ExtendedMode.</para> <para type="description">Returns currently configured attribute string pattern for file and directory custom property, ExtendedMode.</para> <para type="description">Additionally, if the -ShowAll parameter is used, the cmdled will print out all supported attributes and their names.</para> <para type="description">Currently supported attributes: A - Archive C - Compressed D - Directory E - Encrypted H - Hidden G - IntegrityStream N - Normal B - NoScrubData I - NotContentIndexed O - Offline R - ReadOnly J - ReparsePoint P - SparseFile S - System T - Temporary </para> </summary> </member> <member name="P:Bozho.PowerShell.GetFileInfoAttributePattern.ShowAll"> <summary> <para type="description">If specified, the cmdled will print out all supported attributes and their names.</para> </summary> </member> <member name="T:Bozho.PowerShell.ColorMatcher`1"> <summary> Base color matcher class. </summary> <typeparam name="TTarget">Target object's type.</typeparam> </member> <member name="M:Bozho.PowerShell.ColorMatcher`1.GetMatch(`0)"> <summary> Strongly typed GetMatch method. </summary> <param name="target"></param> <returns>IColorMatch matching the target object. Null if no match was found.</returns> </member> <member name="M:Bozho.PowerShell.ColorMatcher`1.SetMatches(System.Collections.Generic.IEnumerable{Bozho.PowerShell.IColorMatch{`0}})"> <summary> Sets matches for the matcher. </summary> </member> <member name="M:Bozho.PowerShell.ColorMatcher`1.GetMatches"> <summary> Retrieves currently registered matches. </summary> <returns></returns> </member> <member name="M:Bozho.PowerShell.ColorMatcher`1.CreateMatch(System.ConsoleColor,System.Object)"> <summary> A factory method for matches. Implementing classes for a target type will create instances of its subclasses based on the colorMatch type (and possibly other conditions) </summary> </member> <member name="M:Bozho.PowerShell.ColorMatcher`1.Bozho#PowerShell#IColorMatcher#GetMatch(System.Object)"> <summary> The method will attempt to find a match matching the target object, using a collection of stored matches (using IColorMatch<TTarget/^>.IsMatch()) </summary> <param name="target">Target object for matching</param> <returns>Matching IColorMatch, or null if none was found.</returns> </member> <member name="T:Bozho.PowerShell.ColorMatcherManager"> <summary> Color matcher manager class. </summary> </member> <member name="M:Bozho.PowerShell.ColorMatcherManager.RegisterMatchers(System.Reflection.Assembly)"> <summary> The method will register all matchers (classes implementing IColorMatcher<> interface) in the specified assembly using Reflection. </summary> </member> <member name="M:Bozho.PowerShell.ColorMatcherManager.GetMatcher(System.Type)"> <summary> Retrieves a matcher based on the target object type. Throws if type is not found. </summary> </member> <member name="M:Bozho.PowerShell.ColorMatcherManager.TryGetMatcher(System.Type,Bozho.PowerShell.IColorMatcher@)"> <summary> Tries to retrieve a matcher based on the target type. </summary> </member> <member name="T:Bozho.PowerShell.Console"> <summary> A Console helper class. </summary> </member> <member name="M:Bozho.PowerShell.Console.EnableVirtualTerminalProcessing"> <summary> Cygwin utilities (at the time of this writing) seem to be stripping ENABLE_VIRTUAL_TERMINAL_PROCESSING output handle flag, which disables ANSI sequence processing in PowerShell. The best workaround I came up with was this method that re-adds the flag. You can execute in your custom prompt function, or add it to something like a custom cls function. </summary> </member> <member name="T:Bozho.PowerShell.FileSystemInfoMatcher"> <summary> Color matcher for FileSystemInfo targets. </summary> </member> <member name="T:Bozho.PowerShell.FileSystemInfoMatch"> <summary> A base class for FileSystemInfo target matches. </summary> </member> <member name="T:Bozho.PowerShell.FileExtensionMatch"> <summary> Output color match that matches on file extensions. Does not match directories. </summary> </member> <member name="T:Bozho.PowerShell.FileAttributeMatch"> <summary> Output color matcher that matches on file/directory attributes. Multiple attributes can be specified by ORing them together. </summary> </member> <member name="T:Bozho.PowerShell.FileRegexNameMatch"> <summary> Output color matcher that matches on file/directory name regular expression match. Since regular expressions can be instantiated directly in PS, users are free to specify any regex options when defining the matching expression. </summary> </member> <member name="T:Bozho.PowerShell.FileScriptMatch"> <summary> Output color matcher that matches on PS script return bool value. The match script must accept exactly one parameter of FileSystemInfo type and return a single bool value. </summary> </member> <member name="T:Bozho.PowerShell.IColorMatch"> <summary> Base interface for color matches. When trying to match a target object to a color, the module will iterate through a collection of matches for the target object's type and use the first match that returns true. </summary> </member> <member name="M:Bozho.PowerShell.IColorMatch.IsMatch(System.Object)"> <summary> The matching method. Implementing classes define a matching condition (e.g. file's extension, name regexp, process' priority). The condition is then use to determine if a target object matches the condition. </summary> <param name="target">Target object for matching</param> <returns>True if the object matches the condition. False otherwise.</returns> </member> <member name="P:Bozho.PowerShell.IColorMatch.ForegroundColor"> <summary> The foreground console color associated with the match. When the module matches a target object, this color will be use to format console output. </summary> </member> <member name="T:Bozho.PowerShell.IColorMatch`1"> <summary> Strongly typed IColorMatch interface. Used internally by matchers. </summary> <typeparam name="TTarget">Target object's type.</typeparam> </member> <member name="M:Bozho.PowerShell.IColorMatch`1.IsMatch(`0)"> <summary> Strongly typed version of IsMatch method. </summary> <param name="target">Target object for matching</param> <returns>True if the object matches the condition. False otherwise.</returns> </member> <member name="M:Bozho.PowerShell.IColorMatch`1.GetMatchData"> <summary> Returns a clone of match data (e.g. a list of file extensions used for matching). This method is used by Get-XXXXColors to retrieve current settings. It is important for implementing classes to return a deep clone of the data, in order to prevent modification of reference-typed data. </summary> <returns></returns> </member> <member name="T:Bozho.PowerShell.IColorMatcher"> <summary> Base interface for color matchers. When trying to match a target object to a color, the module will call this method to attempt to find a match for the target object. </summary> </member> <member name="M:Bozho.PowerShell.IColorMatcher.GetMatch(System.Object)"> <summary> The method will attempt to find a match matching the target object, using a collection of stored matches (using IColorMatch<TTarget/^>.IsMatch()) </summary> <param name="target">Target object for matching</param> <returns>Matching IColorMatch, or null if none was found.</returns> </member> <member name="T:Bozho.PowerShell.IColorMatcher`1"> <summary> Strongly type IColorMatcher interface. </summary> <typeparam name="TTarget">Target object's type.</typeparam> </member> <member name="M:Bozho.PowerShell.IColorMatcher`1.GetMatch(`0)"> <summary> Strongly typed GetMatch method. </summary> <param name="target"></param> <returns>IColorMatch matching the target object. Null if no match was found.</returns> </member> <member name="M:Bozho.PowerShell.IColorMatcher`1.SetMatches(System.Collections.Generic.IEnumerable{Bozho.PowerShell.IColorMatch{`0}})"> <summary> Sets matches for the matcher. </summary> </member> <member name="M:Bozho.PowerShell.IColorMatcher`1.GetMatches"> <summary> Gets the matches. </summary> </member> <member name="M:Bozho.PowerShell.IColorMatcher`1.CreateMatch(System.ConsoleColor,System.Object)"> <summary> A factory method for matches. Implementing classes for a target type will create instances of its subclasses based on the colorMatch type (and possibly other conditions) </summary> </member> <member name="T:Bozho.PowerShell.IColorMatcherManager"> <summary> Color matcher manager interface. The manager allows registering matchers, as well as retrieving them based on the target object type. </summary> </member> <member name="M:Bozho.PowerShell.IColorMatcherManager.GetMatcher(System.Type)"> <summary> Retrieves a matcher based on the target object type. Throws if type is not found. </summary> </member> <member name="M:Bozho.PowerShell.IColorMatcherManager.TryGetMatcher(System.Type,Bozho.PowerShell.IColorMatcher@)"> <summary> Tries to retrieve a matcher based on the target type. </summary> </member> <member name="T:Bozho.PowerShell.ProcessMatcher"> <summary> Color matcher for System.Diagnostics.Process targets. </summary> </member> <member name="T:Bozho.PowerShell.ProcessMatch"> <summary> A base class for System.Diagnostics.Process target matches. </summary> </member> <member name="T:Bozho.PowerShell.ProcessPriorityMatch"> <summary> Output color match that matches on process priority </summary> </member> <member name="M:Bozho.PowerShell.ProcessPriorityMatch.#cctor"> <summary> It would appear that Process.PriorityClass property is not always readable. We'll map Process.BasePriority values the best we can and match on those. </summary> </member> <member name="T:Bozho.PowerShell.TypeExtensions"> <summary> Type type extension methdos. </summary> </member> <member name="M:Bozho.PowerShell.TypeExtensions.IsAssignableToGenericType(System.Type,System.Type)"> <summary> Checks whether a type is assignable to an open generic type. </summary> </member> </members> </doc> |