Vba functions

21_132302 appa.qxp 7/27/07 9:52 PM Page 300

VBA and Excel Object
Model Quick Reference
VBA Statements Quick Reference
Legend
Plain courier text = required [] = optional | = or
Italics = user-defined . . . = list of items

File and Folder Handling
STATEMENT DESCRIPTION
ChDir path Changes to the specified folder location.
ChDrive drive Changes to the specified drive.
Close [filenumber] Closes a file opened by using an Open statement.
FileCopy source, destination Copies a file from the source to the specified destination.
Kill pathname Deletes files from a disk. Use wildcards * for multiple characters and ? for single
characters.
Lock [#]filenumber[, recordrange] Locks all or a portion of an open file to prevent access by other processes.
MkDir path Creates a new directory or folder.
Open pathname For mode Opens the specified file to allow input/output operations.
[Access access][lock] As
[#]filenumber [Len=reclength]
Print #filenumber[, outputlist] Writes display-formatted data sequentially to a file.
Put [#]filenumber,
[recnumber,] varname Writes data contained in a variable to a disk file.
Reset Closes all files opened using the Open statement.
RmDir path Removes the specified folder.
SetAttr pathname, attributes Sets the attribute information for the specified file.
Unlock [#]filenumber[, recordrange] Unlocks a file to allow access by other processes.
Width #filenumber, width Assigns the output line width for a file opened using the Open statement.
Write #filenumber[, outputlist] Writes data to a sequential text file.

Interaction
AppActivate title[, wait] Activates an application window.
DeleteSetting appname, Deletes a section or key setting from an application’s entry in the Windows Registry
section[, key]
SaveSetting appname, Saves an application entry in the application’s entry in the Windows Registry.
section, key, setting
SendKeys string[, wait] Sends one or more keystrokes to the active window as if they were typed on the keyboard.

300

21_132302 appa.qxp 7/27/07 9:52 PM Page 301

Appendix A: VBA Quick Reference
VBA Statements Quick Reference (continued)
Program Flow
[Public | Private] Declare Sub name Lib “libname” Declares a reference to an external DLL library function.
[Alias “aliasname”] [([arglist])]
Do [{While | Until} condition] Repeats a block of statements while or until a condition is
[statements] true. The condition is checked at the beginning of the loop.
Loop
Do Repeats a block of statements while or until a condition is
[statements] true. Because the condition is checked at the end of the
Loop [{While | Until} condition] loop, the block of statements always executes at least once.
Exit Do | For | Function | Property | Sub Exits the specified Do Loop, For Next, Function, Sub, or
Property code.
For Each element In group Repeats a block of statements for each element in an array
[statements] or collection.
Next [element]
For counter = start To end [Step step] Repeats a section of code the specified number of times.
[statements]
Next [counter]
[Public | Private | Friend] [Static] Function name Defines a procedure that returns a value.
[(arglist)] [As type]
[statements]
[name = expression]
End Function
If condition Then Conditionally executes a block of statements based upon
[statements] the value of an expression.

[ElseIf condition-n Then]
[elseifstatements]]

[Else [elsestatements]]

End If
[Public | Private | Friend] [Static] Property Get name Declares the name and arguments associated with a
[(arglist)] [As type] procedure.
[statements]
[name = expression]

End Property
[Public | Private | Friend] [Static] Property Let name Declares the name and arguments of a procedure that
([arglist,] value) assigns a value to a property.
[statements]
End Property
[Public | Private | Friend] [Static] Property Set name Declares the name and arguments of a procedure that sets
([arglist,] reference) a reference to an object.
[statements]
End Property
continued

continued ➔ 301

21_132302 appa.qxp 7/27/07 9:52 PM Page 302

VBA and Excel Object Model
Quick Reference (continued)
Program Flow (continued)
Select Case testexpression Executes one block out of a series of statement blocks
[Case expressionlist-n depending upon the value of an expression.
[statements-n]]
[Case Else
[elsestatements]]
End Select
[Private | Public | Friend] [Static] Sub name [(arglist)] Declares the name, arguments, and code that form a
[statements] Sub procedure.
End Sub
While condition Executes a block of statements as long as the specified
[statements] condition is true.
Wend
With object Executes a block of statements on a single object or on a
[statements] user-defined data type.
End With

Variable Declaration
[Public | Private] Const constname [As type] = expression Declares a constant value.
Dim [WithEvents] varname[([subscripts])] [As [New] type] Declares variables and allocates the appropriate storage
space.
Friend [WithEvents] varname[([subscripts])] [As [New] type] Declares a procedure or variable to only have scope in the
project where it is defined.
Option Compare {Binary | Text | Database} Specifies the default comparison method to use when
comparing strings.
Option Explicit Forces declaration of all variables within the module.
Option Private Indicates that all code within the entire module is Private.
This option is used by default. You can overwrite the effects
of this option by declaring a specific procedure Public.
Private [WithEvents] varname[([subscripts])] [As [New] type] Declares variables and procedures to only have scope within
the current module.
Public [WithEvents] varname[([subscripts])] [As [New] type] Declares variables and procedures to have scope within the
entire project.

302

21_132302 appa.qxp 7/27/07 9:52 PM Page 303


Variable Declaration (continued)
ReDim [Preserve] varname(subscripts) [As type] Changes the dimensions of a dynamic array.
[Private | Public] Type varname Defines a custom data type.
elementname [([subscripts])] As type
[elementname [([subscripts])] As type]
...
End Type

VBA Function Quick Reference
Legend
Plain courier text = required [] = optional | = or
Italics = user-defined . . . = list of items

Array Functions
FUNCTION DESCRIPTION RETURNS
Array(arg1,arg2, arg3, . . .) Creates a variant array containing the specified elements. Variant
LBound(arrayname[, dimension]) Returns the smallest subscript for the specified array. Long
UBound(arrayname[, dimension]) Returns the largest subscript for the specified array. Long

Data Type Conversion Functions
Asc(string) Returns the character code of the first letter in a string. Integer
CBool(expression) Converts an expression to Boolean data type (True or False) Boolean
CByte(expression) Converts an expression to Byte data type. Byte
CCur(expression) Converts an expression to Currency data type. Currency
CDate(expression) Converts an expression to a Date data type. Date
CDbl(expression) Converts an expression to Double data type. Double
CDec(expression) Converts an expression to a decimal value. Variant
(Decimal)
Chr(charactercode) Converts the character code to the corresponding character. Variant
Chr(9) returns a tab, Chr(34) returns quotation marks, etc.
CInt(expression) Converts an expression to an Integer data type, rounding Integer
any fractional parts.
continued

continued ➔ 303

21_132302 appa.qxp 7/27/07 9:52 PM Page 304

VBA Function Quick Reference (continued)

Data Type Conversion Functions (continued)
CLng(expression) Converts an expression to the Long data type. Long
CSng(expression) Converts an expression to the Single data type. Single
CStr(expression) Returns a string containing the specified expression. String
CVar(expression) Converts any data type to a Variant data type. All Variant
numeric values are treated as Double data types and
string expressions are treated as String data types.
Format(expression[, format[, Formats the expression using either predefined or Variant
firstdayofweek[, user-defined formats.
firstweekofyear]]])
FormatCurrency(Expression[, Formats the expression as a currency value using the Currency
NumDigitsAfterDecimal system-defined currency symbol.
[, IncludeLeadingDigit
[,UseParensForNegativeNumbers
[, GroupDigits]]]])
FormatDateTime(Date[, Formats an expression as a date and time. Date
NamedFormat])
FormatNumber(Expression Formats the expression as a number. Mixed
[, NumDigitsAfterDecimal
[, IncludeLeadingDigit
[, UseParensForNegativeNumbers
[, GroupDigits]]]])
FormatPercent(Expression Returns the expression formatted as a percentage with String
[,NumDigitsAfterDecimal a trailing % character.
[,IncludeLeadingDigit
[,UseParensForNegativeNumbers
[,GroupDigits]]]])
Hex(number) Converts a number to a hexadecimal value. Rounds String
numbers to nearest whole number before converting.
Oct(number) Converts a number to an octal value. Rounds numbers Variant (String)
to nearest whole number before converting.
Str(number) Converts a number to a string using the Variant data type. Variant (String)
Val(string) Returns the numeric portion of a string formatted as a Mixed
number of the appropriate data type.

304

21_132302 appa.qxp 7/27/07 9:52 PM Page 305


Date and Time Functions
Date Returns the current system date. Date
DateAdd(interval, number, date) Returns a date that is the specified interval of time from Date
the original date.
DateDiff(interval, date1, date2[, Determines the time interval between two dates. Long
firstdayofweek[,
firstweekofyear]])
DatePart(interval, date[, Returns the specified part of a date. Integer
firstdayofweek[,
firstweekofyear]])
DateSerial(year, month, day) Converts the specified date to a serial number. Date
DateValue(date) Converts a string to a date. Date
Day(date) Returns a whole number between 1 and 31 representing Integer
the day of the month.
Hour(time) Returns a whole number between 0 and 23 representing Integer
the hour of the day.
Minute(time) Returns a whole number between 0 and 59 representing Integer
the minute of the hour.
Month(date) Returns a whole number between 1 and 12 representing Integer
the month of the year.
Now Returns the current system date and time. Date
Second(time) Returns a whole number between 0 and 59 representing Integer
the second of the minute.
Time Returns the current system time. Date
Timer Indicates the number of seconds that have elapsed Single
since midnight
TimeSerial(hour, minute, second) Creates a time using the specified hour, minute, and Date
second values.
TimeValue(time) Converts a time to the serial number used to store time. Date
WeekDay(date, [firstdayofweek]) Returns a whole number representing the first day of Integer
the week.
Year(date) Returns a whole number representing the year portion Integer
of a date

continued ➔ 305

21_132302 appa.qxp 7/27/07 9:52 PM Page 306


File and Folder Handling Functions
CurDir(drive) Returns the current path. String
Dir[(pathname[, attributes])] Returns the name of the file, directory, or folder String
that matches the specified pattern.
EOF(filenumber) Returns -1 when the end of a file has been reached. Integer
FileAttr(filenumber, returntype) Indicates the file mode used for files opened with Long
the Open statement.
FileDateTime(pathname) Indicates the date and time when a file was last Date
modified.
FileLen(pathname) Indicates the length of a file in bytes. Long
FreeFile(rangenumber) Returns the next file number available for use by Integer
the Open statement.
GetAttr(pathname) Returns a whole number representing the attributes Integer
of a file, directory, or folder.
Input(number, [#]filenumber) Returns a string containing the indicated number String
of characters from the specified file.
Loc(filenumber) Indicates the current read/write position in an Long
open file.
LOF(filenumber) Returns the size in bytes of a file opened using the Long
Long Open statement.
Seek(filenumber) Specifies the current read/write position with a file Long
opened with the Open statement.

Financial Functions
DDB(cost, salvage, life, period[, factor]) Specifies the depreciation value for an asset during Double
a specific time frame.
FV(rate, nper, pmt[, pv[, type]]) Determines the future value of an annuity based Double
on periodic fixed payments.
IPmt(rate, per, nper, pv[, fv[, type]]) Determines the interest payment on an annuity Double
for a specific period of time.
IRR(values(), [, guess]) Determines the internal rate of returns for a series Double
of cash flows.
MIRR(values(), finance_rate, reinvest_rate) Returns the modified interest rate of returns for Double
a series of periodic cash flows

306

21_132302 appa.qxp 7/27/07 9:52 PM Page 307


Financial Functions (continued)
NPer(rate, pmt, pv[, fv[, type]]) Returns the number of periods for an annuity. Double
NPV(rate, values()) Returns the net present value of an investment. Double
Pmt(rate, nper, pv[, fv[, type]]) Returns the payment amount for an annuity based Double
on fixed payments.
PPmt(rate, per, nper, pv[, fv[, type]]) Returns the principal payment amount for an annuity. Double
PV(rate, nper, pmt[, fv[, type]]) Returns the present value of an annuity. Double
Rate(nper, pmt, pv[, fv[, type[, guess]]]) Returns the interest rate per period for an annuity. Double
SLN(cost, salvage, life) Determines the straight-line depreciation of an asset Double
for a single period.
SYD(cost, salvage, life, period) Determines the sum-of-years’ digits depreciation of Double
an asset for a specified period.

Information Functions
CVErr(errornumber) Returns a user-defined error number. Variant
Error[(errornumber)] Returns the error message for the specified error number. String
IsArray(varname) Indicates whether a variable contains an array. Boolean
IsDate(expression) Indicates whether an expression contains a date. Boolean
IsEmpty(expression) Indicates whether a variable has been initialized. Boolean
IsError(expression) Indicates whether an expression is an error value. Boolean
IsMissing(argname) Indicates whether an optional argument was passed to Boolean
a procedure.
IsNull(expression) Indicates whether an expression contains no valid data. Boolean
IsNumeric(expression) Indicates whether an expression is a number. Boolean
IsObject(identifier) Indicates whether a variable references an object. Boolean
TypeName(varname) Specifies the variable type. String
VarType(varname) Specifies the subtype of a variable. Integer

continued ➔ 307

21_132302 appa.qxp 7/27/07 9:52 PM Page 308


Interaction Functions
Choose(index, choice-1, Selects and returns a value from a list of arguments. Mixed
[choice-2, ...])
DoEvents() Yields execution so the operating system can process Integer
other events.
Iif(expr, truepart, falsepart) Evaluates the expression and returns either the Mixed
truepart or falsepart parameter value.
InputBox(prompt[, title] Displays a dialog box prompting the user for input. String
[, default] [, xpos]
[, ypos] [, helpfile,
context])
GetAllSettings(appname, section) Returns a list of key settings and their values from Variant
the Windows Registry.
GetObject([pathname][, class]) Returns a reference to an object provided by an Variant
ActiveX Component.
GetSetting(appname, section, Returns a key setting value from an application’s Variant
key[, default]) entry in the Windows registry.
MsgBox(prompt[, buttons] Displays a message box and returns a value representing Integer
[, title] [, helpfile, the button pressed by the user
context])
Partition(number, start, stop, Indicates where a number occurs within a series of String
interval) ranges.
QBColor(color) Returns the RGB color code for the specified color. Long
Switch(expr-1, value-1[, expr-2, Evaluates a list of expressions and returns the value Variant
value-2 ...]) associated with the first True expression.
RGB(red, green, blue) Returns a number representing the RGB color value. Long

Mathematical Functions
Abs(number) Returns the absolute value of a number. Mixed
Atn(number) Returns the arctangent of a number. Double
Cos(number) Returns the cosine of an angle. Double

308

21_132302 appa.qxp 7/27/07 9:52 PM Page 309


Mathematical Functions (continued)
Exp(number) Returns the base of the natural logarithms raised to Double
a power.
Fix(number) Returns the integer portion of a number. With Integer
negative values, returns the first negative value greater
than or equal to the number.
Int(number) Returns the integer portion of a number. With negative Integer
values, returns the first negative number less than or
equal to the number
Log(number) Returns the natural logarithm of a number. Double
Round(expression [, numdecimalplaces]) Rounds a number to the specified number of decimal Mixed
places.
Rnd[(number)] Returns a random number between 0 and 1. Single
Sgn(number) Returns 1 for a number greater than 0, 0 for a value Integer
of 0, and -1 for a number less than zero.
Sin(number) Specifies the sine of an angle. Double
Sqr(number) Specifies the square root of a number. Double
Tan(number) Specifies the tangent of an angle. Double

String Manipulation Functions
nStr([start, ]string1, Specifies the position of one string within another Long
string2 [, compare]) string.
InStrRev(stringcheck, Specifies the position of one string within another Long
stringmatch[, start[, starting at the end of the string.
compare]])
LCase(string) Converts a string to lowercase. String
Left(string, length) Returns the specified number of characters from String
the left side of a string.
Len(string | varname) Determines the number of characters in a string. Long
LTrim(string) Trims spaces from the left side of a string. String
Mid(string, start[, length]) Returns the specified number of characters from String
the center of a string.
Right(string, length) Returns the specified number of characters from String
the right side of a string.
RTrim(string) Trims spaces from the right side of a string. String
Space(number) Creates a string with the specified number of spaces. String
continued

continued ➔ 309

21_132302 appa.qxp 7/27/07 9:52 PM Page 310


String Manipulation Functions (continued)
Spc(n) Positions output when printing to a file. String
Str(number) Returns a string representation of a number. String
StrComp(string1, string2[, compare]) Returns a value indicating the result of a string comparison. Integer
StrConv(string, conversion, LCID) Converts a string to the specified format. String
String(number, character) Creates a string by repeating a character the specified String
number of times.
Tab[(n)] Positions output when printing to a file. String
Trim(string) Trims spaces from left and right of a string. String
UCase(string) Converts a string to uppercase. String

VBA Function Constants and Characters

vbMsgBoxStyle Constants (MsgBox Function)
CONSTANT VALUE DESCRIPTION
vbAbortRetryIgnore 2 Displays Abort, Retry, and Ignore buttons.
vbApplicationModal 0 Creates application modal message box.
vbCritical 16 Displays Critical Message icon.
vbDefaultButton1 0 Makes first button default.
vbDefaultButton2 256 Makes second button default.
vbDefaultButton3 512 Makes third button default.
vbDefaultButton4 768 Makes fourth button default.
vbExclamation 48 Displays Warning Message icon.
vbInformation 64 Displays Information Message icon.
vbMsgBoxHelpButton 16384 Adds a Help button.

310

21_132302 appa.qxp 7/27/07 9:52 PM Page 311

VBA Function Constants and Characters (continued)

vbMsgBoxStyle Constants (MsgBox Function) (continued)
vbMsgBoxRight 524288 Right aligns text in the box.
vbMsgBoxRtlReading 1048576 Used only with Hebrew and Arabic systems
for right-to-left reading.
vbMsgBoxSetForeground 65536 Makes message box the foreground window.
vbOKCancel 1 Displays OK and Cancel buttons.
vbOKOnly 0 Displays only the OK button.
vbQuestion 32 Displays Warning Query icon.
vbRetryCancel 5 Displays Retry and Cancel buttons.
vbSystemModal 4096 Creates a system modal message box.
vbYesNo 4 Displays Yes and No buttons.
vbYesNoCancel 3 Displays Yes, No, and Cancel buttons.

vbDayOfWeek Constants
vbUseSystemDayofWeek 0 Uses the system defined first day of week.
vbSunday 1 Sunday (default).
vbMonday 2 Monday.
vbTuesday 3 Tuesday.
vbWednesday 4 Wednesday.
vbThursday 5 Thursday.
vbFriday 6 Friday.
vbSaturday 7 Saturday.

vbFirstWeekOfYear Constants
vbUseSystem 0 Uses system defined first week of year.
vbFirstJan1 1 Starts with week in which January 1 occurs
(default).
vbFirstFourDays 2 Starts with the first week that has at least
four days in the new year.
vbFirstFullWeek 3 Starts with first full week of the year.

continued ➔ 311

21_132302 appa.qxp 7/27/07 9:52 PM Page 312


Format Function Characters
DATE/TIME CHARACTERS DISPLAYS
d Day with no leading zero.
ddd Three-letter abbreviation of day (Sun. – Sat.).
dddd Full day name (Sunday).
ddddd Complete date using short date format.
dddddd Complete date using long date format.
w Day of week as number (1 for Sunday).
ww Week of year as number.
m Month with no leading zero.
mmm Three letter abbreviation of month (Jan.-Dec.).
mmmm Complete month name.
q Quarter of year.
y Day of year as number.
yy Year as 2-digit number.
yyyy Year as 4-digit number.
h Hour with no leading zero.
n Minutes with no leading zero.
s Seconds with no leading zero.
ttttt Complete time using system time format.
c Date as dddddd and time as ttttt.

Format Function Predefined Formats
FORMAT DESCRIPTION
General Date Uses general date format.
Long Date Uses system-defined long date, such as Tuesday, August 7,
2007.
Medium Date Uses the medium date format, such as 07-Aug-07.
Short Date Uses system-defined short date, such as 8/7/2007.
Long Time Uses system-defined long time, such as 5:45:30 P.M.
Medium Time Uses the medium time format, such as 05:45 P.M.
Short Time Uses the short time format, such as 17:45.

312

21_132302 appa.qxp 7/27/07 9:52 PM Page 313


Format Function Predefined Formats (continued)
FORMAT DESCRIPTION
General Number Uses the general number format.
Currency Places the appropriate currency symbol in front of the number.
Fixed Uses a fixed decimal format.
Standard Uses standard formatting.
Percent Converts the expression to a percentage.
Scientific Displays the expression using scientific notation.
Yes/No Converts the expression to a Yes or No value.
True/False Converts the expression to a True or False value.
On/Off Converts the expression to an On or Off value.

Excel Object Model Constants

XlColumnDataType Constants
xlDMYFormat 4 DMY format date.
xlDYMFormat 7 DYM format date.
xlEMDFormat 10 EMD format date.
xlGeneralFormat 1 General format.
xlMDYFormat 3 MDY format date.
xlMYDFormat 6 MYD format date.
xlSkipColumn 9 Skip Column.
xlTextFormat 2 Text format.
xlYDMFormat 8 YDM format date.
xlYMDFormat 5 YMD format date.

XlFileFormat Constants
xlAddIn 18 Excel add-in.
xlAddIn8 18 Excel 2007 Add-In
xlCSV 6 Comma-separated values format.
xlCSVMac 22 Macintosh comma-separated
values format.
continued

continued ➔ 313

21_132302 appa.qxp 7/27/07 9:52 PM Page 314

Excel Object Model Constants (continued)

XlFileFormat Constants (continued)
xlCSVMSDOS 24 MSDOS comma-separated values format.
xlCSVWindows 23 MS Windows comma-separated values format.
xlCurrentPlatformText -4158 Text file based on current operating system.
xlDBF2 7 DBase II format.
xlDBF3 8 DBase III format.
xlDBF4 11 DBase IV format.
xlDIF 9 Data interchange format.
xlExcel12 50 Excel 12 format.
xlExcel2 16 Excel 2
xlExcel2FarEast 27 Excel 2.0 format – Far East version.
xlExcel3 29 Excel 3.0 format.
xlExcel4Workbook 35 Excel 4.0 workbook format.
xlExcel7 39 Excel 97 format.
xlExcel9597 43 Excel 95 – 97 format.
xlHtml 44 HTML format.
xlIntlAddIn 26 Excel international Add-in.
xlIntlMacro 25 Excel international macro.
xlOpenXMLAddin 55 Open XML Add-In.
xlOpenXMLTemplate 54 Open XML Template.
xlOpemXMLTemplateMacroEnabled 53 Open XML Template Macro Enabled.
xlOpenXMLWorkbook 51 Open XML Workbook.
xlOpenXMLWorkbookzMacroEnabled 52 Open XML Workbook Enabled.
xlSYLK 2 Symbolic link format.
xlTemplate 17 Template file format.
xlTemplate8 17 Template.
xlTextMac 19 Macintosh text file format.
xlTextMSDOS 21 MSDOS text file format.
xlTextPrinter 36 Text file created for a printer (.prn).
xlTextWindows 20 MS Window text file format.

314

21_132302 appa.qxp 7/27/07 9:52 PM Page 315


XlFileFormat Constants (continued)
xlUnicodeText 42 Unicode text file format.
xlWebArchive 45 Web archive format (.mht).
xlWJ2WD1 14 WJ2WD1
xlWJ3 40 WJ3
xlWJ3FM3 41 WJ3FJ3
xlWK1 5 Lotus 2.x format.
xlWK1ALL 31 Lotus 2.x .all format.
xlWK1FMT 30 Lotus 2.x .fmt format.
xlWK3 15 Lotus 3.x format.
xlWK3FM3 32 Lotus 3.x and Lotus 1-2-3 for Windows
format.
xlWK4 38 Lotus 4.0 format.
xlWKS 4 MS Works file format.
xlWorkBookDefault 51 Workbook default
xlWorkbookNormal -4143 Excel workbook format.
xlWorks2FarEast 28 MS Works file – Far East format.
xlWQ1 34 Quattro Pro for MSDOS format.
xlXMLSpreadsheet 46 XML format.

MsoFileType Constants
msoFileTypeAllFiles 1 All file types.
msoFileTypeBinders 6 Microsoft Office Binder file.
msoFileTypeCalendarItem 11 Microsoft Outlook Calendar item.
msoFileTypeContactItem 12 Microsoft Outlook Contact item.
msoFileTypeDatabases 7 Database files.
msoFileTypeDataConnectionFiles 17 Database connection files.
msoFileTypeDesignerFiles 22 Designer files.
msoFileTypeDocumentImagingFiles 20 Document imaging files.
msoFileTypeExcelWorkbooks 4 Microsoft Excel Workbooks.
msoFileTypeJournalItem 14 Journal items.
msoFileTypeMailItem 10 Microsoft Outlook Mail message.
msoFileTypeNoteItem 13 Microsoft Outlook Note item.
msoFileTypeOfficeFiles 2 All Microsoft Office file types.
continued

continued ➔ 315

21_132302 appa.qxp 7/27/07 9:52 PM Page 316


MsoFileTypeConstant (continued)
msoFileTypeOutlookItems 9 Microsoft Outlook files.
msoFileTypePhotoDrawFiles 16 Microsoft PhotoDraw files.
msoFileTypePowerPointPresentations 5 Microsoft PowerPoint files.
msoFileTypeProjectFiles 19 Microsoft Project files.
msoFileTypePublisherFiles 18 Microsoft Publisher files.
msoFileTypeTaskItem 15 Microsoft Outlook Task item.
msoFileTypeTemplates 8 Template files.
msoFileTypeVisioFiles 21 Visio files.
msoFileTypeWebPages 23 Web pages including .htm, .asp, and .mht files.
msoFileTypeWordDocuments 3 Microsoft Word documents.

XlChartType Constants
CONSTANT VALUE CHART TYPE
xl3DArea -4098 3D Area.
xl3DAreaStacked 78 3D Stacked Area.
xl3DAreaStacked100 79 100% Stacked Area.
xl3DBarClustered 60 3D Clustered Bar.
xl3DBarStacked 61 3D Stacked Bar.
xl3DBarStacked100 62 3D 100% Stacked Bar.
xl3DColumn -4100 3D Column.
xl3DColumnClustered 54 3D Clustered Column.
xl3DColumnStacked 55 3D Stacked Column.
xl3DColumnStacked100 56 3D 100% Stacked Column.
xl3DLine -4101 3D Line.
xl3DPie -4102 3D Pie.
xl3DPieExploded 70 Exploded 3D Pie.
xlArea 1 Area.
xlAreaStacked 76 Stacked Area.
xlAreaStacked100 77 100% Stacked Area.
xlBarClustered 57 Clustered Bar.

316

21_132302 appa.qxp 7/27/07 9:52 PM Page 317


XlChartType Constants (continued)
xlBarOfPie 71 Bar of Pie.
xlBarStacked 58 Stacked Bar.
xlBarStacked100 59 100% Stacked Bar.
xlBubble 15 Bubble.
xlBubble3DEffec 87 Bubble with 3D effects.
xlColumnClustered 51 Clustered Column.
xlColumnStacked 52 Stacked Column.
xlColumnStacked100 53 100% Stacked Column.
xlConeBarClustered 102 Clustered Cone Bar.
xlConeBarStacked 103 Stacked Cone Bar.
xlConeBarStacked100 104 100% Stacked Cone Bar.
xlConeCol 105 3D Cone Column.
xlConeColClustered 99 Clustered Cone Column.
xlConeColStacked 100 Stacked Cone Column.
xlConeColStacked100 101 100% Stacked Cone Column.
xlCylinderBarClustered 95 Clustered Cylinder Bar.
xlCylinderBarStacked 96 Stacked Cylinder Bar.
xlCylinderBarStacked100 97 100% Stacked Cylinder Bar.
xlCylinderCol 98 3D Cylinder Column.
xlCylinderColClustered 92 Clustered Cone Column.
xlCylinderColStacked 93 Stacked Cone Column.
xlCylinderColStacked100 94 100% Stacked Cylinder Column.
xlDoughnut -4120 Doughnut.
xlDoughnutExploded 80 Exploded Doughnut.
xlLine 4 Line.
xlLineMarkers 65 Line with Markers.
xlLineMarkersStacked 66 Stacked Line with Markers.
xlLineMarkersStacked100 67 100% Stacked Line with Markers.
xlLineStacked 63 Stacked Line.
xlLineStacked100 64 100% Stacked Line.
xlPie 5 Pie.
xlPieExploded 69 Exploded Pie.
xlPieOfPie 68 Pie of Pie.
xlPyramidBarClustered 109 Clustered Pyramid Bar.
continued

continued ➔ 317

21_132302 appa.qxp 7/27/07 9:52 PM Page 318


XlChartType Constants (continued)
xlPyramidBarStacked 110 Stacked Pyramid Bar.
xlPyramidBarStacked100 111 100% Stacked Pyramid Bar.
xlPyramidCol 112 3D Pyramid Column.
xlPyramidColClustered 106 Clustered Pyramid Column.
xlPyramidColStacked 107 Stacked Pyramid Column.
xlPyramidColStacked100 108 100% Stacked Pyramid Column.
xlRadar -4151 Radar.
xlRadarFilled 82 Filled Radar.
xlRadarMarkers 81 Radar with Data Markers.
xlStockHLC 88 High-Low-Close.
xlStockOHLC 89 Open-High-Low-Close.
xlStockVHLC 90 Volume-High-Low-Close.
xlStockVOHLC 91 Volume-Open-High-Low-Close.
xlSurface 83 3D Surface.
xlSurfaceTopView 85 Top View Surface.
xlSurfaceTopViewWireframe 86 Top View Wireframe Surface.
xlSurfaceWireframe 84 3D Surface Wireframe.
xlXYScatter -4169 Scatter.
xlXYScatterLines 74 Scatter with Lines.
xlXYScatterLinesNoMarkers 75 Scatter with Lines and No Data Markers.
xlXYScatterSmooth 72 Scatter with Smoothed Lines.
xlXYScatterSmoothNoMarkers 73 Scatter with Smoothed Lines and No Data Markers.

XlLineStyle Constants
xlContinuous 1 Continuous solid line.
xlDash -4155 Dashed line.
xlDashDot 4 Line with the pattern dash dot.
xlDashDotDot 5 Line with the pattern dash dot dot.
xlDot -4118 Dotted line.

318

21_132302 appa.qxp 7/27/07 9:52 PM Page 319


XlLineStyle Constants (continued)
xlDouble -4119 Double solid line.
xlSlantDashDot 13 Slanted line with the pattern dash dot.
xlineStyleNone -4142 No line.

XlBorderWeight Constants
xlHairline 1 Creates a very thin line.
xlMedium -4138 Creates a medium width line.
xlThick 4 Creates a thick line.
xlThin 2 Creates a thin line.

XlPattern Constants
xlPatternAutomatic -4105 System default.
xlPatternChecker 9 Checkered pattern.
xlPatternCrissCross 16 Criss-cross pattern.
xlPatternDown -4121 Downward pattern.
xlPatternGray25 -4124 25% gray pattern.
xlPatternGrid 15 Grid pattern.
xlPatternHorizontal -4128 Horizontal pattern.
xlPatternLightHorizontal 11 Light horizontal pattern.
xlPatternLightVertical 12 Light vertical pattern.
xlPatternLightDown 13 Light downward pattern.
xlPatternLightUp 14 Light upward pattern.
xlPatternNone -4142 No pattern.
xlPatternSemiGray75 10 75% semi-gray pattern.
xlPatternSolid 1 Solid color, no pattern.
xlPatternUp -4162 Upward pattern.
xlPatternVertical -4166 Vertical pattern.

319

22_132302 appb.qxp 7/27/07 9:52 PM Page 320

Ribbon Controls
Quick Reference
XML Controls
XML controls specific to the Ribbon.

CONTROL DESCRIPTION COMMON ATTRIBUTES CHILDREN
customUI The root tag for Ribbon None commands, ribbon
customizations.
commands Globally repurposed commands. None command
command Represents the command that enabled, getEnabled, contextualTabs, officeMenu,
you are repurposing. idMso (required), onAction qat, tabs
contextualTabs The contextual tabs that display in None tabSet
Excel. For example, the Chart tools.
tabSet A collection of tab controls. getVisible, idMso (required),
visible tab
qat The Quick Access Toolbar. Used None documentControls,
only in the start from scratch mode. sharedControls
sharedControls Controls shared across documents. None button, control, separator
In general, you should use
documentControls, not
sharedControls.
documentControls Controls specific to a document. None button, control, separator
officeMenu Microsoft Office menu controls. None button, checkbox, control,
dynamicMenu, gallery, menu,
menuSeparator, splitButton,
toggleButton
tabs Container for tab controls. None tab
tab A tab on the Ribbon. getKeytip, getLabel, getVisible, group
id, idMso, idQ, insertAfterMso,
insertAfterQ, insertBeforeMso,
insertBeforeQ, keytip, label,
tag, visible
group A group on a tab on the Ribbon. getImage, getImageMso, box, button, buttonGroup,
getKeytip, getLabel, checkBox, comboBox, control,
getScreentip, getSupertip, dialogBoxLauncher, dropDown,
getVisible, id, idMso, idQ, editBox, gallery, labelControl,
image, imageMso, menu, separator, splitButton,
insertAfterMso, insertAfterQ, toggleButton
insertBeforeMso, insertBeforeQ,
keytip, label, screentip,
supertip, visible

320

22_132302 appb.qxp 7/27/07 9:52 PM Page 321

Appendix B: Ribbon Controls Quick Reference
XML Basic Controls

box Use to arrange getVisible, id, idQ, insertAfterMso, box, button,
controls within insertAfterQ, insertBeforeMso, buttonGroup, checkBox,
a group. insertBeforeQ, visible comboBox, control,
dropdown,
dynamicMenu, editBox,
gallery, labelControl,
menu, splitButton,
toggleButton
button Use to represent description, enabled, getDescription, None
a button control. getEnabled, getImage, getImageMso,
getKeytip, getLabel, getScreentip,
getShowImage, getShowLabel, getSize,
getSupertip, getVisible, id, idMso, idQ,
image, imageMso, insertAfterMso,
insertAfterQ, insertBeforeMso, insertBeforeQ,
keytip, label, onAction, screentip, showImage,
showLabel, size, supertip, tag, visible
buttonGroup Use to create a getVisible, id, idQ, insertAfterMso, button, control,
grouping of insertAfterQ, insertBeforeMso, dynamicMenu, gallery,
buttons. insertBeforeQ, visible menu, splitButton,
toggleButton
checkbox Use to create description, enabled, getDescription, None
a check box getEnabled, getKeytip, getLabel,
control. getScreentip, getSupertip, getVisible, id,
idMso, idQ, insertAfterMso, insertAfterQ,
insertBeforeMso, insertBeforeQ, keytip,
label, onAction, screentip, supertip,
tag, visible
comboBox Use to create enabled, getEnabled, getImage, getImageMso, item
a combo box getKeytip, getLabel, getScreentip, getShowImage,
control. getShowLabel, getSupertip, getVisible, id, idMso,
idQ, image, imageMso, insertAfterMso,
label, screentip, showImage, showLabel, supertip,
tag, visible, Shared with editBox: getText,
maxLength, onChange, sizeString
dialogBox Use to create a None button (required)
Launcher dialog box launcher
for a group. A
group control can
only have one
dialog box launcher,
the control must
contain a button
control, and must
be the final element
in the group
element.
continued

continued ➔ 321

22_132302 appb.qxp 7/27/07 9:52 PM Page 322

Ribbon Controls Quick
Reference (continued)
XML Basic Controls (continued)

dropdown Use to create a enabled, getEnabled, getImage, getImageMso, item
drop-down list getKeytip, getLabel, getScreentip, getShowImage,
box. getShowLabel, getSupertip, getVisible, id, idMso,
idQ, image, imageMso, insertAfterMso, insertAfterQ,
insertBeforeMso, insertBeforeQ, keytip, label,
onAction, screentip, showImage, showLabel,
supertip, tag, visible Shared with comboBox:
getItemCount, getItemID, getItemImage,
getItemLabel, getItemScreentip, getItemSupertip,
showItemImage, Shared with editBox: sizeString
dynamicMenu Use to create a description, enabled, getDescription, getEnabled, Same as a menu, but is
menu at run time. getImage, getImageMso, getKeytip, getLabel, populated by using the
getScreentip, getShowImage, getShowLabel, getContent callback.
getSize, getSupertip, getVisible, id, idMso, idQ,
image, imageMso, insertAfterMso, insertAfterQ,
screentip, showImage, showLabel, supertip, tag,
visible
editBox Use to create an enabled, getEnabled, getImage, getImageMso, None
edit box control. getKeytip, getLabel, getScreentip, getShowImage,
getShowLabel, getSupertip, getVisible, id, idMso,
idQ, image, imageMso, insertAfterMso, insertAfterQ,
screentip, showImage, showLabel, supertip, tag, visible
gallery Use to create a description, enabled, getDescription, getEnabled, item, button. Buttons must be
gallery control. getImage, getImageMso, getKeytip, getLabel, listed after the items, and all
getScreentip, getShowImage, getShowLabel, buttons appear at the bottom
getSize,getSupertip, getVisible, id, idMso, idQ, of the gallery.
image, imageMso, insertAfterMso, insertAfterQ,
onAction, screentip, showImage, showLabel, size,
supertip, tag, visible, Shared with comboBox:
getItemCount, getItemID, getItemImage,
getItemLabel, getItemScreentip, getItemSupertip,
showItemImage, showItemLabel, Shared with
dropDown: getSelectedItemID, getSelectedItem
Index Shared with editBox: sizeString
item A static gallery, id, image, imageMso, label, screentip, supertip None
dropDown, or
comboBox item.
If you specify
static items, you
cannot also specify
dynamic items.

322

22_132302 appb.qxp 7/27/07 9:52 PM Page 323

XML Basic Controls (continued)

labelControl Use to create a enabled, getEnabled, getLabel, getScreentip, None
label control. getShowLabel, getSupertip, getVisible, id, idMso,
idQ, insertAfterMso, insertAfterQ, insertBeforeMso,
insertBeforeQ, label, screentip, showLabel, supertip,
tag, visible
menu Use to create a description, enabled, getDescription, getEnabled, button, checkBox,
menu control. getImage, getImageMso, getKeytip, getLabel, control, dynamicMenu,
getScreentip, getShowImage, getShowLabel, getSize, gallery, menu,
getSupertip, getVisible, id, idMso, idQ, image, menuSeparator,
imageMso, insertAfterMso, insertAfterQ, splitButton,
insertBeforeMso, insertBeforeQ, keytip, label, toggleButton
screentip, showImage, showLabel, size, supertip,
tag, visible
menu Use to create a id, idQ, insertAfterMso, insertAfterQ, None
Separator separator line insertBeforeMso, insertBeforeQ
(which can
optionally include
a text label)
between menu
items.
separator Use to create a getVisible, id, idQ, insertAfterMso, insertAfterQ, None
separator line insertBeforeMso, insertBeforeQ, visible
between controls.
splitButton Use to create a enabled, getEnabled, getKeytip, getShowLabel, button or toggleButton
split button getSize, getSupertip, getVisible, id, idMso, idQ, (required, only one
control. insertAfterMso, insertAfterQ, insertBeforeMso, permitted, and must
insertBeforeQ, keytip, showLabel (determines appear before the
whether the button or toggle button control menu): The main button
displays its label), size, supertip, tag, visible for the split button
control menu (required,
and only one permitted):
The menu of a split
button control.
toggleButton Use to create a description, enabled, getDescription, getEnabled, None
toggle button getImage, getImageMso, getKeytip, getLabel,
control. getPressed, getScreentip, getShowImage,
getShowLabel, getSize, getSupertip, getVisible,
id, idMso, idQ, image, imageMso, insertAfterMso,
keytip, label, onAction, screentip, showImage,
showLabel, size, supertip, tag, visible

continued ➔ 323

22_132302 appb.qxp 7/27/07 9:52 PM Page 324

Attributes and Methods of Ribbon Controls
The following tables list the attributes and methods related to
specific ribbon controls.

CONTROL ATTRIBUTE OR METHOD TYPE OR ACTION DESCRIPTION
customUI xmlns String You must set xmlns to http://schemas.microsoft.com/
office/2006/01/customui
customUI onLoad callback As the Ribbon load passes a Ribbon parameter to the
callback procedure. This enables the associated code
to store a reference to the Ribbon for later use.
customUI loadImage callback Use to create a procedure to load all of the images
required by the Ribbon.

CONTROL ATTRIBUTE VALUES DESCRIPTION
ribbon startFromScratch True, False, 1, 0 Set to True, to hide built-in Ribbon tabs and display a minimal
File menu.

box boxStyle Horizontal, Vertical Sets the flow of the controls inside a box.

CONTROL ATTRIBUTE TYPE OR ACTION DESCRIPTION
checkBox getPressed callback Use to specify whether the checkBox control is pressed.

CONTROL METHOD ATTRIBUTE OR DESCRIPTION
METHOD
comboBox getItemCount callback Returns the number of items in a comboBox.
comboBox getItemID callback Returns the ID of for the item.
comboBox getItemImage callback Returns the image for the item.
comboBox getItemLabel callback Returns the label of for the item.
comboBox getItemScreentip callback Returns the ScreenTip of for the item.
comboBox getItemSupertip callback Returns the Enhanced ScreenTip for the item.
comboBox showItemImage True, False, 1, 0 Specifies whether to display the item image.

CONTROL METHOD ACTION DESCRIPTION
dropdown getSelectedItemID callback Asks for the item that should be selected by ID. Specify either this
attribute or the getSelectedItemIndex attribute, but not both.
dropdown getSelectedItemIndex callback Asks for the item that should be selected by index. Specify either
this attribute or the getSelectedItemId attribute, but not both.
dropdown showItemLabel True, False, 1, 0 Indicates whether items should display labels.

324

22_132302 appb.qxp 7/27/07 9:52 PM Page 325

Attributes and Methods of Ribbon Controls (continued)

CONTROL METHOD ACTION DESCRIPTION
dynamicMenu getContent callback Returns an XML string that contains the contents of the
dynamic menu.

CONTROL ATTRIBUTE TYPE OR DESCRIPTION
OR METHOD ACTION
editBox getText callback Returns the text that displays in the edit box.
editBox maxLength Integer The maximum number of characters that a user can type in a
edit box.
editBox onChange callback Called when the value in the edit box changes.
editBox sizeString String A string, such as “wwwwwwwwww”. Determines the size of an
edit box.

OR METHOD ACTION
gallery columns Integer The number of columns in a gallery.
gallery getItemHeight callback Requests the height of items, in pixels.
gallery getItemWidth callback Requests the width of items, in pixels.
gallery itemHeight Integer The height of items, in pixels.
gallery itemWidth Integer The width of items, in pixels.
gallery rows Integer The number of rows in a gallery.

menu itemSize Normal, The size of an item. The Description property shows for Large
Large menu items.

ACTION
menuSeparator title String The text for this separator.
menuSeparator getTitle callback Callback for this separator’s text.

ACTION
toggleButton getPressed callback Enables you to specify whether the toggle button control is
pressed.

continued ➔ 325

22_132302 appb.qxp 7/27/07 9:52 PM Page 326

Callbacks
The following table lists all of the callbacks used by RibbonX.

CONTROL CALLBACK NAME SIGNATURES
(several controls) getDescription Sub GetDescription (control As IRibbonControl, ByRef description)
(several controls) getEnabled Sub GetEnabled (control As IRibbonControl, ByRef enabled)
(several controls) getImage Sub GetImage (control As IRibbonControl, ByRef image)
(several controls) getImageMso Sub GetImageMso (control As IRibbonControl, ByRef imageMso)
(several controls) getLabel Sub GetLabel (control As IRibbonControl, ByRef label)
(several controls) getKeytip Sub GetKeytip (control As IRibbonControl, ByRef label)
(several controls) getSize Sub GetSize (control As IRibbonControl, ByRef size)
(several controls) getScreentip Sub GetScreentip (control As IRibbonControl, ByRef screentip)
(several controls) getSupertip Sub GetSupertip (control As IRibbonControl, ByRef screentip)
(several controls) getVisible Sub GetVisible (control As IRibbonControl, ByRef visible)
button getShowImage Sub GetShowImage (control As IRibbonControl, ByRef showImage)
button getShowLabel Sub GetShowLabel (control As IRibbonControl, ByRef showLabel)
button onAction – repurposed Sub OnAction (control As IRibbonControl, byRef CancelDefault)
button onAction Sub OnAction (control As IRibbonControl)
checkBox getPressed Sub GetPressed (control As IRibbonControl, ByRef returnValue)
checkBox onAction Sub OnAction (control As IRibbonControl, pressed As
Boolean)(pvarfPressed)
comboBox getItemCount Sub GetItemCount (control As IRibbonControl, ByRef count)
comboBox getItemID Sub GetItemID (control As IRibbonControl, index As Integer, ByRef id)
comboBox getItemImage Sub GetItemImage (control As IRibbonControl, index As Integer, ByRef
image)
comboBox getItemLabel Sub GetItemLabel (control As IRibbonControl, index As Integer, ByRef label)
comboBox getItemScreenTip Sub GetItemScreenTip (control As IRibbonControl, index As Integer, ByRef
screentip)
comboBox getItemSuperTip Sub GetItemSuperTip (control As IRibbonControl, index As Integer, ByRef
supertip)
comboBox getText Sub GetText (control As IRibbonControl, ByRef text)
comboBox onChange Sub OnChange (control As IRibbonControl, text As String)
customUI loadImage Sub LoadImage (imageId As string, ByRef image)
customUI onLoad Sub OnLoad (ribbon As IRibbonUI)
dropDown getItemCount Sub GetItemCount (control As IRibbonControl, ByRef count)

326

22_132302 appb.qxp 7/27/07 9:52 PM Page 327

Callbacks (continued)

CONTROL CALLBACK NAME SIGNATURES
dropDown getItemID Sub GetItemID (control As IRibbonControl, index As Integer,
ByRef id)
dropDown getItemImage Sub GetItemImage (control As IRibbonControl, index As Integer,
ByRef image)
dropDown getItemLabel Sub GetItemLabel (control As IRibbonControl, index As Integer,
ByRef label)
dropDown getItemScreenTip Sub GetItemScreenTip (control As IRibbonControl, index As
Integer, ByRef screenTip)
dropDown getItemSuperTip Sub GetItemSuperTip (control As IRibbonControl, index As Integer,
ByRef superTip)
dropDown getSelectedItemID Sub GetSelectedItemID (control As IRibbonControl, ByRef index)
dropDown getSelectedItemIndex Sub GetSelectedItemIndex (control As IRibbonControl, ByRef index)
dropDown onAction Sub OnAction (control As IRibbonControl, selectedId As String,
selectedIndex As Integer)
dynamicMenu getContent Sub GetContent (control As IRibbonControl, ByRef content)
editBox getText Sub GetText (control As IRibbonControl, ByRef text)
editBox onChange Sub OnChange (control As IRibbonControl, text As String)
gallery getItemCount Sub GetItemCount (control As IRibbonControl, ByRef count)
gallery getItemHeight Sub getItemHeight (control As IRibbonControl, ByRef height)
gallery getItemID Sub GetItemID (control As IRibbonControl, index As Integer,
ByRef id)
gallery getItemImage Sub GetItemImage (control As IRibbonControl, index As Integer,
ByRef image)
gallery getItemLabel Sub GetItemLabel (control As IRibbonControl, index As Integer,
ByRef label)
gallery getItemScreenTip Sub GetItemScreenTip (control As IRibbonControl, index as Integer,
ByRef screen)
gallery getItemSuperTip Sub GetItemSuperTip (control As IRibbonControl, index as Integer,
ByRef screen)
gallery getItemWidth Sub getItemWidth (control As IRibbonControl, ByRef width)
gallery getSelectedItemID Sub GetSelectedItemID (control As IRibbonControl, ByRef index)
gallery getSelectedItemIndex Sub GetSelectedItemIndex (control As IRibbonControl, ByRef index)
gallery onAction Sub OnAction (control As IRibbonControl, selectedId As String,
selectedIndex As Integer)
menuSeparator getTitle Sub GetTitle (control As IRibbonControl, ByRef title)
toggleButton getPressed Sub GetPressed (control As IRibbonControl, ByRef returnValue)
toggleButton onAction Sub OnAction (control As IRibbonControl, pressed As Boolean,
byRef cancelDefault)
toggleButton onAction Sub OnAction (control As IRibbonControl, pressed As Boolean)

continued ➔ 327

22_132302 appb.qxp 7/27/07 9:52 PM Page 328

Attributes
The following table lists all of the Ribbon attributes used by
RibbonX.

ATTRIBUTE TYPE OR DESCRIPTION
VALUE
description String When the itemSize attribute is set to large, sets the description text that displays in
menus.
enabled true, false, Enables controls.
0, 1
getContent callback Retrieves XML content that describes the menu. Used with a dynamic menu.
getDescription callback Returns the control description.
getEnabled callback Returns the control enabled state.
getImage callback Returns the image.
getImageMso callback Uses a control ID to returns a built-in control icon.
getItemCount callback Returns the number of items in a combo box, drop-down list, or gallery.
getItemID callback Returns the ID for a specific item in a combo box, drop-down list, or gallery.
getItemImage callback Returns the image for a specific item in a combo box, drop-down list, or gallery.
getItemLabel callback Returns the label for a specific item in a combo box, drop-down list, or gallery.
getItemScreentip callback Returns the ScreenTip for a specific item in a combo box, drop-down list, or gallery.
getItemSupertip callback Returns the Enhanced ScreenTip for a specific item in a combo box, drop-down list,
or gallery.
getKeytip callback Returns the KeyTip.
getLabel callback Returns the label.
getPressed callback When used with a toggle button, gets a value that indicates whether the state is
pressed or not pressed. When used with a checkbox, gets a value that indicates
whether the state is selected or cleared.
getScreentip callback Returns the ScreenTip.
getSelectedItemID callback For a drop-down list or gallery, gets the ID of the selected item.
getSelectedItemIndex callback For a drop-down list or gallery, gets the index of the selected item.
getShowImage callback Returns a value that sets whether to display the control image.
getShowLabel callback Returns a value that sets whether to display the control label.
getSize callback Returns a value that sets the size of a control (normal or large).
getSupertip callback Returns a value that sets the Enhanced ScreenTip for a control.
getText callback For a text box or edit box, gets the text to display in the edit portion of the control.

328

22_132302 appb.qxp 7/27/07 9:52 PM Page 329

Attributes (continued)

ATTRIBUTE TYPE OR DESCRIPTION
VALUE
getTitle callback For a menu separator, sets the text to display (rather than a horizontal line).
getVisible callback Returns the value that determines whether the control is visible.
id String A user-defined unique identifier for a control. If you define an id, do not
assign an idMso or an idQ.
idMso control id Built-in control ID. If you define an idMso, do not assign an id or an idQ.
idQ qualified id Qualified control ID, prefixed with a namespace identifier. If you define an
idQ, do not assign an idMso or an id.
image String Sets the image for a control.
imageMso control id Sets the identifier for a built-in image.
insertAfterMso control id Specifes the identifier for the built-in control after which the control is
positioned.
insertAfterQ qualified id Specifies the identifier of a qualified control (that is, the control whose idQ
property was specified) after which the control is positioned.
insertBeforeMso control id Specifies the identifier for the built-in control before the control is positioned.
insertBeforeQ qualified id Specifies the identifier of a qualified control (that is, a control whose idQ
property was specified) before which the control is positioned.
itemSize large, normal Sets the size for the items in the menu.
keytip String Sets the KeyTip for the control. KeyTips display when the user presses the
ALT key plus a letter.
label String Sets the label for the control.
onAction callback Called when the user clicks the control.
onChange callback Called when the user commits text in an edit box or combo box.
screentip String Sets the control’s ScreenTip.
showImage true, false, 0, 1 Specifed whether the control’s image displays.
showItemImage true, false, 0, 1 In a combo box, drop-down list, or gallery, specifies whether each item’s
image shows.
showItemLabel true, false, 0, 1 In a combo box, drop-down list, or gallery, specifies whether to show each
item’s label.
showLabel true, false, 0, 1 Specifies whether the control’s label shows.
size large, normal Sets the size of the control.
sizeString String Sets a string, such as “MMMMM”. The string sets the width of the control.
supertip String Sets the Enhanced ScreenTip for the control. An EnhancedScreenTip is a
longer screen tip.
tag String Sets user-defined text that enables you to store information about the
control that is not pertinent to any other specific property.
title String Used with a menu separator. Sets the text displayed (rather than a
horizontal line).
visible true, false, 0, 1 Determines whether the control is visible.

329

Vba functions

More Related Content

What's hot

Similar to Vba functions

Recently uploaded

Vba functions