---
title: "Class TemplateConverter | Customer's Canvas On-Premises"
canonical: "https://customerscanvas.com/docs/on-premises/design-atoms-cs/reference/api/Aurigma.DesignAtoms.Convert/TemplateConverter/"
---

# Class TemplateConverter

> **Inheritance:** `System.Object` -> TemplateConverter

###### **Namespace**: [Aurigma.DesignAtoms.Convert](https://customerscanvas.com/docs/on-premises/design-atoms-cs/reference/api/Aurigma.DesignAtoms.Convert.md)

###### **Assembly**: Aurigma.DesignAtoms.dll

```csharp title="Syntax"
public class TemplateConverter : ITemplateConverter
```

## Implements

* [Aurigma.DesignAtoms.Convert.ITemplateConverter](https://customerscanvas.com/docs/on-premises/design-atoms-cs/reference/api/Aurigma.DesignAtoms.Convert/ITemplateConverter.md)

## Inherited Members

* `System.Object.ToString`
* `System.Object.Equals(System.Object)`
* `System.Object.Equals(System.Object,System.Object)`
* `System.Object.ReferenceEquals(System.Object,System.Object)`
* `System.Object.GetHashCode`
* `System.Object.GetType`
* `System.Object.MemberwiseClone`

## Constructors

### TemplateConverter

```csharp
public TemplateConverter(IFontSubstitutionService fontSubstitution, IFontService fontService, IConfiguration configuration, IStateResourcesLoader stateResourcesLoader, IColorManagement colorManagement, IMergeUtil mergeUtil, IImageLoader imageLoader, IFrameConfigHandlerFactory frameConfigHandlerFactory, IItemHandlerFactory itemHandlerFactory, JsonColorConverter colorConverter, ITemplateStorage templateStorage, ISourceImageParamsReader imageParamsReader, IRepositoryImageParamsReaderFactory repositoryImageParamsReaderFactory, IGmColorConverter gmColorConverter, IPdfParser pdfParser, IBoundingPathCalculationService boundingPathCalculationService, bool ignoreCreateItemExceptions = false)
```

## Methods

### Convert

```csharp
public ConvertResult Convert(string designFileName)
```

##### Parameters

| Type | Name | Description |
|:---|:---|:---|
| `System.String` | *designFileName* |  |

##### Returns

[Aurigma.DesignAtoms.Convert.ConvertResult](https://customerscanvas.com/docs/on-premises/design-atoms-cs/reference/api/Aurigma.DesignAtoms.Convert/ConvertResult.md)

### Convert

```csharp
public ConvertResult Convert(string designFileName, float? rasterDpi)
```

##### Parameters

| Type | Name | Description |
|:---|:---|:---|
| `System.String` | *designFileName* |  |
| `System.Nullable<System.Single>` | *rasterDpi* |  |

##### Returns

[Aurigma.DesignAtoms.Convert.ConvertResult](https://customerscanvas.com/docs/on-premises/design-atoms-cs/reference/api/Aurigma.DesignAtoms.Convert/ConvertResult.md)

### Convert

```csharp
public ConvertResult Convert(string designFileName, float? rasterDpi, Func<int, string> requestNameCallback)
```

##### Parameters

| Type | Name | Description |
|:---|:---|:---|
| `System.String` | *designFileName* |  |
| `System.Nullable<System.Single>` | *rasterDpi* |  |
| `System.Func<System.Int32,System.String>` | *requestNameCallback* |  |

##### Returns

[Aurigma.DesignAtoms.Convert.ConvertResult](https://customerscanvas.com/docs/on-premises/design-atoms-cs/reference/api/Aurigma.DesignAtoms.Convert/ConvertResult.md)

### Convert

```csharp
public ConvertResult Convert(string designFileName, float? rasterDpi, Func<int, string> requestNameCallback, Stream templateConfigShortcutsStream)
```

##### Parameters

| Type | Name | Description |
|:---|:---|:---|
| `System.String` | *designFileName* |  |
| `System.Nullable<System.Single>` | *rasterDpi* |  |
| `System.Func<System.Int32,System.String>` | *requestNameCallback* |  |
| `System.IO.Stream` | *templateConfigShortcutsStream* |  |

##### Returns

[Aurigma.DesignAtoms.Convert.ConvertResult](https://customerscanvas.com/docs/on-premises/design-atoms-cs/reference/api/Aurigma.DesignAtoms.Convert/ConvertResult.md)

### Convert

```csharp
public ConvertResult Convert(string designFileName, float? rasterDpi, Func<int, string> requestNameCallback, TemplateConfigShortcuts templateConfigShortcuts)
```

##### Parameters

| Type | Name | Description |
|:---|:---|:---|
| `System.String` | *designFileName* |  |
| `System.Nullable<System.Single>` | *rasterDpi* |  |
| `System.Func<System.Int32,System.String>` | *requestNameCallback* |  |
| [Aurigma.DesignAtoms.Convert.TemplateConfigShortcuts](https://customerscanvas.com/docs/on-premises/design-atoms-cs/reference/api/Aurigma.DesignAtoms.Convert/TemplateConfigShortcuts.md) | *templateConfigShortcuts* |  |

##### Returns

[Aurigma.DesignAtoms.Convert.ConvertResult](https://customerscanvas.com/docs/on-premises/design-atoms-cs/reference/api/Aurigma.DesignAtoms.Convert/ConvertResult.md)

### Convert

```csharp
public ConvertResult Convert(IEnumerable<string> designFileNames)
```

##### Parameters

| Type | Name | Description |
|:---|:---|:---|
| `System.Collections.Generic.IEnumerable<System.String>` | *designFileNames* |  |

##### Returns

[Aurigma.DesignAtoms.Convert.ConvertResult](https://customerscanvas.com/docs/on-premises/design-atoms-cs/reference/api/Aurigma.DesignAtoms.Convert/ConvertResult.md)

### Convert

```csharp
public ConvertResult Convert(IEnumerable<string> designFileNames, float? rasterDpi)
```

##### Parameters

| Type | Name | Description |
|:---|:---|:---|
| `System.Collections.Generic.IEnumerable<System.String>` | *designFileNames* |  |
| `System.Nullable<System.Single>` | *rasterDpi* |  |

##### Returns

[Aurigma.DesignAtoms.Convert.ConvertResult](https://customerscanvas.com/docs/on-premises/design-atoms-cs/reference/api/Aurigma.DesignAtoms.Convert/ConvertResult.md)

### Convert

```csharp
public ConvertResult Convert(IEnumerable<string> designFileNames, float? rasterDpi, Func<int, string> requestNameCallback)
```

##### Parameters

| Type | Name | Description |
|:---|:---|:---|
| `System.Collections.Generic.IEnumerable<System.String>` | *designFileNames* |  |
| `System.Nullable<System.Single>` | *rasterDpi* |  |
| `System.Func<System.Int32,System.String>` | *requestNameCallback* |  |

##### Returns

[Aurigma.DesignAtoms.Convert.ConvertResult](https://customerscanvas.com/docs/on-premises/design-atoms-cs/reference/api/Aurigma.DesignAtoms.Convert/ConvertResult.md)

### Convert

```csharp
public ConvertResult Convert(IEnumerable<string> designFileNames, float? rasterDpi, Func<int, string> requestNameCallback, Stream templateConfigShortcutsStream)
```

##### Parameters

| Type | Name | Description |
|:---|:---|:---|
| `System.Collections.Generic.IEnumerable<System.String>` | *designFileNames* |  |
| `System.Nullable<System.Single>` | *rasterDpi* |  |
| `System.Func<System.Int32,System.String>` | *requestNameCallback* |  |
| `System.IO.Stream` | *templateConfigShortcutsStream* |  |

##### Returns

[Aurigma.DesignAtoms.Convert.ConvertResult](https://customerscanvas.com/docs/on-premises/design-atoms-cs/reference/api/Aurigma.DesignAtoms.Convert/ConvertResult.md)

### Convert

```csharp
public ConvertResult Convert(IEnumerable<string> designFileNames, float? rasterDpi, Func<int, string> requestNameCallback, TemplateConfigShortcuts templateConfigShortcuts)
```

##### Parameters

| Type | Name | Description |
|:---|:---|:---|
| `System.Collections.Generic.IEnumerable<System.String>` | *designFileNames* |  |
| `System.Nullable<System.Single>` | *rasterDpi* |  |
| `System.Func<System.Int32,System.String>` | *requestNameCallback* |  |
| [Aurigma.DesignAtoms.Convert.TemplateConfigShortcuts](https://customerscanvas.com/docs/on-premises/design-atoms-cs/reference/api/Aurigma.DesignAtoms.Convert/TemplateConfigShortcuts.md) | *templateConfigShortcuts* |  |

##### Returns

[Aurigma.DesignAtoms.Convert.ConvertResult](https://customerscanvas.com/docs/on-premises/design-atoms-cs/reference/api/Aurigma.DesignAtoms.Convert/ConvertResult.md)

### Convert

```csharp
public ConvertResult Convert(IEnumerable<BaseTemplate> productTemplates)
```

##### Parameters

| Type | Name | Description |
|:---|:---|:---|
| `System.Collections.Generic.IEnumerable<Aurigma.DesignAtoms.Convert.BaseTemplate>` | *productTemplates* |  |

##### Returns

[Aurigma.DesignAtoms.Convert.ConvertResult](https://customerscanvas.com/docs/on-premises/design-atoms-cs/reference/api/Aurigma.DesignAtoms.Convert/ConvertResult.md)

### Convert

```csharp
public ConvertResult Convert(IEnumerable<BaseTemplate> productTemplates, float? rasterDpi)
```

##### Parameters

| Type | Name | Description |
|:---|:---|:---|
| `System.Collections.Generic.IEnumerable<Aurigma.DesignAtoms.Convert.BaseTemplate>` | *productTemplates* |  |
| `System.Nullable<System.Single>` | *rasterDpi* |  |

##### Returns

[Aurigma.DesignAtoms.Convert.ConvertResult](https://customerscanvas.com/docs/on-premises/design-atoms-cs/reference/api/Aurigma.DesignAtoms.Convert/ConvertResult.md)

### Convert

```csharp
public ConvertResult Convert(IEnumerable<BaseTemplate> productTemplates, float? rasterDpi, Func<int, string> requestNameCallback)
```

##### Parameters

| Type | Name | Description |
|:---|:---|:---|
| `System.Collections.Generic.IEnumerable<Aurigma.DesignAtoms.Convert.BaseTemplate>` | *productTemplates* |  |
| `System.Nullable<System.Single>` | *rasterDpi* |  |
| `System.Func<System.Int32,System.String>` | *requestNameCallback* |  |

##### Returns

[Aurigma.DesignAtoms.Convert.ConvertResult](https://customerscanvas.com/docs/on-premises/design-atoms-cs/reference/api/Aurigma.DesignAtoms.Convert/ConvertResult.md)

### Convert

```csharp
public ConvertResult Convert(IEnumerable<BaseTemplate> productTemplates, float? rasterDpi, Func<int, string> requestNameCallback, Stream templateConfigShortcutsStream)
```

##### Parameters

| Type | Name | Description |
|:---|:---|:---|
| `System.Collections.Generic.IEnumerable<Aurigma.DesignAtoms.Convert.BaseTemplate>` | *productTemplates* |  |
| `System.Nullable<System.Single>` | *rasterDpi* |  |
| `System.Func<System.Int32,System.String>` | *requestNameCallback* |  |
| `System.IO.Stream` | *templateConfigShortcutsStream* |  |

##### Returns

[Aurigma.DesignAtoms.Convert.ConvertResult](https://customerscanvas.com/docs/on-premises/design-atoms-cs/reference/api/Aurigma.DesignAtoms.Convert/ConvertResult.md)

### Convert

```csharp
public ConvertResult Convert(IEnumerable<BaseTemplate> productTemplates, float? rasterDpi, Func<int, string> requestNameCallback, TemplateConfigShortcuts templateConfigShortcuts)
```

##### Parameters

| Type | Name | Description |
|:---|:---|:---|
| `System.Collections.Generic.IEnumerable<Aurigma.DesignAtoms.Convert.BaseTemplate>` | *productTemplates* |  |
| `System.Nullable<System.Single>` | *rasterDpi* |  |
| `System.Func<System.Int32,System.String>` | *requestNameCallback* |  |
| [Aurigma.DesignAtoms.Convert.TemplateConfigShortcuts](https://customerscanvas.com/docs/on-premises/design-atoms-cs/reference/api/Aurigma.DesignAtoms.Convert/TemplateConfigShortcuts.md) | *templateConfigShortcuts* |  |

##### Returns

[Aurigma.DesignAtoms.Convert.ConvertResult](https://customerscanvas.com/docs/on-premises/design-atoms-cs/reference/api/Aurigma.DesignAtoms.Convert/ConvertResult.md)

### ConvertSurfaceToGroupItem

```csharp
public GroupItem ConvertSurfaceToGroupItem(Surface surface)
```

##### Parameters

| Type | Name | Description |
|:---|:---|:---|
| [Aurigma.DesignAtoms.Model.Surface](https://customerscanvas.com/docs/on-premises/design-atoms-cs/reference/api/Aurigma.DesignAtoms.Model/Surface.md) | *surface* |  |

##### Returns

[Aurigma.DesignAtoms.Model.Items.GroupItem](https://customerscanvas.com/docs/on-premises/design-atoms-cs/reference/api/Aurigma.DesignAtoms.Model.Items/GroupItem.md)

### Convert

```csharp
public ConvertResult Convert(MultipageTemplate multiPageTemplate)
```

##### Parameters

| Type | Name | Description |
|:---|:---|:---|
| [Aurigma.DesignAtoms.Convert.MultipageTemplate](https://customerscanvas.com/docs/on-premises/design-atoms-cs/reference/api/Aurigma.DesignAtoms.Convert/MultipageTemplate.md) | *multiPageTemplate* |  |

##### Returns

[Aurigma.DesignAtoms.Convert.ConvertResult](https://customerscanvas.com/docs/on-premises/design-atoms-cs/reference/api/Aurigma.DesignAtoms.Convert/ConvertResult.md)

### Convert

```csharp
public ConvertResult Convert(MultipageTemplate multiPageTemplate, float? rasterDpi)
```

##### Parameters

| Type | Name | Description |
|:---|:---|:---|
| [Aurigma.DesignAtoms.Convert.MultipageTemplate](https://customerscanvas.com/docs/on-premises/design-atoms-cs/reference/api/Aurigma.DesignAtoms.Convert/MultipageTemplate.md) | *multiPageTemplate* |  |
| `System.Nullable<System.Single>` | *rasterDpi* |  |

##### Returns

[Aurigma.DesignAtoms.Convert.ConvertResult](https://customerscanvas.com/docs/on-premises/design-atoms-cs/reference/api/Aurigma.DesignAtoms.Convert/ConvertResult.md)

### Convert

```csharp
public ConvertResult Convert(MultipageTemplate multiPageTemplate, float? rasterDpi, Func<int, string> requestNameCallback)
```

##### Parameters

| Type | Name | Description |
|:---|:---|:---|
| [Aurigma.DesignAtoms.Convert.MultipageTemplate](https://customerscanvas.com/docs/on-premises/design-atoms-cs/reference/api/Aurigma.DesignAtoms.Convert/MultipageTemplate.md) | *multiPageTemplate* |  |
| `System.Nullable<System.Single>` | *rasterDpi* |  |
| `System.Func<System.Int32,System.String>` | *requestNameCallback* |  |

##### Returns

[Aurigma.DesignAtoms.Convert.ConvertResult](https://customerscanvas.com/docs/on-premises/design-atoms-cs/reference/api/Aurigma.DesignAtoms.Convert/ConvertResult.md)

### Convert

```csharp
public ConvertResult Convert(MultipageTemplate multiPageTemplate, float? rasterDpi, Func<int, string> requestNameCallback, Stream templateConfigShortcutsStream)
```

##### Parameters

| Type | Name | Description |
|:---|:---|:---|
| [Aurigma.DesignAtoms.Convert.MultipageTemplate](https://customerscanvas.com/docs/on-premises/design-atoms-cs/reference/api/Aurigma.DesignAtoms.Convert/MultipageTemplate.md) | *multiPageTemplate* |  |
| `System.Nullable<System.Single>` | *rasterDpi* |  |
| `System.Func<System.Int32,System.String>` | *requestNameCallback* |  |
| `System.IO.Stream` | *templateConfigShortcutsStream* |  |

##### Returns

[Aurigma.DesignAtoms.Convert.ConvertResult](https://customerscanvas.com/docs/on-premises/design-atoms-cs/reference/api/Aurigma.DesignAtoms.Convert/ConvertResult.md)

### Convert

```csharp
public ConvertResult Convert(MultipageTemplate multiPageTemplate, float? rasterDpi, Func<int, string> requestNameCallback, TemplateConfigShortcuts templateConfigShortcuts)
```

##### Parameters

| Type | Name | Description |
|:---|:---|:---|
| [Aurigma.DesignAtoms.Convert.MultipageTemplate](https://customerscanvas.com/docs/on-premises/design-atoms-cs/reference/api/Aurigma.DesignAtoms.Convert/MultipageTemplate.md) | *multiPageTemplate* |  |
| `System.Nullable<System.Single>` | *rasterDpi* |  |
| `System.Func<System.Int32,System.String>` | *requestNameCallback* |  |
| [Aurigma.DesignAtoms.Convert.TemplateConfigShortcuts](https://customerscanvas.com/docs/on-premises/design-atoms-cs/reference/api/Aurigma.DesignAtoms.Convert/TemplateConfigShortcuts.md) | *templateConfigShortcuts* |  |

##### Returns

[Aurigma.DesignAtoms.Convert.ConvertResult](https://customerscanvas.com/docs/on-premises/design-atoms-cs/reference/api/Aurigma.DesignAtoms.Convert/ConvertResult.md)

### ParseMockup

```csharp
[HandleProcessCorruptedStateExceptions]
protected virtual Tuple<SizeF?, MissingFontsCollection> ParseMockup(TemplateImage mockupImage, Collection<MockupContainer> container, bool createSmartItem = false)
```

##### Parameters

| Type | Name | Description |
|:---|:---|:---|
| [Aurigma.DesignAtoms.Convert.Unit.TemplateImage](https://customerscanvas.com/docs/on-premises/design-atoms-cs/reference/api/Aurigma.DesignAtoms.Convert.Unit/TemplateImage.md) | *mockupImage* |  |
| `Aurigma.DesignAtoms.Canvas.Collection.Collection<Aurigma.DesignAtoms.Model.MockupContainer>` | *container* |  |
| `System.Boolean` | *createSmartItem* |  |

##### Returns

`System.Tuple<System.Nullable<System.Drawing.SizeF>,Aurigma.DesignAtoms.Convert.MissingFontsCollection>`

### ParsePreviewMockups

```csharp
protected void ParsePreviewMockups(SurfaceTemplate template, Surface surface)
```

##### Parameters

| Type | Name | Description |
|:---|:---|:---|
| [Aurigma.DesignAtoms.Convert.SurfaceTemplate](https://customerscanvas.com/docs/on-premises/design-atoms-cs/reference/api/Aurigma.DesignAtoms.Convert/SurfaceTemplate.md) | *template* |  |
| [Aurigma.DesignAtoms.Model.Surface](https://customerscanvas.com/docs/on-premises/design-atoms-cs/reference/api/Aurigma.DesignAtoms.Model/Surface.md) | *surface* |  |

### ParseDesign

```csharp
protected virtual Tuple<SizeF?, DesignImagesCollection, MissingFontsCollection> ParseDesign(TemplateImage designImage, Surface surface, SurfaceTemplate template, TemplateConfigShortcuts templateConfigShortcuts, float? rasterDpi = null, int printAreaIndex = 0)
```

##### Parameters

| Type | Name | Description |
|:---|:---|:---|
| [Aurigma.DesignAtoms.Convert.Unit.TemplateImage](https://customerscanvas.com/docs/on-premises/design-atoms-cs/reference/api/Aurigma.DesignAtoms.Convert.Unit/TemplateImage.md) | *designImage* |  |
| [Aurigma.DesignAtoms.Model.Surface](https://customerscanvas.com/docs/on-premises/design-atoms-cs/reference/api/Aurigma.DesignAtoms.Model/Surface.md) | *surface* |  |
| [Aurigma.DesignAtoms.Convert.SurfaceTemplate](https://customerscanvas.com/docs/on-premises/design-atoms-cs/reference/api/Aurigma.DesignAtoms.Convert/SurfaceTemplate.md) | *template* |  |
| [Aurigma.DesignAtoms.Convert.TemplateConfigShortcuts](https://customerscanvas.com/docs/on-premises/design-atoms-cs/reference/api/Aurigma.DesignAtoms.Convert/TemplateConfigShortcuts.md) | *templateConfigShortcuts* |  |
| `System.Nullable<System.Single>` | *rasterDpi* |  |
| `System.Int32` | *printAreaIndex* |  |

##### Returns

`System.Tuple<System.Nullable<System.Drawing.SizeF>,Aurigma.DesignAtoms.Convert.DesignImagesCollection,Aurigma.DesignAtoms.Convert.MissingFontsCollection>`

### SetExternalConverter

```csharp
protected void SetExternalConverter(IExternalConverter converter)
```

##### Parameters

| Type | Name | Description |
|:---|:---|:---|
| [Aurigma.DesignAtoms.Common.ExternalConverter.IExternalConverter](https://customerscanvas.com/docs/on-premises/design-atoms-cs/reference/api/Aurigma.DesignAtoms.Common.ExternalConverter/IExternalConverter.md) | *converter* |  |