Extensibility > Graphics Builder Automation Interface > Miscellaneous Functions > GetOnBitmap

GetOnBitmap

Returns bitmap data for an object. The data can be saved directly as the contents of a bitmap file, and includes both a BITMAPFILEHEADER and a BITMAPV4HEADER with transparency information. Object needs to be a bitmap or an error message will be raised.

This function applies to the selected object, which is typically the last placed object. By using the PageSelectFirstObject() and PageSelectNextObject() functions, you can access your objects and change or read their properties.

The On and Off versions are provided to support flashing colors (similar to other automation interface functions)

Syntax

GetOnBitmap(Bitmap)

Bitmap:

Returns the bitmap as SAFEARRAY.

	Result = GraphicsBuilder.GetOnBitmap bitmap

Return Value

Success or failure.

Note: For details on handling return and error values, see Error Handling.

Published June 2018