Introduction

Properties	Events	Methods

The RSSlider control provides a graphical data input control for your application with Min / Max points and extensive scaling features. It supports Rockwell Software’s AdvanceDDE format and can be linked to servers communication via AdvanceDDE , XL_TABL and CF-TEXT protocol. RSSlider is a data bound control that can be bound to databases. The custom events for RSSlider provide additional features to monitor data and keep a check on data going to or from RSSlider.

File Name	RSSld32.OCX

Object Type	RSSlider

Remarks

The RSSlider control has several custom properties that allow you to monitor and control data.  The RSSlider control also has custom events that allow you to be notified when data has changed, or if a  request or poke action has completed.

Note

When you create and distribute applications that use the RSSlider control, certain files need to be installed in the Windows\System directory.  Refer to the Distributing Files Distributing_RSSlider_Applications>main section specific file names.  The Setup Wizard included with Visual Basic provides tools to help create setup programs for installing your applications.


Basic Concepts

RSSlider is a Visual Basic OLE Custom Control (OCX).  It can be used in Visual Basic, Microsoft Access,  or any Microsoft compatible OLE container.

•	The RSSlider control is designed to be used with any Dynamic Data Exchange Server and provides enhanced performance when used with those that conform to AdvanceDDE protocol.  If you choose to write your own DDE server, the AdvanceDDE protocol can be obtained from Rockwell Software Inc., by contacting  Technical Support.

•	The RSSlider control can be easily configured by setting its properties, without writing a single line of code.

•	The RSSlider control can be used as a bound control.  It automatically handles updating and displaying data from the Data control, which supports ODBC, Microsoft Access, dBASE, Foxpro, Paradox, BTRIEVE and several other database types.

•	The RSSlider control also supports the Paste Link method from RSLinx, Microsoft Excel or other servers for transferring DDE Link data via the clipboard.

•	The RSSlider control has built in error notification and handling.  If an error has occurred in the data stream, the error can be displayed in the controls caption property, or handled via code in one of its events.

•	RSSlider provides a limited read/write mechanism for both linked and bound data.


Property List

(ABOUT)

(CUSTOM)

AccelRate

AllowItemChangeEvent

AutoColumns

BackColor

BackStyle

BevelHeight

BevelHighlight

BevelShadow

BevelStyle

BevelWidth

BorderColor

BorderInner

BorderInnerColor

BorderStyle

BorderWidth

BottomBorder

ButtonArrowColor

ButtonFaceColor

ButtonHighlight

ButtonOffset

ButtonShadow

ButtonSize

ButtonStyle

Caption

CaptionBackColor

CaptionColor

CaptionShadow

CaptionShadowColor

CaptionTransparent

CaptionX

CaptionY

CenterOnKnob

Clip

DataChanged

DataField

DataSource

DataUpdate

DataValue

DecimalPlaces

DefaultIncrement

DisplayCaption

DisplayCaptionVertically

DisplayPicture

DisplaySliderFace

DisplayValue

DragIcon

DragMode

DrawDisabledShadow

Enabled

EndValue

ExpressionForRead

ExpressionForWrite

FaceBorderColor

FaceColor

FaceDivider

FaceHeight

FaceWidth

FlashEnabled

FlashOn

FlashSpeed

FlashTime

Font

Height

HelpContextID

IndentedStyle

Index

KnobFaceColor

KnobHeight

KnobHighlight

KnobShadow

KnobType

KnobWidth

Left

LeftBorder

LinkErrorDisplay

LinkErrorNumber

LinkErrorString

LinkItem

LinkMode

LinkServer

LinkTip

LinkTipBackColor

LinkTipForeColor

LinkTipText

LinkTopic

MaximumIncrement

MoveRefresh

Name

NumberOfDataValues

PageIncClick

Picture

PictureKnob

PictureKnobStretch

PictureStretch

PointedType

PokeLength

PokeStartIndex

RequestLength

RequestStartIndex

ReverseDirection

RightBorder

Scale1DecimalPlaces

Scale1End

Scale1Length

Scale1Major

Scale1MajorColor

Scale1Minor

Scale1MinorColor

Scale1NumberVisible

Scale1Offset

Scale1Start

Scale1String

Scale1StringEnabled

Scale1Style

Scale1TextColor

Scale1TrailingZeros

Scale1Type

Scale1Visible

Scale1Width

Scale2DecimalPlaces

Scale2End

Scale2EndNumber

Scale2Length

Scale2Major

Scale2MajorColor

Scale2Minor

Scale2MinorColor

Scale2NumberVisible

Scale2Offset

Scale2Start

Scale2StartNumber

Scale2String

Scale2StringEnabled

Scale2Style

Scale2TextColor

Scale2TrailingZeros

Scale2Type

Scale2Visible

Scale2Width

ScaleBorderColor

ScaleHighlight

ScaleShadow

ScreenPriority

Shadow

ShadowOffsetX

ShadowOffsetY

SliderHighlight

SliderShadow

SliderType

StartValue

Symbol

TabIndex

TabStop

Tag

Top

TopBorder

TrailingZeros

UseInPoke

UseInRequest

Value

ValueBackColor

ValueColor

ValueShadow

ValueShadowColor

ValueTransparent

ValueX

ValueY

Visible

WhatsThisHelpID

Width

WriteStyle

WriteValue


Event List

Change

Click

DblClick

DragDrop

DragOver

EndMove

GotFocus

KeyDown

KeyPress

KeyUp

LinkError

LinkItemNotSupported

LinkItemSupported

LinkNotify

LinkOutOfMemory

LinkServerDisconnected

LinkUnableToConnectToServer

LostFocus

MouseDown

MouseMove

MouseUp

PokeCompleted

RequestCompleted

StartMove


Method List

Container

DoPoke

DoRequest

Drag

LinkPoke

LinkRequest

Move

Object

Parent

SetFocus

ShowWhatsThis

Zorder


Copyright Information

Copyright Notice	1996 Rockwell Software Inc. All rights reserved Printed in the United States of America This manual and any accompanying Rockwell Software products are copyrighted by Rockwell Software Inc. Any reproduction and/or distribution without prior written consent from Rockwell Software Inc. is strictly prohibited. Please refer to the license agreement for details.
Trademark Notices	WINtelligent Series is a registered trademark and RSAnimator, RSButton, RSCompare, RSData, RSEventMaster, RSGauge, RSJunctionBox, RSSlider, RSToolbox, RSToolPak I, RSToolPak II, RSTools, RSVessel, RSWheel, RSWorkbench, RSWorkshop, RSLinx, INTERCHANGE, AdvanceDDE, Packed DDE, WINtelligent LINX, WINtelligent and the Rockwell Software logo are trademarks of Rockwell Software Inc. PLC, PLC-2, PLC-3 and PLC-5, are registered trademarks, and Data Highway Plus, DH+, DHII, DTL, Network DTL, Pyramid Integrator, PLC-5/250, SLC, and SLC 500 are trademarks of the Allen-Bradley Company, Inc. Microsoft, MS-DOS, Windows, and Visual Basic are registered trademarks, and Windows NT and Microsoft Access are trademarks of the Microsoft Corporation. All other trademarks are the property of their respective holders and are hereby acknowledged.
Important User Information	This Rockwell Software product is warranted in accord with the product license. The product's performance will be affected by system configuration, the application being performed, operator control and other related factors.  The product's implementation may vary among users.  This manual is as up-to-date as possible at the time of printing; however, the accompanying software may have changed since that time. Rockwell Software reserves the right to change any information contained in this manual or the software at anytime without prior notice. The instructions in this manual do not claim to cover all the details or variations in the equipment, procedure, or process described, nor to provide directions for meeting every possible contingency during installation, operation, or maintenance.


Bound Properties

The RSSlider control has three bound properties: DataUpdate, DataField and DataSource.  This allows the RSSlider control to be linked to a Visual Basic Data control and Visual Basic Remote Data Control, and display field values for the current record in the recordset.  The RSSlider control can also write values to the Data control’s recordset.

Note	For more information on using bound controls, refer to Accessing Databases With the Data Control, in the Visual Basic Programmers Guide.


Installing the OCX

You can install RSSlider on your computer using Rockwell Software’s SETUP.EXE.  The setup program installs all RSSlider files, the Help system, sample applications and other product components from the distribution disks to your hard disk.

System Requirements

Before you install RSSlider, make sure that your computer meets the minimum system requirements. You must have certain hardware and software installed on your computer.  Though RSSlider Control can be placed in any OLE container such as Microsoft Access, this manual specifically references Microsoft Visual Basic as the container. The system requirements include:

Minimum Requirements

•	IBM-compatible 486 or higher.

•	8 MB of RAM

•	10 MB Hard Disk Drive

•	A 3.5” floppy drive

•	VGA Graphics Card

•	Microsoft Visual Basic 4.0, Microsoft Access or Other OLE Control Containers.

•	Microsoft Windows NT 3.51 or Microsoft Windows 95

Recommended Requirements

•	IBM compatible  Pentium

•	16 MB of RAM or more

•	30 MB Hard Disk Drive

•	CD-ROM Drive

•	Color (800x600) or (1024 x 768) Monitor

•	Microsoft Mouse compatible pointing device (mouse, trackball, touchscreen, etc.)

•	Microsoft Visual Basic 4.0, Professional Edition or Enterprise Edition, Microsoft Access or Other OLE Control Containers.

•	Microsoft Windows NT 3.51 or  Microsoft Windows 95

RSTOOLS.WRI File

The RSTOOLS.WRI file lists any last minute changes to the RSSlider documentation, Help file and to the RSSlider control.  To read the file, open the Windows Write application or double-click the RSTOOLS.WRI file in the file manager or Windows Explorer.

Running Setup

When you run the setup program, you will set a path for RSSlider.

To Start Setup:

1.	Insert Disk 1 in drive A.

2.	From the file menu in Program Manager, File manager or Explorer, choose Run.

3.	Type a:setup

4.	Follow the setup instructions on the screen.


Learning To Use RSSlider

The RSSlider control requires very little programming to create full-featured applications.  Much of the functionality is available by setting standard properties.  You can even log data seamlessly through the Visual Basic Data control.

Loading RSSlider (Adding RSSlider to your VB Project)

To use RSSlider in Visual Basic, you must add the RSSlider control to the Visual Basic toolbox.

1.	Start Visual Basic.

2.	From Visual Basic, select Tools/Custom Controls menu item.

3.	Scroll through the available controls listed. Choose “Rockwell Software RSSlider” and choose OK.

The RSSlider icon is added to the Visual Basic Toolbox.

Autoloading RSSlider

You can configure Visual Basic to automatically load the RSSlider control when you start a new project in Visual Basic.

To configure Visual Basic to automatically load RSSlider:

1.	Start Visual Basic and open AUTO32LD.VBP.

2.	Choose Custom Controls from the Tools menu.  (The “Custom Controls” Dialog appears.)

3.	Scroll down the list box until “Rockwell Software RSSlider” is visible, select it and choose OK. The control is added to the project list.

4.	Choose Save Project from the File menu.

Note:	If “Rockwell Software RSSlider” does not appear in the list of available custom controls, you may have to click the Browse button and manually select RSSLD32.OCX and RSSLDX32.DLL, which are located in the C:\WINDOWS\SYSTEM directory .When attempting to load RSSLDX32.DLL the message “Unable to load control from RSSLDX32.DLL” may appear. This occurs because this DLL contains supporting code for the RSSlider OCX and does not contain the actual control. Choose OK to continue.

Placing the RSSlider on a Form

Creating a new RSSlider control and placing it on a form is as simple as point, click and drag.

1.	Select the RSSlider tool in the Visual Basic toolbox.

2.	Position the mouse on the form at the location where you want to draw the control.

3.	Click and drag to draw the outline of the RSSlider control on the form.

4.	When you release the mouse, the new RSSlider control is placed in the location you specified.

OR

Double Click on the RSSlider Icon in the Visual Basic Toolbox.


Using Help

Comprehensive on-line help is available to assist you as you learn and use the RSSlider control.  The complete RSSlider documentation is available through on-line help.  In addition, you can receive context-sensitive help for properties & events.  The Help file is located in your \RSWKSHOP\RSTOOLBX directory.

To access the help contents page:

1.	Click the RSSlider icon in the toolbox.

2.	Press F1.

To access context-sensitive help for properties:

1.	Select an RSSlider control on your form.

2.	Highlight an RSSlider property in the properties window.

3.	Press F1.

To access context-sensitive help for events:

1.	Double-click an RSSlider control on your form.

2.	Pull down the procedure Combo-Box, labeled “Proc:”, and select an event from the list.

3.	Press F1.


Distributing RSSlider Applications

Please read the license agreement that was shipped with this package.  You are bound by the licensing restrictions contained in that document.

Redistributing Files

All of the files that accompany this product may be used for development of an application.  You can redistribute the run time version of the software according to the terms of the license agreement.

You can ship the following files with your application:

File	Description

RSTool32.OCX	Common Code for the OCX

RSSld32.OCX	Code for the OCX

If the run time application requires features of the RSJunctionBox (enhanced communications, calculation engine) then in addition to the files listed above, an RS JunctionBox needs to be installed on the system.   The RSJunctionBox (can be purchased seperately) installs the following files into the Windows\System directory.  These files may not be freely distributed and require a special activation key which is automatically installed during setup.

RSJBOX32.DLL	RSJunctionBox

RSJBP32.DLL	RSJunctionBox Protection DLL

RSCALC32.OCX	Calculation Engine for Read/Write Expressions


Using Custom Property Tabs

RSSlider provides custom and standard properties, events and methods.  By setting these properties, you can perform a variety of tasks, such as changing graphical appearance, automatic DDE links, binding to a database, data validity checks in code etc.

Visual Basic Floating Menu

Click the right mouse button anywhere within an RSSlider control to display the floating menu.  Once the menu appears, use the left mouse button to select a menu item.  Clicking on a menu item that contains three periods brings up various dialog boxes that perform certain functions for the control.  The Properties menu item will bring up the Custom Property Tab dialog  discussed in the next section.

The following table describes the purpose of each item on the floating menu.

Menu item	Description

Cut	Deletes the selected item and copies it to the clipboard.
Copy	Copies the selected item to the clipboard.
Paste	Pastes the contents of the clipboard onto the form.
Delete	Deletes the selected item.
Bring To Front	Brings the selected item to top of the Zorder.
Send To Back	Sends the selected item to bottom of the Zorder.
View Code	View the selected items code window.
Align to Grid	Aligns the control’s Top and Left property to the forms grid.
Properties	Displays Custom Property Dialog.
Paste Link	Supports pasting a link to a valid DDE source.
Using Custom Property Tabs

RSSlider OCX dialog boxes provide sets of options grouped on separate tabs.  As you click each tab, the controls in the dialog box change to allow you to edit a different set of options.  Any options that are not appropriate for the current control type or situation are grayed.  The following  illustration shows an example of an RSSlider OCX dialog box.

Note : Switching between tabs will force an automatic “apply” to the control.

See Also

General Tab

Value Tab

Scale Tab

LinkInfo Tab

Font Tab

Display Tab

Template Tab


General Tab

•	OCX Setup Area.  Use this display to change the attributes of the control.  While in this rectangular area click the right mouse button, to bring up the floating menu.

From this menu you can enable/disable the Value, Caption properties, or toggle ToolTips for the Custom Property Tabs.  You can also display the Preview window, which allows you to view a real time display of your control.

The Zoom option enlarges the OCX setup area to allow you to make more detailed adjustments to the graphic shape.

Setup box or OCX Setup Area box allows you to change the attributes of the control by directly editing the control image. The attribute that can be edited is highlighted and the cursor changes as you bring the mouse over the editable region.

•	Options.  This list box lists all of the general options for the control.  You can enable or disable these properties from this list box by clicking in the appropriate check box. Properties set in this option box are :

Value Transparent	CaptionTransparent Property	Value Shadow
Caption Shadow	Default Increment	Page Increment
Display Picture	Picture Stretch	Picture Knob Stretch
Indented Track	Update Screen on Fast	Move
Display Face	Shadow Property	Reverse Direction
Center Text On knob	Trailing Zeros	Write Value
Draw Disabled Shadow
•	Slider Type.	The slider type is set from this drop down combo box. The available style are listed and may be selected by clicking on the desired style. Available Styles include:

0 - Horizontal

1 - Vertical

2 - Horizontal with buttons on one end

3 - Vertical with buttons on one end

4 - Horizontal with buttons on both ends

5 - Vertical with buttons on both ends

•	Knob Style. Styles for the RSSlider knob can be selected using this drop down combo box. Available Styles are :

0 - None

1 - Button

2 - Pointed

3 - Box

•	Pointed Knob Direction lets you choose the direction for a pointed knob.Select from the options in the drop down combo box.

•	Button Style lets you choose the RSSlider Increment or Decrement  Buttons from the drop down combo box. Available styles are :

    0 - Button

1 - Arrow


Value Tab

•	Start Value.  Sets the RSSlider min  value. You can either key in the value or click on the ‘#’ sign and use the numeric keypad.

•	EndValue .  Set the RSSlider Max value. You can either key in the value or click on the ‘#’ sign and use the numeric keypad.

•	Value.  Set the default value for the RSSlider. You can either key in the value or click on the ‘#’ sign and use the numeric keypad.

•	Decimals. Sets the number of digits after the decimal point for the RSSlider value. You can either key in the value in the box or use the spin buttons to change the value.

•	Caption.  Sets the caption property for the RSSlider. Text can be typed in the text box below the Caption label.

•	Maximum Increment. Sets the Maximum Increment property. You can either key in the value in the box or use the spin buttons to change the value. Maximum Increment is the increment or decrement by which the RSSlider value would change on clicking the slider track(face).

•	Acceleration Rate. Sets the Accel Rate property for the RSSlider. Accel Rate property sets the rate of change of RSSlider value if the RSSlider button(s) are clicked on and held. You can either key in the value or click on the ‘#’ sign and use the numeric keypad.

•	Write Style.  Sets the Write style property for the RSSlider. This property determines if the RSSlider value would be written continuously as the RSSlider knob is moved or written when the knob is released. Selected from the drop down combo box.


Scale Tab

Various properties dealing with the scales of the RSSlider control can be set using this custom property Tab.  There are two distinct scales available.  Scale2 is the main scale that takes its values from the SliderStart and SliderEnd Values.  The other scale, Scale 1, is an additional scale whose sole purpose is to provide for the diaplay of different units.  Example: Main scale - Celsius , Additional  scale - Fahrenheit.

Important note:  Both scales have almost all of the same changeable properties and it can be confusing if both scales are displayed at once, initially.  It is better to get all the properties set for Scale 2, and then turn on Scale 1 and adjust its properties.   (For more scale options, such as position of marks, see the General Tab section of this chapter.)

Scale1 or Scale2 check boxes

•	Display.  Marking these check boxes will cause Scale1and/or Scale 2 to be displayed. (For more information see Scale1Visible in the RSSlider Property Reference.)

•	Numbers.   Marking these check boxes will cause the numbers or text for Scale 1 and/or  Scale 2 to be displayed. (For more information see Scale1NumbersVisible in the RSSlider Property Reference.)

•	Zeros.  Enabled when the appropriate Display check box is marked.  Marking these check boxes will cause Scale1 and/or Scale 2 to display trailing zeroes on their numbers when appropriate.  (For more information see Scale1TrailingZeros in the RSSlider Property Reference.)

Scale1 or Scale2 Input Boxes with spin buttons

•	Major.  This box is where you define the number of major (larger size) marks that a scale will have.  You can type the major mark value in the box or you can use the spin buttons to increase or decrease the number of major marks.  (For more information see Scale1Major in the RSSlider Property Reference.)

•	Minor.  This box is where you define the number of minor (smaller size) marks a scale will have.  You can type the minor mark value in the box or you can use the spin buttons to increase or decrease the number of minor marks.  (For more information see Scale1Minor in the RSSlider Property Reference.)

•	Decimal.  This box is where you define the number of decimal places that the scale numbers will have.  You can type the decimal place value in the box or you can use the spin buttons to increase or decrease the number of decimal places. (For more information see Scale1DecimalPlaces in the RSSlider Property Reference.)

Scale1 or Scale2 Start and End Boxes

•	Place Scale (1 or 2) @ Start.  These boxes are where you define the position of the scale marks in reference to the Start Value (see Value Tab section of this chapter).  You can type this value in the box or if you click on the “#” symbol in the box, a numeric keypad will be displayed which can be used to enter the starting position for the scale marks. (For more information see Scale1Start in the RSSlider Property Reference.)

•	Place Scale (1 or 2) @ End.  These boxes are where you define the position of the scale marks in reference to the End Value (see Value Tab section of this chapter).  You can type scale end position value in the box or if you click on the “#” symbol in the box, a numeric keypad will be displayed which can used to define the end position of the scale marks. (For more information see Scale1End in the RSSlider Property Reference.)

•	Scale 2 Numbering Start.  This box is where you define the number for the Scale2 starting mark.  You can type the Scale2 start number value in the box or if you click on the number symbol in the box, a numeric keypad will be displayed which you can use to define the “#” for the Scale2 starting mark.  (For more information see Scale2StartNumber in the RSSlider Property Reference.)

•	Scale 2 Numbering End.  This box is where you define the number for the Scale2 end mark.  You can type the Scale2 end number value in the box or if you click on the number symbol in the box, a numeric keypad will be displayed which you can use to define the number for the Scale2 end mark. (For more information see Scale2EndNumber in the RSSlider Property Reference.)

Scale 1 or Scale2 Combo boxes

•	Scale(1 or 2)Style.  These boxes allow you to choose between 3 different styles for the scale marks.  The available options are normal, indented and beveled. (For more information see Scale1Style in the RSSlider Property Reference.)

•	Scale(1 or 2)Type.  These boxes allow you to choose between 5 different positions for the scale numbers or text.  The available options are inside, outside or centered on the scale mark, and inside or outside the RSSlider face border. (For more information see Scale1Type in the RSSlider Property Reference.)


LinkInfo Tab

•	Symbol.   This combo box is used to choose the name of a Symbol, that has been previously defined for a specific Server, Topic and Item, in a DDE link.   To define Symbols for different DDE links see the section on Manage Symbols that follows.  If the Symbol has been previously defined select it from the combo box list or enter the name of the Symbol in the combo box directly.  When a defined Symbol is chosen then the Server, Topic and Item combo boxes on the LinkInfo page will automatically be filled in with the appropriate data.

•	Server.  This combo box determines the application or Server name that the RSSlider control is linked to.  If the Server name has been previously used it can be chosen from the combo box list or enter the name of a new Server into the combo box directly.  (For more information on the LinkServer property see the RSTools Common Reference Guide.)

•	Topic.  This combo box determines the LinkTopic portion of the data link string, which the RSSlider control uses for addressing in a DDE link.  If the topic has been previously used it can be chosen from the combo box list or enter the name of a new Topic into the combo box directly.  (For more information on the LinkTopic property see the RSTools Common Reference Guide.)

•	Item.  This combo box determines the LinkItem portion of the data link string, which the RSSlider control uses for addressing in a DDE link.  If the Item has been previously used it can be chosen from the combo box list or enter the name of a new Item into the combo box directly.  (For more information on the LinkItem property see the RSTools Common Reference Guide.)

•	AutoColumns.  This check box is used to enable or disable the AutoColumns property for the control. AdvanceDDE servers can provide data in block format and RSSlider can display the data in that format by setting this property.

•	LinkMode.  Sets the type of link to be used for a DDE conversation and activates the connection.  Available options for the LinkMode property are:

Settings	Description

0 = None 	No DDE connection is established between the control and

 	server.

1= Automatic  	A “HOT link”.  The Server automatically updates the control

when data changes.

2 = Manual  	A “COLD link”. The client has to issue a DOREQUEST

method to get data from the Server.

3 = Notify 	Causes Visual Basic to fire the LINKNOTIFY event.

•	Manage Symbols. This button is used to display the Manage Symbols dialog (see below), which is used to define Symbols for DDE links to the control.  (See the section on Symbols above.)

To define a new Symbol for a specific Server, Topic, and Item in a DDE Link,  place the name for the new Symbol in the text box labeled Symbol.  Then place the DDE Link Server name in the text box labeled Server, the DDE Link Topic name in the text box labeled Topic, and the DDE Link Item name in the text box labeled Item.

Press the Add/Change button to add the new Symbol name to the Symbol list box.

Press Delete  to delete an existing Symbol.

Use the Select All button to group all symbols for exporting.

Press Export or Import to write or read the symbol information to a .RSS file (Rockwell Software Symbol)

This file is a text file with the following format:

   [SYM]

RSI=icomwdrv|testsol|n7:0

icom=icomwdrv|testsol|n7:22

excel=excel|[book1]sheet1|r1c1

This is essentially a .ini file format with a separate entry= line for each symbol. This file can be read by a programmer to utilize symbol information in an application.

•	Paste Link.  This button is enabled when the user has copied specific DDE Link information from another application (example: Excel) to the clipboard.  Pressing this button will then fill in the appropriate DDE Link information for the Server, Topic and Item.

•	Expression. (This feature is available when the RSJunctionBox is installed on the computer.)

When finished, press the OK button to save any changes or the Cancel button to exit without saving changes.


Font Tab

This Tab page is used to change the font, the font size, and/or the font style of the RSSlider control.

The following illustration shows the options in the Font tab.

•	Property Name.  This combo box is currently inactive for the RSSlider control.

•	Font.  This list box shows all the font types that have been installed for Windows.   The font that is currently being used is highlighted.  You may choose a new font by scrolling through the list and clicking the appropriate type or by typing the name of the new font in the input box at the top.

•	Font Style.  This combo box can be used to select between four different attributes that you can assign to the selected font:

Regular	This is the standard, unmodified style for the font.

Bold	Selecting this attribute changes the font to bold.

Italic	Selecting this attribute changes the font to italic.

Bold Italic	Selecting this attribute changes the font to bold italic.

•	Size.  This combo box lists common point sizes for the highlighted font.  The current font size is  shown initially.  You may choose a new size from the drop down list or by typing the new size directly into the combo box.

•	Effects.  This section of the font Tab has two additional options for highlighting a selected font.

Strikeout.  Marking this checkbox places a horizontal line near the center of each 	character.

Underline.  Marking this checkbox underlines each character.

•	Sample.  This section gives you a preview of any changes made to the different font Tab options before they are actually implemented on the RSSlider control.


Display Tab

Display properties of the control can be set using this custom property page tab. Display properties include properties like various colors, pictures, bevel styles etc. This section describes the setting of these properties using this tab.

Colors.

Setting of colors involves selecting the color property (Example : BackColor) and then selecting the color. Both of these can be selected from the pull down combo boxes labeled Colors. Basic Colors can also be selected by clicking on the Ellipsis Button next to the color property combo box. This brings up the color palette from which either the predefined colors or custom colors can be selected.

Color properties that can be set using Display Tab are :

BackColor	ButtonHighlight	KnobHighlight
BevelHighlight	ButtonShadow	KnobShadow
BevelShadow	CaptionBackColor	LinkTipBackColor
BorderColor	CaptionColor	LinkTipForeColor
ButtonArrowColor	CaptionShadowColor	Scale1MajorColor
BorderInnerColor	FaceBorderColor	Scale1MinorColor
ButtonFaceColor	FaceColor	Scale1TextColor
Scale2MinorColor	KnobFaceColor	Scale2MajorColor
Scale2TextColor	ScaleShadow	ValueColor
ScaleBorderColor	SliderHighlight	ValueShadowColor
ScaleHighlight	SliderShadow	ValueBackColor
Pictures.

Use this combo box to select the picture you want to set or clear. RSSlider supports pictures on the Knob and background pictures. After selecting the picture type, click on the ellipsis button to set a picture or the clear button to clear an existing picture.

Picture Preview and Border Size.

The selected picture is displayed here to see how the picture would look on the control. The border size for the RSSlider is also adjusted from here. Place your mouse pointer near the black border line (the mouse pointer changes to a sizing icon) and adjust the size to the desired dimensions. To see how the control would look, use the preview window.

Bevel Style.

This combo box enables you to select a bevel style for RSSlider. Click on the down arrow and pick the desired style. Available styles are:

0-None	3-Beveled

1-Indented 	4-Thick

2-Marbled 	5-Stripe

Flash on New Data.

This check box sets the Flash Enabled FlashEnabled_Property property. To set the property to true and enable to RSSlider to flash when there is a new data from the DDE source, click on the check box.

Flash Always On.

To make RSSlider flash all the time, check this box. RSSlider will flash continuously when this property is true.

FlashSpeed.

Enter the speed at which you want RSSlider to flash in this edit box. The speed is in milliseconds. RSSlider will be on for the set speed and then turn off for the same amount of time.

FlashTimer.

Enter the duration for which you want RSSlider to flash on receiving new data from the DDE source. FlashEnabled property should be set to true (Check the Flash on New Data check box to do this) for the control to flash when it gets a new value.

LinkTip Check Box.

RSSlider provides the ability to add tool tips for the control. The tool tip can be turned on by checking this check box. Text for the tool tip is entered in the Link Tip Text box below the check box. If no text is entered, the tool tip text defaults to the Symbol name being used, and if no symbol was used, to the DDE LinkItem details for the control.


Template Tab

You can save the property settings of a control and apply them again to different controls using templates. Once a template of properties has been saved, it can be applied to another RSSlider control and the property settings applicable to that control are changed as per the template. Using this Custom Property Page Tab, templates can be Added , Changed and Managed. These property templates are saved in a file with *.rwc extension. Each set of templates is saved with a distinct name.  A duplicate name would replace any other template in that file.

•	Template. This field displays the name of the template to be applied, added or changed. The template file can be selected by clicking on ellipsis button [image]  next to the field. Available templates names are displayed in the list below this field and can be selected by clicking on the template name (selected template is highlighted).

•	Add/Change Button.  New templates or changes in an existing template can be saved by clicking on this button. The template is saved in the selected *.rwc file. The template file can be selected as described above.

•	Delete Button. To delete a template from the file, this button is used. Only the template is removed from the file and the file still remains with all other templates in that file.

•	Properties.  This field, below the template list, describes the properties and their settings for the selected template. Properties can be deleted if not required to be in the template.

•	Delete Property Button.  If you want to take out a property from the template, select the property from the list (selected property is highlighted) and click on this button.

•	Update Control Button.  To apply an existing template to the control, select the template and click on this button. This button updates the control with the property settings defined in the template which can be permanently applied by clicking on the Apply or OK button. Clicking on Cancel button will discard the changes and revert the control settings to what they were before the control was updated with Update Control button.


Using RSSlider Custom Events

The RSSlider control comes with a set custom events, that allow you to track and monitor actions performed on a RSSlider control by users of your application or by DDE transactions.  Events allow you to respond to user’s actions and control the operation of the RSSlider control.

RSSlider Custom Events.

Change Event

EndMove Event

LinkError Event

LinkItemNotSupported Event

LinkItemSupported Event

LinkNotifyEvent

LinkOutOfMemory Event

LinkServerDisconnected Event

LinkUnableToConnectToServer Event

PokeCompleted Event

RequestCompleted Event

StartMove Event


Change Event Example

You can use the Change event to validate data, update other controls and perform other functions when a RSSlider value is changed by user interaction or a DDE Source.

Note : The AllowChangeEvent property must be set to “True” to enable the Change Event to fire.

RSSlider1_Change (Index as Integer, ByVal Value As Double, ByVal SliderIndex As Integer)

Index 	: The index of the control if it is a member of an array of RSSliders.  (This index is used only if there is a RSSlider Control Array, otherwise  it is not displayed.)

Value	: The “Value” of the RSSlider control.

SliderIndex	: The index of the control if RSSlider is linked to a block of items.

1.	Place an RSSlider and a ProgressBar control on your form.

2.	Set the RSSlider AllowChangeEvent = True, LinkServer = “EXCEL”, LinkTopic = “[Book1]Sheet1”, LinkItem =“R1C1” and LinkMode = 1 - Automatic

3.	Set the ProgressBar Max = 100 and Min = 0

4.	Type in the following code.

Private Sub RSSlider1_Change (ByVal Value As Double, ByVal SliderIndex As Integer)

    ProgressBar1.Value = Value

End Sub

1.	Run the program.

In EXCEL, change the value of Cell 1 of Row 1. The RSSlider value will change accordingly and the progress bar will show the value in a graph form.

Note : RSSlider can also be linked to a column of cells. For example try changing the LinkItem to R1C1:R2C1. When you run the program RSSlider will split into two sliders showing the value from Row1 Col1 and Row2 Col1. SliderIndex will now be the index of the two split controls.


EndMove Event Example

This Event is fired when the user stops moving the slider knob.  Parameters passed in this event are as follows:

Index 	: The index of the control if it is a member of an array of RSSliders.  (This index is used only if there is a RSSlider Control Array, other wise it is not displayed.)

Value	: The “Value” of the RSSlider control.

SliderIndex	: The index of the control if RSSlider is linked to a block of items.

EndMove event can be used to perform actions when the user stops moving the RSSlidder knob( RSSlider Knob can be moved by either clicking on it and dragging it or using the scroll buttons at run time.) The following example illustrates how this event can be used.

' Global Variable declaration

Dim OldValue As Integer

Private Sub RSSlider1_EndMove (ByVal Value As Double, ByVal SliderIndex As Integer)

    Dim Msg As String

    Dim Response As Integer

    ' Build the Message String

 Msg = "Replace the old value " & OldValue & " with " & Value

    ' Display Msg Box and wait for user reply

        Response = MsgBox(Msg, vbQuestion + vbYesNo)

    ' If user wants to replace the value then update the

    ' RSSlider else set its value to the old value

    If Response = vbYes Then

        RSSlider1.Value = Value

    Else

        RSSlider1.Value = OldValue

    End If

End Sub

Private Sub RSSlider1_StartMove (ByVal Value As Double, ByVal SliderIndex As Integer)

    ' Save the old value in a global variable before

    ' the value starts to change

    OldValue = Value

End Sub


LinkError Event Example

The LinkError event occurs when there is an error during a DDE conversation.  This event is recognized only as the result of a DDE-related error that occurs when no Visual Basic code is being executed.  The Error String and Error Number is passed as an argument.

Private Sub RSSlider1_LinkError (ByVal iRet As Integer, ByVal ErrorString as String)

MsgBox ErrorString, 48, "Error Report"

End Sub


LinkItemNotSupported Event Example

LinkItemNotSupported event is fired when the DDE server does not support the Link Item specified in the link properties of the control.

Private Sub RSSlider1_LinkItemNotSupported()

Dim Msg as String

Msg = "Link Item " & RSSlider1.LinkItem & “ is not

 supported by server “ & RSSlider1.LinkServer

MsgBox Msg, 48, "Error Report"

End Sub


LinkItemSupported Event Example

LinkItemSupported Event is fired when the DDE communication is initialized and the specified Item is supported by the server.

Private Sub RSSlider1_LinkItemSupported()

Dim Msg as String

Msg = "Link Item " & RSSlider1.LinkItem & “ is

 supported by server “ & RSSlider1.LinkServer

MsgBox Msg, 48, "Link Report"

End Sub


LinkNotify Event Example

The LinkNotify event occurs when the source has changed the data defined by the DDE link, if the LinkMode property of the RSSlider control is set to 3-Notify.

Private Sub RSSlider1_LinkNotify ()

 	Dim Msg as String

Msg = "Data Value has Changed”

MsgBox Msg, 48, "Link Report"

End Sub


LinkOutOfMemory Event Example

This event is fired when the memory resources allocated for the control are exhausted and no more link activity can take place.

Private Sub RSSlider1_LinkOutOfMemory ()

Dim Msg as String

Msg = "Out of memory to carry on Link activities”

MsgBox Msg, 48, "Error Report"

End Sub


LinkServerDisconnected Event Example

This event is another tool for efficient DDE link error management. LinkServerDisconnected event is fired when an established DDE link fails due to the server disconnecting the link. Place a RSSlider control on a form and set its properties as follows :

1.	Set the RSSlider AllowChangeEvent = True, LinkServer = “EXCEL”, LinkTopic = “[Book1]Sheet1”, LinkItem =“R1C1” and LinkMode = 1 - Automatic

2.	Type in the following code.

Private Sub RSSlider1_ LinkServerDisconnected()

 Dim Msg as String

 Msg = “Link Server Disconnected”

   MsgBox Msg, 48, "Error Report"

End Sub

1.	Start Microsoft EXCEL.

2.	Run the program.

3.	Type in a value in  Row 1 Cell 1.

4.	Slider value should change accordingly.

5.	Now shutdown EXCEL . LinkServerDisconnected event is now fired and the above error message should be displayed.


LinkUnabletoConnectToServer Event Example

This event is fired when an attempt to connect to the DDE server fails. Place a RSSlider control on a form and set its properties as follows :

1.	Set the RSSlider AllowChangeEvent = True, LinkServer = “EXCEL”, LinkTopic = “[Book1]Sheet1”, LinkItem =“R1C1” and LinkMode = 1 - Automatic

2.	Type in the following code.

Private Sub RSSlider1_ LinkUnabletoConnectToServer()

 Dim Msg as String

 Msg = “Unable to connect to link server”

   MsgBox Msg, 48, "Error Report"

End Sub

1.	Run the program without first starting EXCEL. This error handling event should be fired.


PokeCompleted Event Example

The PokeCompleted event can be used to signal the user when the LinkPoke or DoPoke method (download) has finished.

Sub RSSlider1_PokeCompleted (Status As Long)

   ‘Once the Poke is completed, tell the user.

   Label1.caption = “The Download has been processed.”

End Sub

Note : This event is useful for preventing the sending of additional data to a server while it is still processing previous data.(“Outrunning the server”)


RequestCompleted Event Example

The RequestCompleted event is very similar to the LinkPoke or DoPoke event, it can be used to signal the user when the Link Request or DoRequest method(upload) has finished.

Sub RSSlider1_RequestCompleted (Status As Long, NumberRequested As Long)

   ‘Once the Request is completed, tell the user.

   Label1.caption = “The Request has completed   	successfully!”

End Sub

Note : This event is useful for preventing the requesting of additional data from a server while it is still processing previous data. .(“Outrunning the server”)


StartMove Event Example

This Event is fired when the user starts to move the slider knob.  Parameters for this event are:

Index 	: The index of the control if it is a member of an array of RSSliders. (This index is used only if there is a RSSlider Control Array, other wise it is not displayed.)

Value	: The “Value” of the RSSlider control.

SliderIndex	: The index of the control if RSSlider is linked to a block of items.

StartMove event can be used to perform function before the RSSlider Value is changed via user interaction. The following code sample illustrates one such use.

' Global Variable declaration

Dim OldValue As Integer

Private Sub RSSlider1_EndMove (ByVal Value As Double, ByVal SliderIndex As Integer)

    Dim Msg As String

    Dim Response As Integer

    ' Build the Message String

 Msg = "Replace the old value " & OldValue & " with " & Value

    ' Display Msg Box and wait for user reply

        Response = MsgBox(Msg, vbQuestion + vbYesNo)

    ' If user wants to replace the value then update the

    ' RSSlider else sets its value to the old value

    If Response = vbYes Then

        RSSlider1.Value = Value

    Else

        RSSlider1.Value = OldValue

    End If

End Sub

Private Sub RSSlider1_StartMove (ByVal Value As Double, ByVal SliderIndex As Integer)

    ' Save the old value in a global variable before

    ' the value starts to change

    OldValue = Value

End Sub


Samples Using RSSlider

RSSlider can be used to connect to DDE source and a data control to perform various functions. Two sample applications in this topic show you how to link to a DDE source and bind to a data control.

Sample Applications

Link Sample

Data Binding Sample


Link Sample

This sample illustrates how to link RSSlider to a DDE source. For this sample Microsoft EXCEL is used as the DDE source. This sample Visual Basic Project is included with RSSlider and is called “SLIDLINK.VBP”. The sample project is located in the \RSWKSHOP\RSTOOLBX\DEMO  directory.

Load this project in Visual Basic and the form ‘SlidLink.Frm’ should also be automatically loaded with this project. The form should look like the following figure at design time. The RSSlider link properties are set as follows :

RSSlider.LinkServer =  EXCEL

RSSlider.LinkTopic = [Book1]Sheet1

RSSlider.LinkItem = R1C1:R4C1

RSSlider.LinkMode = 2 (choose Automatic)

These properties can either be set in the Visual Basic Properties Window or on the Custom Property Pages. To set properties on the custom property pages, right click on the RSSlider Control and choose “Properties” option. This will bring up the Custom Property Pages. Click on the Link Info tab. Property values can be keyed in here. (For more information refer to Chapter 2, Custom Property Pages)

 RSSlider also supports a Paste Link feature which allows you to paste link information from the clipboard that has been copied from a DDE source that supports copying link information to the clipboard. You can try this with Microsoft EXCEL. Start up Microsoft EXCEL and highlight the cell you want linked. From the Edit Menu choose Copy. Bring up the Custom Property Page for RSSlider control and go to the Link Info Tab.  The Paste Link button, which is normally grayed out, will now be active. Click on the Paste Link Button and the link information is copied from the clipboard to RSSlider. Also you can right click on the RSSlider Control and choose Paste Link from the Visual Basic Floating Menu.

This is all it takes to set up a link. In this case, the RSSlider was linked to four cells. But you can link it to the desired number of cells or link items. Run this sample and RSSlider will connect to EXCEL via DDE. If your cells are empty, type in some values in the linked cells. RSSlider automatically adjusts its display and shows the cell information on different sliders for different cells. If you linked to four cells, RSSlider will show four sliders. On changing the value either in EXCEL or on the RSSlider, both the DDE source and RSSlider are updated automatically. This happens because the Link Mode is set to ‘Automatic’. At run time, the form would look like the following figure.

See Also : Note on Slider Index


Note on SliderIndex

When ever RSSlider is linked to a block of items, like the above sample, each of the RSSlider is referred to by its SliderIndex. SliderIndex should not be confused with the control Index. Control Index is the index of the RSSlider when there is a control array of RSSliders. But SliderIndex is the index of the RSSlider when a single RSSlider is linked to a block of items and each slider represents an item in the block. SliderIndex can be used to refer to the individual RSSlider in that block. In such cases, the DataValue property contains the value of the individual RSSliders and should be referred to using the SliderIndex.


Data Binding Sample

RSSlider is a data bound control and can be bound to a Visual Basic Data Control. This sample shows how RSSlider can be used to log data to a database and also update itself with the data base values. This sample is included with RSSlider and is located in the \RSWKSHOP\RSTOOLBX\DEMO directory. The project “SLIDDATA.VBP” contains the form SLIDDATA.FRM which contains the sample code and form.

The form looks like the following and is ready to run

This sample uses the RSSlider to store RGB Color values in a data base when you click on the Save Mix Button. Also scrolling through the database causes the controls to update their values according to  the data in the database.

This sample uses four RSSliders. Three of them are input controls and one is an output control that displays the tank level. For the three input RSSliders , the properties that need to be changed from defaults are :

Bevel Style	: 3-Beveled

DataField	: <Field Name such as RED, BLUE, GREEN >

DataSource	: Data1 <Name of the data control>

DataUpdate	: 2-DataSource

DisplayCaptionVertically  : True

DataUpdate property sets the source priority for the RSSlider to Update from. For example, if it is set to DataSource then the data control gets priority over the DDE link source.

The red buttons on the RSSliders are regular Visual Basic Shape control configured as a circle with fill color set to red. RSSlider can contain other controls inside it just like a frame or a panel. These button like shapes are put there to illustrate the use of StartMove and EndMove events. The colors of these shapes are changed to indicate when the slider starts to move and stops moving.

The fourth RSSlider acts as a level indicator for the vessel. The slider is configured not to accept any user input but can be controlled via code. The properties to be changed from their default for this RSSlider are:

CenterOnKnob	: False

DisplayCaption	: False

DrawDisabledShadow	: False

Enabled	: False

Scale1NumberVisible	: False

Scale1Visible	: False

Shadow	: False

SliderType	: 1-Vertical

These controls can be configured to your liking by editing their sizes and setting color properties through the custom property pages. Custom property pages provide an easier alternative to set properties than the Visual Basic properties window. RSSlider’s Face Size, Button Size etc. can directly be edited on the General Tab in the custom property pages and the results seen instantaneously in the preview window. If you feel that you are going to use the RSSlider style you created frequently, it is advisable to save it in a template. See the Template Tab reference in Chapter 2, Custom Property Tabs.

The code used for this application is as follows :

Option Explicit ‘ Declare all variables before using

The following subroutine updates the colors of the various objects with the new RSSlider values and is declared Public so that it can be called from anywhere.

Public Sub UpdateColor()

' Routine to update colors on the controls

    Dim iTemp As Integer

    Dim iRed As Integer

    Dim iGreen As Integer

    Dim iBlue As Integer

    iTemp = 0

    iTemp = Val(RSSlider1(0).Value) + Val(RSSlider1(1).Value) + Val(RSSlider1(2).Value)

RSSlider Value is converted to an Integer and added to give the sum of three values. Visual Basic in cases like above would treat the Value as a string and concatanate them into a string. For example, 2+3+4 would result in 234 instead of 9. To see this, remove the ‘Val’ function in front of the statement RSSlider1(1).Value etc.

    ' Calculate color values

    iRed = RSSlider1(0).Value * 2.55

    iGreen = RSSlider1(1).Value * 2.55

    iBlue = RSSlider1(2).Value * 2.55

    ' Set RSSlider2 value that is the tank level marker

    RSSlider2.Value = iTemp

    ' Set the colors for Shape and RSSlider2 objects

    Shape3.FillColor = RGB(iRed, iGreen, iBlue)

    RSSlider2.FaceColor = RGB(iRed, iGreen, iBlue)

End Sub

Private Sub Command1_Click()

Dim sTemp0 As String

Dim sTemp1 As String

Dim sTemp2 As String

' Save the control value before calling the AddNew

' method of the data control that resets the

' control values to zeros

    sTemp0 = RSSlider1(0).Value

    sTemp1 = RSSlider1(1).Value

    sTemp2 = RSSlider1(2).Value

When you call the AddNew method for the Visual Basic Data Control it adds a new record at the end of the database and sets the field values to zero. When this happens the RSSlider updates itself with these new values which are zeros. Therefore it is necessary to save the current RSSlider values in temporary variables before calling the AddNew method.

    Data1.Recordset.AddNew

' Set the RSSliders' value to the saved values

    RSSlider1(0).Value = sTemp0

    RSSlider1(1).Value = sTemp1

    RSSlider1(2).Value = sTemp2

After calling the AddNew method, RSSlider is set with the values in the temporary variables before calling the Update method which commits the RSSlider values to the database.

' Update the data base with new values

    Data1.Recordset.Update

' Move to the last record

    Data1.Recordset.MoveLast

After updating the values the record pointer returns to the last record that it was pointing to before the AddNew and Update methods were called. Therefore to reflect the last updated value on your controls, it is necessary to manually move the record pointer to the last record through code.

' Refresh controls

    Call UpdateColor

End Sub

Private Sub Data1_Reposition()

    ' Refresh the colors when user scrolls through the

    ' data base

    Call UpdateColor

End Sub

Private Sub Form_Load()

    ' Set the Data Control Properties

     Data1.DatabaseName = "C:\RSWKSHOP\RSTOOLBX\DEMO \Color.mdb" ‘ You may change the path to point to the proper location of the database

     Data1.Connect = "Access"

     Data1.RecordSource = "Table1"

     Data1.Caption = Data1.DatabaseName

End Sub

Private Sub RSSlider1_Change(Index As Integer, ByVal Value As Double, ByVal SliderIndex As Integer)

    ' Refresh control with new values when user moves the slider knob

    Call UpdateColor

End Sub

Private Sub RSSlider1_EndMove(Index As Integer, ByVal Value As Double, ByVal SliderIndex As Integer)

      ' Turn the on indicator to red when RSSlider stops moving

      Shape2(Index).FillColor = vbRed

End Sub

Private Sub RSSlider1_StartMove(Index As Integer, ByVal Value As Double, ByVal SliderIndex As Integer)

    ' Turn the on indicator to green when RSSlider starts to move

    Shape2(Index).FillColor = vbGreen

End Sub

Run this sample and scroll through the database to see the changes take effect on the form as the data values change. To add a new record, move the RSSlider knobs to the desired values and click on the Save Mix button.


(About) Property

Description	Displays the About Rockwell Process Objects dialog box with revision number.

Remarks	Available at design time only.


(Custom) Property

Description	Displays the control's custom properties page.

Remarks	Available at design time only.


AccelRate Property

Description	Sets or returns the increment/decrement acceleration rate when the scroll buttons are clicked.

Visual Basic	[form1.]RSSlider1.AccelRate [=setting%]

Remarks	Can be set from 0 to MaximumIncrement.

Custom	Set in the Value section of the properties page

Data Type	Integer


ButtonArrowColor Property

Description	Sets/Returns the color of the arrows on the Slider's scroll buttons.

Visual Basic	[form1.]RSSlider1.ButtonArrowColor [=setting%%]

Custom	Color is set in the Display section of the properties page by choosing ButtonArrowColor in the properties Combo box and then selecting a color in the colors Combo box

Data Type	OLE_Color


ButtonOffset Property

Description	Sets/Returns the distance between the scroll button and the slider face.

Visual Basic	[form1.]RSSlider1.ButtonOffset[=setting%]

Custom	Edit picture directly in General section of Custom property pages.

Data Type	Integer


ButtonSize Property

Description	Sets/Returns the size (width) of the Slider's buttons.

Visual Basic	[form1.]RSSlider1.ButtonSize [=setting%%]

Custom	Edit picture directly in General section of Custom properties page

Data Type	Integer


ButtonStyle Property

Description	Sets/Returns the style of the increment buttons.

Visual Basic	[form1.]RSSlider1.ButtonStyle [=setting%%]

Custom	Set in the General section of the Custom properties page with the Button Combo Box

Remarks	Setting	Description

0	Sets scroll buttons to 3 D buttons.

1	Sets scroll buttons to arrows.

Data Type	Integer


CenterOnKnob Property

Description	Determines if the value is centered on the RSSlider knob or displayed elsewhere on the control.

Visual Basic	[form1.]RSSlider1.CenterOnKnob [=setting%%]

Remarks	Setting	Description

True   	Value is displayed on the RSSlider knob.

False   	Value is displayed at specified location on the control.

Custom	Enabled / disabled  with a checkbox in the Options window of the General Section of the properties page. If CenterOnKnob is disabled, the value position can be set by moving the blue value position square to the desired position.

Data Type	Boolean


DefaultIncrement Property

Description	Sets/Returns the scroll buttons to increment/decrement by the default increment of 0.5 only, even if AccelRate is set to something else.

Visual Basic	[form1.]RSSlider1.DefaultIncrement [=setting%]

Remarks	Setting	Description

True   	Change by default increment of 0.5

False   	Change by the increment set in AccelRate.

Custom	Checkbox in General Section

Data Type	Boolean


DisplaySliderFace Property

Description	Toggles display of RSSlider’s face (track).

Visual Basic	[form1.]RSSlider1.DisplaySliderFace[=setting%]

Remarks	Setting	Description

True   	Displays the Slider face (track).

False 	Hides the Slider face (track).

Custom	"Display Track" checkbox in Options window on the General Section of the Custom properties page.

Data Type	Boolean


FaceDivider Property

Description	Splits the Slider face (track) in two.

Visual Basic	[form1.]RSSlider1.FaceDivider [=setting%]

Remarks	Setting	Description

True 	Divides the face into two tracks.

False 	Makes the face into single track.

Custom	Edit picture directy in general Section.

Data Type	Boolean


FaceHeight Property

Description	Sets/Returns the physical height of the Slider's face (track).

Visual Basic	[form1.]RSSlider1.FaceHeight [=setting%]

Custom	Edit picture directy in General section of Custom properties page.

Data Type	Integer


FaceWidth Property

Description	Sets/Returns the physical width of the Slider's face (track).

Visual Basic	[form1.]RSSlider1.FaceWidth [=setting%]

Custom	Edit picture directy in General section of Custom properties page.

Data Type	Integer


IndentedStyle Property

Description	Sets/Returns the Slider face (track) style.

Visual Basic	[form1.]RSSlider1.IndentedStyle [=setting%%]

Remarks	Setting	Description

True 	The face (track) appears indented.(3-D)

False 	The face (track) appears un-indented.

Applies both when the face (track) is split and when it is solid.

Custom	Checkbox in General Section.

Data Type	Boolean


KnobFaceColor Property

Description	Sets/Returns the color for the Slider's knob face.

Visual Basic	[form1.]RSSlider1.KnobFaceColor [=setting%]

Custom	Color is set in the Display section of the properties page by choosing KnobFaceColor in the properties Combo box and then selecting a color in the colors Combo box.

Data Type	OLE_Color


KnobHeight Property

Description	Sets/Returns the physical height of the Slider's knob.

Visual Basic	[form1.]RSSlider1.KnobHeight [=setting%]

Custom	Edit picture directly in the General section of the Custom properties page.

Data Type	Integer


KnobHighlight Property

Description	Sets/Returns the color for the Slider's knob highlight.

Visual Basic	[form1.]RSSlider1.KnobHighlight [=setting%]

Custom	Color is set in the Display section of the properties page by choosing KnobHighlight in the properties Combo box and then selecting a color in the colors Combo box

Data Type	OLE_Color


KnobShadow Property

Description	Sets/Returns the color for the Slider's knob shadow.

Visual Basic	[form1.]RSSlider1.KnobShadow [=setting%]

Custom	Color is set in the Display section of the properties page by choosing KnobShadow in the properties Combo box and then selecting a color in the colors Combo box.

Data Type	OLE_Color


KnobType Property

Description	Sets/Returns the knob style.

Visual Basic	[form1.]RSSlider1.KnobType [=Setting%]

Remarks	Setting	Description

0 	 None

1	 Button

2 	 Pointed

3 	 Box

Custom	Set in the General section of the Custom properties page using the Knob Style Combo Box

Data Type	Integer


MaximumIncrement Property

Description	Sets/Returns the MaximumIncrement value for the Slider, which is the maximum value to which the scrolling will accelerate.

Visual Basic	[form1.]RSSlider1.MaximumIncrement [=setting%]

Custom	Set in the Value section of the Custom properties page.

Data Type	Integer


PageIncClick Property

Description	Enables Page Increment  to be used when slider face (track) is clicked on. Page Increment is when the Slider's value is adjusted by an interval proportional to the distance between the mouse pointer and the Slider knob at the time of the click.

Visual Basic	[form1.]RSSlider1.PageIncClick [=setting%]

Remarks	Setting	Description

True 	Allows Page Increment.

False 	Disables Page Increment.

Custom	Checkbox in the General section of the Custom properties page.

Data Type	Boolean


PictureKnob Property

Description	Defines the picture to be displayed on the RSSlider knob.

Visual Basic	[form1.]RSSlider1.PictureKnob [=setting%]

Remarks	Supports bitmaps,icons,metafiles files

Custom	Display Section

Data Type	Bitmaps, Metafiles and Icon picture files.


PictureKnobStretch Property

Description	Stretches the picture to the knob boundaries.

Visual Basic	[form1].RSSlider1.PictureKnobStrech[=setting%]

Remarks	Setting	Description

True 	Stretches the Picture.

False 	Lets the picture to be displayed in its original size.

Custom	Checkbox in the General section of the Custom properties page

Data Type	Boolean


PointedType Property

Description	Sets/Returns the direction that the Slider's knob is pointing if the knob is set to  pointed type.

Visual Basic	[form1.]RSSlider1.PointedType[=setting%]

Remarks	Settings	Description

0  	East (Right)

1  	South (Down)

2 	West (Left)

3  	North (Up)

Custom	Set in the General section of the Custom properties page.

Data Type	Integer


SliderHighlight Property

Description	Sets/Returns the Slider's face (track) highlight color..

Visual Basic	[form1.]RSSlider1.SliderHighlight [=setting%]

Custom	Color is set in the Display section of the Custom properties page by choosing SliderHighlight in the properties Combo box and then selecting a color in the colors Combo box

Data Type	OLE_Color


SliderShadow Property

Description	Sets/Returns the Slider's face (track) shadow color.

Visual Basic	[form1.]RSSlider1.SliderShadow [=setting%]

Custom	Color is set in the Display section of the Custom properties page by choosing SliderShadow in the properties Combo box and then selecting a color in the colors Combo box

Data Type	OLE_Color


SliderType Property

Description	Sets/Returns the type of Slider..

Visual Basic	[form1.]RSSlider1.SliderType [=setting%]

Remarks	Settings	Description

0 	Horizontal

1 	Vertical

2 	Horizontal - One End Buttons

3	Vertical - One End Buttons

4 	Horizontal - Both Ends Buttons

5 	Vertical - Both Ends Buttons

Custom	Set on the General section of the properties page with the Slider Type Combo Box..

Data Type	Integer


Change Event

Example

Description	Indicates that the RSSlider Value has changed either by the User actions, or DDE Link Source.

Syntax	Private Sub RSSlider1_Change (Index as Integer, ByVal Value As Double, ByVal SliderIndex As Integer)

Remarks	The Value argument allows you to take the latest information in the control and use it to process in your code.  The argument index uniquely identifies a control if it is in a control array.  A Change procedure can synchronize data display among other controls.

Note	AllowChangeEvent property must be set to true in order for the Change event to occur.


EndMove Event

Example

Description	This Event is fired when the user stops moving the slider knob.

Syntax	Private Sub RSSlider1_EndMove (Index As Integer, ByVal Value As Double, ByVal SliderIndex As Integer)

Remarks	Parameters passed to this event are as follows:

Index: The index of the control if it is a member of an array of RSSliders.  (This index is used only if there is a RSSlider RSSlider1 Array, otherwise it is not displayed.)

Value: The “Value” of the RSSlider control.

SliderIndex: The index of the control if RSSlider is linked to a block of items.


LinkError Event

Example

Description	The LinkError event occurs when there is an error during a DDE conversation.  This event is recognized only as the result of a DDE-related error that occurs when no Visual Basic code is being executed.  The error number and error string are passed as arguments.

Syntax	Private Sub RSSlider1_LinkError (Index As Integer, ByVal iRet As Integer, ByVal ErrorString As String)

Remarks	Use a LinkError event procedure to notify the user of the particular error that has occurred.  For additional information, refer to the description of the LinkError event in the Microsoft Visual Basic Language Reference Manual.


LinkItemNotSupported Event

Example

Description 	The LinkItemNotSupported event occurs when the DDE server does not support the link item you specified.

Syntax	Private Sub RSSlider1_LinkItemNotSupported(Index As Integer)


LinkItemSupported Event

Example

Description 	LinkItemSupported event is fired when DDE conversation with the server is established and the link item is supported by the server.

Syntax	Private Sub RSSlider1_LinkItemSupported(Index As Integer)


LinkNotify Event

Example

Description	The LinkNotify event occurs when the source has changed the data defined by the DDE link, if the LinkMode property of the RSSlider control is set to 3-Notify.

Syntax	Private Sub RSSlider1_LinkNotify (Index As Integer)

Remarks	Typically, in the LinkNotify event your code notifies the user, gets the new data immediately, or defers getting the data until later.  You can use the LinkRequest method to obtain the new data from the source.  For additional information, refer to the description of the LinkNotify event in the Microsoft Visual Basic Language Reference Manual


LinkOutOfMemory Event

Example

Description	Occurs when the control has exhausted its allocated memory resources for the link operation.

Syntax	Private Sub RSSlider1_LinkOutOfMemory (Index As Integer)


LinkServerDisconnected Event

Example

Description	This event is another tool for efficient DDE link error management. LinkServerDisconnected event is fired when an established DDE link fails due to the server disconnecting the link.

Syntax	Private Sub RSSlider1_LinkServerDisconnected(Index As Integer)


LinkUnabletoConnectToServer Event

Example

Description	This event is fired when an attempt to connect to the DDE server fails.

Syntax	Private Sub RSSlider1_LinkUnableToConnectToServer (Index As Integer)


PokeCompleted Event

Example

Description	The PokeCompleted event can be used to signal the user when the LinkPoke or DoPoke method (download) has finished.

Syntax	Private Sub RSSlider1_PokeCompleted (Index As Integer, ByVal iRet As Integer)

Remarks	The argument iRet returns error numbers


RequestCompleted Event

Example

Description	The RequestCompleted event is very similar to PokeCompleted event. It can be used to signal the user when the Link Request or DoRequest method (upload) has finished.

Syntax	Private Sub RSSlider1_RequestCompleted (Index As Integer, ByVal iRet As Integer)

Remarks	The argument iRet returns error numbers


StartMove Event

Example

Description	This Event is fired when the user starts to move the RSSlider knob.

Syntax	Private Sub RSSlider1_StartMove (Index as Integer, ByVal Value As Double, ByVal SliderIndex As Integer)

Remarks	Index: The index of the control if it is a member of an array of RSSliders.  (This index is used only if there is a RSSlider Array, other wise it is not displayed.)

Value : The “Value” of the RSSlider control.

SliderIndex: The index of the control if RSSlider is linked to a block of items.


INI File Used for RSSlider

RSSlider saves some of the information such as the default files names etc. in the RSTOOLS.INI file located in the \WINDOWS directory. Only the following information should be changed or altered and any other section should not be altered for proper operation of the OCX.

The following section sets the default template file for RSSlider. The user templates are stored in this file.

[cfg]

cfg=c:\windows\mytempls.rwc

where mytempls.rwc is the default template file you want your templates to be saved in.

The symbol information for the DDE link is set in the following section.

[sym]

symbolname=server|topic|item

where the ‘server’ is the DDE server, ‘topic’ is the DDE topic and ‘item’ is the DDE item. Example of the above is

[sym]

subtotal= Excel|[Book1]Sheet1|R6C2

total= Excel|[Book1]Sheet1|R8C2


Programming Tools

RSTools provide several custom properties and standard properties.  By setting these properties, you can perform a variety of tasks, such as hiding and displaying controls, setting DDE properties or binding to a database.

See Also

Link Tips

Excel Blocks

AdvanceDDE Arrays


LinkTips

The LinkTips property can be a very useful tool during run time.  It allows you to create a help balloon to display useful information.  It will also display the property settings for the LinkServer, LinkTopic and LinkItem all at once.  The controls have four properties associated with the LinkTips function:

•	LinkTip (True\False) - The LinkTip property allows you to turn it on or off during run time.

•	LinkTipText - Displays text in a popup window next to the control. (A help balloon).

•	LinkTipBackColor (any color value) - The LinkTipBackColor property allows you to change the background color of the LinkTip window.

•	LinkTipForeColor (any color value) - The LinkTipForeColor property allows you to change the text color of the LinkTip window.

Note	Refer to the LinkTip property in the property reference for more information on the LinkTip property’s attributes.


Excel Blocks

A very useful tool that the control supports is its ability to poke or request data to Microsoft Excel, one word at a time or as a large block of data.  Below is one possible example for configuring a block read from Excel (Using RSData as an example).

rsdata1.LinkServer = "Excel"

rsdata1.LinkTopic = "[Book1]Sheet1"

rsdata1.LinkItem = "R1C1:R2C2"   ‘Read 4 cells of data

rsdata1.DoRequest = True


AdvanceDDE Arrays   (Optional: Requires RSJunctionBox)

AdvanceDDE arrays are very useful when accessing large amounts of data from a server.  The easiest method is to use DDE block arrays as shown below.

rsdata1.LinkServer = "icomwdrv"

rsdata1.LinkTopic = "testsol"

rsdata1.Linkitem = "N7:0,L10"

rsdata1.LinkMode = 1

Note	This functionality (AdvanceDDE) requires a Rockwell Software serve product, RSServer Toolkit partner server product, or a self-built AdvanceDDE server as the data link source.


Binding to the Data Control

With the RSTools controls and Visual Basic’s Data control, you can create an application to display edit, and update (log) information from many types of existing databases.  Creating a data-aware application with Visual Basic can be done easily through a few steps, and requires very little code.

The first thing you need to do to make a “data-aware” application is to add the Visual Basic Data control or the Remote Data control to your form.  Next, you will have to specify the database you would like to get the information from.  Once you have decided on the database, you must place the RSTools controls on the form and set their properties to “bind“ to Visual Basic’s Data control.  Depending on the property settings you choose for DataUpdate, when you run the application you will be able to view data coming from your server, view data from a database, or log data to the database.

The RSTools controls combined with Visual Basic’s Data control give you seamless access to many standard databases, including Microsoft Access, Btrieve, dBASE , Microsoft FoxPro, and Paradox.  If the Remote Data control is used, ODBC databases such as SQL Server and Oracle are accessible anywhere on a network.

See Also

Quick Start - Using RSTools to read from DataSource.


Quick Start

The following procedure gives you a brief overview of how to “bind” or use the RSData control (one of the RSTools controls) and Visual Basic’s data control in your application.  Below we will use the COLOR.MDB sample database that comes with RSTools.

How to use the RSData (or any RSTools control) control as a “Database” tool.

1.	Select the RSData control in the toolbox and draw a RSData control on the form.  The RSData control icon looks like this:

Click and drag the control on your form.  It will look like a label control.  The default name of the control is RSData1.

1.	Select the Visual Basic Data control and draw a control on the form.  The Data control icon looks like this:

After you have drawn the control on the form, it will look like this, with the default caption as Data1.

1.	In the properties window for the Visual Basic Data control, set the DatabaseName property to the filename you want to connect to C:\RSWKSHOP\RSTOOLBX\DEMO\COLOR.DBF.

1.	For the Connect property, you must specify “Access” Then set RecordSource = “COLORS”.  The RecordSource is the name of the database table.

1.	Click once on the RSData control and bring up it’s property window.  In the properties window, set the DataSource = Data1, the DataField = COLORNAME, and set the DataUpdate = 2- Data Source.

1.	Now run the application.  The RSTools control displays the data in the “COLOR” field based on which database record you display.  You can use the arrow buttons in the data control to move through the records.


AllowChangeEvent Property

Applies To	RSButton, RSCompare, RSData, RSGauge, RSSlider, RSVessel, RSWheel

Description	Enables the firing of a Change event when data in the control changes.

Visual Basic	object.AllowChangeEvent[ = setting %]

Settings	The following table lists the AllowChangeEvent property settings for the control.

Settings	Description

False	Do not allow the Change event to occur.

True	Allow the Change event to occur.

Data Type	Integer


AutoColumns Property

Applies To	RSButton, RSCompare, RSData, RSGauge, RSSlider, RSVessel, RSWheel

Description	Creates the correct number of columns to be displayed based on the LinkItem.

Custom	No access via custom property page.

Visual Basic	object.AutoColumns[=setting %]

Remarks	AutoColumns will work only if the LinkItem length divided by the number of columns leaves a remainder of zero. For example, a LinkItem of  "C5:0,L11,C2"  would display as only one column because eleven divided by two leaves a remainder of one.  AutoColumns will only work with AdvanceDDE, which requires RSJunctionBox.

Data Type	Integer


BackColor Property

Applies To	RSButton, RSCompare, RSData, RSGauge, RSSlider, RSVessel, RSWheel

Description	Sets the background color for the control.

Custom	Display section.

Visual Basic	object.BackColor[=setting %]

Settings	Visual Basic uses the Microsoft Windows operating environment red-green-blue (RGB) color scheme.  The settings for color are:

Setting	Description

Normal RGB colors	Colors specified by using the Color palette or by using the RGB or QBColor functions in code.

System default colors	Colors specified by system color constants listed in the Visual Basic (VB) object library in the Object Browser.  The Windows operating environment substitutes the user's choices as specified in the Control Panel settings.

Data Type	Color


BackStyle Property

Applies To	RSButton, RSCompare, RSData, RSGauge, RSSlider, RSVessel, RSWheel

Description	Determines if the control will be transparent or opaque.

Custom	No access via custom property page.

Visual Basic	object.BackStyle[=setting %]

Settings	Settings	Description

0 	Sets the control  to transparent.

1 	Sets the control to opaque.

Data Type	Integer


BevelHeight Property

Applies To	RSButton, RSCompare, RSData, RSGauge, RSSlider, RSVessel, RSWheel

Description	Sets the height of the top and bottom beveled edges around the control.

Custom	No access via custom property page.

Visual Basic	object.BevelHeight[=setting %]

Data Type	Integer


BevelHighlight Property

Applies To	RSButton, RSCompare, RSData, RSGauge, RSSlider, RSVessel, RSWheel

Description	Sets the highlight color of the control's beveled  border.

Custom	Display section.

Visual Basic	object.BevelHighlight[=setting %]

Remarks	BevelHighlight is dependent on the bevel style chosen for the control.  If BevelStyle is set to either 1 (indented) or 3 (beveled), the control's outside border will be given a 3 dimensional appearance by displaying a bevel highlight and a bevel shadow.

Data Type	Color


BevelShadow Property

Applies To	RSButton, RSCompare, RSData, RSGauge, RSSlider, RSVessel, RSWheel

Description	Sets the shadow color of the control's beveled  border.

Custom	Display section.

Visual Basic	object.BevelShadow[=setting %]

Remarks	BevelShadow is dependent on the bevel style chosen for the control.  If BevelStyle is set to either 1 (indented) or 3 (beveled), the control's outside border will be given a 3 dimensional appearance by displaying a bevel highlight and a bevel shadow.

Data Type	Color


BevelStyle Property

Applies To	RSButton, RSCompare, RSData, RSGauge, RSSlider, RSVessel, RSWheel

Description	Determines the style of the beveled area around the control object.  A beveled appearance is one that has a three dimensional look.  This property controls the beveled appearance of the outside border around the control.

Custom	Adjusted in the Display section of the custom properties page.  The BevelStyle list box in the lower right hand corner has a drop drop down menu with six styles available for the bevel:

Settings	Description

0	None

1	Indented

2	Marble

3	Beveled

4	Thick

5	Stripe

Visual Basic	object.BevelStyle[=setting %]

Remarks	If a bevel does not appear when this property is set to True, make sure that the BevelWidth and BevelHeight properties are set to a value greater than zero.

Data Type	Integer


BevelWidth Property

Applies To	RSButton, RSCompare, RSData, RSGauge, RSSlider, RSVessel, RSWheel

Description	Sets the width of the left and right beveled edges around the control.

Custom	No access via custom property page.

Visual Basic	object.BevelWidth[= setting %]

Data Type	Integer


BorderBeveled Property

Applies To	RSCompare, RSVessel

Description	Toggles display of BorderHighlight and BorderShadow.

Custom	Adjusted in the General section of the custom properties page with a checkbox in the Options window.

Visual Basic	object.BorderBeveled[=setting %]

Remarks	When set to False in the RSVessel control, the BorderHighlight and BorderShadow are not displayed, but PolyBorderColor is displayed. When True, all three are shown. When set to False in the RSCompare control, BorderHighlight and BorderShadow are not displayed, while DownBorderColor, EqualBorderColor, and UpBorderColor are still shown. When set to True, all are shown.

Data Type	Integer


BorderColor Property

Applies To	RSButton, RSCompare, RSData, RSGauge, RSSlider, RSVessel, RSWheel

Description	Determines the color of the border around the control object.

Custom	Display section.

Visual Basic	object.BorderColor[=setting %]

Remarks	The BorderColor property can be set to any color in the palette or to a hex integer value that represents a color.

Data Type	Color


BorderHighlight Property

Applies To	RSCompare, RSVessel

Description	Sets the Highlight color for the three-dimensional border of the applicable controls' graphic shapes.

Custom	Display section.

Visual Basic	object.BorderHighlight[=setting %]

Remarks	For the RSCompare control, this property sets the BorderHighlight color for all of its states - Up, Equal, and Down.

Data Type	Color


BorderInner Property

Applies To	RSButton, RSCompare, RSData, RSGauge, RSSlider, RSVessel, RSWheel

Description	Determines if the inner border is displayed around the control object.

Custom	No access via custom property page.

Visual Basic	object.BorderInner[ = setting %]

Remarks	This property is dependent upon the BevelStyle property in that  the inner border is displayed only when a BevelStyle other than 0 (none) is chosen.

Data Type	Integer


BorderInnerColor Property

Applies To	RSButton, RSCompare, RSData, RSGauge, RSSlider, RSVessel, RSWheel

Description	Determines the color of the inner border around the control object.

Custom	Display section.

Visual Basic	object.BorderInnerColor[=setting %]

Remarks	The BorderInnerColor property can be set to any color in the palette or to a hex integer value that represents a color.

Data Type	Color


BorderShadow Property

Applies To	RSCompare, RSVessel

Description	Sets the Shadow color for the three-dimensional border of the applicable controls' graphic shapes.

Custom	Display section.

Visual Basic	object.BorderShadow[=setting %]

Remarks	For the RSCompare control, this property sets the BorderShadow color for all of its states - Up, Equal, and Down.

Data Type	Color


BorderStyle Property

Applies To	RSButton, RSCompare, RSData, RSGauge, RSSlider, RSVessel, RSWheel

Description	Determines the type of border displayed around the control object.

Custom	No access via custom property page.

Visual Basic	object.BorderStyle[=setting %]

Remarks	There are two border styles available: 0 = None and 1 = Fixed Single.

Data Type	Integer


BorderWidth Property

Applies To	RSButton, RSCompare, RSData, RSGauge, RSSlider, RSVessel, RSWheel

Description	Determines the width of the border displayed around the control object.

Custom	No access via custom property page.

Visual Basic	object.BorderWidth[=setting %]

Remarks	The BorderStyle property needs to be set to 1 (Fixed Single) in order to make changes in BorderWidth visible.

Data Type	Integer


BottomBorder Property

Applies To	RSButton, RSCompare, RSData, RSGauge, RSSlider, RSVessel, RSWheel

Description	Sets the distance between bottom external border of the control and bottom of the control.

Custom	Adjusted in the General section of the custom properties page. Placing the mouse pointer over either of the control graphic's lower corners will cause a sizing pointer to appear. Clicking and holding the left mouse button allows the bottom border for the control to be adjusted to the appropriate position with respect to the bottom external border of the control. Releasing the mouse button will then set the BottomBorder property.

Visual Basic	object.BottomBorder[=setting %]

Remarks	The BottomBorder property controls the distance between the outside border of the control and the lower edge of the control. Use this property to adjust the space available for displaying a caption or value.

Data Type	Integer


ButtonBorderWidth Property

Applies To	RSCompare, RSVessel

Description	Sets the width of the BorderHighlight and BorderShadow properties for applicable controls.

Custom	No access via custom property page.

Visual Basic	object.ButtonBorderWidth[=setting %]

Remarks	Sets the width of the three-dimensional border (shown with the BorderHighlight and BorderShadow properties) around the RSVessel and RSCompare controls' graphic shapes. For these two	 controls there is not a corresponding ButtonBorderHeight property as in the RSButton control.

Data Type	Integer


ButtonFaceColor Property

Applies To	RSButton, RSSlider, RSWheel

Description	Sets the color for the face of the control's buttons.

Custom	Display section.

Visual Basic	object.ButtonFaceColor[=setting %]

Remarks	For the RSButton control, the Button's (all styles) face color is set with ButtonFaceColor,  for the RSSlider control, the face color of the its two scroll buttons is set with ButtonFaceColor, and for the RSWheel control ButtonFaceColor sets the face color for the up and down scroll arrow buttons.

Data Type	Color


ButtonHighlight Property

Applies To	RSButton, RSSlider, RSWheel

Description	Sets the highlight color for the control's three-dimensional button(s) effect.

Custom	Display section.

Visual Basic	object.ButtonHighlight[=setting %]

Remarks	ButtonHighlight sets the highlight color for the Button control's three-dimensional outside border, sets the highlight color on the scroll buttons for the Slider, and sets the highlight color for the up and down scroll arrow buttons for the Wheel.

Data Type	Color


ButtonShadow Property

Applies To	RSButton, RSSlider, RSWheel

Description	Sets the shadow color for the control's three-dimensional button(s) effect.

Custom	Display section.

Visual Basic	object.ButtonShadow[=setting %]

Remarks	ButtonShadow sets the shadow color for the Button control's three-dimensional outside border, sets the shadow color on the scroll buttons for the Slider, and sets the shadow color for the up and down scroll arrow buttons for the Wheel.

Data Type	Color


Caption Property

Applies To	RSButton, RSCompare, RSData, RSGauge, RSSlider, RSVessel, RSWheel

Description	Sets the caption to be displayed on the control.

Custom	Set in the Value section of the custom properties page with the "Caption" text box. Text entered in this text box will appear as the control's caption.

Visual Basic	object.Caption[=setting %]

Remarks	The DisplayCaption property must be set to True in order for the Caption to be shown.

Data Type	String


CaptionBackColor Property

Applies To	RSButton, RSCompare, RSData, RSGauge, RSSlider, RSVessel, RSWheel

Description	Sets the background color of the caption for the control.

Custom	Display section.

Visual Basic	object.CaptionBackColor[=setting %]

Remarks	The CaptionBackColor property can be set to any color in the palette or to a hex integer value representing a color.  If the CaptionTransparent property is set to True, CaptionBackColor will not be shown.

Data Type	Color


CaptionColor Property

Applies To	RSButton, RSCompare, RSData, RSGauge, RSSlider, RSVessel, RSWheel

Description	Sets the color of the caption text for the control.

Custom	Display section.

Visual Basic	object.CaptionColor[=setting %]

Remarks	The CaptionColor property can be set to any color in the palette or to a hex integer value representing a color. The DisplayCaption property must be set to True in order for this property to have any effect.

Data Type	Color


CaptionShadow Property

Applies To	RSButton, RSCompare, RSData, RSGauge, RSSlider, RSVessel, RSWheel

Description	Enables/disables the shadow behind the caption for the control.

Custom	Adjusted in the General section of the custom properties page with a checkbox in the Options window.

Visual Basic	object.CaptionShadow [=setting %]

Remarks	The DisplayCaption property must be True before this property will have any visible effect.  When set to True, a shadow will be displayed behind the caption text; when set to False, the shadow will not be displayed.

Data Type	Integer


CaptionShadowColor Property

Applies To	RSButton, RSCompare, RSData, RSGauge, RSSlider, RSVessel, RSWheel

Description	Sets the color of the caption's shadow for the control.

Custom	Display section.

Visual Basic	object.CaptionShadowColor[=setting %]

Remarks	The CaptionShadowColor property can be set to any color in the palette or to a hex integer value representing a color. The DisplayCaption and the CaptionShadow properties must be set to True before this property will have any visible effect.

Data Type	Color


CaptionTransparent Property

Applies To	RSButton, RSCompare, RSData, RSGauge, RSSlider, RSVessel, RSWheel

Description	Enables/disables display of the CaptionBackColor.

Custom:	Adjusted in the General section of the custom properties page with a checkbox in the Options window.

Visual Basic	object.CaptionTransparent[=setting %]

Remarks	When set to True, the CaptionBackColor is transparent and will not be displayed; when set to False the CaptionBackColor will be displayed.  DisplayCaption must be set to True before this property will have any visible effect.

Data Type	Integer


CaptionX Property

Applies To	RSButton, RSCompare, RSData, RSGauge, RSSlider, RSVessel, RSWheel

Description	Sets the horizontal position of the caption with respect to the left edge of the control object.

Custom	Adjusted in the General section of the custom properties page. The red square caption position indicator on the control graphic shows the relative position of the caption. To change the caption position, click,  drag, and drop the red square in the desired location. If the red square is not displayed, the DisplayCaption property needs to be set to True.

Visual Basic	object.CaptionX [=setting %]

Remarks	The range for the CaptionX property is from 0 to 100 with zero being the left edge and 100 being the right edge of the control. The DisplayCaption property must be set to True before this property will have any visible effect.

Data Type	Integer


CaptionY Property

Applies To	RSButton, RSCompare, RSData, RSGauge, RSSlider, RSVessel, RSWheel

Description	Sets the vertical position of the caption with respect to the top edge of the control object.

Custom	Adjusted in the General section of the custom properties page. The red, square caption position indicator on the control graphic shows the relative position of the caption. To change the caption position, click,  drag, and drop the red square in the desired location.  If the red square is not displayed, the DisplayCaption property needs to be set to True.

Visual Basic	object.Control.CaptionY[= setting %]

Remarks	The range for the CaptionY property is from 0 to 100 with zero being the top edge and 100 being the bottom edge of the control. The DisplayCaption property must be set to True before this property will have any visible effect.

Data Type	Integer


Clip Property

Applies To	RSButton, RSCompare, RSData, RSGauge, RSSlider, RSVessel, RSWheel

Description 	Returns or sets the contents of the data elements in a control.  Not available at design time.

Visual Basic	object.Clip [= string]

The Clip property syntax has these parts:

Part	Description

object 	An object expression that evaluates to an object in the Applies To list.

string	A string expression containing the element contents.

Remarks	The string can contain the contents of multiple rows and columns.  In the string, a tab character (ANSI character 9) indicates a new element in a row, and a carriage return (ANSI character 13) indicates the beginning of a new row.  Use the Chr function to embed these characters in strings.  For example, the following line of code puts text into 4 Gauge controls that are displayed in 2 rows by 2 columns:

RSGauge1.Clip = "231" & Chr(9) & "400" & Chr(13) & "278" & Chr(9) & "58"

Compiling a string and setting a control’s Clip property is an excellent way to programmatically use a single instance of a control to display multiple values.

The clip property works in a similar fashion for the other RSTool controls.

Data Type	String


DataChanged Property

Description	Returns or sets a value indicating that RSData in a control has changed by some process other than by retreiving RSData from the current record.

Visual Basic	object.Control.RSDataChanged[=setting]

Remarks	The Visual Basic Data control will record changes made to a bound database as you move through its records. In order to avoid recording changes made to the database's records, set the DataChanged property to False in the Data control's Validate event. When the Data control is moved to the next record, the Validate event is fired and if DataChanged is True, changes made to the database are recorded.

Applies To	RSButton, RSCompare, RSData, RSGauge, RSSlider, RSWheel, RSVessel


DataField Property

Applies To	RSButton, RSCompare, RSData, RSGauge, RSSlider, RSVessel, RSWheel

Description	Binds the control to a particular field in a database. Used for reading from and writing to a database.  The DataSource property must be set prior to this property to enable browsing.

Custom	No access via custom property page.

Visual Basic	object.DataField[=setting %]

Remarks	The DataField, DataSource, and DataUpdate properties work together with the Visual Basic Data control to bind the RSTools control to a database.

Data Type	String


DataSource Property

Applies To	RSButton, RSCompare, RSData, RSGauge, RSSlider, RSVessel, RSWheel

Description	Binds the control to the particular Visual Basic data control which is bound directly to a database.  The available data controls appear in a drop-down list next to the property name in the properties window

Custom	No access via custom property page.

Visual Basic	object.DataSource[=setting %]

Remarks	DataSource is read/write at design time; not available at run time. The DataField, DataSource, and DataUpdate properties work together with the Visual Basic Data control to bind the RSTool control to a database.

Data Type	String


DataUpdate Property

Applies To	RSButton, RSCompare, RSData, RSGauge, RSSlider, RSVessel, RSWheel

Description	Determines the primary source of displayed data as well as which data triggers a Change event.

Visual Basic	object.DataUpdate[=setting %]

Remarks	Available settings for the DataUpdate property are 0 = Data Link, which displays only the data specified by the LinkItem; 1 = Data Source, which displays only the data (field in database) that the control is bound to; 2 = Data Link, Log To Data Source, which logs data to the Data Source specified by the data control; and 3 = No Update. When DataUpdate is set to 1 (Data 	Source), you will be able to view the contents of the field that the control is bound to. When DataUpdate is set to 2 (Data Link, Log to Data Source) and LinkMode is set to Automatic, the data control will add new records to the database whenever the control's value changes.

Data Type	Integer


DataValue(Index) Property

Applies To	RSButton, RSCompare, RSData, RSGauge, RSSlider, RSWheel, RSVessel

Description	When requesting an array of data by using the block method (i.e. LinkItem = t4:0.acc, L25), you can use the DataValue property to select the specified element in the array.  DataValue(0) for a single item data link is valid as well, even though it is not an array.  DataValue(n) is an array property and must have an index.

Visual Basic	object.DataValue(item number)

Remarks	Specifying array items in your LinkItem string makes it very easy to move large blocks of data with only one control.  If you want to use element 25, simply specify that number. (i.e. rsdata1.datavalue(24)).

Data Type	Integer


DecimalPlaces Property

Applies To	RSButton, RSCompare, RSData, RSGauge, RSSlider, RSVessel, RSWheel

Description	Determines the number of decimal places that will be shown when the value is displayed on the control.

Custom	Adjusted in the Value section of the custom properties page by changing the value in the 	"Decimals" text box. This value can be changed either by typing the number directly or by using the up and down scroll buttons.

Visual Basic	object.DecimalPlaces[=setting]

Remarks	The range for the DecimalPlaces property value is from 0 to 9. TheDisplayValue property must be set to True before this property will have any visible effect, however the setting affects the Value and DataValue(n) properties whether visible or not.

Data Type	Integer


DisplayBorder Property

Applies To	RSCompare, RSVessel

Description	Enables/disables all borders for the control's graphic shape.

Custom	Enabled/disabled in the Options window of the General section of the properties page.

Visual Basic	object.DisplayBorder[=setting]

Remarks	In the case of the RSCompare control, when set to True a three-dimensional border will be displayed around the control's graphic shapes using the DownBorderColor, EqualBorderColor, UpBorderColor, BorderHighlight, and BorderShadow properties; when set to False none of those properties will be displayed.  In the case of the RSVessel control, when set to True, a three-dimensional border around the fill area will be displayed using the PolyBorderColor, BorderHighlight, and BorderShadow properties; when set to False none of those properties will be displayed.

Data Type	Integer


DisplayCaption Property

Applies To	RSButton, RSCompare, RSData, RSGauge, RSSlider, RSVessel, RSWheel

Description	Determines if the caption will be displayed on the control.

Custom	Adjusted in the General section of the custom property page. Place the mouse pointer inside the setup frame of the General Tab and right-click to display the  popup property menu. Clicking on "Caption" on this menu will toggle a check mark on and off which represents the True state for the DisplayCaption property. When the DisplayCaption is True, a red square caption position indicator appears on the control graphic in the General section.

Visual Basic	object.DisplayCaption[=setting %]

Remarks	When set to True the Caption will be displayed; when set to False the Caption will not be displayed.

Data Type	Integer


DisplayCaptionVertically Property

Applies To	RSButton, RSCompare, RSData, RSGauge, RSSlider, RSVessel, RSWheel

Description	Determines if the caption will be displayed vertically on the control.

Custom	Adjusted in the General section of the property page. The red indicator (square) on the control graphic represents the relative position of the caption on the control. Double clicking on the red indicator toggles the caption display between horizontal and vertical. When the caption is vertical the red indicator becomes a rectangle,  and when the caption is horizontal the red indicator is a square.

Visual Basic	obect.DisplayCaptionVertically[=setting]

Remarks	When set to True, the caption will be displayed vertically; when set to False, the caption will be displayed horizontally.

Data Type	Integer


DisplayPicture Property

Applies To	RSButton, RSCompare, RSData, RSGauge, RSSlider, RSVessel, RSWheel

Description	Determines if a picture will be displayed on the control.

Custom	Adjusted in the General section of the custom properties page with a checkbox in the Options window.

Visual Basic	object.DisplayPicture[=setting %]

Remarks	When set to True, the picture designated in the Picture property will be displayed; when set to False, the picture will not be displayed. Because the RSCompare control has three possible picture properties (PictureUp, PictureEqual, PictureDown), this property applies to all three.

Data Type	Integer


DisplayValue Property

Applies To	RSCompare, RSData, RSGauge, RSSlider, RSVessel, RSWheel

Description	Determines if the control's current value will be displayed.

Custom	Adjusted in the General section of the custom property page. Place the mouse pointer inside the setup frame of the General Tab and right-click to display the  popup property menu. Clicking on "Value" on this menu will toggle a check mark on and off which represents the True state for the DisplayValue property.

Visual Basic	object.DisplayValue[=setting %]

Remarks	When set to True, the value will be displayed; when set to False the value will not be 	displayed.

Data Type	Integer


DrawDisabledShadow Property

Applies To	RSButton, RSCompare, RSData, RSGauge, RSSlider, RSVessel, RSWheel

Description	Determines if a shadow will be displayed over the entire control when it is disabled.

Custom	Adjusted in the General section of the custom properties page with a checkbox in the Options window.

Visual Basic	object.DrawDisabledShadow[=setting  %]

Remarks	When set to True, a shadow will be displayed when the control's Enabled property is set to False.  When set to False, the shadow will not be displayed if the Enabled property is set to False. The shadow is not displayed if the control’s Enabled property is set to True.

Data Type	Integer


EndValue Property

Applies To	RSCompare, RSData, RSGauge, RSSlider, RSVessel, RSWheel

Description	Sets the maximum for the value range of the control.

Custom	Adjusted in the "End Value" text box in the Value section of the custom properties page.

Visual Basic	object.EndValue[=setting %]

Remarks	For the RSGauge and RSSlider controls, EndValue applies to both the Scale1 and Scale2 value ranges. For the RSCompare, RSData, and RSWheel controls, the EndValue will be ignored if the UseStartEndValue property is set to False.

Data Type	Double


ExpressionForRead Property

Applies To	RSButton, RSCompare, RSData, RSGauge, RSSlider, RSVessel, RSWheel

Description	Determines the mathematical expression that will be performed on the link item value when the control reads that value.

Custom	Adjusted in the LinkInfo section of the custom property page. When the "Expression" button is pressed another form appears with two input boxes. Input the appropriate mathematical expression into the "Read Expression" text box.  The expression must be in the form item[mathematical expression]. For example, "item+5" would add 5 to the LinkItem value.

Visual Basic	object.ExpressionForRead[=setting %]

Remarks	This property allows you to perform a mathematical function on the link item as it is read by the control. The expression must be in the form item[mathematical expression]. For example, "item+5" would add 5 to the LinkItem value.

Optional Calculation/Math module required, RSCALC32.DLL.

Data Type	String


ExpressionForWrite Property

Applies To	RSButton, RSCompare, RSData, RSGauge, RSSlider, RSVessel, RSWheel

Description	Determines the mathematical expression that will be performed on the link item when the control writes that value.

Custom	Adjusted in the LinkInfo section of the custom property page. When the "Expression" button is pressed another form appears with two input boxes. Input the appropriate mathematical expression into the "Write Expression" text box.  The expression must be in the form item[mathematical expression]. For example, "item+5" would add 5 to the LinkItem value.

Visual Basic	object.ExpressionForWrite[=setting %]

Remarks	This property allows you to perform a mathematical function on the link item as a write is performed by the control. The expression must be in the form item[mathematical expression].  For example, "item+5" would add 5 to the LinkItem value.

Optional Calculation/Math module required, RSCALC32.DLL.

Data Type	String


FaceBorderColor Property

Applies To	RSGauge, RSSlider, RSWheel

Description	Sets the color of the face border for the control.

Custom	Display section.

Visual Basic	object.FaceBorderColor[=color]

Remarks	The FaceBorderColor property can be set to any color in the palette or a hex integer value representing a color. The DisplayFace property must be True before this property will have any visible effect.

Data Type	Color


FaceColor Property

Applies To	RSGauge, RSSlider, RSWheel

Description	Sets the color of the face for the control.

Custom	Display section.

Visual Basic	object.FaceColor[=setting %]

Remarks	The FaceColor property can be set to any color in the palette or a hex integer value representing a color. The DisplayFace property must be True before this property will have any visible effect.

Data Type	Color


FillColor Property

Applies To	RSGauge, RSVessel

Description	Determines the color of the filled area on the control.

Custom	Display section.

Visual Basic	object.FillColor[=setting %]

Remarks	The FillColor property can be set to any color in the palette or a hex integer value representing a color. For the Gauge control this property is only used with the LED-style, Vertical and Horizontal Gauge types (4-7).

Data Type	Color


FlashEnabled Property

Applies To	RSButton, RSCompare, RSData, RSGauge, RSSlider, RSVessel, RSWheel

Description	Determines if the control will flash when its value changes.

Custom	Enabled / disabled in the Display section of the properties page with the "Flash on New Data" check box.

Visual Basic	object.FlashEnabled[=setting %]

Data Type	Integer


FlashOn Property

Applies To	RSButton, RSCompare, RSData, RSGauge, RSSlider, RSVessel, RSWheel

Description	Determines if the control will continuously flash from visible to invisible.

Custom	Enabled / disabled in the Display section of the properties page with the "Flash Always On" check box.

Visual Basic	object.FlashOn [ = setting %]

Remarks	When set to True the control flashes continuously; when set to False the control does not flash. The FlashSpeed property adjusts the rate that the control flashes on and off.

Data Type	Integer


FlashSpeed Property

Applies To	RSButton, RSCompare, RSData, RSGauge, RSSlider, RSVessel, RSWheel

Description	Determines the rate that the control flashes on and off.

Custom	Set on the Display section of the custom properties page with the "FlashSpeed" text box.

Visual Basic	object.FlashSpeed[=setting %]

Remarks	The setting for FlashSpeed is in milliseconds.

Data Type	Long


FlashTime Property

Applies To	RSButton, RSCompare, RSData, RSGauge, RSSlider, RSVessel, RSWheel

Description	Determines how long the control should flash when server sends new data and FlashEnabled is True.

Custom	Set on the Display section of the custom properties page with the "FlashTime" text box.

Visual Basic	object.FlashTime[=setting %]

Remarks	Enabled only when the "Flash On New Data" check box is checked. The setting for FlashTime is in milliseconds.

Data Type	Long


Font Property

Applies To	RSButton, RSCompare, RSData, RSGauge, RSSlider, RSVessel, RSWheel

Description	Determines the font name, style, and size of text that will be used for the control's caption and value.

Custom	Set on the Fonts section of the custom properties page.

Visual Basic	object.Font[=setting]

Remarks	Available effects on the Fonts section of the custom properties page are Strikeout and Underline. These can be enabled and disabled with check boxes on the Font section.

Data Type	Font


KnobWidth Property

Applies To	RSGauge, RSSlider

Description	Determines the width of the knob displayed on the control.

Custom	The knob width can be changed on the General section of the custom properties page by clicking the mouse on the knob graphic and drag-dropping the knob outline to the desired width.

Visual Basic	object.KnobWidth[=setting %]

Remarks	For the Gauge control, KnobWidth will have a visible effect only when the NeedleType property 	is set to a knob-type setting (3 = Knob; 4 = Knob-Plate; 5 = NeedleKnob; 6 = Needle-Knob-Plate). For the Slider, the KnobWidth property will affect both the button and pointed style knobs.

For the Gauge control, KnobWidth is represented as Diameter.

Data Type	Integer


LeftBorder Property

Applies To	RSButton, RSCompare, RSData, RSGauge, RSSlider, RSVessel, RSWheel

Description	Sets the distance between left external border of the control and left edge of the control.

Custom	Adjusted in the General section of the custom  properties page. Placing the mouse pointer over either of the control graphic's left corners will cause a sizing pointer to appear. Clicking and holding the left mouse button allows the bottom border for the control to be adjusted to the appropriate position with respect to the left external border of the control. Releasing the mouse button will then set the LeftBorder property.

Visual Basic	object.LeftBorder[=setting %]

Remarks	The LeftBorder property controls the distance between the outside border of the control and the left edge of the control. Use this property to adjust the space available for displaying a caption or value.

Data Type	Integer


LinkErrorDisplay Property

Applies To	RSButton, RSCompare, RSData, RSGauge, RSSlider, RSVessel, RSWheel

Description	Determines if an error message will be displayed in a control if an error has occurred when attempting to establish a DDE conversation with a LinkItem.

Custom	No access via custom property page.

Visual Basic	[Form1.]Control.LinkErrorDisplay[=setting %]

Remarks	When set to True, link error messages will be displayed; when set to False link error messages will not be displayed.

Data Type	Integer


LinkErrorNumber Property (Run Time Only)

Applies To	RSButton, RSCompare, RSData, RSGauge, RSSlider, RSVessel, RSWheel

Description	Returns the error number associated with its LinkItem.  Not available at design time and read only at run time.

Custom	No access via custom property page.

Visual Basic	[Form1.]Control.LinkErrorNumber

Remarks	Use the LinkErrorNumber property along with a label control to display the error number.  For example: Label1.caption = rsdata1.LinkErrorNumber.

Data Type	Integer


LinkErrorString Property (Run Time Only)

Applies To	RSButton, RSCompare, RSData, RSGauge, RSSlider, RSVessel, RSWheel

Description	Returns the error string associated with its LinkItem.  Not available at design time and read only at run time.

Custom	No access via custom property page.

Visual Basic	[Form1.]Control.LinkErrorString

Remarks	Use the LinkErrorString property along with a label control to display the error string.  For example: Label1.Caption = rsdata1.LinkErrorString.

Data Type	String


LinkItem Property

Applies To	RSButton, RSCompare, RSData, RSGauge, RSSlider, RSVessel, RSWheel

Description	Sets the item portion of the data link string to which the control is linked.

Custom	Adjusted in the LinkInfo section of the custom property page.

Visual Basic	object.LinkItem[=setting %]

Remarks	Depending upon which type of DDE link is being established, the LinkItem can have many different formats, for example: "N7:1" is an integer address from a PLC datatable; "T4:0.ACC,L10" is a DDE block array, with a length of 10 items; "B3/0" is a binary address from a PLC datatable; "T4:11.ACC" is a timer address from a PLC datatable; and "r1c1" or "R2C2" are row and column addresses from a Microsoft Excel table.

Data Type	String


LinkMode Property

Applies To	RSButton, RSCompare, RSData, RSGauge, RSSlider, RSVessel, RSWheel

Description	Sets the type of link to be used for a DDE conversation and activates the connection.

Custom	Adjusted in the LinkInfo section of the custom properties page.

Visual Basic	object.LinkMode[=setting %]

Remarks	Available options for the LinkMode property are:  0 = None; 1= Automatic; 2 = Manual; and 3 = Notify.

Data Type	Integer


LinkServer Property

Applies To	RSButton, RSCompare, RSData, RSGauge, RSSlider, RSVessel, RSWheel

Description	Determines the application or server name that the control is linked to.

Custom	Adjusted in the LinkInfo section of the custom properties page.

Visual Basic	object.LinkServer[=setting %]

Remarks	Depending upon which type of DDE link is being established, the LinkServer can have different formats, for example: "ICOMWDRV" is the DDE server name for WINtelligent Linx and "EXCEL" is the DDE server name for Microsoft Excel.

Data Type	String


LinkTip Property

Applies To	RSButton, RSCompare, RSData, RSGauge, RSSlider, RSVessel, RSWheel

Description	Determines if a pop up LinkTip will be displayed whenever the mouse pointer is positioned above the control. The message in the LinkTip will either be the address that the control is linked to or a message specified by the LinkTipText property.

Custom	Enabled / disabled in the Display section of the custom properties page with the "Link Tip" check box.

Visual Basic	object.LinkTip[=setting %]

Settings	Settings	Description

True	Displays LinkTip window.

False	Disables LinkTip window.

Remarks	When set to True, the LinkTip popup box will appear whenever the mouse pointer is positioned above the control; when set to False the LinkTip popup box will not appear. If there is not a string value entered for the LinkTipText property, the LinkTip popup message box will display the Link Server, Topic, and Item to which the control is connected.

Data Type	Integer


LinkTipBackColor Property

Applies To	RSButton, RSCompare, RSData, RSGauge, RSSlider, RSVessel, RSWheel

Description	Sets the background color of the LinkTip popup box.

Custom	Color is set in the Display section of the custom properties page by choosing LinkTipBackColor in the properties Combo Box and then selecting a color in the color Combo Box.

Visual Basic	object.LinkTipBackColor[=setting]

Remarks	The LinkTipBackColor property can be set to any color in the palette or a hex integer value representing a color.  The LinkTip property must be set to True before this property will have any visible effect.

Data Type	Color


LinkTipForeColor Property

Applies To	RSButton, RSCompare, RSData, RSGauge, RSSlider, RSVessel, RSWheel

Description	Determines the color of the LinkTip message text.

Custom	Color is set in the Display section of the custom properties page by choosing LinkTipForeColor in the properties Combo Box and then selecting a color in the color Combo Box.

Visual Basic	object.LinkTipForeColor[=setting %]

Remarks	The LinkTipForeColor property can be set to any color in the palette or a hex integer value representing a color. The LinkTip property must be True before this property will have any visible effect.

Data Type	Color


LinkTipText Property

Applies To	RSButton, RSCompare, RSData, RSGauge, RSSlider, RSVessel, RSWheel

Description	Displays a text string that will be displayed in the LinkTip popup box, or the symbol name of a DDE address or the actual DDE address (i.e. LinkServer. LinkTopic, LinkItem).

Custom	No access via custom property page.

Visual Basic	object.LinkTipText [=setting %]

Remarks	This property will only be effective when the LinkTip property is set to True.  The LinkTip window has an order of precedence as follows: If there is not any string value entered for this property, then the LinkTip popup window will display the Symbol name associated with the DDE address.  If a Symbol name is not used then the actual DDE address will be displayed (i.e. LinkServer, LinkTopic, and LinkItem) to which the control is connected.

Data Type	String


LinkTopic Property

Applies To	RSButton, RSCompare, RSData, RSGauge, RSSlider, RSVessel, RSWheel

Description	Determines the topic portion of a data link string to which the control is linked.

Custom	Adjusted in the LinkInfo section of the custom property page.

Visual Basic	object.LinkTopic[=setting %]

Remarks	Depending upon which type of DDE link is being established, the LinkTopic can have different.  Formats, for example: "testsol" would be a DDE topic created for the WINtelligent Linx driver and "sheet1.xls" would be a DDE topic name for Microsoft Excel.

Data Type	String


MoveRefresh Property

Applies To	RSGauge, RSSlider

Description	Determines if the Windows repaint commands called messages will be acted upon immediately upon mouse movement over the control or if the Windows system will decide when to send the messages and repaint the control.

Custom	No access via custom properties page.

Visual Basic	object.MoveRefresh[=setting %]

Remarks	When set to True the repaint messages will be acted upon immediately; when set to False the 	Windows system will decide the most appropriate time to send the message. On a fast machine there will probably not be a visible difference, therefore most users can set this property to False.

Data Type	Integer


NotFilledColor Property

Applies To	RSGauge, RSVessel

Description	Determines the color of the not-filled area on the control.

Custom	Display section.

Visual Basic	object.NotFilledColor[=setting %]

Remarks	The NotFilledColor property can be set to any color in the palette or a hex integer value representing a color. For the Gauge control this property is only used with the LED-style, Vertical and Horizontal Gauge types (4-7).

Data Type	Color


NumberOfDataValues Property (Run Time Only)

Applies To	RSButton, RSCompare, RSData, RSGauge, RSSlider, RSVessel, RSWheel

Description	Returns the total number of individual data values represented by the control. Not available at design time. Read only at run time.

Visual Basic	object.NumberOfDataValues

Data Type	Integer


NumberOfSegments Property

Applies To	RSCompare, RSVessel

Description	Sets the number of line segments to be drawn between the green bezier nodes in the control shape.  (Green bezier nodes are visible on the custom properties page.)  The higher the number of segments, the more round the control’s shape will appear.

Custom	Segments text box on General page.

Visual Basic	object.NumberOfSegments[=setting %]

Data Type	Integer


NumbersColor Property

Applies To	RSVessel, RSWheel

Description	Sets the color of the Start and End values within the control’s display area.  This only applies when the DisplayStartEndValues property is set to True.

Custom	Display Section

Visual Basic	object.NumbersColor[=setting%]


Data TypeColor


Picture Property

Applies To	RSButton, RSCompare, RSData, RSGauge, RSSlider, RSVessel, RSWheel

Description	Any file of the *.bmp,*.wmf, *.ico format may be displayed on the control by defining the picture file.

Custom	Display Section.

Visual Basic	object.Picture[=filename]

Remarks	Bitmaps, Windows metafiles, and icon files may be used as pictures for the control. The RSTools controls also support drag and drop of pictures from the optional RSWorkbench Visual Basic Add-In.

Data Type	String


PictureStretch Property

Applies To	RSButton, RSCompare, RSData, RSGauge, RSSlider, RSVessel, RSWheel

Description	Stretches the picture to fit the control boundaries.

Custom	Check box in General Tab.

Visual Basic	object.PictureStrech[=setting %]

Remarks	True streches the Picture. False lets the picture be displayed in its original size.

Data Type	Integer


PictureUp Property

Applies To	RSButton, RSCompare

Description	Sets the filename of a picture to be displayed within the control when the control is not depressed.  (Or in the case of the RSCompare control, when the control is in its Up state.)

Custom	Display section.

Visual Basic	object.PictureUp[=file]

Remarks	Picture files of the format *.bmp, *.wmf,  and *.ico may be used.  The RSCompare has several other picture properties including PictureUp; PictureDown, PictureEqual and Picture.  Refer to the RSCompare documentation for information on these properties.

Data Type	String


PokeLength Property

Applies To	RSButton, RSCompare, RSData, RSGauge, RSSlider, RSVessel, RSWheel

Description	Defines the number of controls in a control array to be used in a LinkPoke starting from  the PokeStartIndex in a control array.

Custom	No access via custom property page.

Visual Basic	object.PokeLength[=setting%]

Remarks	The number of controls to be used in single message transaction if AdvanceDDE is used.

Data Type	Integer


PokeStartIndex Property

Applies To	RSButton, RSCompare, RSData, RSGauge, RSSlider, RSVessel, RSWheel

Description	Sets the starting index value of the controls in a control array to be used in a poke to the DDE server (source).

Custom	No access via custom property page.

Visual Basic	object.PokeStartIndex[=setting%]

Data Type	Integer


RequestLength Property

Applies To	RSButton, RSCompare, RSData, RSGauge, RSSlider, RSVessel, RSWheel

Description	Defines the number of controls in a control array for a LinkRequest from the DDE server (source).

Custom	N/A on the Custom properties page

Visual Basic	object.RequestLength[=setting%]

Remarks	This property applies if the control is part of an array.

Data Type	Integer


RequestStartIndex Property

Applies To	RSButton, RSCompare, RSData, RSGauge, RSSlider, RSVessel, RSWheel

Description	Sets the starting index value of the controls in a control array to be used in a request from the DDE server (source).

Visual Basic	object.RequestStartIndex[=setting%]

Data Type	Integer


ReverseDirection Property

Applies To	RSGauge, RSSlider, RSWheel

Description	This property reverses the start and end values.

Custom	General section.

Visual Basic	object.ReverseDirection[=setting%]

Remarks	Setting to False uses the defined start and end values. Setting to True reverses the start and end values.

Data Type	Integer


RightBorder Property

Applies To	RSButton, RSCompare, RSData, RSGauge, RSSlider, RSVessel, RSWheel

Description	Sets the distance between right external border of the control and right edge of the control.

Custom	Adjusted in the General section of the custom  properties page. Placing the mouse pointer over either of the control graphic's right corners will cause a sizing pointer to appear. Clicking and holding the left mouse button allows the bottom border for the control to be adjusted to the appropriate position with respect to the right external border of the control. Releasing the mouse button will then set the RightBorder property.

Visual Basic	object.RightBorder[=setting %]

Remarks	The RightBorder property controls the distance between the outside border of the control and the left edge of the control. Use this property to adjust the space available for displaying a caption or value.

Data Type	Integer


Scale1DecimalPlaces Property

Applies To	RSGauge, RSSlider

Description	Sets or returns the number of decimal places used for the Scale 1 numerals.

Custom	Key in or Use the spin buttons next to ‘Decimal’ on the Scale Tab.

Visual Basic	object.Scale1DecimalPlaces[=setting%]

Data Type	Integer


Scale1End Property

Applies To	RSGauge, RSSlider

Description	Sets or returns the End position and value of the Scale 1 markings.

Custom	Key in or click on the # sign to bring up the key pad on ‘Place Scale1 @’ settings box on the  Scale Tab.

Visual Basic	object.Scale1End[=setting %]

Data Type	Double


Scale1Length Property

Applies To	RSSlider, RSGauge

Description	Determines the physical length of the markings for Scale 1.

Custom	General Section. Can be edited directly on the picture.

Visual Basic	object.Scale1Length[=setting %]

Data Type	Integer


Scale1Major Property

Applies To	RSSlider, RSGauge

Description	Sets the number of  major scale divisions for Scale 1.

Custom	Key in or Use the spin buttons next to ‘Major’ on the Scale Tab.

Visual Basic	object.Scale1Major[=setting %]

Data Type	Integer


Scale1MajorColor Property

Applies To	RSSlider, RSGauge

Description	Sets the major scale color of Scale 1.

Custom	Display section.

Visual Basic	object.Scale1MajorColor[=setting%]

Data Type	Color


Scale1Minor Property

Applies To	RSGauge, RSSlider

Description	Sets the number of minor scale divisions for Scale 1.

Custom	Key in or Use the spin buttons next to ‘Minor’ on the Scale Tab.

Visual Basic	object.Scale1Minor[=setting%]

Data Type	Integer


Scale1MinorColor Property

Applies To	RSGauge, RSSlider

Description	Sets the minor scale mark color of Scale 1.

Custom	Display section.

Visual Basic	object.Scale1MinorColor[=setting %]

Data Type	Color


Scale1NumbersVisible Property

Applies To	RSGauge, RSSlider

Description	Determines whether or not Scale 1 numbers are visible.

Custom	Check Box on the Scale Tab.

Visual Basic	object.Scale1NumberVisible[=setting %]

Remarks	True makes the numbers visible. False hides the numbers.

Data Type	Integer


Scale1Offset Property

Applies To	RSGauge, RSSlider

Description	Defines the offset of the Scale 1 markings from the inside border.

Custom	Double Click on the # mark next to scale in the Setup Area on the General Tab.

Visual Basic	object.Scale1Offset[=setting %]

Data Type	Integer


Scale1Start Property

Applies To	RSGauge, RSSlider

Description	Determines the Start position and value of the Scale 1 markings on the control.

Custom	Key in or click on the # sign to bring up the key pad on ‘Place Scale1 @’ settings box on the  Scale Tab.

Visual Basic	object.Scale1Start[=setting %]

Data Type	Double


Scale1String Property

Applies To	RSSlider, RSGauge

Description	Determines the String Caption to be displayed next to Scale 1.

Custom	Not Available on Custom Property Pages.

Visual Basic	object.Scale1String [=setting%]

Data Type	String


Scale1StringEnabled Property

Applies To	RSSlider, RSGauge

Description	Enables / Disables the display of String caption next to Scale 1.

Custom	Not Available on Custom Property Pages.

Visual Basic	object.Scale1StringEnabled[=setting %]

Data Type	Integer


Scale1Style Property

Applies To	RSGauge, RSSlider

Description	Defines the position of the Scale 1 numbers on the control.

Custom	Drop down combo box on the Scale Tab.

Visual Basic	object.Scale1Style[=setting %]

Remarks	Valid styles are 0=Next Scale, 1=Inside Border and 2=Outside Border

Data Type	enumScaleStyles


Scale1TextColor Property

Applies To	RSGauge, RSSlider

Description	Defines the text color for Scale 1.

Custom	Display Section

Visual Basic	object.Scale1TextColor[=setting %]

Remarks	Color can be chosen form the color palette or specified as RGB in Hex.

Data Type	Color


Scale1TrailingZeros Property

Applies To	RSGauge, RSSlider

Description	Defines the number of trailing zeros for Scale 1.

Custom	Check Box on the Scale Tab.

Visual Basic	object.Scale1TrailingZeros[=setting %]

Data Type	Integer


Scale1Type Property

Applies To	RSGauge, RSSlider

Description	Specifies the Scale 1 marking type.

Custom	Drop down combo box on the Scale Tab.

Visual Basic	object.Scale1Type[=setting %]

Remarks	Valid style are  0=Normal, 1=Indented and  2=Bevel

Data Type	Integer


Scale1Visible Property

Applies To	RSGauge, RSSlider

Description	Specifies if Scale 1 is visible or hidden.

Custom	Check Box on the Scale Tab.

Visual Basic	object.Scale1Visible[=setting %]

Data Type	Integer


Scale1Width Property

Applies To	RSGauge, RSSlider

Description	Sets the width of the Scale 1 markings.

Custom	Edit directly on the setup area of the General custom properties tab.

Visual Basic	object..Scale1Width[=setting%]

Data Type	Integer


Scale2DecimalPlaces Property

Applies To	RSGauge, RSSlider

Description	Sets or specifies the number of decimal places used for the Scale 2 numerals.

Custom	Key in or Use the spin buttons next to ‘Decimal’ on the Scale Tab.

Visual Basic	object.Scale2DecimalPlaces[=setting %]

Data Type	Integer


Scale2End Property

Applies To	RSGauge, RSSlider

Description	Sets or returns the End position and value of the Scale 2 markings on the control.

Custom	Key in or click on the # sign to bring up the key pad on ‘Place Scale1 @’ settings box on the  Scale Tab.

Visual Basic	object.Scale2End[=setting %]

Data Type	Double


Scale2EndNumber Property

Applies To	RSGauge, RSSlider

Description	Sets or returns the end number value of the numerals on Scale 2.

Custom	Key in or Use the spin buttons next to ‘Scale 2 Numbering’ on the Scale Tab.

Visual Basic	object.Scale2EndNumber[=setting %]

Remarks	The Scale2End  property value is the physical location of the end scale marking with respect to Scale1; Scale2EndNumber represents the text (number) that will be displayed at that end marking.

Data Type	Double


Scale2Length Property

Applies To	RSGauge, RSSlider.

Description	Sets the length of the Scale 2 markings.

Custom	General section. Edit directly on the setup area.

Visual Basic	object.Scale2Length[=setting %]

Data Type	Integer


Scale2Major Property

Applies To	RSGauge, RSSlider

Custom	Key in or Use the spin buttons next to ‘Major’ on the Scale Tab.

Description	Sets the number of major scale divisions for Scale 2.

Visual Basic	object.Scale2Major[=setting %]

Data Type	Integer


Scale2MajorColor Property

Applies To	RSGauge, RSSlider

Description	Sets the major scale color for Scale 2.

Custom	Display section.

Visual Basic	object.Scale2MajorColor[=setting %]

Data Type	Color


Scale2Minor Property

Applies To	RSGauge, RSSlider

Description	Sets the number of scale divisions for the minor scale of Scale 2.

Custom	Key in or Use the spin buttons next to ‘Minor’ on the Scale Tab.

Visual Basic	object.Scale2Minor[=setting %]

Data Type	Integer


Scale2MinorColor Property

Applies To	RSGauge, RSSlider

Description	Sets Scale 2 minor scale color.

Custom	Display section.

Visual Basic	object.Scale2MinorColor[=setting %]

Data Type	Color


Scale2NumbersVisible Property

Applies To	RSGauge, RSSlider

Description	Determines whether Scale 2 numbers are visible or not.

Custom	Check Box on the Scale Tab.

Visual Basic	object.Scale2NumbersVisible[=setting %]

Remarks	True sets the numbers to be visible. False hides the numbers.

Data Type	Integer


Scale2Offset Property

Applies To	RSGauge, RSSlider

Description	Defines the offset of Scale 2 markings from the outside border.

Custom	No access via custom property page.

Visual Basic	object.Scale2Offset[=setting %]

Data Type	Integer


Scale2Start Property

Applies To	RSGauge, RSSlider

Description	Sets or returns the Start position and value of the Scale 2 markings on the control.

Custom	Key in or click on the # sign to bring up the key pad on ‘Place Scale2 @’ settings box on the  Scale Tab.

Visual Basic	object.Scale2Start[=setting %]

Data Type	Double


Scale2StartNumber Property

Applies To	RSGauge, RSSlider

Description	Sets or returns the Scale 2 start number value of the scale numerals.

Custom	Key in or Use the spin buttons next to ‘Scale 2 Numbering’ on the Scale Tab.

Remarks	The Scale2Start property value is the physical location of the start scale marking with respect to Scale1; Scale2StartNumber represents the text (number) that will be displayed at that start marking.

Visual Basic	object.Scale2StartNumber[=setting %]

Data Type	Double


Scale2String Property

Applies To	RSSlider, RSGauge

Description	Determines the String Caption to be displayed next to Scale 1.

Custom	No access via custom property page.

Visual Basic	object.Scale1String [=setting%%]

Data Type	String


Scale2StringEnabled Property

Applies To	RSSlider, RSGauge

Description	Enables / Disables the display of String caption next to Scale 1.

Custom	No access via custom property page.

Visual Basic	object.Scale1StringEnabled[=setting %]

Data Type	Integer


Scale2Style Property

Applies To	RSGauge, RSSlider

Description	Defines the position of the Scale 2 numbers on the control.

Custom	Drop down combo box on the Scale Tab.

Visual Basic	object.Scale2Style[=setting %]

Remarks	Valid styles are 0=Next Scale, 1=Inside Border and 2=Outside Border.

Data Type	Integer


Scale2TextColor Property

Applies To	RSGauge, RSSlider

Description	Define the text color for Scale 2.

Custom	Display section.

Visual Basic	object.Scale2TextColor[=setting %]

Data Type	Color


Scale2TrailingZeros Property

Applies To	RSGauge, RSSlider

Description	Sets the number of trailing zeros for Scale 2.

Custom	Check Box on the Scale Tab.

Visual Basic	object.Scale2TrailingZeros[=setting %]

Data Type	Integer


Scale2Type Property

Applies To	RSGauge, RSSlider

Description	Specifies the scale marking type for Scale 2.

Custom	Drop down combo box on the Scale Tab.

Visual Basic	object.Scale2Type[=setting %]

Remarks	Valid types are  0=Normal, 1=Indented and 2=Bevel

Data Type	Integer


Scale2Visible Property

Applies To	RSGauge, RSSlider

Description	Decides whether Scale 2 is visible or hidden.

Custom	Check Box on the Scale Tab.

Visual Basic	object.Scale2Visible[=setting %]

Remarks	True makes the scale visible. False hides it.

Data Type	Integer


Scale2Width Property

Applies To	RSGauge, RSSlider

Description	Sets the width of the scale markings for Scale 2.

Custom	General Section.  Edit the picture directly in the setup area.

Visual Basic	object.Scale2Width[=setting %]

Data Type	Integer


ScaleBorderColor Property

Applies To	RSGauge, RSSlider

Description	Sets the scale marking border color.

Custom	Display section.

Visual Basic	object.ScaleBorderColor[=setting %]

Remarks	This property is active with a Scale Type of 1. Color can be chosen from the color palette or specified in RGB format.

Data Type	Color


ScaleHighlight Property

Applies To	RSGauge, RSSlider

Description	Set the scale marking highlight color.

Custom	Display section.

Visual Basic	object.ScaleHighlight[=setting %]

Remarks	This property is active with a Scale Type of 2. Color can be chosen from the color palette or specified in RGB format.

Data Type	Color


ScaleShadow Property

Applies To	RSGauge, RSSlider

Description	Displays a shadow of the scale.

Custom	Check Box in the General section.

Visual Basic	object.ScaleShadow[=setting %]

Remarks	This property is active when the Scale Type = 2. True displays the Shadow and False disables Shadow display.

Data Type	Color


ScreenPriority Property

Applies To	RSButton, RSCompare, RSData, RSGauge, RSSlider, RSVessel, RSWheel

Description	Determines if the Windows dispatch commands called messages will be acted upon immediately or the Windows system will decide when to send the messages.

Visual Basic	object.ScreenPriority[=setting %]

Remarks	When set to True the messages will be acted on immediately.  When set to False the Windows system decides the most appropriate time to send the message.

Data Type	Integer


Shadow Property

Applies To	RSCompare, RSGauge, RSSlider, RSVessel

Description	Specifies if the control’s knob or graphic shadow is visible or hidden.

Custom	Check box in General section.

Visual Basic	object.Shadow[=setting %]

Remarks	True sets the shadow visible. False hides the shadow.

Data Type	Integer


ShadowOffsetX Property

Applies To	RSCompare, RSGauge, RSSlider, RSVessel

Description	Sets the horizontal offset of the control's knob or graphic shadow.

Custom	General section.  Edit the picture directly in the setup area.

Visual Basic	object.ShadowOffsetX[=setting %]

Data Type	Integer


ShadowOffsetY Property

Applies To	RSCompare, RSGauge, RSSlider, RSVessel

Description	Sets the vertical offset of the control's  knob or graphic shadow.

Custom	General section. Edit the picture directly in the setup area.

Visual Basic	object.ShadowOffsetY[=setting %]

Data Type	Integer


StartValue Property

Applies To	RSCompare, RSData, RSGauge, RSSlider, RSVessel, RSWheel

Description	Specifies the starting value for the control.

Custom	Adjusted in the “Start Value” text box in the Value section of the custom properties page.

Visual Basic	object.StartValue[=setting %]

Remarks	For the RSGauge and RSSlider controls, StartValue applies to both the Scale1 and Scale2 value ranges. For the RSCompare, RSData, and RSWheel controls, the StartValue will be ignored if the UseStartEndValue property is set to False.

Data Type	Double


Symbol Property

Applies To	RSButton, RSCompare, RSData, RSGauge, RSSlider, RSVessel, RSWheel

Description	Serves as an alias name for the server, topic and item to be used in a  DDE link.

Custom	LinkInfo Section.

Visual Basic	object.Symbol[=setting %]

Remarks	To establish a symbol go to the LinkInfo tab on the control's custom property page.  Select manage symbols and enter the symbol name, server, topic and item.  After applying this data to the control, enter the Symbol name on the property sheet.  The Linkserver, LinkTopic and LinkItem properties will be updated according to the symbol name entered.

See also:  LinkTip property.

Data Type	String


TabIndex Property

Applies To	RSCompare, RSData, RSGauge, RSSlider, RSVessel, RSWheel

Description	Sets the tab index for the control.

Custom	No access via custom property page.

Visual Basic	object.TabIndex[=setting %]

Remarks	TabIndex is always one less than the total number of controls.

Data Type	Integer


TabStop Property

Applies To	RSCompare, RSData, RSGauge, RSSlider, RSVessel, RSWheel

Description	Adds or removes the control from the form's Tab order at run time.

Custom	No access via custom property page.

Visual Basic	object.TabStop[=setting %]

Remarks	Setting to True adds the control to the form's tab order. False removes the control from the tab order.

Data Type	Integer


Tag Property

Applies To	RSButton, RSCompare, RSData, RSGauge, RSSlider, RSVessel, RSWheel

Description	Sets or returns an expression that stores any extra data needed in the application.

Custom	No access via custom property page.

Visual Basic	object.Tag[=setting %]

Remarks	This is a user defined property that does not affect other VB properties.

Data Type	String


Top Property

Applies To	RSButton, RSCompare, RSData, RSGauge, RSSlider, RSVessel, RSWheel

Description	Determines the distance between the top edge of a control and the top edge of its container.

Custom	No access via custom property page.

Visual Basic	object.Top[=setting %]

Data Type	Single


TopBorder Property

Applies To	RSButton, RSCompare, RSData, RSGauge, RSSlider, RSVessel, RSWheel

Description	Determines the distance between the top external border of the control and the top of the control.

Custom	Adjusted in the General section of the custom properties page. Placing the mouse pointer over either of the control graphic's lower corners will cause a sizing pointer to appear. Clicking and holding the left mouse button allows the top border for the control to be adjusted to the appropriate position with respect to the top external border of the control. Releasing the mouse button will then set the TopBorder property.

Visual Basic	object.TopBorder[=setting %]

Data Type	Integer


TrailingZeros Property

Applies To	RSCompare, RSData, RSGauge, RSSlider, RSVessel

Description	Determines if the value is displayed with trailing insignificant zeros.

Custom	Check box in General section.

Visual Basic	object.TrailingZeros[=setting %]

Remarks	True displays the value with trailing zeros. False displays the value without trailing zeros.

Data Type	Integer


UseInPoke Property

Applies To	RSButton, RSCompare, RSData, RSGauge, RSSlider, RSVessel, RSWheel

Description	A flag to signify that the control should be used in a LinkPoke or DoPoke.

Custom	No access via custom property page.

Visual Basic	object.UseInPoke[=setting %]

Remarks	True sets the control to be used in a poke. False sets the control not to be used.  This property may be set for each element of a control array, which allows individual controls to be “skipped” in a block write action.

Data Type	Integer


UseInRequest Property

Applies To	RSButton, RSCompare, RSData, RSGauge, RSSlider, RSVessel, RSWheel

Description	A flag to signify that the control should be used in a LinkRequest or DoRequest.

Custom	No access via custom property page.

Visual Basic	object.UseInRequest[=setting %]

Remarks	True sets the control to be used in a request. False sets the control not to be used.  This property may be set for each element of a control array, which allows individual controls to be “skipped” in a block read action.

Data Type	Integer


UseStartEndValue Property

Applies To	RSCompare,  RSData,  RSWheel

Description	Enables / disables use of a minimum and maximum value range for the applicable controls, with the minimum and maximum being the values of the StartValue and EndValue properties.

Custom	Adjusted in the General section of the custom properties page with a checkbox in the Options window.

Visual Basic	object.UseStartEndValue[=setting %]

Remarks	When set to True, the control will not allow its Value to fall outside of the StartValue to EndValue range. When set to False, the control will allow Values outside of that range.

Data Type	Integer


Value Property

Applies To	RSButton, RSCompare, RSData, RSGauge, RSSlider, RSVessel, RSWheel

Description	Contains the value of the control at runtime.

Custom	Value section.

Visual Basic	object.Value[=setting %]

Remarks	Since the RSTools controls are capable of displaying multiple LinkItem addresses with an array of controls, you can preview an array of controls at design time with the Value property by setting the Value to a comma-separated string of values. For instance, a Value setting of  “0,1,2,3,4”  will display an array of 5 controls within the one instance of the RSTools control, each with the corresponding Value displayed.

See also: Clip property.

Data Type	String


ValueBackColor Property

Applies To	RSCompare, RSData, RSGauge, RSSlider, RSVessel, RSWheel

Description	Sets the back color for the control's value.

Custom	Display section.

Visual Basic	object.ValueBackColor[=setting %]

Remarks	Is visible only if the VALUE is set to transparent.

Data Type	Color


ValueColor Property

Applies To	RSCompare, RSData, RSGauge, RSSlider, RSVessel, RSWheel

Description	Sets the foreground color of the control's value.

Custom	Display section.

Visual Basic	object.ValueColor[=setting %]

Data Type	Color


ValuePadDownLoad Property

Applies To	RSCompare, RSData, RSVessel

Description	Enables / disables the number entry pad from being activated when the control is clicked on at run time.

Custom	Check box in the General section.

Visual Basic	object.ValuePadDownLoad[=setting %]

Data Type	Integer


ValueShadow Property

Applies To	RSCompare, RSData, RSGauge, RSSlider, RSVessel, RSWheel

Description	Turns On/Off the value shadow.

Custom	Check box in General section.

Visual Basic	object.ValueShadow[=setting %]

Remarks	True displays the shadow and False hides it.

Data Type	Integer


ValueShadowColor Property

Applies To	RSCompare, RSData, RSGauge, RSSlider, RSVessel, RSWheel

Description	Determines the color of the value's shadow.

Custom	Display section.

Visual Basic	object.ValueShadowColor[=setting %]

Data Type	Color


ValueTransparent Property

Applies To	RSCompare, RSData, RSGauge, RSSlider, RSVessel, RSWheel

Description	Determines if the value background is transparent or opaque.

Custom	Check box in General section.

Visual Basic	object.ValueTransparent[=setting %]

Remarks	True sets it to transparent. False sets it to opaque.

Data Type	Integer


ValueX Property

Applies To	RSCompare, RSData, RSGauge, RSSlider, RSVessel, RSWheel

Description	Sets the horizontal position of the Value display within the control.

Custom	General section.  Edit the picture directly.

Visual Basic	object.ValueX[=setting %]

Remarks	The position can be set from 0 to 100.  The CenterOnKnob property  of the RSSlider should be False to display the value somewhere other than the knob.

Data Type	Integer


ValueY Property

Applies To	RSCompare, RSData, RSGauge, RSSlider, RSVessel, RSWheel

Description	Sets the vertical position of the Value display within the control.

Custom	General section.  Edit the picture directly.

Visual Basic	object.ValueY[=setting %]

Remarks	The position can be set from 0 to 100.  The CenterOnKnob property for the RSSlider should be False to display the value somewhere other than the knob.

Data Type	Integer


Visible Property

Applies To	RSButton, RSCompare, RSData, RSGauge, RSSlider, RSVessel, RSWheel

Description	Determines if the control is visible at run-time.

Visual Basic	object.Visible[=setting %]

Remarks	True sets the control to be visible and False hides it.

Data Type	Integer


WhatsThisHelpID Property

Applies To	RSButton, RSCompare, RSData, RSGauge, RSSlider, RSVessel, RSWheel

Description	Sets or returns the associated WhatsThisHelp context number.

Visual Basic	object.WhatsThisHelpID[=number]

Remarks	These context numbers are associated with Windows help files.

Data Type	Long


Width Property

Applies To	RSButton, RSCompare, RSData, RSGauge, RSSlider, RSVessel, RSWheel

Description	Sets or returns the width of the control.

Custom	General section.  Edit the picture directly.

Visual Basic	object.Width[=setting %]

Data Type	Single


WriteStyle Property

Applies To	RSButton, RSGauge, RSSlider, RSWheel

Description	Sets the write style to the DDE server.

Custom	Value section.

Visual Basic	object.WriteStyle[=setting %]

Remarks	Options are: 0 - ReadOnly; 1- Continous,  2- Release.

Data Type	Integer


WriteValue Property

Applies To	RSCompare, RSData, RSGauge, RSSlider, RSVessel, RSWheel

Description	Determines if the value will be downloaded to a database or LinkItem.

Custom	The WriteValue is used when a person programmatically changes a value.

Visual Basic	object.WriteValue[=setting %]

Data Type	Integer


Click Event

Applies To	RSCompare, RSData, RSGauge, RSSlider, RSVessel, RSWheel

Description	Occurs when the user presses and then releases a mouse button over an object.

Visual Basic	Private Sub object_Click([index As Integer])

Remarks	Typically, you attach a Click event procedure to a CommandButton control, Menu object, or PictureBox control to carry out commands and command-like actions.  For the other applicable controls, use this event to trigger actions in response to a change in the control.

For additional information, refer to the description of the Click event in the Microsoft Visual Basic Language Reference Manual.


DblClick Event

Applies To	RSButton, RSCompare, RSData, RSGauge, RSSlider, RSVessel, RSWheel

Description	Occurs when the user presses and releases a mouse button and then presses and releases it again over an object.

Visual Basic	Private Sub object_DblClick (index As Integer)

Remarks	The argument Index uniquely identifies a control if it's in a control array.  You can use a DblClick event procedure for an implied action, such as double-clicking an icon to open a window or document.

For additional information, refer to the description of the DblClick event in the Microsoft Visual Basic Language Reference Manual.


DragDrop Event

Applies To	RSButton, RSCompare, RSData, RSGauge, RSSlider, RSVessel, RSWheel

Description	Occurs when a drag-and-drop operation is completed as a result of dragging a control over a form or control and releasing the mouse button or using the Drag method with its action argument set to 2 (Drop).

Visual Basic	Private Sub object_DragDrop([index As Integer,]source As Control, x As Single, y As Single)

Remarks	Use a DragDrop event procedure to control what happens after a drag operation is completed.

For additional information, refer to the description of the DragDrop event in the Microsoft Visual Basic Language Reference Manual.


DragOver Event

Applies To	RSButton, RSCompare, RSData, RSGauge, RSSlider, RSVessel, RSWheel

Description	Occurs when a drag-and-drop operation is in progress.  You can use this event to monitor the mouse pointer as it enters, leaves, or rests directly over a valid target.  The mouse pointer position determines the target object that receives this event.

Visual Basic	Private Sub object_DragOver([index As Integer,]source As Control, x As Single, y As Single, state As Integer)

Remarks	Use a DragOver event procedure to determine what happens after dragging is initiated and before a control drops onto a target.

For additional information, refer to the description of the DragOver event in the Microsoft Visual Basic Language Reference Manual.


GotFocus Event

Applies To	RSButton, RSCompare, RSData, RSGauge, RSSlider, RSVessel, RSWheel

Description	Occurs when an object receives the focus, either by user action, such as tabbing to or clicking the object, or by changing the focus in code using the SetFocus method.

Visual Basic	Private Sub object_GotFocus([index As Integer])

Remarks	Typically, you use a GotFocus event procedure to specify the actions that occur when a control or form first receives the focus.

For additional information, refer to the description of the GotFocus event in the Microsoft Visual Basic Language Reference Manual.


KeyDown, KeyUp Events

Applies To	RSButton, RSCompare, RSData, RSGauge, RSSlider, RSVessel, RSWheel

Description	Occur when the user presses (KeyDown) or releases (KeyUp) a key while an object has the focus.

Visual Basic	Private Sub object_KeyDown([index As Integer,]keycode As Integer, shift As Integer)

Private Sub object_KeyUp([index As Integer,]keycode As Integer, shift As Integer)

Remarks	For both events, the object with the focus receives all keystrokes.  For additional information, refer to the description of the KeyDown,KeyUp events in the Microsoft Visual Basic Language Reference Manual.


KeyPress Event

Applies To	RSButton, RSCompare, RSData, RSGauge, RSSlider, RSVessel, RSWheel

Description	Occurs when the user presses and releases an ANSI key.

Visual Basic	Private Sub object_KeyPress([index As Integer,]keyascii As Integer)

Remarks	The object with the focus receives the event.  For additional information, refer to the description of the KeyPress event in the Microsoft Visual Basic Language Reference Manual.


LostFocus Event

Applies To	RSButton, RSCompare, RSData, RSGauge, RSSlider, RSVessel, RSWheel

Description	Occurs when an object loses the focus, either by user action, such as tabbing to or clicking another object, or by changing the focus in code using the SetFocus method.

Visual Basic	Private Sub object_LostFocus([index As Integer])

Remarks	A LostFocus event procedure is primarily useful for verification and validation updates.  Using LostFocus can cause validation to take place as the user moves the focus from the control.  For additional information, refer to the description of the Click event in the Microsoft Visual Basic Language Reference Manual.


MouseDown, MouseUp  Events

Applies To	RSButton, RSCompare, RSData, RSGauge, RSSlider, RSVessel, RSWheel

Description	Occur when the user presses (MouseDown) or releases (MouseUp) a mouse button.

Visual Basic	Private Sub object _MouseDown([index As Integer,]button As Integer, shift As Integer, x As Single, y As Single)

Private Sub object _MouseUp([index As Integer,]button As Integer, shift As Integer, x As Single, y As Single)

Remarks	Use a MouseDown or MouseUp event procedure to specify actions that will occur when a given mouse button is pressed or released.  For additional information, refer to the description of the MouseDown, MouseUp events in the Microsoft Visual Basic Language Reference Manual.


MouseMove Event

Applies To	RSButton, RSCompare, RSData, RSGauge, RSSlider, RSVessel, RSWheel

Description	Occurs when the user moves the mouse.

Visual Basic	Private Sub object _MouseMove([index As Integer,]button As Integer, shift As Integer, x As Single, y As Single)

Remarks	The MouseMove event is generated continually as the mouse pointer moves across objects.  For additional information, refer to the description of the MouseMove event in the Microsoft Visual Basic Language Reference Manual.


Container Method

Applies To	RSButton, RSCompare, RSData, EventMaster, RSGauge, RSSlider, RSWheel

Description	Returns or sets the container of a control.

Visual Basic	object.Control.Container[=setting]

Remarks	Not available at design time.  A control's parent (container) may be changed at run time with the Container method.


DoPoke Method

Applies To	RSButton, RSCompare, RSData, RSGauge, RSSlider, RSWheel, RSVessel

Description	Writes the values of all controls in an array to the server in a DDE conversation.  To work successfully the control's UseInPoke property must be set to True.

Visual Basic	object.Control.DoPoke

Remarks	The control’s LinkMode property must be set to 2 - Manual.

See also: PokeStartIndex and PokeLength properties, LinkPoke method.


DoRequest Method

Applies To	RSButton, RSCompare, RSData, RSGauge, RSSlider, RSWheel, RSVessel

Description	Requests the source application in a DDE conversation to update an array of control values.  LinkMode should be set to either None(0) or Manual(2).  To work successfully, the control's UseInRequest property must be set to True.

Visual Basic	object.Control.DoRequest

Remarks	The control’s LinkMode property must be set to 2 - Manual.

See also: RequestStartIndex and RequestLength properties, LinkRequest Method.


Drag Method

Applies To	RSButton, RSCompare, RSData, RSGauge, RSSlider, RSWheel, RSVessel

Description	Begins, ends, or cancels a drag operation of any control except the Line, Menu, Shape, Timer, or CommonDialog controls.

Visual Basic	object.Drag action

Settings	The settings for action are:

Constant	          Value	Description

vbCancel	0	Cancels drag operation.

vbBeginDrag	1	Begins dragging object.

vbEndDrag	2	Ends dragging and drop object.

Remarks	Using the Drag method to control a drag-and-drop operation is required only when the DragMode property of the object is set to Manual (0).  However, you can use Drag on an object whose DragMode property is set to Automatic (1 or vbAutomatic).

For more information refer to the Microsoft Visual Basic Language Reference.


LinkPoke Method

Applies To	RSButton, RSCompare, RSData, RSGauge, RSSlider, RSWheel, RSVessel

Description	Transfers the value of a control to the source application in a DDE conversation.  To work successfully the control's UseInPoke property must be set to True.

Visual Basic	object.LinkPoke

Remarks	Typically, information in a DDE conversation flows from source to destination.  However, LinkPoke allows a destination object to supply RSData to the source.

See also: PokeStartIndex and PokeLength properties, DoPoke method.


LinkRequest Method

Applies To	RSButton, RSCompare, RSData, RSGauge, RSSlider, RSWheel, RSVessel

Description	Requests the source application in a DDE conversation to update the value of the control.  LinkMode should be set to either None(0) or Manual(2).  To work successfully the control's UseInRequest property must be set to True.

Visual Basic	object.LinkRequest

Remarks	LinkRequest causes the source application to send the most current RSData to object.

See also: RequestStartIndex and RequestLength properties, DoRequest method.


Move Method

Applies To	RSButton, RSCompare, RSData, RSGauge, RSSlider, RSWheel, RSVessel

Description	Moves an MDIForm, Form, or control.

Visual Basic	object.Move left, top, width, height

Remarks	Only the left argument is required.  However, to specify any other arguments, you must specify all arguments that appear in the syntax before the argument you want to specify.

For more information refer to the Microsoft Visual Basic Language Reference.


Object Method

Applies To	RSButton, RSCompare, RSData, RSGauge, RSWheel, RSVessel, RSSlider

Description	Returns an object in a control.

Visual Basic	object.Control.Object[.property|.method][=value]

Remarks	For more information refer to the Microsoft Visual Basic Language Reference.


Parent Method

Applies To	RSButton, RSCompare, RSData, RSGauge, RSSlider, RSWheel, RSVessel

Description	Returns the container on which an object is located.

Visual Basic	object.Control.Parent

Remarks	For more information refer to the Microsoft Visual Basic Language Reference.


SetFocus Method

Applies To	RSButton, RSCompare, RSData, RSGauge, RSSlider, RSWheel, RSVessel

Description	Moves the focus to the specified control or form.

Visual Basic	object.SetFocus

Remarks	The object (control) that can receive the focus.  After invoking the SetFocus method, any user input is directed to the specified control.

For more information refer to the Microsoft Visual Basic Language Reference.


ShowWhatsThis Method

Applies To	RSButton, RSCompare, RSData, RSGauge, RSSlider, RSWheel, RSVessel

Description	Displays a selected topic in a Help file using the What's This popup provided by Windows 95 	Help.

Visual Basic	object.ShowWhatsThis

Remarks	The ShowWhatsThis method is very useful for providing context-sensitive Help from a context menu in your application.  The method displays the topic identified by the WhatsThisHelpID property of the object specified in the syntax.


ZOrder Method

Applies To	RSButton, RSCompare, RSData, RSGauge, RSSlider, RSWheel, RSVessel

Description	Places a specified MDIForm, Form, or control at the front or back of the z-order within its graphical level.

Visual Basic	object.ZOrder position

Remarks	The ZOrder method syntax has these parts:

Part	Description

object	Optional.  An object expression that evaluates to an object in the Applies To list.  If object is omitted, the form with the focus is assumed to be object.

position 	Optional.  Integer indicating the position of object relative to other instances of the same object.  If position is 0 or omitted, object is positioned at the front of the z-order.  If position is 1, object is positioned at the back of the z-order.


See Visual Basic Language Reference For More Details