Generate
Contents
[
Hide
]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)
| Parameter | Type | Description |
|---|---|---|
| markupStream | Stream | Readable stream which contains markup lines for tempalte config(txt or json) |
| settings | GlobalPageSettings | global settings used in template generation for all pages |
| collection | 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
Exceptions
| exception | condition |
|---|---|
| ArgumentNullException | markupPath |
See Also
- class GenerationResult
- class GlobalPageSettings
- class ImageCollection
- class OmrEngine
- namespace Aspose.OMR.Api
- assembly Aspose.OMR
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)
| Parameter | Type | Description |
|---|---|---|
| markupPath | String | Path to a file which contains markup lines for tempalte config(txt or json) |
| settings | GlobalPageSettings | global settings used in template generation for all pages |
| imagesPaths | String[] | Path to images that will be used for a template generation |
| encoding | Encoding | markup lines encoding, by default UTF-8 is used |
Return Value
Generation result
Exceptions
| exception | condition |
|---|---|
| ArgumentNullException | markupPath |
| FileNotFoundException | markupPath |
See Also
- class GenerationResult
- class GlobalPageSettings
- class OmrEngine
- namespace Aspose.OMR.Api
- assembly Aspose.OMR
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)
| Parameter | Type | Description |
|---|---|---|
| markupContent | String[] | Collection markup lines for template config(txt or json) |
| settings | GlobalPageSettings | global settings used in template generation for all pages |
| collection | 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
Exceptions
| exception | condition |
|---|---|
| ArgumentNullException |
See Also
- class GenerationResult
- class GlobalPageSettings
- class ImageCollection
- class OmrEngine
- namespace Aspose.OMR.Api
- assembly Aspose.OMR
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)
| Parameter | Type | Description |
|---|---|---|
| config | TemplateConfig | Template config, |
| settings | GlobalPageSettings | global settings used in template generation for all pages |
| collection | 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
- class GenerationResult
- class TemplateConfig
- class GlobalPageSettings
- class ImageCollection
- class OmrEngine
- namespace Aspose.OMR.Api
- assembly Aspose.OMR