Welcome
Expand Getting StartedGetting Started
Expand SOLIDWORKS API HelpSOLIDWORKS API Help
Collapse SOLIDWORKS Electrical API HelpSOLIDWORKS Electrical API Help
Expand Getting StartedGetting Started
Expand Add a Custom CommandAdd a Custom Command
Expand Add an Add-inAdd an Add-in
Expand Release NotesRelease Notes
Expand SampleSample
Collapse ClassesClasses
Expand Class ListClass List
Class Index
Collapse Class HierarchyClass Hierarchy
Collapse IDispatchIDispatch
IEwAPIX
IEwAddIn
IEwAddinInternalX
IEwApplicationSettingsX
IEwApplicationX
IEwArchiveEnvironmentX
IEwCableCoreX
IEwCableReferenceManagerX
IEwCaptionBarControlX
IEwCaptionBarX
IEwClassificationManagerX
IEwCommandContextX
IEwCommandManagerX
IEwCommandX
IEwDialogAlignPartsParametersSelectorX
IEwDialogLocationSelectorX
IEwDialogMacroSelectorX
IEwDialogManufacturerPartOrderingX
IEwDialogManufacturerPartSelectorX
IEwDialogProgressX
IEwDialogProjectManagerX
IEwDialogResumeX
IEwDialogSummaryX
IEwDialogTaskX
IEwDockingPaneManagerX
IEwDockingPaneX
IEwDocumentManagerX
IEwDocumentX
IEwEnvironmentX
IEwLibraryManagerX
IEwLockStringX
IEwManagerDialogX
IEwManufacturerPartCircuitX
IEwManufacturerPartManagerX
IEwManufacturerPartTerminalX
IEwMenuItemX
IEwMenuManagerX
IEwMenuX
IEwNotificationDialogX
Expand IEwObjectDispatchXIEwObjectDispatchX
IEwPointX
IEwProjectAutomaticArrowsX
IEwProjectBookManagerX
IEwProjectCableManagerX
IEwProjectComponentManagerX
IEwProjectEntity3DManagerX
IEwProjectExcelAutomationX
IEwProjectExportDWGFilesX
IEwProjectExportPDFX
IEwProjectExportPDMX
IEwProjectExportReportX
IEwProjectFileConfigurationManagerX
IEwProjectFileConfigurationX
IEwProjectFileManagerX
IEwProjectFolderManagerX
IEwProjectFunctionManagerX
IEwProjectGenerateTSDrawingX
IEwProjectHarnessManagerX
IEwProjectInputOutputManagerX
IEwProjectLocationManagerX
IEwProjectManagerX
IEwProjectManufacturerPartCircuitX
IEwProjectManufacturerPartManagerX
IEwProjectManufacturerPartTerminalX
IEwProjectMultilingualTextFontX
IEwProjectMultilingualTextManagerX
IEwProjectNumberDocumentsX
IEwProjectNumberMarksX
IEwProjectNumberWiresX
IEwProjectOptimizeWireOrderX
IEwProjectPrintConfigManagerX
IEwProjectReportManagerX
IEwProjectSnapshotManagerX
IEwProjectSnapshotX
IEwProjectSymbolManagerX
IEwProjectUpdateReplaceDataX
IEwProjectWireManagerX
IEwProjectWireStyleManagerX
IEwProjectX
IEwResumeRowX
IEwRibbonComboBoxControlX
IEwRibbonControlX
IEwRibbonGroupX
IEwRibbonQuickAccessControlX
IEwRibbonTabX
IEwRibbonX
IEwRightsManagerX
IEwSaveDWGImageX
IEwSelectorDialogX
IEwSymbolCircuitX
IEwSymbolFiltersX
IEwSymbolManagerX
IEwSymbolPointX
IEwTerminalTypeManagerX
IEwTitleBlockManagerX
IEwWireTerminationTypeManagerX
IEwXLSBookX
IEwXLSSheetX
Expand IInteropFactoryXIInteropFactoryX
Expand Class MembersClass Members
Expand SOLIDWORKS PDM Professional API HelpSOLIDWORKS PDM Professional API Help
Expand PDM Pro API Web ServicePDM Pro API Web Service
Expand FeatureWorks API HelpFeatureWorks API Help
Expand SOLIDWORKS Costing API HelpSOLIDWORKS Costing API Help
Expand SOLIDWORKS Document Manager API HelpSOLIDWORKS Document Manager API Help
Expand SOLIDWORKS Inspection API HelpSOLIDWORKS Inspection API Help
Expand SOLIDWORKS Routing API HelpSOLIDWORKS Routing API Help
Expand SOLIDWORKS Simulation API HelpSOLIDWORKS Simulation API Help
Expand SOLIDWORKS Sustainability API HelpSOLIDWORKS Sustainability API Help
Expand SOLIDWORKS Toolbox API HelpSOLIDWORKS Toolbox API Help
Expand SOLIDWORKS Utilities API HelpSOLIDWORKS Utilities API Help
Expand eDrawings API HelpeDrawings API Help
Expand DraftSight API HelpDraftSight API Help
Expand Lisp Programming BasicsLisp Programming Basics
Expand Lisp Functions OverviewLisp Functions Overview
Expand Lisp Functions ReferenceLisp Functions Reference
Expand Visual Lisp Compatible FunctionsVisual Lisp Compatible Functions
Hide Table of Contents
SOLIDWORKS Electrical API 2024.0.0
Electrical API
IEwRibbonTabX Interface Reference

Use this interface to manage the Ribbon tabs. More...

Inheritance diagram for IEwRibbonTabX:
Inheritance graph

Public Member Functions

BSTR getCaption (EwErrorCode *errorCode)
 Return the caption of this tab. More...
 
EwErrorCode setCaption (BSTR strCaption)
 Set a new caption for this tab. More...
 
IEwRibbonGroupX addGroup (BSTR strCaption, EwErrorCode *errorCode)
 Add a new group at the end of the ribbon tab. More...
 
IEwRibbonGroupX insertGroup (BSTR strCaption, int iIndex, EwErrorCode *errorCode)
 Add a new group at the specified index of the ribbon tab. More...
 
IEwRibbonGroupX getGroupAt (int iIndex, EwErrorCode *errorCode)
 Return the specified group of the current tab. More...
 
int getGroupCount (EwErrorCode *errorCode)
 Return the number of group in the current tab. More...
 
EwErrorCode removeGroup (int iIndex)
 Remove a group specified by the index. More...
 
EwErrorCode removeAllGroup ()
 Remove all groups. More...
 
VARIANT_BOOL isVisible (EwErrorCode *errorCode)
 Determine if the tab is visible. More...
 
EwErrorCode setVisible (VARIANT_BOOL bVisible)
 Hide or show the tab. More...
 
VARIANT_BOOL isEnabled (EwErrorCode *errorCode)
 Determine if the tab is enabled. More...
 
EwErrorCode setEnabled (VARIANT_BOOL bEnabled)
 Set whether the tab is enabled. More...
 
long getID (EwErrorCode *errorCode)
 Get the Id's of Tab. More...
 
EwErrorCode remove ()
 Remove the current tab from the ribbon. More...
 
int getIndex (EwErrorCode *errorCode)
 Return the index of the tab. More...
 

Detailed Description

Use this interface to manage the Ribbon tabs.

Since
2019

Member Function Documentation

◆ addGroup()

IEwRibbonGroupX IEwRibbonTabX::addGroup ( BSTR  strCaption,
EwErrorCode errorCode 
)

Add a new group at the end of the ribbon tab.

Parameters
[in]strCaptionthe caption text of the new group.
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_INVALID_OBJECT if object is not initialized
  • EW_UNDEFINED_ERROR if another error occurred
Returns
an IEwRibbonGroupX added to the Ribbon Tab.

◆ getCaption()

BSTR IEwRibbonTabX::getCaption ( EwErrorCode errorCode)

Return the caption of this tab.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_INVALID_OBJECT if object is not initialized
  • EW_UNDEFINED_ERROR if another error occurred
Returns
the caption of this tab.

◆ getGroupAt()

IEwRibbonGroupX IEwRibbonTabX::getGroupAt ( int  iIndex,
EwErrorCode errorCode 
)

Return the specified group of the current tab.

Parameters
[in]iIndexPosition of the group.
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_INVALID_OBJECT if object is not initialized
  • EW_BAD_INPUTS if the index is greater thant the number of tabs or negative.
  • EW_UNDEFINED_ERROR if another error occurred
Returns
An IEwRibbonGroupX specified.

◆ getGroupCount()

int IEwRibbonTabX::getGroupCount ( EwErrorCode errorCode)

Return the number of group in the current tab.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_INVALID_OBJECT if object is not initialized
  • EW_UNDEFINED_ERROR if another error occurred
Returns
the number of group in the current tab.

◆ getID()

long IEwRibbonTabX::getID ( EwErrorCode errorCode)

Get the Id's of Tab.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_INVALID_OBJECT if object is not initialized
  • EW_UNDEFINED_ERROR if another error occurred
Returns
the id of the tab.

◆ getIndex()

int IEwRibbonTabX::getIndex ( EwErrorCode errorCode)

Return the index of the tab.

Since
2022 SP0.
Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_INVALID_OBJECT if object is not initialized
  • EW_UNDEFINED_ERROR if another error occurred
Returns
an integer that is the index of the current tab.

◆ insertGroup()

IEwRibbonGroupX IEwRibbonTabX::insertGroup ( BSTR  strCaption,
int  iIndex,
EwErrorCode errorCode 
)

Add a new group at the specified index of the ribbon tab.

Parameters
[in]strCaptionthe caption text of the new group.
[in]iIndexPosition to insert new group. If iIndex is greater than the number of group, the group is added at the end.
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_INVALID_OBJECT if object is not initialized
  • EW_BAD_INPUTS if the index is negative.
  • EW_UNDEFINED_ERROR if another error occurred
Returns
An IEwRibbonGroupX added to the Ribbon Tab.

◆ isEnabled()

VARIANT_BOOL IEwRibbonTabX::isEnabled ( EwErrorCode errorCode)

Determine if the tab is enabled.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_INVALID_OBJECT if object is not initialized
  • EW_UNDEFINED_ERROR if another error occurred
Returns
TRUE if the tab is enabled, FALSE otherwise.

◆ isVisible()

VARIANT_BOOL IEwRibbonTabX::isVisible ( EwErrorCode errorCode)

Determine if the tab is visible.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_INVALID_OBJECT if object is not initialized
  • EW_UNDEFINED_ERROR if another error occurred
Returns
TRUE if the tab is visible, FALSE otherwise.

◆ remove()

EwErrorCode IEwRibbonTabX::remove ( )

Remove the current tab from the ribbon.

Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_INVALID_OBJECT if object is not initialized
  • EW_PROJECT_NOTOPENED if the associated project is not open.

◆ removeAllGroup()

EwErrorCode IEwRibbonTabX::removeAllGroup ( )

Remove all groups.

Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_INVALID_OBJECT if object is not initialized
  • EW_UNDEFINED_ERROR if another error occurred

◆ removeGroup()

EwErrorCode IEwRibbonTabX::removeGroup ( int  iIndex)

Remove a group specified by the index.

Parameters
[in]iIndexthe index of the group to remove.
Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_INVALID_OBJECT if object is not initialized
  • EW_BAD_INPUTS if the index is greater than the number of group or negative.
  • EW_UNDEFINED_ERROR if another error occurred

◆ setCaption()

EwErrorCode IEwRibbonTabX::setCaption ( BSTR  strCaption)

Set a new caption for this tab.

Parameters
[out]strCaptionthe new caption to display.
Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_INVALID_OBJECT if object is not initialized
  • EW_UNDEFINED_ERROR if another error occurred

◆ setEnabled()

EwErrorCode IEwRibbonTabX::setEnabled ( VARIANT_BOOL  bEnabled)

Set whether the tab is enabled.

Parameters
[in]bEnabledTRUE to enable the tab, FALSE to disable the tab. If FALSE, the tab will appear "grayed out" and the user can not access the tab.
Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_INVALID_OBJECT if object is not initialized
  • EW_UNDEFINED_ERROR if another error occurred

◆ setVisible()

EwErrorCode IEwRibbonTabX::setVisible ( VARIANT_BOOL  bVisible)

Hide or show the tab.

Parameters
[in]bVisibleTRUE to show the tab, FALSE to hide the tab.
Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_INVALID_OBJECT if object is not initialized
  • EW_UNDEFINED_ERROR if another error occurred


Provide feedback on this topic

SOLIDWORKS welcomes your feedback concerning the presentation, accuracy, and thoroughness of the documentation. Use the form below to send your comments and suggestions about this topic directly to our documentation team. The documentation team cannot answer technical support questions. Click here for information about technical support.

* Required

 
*Email:  
Subject:   Feedback on Help Topics
Page:   SOLIDWORKS Electrical API: IEwRibbonTabX Interface Reference
*Comment:  
*   I acknowledge I have read and I hereby accept the privacy policy under which my Personal Data will be used by Dassault Systèmes

Print Topic

Select the scope of content to print:




x

We have detected you are using a browser version older than Internet Explorer 7. For optimized display, we suggest upgrading your browser to Internet Explorer 7 or newer.

 Never show this message again
x

Web Help Content Version: API Help (English only) 2024 SP05

To disable Web help from within SOLIDWORKS and use local help instead, click Help > Use SOLIDWORKS Web Help.

To report problems encountered with the Web help interface and search, contact your local support representative. To provide feedback on individual help topics, use the “Feedback on this topic” link on the individual topic page.