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)
ParameterTypeDescription
streamMemoryStreamThe stream which contains markup lines
settingsGlobalPageSettingsThe global settings applicable to all page elements
userImagesImageCollectionCollection 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

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)
ParameterTypeDescription
streamMemoryStreamThe stream which contains markup lines
userImagesImageCollectionCollection 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

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)
ParameterTypeDescription
markupLinesString[]Array of the markup lines
settingsGlobalPageSettingsThe global settings applicable to all page elements
userImagesImageCollectionCollection 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)
ParameterTypeDescription
markupLinesString[]Array of the markup lines
userImagesImageCollectionCollection 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)
ParameterTypeDescription
markupPathStringPath to the text markup file
settingsGlobalPageSettingsThe global settings applicable to all page elements
encodingEncodingmarkup 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)
ParameterTypeDescription
markupPathStringPath to the text markup file
encodingEncodingmarkup 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)
ParameterTypeDescription
markupPathStringPath to the text markup file
imagesPathsString[]Full paths to the images used in generation
encodingEncodingmarkup 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)
ParameterTypeDescription
configTemplateConfigTemplate object that represent all elements
settingsGlobalPageSettingsglobal settings used in all template generation
userImagesImageCollectionCollection 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