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
IEwRibbonX Interface Reference

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

Inheritance diagram for IEwRibbonX:
Inheritance graph

Public Member Functions

IEwRibbonTabX addTab (BSTR strCaption, EwErrorCode *errorCode)
 Return an IEwRibbonTabX added to the Ribbon Tab. More...
 
IEwRibbonTabX insertTab (BSTR strCaption, int iIndex, EwErrorCode *errorCode)
 Insert new tab for ribbon bar to specified position and return the IEwRibbonTabX inserted. More...
 
IEwRibbonTabX getSelectedTab (EwErrorCode *errorCode)
 Return an IEwRibbonTabX that encapsulate the selected Ribbon Tab. More...
 
EwErrorCode setSelectedTab (int iIndex)
 Select a Ribbon Tab. More...
 
IEwRibbonTabX getTabAt (int iIndex, EwErrorCode *errorCode)
 Return an IEwRibbonTabX that encapsulate the Ribbon Tab specified by index. More...
 
int getTabCount (EwErrorCode *errorCode)
 Return the number of tab of this ribbon bar. More...
 
EwErrorCode removeTab (int iIndex)
 Remove a Ribbon Tab specified by the index. More...
 
IEwRibbonTabX findTabByEnum (EwRibbonMainTabType eRibbonMainTabType, EwErrorCode *errorCode)
 Return an IEwRibbonTabX object find by the input EwRibbonMainTabType enumeration. More...
 
IEwRibbonTabX findTabByID (int iID, EwErrorCode *errorCode)
 Return an IEwRibbonTabX object that has the ID passed as parameter. More...
 
IEwRibbonQuickAccessControlX getQuickAccessControl (EwErrorCode *errorCode)
 Return an IEwRibbonQuickAccessControlX object. More...
 

Detailed Description

Use this interface to manage the Ribbon Bar.

Since
2019

Member Function Documentation

◆ addTab()

IEwRibbonTabX IEwRibbonX::addTab ( BSTR  strCaption,
EwErrorCode errorCode 
)

Return an IEwRibbonTabX added to the Ribbon Tab.

Parameters
[in]strCaptionthe caption text to draw on the new ribbon tab.
[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 IEwRibbonTabX added to the Ribbon Tab.

◆ findTabByEnum()

IEwRibbonTabX IEwRibbonX::findTabByEnum ( EwRibbonMainTabType  eRibbonMainTabType,
EwErrorCode errorCode 
)

Return an IEwRibbonTabX object find by the input EwRibbonMainTabType enumeration.

Since
2022 SP0.
Parameters
[in]eRibbonMainTabTypeEwRibbonMainTabType enum type that specify the RibbonBar to get.
[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 eRibbonMainTabType does not exist or is reserved
  • EW_UNDEFINED_ERROR if another error occurred
Returns
an IEwRibbonTabX object find by the input EwRibbonMainTabType enumeration.

◆ findTabByID()

IEwRibbonTabX IEwRibbonX::findTabByID ( int  iID,
EwErrorCode errorCode 
)

Return an IEwRibbonTabX object that has the ID passed as parameter.

Since
2022 SP0.
Parameters
[in]iIDID of the tab to get.
[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 eRibbonMainTabType does not exist or is reserved
  • EW_UNDEFINED_ERROR if another error occurred
Returns
an IEwRibbonTabX object that encapsulate the Ribbon Tab specified by eRibbonMainTabType.

◆ getQuickAccessControl()

IEwRibbonQuickAccessControlX IEwRibbonX::getQuickAccessControl ( EwErrorCode errorCode)

Return an IEwRibbonQuickAccessControlX object.

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 IEwRibbonQuickAccessControlX added to the Ribbon.

◆ getSelectedTab()

IEwRibbonTabX IEwRibbonX::getSelectedTab ( EwErrorCode errorCode)

Return an IEwRibbonTabX that encapsulate the selected Ribbon 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
an IEwRibbonTabX that encapsulate the selected Ribbon Tab.

◆ getTabAt()

IEwRibbonTabX IEwRibbonX::getTabAt ( int  iIndex,
EwErrorCode errorCode 
)

Return an IEwRibbonTabX that encapsulate the Ribbon Tab specified by index.

Parameters
[in]iIndexthe index of the tab to retrieve.
[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 or greater than the number of tabs.
  • EW_UNDEFINED_ERROR if another error occurred
Returns
an IEwRibbonTabX that encapsulate the Ribbon Tab specified by index.

◆ getTabCount()

int IEwRibbonX::getTabCount ( EwErrorCode errorCode)

Return the number of tab of this ribbon bar.

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 tab of this ribbon bar.

◆ insertTab()

IEwRibbonTabX IEwRibbonX::insertTab ( BSTR  strCaption,
int  iIndex,
EwErrorCode errorCode 
)

Insert new tab for ribbon bar to specified position and return the IEwRibbonTabX inserted.

Parameters
[in]strCaptionthe caption text to draw on the new ribbon tab.
[in]iIndexPosition to insert new tab. If iIndex is greater than the number of tab, the tab 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_UNDEFINED_ERROR if another error occurred
Returns
An IEwRibbonTabX inserted to the Ribbon Tab.

◆ removeTab()

EwErrorCode IEwRibbonX::removeTab ( int  iIndex)

Remove a Ribbon Tab specified by the index.

Parameters
[in]iIndexthe index of the tab 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 negative or greater than the number of tabs
  • EW_UNDEFINED_ERROR if another error occurred

◆ setSelectedTab()

EwErrorCode IEwRibbonX::setSelectedTab ( int  iIndex)

Select a Ribbon Tab.

Parameters
[in]iIndexthe index of the tab to be selected.
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 negative or greater than the number of tabs
  • 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: IEwRibbonX 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.