Professional User Interface Suite, Copyright FOSS Software Inc. Help Published with Permission.

Properties

AutoChangeID Gets/sets whether the toolbar button corresponding to this command automatically changes its active command identifier. This property only makes sense if the button has a set of subcommands (e.g., the Font Color button in Microsoft Word). If it is set to true, the active command identifier of the toolbar button always corresponds to the subcommand that was executed the last time. If it is set to false, the active command identifier is left intact.
Check Gets/sets whether the check box next to the command text in the menu is displayed and the toolbar button is highlighted. NOTE: If the property set to true and the command has an image, the image next to the command text in the menu is highlighted instead.
ColorIconShapeType Gets/sets how the color picker's icon looks like. The property only makes sense if the CommandType property is set to eCtColorPicker, which is equal to 4.
ComboItemsCount Returns the number of items in the combo box.
CommandID Returns a unique command identifier which is in the range of 0 to 65535.
CommandType Gets/sets the command type.
CurrentColor Gets/sets the color value. The property affects the icons of all the color picker buttons with this command assigned as basic.
CustomColorButtonCaption Gets/sets the caption for the Custom Color button on the color picker's popup menu.
DefaultColor Gets/sets the default color for the command. This color is set in the color picker when the Default Color button on the color picker's popup menu is clicked.
DefaultColorButtonCaption Gets/sets the caption for the Default Color button on the color picker's popup menu.
DisableHiding Gets/sets whether the toolbar buttons corresponding to this command are enabled in the Quick Customize menu.
Enabled Gets/sets whether the command is enabled.
FieldIsNotEditable Gets/sets whether the text/combo field is not editable.
FieldIsResizable Gets/sets whether the text/combo field is resizable in the customize mode.
FieldText Gets/sets the string that is displayed in the text/combo field.
HasCustomColorButton Gets/sets whether the Custom Color button is displayed on the color picker's popup menu.
HasDefaultColorButton Gets/sets whether the Default Color button is displayed on the color picker's popup menu.
HasImage Gets whether the command is assigned an icon.
IsToolbarCommand Gets whether the command is used to show/hide a toolbar.
Name Gets/sets an internal unique name of the command which can be used to access the command object in the command collection. An attempt to set a non-unique name to the command may fail or raise an exception. If you have not specified the command name when adding a command to the collection (e.g., by using AutoWindow.Commands.Add (0) instead of AutoWindow.Commands.Add ("String Command Name")), the command name the text contains the text representation of the command identifier.
PersistentImage Gets/sets whether the image assigned to the command can be modified and reset in the customize mode.
QuickCustomizable Gets/sets whether the toolbar buttons corresponding to this command are displayed in the Quick Customize menu
Radio Gets/sets whether the radio-mark next to the command text in the menu is displayed and the toolbar button is highlighted. NOTE: If the property set to true and the command has an image, the image next to the command text in the menu is highlighted instead.
ScrollbarBtnHorzWidth Gets/sets the width of the left/right scroll button in the horizontal scroll bar control. If it is set to zero, the horizontal slider control is used instead of scroll bar.
ScrollbarBtnVertHeight Gets/sets the height of the up/down scroll button in the vertical scroll bar control. If it is set to zero, the vertical slider control is used instead of scroll bar.
ScrollbarCtrlHorzWidth Gets/sets the width of the horizontal scroll bar/slider control.
ScrollbarCtrlVertHeight Gets/sets the height of the vertical scroll bar/slider control.
ScrollingPageSize Gets/sets the scrolling page size.
ScrollingPosition Gets/sets the scrolling position.
ScrollingRange Gets/sets the scrolling range.
SeparatedDropDown Gets/sets whether the button associated with the command is divided into two parts. Clicking the second part labeled with a down arrow generates a popup menu with subcommands (like the Font Color button in Microsoft Word). This property only makes sense when the button has a non-empty collection of child buttons.
StatusTipText Gets/sets the short info text about the command which is displayed in pane 0 of the status bar.
TextInMenu Gets/sets the text that is used in the menu items associated with the command.
TextInToolbar Gets/sets the text that is used in the toolbar buttons associated with the command.
Toolbar Gets the toolbar which is shown/hidden with this command.
TooltipText Gets/sets the text for tooltips displayed when the mouse pointer is over the toolbar buttons associated with the command.
VlNoRotate Gets/sets whether the command item in the vertically docked toolbar has the same look as in the horizontally docked toolbar.
VlVisibleControl Gets/sets whether the command items are visible in vertically docked toolbars.

Classes

AssignImageFromCommand Copies the image associated with another command and assigns the copy to the command.
AssignImageFromStatusBarItem Copies the image associated with a status pane object and assigns the copy to the command.
ComboItemGetAt Gets a string with the specified index from the combo box.
ComboItemInsertAt Inserts one or more string items into the combo box.
ComboItemRemoveAll Removes all string items from the combo box.
ComboItemRemoveAt Removes one or more string items from the combo box.
ComboItemSetAt Replaces a string at the specified position in the combo box with a new string.
FireEvent_OnColor Notifies consumers that the current color is changed.
FireEvent_OnCommand Notifies consumers that the command button is clicked.
FireEvent_OnContextHelp Notifies consumers about the context help event.
FireEvent_OnScroll Notifies consumers that the scrolling position is changed.
FireEvent_OnTextChanged Notifies consumers that the contents of the text field is changed.
LoadBitmapFile Loads an image from the bitmap file, assigns it to the command and gets true if it succeeded. Set x, y, dx, and dy arguments to zero, if you want to display the entire bitmap image; otherwise, only specified part of the bitmap is extracted and used as the command image.
LoadBitmapFromStream Loads a bitmap image from the OLE stream object, assigns it to the command, and gets true if it succeeded. Set x, y, dx, and dy arguments to zero, if you want to display the entire bitmap image; otherwise, only specified part of the bitmap is extracted and used as the command image.
LoadIconFile Loads an image from the icon file, assigns it to the command, and gets true if it succeeded. Set dx and dy arguments to zero, if you want to load the icon of the default size, which is 16x16.
LoadIconFromModule Loads an icon from the DLL or EXE module, assigns it to the command, and gets true if it succeeded.
LoadImageFile Loads an image from the file, assigns it to the command, and gets true if it succeeded. The image file contains one copy of the device independent image with transparent areas and is formatted internally to the Professional User Interface Suite, Copyright FOSS Software Inc. Help Published with Permission. library
LoadImageFromStream Loads an image from the OLE stream object, assigns it to the command, and gets true if it succeeded. The image file contains one copy of the device independent image with transparent areas and is formatted internally to the Professional User Interface Suite library.
PostEvent_OnCommand Posts the command button click event. The method returns the execution control immediately. The event message is delivered when the application reaches the idle state.
RemoveImage Removes the image from the command.
ResetAllButtons Resets all command buttons in all toolbars and popup menus.
SaveBitmapFile Saves the image bitmap associated with the command to the .bmp file and returns true if it succeeded.
SaveBitmapToStream Saves the image bitmap associated with the command to the OLE stream object and returns -1 if an error occurred or a color value that specifies the transparent color.
SaveImageFile Saves the image associated with the command to the file and returns true if it succeeded. The image file contains one copy of the device independent image with transparent areas and is formatted internally to the Professional User Interface Suite, Copyright FOSS Software Inc. Help Published with Permission. library.
SaveImageToStream Saves the image associated with the command to the OLE stream object and returns true if it succeeded. The image file contains one copy of the device independent image with transparent areas and is formatted internally to the Professional User Interface Suite, Copyright FOSS Software Inc. Help Published with Permission. library.

See Also

IExtAutoCommand Overview | Interface Diagram