Contact us

Applies to: Customer's Canvas On-Premises; Design Atoms .NET 7.0 - 7.4

Skip to main content

Class TemplateConverter

Namespace: Aurigma.DesignAtoms.Convert​
Assembly: Aurigma.DesignAtoms.dll​
Syntax
public class TemplateConverter : ITemplateConverter

Inheritance: System.Object -> TemplateConverter

Implements​

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​

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​

public ConvertResult Convert(string designFileName)
Parameters​
TypeNameDescription
System.StringdesignFileName
Returns​

Aurigma.DesignAtoms.Convert.ConvertResult

Convert​

public ConvertResult Convert(string designFileName, float? rasterDpi)
Parameters​
TypeNameDescription
System.StringdesignFileName
System.Nullable<System.Single>rasterDpi
Returns​

Aurigma.DesignAtoms.Convert.ConvertResult

Convert​

public ConvertResult Convert(string designFileName, float? rasterDpi, Func<int, string> requestNameCallback)
Parameters​
TypeNameDescription
System.StringdesignFileName
System.Nullable<System.Single>rasterDpi
System.Func<System.Int32,System.String>requestNameCallback
Returns​

Aurigma.DesignAtoms.Convert.ConvertResult

Convert​

public ConvertResult Convert(string designFileName, float? rasterDpi, Func<int, string> requestNameCallback, Stream templateConfigShortcutsStream)
Parameters​
TypeNameDescription
System.StringdesignFileName
System.Nullable<System.Single>rasterDpi
System.Func<System.Int32,System.String>requestNameCallback
System.IO.StreamtemplateConfigShortcutsStream
Returns​

Aurigma.DesignAtoms.Convert.ConvertResult

Convert​

public ConvertResult Convert(string designFileName, float? rasterDpi, Func<int, string> requestNameCallback, TemplateConfigShortcuts templateConfigShortcuts)
Parameters​
TypeNameDescription
System.StringdesignFileName
System.Nullable<System.Single>rasterDpi
System.Func<System.Int32,System.String>requestNameCallback
Aurigma.DesignAtoms.Convert.TemplateConfigShortcutstemplateConfigShortcuts
Returns​

Aurigma.DesignAtoms.Convert.ConvertResult

Convert​

public ConvertResult Convert(IEnumerable<string> designFileNames)
Parameters​
TypeNameDescription
System.Collections.Generic.IEnumerable<System.String>designFileNames
Returns​

Aurigma.DesignAtoms.Convert.ConvertResult

Convert​

public ConvertResult Convert(IEnumerable<string> designFileNames, float? rasterDpi)
Parameters​
TypeNameDescription
System.Collections.Generic.IEnumerable<System.String>designFileNames
System.Nullable<System.Single>rasterDpi
Returns​

Aurigma.DesignAtoms.Convert.ConvertResult

Convert​

public ConvertResult Convert(IEnumerable<string> designFileNames, float? rasterDpi, Func<int, string> requestNameCallback)
Parameters​
TypeNameDescription
System.Collections.Generic.IEnumerable<System.String>designFileNames
System.Nullable<System.Single>rasterDpi
System.Func<System.Int32,System.String>requestNameCallback
Returns​

Aurigma.DesignAtoms.Convert.ConvertResult

Convert​

public ConvertResult Convert(IEnumerable<string> designFileNames, float? rasterDpi, Func<int, string> requestNameCallback, Stream templateConfigShortcutsStream)
Parameters​
TypeNameDescription
System.Collections.Generic.IEnumerable<System.String>designFileNames
System.Nullable<System.Single>rasterDpi
System.Func<System.Int32,System.String>requestNameCallback
System.IO.StreamtemplateConfigShortcutsStream
Returns​

Aurigma.DesignAtoms.Convert.ConvertResult

Convert​

public ConvertResult Convert(IEnumerable<string> designFileNames, float? rasterDpi, Func<int, string> requestNameCallback, TemplateConfigShortcuts templateConfigShortcuts)
Parameters​
TypeNameDescription
System.Collections.Generic.IEnumerable<System.String>designFileNames
System.Nullable<System.Single>rasterDpi
System.Func<System.Int32,System.String>requestNameCallback
Aurigma.DesignAtoms.Convert.TemplateConfigShortcutstemplateConfigShortcuts
Returns​

Aurigma.DesignAtoms.Convert.ConvertResult

Convert​

public ConvertResult Convert(IEnumerable<BaseTemplate> productTemplates)
Parameters​
TypeNameDescription
System.Collections.Generic.IEnumerable<Aurigma.DesignAtoms.Convert.BaseTemplate>productTemplates
Returns​

Aurigma.DesignAtoms.Convert.ConvertResult

Convert​

public ConvertResult Convert(IEnumerable<BaseTemplate> productTemplates, float? rasterDpi)
Parameters​
TypeNameDescription
System.Collections.Generic.IEnumerable<Aurigma.DesignAtoms.Convert.BaseTemplate>productTemplates
System.Nullable<System.Single>rasterDpi
Returns​

Aurigma.DesignAtoms.Convert.ConvertResult

Convert​

public ConvertResult Convert(IEnumerable<BaseTemplate> productTemplates, float? rasterDpi, Func<int, string> requestNameCallback)
Parameters​
TypeNameDescription
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

Convert​

public ConvertResult Convert(IEnumerable<BaseTemplate> productTemplates, float? rasterDpi, Func<int, string> requestNameCallback, Stream templateConfigShortcutsStream)
Parameters​
TypeNameDescription
System.Collections.Generic.IEnumerable<Aurigma.DesignAtoms.Convert.BaseTemplate>productTemplates
System.Nullable<System.Single>rasterDpi
System.Func<System.Int32,System.String>requestNameCallback
System.IO.StreamtemplateConfigShortcutsStream
Returns​

Aurigma.DesignAtoms.Convert.ConvertResult

ConvertSurfaceToGroupItem​

public GroupItem ConvertSurfaceToGroupItem(Surface surface)
Parameters​
TypeNameDescription
Aurigma.DesignAtoms.Model.Surfacesurface
Returns​

Aurigma.DesignAtoms.Model.Items.GroupItem

Convert​

public ConvertResult Convert(MultipageTemplate multiPageTemplate)
Parameters​
TypeNameDescription
Aurigma.DesignAtoms.Convert.MultipageTemplatemultiPageTemplate
Returns​

Aurigma.DesignAtoms.Convert.ConvertResult

Convert​

public ConvertResult Convert(MultipageTemplate multiPageTemplate, float? rasterDpi)
Parameters​
TypeNameDescription
Aurigma.DesignAtoms.Convert.MultipageTemplatemultiPageTemplate
System.Nullable<System.Single>rasterDpi
Returns​

Aurigma.DesignAtoms.Convert.ConvertResult

Convert​

public ConvertResult Convert(MultipageTemplate multiPageTemplate, float? rasterDpi, Func<int, string> requestNameCallback)
Parameters​
TypeNameDescription
Aurigma.DesignAtoms.Convert.MultipageTemplatemultiPageTemplate
System.Nullable<System.Single>rasterDpi
System.Func<System.Int32,System.String>requestNameCallback
Returns​

Aurigma.DesignAtoms.Convert.ConvertResult

Convert​

public ConvertResult Convert(MultipageTemplate multiPageTemplate, float? rasterDpi, Func<int, string> requestNameCallback, Stream templateConfigShortcutsStream)
Parameters​
TypeNameDescription
Aurigma.DesignAtoms.Convert.MultipageTemplatemultiPageTemplate
System.Nullable<System.Single>rasterDpi
System.Func<System.Int32,System.String>requestNameCallback
System.IO.StreamtemplateConfigShortcutsStream
Returns​

Aurigma.DesignAtoms.Convert.ConvertResult

Convert​

public ConvertResult Convert(IEnumerable<BaseTemplate> productTemplates, float? rasterDpi, Func<int, string> requestNameCallback, TemplateConfigShortcuts templateConfigShortcuts)
Parameters​
TypeNameDescription
System.Collections.Generic.IEnumerable<Aurigma.DesignAtoms.Convert.BaseTemplate>productTemplates
System.Nullable<System.Single>rasterDpi
System.Func<System.Int32,System.String>requestNameCallback
Aurigma.DesignAtoms.Convert.TemplateConfigShortcutstemplateConfigShortcuts
Returns​

Aurigma.DesignAtoms.Convert.ConvertResult

Convert​

public ConvertResult Convert(MultipageTemplate multiPageTemplate, float? rasterDpi, Func<int, string> requestNameCallback, TemplateConfigShortcuts templateConfigShortcuts)
Parameters​
TypeNameDescription
Aurigma.DesignAtoms.Convert.MultipageTemplatemultiPageTemplate
System.Nullable<System.Single>rasterDpi
System.Func<System.Int32,System.String>requestNameCallback
Aurigma.DesignAtoms.Convert.TemplateConfigShortcutstemplateConfigShortcuts
Returns​

Aurigma.DesignAtoms.Convert.ConvertResult

Convert​

public ConvertResult Convert(string designFileName, ConvertSettings convertSettings)
Parameters​
TypeNameDescription
System.StringdesignFileName
Aurigma.DesignAtoms.Convert.Settings.ConvertSettingsconvertSettings
Returns​

Aurigma.DesignAtoms.Convert.ConvertResult

Convert​

public ConvertResult Convert(IEnumerable<string> designFileNames, ConvertSettings convertSettings)
Parameters​
TypeNameDescription
System.Collections.Generic.IEnumerable<System.String>designFileNames
Aurigma.DesignAtoms.Convert.Settings.ConvertSettingsconvertSettings
Returns​

Aurigma.DesignAtoms.Convert.ConvertResult

Convert​

public ConvertResult Convert(IEnumerable<BaseTemplate> productTemplates, ConvertSettings convertSettings)
Parameters​
TypeNameDescription
System.Collections.Generic.IEnumerable<Aurigma.DesignAtoms.Convert.BaseTemplate>productTemplates
Aurigma.DesignAtoms.Convert.Settings.ConvertSettingsconvertSettings
Returns​

Aurigma.DesignAtoms.Convert.ConvertResult

Convert​

public ConvertResult Convert(MultipageTemplate multiPageTemplate, ConvertSettings convertSettings)
Parameters​
TypeNameDescription
Aurigma.DesignAtoms.Convert.MultipageTemplatemultiPageTemplate
Aurigma.DesignAtoms.Convert.Settings.ConvertSettingsconvertSettings
Returns​

Aurigma.DesignAtoms.Convert.ConvertResult

ParseMockup​

[HandleProcessCorruptedStateExceptions]
protected virtual Tuple<SizeF?, MissingFontsCollection> ParseMockup(TemplateImage mockupImage, Collection<MockupContainer> container, ConvertSettings convertSettings, bool createSmartItem = false)
Parameters​
TypeNameDescription
Aurigma.DesignAtoms.Convert.Unit.TemplateImagemockupImage
Aurigma.DesignAtoms.Canvas.Collection.Collection<Aurigma.DesignAtoms.Model.MockupContainer>container
Aurigma.DesignAtoms.Convert.Settings.ConvertSettingsconvertSettings
System.BooleancreateSmartItem
Returns​

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

ParsePreviewMockups​

protected void ParsePreviewMockups(SurfaceTemplate template, Surface surface, ConvertSettings convertSettings)
Parameters​
TypeNameDescription
Aurigma.DesignAtoms.Convert.SurfaceTemplatetemplate
Aurigma.DesignAtoms.Model.Surfacesurface
Aurigma.DesignAtoms.Convert.Settings.ConvertSettingsconvertSettings

ParseDesign​

protected virtual Tuple<SizeF?, DesignImagesCollection, MissingFontsCollection> ParseDesign(TemplateImage designImage, Surface surface, SurfaceTemplate template, ConvertSettings convertSettings, int printAreaIndex = 0)
Parameters​
TypeNameDescription
Aurigma.DesignAtoms.Convert.Unit.TemplateImagedesignImage
Aurigma.DesignAtoms.Model.Surfacesurface
Aurigma.DesignAtoms.Convert.SurfaceTemplatetemplate
Aurigma.DesignAtoms.Convert.Settings.ConvertSettingsconvertSettings
System.Int32printAreaIndex
Returns​

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

SetExternalConverter​

protected void SetExternalConverter(IExternalConverter converter)
Parameters​
TypeNameDescription
Aurigma.DesignAtoms.Common.ExternalConverter.IExternalConverterconverter
Was this page helpful?