IDLgrClipboard Properties

IDLgrClipboard objects have the following properties in addition to properties inherited from any superclasses. Properties with the word "Yes" in the "Get" column of the property table can be retrieved via IDLgrClipboard::GetProperty. Properties with the word "Yes" in the "Init" column of the property table can be set via IDLgrClipboard::Init. Properties with the word "Yes" in the "Set" column in the property table can be set via IDLgrClipboard::SetProperty.

Note
For a discussion of the property description tables shown below, see About Object Property Descriptions.

Objects of this class have the following properties.

In addition, objects of this class inherit:

ALL

An anonymous structure that contains the values of all of the retrievable properties associated with this object.

COLOR_MODEL

An integer value or enumerated list item that determines whether to use the indexed color model for the clipboard buffer:

Note
See "Color and Destination Objects" (Object Programming) for more information.

DIMENSIONS

A two-element integer vector of the form [width, height] to specify the dimensions of the clipboard buffer in units specified by the UNITS property. The default is [640,480].

GRAPHICS_TREE

An object reference of type IDLgrScene, IDLgrViewgroup, or IDLgrView that specifies the graphic tree of this object. If this property is set to a valid object reference, calling the Draw method on the destination object with no arguments will cause the object reference associated with this property to be drawn. If this object is valid and the destination object is destroyed, this object reference will be destroyed as well. By default the GRAPHICS_TREE property is set equal to the null-object.

N_COLORS

An integer value that determines the number of colors (between 2 and 256) to be used if COLOR_MODEL is set to Color Index.

PALETTE

An object reference to a palette object (an instance of the IDLgrPalette object class) that specifies the red, green, and blue values that are to be loaded into the clipboard buffer's color lookup table.

Note
Objects specified via this property are not automatically cleaned up when the IDLgrClipboard object is destroyed.

This property is registered as a user-defined property, but it is hidden by default.

QUALITY

An integer value or enumerated list item indicating the rendering quality at which graphics are to be drawn to the clipboard buffer. Valid values are:

REGISTER_PROPERTIES

A Boolean value that determines whether to register properties available for this object. If this property is set, all properties marked in this properties section as "Registered: Yes" will be registered for display in a property sheet. This property is useful mainly when creating iTools. By default, no properties are registered.

RESOLUTION

A two-element floating-point vector of the form [xres, yres] specifying the device resolution in centimeters per pixel. This value is stored in double precision. The default value is: [0.035277778, 0.035277778] (72 DPI).

Note
To match screen rendering on an IDLgrClipboard object, the following properties should be matched between the devices: DIMENSIONS, UNITS, RESOLUTION, COLOR_MODEL and N_COLORS.

This property is registered as a user-defined property, but it is hidden by default.

SCREEN_DIMENSIONS

A two-element integer vector of the form [width, height] that specifies the maximum allowed dimensions (measured in device units) for the clipboard object.

UNITS

An integer value that indicates the units of measure for the DIMENSIONS property. Valid values are: