> ## Documentation Index
> Fetch the complete documentation index at: https://easyaf.nimbleapps.cloud/llms.txt
> Use this file to discover all available pages before exploring further.

# ColorConsole

> Console Color Helper class that provides coloring to individual commands

## Definition

**Assembly:** Breakdance.Tools.dll

**Namespace:** CloudNimble.Breakdance.Tools

**Inheritance:** System.Object

## Syntax

```csharp theme={"dark"}
CloudNimble.Breakdance.Tools.ColorConsole
```

## Summary

Console Color Helper class that provides coloring to individual commands

## Methods

###  Write

Write with color

#### Syntax

```csharp theme={"dark"}
public static void Write(string text, System.Nullable<System.ConsoleColor> color = null)
```

#### Parameters

| Name | Type | Description |
| - | - | - |
| `text` | `string` | - |
| `color` | `System.Nullable<System.ConsoleColor>` | - |

### &#x20;Write

Writes out a line with color specified as a string

#### Syntax

```csharp theme={"dark"}
public static void Write(string text, string color)
```

#### Parameters

| Name | Type | Description |
| - | - | - |
| `text` | `string` | Text to write |
| `color` | `string` | A console color. Must match ConsoleColors collection names (case insensitive) |

### &#x20;WriteEmbeddedColorLine

Allows a string to be written with embedded color values using:
This is \[red]Red\[/red] text and this is \[cyan]Blue\[/cyan] text

#### Syntax

```csharp theme={"dark"}
public static void WriteEmbeddedColorLine(string text, System.Nullable<System.ConsoleColor> baseTextColor = null)
```

#### Parameters

| Name | Type | Description |
| - | - | - |
| `text` | `string` | Text to display |
| `baseTextColor` | `System.Nullable<System.ConsoleColor>` | Base text color |

### &#x20;WriteError

Write a Error Line - Red

#### Syntax

```csharp theme={"dark"}
public static void WriteError(string text)
```

#### Parameters

| Name | Type | Description |
| - | - | - |
| `text` | `string` | Text to write out |

### &#x20;WriteInfo

Write a Info Line - dark cyan

#### Syntax

```csharp theme={"dark"}
public static void WriteInfo(string text)
```

#### Parameters

| Name | Type | Description |
| - | - | - |
| `text` | `string` | Text to write out |

### &#x20;WriteLine

WriteLine with color

#### Syntax

```csharp theme={"dark"}
public static void WriteLine(string text, System.Nullable<System.ConsoleColor> color = null)
```

#### Parameters

| Name | Type | Description |
| - | - | - |
| `text` | `string` | - |
| `color` | `System.Nullable<System.ConsoleColor>` | - |

### &#x20;WriteLine

Writes out a line with a specific color as a string

#### Syntax

```csharp theme={"dark"}
public static void WriteLine(string text, string color)
```

#### Parameters

| Name | Type | Description |
| - | - | - |
| `text` | `string` | Text to write |
| `color` | `string` | A console color. Must match ConsoleColors collection names (case insensitive) |

### &#x20;WriteSuccess

Write a Success Line - green

#### Syntax

```csharp theme={"dark"}
public static void WriteSuccess(string text)
```

#### Parameters

| Name | Type | Description |
| - | - | - |
| `text` | `string` | Text to write out |

### &#x20;WriteWarning

Write a Warning Line - Yellow

#### Syntax

```csharp theme={"dark"}
public static void WriteWarning(string text)
```

#### Parameters

| Name | Type | Description |
| - | - | - |
| `text` | `string` | Text to Write out |

### &#x20;WriteWrappedHeader

## Writes a line of header text wrapped in a in a pair of lines of dashes:

## Header Text

and allows you to specify a color for the header. The dashes are colored

#### Syntax

```csharp theme={"dark"}
public static void WriteWrappedHeader(string headerText, char wrapperChar = '-', System.ConsoleColor headerColor = 14, System.ConsoleColor dashColor = 8)
```

#### Parameters

| Name | Type | Description |
| - | - | - |
| `headerText` | `string` | Header text to display |
| `wrapperChar` | `char` | wrapper character (-) |
| `headerColor` | `System.ConsoleColor` | Color for header text (yellow) |
| `dashColor` | `System.ConsoleColor` | Color for dashes (gray) |


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.