Ribbon Control Definitions - MapBasic - 2023

MapInfo MapBasic Reference

Product type
Software
Portfolio
Locate
Product family
MapInfo
Product
MapInfo > MapBasic
Version
2023
Language
English
Product name
MapBasic
Title
MapInfo MapBasic Reference
First publish date
1985
Last updated
2023-09-12
Published on
2023-09-12T16:32:32.686312

The tables below shows only the ribbon control definitions relevant to the Create and Set Ribbon statements. For a complete list, see the The RibbonControls.DEF File.

Ribbon Properties

Define PRO_RIBBON "MainRibbon" ‘control name to get ribbon itself
Define PROPERTY_ACTIVETAB "ActiveTab" 'string
Define PROPERTY_TABCOUNT "Tabs.Count" 'integer
Define PROPERTY_TABS "Tabs" ‘Collection
Define PROPERTY_CONTEXTTABGROUPSCOUNT "ContextualTabGroups.Count" 'integer
Define PROPERTY_CONTEXTTABGROUPS "ContextualTabGroups" ‘Collection

RibbonTab Properties

'Defines for standard Ribbon TAB and Contextual Tab (CTAB) names.
DEFINE TAB_PRO "Backstage"
DEFINE TAB_HOME "TabHome"
DEFINE TAB_MAP "TabMap"
DEFINE TAB_TABLE "TabTable"
DEFINE TAB_SPATIAL "TabSpatial"
DEFINE TAB_LAYOUT "TabLayout"
DEFINE TAB_LEGACY "TabLegacy"

Contextual Tab Groups and Context Tabs

DEFINE CTAB_GRP_LAYER_TOOLS "LayerTools"
DEFINE CTAB_THEME "TabTheme"
DEFINE CTAB_LAYER_STYLES "TabLayerStyle"
DEFINE CTAB_LAYER_LABELS "TabLayerLabeling"
DEFINE CTAB_GRP_LEGEND_TOOLS "LegendTools"
DEFINE CTAB_LEGEND "TabLegend"
DEFINE CTAB_GRP_GRIDLINE "GridLineContextTabGroup"
DEFINE CTAB_GRIDLINES "TabGridlines"

IRibbon Control Property Names

Define PROPERTY_ACTIVETAB "ActiveTab" 'string
Define PROPERTY_TABCOUNT "Tabs.Count" 'integer
Define PROPERTY_TABS "Tabs" 'collection
Define PROPERTY_CONTEXTTABGROUPSCOUNT "ContextualTabGroups.Count" 'integer
Define PROPERTY_CONTEXTTABGROUPS "ContextualTabGroups" 'collection

COMMON PROPERTY NAMES

Define PROPERTY_COUNT "Count" 'integer
Define PROPERTY_ENABLED "Enabled" 'logical
Define PROPERTY_NAME "Name" 'string
Define PROPERTY_FULLNAME "FullName" 'string - returns full name of control with namespace
Define PROPERTY_TOOLTIP "ToolTip" 'string
Define PROPERTY_VISIBLE "Visible" 'logical
Define PROPERTY_PLACEMENT "Placement" 'PlacementMode enum
Define PROPERTY_HORIZONTALOFFSET "HorizontalOffset" 'float
Define PROPERTY_VERTICALOFFSET "VerticalOffset" 'float
Define PROPERTY_PROPERTIES "Properties" 'string - returns a properties clause with all properties of the control
Define PROPERTY_DESCRIPTION "Description" 'string
Define PROPERTY_IMAGE "Image" 'string

IRibbon Item

Define PROPERTY_CAPTION "Caption" 'string
Define PROPERTY_KEYTIP "KeyTip" 'string

IMapInfoControl Common properties

Define PROPERTY_CONTROLID "ControlId" 'integer
Define PROPERTY_CONTROLTYPE "ControlType" 'string: Enum ControlType
Define PROPERTY_ACTUALHEIGHT "ActualHeight" 'float- Actual Height
Define PROPERTY_ACTUALWIDTH "ActualWidth" 'float- Actual Width
Define PROPERTY_BOTTOMBORDER "BottomBorderThickness" 'float
Define PROPERTY_BOTTOMMARGIN "BottomMargin" 'float
Define PROPERTY_BOTTOMPADDING "BottomPadding" 'float
Define PROPERTY_HEIGHT "Height" 'float- suggested Height
Define PROPERTY_HORIZ_ALIGN "HorizontalAlignment" 'integer
Define PROPERTY_HORIZ_CONTENT_ALIGN "HorizontalContentAlignment" 'integer
Define PROPERTY_AUTOSIZEFORMENABLED "IsAutoSizeFormEnabled" 'logical
Define PROPERTY_ISQATITEM "IsQatItem" 'logical
Define PROPERTY_KEYWORDS "Keywords" 'string comma separated
Define PROPERTY_LEFTBORDER "LeftBorderThickness" 'float
Define PROPERTY_LEFTMARGIN "LeftMargin" 'float
Define PROPERTY_LEFTPADDING "LeftPadding" 'float
Define PROPERTY_RIGHTBORDER "RightBorderThickness" 'float
Define PROPERTY_RIGHTMARGIN "RightMargin" 'float
Define PROPERTY_RIGHTPADDING "RightPadding" 'float
Define PROPERTY_SCREENCOORDS "ScreenCoordinates"
'Point type - see IMapInfoPro.def
Define PROPERTY_SHOWINMORECOMMANDS "ShowInMoreCommands" 'logical
Define PROPERTY_TAG "Tag" 'string
Define PROPERTY_TOPBORDER "TopBorderThickness" 'float
Define PROPERTY_TOPMARGIN "TopMargin" 'float
Define PROPERTY_TOPPADDING "TopPadding" 'float
Define PROPERTY_VERT_ALIGN "VerticalAlignment" 'integer
Define PROPERTY_VERT_CONTENT_ALIGN "VerticalContentAlignment" 'integer
Define PROPERTY_WIDTH "Width" 'integer - suggested width

IControlGroup

Define PROPERTY_CONTROLS "Controls" 'collection
Define PROPERTY_CONTROLCOUNT "Controls.Count" 'integer
Define PROPERTY_CALLINGHANDLER "CallingHandler" 'string
Define PROPERTY_LAUNCHER_COMMAND "LauncherCommand"
Define PROPERTY_LAUNCHER_COMMANDID "LauncherCommandId" 'smallint
Define PROPERTY_COMMANDID "CommandId" 'integer

IImageControl

Define PROPERTY_ISEXTRASMALL "IsExtraSmall" 'logical
Define PROPERTY_ISLARGE "IsLarge" 'logical
Define PROPERTY_LARGEICON "LargeIcon" 'string Uri see Image defines below
Define PROPERTY_SMALLICON "SmallIcon" 'string Uri see Image defines below

IRibbonTab

Define PROPERTY_ISSELECTED "IsSelected" 'logical, also for Toggle button state
Define PROPERTY_GROUPS "Groups" 'collection
Define PROPERTY_GROUPCOUNT "Groups.Count" 'integer
Define PROPERTY_ISTRACKED "IsTracked" 'logical

IRibbonToolTip

Define PROPERTY_SHOWHELPTEXT "ShowHelpText" 'logical
Define PROPERTY_SHOWSIMPLETOOLTIP "ShowSimpleToolTip" 'logical
Define PROPERTY_SHOWONDISABLED "ShowOnDisabled" 'logical
Define PROPERTY_TOOLTIPDESCRIPTION "ToolTipDescription" 'string
Define PROPERTY_TOOLTIPDISABLEDTEXT "ToolTipDisabledText" 'string
Define PROPERTY_TOOLTIPTEXT "ToolTipText" 'string

'IRibbonControlGroup

Define PROPERTY_COLLAPSEDIMAGE "CollapsedImage" 'string
Define PROPERTY_ISLAUNCHERVISIBLE "IsLauncherVisible" 'logical
Define PROPERTY_LAUNCHER_COMMANDPARAMETER "LauncherCommandParameter" 'any
Define PROPERTY_LAUNCHER_TOOLTIP "LauncherToolTip" 'string

IRibbonContextualTabGroup

Define PROPERTY_BACKCOLOR "BackColor" 'integer/string can set from Known Color names, returns an ARGB integer
Define PROPERTY_BACKCOLORARGB "BackColorArgb" 'integer

IRibbonButtonControl

Define PROPERTY_KEYGESTURE "KeyGesture" 'string (eg: "Ctrl+Shift+R")
Define PROPERTY_ISTOGGLE "IsToggle" 'logical

IRibbonToolButtonControl

Define PROPERTY_BMODIFIERKEYS "BModifierKeys" 'logical
Define PROPERTY_CURSOR "Cursor" 'string
Define PROPERTY_CURSORID "CursorID" 'Integer
Define PROPERTY_DRAWMODE "DrawMode" 'Integer
Define PROPERTY_TOOLBUTTONID "ToolButtonID" 'Integer

IRibbonGalleryControl

Define PROPERTY_BORDERBRUSH "BorderBrush" 'string - set only
Define PROPERTY_EXPANDHEIGHT "ExpandHeight" 'float
Define PROPERTY_EXPANDWIDTH "ExpandWidth" 'float
Define PROPERTY_INLINE "InLine" 'logical
Define PROPERTY_FILTERS "Filters" 'string
Define PROPERTY_ITEMHEIGHT "ItemHeight" 'integer
Define PROPERTY_ITEMWIDTH "ItemWidth" 'integer
Define PROPERTY_MANIPULATEENABLED "IsManipulationEnabled" 'logical
Define PROPERTY_MENUICONBARENABLED "IsMenuIconBarEnabled" 'logical
Define PROPERTY_MENUITEMS "MenuItems" 'collection of gallery menuitems
Define PROPERTY_MENUITEMCOUNT "MenuItems.Count" 'count of collection of gallery

IRibbonGalleryItem

Define PROPERTY_ORIENTATION "Orientation" 'string Vertical or Horizontal
Define PROPERTY_CHECKONCLICK "CheckOnClick" 'logical
Define PROPERTY_CTRLSVISIBLEMOUSEHOVER "ControlsVisibleOnMouseHover" 'logical
Define PROPERTY_ICONHEIGHT "IconHeight" 'float
Define PROPERTY_ICONWIDTH "IconWidth" 'float
Define PROPERTY_TEXTHEIGHT "TextHeight" 'float
Define PROPERTY_TEXTWIDTH "TextWidth" 'float
Define PROPERTY_TEXTTRIMMING "TextTrimming" 'integer see enums.def
Define PROPERTY_TEXTWRAPPING "TextWrapping" 'integer see enums.def

IRibbonGalleryGroup

Define PROPERTY_FILTERINDEX "FilterIndex" 'string semi-colon delimited.

IribbonSplitControl

Define PROPERTY_REMEMBERLASTCMD "RememberLastCommand" 'logical

IRibbonMenuItemControl

Define PROPERTY_ISCHECKABLE "IsCheckable" 'logical
Define PROPERTY_ISCHECKED "IsChecked" 'logical - radiobutton & checkbox
Define PROPERTY_ICONENABLED "IsIconEnabled" 'logical

IRibbonRadioButton

Define PROPERTY_GROUPNAME $"GroupName" 'string

ITextBlock

Define PROPERTY_FONTFAMILY "FontFamily" 'string (e.g., Segoe UI)
Define PROPERTY_FONTSIZE "FontSize" 'string
Define PROPERTY_FONTSTYLE "FontStyle" 'string (e.g., Normal, Italic, Oblique)
Define PROPERTY_FONTWEIGHT "FontWeight" 'string (e.g., Heavy, Normal, Thin, Bold)

Ribbon Control Types

Define CTRL_TYPE_BUTTON "Button" '1 - See ControlType Enum
Define CTRL_TYPE_TOOLBUTTON "ToolButton" '2
Define CTRL_TYPE_RIBBON_MENU_ITEM "RibbonMenuItem" '3
Define CTRL_TYPE_RIBBON_BUTTON_PANEL "ButtonPanel" '4
Define CTRL_TYPE_RIBBON_SEPARATOR "RibbonSeparator" '5
Define CTRL_TYPE_CONTEXT_MENU_ITEM "ContextMenuItem" '6
Define CTRL_TYPE_CONTEXT_MENU_SEPARATOR "ContextMenuSeparator" '7
Define CTRL_TYPE_MENU_SEPARATOR "MenuSeparator" '8
Define CTRL_TYPE_DROPDOWN_BUTTON "DropDownButton" '9
Define CTRL_TYPE_SPLIT_BUTTON "SplitButton" '10
Define CTRL_TYPE_DROPDOWN_MENU_GROUP "DropDownMenuGroup" '11
Define CTRL_TYPE_GALLERY_CONTROL "GalleryControl" '12
Define CTRL_TYPE_GALLERY_ITEM "GalleryItem" '13
Define CTRL_TYPE_GALLERY_GROUP "GalleryGroup" '14
Define CTRL_TYPE_CUSTOM "CustomControl" '15
Define CTRL_TYPE_TEXTBLOCK "TextBlock" '16
Define CTRL_TYPE_IMAGE "Image" '17
Define CTRL_TYPE_BACKSTAGE_TAB_ITEM "BackStageTabItem" '18
Define CTRL_TYPE_BACKSTAGE_BUTTON "BackStageButton" '19
Define CTRL_TYPE_BACKSTAGE_TAB_SECTION "BackStageTabSection" '20
Define CTRL_TYPE_BACKSTAGE_SEPARATOR "BackStageSeparator" '21
Define CTRL_TYPE_STACK_PANEL "StackPanel" '22
Define CTRL_TYPE_CHECKBOX "CheckBox" '23
Define CTRL_TYPE_RADIO_BUTTON "RadioButton" '24
Define CTRL_TYPE_WRAP_PANEL "WrapPanel" '25
Define CTRL_TYPE_MENU_GROUP "RibbonMenuGroup" '26
Define CTRL_TYPE_UNKNOWN "Unknown" '27
Define CTRL_TYPE_CONTEXTTABGROUP "ContextualTabGroup" '28
Define CTRL_TYPE_RIBBON "Ribbon" '29
Define CTRL_TYPE_RIBBONTAB "RibbonTab" '30
Define CTRL_TYPE_RIBBONGROUP "RibbonGroup" '31
Define CTRL_TYPE_RIBBONBACKSTAGE "RibbonBackStage" '32
Define CTRL_TYPE_STATUSBAR "StatusBar" '33
Define CTRL_TYPE_GRID "Grid" '34