Properties

AutoRedraw, AutoSize, BackColor, BackStyle, BorderStyle, CurrentX, CurrentY, DownPicture, DownURLPicture, DrawMode, DrawStyle, DrawWidth, Enabled, FillColor, FillStyle, FontBold, FontItalic, FontName, FontSize, FontStrikethru, FontTransparent, FontUnderline, ForeColor, hDC, hWnd, MouseIcon, MousePointer, NavBookmark, NavFrame, NavURL, OverPicture, OverURLPicture, Picture, ScaleHeight, ScaleLeft, ScaleMode, ScaleTop, ScaleWidth, Stretch, URLPicture

AutoRedraw

Description

Returns/sets the output from a graphics method to a persistent bitmap.

Syntax

object.AutoRedraw [= bool]

Part Description

object an object expression that evaluates to a gtimage control.

bool Optional. A boolean value that specifies whether or not to use a persistent bitmap.

Return Value

Returns a boolean value that specifies whether or not a persistent bitmap is being used.

Remarks

A using a persistent bitmap redraws the object quicker, but uses more resources.

AutoSize

Description

Determines whether or not the control is sized to fit the image.

Syntax

object.AutoSize [= bool]

Part Description

object an object expression that evaluates to a gtimage control.

bool Optional. A boolean value that specifies whether or not the control is automatically resized.

Return Value

Returns a boolean value that specifies whether or not the control is automatically resized.

Remarks

None.

BackColor

Description

Returns/sets the background color used to display text and graphics in an object.

Syntax

object.BackColor [= long]

Part Description

object an object expression that evaluates to a gtimage control.

long Optional. A long value that specifies the new background color.

Return Value

Returns a long value that specifies the current background color.

Remarks

Example: Red=&HFF0000 Green=&H00FF00 Blue=&H0000FF

BackStyle

Description

Indicates whether the background is transparent or opaque.

Syntax

object.BackStyle [= integer]

Part Description

object an object expression that evaluates to a gtimage control.

integer Optional. An integer value that specifies whether the background is transparent or opaque.

Return Value

Returns an integer value that specifies whether the background is transparent or opaque.

Settings

The settings for integer are:

0 Transparent — background color and any graphics are visible behind the object.
1 (Default) Opaque — the object's BackColor property setting fills the object and obscures any color or graphics behind it.

Remarks

None.

BorderStyle

Description

Returns/sets the border style for an object.

Syntax

object.BorderStyle [= integer]

Part Description

object an object expression that evaluates to a gtimage control.

integer Optional. An integer value that specifies the new border style.

Return Value

Returns an integer value that specifies the border style

Settings

The settings for integer are:

0 (Default) No border or border-related elements.
1 Fixed single.

Remarks

None

CurrentX

Description

Returns/sets the horizontal coordinates for next graphics methods.

Syntax

object.CurrentX [= single]

Part Description

object an object expression that evaluates to a gtimage control.

single Optional. A single value that specifies the new horizontal coordinate.

Return Value

Returns a single value the specifies the current horizontal coordinate.

Remarks

See CurrentY.

CurrentY

Description

Returns/sets the vertical coordinates for next graphics methods.

Syntax

object.CurrentY [= single]

Part Description

object an object expression that evaluates to a gtimage control.

single Optional. A single value that specifies the new vertical coordinate.

Return Value

Returns a single value that specifies the current vertical coordinate.

Remarks

Coordinates are measured from the upper-left corner of an object. The CurrentX property setting is 0 at an object's left edge, and the CurrentY property setting is 0 at its top edge. Coordinates are expressed in twips (15 twips per pixel), or the current unit of measurement defined by the ScaleHeight, ScaleWidth, ScaleLeft, ScaleTop, and ScaleMode properties.

When you use the following graphics methods, the CurrentX and CurrentY settings are changed as indicated:

This method Sets CurrentX, CurrentY to

Circle The center of the object.

Cls 0, 0.

Line The end point of the line.

PSet The point drawn.

DownPicture

Description

Returns/sets a graphic to be displayed for the down state of the Active Button.

Syntax

object.DownPicture [= StdPicture]

Part Description

object an object expression that evaluates to a gtimage control.

StdPicture Optional. A long value that specifies a handle to the new down state graphic.

Return Value

Returns a handle to the graphic for the down state of the Active Button.

Remarks

This graphic will be displayed as soon as the user presses the left mouse button while over the object, and will continue being displayed until the user releases the left mouse button, or moves the mouse off of the object.

DownURLPicture

Description

Returns/sets a graphic to be displayed for the down state of the Active Button.

Syntax

object.DownURLPicture = [URL]

Part Description

object an object expression that evaluates to a gtimage control.

URL Optional. A string value that specifies the file or URL of the new down state graphic.

Return Value

Returns a string value that specifies the file or URL of the graphic for the down state of the Active Button.

Remarks

Setting DownURLPicture causes an asynchronous download of an image from a file or URL to be displayed for the down state of the Active Button, and sets DownPicture the handle of the downloaded graphic.

DrawMode

Description

Sets the appearance of output from graphics methods.

Syntax

object.DrawMode = [integer]

Part Description

object an object expression that evaluates to a gtimage control.

integer Optional. An integer value that specifies the new appearance of output from graphics methods.

Return Value

Returns an integer value that specifies the current appearance of output from graphics methods.

Settings

The settings for integer are:

Setting Description

1 Blackness.

2 Not Merge Pen — Inverse of setting 15 (Merge Pen).

3 Mask Not Pen — Combination of the colors common to the background color and the inverse of the pen.

4 Not Copy Pen — Inverse of setting 13 (Copy Pen).

5 Mask Pen Not — Combination of the colors common to both the pen and the inverse of the display.

6 Invert — Inverse of the display color.

7 Xor Pen — Combination of the colors in the pen and in the display color, but not in both.

8 Not Mask Pen — Inverse of setting 9 (Mask Pen).

9 Mask Pen — Combination of the colors common to both the pen and the display.

10 Not Xor Pen — Inverse of setting 7 (Xor Pen).

11 Nop — No operation — output remains unchanged. In effect, this setting turns drawing off.

12 Merge Not Pen — Combination of the display color and the inverse of the pen color.

13 Copy Pen (Default) — Color specified by the ForeColor property.

14 Merge Pen Not — Combination of the pen color and the inverse of the display color.

15 Merge Pen — Combination of the pen color and the display color.

16 Whiteness.

Remarks

Use this property to produce visual effects when drawing with the graphics methods. GT Image Control compares each pixel in the draw pattern to the corresponding pixel in the existing background and then applies bit-wise operations. For example, setting 7 (Xor Pen) uses the Xor operator to combine a draw pattern pixel with a background pixel.

The exact effect of a DrawMode setting depends on the way the color of a line drawn at run time combines with colors already on the screen. Settings 1, 6, 7, 11, 13, and 16 yield the most predictable results.

DrawStyle

Description

Determines the line style for output from graphics methods.

Syntax

object.DrawStyle = [integer]

Part Description

object an object expression that evaluates to a gtimage control.

integer Optional. An integer value that specifies the new line style for output from graphics methods.

Return Value

Returns an integer value that specifies the current line style for output from graphics methods.

Settings

The settings for integer are:

Setting Description

0 (Default) Solid

1 Dash

2 Dot

3 Dash-Dot

4 Dash-Dot-Dot

5 Transparent

6 Inside Solid

Remarks

If DrawWidth is set to a value greater than 1, DrawStyle settings 1 through 4 produce a solid line (the DrawStyle property value isn't changed). If DrawWidth is set to 1, DrawStyle produces the effect described in the preceding table for each setting.

DrawWidth

Description

Returns/sets the line width for output from graphics methods.

Syntax

object.DrawWidth = [integer]

Part Description

object an object expression that evaluates to a gtimage control.

integer Optional. An integer value that specifies the new line width for output from graphics methods.
A numeric expression from 1 through 32,767. This value represents the width of the line in
pixels. The default is 1; that is, 1 pixel wide.

Return Value

Returns an integer value that specifies the current line width for output from graphics methods.

Remarks

Increase the value of this property to increase the width of the line. If the DrawWidth property setting is greater than 1, DrawStyle property settings 1 through 4 produce a solid line (the DrawStyle property value isn't changed). Setting DrawWidth to 1 allows DrawStyle to produce the results shown in the DrawStyle property table.

Enabled

Description

Returns/sets a value that determines whether an object can respond to user-generated events.

Syntax

object.Enabled = [bool]

Part Description

object an object expression that evaluates to a gtimage control.

bool Optional. A boolean value that determines whether an object can respond to user-generated events.

Return Value

Returns a boolean value that determines whether an object can respond to user-generated events.

Remarks

The Enabled property allows objects to be enabled or disabled at run time. For example, you can disable objects that don't apply to the current state of the application. You can also disable a object used purely for display purposes (read-only information).

FillColor

Description

Returns/sets the color used to fill in shapes, circles, and boxes.

Syntax

object.FillColor = [long]

Part Description

object an object expression that evaluates to a gtimage control.

long Optional. A long value that specifies the new color used to fill in shapes, circles, and boxes.

Return Value

Returns a long value that specifies the current color used to fill in shapes, circles, and boxes.

Remarks

When the FillStyle property is set to its default, 1 (Transparent), the FillColor setting is ignored.

FillStyle

Description

Returns/sets the fill style of a shape.

Syntax

object.FillStyle = [integer]

Part Description

object an object expression that evaluates to a gtimage control.

integer Optional. An integer value that specifies the new fill style of a shape.

Return Value

Returns an integer value that specifies the current fill style of a shape.

Settings

The settings for integer are:

Setting Description

0 Solid

1 (Default) Transparent

2 Horizontal Line

3 Vertical Line

4 Upward Diagonal

5 Downward Diagonal

6 Cross

7 Diagonal Cross

Remarks

When FillStyle is set to 1 (Transparent), the FillColor property is ignored.

FontBold

Description

Returns/sets bold font styles.

Syntax

object.FontBold = [bool]

Part Description

object an object expression that evaluates to a gtimage control.

bool Optional. A boolean value that specifies the new bold font styles.

Return Value

Returns a boolean value that specifies the current bold font styles.

Remarks

See FontUnderline.

FontItalic

Description

Returns/sets italic font styles.

Syntax

object.FontItalic = [bool]

Part Description

object an object expression that evaluates to a gtimage control.

bool Optional. A boolean value that specifies the new italic font styles.

Return Value

Returns a boolean value that specifies the current italic font styles.

Remarks

See FontUnderline.

FontName

Description

Returns/sets font name.

Syntax

object.FontName = [string]

Part Description

object an object expression that evaluates to a gtimage control.

string Optional. A string value that specifies the new font name.

Return Value

Returns a string value that specifies the current font name.

Remarks

The default for this property is determined by the system. Fonts available vary depending on your system configuration, display devices, and printing devices. Font-related properties can be set only to values for which fonts exist.

FontStrikethru

Description

Returns/sets strikethru font styles.

Syntax

object.FontStrikethru = [bool]

Part Description

object an object expression that evaluates to a gtimage control.

bool Optional. A boolean value that specifies the new strikethru font styles.

Return Value

Returns a boolean value that specifies the current strikethru font styles.

Remarks

See FontUnderline.

FontTransparent

Description

Returns/sets a value that determines whether background text/graphics are displayed.

Syntax

object.FontTransparent = [bool]

Part Description

object an object expression that evaluates to a gtimage control.

bool Optional. A boolean value that determines whether background text/graphics are displayed.

Return Value

Returns a boolean value that determines whether background text/graphics are displayed.

Remarks

None.

FontUnderline

Description

Returns/sets underline font styles.

Syntax

object.FontUnderline = [bool]

Part Description

object an object expression that evaluates to a gtimage control.

bool Optional. A boolean value that specifies the new underline font styles.

Return Value

Returns a boolean value that specifies the current underline font styles.

Remarks

Use the FontBold, FontItalic, FontStrikethru and FontUnderLine properties to format text, either at design time using the Properties window or at run time using code. Setting these properties doesn't affect graphics or text already drawn on the object.

Note Fonts available vary depending on your system configuration, display devices, and printing devices. Font-related properties can be set only to values for which actual fonts exist.

In general, you should change the FontName property before you set size and style attributes with the FontSize, FontBold, FontItalic, FontStrikethru, and FontUnderline properties. However, when you set TrueType fonts to smaller than 8 points, you should set the point size with the FontSize property, then set the FontName property, and then set the size again with the FontSize property. The Microsoft Windows operating environment uses a different font for TrueType fonts that are smaller than 8 points.

ForeColor

Description

Returns/sets the foreground color used to display text and graphics in an object.

Syntax

object.ForeColor = [long]

Part Description

object an object expression that evaluates to a gtimage control.

long Optional. A long value that specifies the new foreground color.

Return Value

Returns a long value that specifies the current foreground color.

Remarks

If you set the BackColor property, all text and graphics, including the persistent graphics, are erased. Setting the ForeColor property doesn't affect graphics or print output already drawn.

The valid range for a normal RGB color is 0 to 16,777,215 (&HFFFFFF). The high byte of a number in this range equals 0; the lower 3 bytes, from least to most significant byte, determine the amount of red, green, and blue, respectively. The red, green, and blue components are each represented by a number between 0 and 255 (&HFF). If the high byte isn't 0, the system colors are used, as defined in the user's Control Panel settings.

To display text in the Windows operating environment, both the text and background colors must be solid. If the text or background colors you've selected aren't displayed, one of the selected colors may be dithered — that is, comprised of up to three different-colored pixels. If you choose a dithered color for either the text or background, the nearest solid color will be substituted.

hDC

Description

Returns a handle provided by the Microsoft Windows operating environment to the device context of an object.

Syntax

object.hDC

Part Description

object an object expression that evaluates to a gtimage control.

Return Value

Returns an integer value that specifies the handle to the device context.

Remarks

This property is a Windows operating environment device context handle. The Windows operating environment manages the system display by assigning a device context for each visual object in your application. You can use the hDC property to refer to the handle for an object's device context. This provides a value to pass to Windows API calls.

Note The value of the hDC property can change while a program is running, so don't store the value in a variable; instead, use the hDC property each time you need it.

The AutoRedraw property can cause the hDC property setting to change. If AutoRedraw is set to True, hDC acts as a handle to the device context of the persistent graphic (equivalent to the Image property). When AutoRedraw is False, hDC is the actual hDC value of the object's window. The hDC property setting may change while the program is running regardless of the AutoRedraw setting.

hWnd

Description

Returns a handle to an object.

Syntax

object.hWnd

Part Description

object an object expression that evaluates to a gtimage control.

Return Value

Returns an integer value that specifies the handle to the object.

Remarks

The Microsoft Windows operating environment identifies each window and control in an application by assigning it a handle, or hWnd. The hWnd property is used with Windows API calls. Many Windows operating environment functions require the hWnd of the active window as an argument.

Note Because the value of this property can change while a program is running, never store the hWnd value in a variable.

MouseIcon

Description

Returns/sets a custom mouse icon.

Syntax

object.MouseIcon = [StdPicture]

Part Description

object an object expression that evaluates to a gtimage control.

StdPicture Optional. A long value that specifies the handle of the new icon image.

Return Value

Returns a long value that specifies the handle of the current icon image.

Remarks

The MouseIcon property provides a custom icon that is used when the MousePointer property is set to 99.

MousePointer

Description

Returns/sets the type of mouse pointer displayed when over part of an object.

Syntax

object.MousePointer = [Integer]

Part Description

object an object expression that evaluates to a gtimage control.

Integer Optional. An integer value that specifies the new mouse pointer.

Return Value

Returns an integer value that specifies the current mouse pointer.

Settings

The settings for integer are:

Value Description

0 (Default) Shape determined by the object.

1 Arrow.

2 Cross (crosshair pointer).

3 I beam.

4 Icon (small square within a square).

5 Size (four-pointed arrow pointing north, south, east, and west).

6 Size NE SW (double arrow pointing northeast and southwest).

7 Size N S (double arrow pointing north and south).

8 Size NW SE (double arrow pointing northwest and southeast).

9 Size W E (double arrow pointing west and east).

10 Up Arrow.

11 Hourglass (wait).

12 No Drop.

13 Arrow and hourglass. (Only available in 32-bit.)

14 Arrow and question mark. (Only available in 32-bit.)

15 Size all. (Only available in 32-bit.)

99 Custom icon specified by the MouseIcon property.

Remarks

You can use this property when you want to indicate changes in functionality as the mouse pointer passes over the object. The Hourglass setting (11) is useful for indicating that the user should wait for a process or operation to finish.

NavBookmark

Description

Returns/sets the bookmark for a subsequent navigation.

Syntax

object.NavBookmark = [Location]

Part Description

object an object expression that evaluates to a gtimage control.

Location Optional. A string expression specifying the location within the URL
Specified in NavURL to jump to. If Location is not specified, the
default document will be jumped to.

Return Value

Returns a string expression that specifies the bookmark for a subsequent navigation.

Remarks

None.

NavFrame

Description

Returns/sets the frame for a subsequent navigation.

Syntax

object.NavFrame = [FrameName]

Part Description

object an object expression that evaluates to a gtimage control.

FrameName Optional. A string expression specifying the frame within the URL
Specified in NavURL to jump to. If FrameName is not specified,
the default frame will be jumped to.

Return Value

Returns a string expression that specifies the frame for a subsequent navigation.

Remarks

None.

NavURL

Description

Returns/sets the URL for a subsequent navigation.

Syntax

object.NavURL = [Target]

Part Description

object an object expression that evaluates to a gtimage control.

Target Optional. A string expression specifying the location to jump to. This
can be a document or a URL.

Return Value

Returns a string expression that specifies the URL for a subsequent navigation.

Remarks

The following applies when this property is set and the control is clicked:
If the control is in a container that supports OLE hyperlinking, then the contaner will jump to the location specified by the three Nav properies. If the control is in a container that does not support OLE hyperlinking, then an application that is registered as supporting hyperlinking is started to handle the request.

OverPicture

Description

Returns/sets a graphic to be displayed for the mouse-over state of the Active Button.

Syntax

object.OverPicture [= StdPicture]

Part Description

object an object expression that evaluates to a gtimage control.

StdPicture Optional. A long value that specifies a handle to the new mouse-over state graphic.

Return Value

Returns a handle to the graphic for the mouse-over state of the Active Button.

Remarks

This graphic will be displayed as soon as the user moves the mouse over the object, and will continue being displayed until the user presses the left mouse button, or moves the mouse off of the object.

OverURLPicture

Description

Returns/sets a graphic to be displayed for the mouse-over state of the Active Button.

Syntax

object.OverURLPicture = [URL]

Part Description

object an object expression that evaluates to a gtimage control.

URL Optional. A string value that specifies the file or URL of the new mouse-over state graphic.

Return Value

Returns a string value that specifies the file or URL of the graphic for the mouse-over state of the Active Button.

Remarks

Setting OverURLPicture causes an asynchronous download of an image from a file or URL to be displayed for the mouse-over state of the Active Button, and sets OverPicture the handle of the downloaded graphic.

Picture

Description

Returns/sets a graphic to be displayed for the up (normal) state of the Active Button.

Syntax

object.Picture [= StdPicture]

Part Description

object an object expression that evaluates to a gtimage control.

StdPicture Optional. A long value that specifies a handle to the new up state graphic.

Return Value

Returns a handle to the graphic for the up state of the Active Button.

Remarks

This graphic will be displayed until the user moves the mouse over the object or presses the left mouse button while over the object.

ScaleHeight

Description

Returns/sets the number of units for the vertical measurement of an object's interior.

Syntax

object.ScaleHeight [= single]

Part Description

object an object expression that evaluates to a gtimage control.

single Optional. A single value that specifies the new scaleheight.

Return Value

Returns a single value that specifies the current scaleheight.

Remarks

See ScaleWidth.

ScaleLeft

Description

Returns/sets the horizontal coordinates for the left edges of an object.

Syntax

object.ScaleLeft [= single]

Part Description

object an object expression that evaluates to a gtimage control.

single Optional. A single value that specifies the new scaleleft.

Return Value

Returns a single value that specifies the current scaleleft.

Remarks

See ScaleWidth.

ScaleMode

Description

Returns/sets a value indicating measurement units for object coordinates when using graphics methods or positioning objects.

Syntax

object.ScaleMode [= integer]

Part Description

object an object expression that evaluates to a gtimage control.

integer Optional. An integer value that specifies the new scalemode.

Return Value

Returns an integer value that specifies the current scalemode.

Settings

The settings for integer are:

Setting Description

0 Indicates that one or more of the ScaleHeight, ScaleWidth, ScaleLeft, and ScaleTop properties are set to custom values.

1 (Default) Twip (1440 twips per logical inch; 567 twips per logical centimeter).

2 Point (72 points per logical inch).

3 Pixel (smallest unit of monitor or printer resolution).

4 Character (horizontal = 120 twips per unit; vertical = 240 twips per unit).

5 Inch.

6 Millimeter.

7 Centimeter.

Remarks

See ScaleWidth.

ScaleTop

Description

Returns/sets the vertical coordinates for the top edges of an object.

Syntax

object.ScaleTop [= single]

Part Description

object an object expression that evaluates to a gtimage control.

single Optional. A single value that specifies the new scaletop.

Return Value

Returns a single value that specifies the current scaletop.

Remarks

See ScaleWidth.

ScaleWidth

Description

Returns/sets the number of units for the horizontal measurement of an object's interior.

Syntax

object.ScaleWidth [= single]

Part Description

object an object expression that evaluates to a gtimage control.

single Optional. A single value that specifies the new scalewidth.

Return Value

Returns a single value that specifies the current scalewidth.

Remarks

You can use the ScaleHeight and ScaleWidth properties to create a custom coordinate scale for drawing. For example, the statement ScaleHeight = 100 changes the units of measure of the actual interior height of the object. Instead of the height being n current units (twips, pixels, ...), the height will be 100 user-defined units. Therefore, a distance of 50 units is half the height/width of the object, and a distance of 101 units will be off the object by 1 unit.

Use the ScaleMode property to define a scale based on a standard unit of measurement, such as twips, points, pixels, characters, inches, millimeters, or centimeters.

Setting the ScaleHeight and ScaleWidth properties to positive values makes coordinates increase from top to bottom and left to right. Setting them to negative values makes coordinates increase from bottom to top and right to left.

Using the ScaleHeight, ScaleWidth, ScaleLeft, and ScaleTop properties, you can set up a full coordinate system with both positive and negative coordinates. All four of these Scale properties interact with the ScaleMode property in the following ways:

Setting any other Scale property to any value automatically sets ScaleMode to 0. A ScaleMode of 0 is user-defined.

Setting ScaleMode to a number greater than 0 changes ScaleHeight and ScaleWidth to the new unit of measurement and sets ScaleLeft and ScaleTop to 0. In addition, the CurrentX and CurrentY settings change to reflect the new coordinates of the current point.

You can also use the Scale_ method to set the ScaleHeight, ScaleWidth, ScaleLeft, and ScaleTop properties in one statement.

Stretch

Description

Determines whether or not the image is scaled to fit the control.

Syntax

object.Stretch [= bool]

Part Description

object an object expression that evaluates to a gtimage control.

single Optional. A boolean value that specifies whether or not the image is scaled to fit the control.

Return Value

Returns a boolean value that specifies whether or not the image is scaled to fit the control.

Remarks

If AutoSize is true then this property is ignored.

URLPicture

Description

Returns/sets a graphic to be displayed for the up (normal) state of the Active Button.

Syntax

object.URLPicture = [URL]

Part Description

object an object expression that evaluates to a gtimage control.

URL Optional. A string value that specifies the file or URL of the new up state graphic.

Return Value

Returns a string value that specifies the file or URL of the graphic for the up state of the Active Button.

Remarks

Setting URLPicture causes an asynchronous download of an image from a file or URL to be displayed for the up state of the Active Button, and sets Picture the handle of the downloaded graphic.