Generate

Generate(Stream, GlobalPageSettings, ImageCollection, Encoding)

Creates a GenerationResult which contains template (.omr) and template image based on markup stream

public GenerationResult Generate(Stream markupStream, GlobalPageSettings settings = null, 
    ImageCollection collection = null, Encoding encoding = null)
ParameterTypeDescription
markupStreamStreamReadable stream which contains markup lines for tempalte config(txt or json)
settingsGlobalPageSettingsglobal settings used in template generation for all pages
collectionImageCollectionCollection of images that can be used for a template generation. Allow to use images from MemoryStream instead of file system
encodingEncodingmarkup lines encoding, by default UTF-8 is used

Return Value

Generation result

Exceptions

exceptioncondition
ArgumentNullExceptionmarkupPath

See Also


Generate(string, GlobalPageSettings, string[], Encoding)

Creates a GenerationResult which contains template (.omr) and template image based on markup content stored by specified path

public GenerationResult Generate(string markupPath, GlobalPageSettings settings = null, 
    string[] imagesPaths = null, Encoding encoding = null)
ParameterTypeDescription
markupPathStringPath to a file which contains markup lines for tempalte config(txt or json)
settingsGlobalPageSettingsglobal settings used in template generation for all pages
imagesPathsString[]Path to images that will be used for a template generation
encodingEncodingmarkup lines encoding, by default UTF-8 is used

Return Value

Generation result

Exceptions

exceptioncondition
ArgumentNullExceptionmarkupPath
FileNotFoundExceptionmarkupPath

See Also


Generate(string[], GlobalPageSettings, ImageCollection)

Creates a GenerationResult which contains template (.omr) and template image based on markup content

public GenerationResult Generate(string[] markupContent, GlobalPageSettings settings = null, 
    ImageCollection collection = null)
ParameterTypeDescription
markupContentString[]Collection markup lines for template config(txt or json)
settingsGlobalPageSettingsglobal settings used in template generation for all pages
collectionImageCollectionCollection of images that can be used for a template generation. Allow to use images from MemoryStream instead of file system

Return Value

Generation result

Exceptions

exceptioncondition
ArgumentNullException

See Also


Generate(TemplateConfig, GlobalPageSettings, ImageCollection)

Creates a GenerationResult which contains template (.omr) and template image based on markup content

public GenerationResult Generate(TemplateConfig config, GlobalPageSettings settings = null, 
    ImageCollection collection = null)
ParameterTypeDescription
configTemplateConfigTemplate config,
settingsGlobalPageSettingsglobal settings used in template generation for all pages
collectionImageCollectionCollection of images that can be used for a template generation. Allow to use images from MemoryStream instead of file system

Return Value

Generation result

See Also