Method ExportArticleImage
ExportArticleImage(string, HandingType, bool, ViewMode, string, int, int, bool, string, int, int)
Exports thumbnail corresponding to a given article as an image file.
Declaration
public void ExportArticleImage(string articleReference, Scene.Object.HandingType handingType, bool opened, Scene.ViewMode viewMode, string imageFilename, int imageWidth, int imageHeight, bool transparent = true, string backgroundColor = "255,255,255", int jpegQuality = 100, int antialiasing = 1)Parameters
| Type | Name | Description |
|---|---|---|
| string | articleReference | Reference of the article to be exported. |
| Scene.Object.HandingType | handingType | Handing type of the article to be exported. |
| bool | opened | Indicates whether the article should be represented in its open visual state. |
| Scene.ViewMode | viewMode | Specifies the view mode of the article that should be generated. |
| string | imageFilename | Filename of the image to create. The image format is determined from the filename extension. |
| int | imageWidth | Width of the image to create, in pixels. |
| int | imageHeight | Height of the image to create, in pixels. |
| bool | transparent | Indicates whether an image should be exported with transparent background. This parameter is ignored for the formats that do not support transparency. |
| string | backgroundColor | Background color of the image.
It's a character string representing the decimal values in
range 0-255 for red, green, and blue, comma-separated (e.g.
|
| int | jpegQuality | The quality level of the image if the export format is JPEG. Should be in 0-100 range. |
| int | antialiasing | Specified the antialiasing level used to reduce the stairs effect on the oblique lines. See ExportImage(string, int, int, bool, string, int, int) for the explanation. |
Remarks
Supported image formats are .JPG, .BMP, .GIF, .PNG, and .TIF for raster images. For vectorial images .EMF, .WMF, and .SVG are supported. Vectorial image can be exported in top view mode only.
Note: the model and the finishes that will be applied to the article for the generated image are those of the presentation scene corresponding to the catalog (see the LoadCatalogScene(string) and SaveCatalogScene(string) remarks for details.