GenerateTemplate

GenerateTemplate(MemoryStream, GlobalPageSettings, ImageCollection, Encoding)

Creates a template (.omr) and template image based on MemoryStream

public GenerationResult GenerateTemplate(MemoryStream stream, GlobalPageSettings settings, 
    ImageCollection userImages = null, Encoding encoding = null)
Parameter Type Description
stream MemoryStream The stream which contains markup lines
settings GlobalPageSettings The global settings applicable to all page elements
userImages ImageCollection Collection of images that can be used for a template generation. Allow to use images from MemoryStream instead of file system
encoding Encoding markup lines encoding, by default UTF-8 is used

Return Value

Generation result

See Also


GenerateTemplate(MemoryStream, ImageCollection, Encoding)

Creates a template (.omr) and template image based on MemoryStream

public GenerationResult GenerateTemplate(MemoryStream stream, ImageCollection userImages = null, 
    Encoding encoding = null)
Parameter Type Description
stream MemoryStream The stream which contains markup lines
userImages ImageCollection Collection of images that can be used for a template generation. Allow to use images from MemoryStream instead of file system
encoding Encoding markup lines encoding, by default UTF-8 is used

Return Value

Generation result

See Also


GenerateTemplate(string[], GlobalPageSettings, ImageCollection)

Creates a template (.omr) and template image based on an array of the markup lines

public GenerationResult GenerateTemplate(string[] markupLines, GlobalPageSettings settings, 
    ImageCollection userImages = null)
Parameter Type Description
markupLines String[] Array of the markup lines
settings GlobalPageSettings The global settings applicable to all page elements
userImages ImageCollection Collection 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


GenerateTemplate(string[], ImageCollection)

Creates a template (.omr) and template image based on an array of the markup lines

public GenerationResult GenerateTemplate(string[] markupLines, ImageCollection userImages = null)
Parameter Type Description
markupLines String[] Array of the markup lines
userImages ImageCollection Collection 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


GenerateTemplate(string, GlobalPageSettings, Encoding)

Creates a template (.omr) and template image based on text markup

public GenerationResult GenerateTemplate(string markupPath, GlobalPageSettings settings, 
    Encoding encoding = null)
Parameter Type Description
markupPath String Path to the text markup file
settings GlobalPageSettings The global settings applicable to all page elements
encoding Encoding markup file encoding, by default UTF-8 is used

Return Value

Generation result

See Also


GenerateTemplate(string, Encoding)

Creates a template (.omr) and template image based on text markup

public GenerationResult GenerateTemplate(string markupPath, Encoding encoding = null)
Parameter Type Description
markupPath String Path to the text markup file
encoding Encoding markup file encoding, by default UTF-8 is used

Return Value

Generation result

See Also


GenerateTemplate(string, string[], Encoding)

Creates a template (.omr) and template image based on text markup

public GenerationResult GenerateTemplate(string markupPath, string[] imagesPaths, 
    Encoding encoding = null)
Parameter Type Description
markupPath String Path to the text markup file
imagesPaths String[] Full paths to the images used in generation
encoding Encoding markup file encoding, by default UTF-8 is used

Return Value

Generation result

See Also


GenerateTemplate(TemplateConfig, GlobalPageSettings, ImageCollection)

Creates a template (.omr) and template image based on Template object

public GenerationResult GenerateTemplate(TemplateConfig config, GlobalPageSettings settings, 
    ImageCollection userImages = null)
Parameter Type Description
config TemplateConfig Template object that represent all elements
settings GlobalPageSettings global settings used in all template generation
userImages ImageCollection Collection 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