RibbonItemInfo() function - 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

Purpose

Returns a property value of a collection item under a control. You can call this function from the MapBasic window in MapInfo Pro.

Syntax

RibbonItemInfo( control_name, collection_name, { item_name | item_index }, property_name, 
	[ ribbon_windowid ] ) 

control_name is the unique name specified when creating the control, or the name of a built-in control. See RibbonControls.def for a list of built-in control names. It is a string expression, and the name property is case sensitive. It must start with a letter or underscore and can contain numbers, letters and underscores. If the control is added by another MBX or using .NET, python or mapbasic function calls, the name will not be found and will cause an error. Only built-in controls and controls added by an MBX via MapBasic statements can be found this way.

collection_name is a string specifying the name collection item under the control.

item_name is an optional parameter specifying the name of an item in the collection.

item_index is an optional parameter specifying the position/index of an item in the collection.

property_name is the name of a property for the specified control. The properties vary based on the type of the control being queried.

ribbon_windowid is an optional parameter that specifies the numeric id of the ribbon window. If this parameter is not passed, the main ribbon window is taken.

Return Value

Property

Note: Refer Ribbon Token and Property Mappings to see which ribbon token sets the corresponding ribbon property. You can access these properties using the RibbonInfo() and the RibbonItemInfo() functions.

Example

RibbonItemInfo(PRO_RIBBON, PROPERTY_TABS , 1, PROPERTY_CAPTION)