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

# ScaffoldOptions

> The validated inputs for `dotnet easyaf new`: the solution namespace, target framework, and which optional projects to include.

## Definition

**Assembly:** CloudNimble.EasyAF.Tools.dll

**Namespace:** CloudNimble.EasyAF.Tools.Scaffolding

**Inheritance:** System.Object

## Syntax

```csharp theme={"dark"}
CloudNimble.EasyAF.Tools.Scaffolding.ScaffoldOptions
```

## Summary

The validated inputs for `dotnet easyaf new`: the solution namespace, target framework, and which optional
projects to include.

## Constructors

### <Icon icon="hammer" iconType="duotone" color="#E0EC32" size={24} className="mr-2" /> .ctor

Initializes a new instance of the [ScaffoldOptions](/api-reference/CloudNimble/EasyAF/Tools/Scaffolding/ScaffoldOptions) class.

#### Syntax

```csharp theme={"dark"}
public ScaffoldOptions(string namespace, string targetFramework = "net10.0", bool includeApi = true, bool includeMessageBus = true, bool includeRuntime = true, bool webJob = false)
```

#### Parameters

| Name | Type | Description |
| - | - | - |
| `namespace` | `string` | The solution namespace; every dot-separated segment must be a C# identifier. |
| `targetFramework` | `string` | The target framework: `net10.0` or `net11.0`. |
| `includeApi` | `bool` | Whether to create the `.Api` project. |
| `includeMessageBus` | `bool` | Whether to create the `.MessageBus.*` projects. |
| `includeRuntime` | `bool` | Whether to create the `.MessageBus.Runtime` project. |
| `webJob` | `bool` | Whether to stamp Azure WebJob publish metadata on the runtime. |

#### Exceptions

| Exception | Description |
| - | - |
| `ArgumentException` | Thrown when an argument is invalid or the flags conflict. |

### <Icon icon="hammer" iconType="duotone" color="#E0EC32" size={24} className="mr-2" /> .ctor <Badge color="gray">Inherited</Badge>

<Note>Inherited from `object`</Note>

#### Syntax

```csharp theme={"dark"}
public Object()
```

## Properties

### <Icon icon="tag" iconType="duotone" color="#E0EC32" size={24} className="mr-2" /> Company

Gets the first namespace segment (for example `CloudNimble` for `CloudNimble.Contoso`), used for package metadata.

#### Syntax

```csharp theme={"dark"}
public string Company { get; }
```

#### Property Value

Type: `string`

### <Icon icon="tag" iconType="duotone" color="#E0EC32" size={24} className="mr-2" /> IncludeApi

Gets a value indicating whether the `.Api` project (and its test project) is created.

#### Syntax

```csharp theme={"dark"}
public bool IncludeApi { get; }
```

#### Property Value

Type: `bool`

### <Icon icon="tag" iconType="duotone" color="#E0EC32" size={24} className="mr-2" /> IncludeMessageBus

Gets a value indicating whether the `.MessageBus.*` projects are created.

#### Syntax

```csharp theme={"dark"}
public bool IncludeMessageBus { get; }
```

#### Property Value

Type: `bool`

### <Icon icon="tag" iconType="duotone" color="#E0EC32" size={24} className="mr-2" /> IncludeRuntime

Gets a value indicating whether the `.MessageBus.Runtime` project is created. Always [`false`](https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool)
when [ScaffoldOptions.IncludeMessageBus](/api-reference/CloudNimble/EasyAF/Tools/Scaffolding/ScaffoldOptions#includemessagebus) is [`false`](https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool).

#### Syntax

```csharp theme={"dark"}
public bool IncludeRuntime { get; }
```

#### Property Value

Type: `bool`

### <Icon icon="tag" iconType="duotone" color="#E0EC32" size={24} className="mr-2" /> MicrosoftPackageVersion

Gets the version that Microsoft.Extensions and EF Core packages float to for [ScaffoldOptions.TargetFramework](/api-reference/CloudNimble/EasyAF/Tools/Scaffolding/ScaffoldOptions#targetframework).

#### Syntax

```csharp theme={"dark"}
public string MicrosoftPackageVersion { get; }
```

#### Property Value

Type: `string`

### <Icon icon="tag" iconType="duotone" color="#E0EC32" size={24} className="mr-2" /> Namespace

Gets the solution namespace (for example `CloudNimble.Contoso`); every project name starts with it.

#### Syntax

```csharp theme={"dark"}
public string Namespace { get; }
```

#### Property Value

Type: `string`

### <Icon icon="tag" iconType="duotone" color="#E0EC32" size={24} className="mr-2" /> Product

Gets the last namespace segment (for example `Contoso`), used in class, configuration, and WebJob names.

#### Syntax

```csharp theme={"dark"}
public string Product { get; }
```

#### Property Value

Type: `string`

### <Icon icon="tag" iconType="duotone" color="#E0EC32" size={24} className="mr-2" /> TargetFramework

Gets the target framework moniker every project uses (for example `net10.0`).

#### Syntax

```csharp theme={"dark"}
public string TargetFramework { get; }
```

#### Property Value

Type: `string`

### <Icon icon="tag" iconType="duotone" color="#E0EC32" size={24} className="mr-2" /> WebJob

Gets a value indicating whether Azure WebJob publish metadata is stamped on the `.MessageBus.Runtime` project.

#### Syntax

```csharp theme={"dark"}
public bool WebJob { get; }
```

#### Property Value

Type: `bool`

## Methods

### <Icon icon="function" iconType="duotone" color="#E0EC32" size={24} className="mr-2" /> CreateTokens

Creates the token values the embedded scaffold resources are rendered with.

#### Syntax

```csharp theme={"dark"}
public System.Collections.Generic.IReadOnlyDictionary<string, string> CreateTokens(string sdkVersion, int year)
```

#### Parameters

| Name | Type | Description |
| - | - | - |
| `sdkVersion` | `string` | The .NET SDK version to pin in `global.json`. |
| `year` | `int` | The copyright year. |

#### Returns

Type: `System.Collections.Generic.IReadOnlyDictionary<string, string>`
The tokens keyed by placeholder name.

### <Icon icon="code-fork" iconType="duotone" color="#E0EC32" size={24} className="mr-2" /> Equals <Badge color="gray">Inherited</Badge> <Badge color="orange">Virtual</Badge>

<Note>Inherited from `object`</Note>

#### Syntax

```csharp theme={"dark"}
public virtual bool Equals(object obj)
```

#### Parameters

| Name | Type | Description |
| - | - | - |
| `obj` | `object?` | - |

#### Returns

Type: `bool`

### <Icon icon="thumbtack" iconType="duotone" color="#E0EC32" size={24} className="mr-2" /> Equals <Badge color="gray">Inherited</Badge>

<Note>Inherited from `object`</Note>

#### Syntax

```csharp theme={"dark"}
public static bool Equals(object objA, object objB)
```

#### Parameters

| Name | Type | Description |
| - | - | - |
| `objA` | `object?` | - |
| `objB` | `object?` | - |

#### Returns

Type: `bool`

### <Icon icon="code-fork" iconType="duotone" color="#E0EC32" size={24} className="mr-2" /> GetHashCode <Badge color="gray">Inherited</Badge> <Badge color="orange">Virtual</Badge>

<Note>Inherited from `object`</Note>

#### Syntax

```csharp theme={"dark"}
public virtual int GetHashCode()
```

#### Returns

Type: `int`

### <Icon icon="function" iconType="duotone" color="#E0EC32" size={24} className="mr-2" /> GetType <Badge color="gray">Inherited</Badge>

<Note>Inherited from `object`</Note>

#### Syntax

```csharp theme={"dark"}
public System.Type GetType()
```

#### Returns

Type: `System.Type`

### <Icon icon="function" iconType="duotone" color="#E0EC32" size={24} className="mr-2" /> MemberwiseClone <Badge color="gray">Inherited</Badge>

<Note>Inherited from `object`</Note>

#### Syntax

```csharp theme={"dark"}
protected internal object MemberwiseClone()
```

#### Returns

Type: `object`

### <Icon icon="thumbtack" iconType="duotone" color="#E0EC32" size={24} className="mr-2" /> ReferenceEquals <Badge color="gray">Inherited</Badge>

<Note>Inherited from `object`</Note>

#### Syntax

```csharp theme={"dark"}
public static bool ReferenceEquals(object objA, object objB)
```

#### Parameters

| Name | Type | Description |
| - | - | - |
| `objA` | `object?` | - |
| `objB` | `object?` | - |

#### Returns

Type: `bool`

### <Icon icon="code-fork" iconType="duotone" color="#E0EC32" size={24} className="mr-2" /> ToString <Badge color="gray">Inherited</Badge> <Badge color="orange">Virtual</Badge>

<Note>Inherited from `object`</Note>

#### Syntax

```csharp theme={"dark"}
public virtual string ToString()
```

#### Returns

Type: `string?`


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