Camera.SaveAsBitmapWithOptions Method
Parent Object: CameraDescription
Method that saves the view as a bitmap with more options.
Syntax
Camera.SaveAsBitmapWithOptions( FullFileName As String, Width As Long, Height As Long, Options As NameValueMap )Parameters
| Name | Type | Description |
| FullFileName | String | Input String value that specifies the full filename of the file to which to save the view. The extension of this filename controls the type of file that’s created. Valid extensions are bmp, jpg, png, tiff, and gif. |
| Width | Long | Input Long that specifies the width of the view. A value of 0 will use the current width. |
| Height | Long | Input Long that specifies the height of the view. A value of 0 will use the current height. |
| Options | NameValueMap | Input NameValueMap that specifies more options to create the bitmap. The valid values for the options are: Name = TransparentBackground. Value = Boolean value that specifies whether the saved bitmap will have transparent background. If not specified this will default to False. Name = TopBackgroundColor. Value = Color object that specifies the background color at the top of the image. If a bottom background color is supplied, then the background will be a gradient between the top and bottom colors. If only a top background color is supplied, the background will be a solid color using this color. If no color is defined a default color will be used. Name = BottomBackgroundColor. Value = Color object that specified the background color at the bottom of the image. This argument is only valid when the TopBackgroundColor argument has been supplied. This argument defines the color of the background at the bottom of the image and a gradient background is created that varies from the top color to the bottom color. |