Welcome
Expand Getting StartedGetting Started
Expand SOLIDWORKS API HelpSOLIDWORKS API Help
Collapse SOLIDWORKS Electrical API HelpSOLIDWORKS Electrical API Help
Expand Getting StartedGetting Started
Expand Release NotesRelease Notes
Collapse ClassesClasses
Expand Class ListClass List
Class Index
Collapse Class HierarchyClass Hierarchy
_DIEwProjectXEvents
Collapse IDispatchIDispatch
IEwAddIn
IEwAPIX
IEwApplicationReactorX
IEwApplicationSettingsX
IEwApplicationX
IEwArchiveEnvironmentX
IEwCableCoreX
IEwCableReferenceManagerX
IEwCableReferenceX
IEwCaptionBarControlX
IEwCaptionBarX
IEwCommandContextX
IEwCommandManagerX
IEwCommandX
IEwDialogAlignPartsParametersSelectorX
IEwDialogLocationSelectorX
IEwDialogMacroSelectorX
IEwDialogManufacturerPartOrderingX
IEwDialogManufacturerPartSelectorX
IEwDialogProgressX
IEwDialogProjectManagerX
IEwDialogResumeX
IEwDialogSummaryX
IEwDialogTaskX
IEwDockingPaneManagerX
IEwDockingPaneX
IEwEnvironmentX
IEwInteropFactoryX
IEwLibraryManagerX
IEwLibraryX
IEwLockStringX
IEwManagerDialogX
IEwManufacturerPartCircuitX
IEwManufacturerPartManagerX
IEwManufacturerPartTerminalX
Expand IEwObjectBaseXIEwObjectBaseX
IEwPointX
IEwProjectAutomaticArrowsX
IEwProjectBookManagerX
IEwProjectCableManagerX
IEwProjectComponentManagerX
IEwProjectComponentTerminalX
IEwProjectEntity3DManagerX
IEwProjectExcelAutomationX
IEwProjectExportDWGFilesX
IEwProjectExportPDFX
IEwProjectExportPDMX
IEwProjectExportReportX
IEwProjectFileManagerX
IEwProjectFolderManagerX
IEwProjectFunctionManagerX
IEwProjectGenerateTSDrawingX
IEwProjectHarnessManagerX
IEwProjectInputOutputManagerX
IEwProjectLocationManagerX
IEwProjectManagerX
IEwProjectManufacturerPartCircuitX
IEwProjectManufacturerPartManagerX
IEwProjectManufacturerPartTerminalX
IEwProjectManufacturerPartX
IEwProjectNumberDocumentsX
IEwProjectNumberMarksX
IEwProjectNumberWiresX
IEwProjectOptimizeWireOrderX
IEwProjectPrintConfigManagerX
IEwProjectReportManagerX
IEwProjectSnapshotManagerX
IEwProjectSnapshotX
IEwProjectSymbolManagerX
IEwProjectUpdateReplaceDataX
IEwProjectWireManagerX
IEwProjectX
IEwResumeRowX
IEwRibbonComboBoxControlX
IEwRibbonControlX
IEwRibbonGroupX
IEwRibbonQuickAccessControlX
IEwRibbonTabX
IEwRibbonX
IEwRightsManagerX
IEwSaveDWGImageX
IEwSymbolCircuitX
IEwSymbolFiltersX
IEwSymbolManagerX
IEwSymbolPointX
IEwSymbolX
IEwTerminalTypeManagerX
IEwTitleBlockManagerX
IEwTitleBlockX
IEwWireTerminationTypeManagerX
IEwXLSBookX
IEwXLSSheetX
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  2022.0.0
Electrical API
Public Member Functions | List of all members
IEwRibbonGroupX Interface Reference

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

Inheritance diagram for IEwRibbonGroupX:
[legend]

Public Member Functions

BSTR getCaption (EwErrorCode *errorCode)
 Return the caption of this ribbon group. More...
 
EwErrorCode setCaption (BSTR strCaption)
 Set a new caption for this ribbon group. More...
 
IEwRibbonControlX addControl (EwRibbonControlType eRibbonControlType, BSTR strCommand, EwErrorCode *errorCode)
 Add a new control at the end of the ribbon group. More...
 
IEwRibbonControlX getControlAt (int iIndex, EwErrorCode *errorCode)
 Return the specified control of the current group. More...
 
int getControlCount (EwErrorCode *errorCode)
 Return the number of control in the current group. More...
 
EwErrorCode removeControl (int iIndex)
 Remove a control specified by the index. More...
 
EwErrorCode removeAll ()
 Remove all controls. More...
 
long getID (EwErrorCode *errorCode)
 Get the Id's of group. More...
 
IEwRibbonControlX insertControl (int nPosition, EwRibbonControlType eRibbonControlType, BSTR strCommand, EwErrorCode *errorCode)
 Insert a new control to a pop-up button in a ribbon. More...
 
IEwRibbonComboBoxControlX insertComboBoxControl (int nPosition, EwErrorCode *pErrorCode)
 Insert the ComboBox Control in the Ribbon Group. More...
 
IEwRibbonComboBoxControlX addComboBoxControl (EwErrorCode *pErrorCode)
 Add the ComboBox Control in the Ribbon Group. More...
 
int getIndex (EwErrorCode *errorCode)
 Return the index of the group. More...
 

Detailed Description

Use this interface to manage the Ribbon group.

Since
2019

Member Function Documentation

◆ addComboBoxControl()

IEwRibbonComboBoxControlX IEwRibbonGroupX::addComboBoxControl ( EwErrorCode *  pErrorCode)

Add the ComboBox Control in the Ribbon Group.

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_BAD_INPUT if wrong input is provided
  • EW_UNDEFINED_ERROR if another error occurred
Returns
an IEwRibbonComboBoxControlX object.

◆ addControl()

IEwRibbonControlX IEwRibbonGroupX::addControl ( EwRibbonControlType  eRibbonControlType,
BSTR  strCommand,
EwErrorCode *  errorCode 
)

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

\NOTE: To add ComboBox Control use addComboBoxControl.

Parameters
[in]eRibbonControlTypetype of control
[in]strCommandthe name of a command to launch. Can be blanck.
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_INVALID_OBJECT if object is not initialized or EwRibbonControlType is invalid
  • EW_UNDEFINED_ERROR if another error occurred
Returns
an IEwRibbonControlX added to the Ribbon Tab.

◆ getCaption()

BSTR IEwRibbonGroupX::getCaption ( EwErrorCode *  errorCode)

Return the caption of this ribbon group.

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 ribbon group.

◆ getControlAt()

IEwRibbonControlX IEwRibbonGroupX::getControlAt ( int  iIndex,
EwErrorCode *  errorCode 
)

Return the specified control of the current group.

Parameters
[in]iIndexPosition of the control.
[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 IEwRibbonControlX specified.

◆ getControlCount()

int IEwRibbonGroupX::getControlCount ( EwErrorCode *  errorCode)

Return the number of control in the current group.

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 control in the current group.

◆ getID()

long IEwRibbonGroupX::getID ( EwErrorCode *  errorCode)

Get the Id's of group.

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 group.

◆ getIndex()

int IEwRibbonGroupX::getIndex ( EwErrorCode *  errorCode)

Return the index of the group.

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 group.

◆ insertComboBoxControl()

IEwRibbonComboBoxControlX IEwRibbonGroupX::insertComboBoxControl ( int  nPosition,
EwErrorCode *  pErrorCode 
)

Insert the ComboBox Control in the Ribbon Group.

Since
2022 SP0.
Parameters
[in]nPositionposition where button must be inserted in ribbon group
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_INVALID_OBJECT if object is not initialized
  • EW_BAD_INPUT if wrong input is provided
  • EW_UNDEFINED_ERROR if another error occurred
Returns
an IEwRibbonComboBoxControlX.

◆ insertControl()

IEwRibbonControlX IEwRibbonGroupX::insertControl ( int  nPosition,
EwRibbonControlType  eRibbonControlType,
BSTR  strCommand,
EwErrorCode *  errorCode 
)

Insert a new control to a pop-up button in a ribbon.

Since
2022 SP0. \NOTE: To insert ComboBox Control use insertComboBoxControl.
Parameters
[in]nPositionposition where button must be inserted in ribbon group , if position is negative or higher than the number of control in group, then the control will be added to the queue of the group
[in]eRibbonControlTypetype of ribbon control
[in]strCommandthe name of a command to launch. Can be blank.
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_INVALID_OBJECT if object is not initialized or EwRibbonControlType is invalid
  • EW_BAD_INPUT if eType is not a good type or if the current button is not a pop-up button.
  • EW_UNDEFINED_ERROR if another error occurred
Returns
an IEwRibbonControlX added to the control.

◆ removeAll()

EwErrorCode IEwRibbonGroupX::removeAll ( )

Remove all controls.

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

◆ removeControl()

EwErrorCode IEwRibbonGroupX::removeControl ( int  iIndex)

Remove a control specified by the index.

Parameters
[in]iIndexthe index of the control 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 control or negative.
  • EW_UNDEFINED_ERROR if another error occurred

◆ setCaption()

EwErrorCode IEwRibbonGroupX::setCaption ( BSTR  strCaption)

Set a new caption for this ribbon group.

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
Generated on Wed Aug 18 2021 10:34:11 for SOLIDWORKS Electrical API by   doxygen 1.8.18


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: IEwRibbonGroupX 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) 2022 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.

0.20.46